udf.h revision 1.12.2.4
1 /* $NetBSD: udf.h,v 1.12.2.4 2008/07/22 05:44:02 simonb Exp $ */ 2 3 /* 4 * Copyright (c) 2006, 2008 Reinoud Zandijk 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26 * 27 */ 28 29 #ifndef _FS_UDF_UDF_H_ 30 #define _FS_UDF_UDF_H_ 31 32 #include <sys/queue.h> 33 #include <sys/uio.h> 34 #include <sys/mutex.h> 35 36 #include "udf_osta.h" 37 #include "ecma167-udf.h" 38 #include <sys/cdio.h> 39 #include <sys/bufq.h> 40 #include <sys/disk.h> 41 #include <sys/kthread.h> 42 #include <miscfs/genfs/genfs_node.h> 43 44 /* debug section */ 45 extern int udf_verbose; 46 47 /* undefine UDF_COMPLETE_DELETE to need `purge'; but purge is not implemented */ 48 #define UDF_COMPLETE_DELETE 49 50 /* debug categories */ 51 #define UDF_DEBUG_VOLUMES 0x000001 52 #define UDF_DEBUG_LOCKING 0x000002 53 #define UDF_DEBUG_NODE 0x000004 54 #define UDF_DEBUG_LOOKUP 0x000008 55 #define UDF_DEBUG_READDIR 0x000010 56 #define UDF_DEBUG_FIDS 0x000020 57 #define UDF_DEBUG_DESCRIPTOR 0x000040 58 #define UDF_DEBUG_TRANSLATE 0x000080 59 #define UDF_DEBUG_STRATEGY 0x000100 60 #define UDF_DEBUG_READ 0x000200 61 #define UDF_DEBUG_WRITE 0x000400 62 #define UDF_DEBUG_CALL 0x000800 63 #define UDF_DEBUG_ATTR 0x001000 64 #define UDF_DEBUG_EXTATTR 0x002000 65 #define UDF_DEBUG_ALLOC 0x004000 66 #define UDF_DEBUG_ADWLK 0x008000 67 #define UDF_DEBUG_DIRHASH 0x010000 68 #define UDF_DEBUG_NOTIMPL 0x020000 69 #define UDF_DEBUG_SHEDULE 0x040000 70 #define UDF_DEBUG_ECCLINE 0x080000 71 #define UDF_DEBUG_SYNC 0x100000 72 #define UDF_DEBUG_PARANOIA 0x200000 73 #define UDF_DEBUG_PARANOIDADWLK 0x400000 74 #define UDF_DEBUG_NODEDUMP 0x800000 75 76 /* initial value of udf_verbose */ 77 #define UDF_DEBUGGING 0 78 79 #ifdef DEBUG 80 #define DPRINTF(name, arg) { \ 81 if (udf_verbose & UDF_DEBUG_##name) {\ 82 printf arg;\ 83 };\ 84 } 85 #define DPRINTFIF(name, cond, arg) { \ 86 if (udf_verbose & UDF_DEBUG_##name) { \ 87 if (cond) printf arg;\ 88 };\ 89 } 90 #else 91 #define DPRINTF(name, arg) {} 92 #define DPRINTFIF(name, cond, arg) {} 93 #endif 94 95 96 /* constants to identify what kind of identifier we are dealing with */ 97 #define UDF_REGID_DOMAIN 1 98 #define UDF_REGID_UDF 2 99 #define UDF_REGID_IMPLEMENTATION 3 100 #define UDF_REGID_APPLICATION 4 101 #define UDF_REGID_NAME 99 102 103 104 /* DON'T change these: they identify 13thmonkey's UDF implementation */ 105 #define APP_NAME "*NetBSD UDF" 106 #define APP_VERSION_MAIN 0 107 #define APP_VERSION_SUB 4 108 #define IMPL_NAME "*NetBSD kernel UDF" 109 110 111 /* Configuration values */ 112 #define UDF_INODE_HASHBITS 10 113 #define UDF_INODE_HASHSIZE (1<<UDF_INODE_HASHBITS) 114 #define UDF_INODE_HASHMASK (UDF_INODE_HASHSIZE - 1) 115 #define UDF_ECCBUF_HASHBITS 10 116 #define UDF_ECCBUF_HASHSIZE (1<<UDF_ECCBUF_HASHBITS) 117 #define UDF_ECCBUF_HASHMASK (UDF_ECCBUF_HASHSIZE -1) 118 119 #define UDF_DIRHASH_HASHBITS 5 120 #define UDF_DIRHASH_HASHSIZE (1<<UDF_DIRHASH_HASHBITS) 121 #define UDF_DIRHASH_HASHMASK (UDF_DIRHASH_HASHSIZE -1) 122 123 #define UDF_ECCLINE_MAXFREE 10 /* picked */ 124 #define UDF_ECCLINE_MAXBUSY 100 /* picked */ 125 126 #define UDF_MAX_MAPPINGS (MAXPHYS/DEV_BSIZE) /* 128 */ 127 #define UDF_VAT_CHUNKSIZE (64*1024) /* picked */ 128 #define UDF_SYMLINKBUFLEN (64*1024) /* picked */ 129 130 131 /* structure space */ 132 #define UDF_ANCHORS 4 /* 256, 512, N-256, N */ 133 #define UDF_PARTITIONS 4 /* overkill */ 134 #define UDF_PMAPS 5 /* overkill */ 135 #define UDF_LVDINT_SEGMENTS 100 /* big overkill */ 136 #define UDF_LVINT_LOSSAGE 4 /* lose 2 openings */ 137 #define UDF_MAX_ALLOC_EXTENTS 50 /* overkill */ 138 139 140 /* constants */ 141 #define UDF_MAX_NAMELEN 255 /* as per SPEC */ 142 #define UDF_TRANS_ZERO ((uint64_t) -1) 143 #define UDF_TRANS_UNMAPPED ((uint64_t) -2) 144 #define UDF_TRANS_INTERN ((uint64_t) -3) 145 #define UDF_MAX_SECTOR ((uint64_t) -10) /* high water mark */ 146 147 148 /* RW content hint for allocation and other purposes */ 149 #define UDF_C_PROCESSED 0 /* not relevant */ 150 #define UDF_C_USERDATA 1 /* all but userdata is metadata */ 151 //#define UDF_C_METADATA 2 /* unspecified metadata */ 152 #define UDF_C_DSCR 3 /* update sectornr and CRC */ 153 #define UDF_C_NODE 4 /* file/dir node, update sectornr and CRC */ 154 #define UDF_C_EXTATTRS 5 /* dunno what to do yet */ 155 #define UDF_C_FIDS 6 /* update all contained fids */ 156 157 158 /* use unused b_freelistindex for our UDF_C_TYPE */ 159 #define b_udf_c_type b_freelistindex 160 161 162 /* virtual to physical mapping types */ 163 #define UDF_VTOP_RAWPART UDF_PMAPS /* [0..UDF_PMAPS> are normal */ 164 165 #define UDF_VTOP_TYPE_RAW 0 166 #define UDF_VTOP_TYPE_UNKNOWN 0 167 #define UDF_VTOP_TYPE_PHYS 1 168 #define UDF_VTOP_TYPE_VIRT 2 169 #define UDF_VTOP_TYPE_SPARABLE 3 170 #define UDF_VTOP_TYPE_META 4 171 172 173 /* allocation strategies */ 174 #define UDF_ALLOC_SEQUENTIAL 1 /* linear on NWA */ 175 #define UDF_ALLOC_VAT 2 /* VAT handling */ 176 #define UDF_ALLOC_SPACEMAP 3 /* spacemaps */ 177 #define UDF_ALLOC_METABITMAP 4 /* metadata bitmap */ 178 #define UDF_ALLOC_METASEQUENTIAL 5 /* in chunks seq., nodes not seq */ 179 #define UDF_ALLOC_RELAXEDSEQUENTIAL 6 /* only nodes not seq. */ 180 181 182 /* logical volume open/close actions */ 183 #define UDF_OPEN_SESSION 0x01 /* if needed writeout VRS + VDS */ 184 #define UDF_CLOSE_SESSION 0x02 /* close session after writing VAT */ 185 #define UDF_WRITE_VAT 0x04 /* sequential VAT filesystem */ 186 #define UDF_WRITE_LVINT 0x08 /* write out open lvint */ 187 #define UDF_WRITE_PART_BITMAPS 0x10 /* write out partition space bitmaps */ 188 #define UDF_APPENDONLY_LVINT 0x20 /* no shifting, only appending */ 189 #define UDFLOGVOL_BITS "\20\1OPENSESSION\2CLOSESESSION\3WRITEVAT\4WRITELVINT"\ 190 "\5APPENDONLY" 191 192 /* logical volume error handling actions */ 193 #define UDF_UPDATE_TRACKINFO 0x01 /* update trackinfo and re-shedule */ 194 #define UDF_REMAP_BLOCK 0x02 /* remap the failing block length */ 195 #define UDFONERROR_BITS "\20\1UPDATE_TRACKINFO\2REMAP_BLOCK" 196 197 198 /* readdir cookies */ 199 #define UDF_DIRCOOKIE_DOT 1 200 201 202 /* malloc pools */ 203 MALLOC_DECLARE(M_UDFMNT); 204 MALLOC_DECLARE(M_UDFVOLD); 205 MALLOC_DECLARE(M_UDFTEMP); 206 207 struct pool udf_node_pool; 208 struct pool udf_dirhash_pool; 209 struct pool udf_dirhash_entry_pool; 210 struct udf_node; 211 struct udf_strategy; 212 213 214 struct udf_lvintq { 215 uint32_t start; 216 uint32_t end; 217 uint32_t pos; 218 uint32_t wpos; 219 }; 220 221 222 struct udf_bitmap { 223 uint8_t *blob; /* allocated */ 224 uint8_t *bits; /* bits themselves */ 225 uint8_t *pages; /* dirty pages */ 226 uint32_t max_offset; /* in bits */ 227 uint32_t data_pos; /* position in data */ 228 uint32_t metadata_pos; /* .. in metadata */ 229 }; 230 231 232 struct udf_strat_args { 233 struct udf_mount *ump; 234 struct udf_node *udf_node; 235 struct long_ad *icb; 236 union dscrptr *dscr; 237 struct buf *nestbuf; 238 kauth_cred_t cred; 239 int waitfor; 240 }; 241 242 struct udf_strategy { 243 int (*create_logvol_dscr) (struct udf_strat_args *args); 244 void (*free_logvol_dscr) (struct udf_strat_args *args); 245 int (*read_logvol_dscr) (struct udf_strat_args *args); 246 int (*write_logvol_dscr) (struct udf_strat_args *args); 247 void (*queuebuf) (struct udf_strat_args *args); 248 void (*discstrat_init) (struct udf_strat_args *args); 249 void (*discstrat_finish) (struct udf_strat_args *args); 250 }; 251 252 extern struct udf_strategy udf_strat_bootstrap; 253 extern struct udf_strategy udf_strat_sequential; 254 extern struct udf_strategy udf_strat_direct; 255 extern struct udf_strategy udf_strat_rmw; 256 257 258 /* pre cleanup */ 259 struct udf_mount { 260 struct mount *vfs_mountp; 261 struct vnode *devvp; 262 struct mmc_discinfo discinfo; 263 struct udf_args mount_args; 264 265 /* format descriptors */ 266 kmutex_t logvol_mutex; 267 struct anchor_vdp *anchors[UDF_ANCHORS]; /* anchors to VDS */ 268 struct pri_vol_desc *primary_vol; /* identification */ 269 struct logvol_desc *logical_vol; /* main mapping v->p */ 270 struct unalloc_sp_desc *unallocated; /* free UDF space */ 271 struct impvol_desc *implementation; /* likely reduntant */ 272 struct logvol_int_desc *logvol_integrity; /* current integrity */ 273 struct part_desc *partitions[UDF_PARTITIONS]; /* partitions */ 274 /* logvol_info is derived; points *into* other structures */ 275 struct udf_logvol_info *logvol_info; /* integrity descr. */ 276 277 /* fileset and root directories */ 278 struct fileset_desc *fileset_desc; /* normally one */ 279 280 /* tracing logvol integrity history */ 281 struct udf_lvintq lvint_trace[UDF_LVDINT_SEGMENTS]; 282 int lvopen; /* logvol actions */ 283 int lvclose; /* logvol actions */ 284 285 /* disc allocation / writing method */ 286 int lvreadwrite; /* error handling */ 287 int data_alloc; /* all userdata */ 288 int data_allocdscr; 289 int meta_alloc; /* all metadata */ 290 int meta_allocdscr; 291 int data_part; 292 int metadata_part; 293 kmutex_t allocate_mutex; 294 295 /* logical to physical translations */ 296 int vtop[UDF_PMAPS+1]; /* vpartnr trans */ 297 int vtop_tp[UDF_PMAPS+1]; /* type of trans */ 298 299 /* sequential track info */ 300 struct mmc_trackinfo data_track; 301 struct mmc_trackinfo metadata_track; 302 303 /* VAT */ 304 uint32_t first_possible_vat_location; 305 uint32_t last_possible_vat_location; 306 uint32_t vat_entries; 307 uint32_t vat_offset; /* offset in table */ 308 uint32_t vat_last_free_lb; /* last free lb_num */ 309 uint32_t vat_table_len; 310 uint32_t vat_table_alloc_len; 311 uint8_t *vat_table; 312 uint8_t *vat_pages; /* TODO */ 313 struct udf_node *vat_node; /* system node */ 314 315 /* space bitmaps */ 316 struct space_bitmap_desc*part_unalloc_dscr[UDF_PARTITIONS]; 317 struct space_bitmap_desc*part_freed_dscr [UDF_PARTITIONS]; 318 struct udf_bitmap part_unalloc_bits[UDF_PARTITIONS]; 319 struct udf_bitmap part_freed_bits [UDF_PARTITIONS]; 320 321 /* sparable */ 322 uint32_t sparable_packet_size; 323 uint32_t packet_size; 324 struct udf_sparing_table*sparing_table; 325 326 /* meta */ 327 struct udf_node *metadata_node; /* system node */ 328 struct udf_node *metadatamirror_node; /* system node */ 329 struct udf_node *metadatabitmap_node; /* system node */ 330 struct udf_bitmap metadata_bitmap; /* TODO : readin */ 331 332 /* hash table to lookup icb -> udf_node and sorted list for sync */ 333 kmutex_t ihash_lock; 334 kmutex_t get_node_lock; 335 LIST_HEAD(, udf_node) udf_nodes[UDF_INODE_HASHSIZE]; 336 LIST_HEAD(, udf_node) sorted_udf_nodes; /* sorted sync list */ 337 338 /* syncing */ 339 int syncing; /* are we syncing? */ 340 kcondvar_t dirtynodes_cv; /* sleeping on sync */ 341 342 /* late allocation */ 343 uint32_t uncomitted_lb; /* for free space */ 344 struct long_ad *la_node_ad_cpy; /* issue buf */ 345 uint64_t *la_lmapping, *la_pmapping; /* issue buf */ 346 347 /* lists */ 348 STAILQ_HEAD(udfmntpts, udf_mount) all_udf_mntpnts; 349 350 /* device strategy */ 351 struct udf_strategy *strategy; 352 void *strategy_private; 353 }; 354 355 356 /* dirent's d_namlen is to avoid useless costly fid->dirent translations */ 357 struct udf_dirhash_entry { 358 uint32_t hashvalue; 359 uint64_t offset; 360 uint32_t d_namlen; 361 uint32_t fid_size; 362 LIST_ENTRY(udf_dirhash_entry) next; 363 }; 364 365 366 struct udf_dirhash { 367 LIST_HEAD(, udf_dirhash_entry) entries[UDF_DIRHASH_HASHSIZE]; 368 LIST_HEAD(, udf_dirhash_entry) free_entries; 369 }; 370 371 372 /* 373 * UDF node describing a file/directory. 374 * 375 * BUGALERT claim node_mutex before reading/writing to prevent inconsistencies ! 376 */ 377 struct udf_node { 378 struct genfs_node i_gnode; /* has to be first */ 379 struct vnode *vnode; /* vnode associated */ 380 struct udf_mount *ump; 381 382 kmutex_t node_mutex; 383 kcondvar_t node_lock; /* sleeping lock */ 384 char const *lock_fname; 385 int lock_lineno; 386 387 /* one of `fe' or `efe' can be set, not both (UDF file entry dscr.) */ 388 struct file_entry *fe; 389 struct extfile_entry *efe; 390 struct alloc_ext_entry *ext[UDF_MAX_ALLOC_EXTENTS]; 391 int num_extensions; 392 393 /* location found, recording location & hints */ 394 struct long_ad loc; /* FID/hash loc. */ 395 struct long_ad write_loc; /* strat 4096 loc */ 396 int needs_indirect; /* has missing indr. */ 397 struct long_ad ext_loc[UDF_MAX_ALLOC_EXTENTS]; 398 399 struct udf_dirhash *dir_hash; 400 401 /* misc */ 402 uint32_t i_flags; /* associated flags */ 403 struct lockf *lockf; /* lock list */ 404 uint32_t outstanding_bufs; /* file data */ 405 uint32_t outstanding_nodedscr; /* node dscr */ 406 407 /* references to associated nodes */ 408 struct udf_node *extattr; 409 struct udf_node *streamdir; 410 struct udf_node *my_parent; /* if extended attr. */ 411 412 LIST_ENTRY(udf_node) hashchain; /* inside hash line */ 413 LIST_ENTRY(udf_node) sortchain; /* sorted udf nodes */ 414 }; 415 416 417 /* misc. flags stored in i_flags (XXX needs cleaning up) */ 418 #define IN_ACCESS 0x0001 /* Inode access time update request */ 419 #define IN_CHANGE 0x0002 /* Inode change time update request */ 420 #define IN_UPDATE 0x0004 /* Inode was written to; update mtime*/ 421 #define IN_MODIFY 0x0008 /* Modification time update request */ 422 #define IN_MODIFIED 0x0010 /* node has been modified */ 423 #define IN_ACCESSED 0x0020 /* node has been accessed */ 424 #define IN_RENAME 0x0040 /* node is being renamed. XXX ?? */ 425 #define IN_DELETED 0x0080 /* node is unlinked, no FID reference*/ 426 #define IN_LOCKED 0x0100 /* node is locked by condvar */ 427 #define IN_SYNCED 0x0200 /* node is being used by sync */ 428 #define IN_CALLBACK_ULK 0x0400 /* node will be unlocked by callback */ 429 #define IN_NODE_REBUILD 0x0800 /* node is rebuild */ 430 #define IN_DIRHASH_COMPLETE 0x1000 /* dirhash is complete */ 431 #define IN_DIRHASH_BROKEN 0x2000 /* dirhash is broken on readin */ 432 433 434 #define IN_FLAGBITS \ 435 "\10\1IN_ACCESS\2IN_CHANGE\3IN_UPDATE\4IN_MODIFY\5IN_MODIFIED" \ 436 "\6IN_ACCESSED\7IN_RENAME\10IN_DELETED\11IN_LOCKED\12IN_SYNCED" \ 437 "\13IN_CALLBACK_ULK\14IN_NODE_REBUILD\15IN_DIRHASH_COMPLETE" \ 438 "\16IN_DIRHASH_BROKEN" 439 440 #endif /* !_FS_UDF_UDF_H_ */ 441
Indexes created Thu Oct 02 10:09:58 GMT 2025