udf.h revision 1.19
1 /* $NetBSD: udf.h,v 1.19 2008/07/19 16:00:35 reinoud 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 /* allocation descriptor styles */ 183 #define UDF_ALLOCDSCR_SHORT 1 /* use short_ad allocation dscr. */ 184 #define UDF_ALLOCDSCR_LONG 2 /* use long_ad allocation dscr. */ 185 186 187 /* logical volume open/close actions */ 188 #define UDF_OPEN_SESSION 0x01 /* if needed writeout VRS + VDS */ 189 #define UDF_CLOSE_SESSION 0x02 /* close session after writing VAT */ 190 #define UDF_WRITE_VAT 0x04 /* sequential VAT filesystem */ 191 #define UDF_WRITE_LVINT 0x08 /* write out open lvint */ 192 #define UDF_WRITE_PART_BITMAPS 0x10 /* write out partition space bitmaps */ 193 #define UDF_APPENDONLY_LVINT 0x20 /* no shifting, only appending */ 194 #define UDFLOGVOL_BITS "\20\1OPENSESSION\2CLOSESESSION\3WRITEVAT\4WRITELVINT"\ 195 "\5APPENDONLY" 196 197 /* logical volume error handling actions */ 198 #define UDF_UPDATE_TRACKINFO 0x01 /* update trackinfo and re-shedule */ 199 #define UDF_REMAP_BLOCK 0x02 /* remap the failing block length */ 200 #define UDFONERROR_BITS "\20\1UPDATE_TRACKINFO\2REMAP_BLOCK" 201 202 203 /* readdir cookies */ 204 #define UDF_DIRCOOKIE_DOT 1 205 206 207 /* malloc pools */ 208 MALLOC_DECLARE(M_UDFMNT); 209 MALLOC_DECLARE(M_UDFVOLD); 210 MALLOC_DECLARE(M_UDFTEMP); 211 212 struct pool udf_node_pool; 213 struct pool udf_dirhash_pool; 214 struct pool udf_dirhash_entry_pool; 215 struct udf_node; 216 struct udf_strategy; 217 218 219 struct udf_lvintq { 220 uint32_t start; 221 uint32_t end; 222 uint32_t pos; 223 uint32_t wpos; 224 }; 225 226 227 struct udf_bitmap { 228 uint8_t *blob; /* allocated */ 229 uint8_t *bits; /* bits themselves */ 230 uint8_t *pages; /* dirty pages */ 231 uint32_t max_offset; /* in bits */ 232 uint32_t data_pos; /* position in data */ 233 uint32_t metadata_pos; /* .. in metadata */ 234 }; 235 236 237 struct udf_strat_args { 238 struct udf_mount *ump; 239 struct udf_node *udf_node; 240 struct long_ad *icb; 241 union dscrptr *dscr; 242 struct buf *nestbuf; 243 kauth_cred_t cred; 244 int waitfor; 245 }; 246 247 struct udf_strategy { 248 int (*create_logvol_dscr) (struct udf_strat_args *args); 249 void (*free_logvol_dscr) (struct udf_strat_args *args); 250 int (*read_logvol_dscr) (struct udf_strat_args *args); 251 int (*write_logvol_dscr) (struct udf_strat_args *args); 252 void (*queuebuf) (struct udf_strat_args *args); 253 void (*discstrat_init) (struct udf_strat_args *args); 254 void (*discstrat_finish) (struct udf_strat_args *args); 255 }; 256 257 extern struct udf_strategy udf_strat_bootstrap; 258 extern struct udf_strategy udf_strat_sequential; 259 extern struct udf_strategy udf_strat_direct; 260 extern struct udf_strategy udf_strat_rmw; 261 262 263 /* pre cleanup */ 264 struct udf_mount { 265 struct mount *vfs_mountp; 266 struct vnode *devvp; 267 struct mmc_discinfo discinfo; 268 struct udf_args mount_args; 269 270 /* format descriptors */ 271 kmutex_t logvol_mutex; 272 struct anchor_vdp *anchors[UDF_ANCHORS]; /* anchors to VDS */ 273 struct pri_vol_desc *primary_vol; /* identification */ 274 struct logvol_desc *logical_vol; /* main mapping v->p */ 275 struct unalloc_sp_desc *unallocated; /* free UDF space */ 276 struct impvol_desc *implementation; /* likely reduntant */ 277 struct logvol_int_desc *logvol_integrity; /* current integrity */ 278 struct part_desc *partitions[UDF_PARTITIONS]; /* partitions */ 279 /* logvol_info is derived; points *into* other structures */ 280 struct udf_logvol_info *logvol_info; /* integrity descr. */ 281 282 /* fileset and root directories */ 283 struct fileset_desc *fileset_desc; /* normally one */ 284 285 /* tracing logvol integrity history */ 286 struct udf_lvintq lvint_trace[UDF_LVDINT_SEGMENTS]; 287 int lvopen; /* logvol actions */ 288 int lvclose; /* logvol actions */ 289 290 /* disc allocation / writing method */ 291 int lvreadwrite; /* error handling */ 292 int data_alloc; /* all userdata */ 293 int data_allocdscr; 294 int meta_alloc; /* all metadata */ 295 int meta_allocdscr; 296 int data_part; 297 int metadata_part; 298 kmutex_t allocate_mutex; 299 300 /* logical to physical translations */ 301 int vtop[UDF_PMAPS+1]; /* vpartnr trans */ 302 int vtop_tp[UDF_PMAPS+1]; /* type of trans */ 303 304 /* sequential track info */ 305 struct mmc_trackinfo data_track; 306 struct mmc_trackinfo metadata_track; 307 308 /* VAT */ 309 uint32_t first_possible_vat_location; 310 uint32_t last_possible_vat_location; 311 uint32_t vat_entries; 312 uint32_t vat_offset; /* offset in table */ 313 uint32_t vat_last_free_lb; /* last free lb_num */ 314 uint32_t vat_table_len; 315 uint32_t vat_table_alloc_len; 316 uint8_t *vat_table; 317 uint8_t *vat_pages; /* TODO */ 318 struct udf_node *vat_node; /* system node */ 319 320 /* space bitmaps */ 321 struct space_bitmap_desc*part_unalloc_dscr[UDF_PARTITIONS]; 322 struct space_bitmap_desc*part_freed_dscr [UDF_PARTITIONS]; 323 struct udf_bitmap part_unalloc_bits[UDF_PARTITIONS]; 324 struct udf_bitmap part_freed_bits [UDF_PARTITIONS]; 325 326 /* sparable */ 327 uint32_t sparable_packet_size; 328 uint32_t packet_size; 329 struct udf_sparing_table*sparing_table; 330 331 /* meta */ 332 struct udf_node *metadata_node; /* system node */ 333 struct udf_node *metadatamirror_node; /* system node */ 334 struct udf_node *metadatabitmap_node; /* system node */ 335 struct udf_bitmap metadata_bitmap; /* TODO : readin */ 336 337 /* hash table to lookup icb -> udf_node and sorted list for sync */ 338 kmutex_t ihash_lock; 339 kmutex_t get_node_lock; 340 LIST_HEAD(, udf_node) udf_nodes[UDF_INODE_HASHSIZE]; 341 LIST_HEAD(, udf_node) sorted_udf_nodes; /* sorted sync list */ 342 343 /* syncing */ 344 int syncing; /* are we syncing? */ 345 kcondvar_t dirtynodes_cv; /* sleeping on sync */ 346 347 /* late allocation */ 348 uint32_t uncomitted_lb; /* for free space */ 349 struct long_ad *la_node_ad_cpy; /* issue buf */ 350 uint64_t *la_lmapping, *la_pmapping; /* issue buf */ 351 352 /* lists */ 353 STAILQ_HEAD(udfmntpts, udf_mount) all_udf_mntpnts; 354 355 /* device strategy */ 356 struct udf_strategy *strategy; 357 void *strategy_private; 358 }; 359 360 361 /* dirent's d_namlen is to avoid useless costly fid->dirent translations */ 362 struct udf_dirhash_entry { 363 uint32_t hashvalue; 364 uint64_t offset; 365 uint32_t d_namlen; 366 uint32_t fid_size; 367 LIST_ENTRY(udf_dirhash_entry) next; 368 }; 369 370 371 struct udf_dirhash { 372 LIST_HEAD(, udf_dirhash_entry) entries[UDF_DIRHASH_HASHSIZE]; 373 LIST_HEAD(, udf_dirhash_entry) free_entries; 374 }; 375 376 377 /* 378 * UDF node describing a file/directory. 379 * 380 * BUGALERT claim node_mutex before reading/writing to prevent inconsistencies ! 381 */ 382 struct udf_node { 383 struct genfs_node i_gnode; /* has to be first */ 384 struct vnode *vnode; /* vnode associated */ 385 struct udf_mount *ump; 386 387 kmutex_t node_mutex; 388 kcondvar_t node_lock; /* sleeping lock */ 389 char const *lock_fname; 390 int lock_lineno; 391 392 /* one of `fe' or `efe' can be set, not both (UDF file entry dscr.) */ 393 struct file_entry *fe; 394 struct extfile_entry *efe; 395 struct alloc_ext_entry *ext[UDF_MAX_ALLOC_EXTENTS]; 396 int num_extensions; 397 398 /* location found, recording location & hints */ 399 struct long_ad loc; /* FID/hash loc. */ 400 struct long_ad write_loc; /* strat 4096 loc */ 401 int needs_indirect; /* has missing indr. */ 402 struct long_ad ext_loc[UDF_MAX_ALLOC_EXTENTS]; 403 404 struct udf_dirhash *dir_hash; 405 406 /* misc */ 407 uint32_t i_flags; /* associated flags */ 408 struct lockf *lockf; /* lock list */ 409 uint32_t outstanding_bufs; /* file data */ 410 uint32_t outstanding_nodedscr; /* node dscr */ 411 412 /* references to associated nodes */ 413 struct udf_node *extattr; 414 struct udf_node *streamdir; 415 struct udf_node *my_parent; /* if extended attr. */ 416 417 LIST_ENTRY(udf_node) hashchain; /* inside hash line */ 418 LIST_ENTRY(udf_node) sortchain; /* sorted udf nodes */ 419 }; 420 421 422 /* misc. flags stored in i_flags (XXX needs cleaning up) */ 423 #define IN_ACCESS 0x0001 /* Inode access time update request */ 424 #define IN_CHANGE 0x0002 /* Inode change time update request */ 425 #define IN_UPDATE 0x0004 /* Inode was written to; update mtime*/ 426 #define IN_MODIFY 0x0008 /* Modification time update request */ 427 #define IN_MODIFIED 0x0010 /* node has been modified */ 428 #define IN_ACCESSED 0x0020 /* node has been accessed */ 429 #define IN_RENAME 0x0040 /* node is being renamed. XXX ?? */ 430 #define IN_DELETED 0x0080 /* node is unlinked, no FID reference*/ 431 #define IN_LOCKED 0x0100 /* node is locked by condvar */ 432 #define IN_SYNCED 0x0200 /* node is being used by sync */ 433 #define IN_CALLBACK_ULK 0x0400 /* node will be unlocked by callback */ 434 #define IN_NODE_REBUILD 0x0800 /* node is rebuild */ 435 #define IN_DIRHASH_COMPLETE 0x1000 /* dirhash is complete */ 436 #define IN_DIRHASH_BROKEN 0x2000 /* dirhash is broken on readin */ 437 438 439 #define IN_FLAGBITS \ 440 "\10\1IN_ACCESS\2IN_CHANGE\3IN_UPDATE\4IN_MODIFY\5IN_MODIFIED" \ 441 "\6IN_ACCESSED\7IN_RENAME\10IN_DELETED\11IN_LOCKED\12IN_SYNCED" \ 442 "\13IN_CALLBACK_ULK\14IN_NODE_REBUILD\15IN_DIRHASH_COMPLETE" \ 443 "\16IN_DIRHASH_BROKEN" 444 445 #endif /* !_FS_UDF_UDF_H_ */ 446
Indexes created Wed Sep 24 05:09:52 GMT 2025