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