wavelength 1.0.0
Loading...
Searching...
No Matches
udfformat.h
Go to the documentation of this file.
1#pragma once
2
3#include <algorithm>
4#include <chrono>
5#include <cstddef>
6#include <cstdint>
7#include <span>
8
9#include "byteorder.h"
10#include "isodate.h"
11#include "volume.h"
12
15
18using Common::Seconds;
19using Common::Volume;
21
22// Tag identifiers of ECMA-167.
23constexpr std::uint16_t kTagAnchor = 2;
24constexpr std::uint16_t kTagPartition = 5;
25constexpr std::uint16_t kTagLogicalVolume = 6;
26constexpr std::uint16_t kTagTerminating = 8;
27constexpr std::uint16_t kTagIntegrity = 9;
28constexpr std::uint16_t kTagFileSet = 256;
29constexpr std::uint16_t kTagFileIdentifier = 257;
30constexpr std::uint16_t kTagFileEntry = 261;
31constexpr std::uint16_t kTagExtendedFileEntry = 266;
32
33// The offsets below are within a descriptor tag.
34constexpr std::size_t kTagLength = 16;
35constexpr std::size_t kTagChecksum = 4;
36constexpr std::size_t kTagCrc = 8;
37constexpr std::size_t kTagCrcLength = 10;
38constexpr std::size_t kTagLocation = 12;
39
40// The offsets below are within the anchor, partition, logical volume, and file set descriptors.
41constexpr std::size_t kAnchorMain = 16;
42constexpr std::size_t kAnchorReserve = 24;
43constexpr std::size_t kPartitionStart = 188;
44constexpr std::size_t kPartitionLength = 192;
45constexpr std::size_t kLogicalVolumeFileSet = 252;
46constexpr std::size_t kLogicalVolumeIntegrity = 436;
47constexpr std::size_t kFileSetRoot = 404;
48
49// The offsets below are within a logical volume integrity descriptor.
50constexpr std::size_t kIntegrityTime = 16;
51constexpr std::size_t kIntegrityPartitions = 72;
52constexpr std::size_t kIntegrityFreeSpace = 80;
53
54// The offsets below are within a file entry or an extended file entry.
55constexpr std::size_t kEntryFileType = 27;
56constexpr std::size_t kEntryFlags = 34;
57constexpr std::size_t kEntryInformationLength = 56;
58constexpr std::size_t kExtendedObjectSize = 64;
59constexpr std::uint8_t kFileTypeDirectory = 4;
60constexpr std::uint16_t kAllocationTypeMask = 7;
61constexpr std::uint16_t kAllocationShort = 0;
62constexpr std::uint16_t kAllocationLong = 1;
63constexpr std::uint16_t kAllocationEmbedded = 3;
64constexpr std::size_t kShortLength = 8;
65constexpr std::size_t kLongLength = 16;
66constexpr std::uint32_t kExtentLengthMask = 0x3FFFFFFF;
67
68// The offsets below are within a file identifier descriptor.
69constexpr std::size_t kIdentifierCharacteristics = 18;
70constexpr std::size_t kIdentifierNameLength = 19;
71constexpr std::size_t kIdentifierIcbBlock = 24;
72constexpr std::size_t kIdentifierUseLength = 36;
73constexpr std::size_t kIdentifierFixedLength = 38;
74constexpr std::uint8_t kCharacteristicParent = 0x08;
75
76// The layout differences between a file entry and an extended file entry.
78 std::size_t recorded;
79 std::size_t modified;
80 std::size_t attribute;
81 std::size_t lengths;
82 std::size_t descriptors;
83};
84
85constexpr EntryLayout kFileEntryLayout{64, 84, 96, 168, 176};
86constexpr EntryLayout kExtendedEntryLayout{72, 92, 116, 208, 216};
87
88// A UDF timestamp has a type and zone word, then the year and the fields down to microseconds.
89constexpr std::size_t kTimeLength = 12;
90constexpr std::uint16_t kTimeTypeLocal = 0x1000;
91constexpr std::uint16_t kTimeZoneMask = 0xFFF;
92constexpr int kTimeZoneUnspecified = -2047;
93constexpr int kTimeZoneSignBit = 0x800;
94
95inline std::uint64_t readLittle64(std::span<const std::uint8_t> bytes, std::size_t offset) {
96 return readLittle32(bytes, offset) | (std::uint64_t{readLittle32(bytes, offset + 4)} << 32);
97}
98
99inline void writeLittle64(std::span<std::uint8_t> bytes, std::size_t offset, std::uint64_t value) {
100 writeLittle(bytes, offset, static_cast<std::uint32_t>(value));
101 writeLittle(bytes, offset + 4, static_cast<std::uint32_t>(value >> 32));
102}
103
104inline Seconds readTime(std::span<const std::uint8_t> bytes, std::size_t offset) {
105 int zone = readLittle16(bytes, offset) & kTimeZoneMask;
106 zone = (zone & kTimeZoneSignBit) != 0 ? zone - (kTimeZoneMask + 1) : zone;
107 const std::chrono::year_month_day day{
108 std::chrono::year{static_cast<std::int16_t>(readLittle16(bytes, offset + 2))},
109 std::chrono::month{bytes[offset + 4]},
110 std::chrono::day{bytes[offset + 5]}};
111 return std::chrono::sys_days{day} + std::chrono::hours{bytes[offset + 6]} +
112 std::chrono::minutes{bytes[offset + 7]} + std::chrono::seconds{bytes[offset + 8]} -
113 std::chrono::minutes{zone == kTimeZoneUnspecified ? 0 : zone};
114}
115
116inline void writeTime(std::span<std::uint8_t> bytes, std::size_t offset, Seconds time) {
117 const auto midnight = std::chrono::floor<std::chrono::days>(time);
118 const std::chrono::year_month_day day{midnight};
119 const std::chrono::hh_mm_ss clock{time - midnight};
120 std::fill_n(bytes.begin() + static_cast<std::ptrdiff_t>(offset), kTimeLength, 0);
121 writeLittle(bytes, offset, kTimeTypeLocal, 2);
122 writeLittle(bytes, offset + 2, static_cast<std::uint32_t>(static_cast<int>(day.year())), 2);
123 bytes[offset + 4] = static_cast<std::uint8_t>(static_cast<unsigned>(day.month()));
124 bytes[offset + 5] = static_cast<std::uint8_t>(static_cast<unsigned>(day.day()));
125 bytes[offset + 6] = static_cast<std::uint8_t>(clock.hours().count());
126 bytes[offset + 7] = static_cast<std::uint8_t>(clock.minutes().count());
127 bytes[offset + 8] = static_cast<std::uint8_t>(clock.seconds().count());
128}
129
130// CRC-16/CCITT with a zero initial value, as ECMA-167 7.2.6 defines the descriptor CRC.
131inline std::uint16_t crc16(std::span<const std::uint8_t> bytes) {
132 constexpr std::uint16_t kPolynomial = 0x1021;
133 std::uint16_t crc = 0;
134 for (const auto byte : bytes) {
135 crc ^= static_cast<std::uint16_t>(byte << 8);
136 for (int bit = 0; bit < 8; ++bit) {
137 crc = (crc & 0x8000) != 0 ? static_cast<std::uint16_t>((crc << 1) ^ kPolynomial) :
138 static_cast<std::uint16_t>(crc << 1);
139 }
140 }
141 return crc;
142}
143
144inline std::uint8_t tagChecksum(std::span<const std::uint8_t> bytes) {
145 std::uint8_t sum = 0;
146 for (std::size_t i = 0; i < kTagLength; ++i) {
147 sum = static_cast<std::uint8_t>(sum + (i == kTagChecksum ? 0 : bytes[i]));
148 }
149 return sum;
150}
151
152inline std::uint16_t tagIdentifier(std::span<const std::uint8_t> bytes) {
153 return readLittle16(bytes, 0);
154}
155
156inline bool
157isTag(std::span<const std::uint8_t> bytes, std::uint16_t identifier, std::uint32_t location) {
158 return tagIdentifier(bytes) == identifier && tagChecksum(bytes) == bytes[kTagChecksum] &&
159 readLittle32(bytes, kTagLocation) == location;
160}
161
162inline void seal(Volume::Sector &descriptor) {
163 const auto length = std::min<std::size_t>(readLittle16(descriptor, kTagCrcLength),
164 descriptor.size() - kTagLength);
165 writeLittle(descriptor, kTagCrc, crc16(std::span(descriptor).subspan(kTagLength, length)), 2);
166 descriptor[kTagChecksum] = tagChecksum(descriptor);
167}
168
169} // namespace Tools::BuildImage::Udf
std::array< std::uint8_t, kSectorData > Sector
The data bytes of one sector.
Definition volume.h:50
The data sectors of an ISO9660 volume, from a disc image or built from a disc root.
Definition volume.h:34
The descriptor layouts of ECMA-167 and UDF that the UDF reader and writer share.
Definition udfformat.h:14
constexpr std::size_t kTagLength
Definition udfformat.h:34
constexpr int kTimeZoneSignBit
Definition udfformat.h:93
constexpr std::size_t kShortLength
Definition udfformat.h:64
constexpr std::size_t kLongLength
Definition udfformat.h:65
constexpr std::uint16_t kTagExtendedFileEntry
Definition udfformat.h:31
constexpr std::size_t kTagChecksum
Definition udfformat.h:35
constexpr std::size_t kIdentifierNameLength
Definition udfformat.h:70
constexpr std::size_t kIdentifierCharacteristics
Definition udfformat.h:69
constexpr std::uint16_t kAllocationShort
Definition udfformat.h:61
std::uint32_t readLittle32(std::span< const std::uint8_t > bytes, std::size_t offset)
Read a little-endian 32-bit value.
Definition byteorder.h:27
constexpr std::uint16_t kTagFileSet
Definition udfformat.h:28
constexpr std::size_t kEntryInformationLength
Definition udfformat.h:57
constexpr std::size_t kIdentifierFixedLength
Definition udfformat.h:73
constexpr std::uint16_t kTagLogicalVolume
Definition udfformat.h:25
constexpr std::size_t kEntryFileType
Definition udfformat.h:55
constexpr std::size_t kPartitionLength
Definition udfformat.h:44
constexpr std::size_t kTagCrcLength
Definition udfformat.h:37
constexpr std::uint8_t kFileTypeDirectory
Definition udfformat.h:59
constexpr std::uint16_t kTagFileEntry
Definition udfformat.h:30
constexpr std::size_t kTagCrc
Definition udfformat.h:36
constexpr EntryLayout kFileEntryLayout
Definition udfformat.h:85
constexpr std::uint16_t kTagTerminating
Definition udfformat.h:26
std::uint16_t crc16(std::span< const std::uint8_t > bytes)
Definition udfformat.h:131
constexpr std::size_t kIntegrityPartitions
Definition udfformat.h:51
constexpr std::size_t kAnchorMain
Definition udfformat.h:41
std::uint16_t tagIdentifier(std::span< const std::uint8_t > bytes)
Definition udfformat.h:152
constexpr std::size_t kIntegrityTime
Definition udfformat.h:50
constexpr std::size_t kLogicalVolumeIntegrity
Definition udfformat.h:46
constexpr std::size_t kIntegrityFreeSpace
Definition udfformat.h:52
constexpr std::uint16_t kAllocationLong
Definition udfformat.h:62
bool isTag(std::span< const std::uint8_t > bytes, std::uint16_t identifier, std::uint32_t location)
Definition udfformat.h:157
constexpr std::size_t kPartitionStart
Definition udfformat.h:43
void seal(Volume::Sector &descriptor)
Definition udfformat.h:162
constexpr std::uint16_t kTimeZoneMask
Definition udfformat.h:91
void writeLittle64(std::span< std::uint8_t > bytes, std::size_t offset, std::uint64_t value)
Definition udfformat.h:99
void writeTime(std::span< std::uint8_t > bytes, std::size_t offset, Seconds time)
Definition udfformat.h:116
constexpr std::uint32_t kExtentLengthMask
Definition udfformat.h:66
constexpr std::size_t kEntryFlags
Definition udfformat.h:56
void writeLittle(std::span< std::uint8_t > bytes, std::size_t offset, std::uint32_t value, std::size_t width=4)
Write a little-endian value.
Definition byteorder.h:42
constexpr std::uint16_t kAllocationEmbedded
Definition udfformat.h:63
constexpr std::uint8_t kCharacteristicParent
Definition udfformat.h:74
std::uint8_t tagChecksum(std::span< const std::uint8_t > bytes)
Definition udfformat.h:144
constexpr std::size_t kTagLocation
Definition udfformat.h:38
constexpr std::uint16_t kAllocationTypeMask
Definition udfformat.h:60
std::uint16_t readLittle16(std::span< const std::uint8_t > bytes, std::size_t offset)
Read a little-endian 16-bit value.
Definition byteorder.h:16
constexpr std::uint16_t kTagPartition
Definition udfformat.h:24
constexpr std::uint16_t kTagIntegrity
Definition udfformat.h:27
constexpr std::uint16_t kTagAnchor
Definition udfformat.h:23
constexpr std::size_t kFileSetRoot
Definition udfformat.h:47
Seconds readTime(std::span< const std::uint8_t > bytes, std::size_t offset)
Definition udfformat.h:104
std::uint64_t readLittle64(std::span< const std::uint8_t > bytes, std::size_t offset)
Definition udfformat.h:95
constexpr std::size_t kIdentifierIcbBlock
Definition udfformat.h:71
constexpr std::size_t kLogicalVolumeFileSet
Definition udfformat.h:45
constexpr EntryLayout kExtendedEntryLayout
Definition udfformat.h:86
constexpr std::size_t kAnchorReserve
Definition udfformat.h:42
constexpr std::uint16_t kTagFileIdentifier
Definition udfformat.h:29
constexpr std::size_t kIdentifierUseLength
Definition udfformat.h:72
constexpr std::size_t kTimeLength
Definition udfformat.h:89
constexpr std::size_t kExtendedObjectSize
Definition udfformat.h:58
constexpr int kTimeZoneUnspecified
Definition udfformat.h:92
constexpr std::uint16_t kTimeTypeLocal
Definition udfformat.h:90
std::uint32_t readLittle32(std::span< const std::uint8_t > bytes, std::size_t offset)
Read a little-endian 32-bit value.
Definition byteorder.h:27
void writeLittle(std::span< std::uint8_t > bytes, std::size_t offset, std::uint32_t value, std::size_t width=4)
Write a little-endian value.
Definition byteorder.h:42
std::uint16_t readLittle16(std::span< const std::uint8_t > bytes, std::size_t offset)
Read a little-endian 16-bit value.
Definition byteorder.h:16
std::chrono::sys_seconds Seconds
A UTC time with a resolution of one second.
Definition isodate.h:20
Definition udfformat.h:77
std::size_t attribute
Definition udfformat.h:80
std::size_t modified
Definition udfformat.h:79
std::size_t descriptors
Definition udfformat.h:82
std::size_t recorded
Definition udfformat.h:78
std::size_t lengths
Definition udfformat.h:81