udf.h revision 1.12.2.6
1 /* $NetBSD: udf.h,v 1.12.2.6 2008/07/31 04:51: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_DEFAULTMEM (1024*1024) 120 #define UDF_DIRHASH_HASHBITS 5 121 #define UDF_DIRHASH_HASHSIZE (1<<UDF_DIRHASH_HASHBITS) 122 #define UDF_DIRHASH_HASHMASK (UDF_DIRHASH_HASHSIZE -1) 123 124 #define UDF_ECCLINE_MAXFREE 10 /* picked */ 125 #define UDF_ECCLINE_MAXBUSY 100 /* picked */ 126 127 #define UDF_MAX_MAPPINGS (MAXPHYS/DEV_BSIZE) /* 128 */ 128 #define UDF_VAT_CHUNKSIZE (64*1024) /* picked */ 129 #define UDF_SYMLINKBUFLEN (64*1024) /* picked */ 130 131 132 /* structure space */ 133 #define UDF_ANCHORS 4 /* 256, 512, N-256, N */ 134 #define UDF_PARTITIONS 4 /* overkill */ 135 #define UDF_PMAPS 5 /* overkill */ 136 #define UDF_LVDINT_SEGMENTS 100 /* big overkill */ 137 #define UDF_LVINT_LOSSAGE 4 /* lose 2 openings */ 138 #define UDF_MAX_ALLOC_EXTENTS 50 /* overkill */ 139 140 141 /* constants */ 142 #define UDF_MAX_NAMELEN 255 /* as per SPEC */ 143 #define UDF_TRANS_ZERO ((uint64_t) -1) 144 #define UDF_TRANS_UNMAPPED ((uint64_t) -2) 145 #define UDF_TRANS_INTERN ((uint64_t) -3) 146 #define UDF_MAX_SECTOR ((uint64_t) -10) /* high water mark */ 147 148 149 /* RW content hint for allocation and other purposes */ 150 #define UDF_C_PROCESSED 0 /* not relevant */ 151 #define UDF_C_USERDATA 1 /* all but userdata is metadata */ 152 #define UDF_C_DSCR 2 /* update sectornr and CRC */ 153 #define UDF_C_NODE 3 /* file/dir node, update sectornr and CRC */ 154 #define UDF_C_FIDS 4 /* update all contained fids */ 155 #define UDF_C_METADATA_SBM 5 /* space bitmap, update sectornr and CRC */ 156 #define UDF_C_EXTATTRS 6 /* dunno what to do yet */ 157 158 159 /* use unused b_freelistindex for our UDF_C_TYPE */ 160 #define b_udf_c_type b_freelistindex 161 162 163 /* virtual to physical mapping types */ 164 #define UDF_VTOP_RAWPART UDF_PMAPS /* [0..UDF_PMAPS> are normal */ 165 166 #define UDF_VTOP_TYPE_RAW 0 167 #define UDF_VTOP_TYPE_UNKNOWN 0 168 #define UDF_VTOP_TYPE_PHYS 1 169 #define UDF_VTOP_TYPE_VIRT 2 170 #define UDF_VTOP_TYPE_SPARABLE 3 171 #define UDF_VTOP_TYPE_META 4 172 173 174 /* allocation strategies */ 175 #define UDF_ALLOC_SEQUENTIAL 1 /* linear on NWA */ 176 #define UDF_ALLOC_VAT 2 /* VAT handling */ 177 #define UDF_ALLOC_SPACEMAP 3 /* spacemaps */ 178 #define UDF_ALLOC_METABITMAP 4 /* metadata bitmap */ 179 #define UDF_ALLOC_METASEQUENTIAL 5 /* in chunks seq., nodes not seq */ 180 #define UDF_ALLOC_RELAXEDSEQUENTIAL 6 /* only nodes not seq. */ 181 182 183 /* logical volume open/close actions */ 184 #define UDF_OPEN_SESSION 0x01 /* if needed writeout VRS + VDS */ 185 #define UDF_CLOSE_SESSION 0x02 /* close session after writing VAT */ 186 #define UDF_WRITE_VAT 0x04 /* sequential VAT filesystem */ 187 #define UDF_WRITE_LVINT 0x08 /* write out open lvint */ 188 #define UDF_WRITE_PART_BITMAPS 0x10 /* write out partition space bitmaps */ 189 #define UDF_APPENDONLY_LVINT 0x20 /* no shifting, only appending */ 190 #define UDFLOGVOL_BITS "\20\1OPENSESSION\2CLOSESESSION\3WRITEVAT\4WRITELVINT"\ 191 "\5APPENDONLY" 192 193 /* logical volume error handling actions */ 194 #define UDF_UPDATE_TRACKINFO 0x01 /* update trackinfo and re-shedule */ 195 #define UDF_REMAP_BLOCK 0x02 /* remap the failing block length */ 196 #define UDFONERROR_BITS "\20\1UPDATE_TRACKINFO\2REMAP_BLOCK" 197 198 199 /* readdir cookies */ 200 #define UDF_DIRCOOKIE_DOT 1 201 202 203 /* malloc pools */ 204 MALLOC_DECLARE(M_UDFMNT); 205 MALLOC_DECLARE(M_UDFVOLD); 206 MALLOC_DECLARE(M_UDFTEMP); 207 208 struct pool udf_node_pool; 209 struct pool udf_dirhash_pool; 210 struct pool udf_dirhash_entry_pool; 211 struct udf_node; 212 struct udf_strategy; 213 214 215 struct udf_lvintq { 216 uint32_t start; 217 uint32_t end; 218 uint32_t pos; 219 uint32_t wpos; 220 }; 221 222 223 struct udf_bitmap { 224 uint8_t *blob; /* allocated */ 225 uint8_t *bits; /* bits themselves */ 226 uint8_t *pages; /* dirty pages */ 227 uint32_t max_offset; /* in bits */ 228 uint32_t data_pos; /* position in data */ 229 uint32_t metadata_pos; /* .. in metadata */ 230 }; 231 232 233 struct udf_strat_args { 234 struct udf_mount *ump; 235 struct udf_node *udf_node; 236 struct long_ad *icb; 237 union dscrptr *dscr; 238 struct buf *nestbuf; 239 kauth_cred_t cred; 240 int waitfor; 241 }; 242 243 struct udf_strategy { 244 int (*create_logvol_dscr) (struct udf_strat_args *args); 245 void (*free_logvol_dscr) (struct udf_strat_args *args); 246 int (*read_logvol_dscr) (struct udf_strat_args *args); 247 int (*write_logvol_dscr) (struct udf_strat_args *args); 248 void (*queuebuf) (struct udf_strat_args *args); 249 void (*discstrat_init) (struct udf_strat_args *args); 250 void (*discstrat_finish) (struct udf_strat_args *args); 251 }; 252 253 extern struct udf_strategy udf_strat_bootstrap; 254 extern struct udf_strategy udf_strat_sequential; 255 extern struct udf_strategy udf_strat_direct; 256 extern struct udf_strategy udf_strat_rmw; 257 258 259 /* pre cleanup */ 260 struct udf_mount { 261 struct mount *vfs_mountp; 262 struct vnode *devvp; 263 struct mmc_discinfo discinfo; 264 struct udf_args mount_args; 265 266 /* format descriptors */ 267 kmutex_t logvol_mutex; 268 struct anchor_vdp *anchors[UDF_ANCHORS]; /* anchors to VDS */ 269 struct pri_vol_desc *primary_vol; /* identification */ 270 struct logvol_desc *logical_vol; /* main mapping v->p */ 271 struct unalloc_sp_desc *unallocated; /* free UDF space */ 272 struct impvol_desc *implementation; /* likely reduntant */ 273 struct logvol_int_desc *logvol_integrity; /* current integrity */ 274 struct part_desc *partitions[UDF_PARTITIONS]; /* partitions */ 275 /* logvol_info is derived; points *into* other structures */ 276 struct udf_logvol_info *logvol_info; /* integrity descr. */ 277 278 /* fileset and root directories */ 279 struct fileset_desc *fileset_desc; /* normally one */ 280 281 /* tracing logvol integrity history */ 282 struct udf_lvintq lvint_trace[UDF_LVDINT_SEGMENTS]; 283 int lvopen; /* logvol actions */ 284 int lvclose; /* logvol actions */ 285 286 /* disc allocation / writing method */ 287 int lvreadwrite; /* error handling */ 288 int data_alloc; /* all userdata */ 289 int data_allocdscr; 290 int meta_alloc; /* all metadata */ 291 int meta_allocdscr; 292 int data_part; 293 int metadata_part; 294 kmutex_t allocate_mutex; 295 296 /* logical to physical translations */ 297 int vtop[UDF_PMAPS+1]; /* vpartnr trans */ 298 int vtop_tp[UDF_PMAPS+1]; /* type of trans */ 299 300 /* sequential track info */ 301 struct mmc_trackinfo data_track; 302 struct mmc_trackinfo metadata_track; 303 304 /* VAT */ 305 uint32_t first_possible_vat_location; 306 uint32_t last_possible_vat_location; 307 uint32_t vat_entries; 308 uint32_t vat_offset; /* offset in table */ 309 uint32_t vat_last_free_lb; /* last free lb_num */ 310 uint32_t vat_table_len; 311 uint32_t vat_table_alloc_len; 312 uint8_t *vat_table; 313 uint8_t *vat_pages; /* TODO */ 314 struct udf_node *vat_node; /* system node */ 315 316 /* space bitmaps for physical partitions */ 317 struct space_bitmap_desc*part_unalloc_dscr[UDF_PARTITIONS]; 318 struct space_bitmap_desc*part_freed_dscr [UDF_PARTITIONS]; 319 struct udf_bitmap part_unalloc_bits[UDF_PARTITIONS]; 320 struct udf_bitmap part_freed_bits [UDF_PARTITIONS]; 321 322 /* sparable */ 323 uint32_t sparable_packet_size; 324 uint32_t packet_size; 325 struct udf_sparing_table*sparing_table; 326 327 /* meta */ 328 struct udf_node *metadata_node; /* system node */ 329 struct udf_node *metadatamirror_node; /* system node */ 330 struct udf_node *metadatabitmap_node; /* system node */ 331 struct space_bitmap_desc*metadata_unalloc_dscr; 332 struct udf_bitmap metadata_unalloc_bits; 333 334 /* hash table to lookup icb -> udf_node and sorted list for sync */ 335 kmutex_t ihash_lock; 336 kmutex_t get_node_lock; 337 LIST_HEAD(, udf_node) udf_nodes[UDF_INODE_HASHSIZE]; 338 LIST_HEAD(, udf_node) sorted_udf_nodes; /* sorted sync list */ 339 340 /* syncing */ 341 int syncing; /* are we syncing? */ 342 kcondvar_t dirtynodes_cv; /* sleeping on sync */ 343 344 /* late allocation */ 345 uint32_t uncomitted_lb; /* for free space */ 346 struct long_ad *la_node_ad_cpy; /* issue buf */ 347 uint64_t *la_lmapping, *la_pmapping; /* issue buf */ 348 349 /* lists */ 350 STAILQ_HEAD(udfmntpts, udf_mount) all_udf_mntpnts; 351 352 /* device strategy */ 353 struct udf_strategy *strategy; 354 void *strategy_private; 355 }; 356 357 358 /* dirent's d_namlen is to avoid useless costly fid->dirent translations */ 359 struct udf_dirhash_entry { 360 uint32_t hashvalue; 361 uint64_t offset; 362 uint32_t d_namlen; 363 uint32_t fid_size; 364 LIST_ENTRY(udf_dirhash_entry) next; 365 }; 366 367 368 struct udf_dirhash { 369 uint32_t flags; 370 uint32_t size; /* in bytes */ 371 uint32_t refcnt; 372 LIST_HEAD(, udf_dirhash_entry) entries[UDF_DIRHASH_HASHSIZE]; 373 LIST_HEAD(, udf_dirhash_entry) free_entries; 374 TAILQ_ENTRY(udf_dirhash) next; 375 }; 376 377 #define UDF_DIRH_PURGED 0x0001 /* dirhash has been purged */ 378 #define UDF_DIRH_COMPLETE 0x0002 /* dirhash is complete */ 379 #define UDF_DIRH_BROKEN 0x0004 /* dirhash is broken on readin */ 380 #define UDF_DIRH_FLAGBITS \ 381 "\10\1DIRH_PURGED\2DIRH_COMPLETE\3DIRH_BROKEN" 382 383 extern kmutex_t udf_dirhashmutex; 384 extern uint32_t udf_maxdirhashsize; 385 extern uint32_t udf_dirhashsize; 386 extern TAILQ_HEAD(_udf_dirhash, udf_dirhash) udf_dirhash_queue; 387 388 389 /* 390 * UDF node describing a file/directory. 391 * 392 * BUGALERT claim node_mutex before reading/writing to prevent inconsistencies ! 393 */ 394 struct udf_node { 395 struct genfs_node i_gnode; /* has to be first */ 396 struct vnode *vnode; /* vnode associated */ 397 struct udf_mount *ump; 398 399 kmutex_t node_mutex; 400 kcondvar_t node_lock; /* sleeping lock */ 401 char const *lock_fname; 402 int lock_lineno; 403 404 /* one of `fe' or `efe' can be set, not both (UDF file entry dscr.) */ 405 struct file_entry *fe; 406 struct extfile_entry *efe; 407 struct alloc_ext_entry *ext[UDF_MAX_ALLOC_EXTENTS]; 408 int num_extensions; 409 410 /* location found, recording location & hints */ 411 struct long_ad loc; /* FID/hash loc. */ 412 struct long_ad write_loc; /* strat 4096 loc */ 413 int needs_indirect; /* has missing indr. */ 414 struct long_ad ext_loc[UDF_MAX_ALLOC_EXTENTS]; 415 416 struct udf_dirhash *dir_hash; 417 418 /* misc */ 419 uint32_t i_flags; /* associated flags */ 420 struct lockf *lockf; /* lock list */ 421 uint32_t outstanding_bufs; /* file data */ 422 uint32_t outstanding_nodedscr; /* node dscr */ 423 424 /* references to associated nodes */ 425 struct udf_node *extattr; 426 struct udf_node *streamdir; 427 struct udf_node *my_parent; /* if extended attr. */ 428 429 LIST_ENTRY(udf_node) hashchain; /* inside hash line */ 430 LIST_ENTRY(udf_node) sortchain; /* sorted udf nodes */ 431 }; 432 433 434 /* misc. flags stored in i_flags (XXX needs cleaning up) */ 435 #define IN_ACCESS 0x0001 /* Inode access time update request */ 436 #define IN_CHANGE 0x0002 /* Inode change time update request */ 437 #define IN_UPDATE 0x0004 /* Inode was written to; update mtime*/ 438 #define IN_MODIFY 0x0008 /* Modification time update request */ 439 #define IN_MODIFIED 0x0010 /* node has been modified */ 440 #define IN_ACCESSED 0x0020 /* node has been accessed */ 441 #define IN_RENAME 0x0040 /* node is being renamed. XXX ?? */ 442 #define IN_DELETED 0x0080 /* node is unlinked, no FID reference*/ 443 #define IN_LOCKED 0x0100 /* node is locked by condvar */ 444 #define IN_SYNCED 0x0200 /* node is being used by sync */ 445 #define IN_CALLBACK_ULK 0x0400 /* node will be unlocked by callback */ 446 #define IN_NODE_REBUILD 0x0800 /* node is rebuild */ 447 448 449 #define IN_FLAGBITS \ 450 "\10\1IN_ACCESS\2IN_CHANGE\3IN_UPDATE\4IN_MODIFY\5IN_MODIFIED" \ 451 "\6IN_ACCESSED\7IN_RENAME\10IN_DELETED\11IN_LOCKED\12IN_SYNCED" \ 452 "\13IN_CALLBACK_ULK\14IN_NODE_REBUILD" 453 454 #endif /* !_FS_UDF_UDF_H_ */ 455
Indexes created Thu Oct 02 10:09:58 GMT 2025