ecma167-udf.h revision 1.3 1 1.3 reinoud /* $NetBSD: ecma167-udf.h,v 1.3 2006/08/25 17:43:51 reinoud Exp $ */
2 1.1 reinoud
3 1.1 reinoud /*-
4 1.1 reinoud * Copyright (c) 2003, 2004, 2005, 2006 Reinoud Zandijk <reinoud (at) netbsd.org>
5 1.1 reinoud * Copyright (c) 2001, 2002 Scott Long <scottl (at) freebsd.org>
6 1.1 reinoud * All rights reserved.
7 1.1 reinoud *
8 1.1 reinoud * Redistribution and use in source and binary forms, with or without
9 1.1 reinoud * modification, are permitted provided that the following conditions
10 1.1 reinoud * are met:
11 1.1 reinoud * 1. Redistributions of source code must retain the above copyright
12 1.1 reinoud * notice, this list of conditions and the following disclaimer.
13 1.1 reinoud * 2. Redistributions in binary form must reproduce the above copyright
14 1.1 reinoud * notice, this list of conditions and the following disclaimer in the
15 1.1 reinoud * documentation and/or other materials provided with the distribution.
16 1.1 reinoud *
17 1.1 reinoud * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 1.1 reinoud * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 1.1 reinoud * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 1.1 reinoud * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 1.1 reinoud * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 1.1 reinoud * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 1.1 reinoud * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 1.1 reinoud * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 1.1 reinoud * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 1.1 reinoud * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 1.1 reinoud * SUCH DAMAGE.
28 1.1 reinoud *
29 1.1 reinoud *
30 1.1 reinoud * Extended and adapted for UDFv2.50+ bij Reinoud Zandijk based on the
31 1.1 reinoud * origional by Scott Long.
32 1.1 reinoud *
33 1.1 reinoud * 20030508 Made some small typo and explainatory comments
34 1.1 reinoud * 20030510 Added UDF 2.01 structures
35 1.1 reinoud * 20030519 Added/correct comments on multi-partitioned logical volume space
36 1.1 reinoud * 20050616 Added pseudo overwrite
37 1.1 reinoud * 20050624 Added the missing extended attribute types and `magic values'.
38 1.1 reinoud * 20051106 Reworked some implementation use parts
39 1.1 reinoud *
40 1.1 reinoud */
41 1.1 reinoud
42 1.1 reinoud
43 1.2 reinoud #ifndef _FS_UDF_ECMA167_UDF_H_
44 1.2 reinoud #define _FS_UDF_ECMA167_UDF_H_
45 1.1 reinoud
46 1.1 reinoud
47 1.1 reinoud /*
48 1.1 reinoud * in case of an older gcc versions, define the __packed as explicit
49 1.1 reinoud * attribute
50 1.1 reinoud */
51 1.1 reinoud
52 1.1 reinoud /*
53 1.1 reinoud * You may specify the `aligned' and `transparent_union' attributes either in
54 1.1 reinoud * a `typedef' declaration or just past the closing curly brace of a complete
55 1.1 reinoud * enum, struct or union type _definition_ and the `packed' attribute only
56 1.1 reinoud * past the closing brace of a definition. You may also specify attributes
57 1.1 reinoud * between the enum, struct or union tag and the name of the type rather than
58 1.1 reinoud * after the closing brace.
59 1.1 reinoud */
60 1.1 reinoud
61 1.1 reinoud #ifndef __packed
62 1.1 reinoud #define __packed __attribute__((packed))
63 1.1 reinoud #endif
64 1.1 reinoud
65 1.1 reinoud
66 1.1 reinoud /* ecma167-udf.h */
67 1.1 reinoud
68 1.1 reinoud /* Volume recognition sequence ECMA 167 rev. 3 16.1 */
69 1.1 reinoud struct vrs_desc {
70 1.1 reinoud uint8_t struct_type;
71 1.1 reinoud uint8_t identifier[5];
72 1.1 reinoud uint8_t version;
73 1.1 reinoud uint8_t data[2041];
74 1.1 reinoud } __packed;
75 1.1 reinoud
76 1.1 reinoud
77 1.1 reinoud #define VRS_NSR02 "NSR02"
78 1.1 reinoud #define VRS_NSR03 "NSR03"
79 1.1 reinoud #define VRS_BEA01 "BEA01"
80 1.1 reinoud #define VRS_TEA01 "TEA01"
81 1.1 reinoud #define VRS_CD001 "CD001"
82 1.1 reinoud #define VRS_CDW02 "CDW02"
83 1.1 reinoud
84 1.1 reinoud
85 1.1 reinoud /* Structure/definitions/constants a la ECMA 167 rev. 3 */
86 1.1 reinoud
87 1.1 reinoud
88 1.1 reinoud #define MAX_TAGID_VOLUMES 9
89 1.1 reinoud /* Tag identifiers */
90 1.1 reinoud enum {
91 1.1 reinoud TAGID_SPARING_TABLE = 0,
92 1.1 reinoud TAGID_PRI_VOL = 1,
93 1.1 reinoud TAGID_ANCHOR = 2,
94 1.1 reinoud TAGID_VOL = 3,
95 1.1 reinoud TAGID_IMP_VOL = 4,
96 1.1 reinoud TAGID_PARTITION = 5,
97 1.1 reinoud TAGID_LOGVOL = 6,
98 1.1 reinoud TAGID_UNALLOC_SPACE = 7,
99 1.1 reinoud TAGID_TERM = 8,
100 1.1 reinoud TAGID_LOGVOL_INTEGRITY= 9,
101 1.1 reinoud TAGID_FSD = 256,
102 1.1 reinoud TAGID_FID = 257,
103 1.1 reinoud TAGID_ALLOCEXTENT = 258,
104 1.1 reinoud TAGID_INDIRECT_ENTRY = 259,
105 1.1 reinoud TAGID_ICB_TERM = 260,
106 1.1 reinoud TAGID_FENTRY = 261,
107 1.1 reinoud TAGID_EXTATTR_HDR = 262,
108 1.1 reinoud TAGID_UNALL_SP_ENTRY = 263,
109 1.1 reinoud TAGID_SPACE_BITMAP = 264,
110 1.1 reinoud TAGID_PART_INTEGRETY = 265,
111 1.1 reinoud TAGID_EXTFENTRY = 266,
112 1.1 reinoud TAGID_MAX = 266
113 1.1 reinoud };
114 1.1 reinoud
115 1.1 reinoud
116 1.1 reinoud enum {
117 1.1 reinoud UDF_DOMAIN_FLAG_HARD_WRITE_PROTECT = 1,
118 1.1 reinoud UDF_DOMAIN_FLAG_SOFT_WRITE_PROTECT = 2
119 1.1 reinoud };
120 1.1 reinoud
121 1.1 reinoud
122 1.1 reinoud enum {
123 1.1 reinoud UDF_ACCESSTYPE_NOT_SPECIFIED = 0, /* unknown */
124 1.1 reinoud UDF_ACCESSTYPE_PSEUDO_OVERWITE = 0, /* Pseudo overwritable, f.e. BD-R's LOW */
125 1.1 reinoud UDF_ACCESSTYPE_READ_ONLY = 1, /* really only readable */
126 1.1 reinoud UDF_ACCESSTYPE_WRITE_ONCE = 2, /* write once and you're done */
127 1.1 reinoud UDF_ACCESSTYPE_REWRITEABLE = 3, /* may need extra work to rewrite */
128 1.1 reinoud UDF_ACCESSTYPE_OVERWRITABLE = 4 /* no limits on rewriting; harddisc f.e.*/
129 1.1 reinoud };
130 1.1 reinoud
131 1.1 reinoud
132 1.1 reinoud /* Descriptor tag [3/7.2] */
133 1.1 reinoud struct desc_tag {
134 1.1 reinoud uint16_t id;
135 1.1 reinoud uint16_t descriptor_ver;
136 1.1 reinoud uint8_t cksum;
137 1.1 reinoud uint8_t reserved;
138 1.1 reinoud uint16_t serial_num;
139 1.1 reinoud uint16_t desc_crc;
140 1.1 reinoud uint16_t desc_crc_len;
141 1.1 reinoud uint32_t tag_loc;
142 1.1 reinoud } __packed;
143 1.1 reinoud #define UDF_DESC_TAG_LENGTH 16
144 1.1 reinoud
145 1.1 reinoud
146 1.1 reinoud /* Recorded Address [4/7.1] */
147 1.1 reinoud struct lb_addr { /* within partition space */
148 1.1 reinoud uint32_t lb_num;
149 1.1 reinoud uint16_t part_num;
150 1.1 reinoud } __packed;
151 1.1 reinoud
152 1.1 reinoud
153 1.1 reinoud /* Extent Descriptor [3/7.1] */
154 1.1 reinoud struct extent_ad {
155 1.1 reinoud uint32_t len;
156 1.1 reinoud uint32_t loc;
157 1.1 reinoud } __packed;
158 1.1 reinoud
159 1.1 reinoud
160 1.1 reinoud /* Short Allocation Descriptor [4/14.14.1] */
161 1.1 reinoud struct short_ad {
162 1.1 reinoud uint32_t len;
163 1.1 reinoud uint32_t lb_num;
164 1.1 reinoud } __packed;
165 1.1 reinoud
166 1.1 reinoud
167 1.1 reinoud /* Long Allocation Descriptor [4/14.14.2] */
168 1.1 reinoud struct UDF_ADImp_use {
169 1.1 reinoud uint16_t flags;
170 1.1 reinoud uint32_t unique_id;
171 1.1 reinoud } __packed;
172 1.1 reinoud #define UDF_ADIMP_FLAGS_EXTENT_ERASED 1
173 1.1 reinoud
174 1.1 reinoud
175 1.1 reinoud struct long_ad {
176 1.1 reinoud uint32_t len;
177 1.1 reinoud struct lb_addr loc; /* within a logical volume mapped partition space !! */
178 1.1 reinoud union {
179 1.1 reinoud uint8_t bytes[6];
180 1.1 reinoud struct UDF_ADImp_use im_used;
181 1.1 reinoud } __packed impl;
182 1.1 reinoud } __packed;
183 1.1 reinoud
184 1.1 reinoud
185 1.1 reinoud /* Extended Allocation Descriptor [4/14.14.3] ; identifies an extent of allocation descriptors ; also in UDF ? */
186 1.1 reinoud struct ext_ad {
187 1.1 reinoud uint32_t ex_len;
188 1.1 reinoud uint32_t rec_len;
189 1.1 reinoud uint32_t inf_len;
190 1.1 reinoud struct lb_addr ex_loc;
191 1.1 reinoud uint8_t reserved[2];
192 1.1 reinoud } __packed;
193 1.1 reinoud
194 1.1 reinoud
195 1.1 reinoud /* ICB : Information Control Block; positioning */
196 1.1 reinoud union icb {
197 1.1 reinoud struct short_ad s_ad;
198 1.1 reinoud struct long_ad l_ad;
199 1.1 reinoud struct ext_ad e_ad;
200 1.1 reinoud } __packed;
201 1.1 reinoud
202 1.1 reinoud
203 1.1 reinoud /* short/long/ext extent have flags encoded in length */
204 1.1 reinoud #define UDF_EXT_ALLOCATED (0<<30)
205 1.1 reinoud #define UDF_EXT_FREED (1<<30)
206 1.1 reinoud #define UDF_EXT_ALLOCATED_BUT_NOT_USED (1<<30)
207 1.1 reinoud #define UDF_EXT_FREE (2<<30)
208 1.1 reinoud #define UDF_EXT_REDIRECT (3<<30)
209 1.1 reinoud #define UDF_EXT_FLAGS(len) ((len) & (3<<30))
210 1.1 reinoud #define UDF_EXT_LEN(len) ((len) & ((1<<30)-1))
211 1.1 reinoud
212 1.1 reinoud
213 1.1 reinoud /* Character set spec [1/7.2.1] */
214 1.1 reinoud struct charspec {
215 1.1 reinoud uint8_t type;
216 1.1 reinoud uint8_t inf[63];
217 1.1 reinoud } __packed;
218 1.1 reinoud
219 1.1 reinoud
220 1.1 reinoud /* Timestamp [1/7.3] */
221 1.1 reinoud struct timestamp {
222 1.1 reinoud uint16_t type_tz;
223 1.1 reinoud uint16_t year;
224 1.1 reinoud uint8_t month;
225 1.1 reinoud uint8_t day;
226 1.1 reinoud uint8_t hour;
227 1.1 reinoud uint8_t minute;
228 1.1 reinoud uint8_t second;
229 1.1 reinoud uint8_t centisec;
230 1.1 reinoud uint8_t hund_usec;
231 1.1 reinoud uint8_t usec;
232 1.1 reinoud } __packed;
233 1.1 reinoud
234 1.1 reinoud
235 1.1 reinoud /* Entity Identifier [1/7.4] */
236 1.1 reinoud #define UDF_REGID_ID_SIZE 23
237 1.1 reinoud struct regid {
238 1.1 reinoud uint8_t flags;
239 1.1 reinoud uint8_t id[UDF_REGID_ID_SIZE];
240 1.1 reinoud uint8_t id_suffix[8];
241 1.1 reinoud } __packed;
242 1.1 reinoud
243 1.1 reinoud
244 1.1 reinoud /* ICB Tag [4/14.6] */
245 1.1 reinoud struct icb_tag {
246 1.1 reinoud uint32_t prev_num_dirs;
247 1.1 reinoud uint16_t strat_type;
248 1.1 reinoud uint8_t strat_param[2];
249 1.1 reinoud uint16_t max_num_entries;
250 1.1 reinoud uint8_t reserved;
251 1.1 reinoud uint8_t file_type;
252 1.1 reinoud struct lb_addr parent_icb;
253 1.1 reinoud uint16_t flags;
254 1.1 reinoud } __packed;
255 1.1 reinoud #define UDF_ICB_TAG_FLAGS_ALLOC_MASK 0x03
256 1.1 reinoud #define UDF_ICB_SHORT_ALLOC 0x00
257 1.1 reinoud #define UDF_ICB_LONG_ALLOC 0x01
258 1.1 reinoud #define UDF_ICB_EXT_ALLOC 0x02
259 1.1 reinoud #define UDF_ICB_INTERN_ALLOC 0x03
260 1.1 reinoud
261 1.1 reinoud #define UDF_ICB_TAG_FLAGS_DIRORDERED (1<< 3)
262 1.1 reinoud #define UDF_ICB_TAG_FLAGS_NONRELOC (1<< 4)
263 1.1 reinoud #define UDF_ICB_TAG_FLAGS_CONTIGUES (1<< 9)
264 1.1 reinoud #define UDF_ICB_TAG_FLAGS_MULTIPLEVERS (1<<12)
265 1.1 reinoud
266 1.1 reinoud #define UDF_ICB_TAG_FLAGS_SETUID (1<< 6)
267 1.1 reinoud #define UDF_ICB_TAG_FLAGS_SETGID (1<< 7)
268 1.1 reinoud #define UDF_ICB_TAG_FLAGS_STICKY (1<< 8)
269 1.1 reinoud
270 1.1 reinoud #define UDF_ICB_FILETYPE_UNKNOWN 0
271 1.1 reinoud #define UDF_ICB_FILETYPE_UNALLOCSPACE 1
272 1.1 reinoud #define UDF_ICB_FILETYPE_PARTINTEGRITY 2
273 1.1 reinoud #define UDF_ICB_FILETYPE_INDIRECTENTRY 3
274 1.1 reinoud #define UDF_ICB_FILETYPE_DIRECTORY 4
275 1.1 reinoud #define UDF_ICB_FILETYPE_RANDOMACCESS 5
276 1.1 reinoud #define UDF_ICB_FILETYPE_BLOCKDEVICE 6
277 1.1 reinoud #define UDF_ICB_FILETYPE_CHARDEVICE 7
278 1.1 reinoud #define UDF_ICB_FILETYPE_EXTATTRREC 8
279 1.1 reinoud #define UDF_ICB_FILETYPE_FIFO 9
280 1.1 reinoud #define UDF_ICB_FILETYPE_SOCKET 10
281 1.1 reinoud #define UDF_ICB_FILETYPE_TERM 11
282 1.1 reinoud #define UDF_ICB_FILETYPE_SYMLINK 12
283 1.1 reinoud #define UDF_ICB_FILETYPE_STREAMDIR 13
284 1.1 reinoud #define UDF_ICB_FILETYPE_VAT 248
285 1.1 reinoud #define UDF_ICB_FILETYPE_META_MAIN 250
286 1.1 reinoud #define UDF_ICB_FILETYPE_META_MIRROR 251
287 1.1 reinoud
288 1.1 reinoud
289 1.1 reinoud /* Anchor Volume Descriptor Pointer [3/10.2] */
290 1.1 reinoud struct anchor_vdp {
291 1.1 reinoud struct desc_tag tag;
292 1.1 reinoud struct extent_ad main_vds_ex; /* to main volume descriptor set ; 16 sectors min */
293 1.1 reinoud struct extent_ad reserve_vds_ex; /* copy of main volume descriptor set ; 16 sectors min */
294 1.1 reinoud } __packed;
295 1.1 reinoud
296 1.1 reinoud
297 1.1 reinoud /* Volume Descriptor Pointer [3/10.3] */
298 1.1 reinoud struct vol_desc_ptr {
299 1.1 reinoud struct desc_tag tag; /* use for extending the volume descriptor space */
300 1.1 reinoud uint32_t vds_number;
301 1.1 reinoud struct extent_ad next_vds_ex; /* points to the next block for volume descriptor space */
302 1.1 reinoud } __packed;
303 1.1 reinoud
304 1.1 reinoud
305 1.1 reinoud /* Primary Volume Descriptor [3/10.1] */
306 1.1 reinoud struct pri_vol_desc {
307 1.1 reinoud struct desc_tag tag;
308 1.1 reinoud uint32_t seq_num; /* MAX prevail */
309 1.1 reinoud uint32_t pvd_num; /* assigned by author; 0 is special as in it may only occure once */
310 1.1 reinoud char vol_id[32]; /* KEY ; main identifier of this disc */
311 1.1 reinoud uint16_t vds_num; /* volume descriptor number; i.e. what volume number is it */
312 1.1 reinoud uint16_t max_vol_seq; /* maximum volume descriptor number known */
313 1.1 reinoud uint16_t ichg_lvl;
314 1.1 reinoud uint16_t max_ichg_lvl;
315 1.1 reinoud uint32_t charset_list;
316 1.1 reinoud uint32_t max_charset_list;
317 1.1 reinoud char volset_id[128]; /* KEY ; if part of a multi-disc set or a band of volumes */
318 1.1 reinoud struct charspec desc_charset; /* KEY according to ECMA 167 */
319 1.1 reinoud struct charspec explanatory_charset;
320 1.1 reinoud struct extent_ad vol_abstract;
321 1.1 reinoud struct extent_ad vol_copyright;
322 1.1 reinoud struct regid app_id;
323 1.1 reinoud struct timestamp time;
324 1.1 reinoud struct regid imp_id;
325 1.1 reinoud uint8_t imp_use[64];
326 1.1 reinoud uint32_t prev_vds_loc; /* location of predecessor _lov ? */
327 1.1 reinoud uint16_t flags; /* bit 0 : if set indicates volume set name is meaningfull */
328 1.1 reinoud uint8_t reserved[22];
329 1.1 reinoud } __packed;
330 1.1 reinoud
331 1.1 reinoud
332 1.1 reinoud /* UDF specific implementation use part of the implementation use volume descriptor */
333 1.1 reinoud struct udf_lv_info {
334 1.1 reinoud struct charspec lvi_charset;
335 1.1 reinoud char logvol_id[128];
336 1.1 reinoud
337 1.1 reinoud char lvinfo1[36];
338 1.1 reinoud char lvinfo2[36];
339 1.1 reinoud char lvinfo3[36];
340 1.1 reinoud
341 1.1 reinoud struct regid impl_id;
342 1.1 reinoud uint8_t impl_use[128];
343 1.1 reinoud } __packed;
344 1.1 reinoud
345 1.1 reinoud
346 1.1 reinoud /* Implementation use Volume Descriptor */
347 1.1 reinoud struct impvol_desc {
348 1.1 reinoud struct desc_tag tag;
349 1.1 reinoud uint32_t seq_num;
350 1.1 reinoud struct regid impl_id;
351 1.1 reinoud union {
352 1.1 reinoud struct udf_lv_info lv_info;
353 1.1 reinoud char impl_use[460];
354 1.1 reinoud } __packed _impl_use;
355 1.1 reinoud } __packed;
356 1.1 reinoud
357 1.1 reinoud
358 1.1 reinoud /* Logical Volume Descriptor [3/10.6] */
359 1.1 reinoud struct logvol_desc {
360 1.1 reinoud struct desc_tag tag;
361 1.1 reinoud uint32_t seq_num; /* MAX prevail */
362 1.1 reinoud struct charspec desc_charset; /* KEY */
363 1.1 reinoud char logvol_id[128]; /* KEY */
364 1.1 reinoud uint32_t lb_size;
365 1.1 reinoud struct regid domain_id;
366 1.1 reinoud union {
367 1.1 reinoud struct long_ad fsd_loc; /* to fileset descriptor SEQUENCE */
368 1.1 reinoud uint8_t logvol_content_use[16];
369 1.1 reinoud } __packed _lvd_use;
370 1.1 reinoud uint32_t mt_l; /* Partition map length */
371 1.1 reinoud uint32_t n_pm; /* Number of partition maps */
372 1.1 reinoud struct regid imp_id;
373 1.1 reinoud uint8_t imp_use[128];
374 1.1 reinoud struct extent_ad integrity_seq_loc;
375 1.1 reinoud uint8_t maps[1];
376 1.1 reinoud } __packed;
377 1.1 reinoud #define lv_fsd_loc _lvd_use.fsd_loc
378 1.1 reinoud
379 1.1 reinoud #define UDF_INTEGRITY_OPEN 0
380 1.1 reinoud #define UDF_INTEGRITY_CLOSED 1
381 1.1 reinoud
382 1.1 reinoud
383 1.1 reinoud #define UDF_PMAP_SIZE 64
384 1.1 reinoud
385 1.1 reinoud /* Type 1 Partition Map [3/10.7.2] */
386 1.1 reinoud struct part_map_1 {
387 1.1 reinoud uint8_t type;
388 1.1 reinoud uint8_t len;
389 1.1 reinoud uint16_t vol_seq_num;
390 1.1 reinoud uint16_t part_num;
391 1.1 reinoud } __packed;
392 1.1 reinoud
393 1.1 reinoud
394 1.1 reinoud /* Type 2 Partition Map [3/10.7.3] */
395 1.1 reinoud struct part_map_2 {
396 1.1 reinoud uint8_t type;
397 1.1 reinoud uint8_t len;
398 1.1 reinoud uint8_t reserved[2];
399 1.1 reinoud struct regid part_id;
400 1.1 reinoud uint16_t vol_seq_num;
401 1.1 reinoud uint16_t part_num;
402 1.1 reinoud uint8_t reserved2[24];
403 1.1 reinoud } __packed;
404 1.1 reinoud
405 1.1 reinoud
406 1.1 reinoud /* Virtual Partition Map [UDF 2.01/2.2.8] */
407 1.1 reinoud struct part_map_virt {
408 1.1 reinoud uint8_t type;
409 1.1 reinoud uint8_t len;
410 1.1 reinoud uint8_t reserved[2];
411 1.1 reinoud struct regid id;
412 1.1 reinoud uint16_t vol_seq_num;
413 1.1 reinoud uint16_t part_num;
414 1.1 reinoud uint8_t reserved1[24];
415 1.1 reinoud } __packed;
416 1.1 reinoud
417 1.1 reinoud
418 1.1 reinoud /* Sparable Partition Map [UDF 2.01/2.2.9] */
419 1.1 reinoud struct part_map_spare {
420 1.1 reinoud uint8_t type;
421 1.1 reinoud uint8_t len;
422 1.1 reinoud uint8_t reserved[2];
423 1.1 reinoud struct regid id;
424 1.1 reinoud uint16_t vol_seq_num;
425 1.1 reinoud uint16_t part_num;
426 1.1 reinoud uint16_t packet_len;
427 1.1 reinoud uint8_t n_st; /* Number of redundant sparing tables range 1-4 */
428 1.1 reinoud uint8_t reserved1;
429 1.1 reinoud uint32_t st_size; /* size of EACH sparing table */
430 1.1 reinoud uint32_t st_loc[1]; /* locations of sparing tables */
431 1.1 reinoud } __packed;
432 1.1 reinoud
433 1.1 reinoud
434 1.1 reinoud /* Metadata Partition Map [UDF 2.50/2.2.10] */
435 1.1 reinoud struct part_map_meta {
436 1.1 reinoud uint8_t type;
437 1.1 reinoud uint8_t len;
438 1.1 reinoud uint8_t reserved[2];
439 1.1 reinoud struct regid id;
440 1.1 reinoud uint16_t vol_seq_num;
441 1.1 reinoud uint16_t part_num;
442 1.1 reinoud uint32_t meta_file_lbn; /* logical block number for file entry within part_num */
443 1.1 reinoud uint32_t meta_mirror_file_lbn;
444 1.1 reinoud uint32_t meta_bitmap_file_lbn;
445 1.1 reinoud uint32_t alloc_unit_size; /* allocation unit size in blocks */
446 1.1 reinoud uint16_t alignment_unit_size; /* alignment nessisary in blocks */
447 1.1 reinoud uint8_t flags;
448 1.1 reinoud uint8_t reserved1[5];
449 1.1 reinoud } __packed;
450 1.1 reinoud #define METADATA_DUPLICATED 1
451 1.1 reinoud
452 1.1 reinoud
453 1.1 reinoud union udf_pmap {
454 1.1 reinoud uint8_t data[UDF_PMAP_SIZE];
455 1.1 reinoud struct part_map_1 pm1;
456 1.1 reinoud struct part_map_2 pm2;
457 1.1 reinoud struct part_map_virt pmv;
458 1.1 reinoud struct part_map_spare pms;
459 1.1 reinoud struct part_map_meta pmm;
460 1.1 reinoud } __packed;
461 1.1 reinoud
462 1.1 reinoud
463 1.1 reinoud /* Sparing Map Entry [UDF 2.01/2.2.11] */
464 1.1 reinoud struct spare_map_entry {
465 1.1 reinoud uint32_t org; /* partion relative address */
466 1.1 reinoud uint32_t map; /* absolute disc address (!) can be in partion, but doesn't have to be */
467 1.1 reinoud } __packed;
468 1.1 reinoud
469 1.1 reinoud
470 1.1 reinoud /* Sparing Table [UDF 2.01/2.2.11] */
471 1.1 reinoud struct udf_sparing_table {
472 1.1 reinoud struct desc_tag tag;
473 1.1 reinoud struct regid id;
474 1.1 reinoud uint16_t rt_l; /* Relocation Table len */
475 1.1 reinoud uint8_t reserved[2];
476 1.1 reinoud uint32_t seq_num;
477 1.1 reinoud struct spare_map_entry entries[1];
478 1.1 reinoud } __packed;
479 1.1 reinoud
480 1.1 reinoud
481 1.3 reinoud #define UDF_NO_PREV_VAT 0xffffffff
482 1.3 reinoud /* UDF 1.50 VAT suffix [UDF 2.2.10 (UDF 1.50 spec)] */
483 1.3 reinoud struct udf_oldvat_tail {
484 1.3 reinoud struct regid id; /* "*UDF Virtual Alloc Tbl" */
485 1.3 reinoud uint32_t prev_vat;
486 1.3 reinoud } __packed;
487 1.3 reinoud
488 1.3 reinoud
489 1.1 reinoud /* VAT table [UDF 2.0.1/2.2.10] */
490 1.1 reinoud struct udf_vat {
491 1.1 reinoud uint16_t header_len;
492 1.1 reinoud uint16_t impl_use_len;
493 1.1 reinoud char logvol_id[128]; /* newer version of the LVD one */
494 1.1 reinoud uint32_t prev_vat;
495 1.1 reinoud uint32_t num_files;
496 1.1 reinoud uint32_t num_directories;
497 1.1 reinoud uint16_t min_udf_readver;
498 1.1 reinoud uint16_t min_udf_writever;
499 1.1 reinoud uint16_t max_udf_writever;
500 1.1 reinoud uint16_t reserved;
501 1.1 reinoud uint8_t data[1]; /* impl.use followed by VAT entries (uint32_t) */
502 1.1 reinoud } __packed;
503 1.1 reinoud
504 1.1 reinoud
505 1.1 reinoud /* Space bitmap descriptor as found in the partition header descriptor */
506 1.1 reinoud struct space_bitmap_desc {
507 1.1 reinoud struct desc_tag tag; /* TagId 264 */
508 1.1 reinoud uint32_t num_bits; /* number of bits */
509 1.1 reinoud uint32_t num_bytes; /* bytes that contain it */
510 1.1 reinoud uint8_t data[1];
511 1.1 reinoud } __packed;
512 1.1 reinoud
513 1.1 reinoud
514 1.1 reinoud /* Unalloc space entry as found in the partition header descriptor */
515 1.1 reinoud struct space_entry_desc {
516 1.1 reinoud struct desc_tag tag; /* TagId 263 */
517 1.1 reinoud struct icb_tag icbtag; /* type 1 */
518 1.1 reinoud uint32_t l_ad; /* in bytes */
519 1.1 reinoud uint8_t entry[1];
520 1.1 reinoud } __packed;
521 1.1 reinoud
522 1.1 reinoud
523 1.1 reinoud /* Partition header descriptor; in the contents_use of part_desc */
524 1.1 reinoud struct part_hdr_desc {
525 1.1 reinoud struct short_ad unalloc_space_table;
526 1.1 reinoud struct short_ad unalloc_space_bitmap;
527 1.1 reinoud struct short_ad part_integrety_table; /* has to be ZERO for UDF */
528 1.1 reinoud struct short_ad freed_space_table;
529 1.1 reinoud struct short_ad freed_space_bitmap;
530 1.1 reinoud uint8_t reserved[88];
531 1.1 reinoud } __packed;
532 1.1 reinoud
533 1.1 reinoud
534 1.1 reinoud /* Partition Descriptor [3/10.5] */
535 1.1 reinoud struct part_desc {
536 1.1 reinoud struct desc_tag tag;
537 1.1 reinoud uint32_t seq_num; /* MAX prevailing */
538 1.1 reinoud uint16_t flags; /* bit 0 : if set the space is allocated */
539 1.1 reinoud uint16_t part_num; /* KEY */
540 1.1 reinoud struct regid contents;
541 1.1 reinoud union {
542 1.1 reinoud struct part_hdr_desc part_hdr;
543 1.1 reinoud uint8_t contents_use[128];
544 1.1 reinoud } _impl_use;
545 1.1 reinoud uint32_t access_type; /* R/W, WORM etc. */
546 1.1 reinoud uint32_t start_loc; /* start of partion with given length */
547 1.1 reinoud uint32_t part_len;
548 1.1 reinoud struct regid imp_id;
549 1.1 reinoud uint8_t imp_use[128];
550 1.1 reinoud uint8_t reserved[156];
551 1.1 reinoud } __packed;
552 1.1 reinoud #define pd_part_hdr _impl_use.part_hdr
553 1.1 reinoud #define UDF_PART_FLAG_ALLOCATED 1
554 1.1 reinoud
555 1.1 reinoud
556 1.1 reinoud /* Unallocated Space Descriptor (UDF 2.01/2.2.5) */
557 1.1 reinoud struct unalloc_sp_desc {
558 1.1 reinoud struct desc_tag tag;
559 1.1 reinoud uint32_t seq_num; /* MAX prevailing */
560 1.1 reinoud uint32_t alloc_desc_num;
561 1.1 reinoud struct extent_ad alloc_desc[1];
562 1.1 reinoud } __packed;
563 1.1 reinoud
564 1.1 reinoud
565 1.1 reinoud /* Logical Volume Integrity Descriptor [3/30.10] */
566 1.1 reinoud struct logvolhdr {
567 1.1 reinoud uint64_t next_unique_id;
568 1.1 reinoud /* rest reserved */
569 1.1 reinoud } __packed;
570 1.1 reinoud
571 1.1 reinoud
572 1.1 reinoud struct udf_logvol_info {
573 1.1 reinoud struct regid impl_id;
574 1.1 reinoud uint32_t num_files;
575 1.1 reinoud uint32_t num_directories;
576 1.1 reinoud uint16_t min_udf_readver;
577 1.1 reinoud uint16_t min_udf_writever;
578 1.1 reinoud uint16_t max_udf_writever;
579 1.1 reinoud } __packed;
580 1.1 reinoud
581 1.1 reinoud
582 1.1 reinoud struct logvol_int_desc {
583 1.1 reinoud struct desc_tag tag;
584 1.1 reinoud struct timestamp time;
585 1.1 reinoud uint32_t integrity_type;
586 1.1 reinoud struct extent_ad next_extent;
587 1.1 reinoud union {
588 1.1 reinoud struct logvolhdr logvolhdr;
589 1.1 reinoud int8_t reserved[32];
590 1.1 reinoud } __packed _impl_use;
591 1.1 reinoud uint32_t num_part;
592 1.1 reinoud uint32_t l_iu;
593 1.1 reinoud uint32_t tables[1]; /* Freespace table, Sizetable, Implementation use */
594 1.1 reinoud } __packed;
595 1.1 reinoud #define lvint_next_unique_id _impl_use.logvolhdr.next_unique_id
596 1.1 reinoud
597 1.1 reinoud
598 1.1 reinoud /* File Set Descriptor [4/14.1] */
599 1.1 reinoud struct fileset_desc {
600 1.1 reinoud struct desc_tag tag;
601 1.1 reinoud struct timestamp time;
602 1.1 reinoud uint16_t ichg_lvl;
603 1.1 reinoud uint16_t max_ichg_lvl;
604 1.1 reinoud uint32_t charset_list;
605 1.1 reinoud uint32_t max_charset_list;
606 1.1 reinoud uint32_t fileset_num; /* key! */
607 1.1 reinoud uint32_t fileset_desc_num;
608 1.1 reinoud struct charspec logvol_id_charset;
609 1.1 reinoud char logvol_id[128]; /* for recovery */
610 1.1 reinoud struct charspec fileset_charset;
611 1.1 reinoud char fileset_id[32]; /* Mountpoint !! */
612 1.1 reinoud char copyright_file_id[32];
613 1.1 reinoud char abstract_file_id[32];
614 1.1 reinoud struct long_ad rootdir_icb; /* to rootdir; icb->virtual ? */
615 1.1 reinoud struct regid domain_id;
616 1.1 reinoud struct long_ad next_ex; /* to the next fileset_desc extent */
617 1.1 reinoud struct long_ad streamdir_icb; /* streamdir; needed? */
618 1.1 reinoud uint8_t reserved[32];
619 1.1 reinoud } __packed;
620 1.1 reinoud
621 1.1 reinoud
622 1.1 reinoud /* File Identifier Descriptor [4/14.4] */
623 1.1 reinoud struct fileid_desc {
624 1.1 reinoud struct desc_tag tag;
625 1.1 reinoud uint16_t file_version_num;
626 1.1 reinoud uint8_t file_char;
627 1.1 reinoud uint8_t l_fi; /* Length of file identifier area */
628 1.1 reinoud struct long_ad icb;
629 1.1 reinoud uint16_t l_iu; /* Length of implementation use area */
630 1.1 reinoud uint8_t data[1];
631 1.1 reinoud } __packed;
632 1.1 reinoud #define UDF_FID_SIZE 38
633 1.1 reinoud #define UDF_FILE_CHAR_VIS (1 << 0) /* Invisible */
634 1.1 reinoud #define UDF_FILE_CHAR_DIR (1 << 1) /* Directory */
635 1.1 reinoud #define UDF_FILE_CHAR_DEL (1 << 2) /* Deleted */
636 1.1 reinoud #define UDF_FILE_CHAR_PAR (1 << 3) /* Parent Directory */
637 1.1 reinoud #define UDF_FILE_CHAR_META (1 << 4) /* Stream metadata */
638 1.1 reinoud
639 1.1 reinoud
640 1.1 reinoud /* Extended attributes [4/14.10.1] */
641 1.1 reinoud struct extattrhdr_desc {
642 1.1 reinoud struct desc_tag tag;
643 1.1 reinoud uint32_t impl_attr_loc; /* offsets within this descriptor */
644 1.1 reinoud uint32_t appl_attr_loc; /* ditto */
645 1.1 reinoud } __packed;
646 1.1 reinoud #define UDF_IMPL_ATTR_LOC_NOT_PRESENT 0xffffffff
647 1.1 reinoud #define UDF_APPL_ATTR_LOC_NOT_PRESENT 0xffffffff
648 1.1 reinoud
649 1.1 reinoud
650 1.1 reinoud /* Extended attribute entry [4/48.10.2] */
651 1.1 reinoud struct extattr_entry {
652 1.1 reinoud uint32_t type;
653 1.1 reinoud uint8_t subtype;
654 1.1 reinoud uint8_t reserved[3];
655 1.1 reinoud uint32_t a_l;
656 1.1 reinoud } __packed;
657 1.1 reinoud
658 1.1 reinoud
659 1.1 reinoud /* Extended attribute entry; type 2048 [4/48.10.8] */
660 1.1 reinoud struct impl_extattr_entry {
661 1.1 reinoud struct extattr_entry hdr;
662 1.1 reinoud uint32_t iu_l;
663 1.1 reinoud struct regid imp_id;
664 1.1 reinoud uint8_t data[1];
665 1.1 reinoud } __packed;
666 1.1 reinoud
667 1.1 reinoud
668 1.1 reinoud /* Extended attribute entry; type 65 536 [4/48.10.9] */
669 1.1 reinoud struct appl_extattr_entry {
670 1.1 reinoud struct extattr_entry hdr;
671 1.1 reinoud uint32_t au_l;
672 1.1 reinoud struct regid appl_id;
673 1.1 reinoud uint8_t data[1];
674 1.1 reinoud } __packed;
675 1.1 reinoud
676 1.1 reinoud
677 1.1 reinoud /* File Times attribute entry; type 5 or type 6 [4/48.10.5], [4/48.10.6] */
678 1.1 reinoud struct filetimes_extattr_entry {
679 1.1 reinoud struct extattr_entry hdr;
680 1.1 reinoud uint32_t d_l; /* length of times[] data following */
681 1.1 reinoud uint32_t existence; /* bitmask */
682 1.1 reinoud struct timestamp times[1]; /* in order of assending bits */
683 1.1 reinoud } __packed;
684 1.1 reinoud
685 1.1 reinoud
686 1.1 reinoud /* Device Specification Extended Attribute [4/4.10.7] */
687 1.1 reinoud struct device_extattr_entry {
688 1.1 reinoud struct extattr_entry hdr;
689 1.1 reinoud uint32_t iu_l; /* length of implementation use */
690 1.1 reinoud uint32_t major;
691 1.1 reinoud uint32_t minor;
692 1.1 reinoud uint8_t data[1]; /* UDF: if nonzero length, contain developer ID regid */
693 1.1 reinoud } __packed;
694 1.1 reinoud
695 1.1 reinoud
696 1.3 reinoud /* VAT LV extension Extended Attribute [UDF 3.3.4.5.1.3] 1.50 errata */
697 1.3 reinoud struct vatlvext_extattr_entry {
698 1.3 reinoud uint64_t unique_id_chk; /* needs to be copy of ICB's */
699 1.3 reinoud uint32_t num_files;
700 1.3 reinoud uint32_t num_directories;
701 1.3 reinoud char logvol_id[128]; /* replaces logvol name */
702 1.3 reinoud } __packed;
703 1.3 reinoud
704 1.3 reinoud
705 1.1 reinoud /* File Entry [4/14.9] */
706 1.1 reinoud struct file_entry {
707 1.1 reinoud struct desc_tag tag;
708 1.1 reinoud struct icb_tag icbtag;
709 1.1 reinoud uint32_t uid;
710 1.1 reinoud uint32_t gid;
711 1.1 reinoud uint32_t perm;
712 1.1 reinoud uint16_t link_cnt;
713 1.1 reinoud uint8_t rec_format;
714 1.1 reinoud uint8_t rec_disp_attr;
715 1.1 reinoud uint32_t rec_len;
716 1.1 reinoud uint64_t inf_len;
717 1.1 reinoud uint64_t logblks_rec;
718 1.1 reinoud struct timestamp atime;
719 1.1 reinoud struct timestamp mtime;
720 1.1 reinoud struct timestamp attrtime;
721 1.1 reinoud uint32_t ckpoint;
722 1.1 reinoud struct long_ad ex_attr_icb;
723 1.1 reinoud struct regid imp_id;
724 1.1 reinoud uint64_t unique_id;
725 1.1 reinoud uint32_t l_ea; /* Length of extended attribute area */
726 1.1 reinoud uint32_t l_ad; /* Length of allocation descriptors */
727 1.1 reinoud uint8_t data[1];
728 1.1 reinoud } __packed;
729 1.1 reinoud #define UDF_FENTRY_SIZE 176
730 1.1 reinoud #define UDF_FENTRY_PERM_USER_MASK 0x07
731 1.1 reinoud #define UDF_FENTRY_PERM_GRP_MASK 0xE0
732 1.1 reinoud #define UDF_FENTRY_PERM_OWNER_MASK 0x1C00
733 1.1 reinoud
734 1.1 reinoud
735 1.1 reinoud /* Extended File Entry [4/48.17] */
736 1.1 reinoud struct extfile_entry {
737 1.1 reinoud struct desc_tag tag;
738 1.1 reinoud struct icb_tag icbtag;
739 1.1 reinoud uint32_t uid;
740 1.1 reinoud uint32_t gid;
741 1.1 reinoud uint32_t perm;
742 1.1 reinoud uint16_t link_cnt;
743 1.1 reinoud uint8_t rec_format;
744 1.1 reinoud uint8_t rec_disp_attr;
745 1.1 reinoud uint32_t rec_len;
746 1.1 reinoud uint64_t inf_len;
747 1.1 reinoud uint64_t obj_size;
748 1.1 reinoud uint64_t logblks_rec;
749 1.1 reinoud struct timestamp atime;
750 1.1 reinoud struct timestamp mtime;
751 1.1 reinoud struct timestamp ctime;
752 1.1 reinoud struct timestamp attrtime;
753 1.1 reinoud uint32_t ckpoint;
754 1.1 reinoud uint32_t reserved1;
755 1.1 reinoud struct long_ad ex_attr_icb;
756 1.1 reinoud struct long_ad streamdir_icb;
757 1.1 reinoud struct regid imp_id;
758 1.1 reinoud uint64_t unique_id;
759 1.1 reinoud uint32_t l_ea; /* Length of extended attribute area */
760 1.1 reinoud uint32_t l_ad; /* Length of allocation descriptors */
761 1.1 reinoud uint8_t data[1];
762 1.1 reinoud } __packed;
763 1.1 reinoud
764 1.1 reinoud
765 1.1 reinoud /* Indirect entry [ecma 48.7] */
766 1.1 reinoud struct indirect_entry {
767 1.1 reinoud struct desc_tag tag;
768 1.1 reinoud struct icb_tag icbtag;
769 1.1 reinoud struct long_ad indirect_icb;
770 1.1 reinoud } __packed;
771 1.1 reinoud
772 1.1 reinoud
773 1.1 reinoud /* Allocation extent descritor [ecma 48.5] */
774 1.1 reinoud struct alloc_ext_entry {
775 1.1 reinoud struct desc_tag tag;
776 1.1 reinoud uint32_t prev_entry;
777 1.1 reinoud uint32_t l_ad;
778 1.1 reinoud uint8_t data[1];
779 1.1 reinoud } __packed;
780 1.1 reinoud
781 1.1 reinoud
782 1.1 reinoud union dscrptr {
783 1.1 reinoud struct desc_tag tag;
784 1.1 reinoud struct anchor_vdp avdp;
785 1.1 reinoud struct vol_desc_ptr vdp;
786 1.1 reinoud struct pri_vol_desc pvd;
787 1.1 reinoud struct logvol_desc lvd;
788 1.1 reinoud struct unalloc_sp_desc usd;
789 1.1 reinoud struct logvol_int_desc lvid;
790 1.1 reinoud struct impvol_desc ivd;
791 1.1 reinoud struct part_desc pd;
792 1.1 reinoud struct fileset_desc fsd;
793 1.1 reinoud struct fileid_desc fid;
794 1.1 reinoud struct file_entry fe;
795 1.1 reinoud struct extfile_entry efe;
796 1.1 reinoud struct extattrhdr_desc eahd;
797 1.1 reinoud struct indirect_entry inde;
798 1.1 reinoud struct alloc_ext_entry aee;
799 1.1 reinoud struct udf_sparing_table spt;
800 1.1 reinoud struct space_bitmap_desc sbd;
801 1.1 reinoud struct space_entry_desc sed;
802 1.1 reinoud } __packed;
803 1.1 reinoud
804 1.1 reinoud
805 1.1 reinoud /* Useful defines */
806 1.1 reinoud
807 1.1 reinoud #define GETICB(ad_type, fentry, offset) \
808 1.1 reinoud (struct ad_type *)&fentry->data[offset]
809 1.1 reinoud
810 1.1 reinoud #define GETICBLEN(ad_type, icb) ((struct ad_type *)(icb))->len
811 1.1 reinoud
812 1.1 reinoud
813 1.2 reinoud #endif /* !_FS_UDF_ECMA167_UDF_H_ */
814 1.1 reinoud
815