udf.h revision 1.33
1 /* $NetBSD: udf.h,v 1.33 2009/06/23 20:13:37 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 0x0000001 52 #define UDF_DEBUG_LOCKING 0x0000002 53 #define UDF_DEBUG_NODE 0x0000004 54 #define UDF_DEBUG_LOOKUP 0x0000008 55 #define UDF_DEBUG_READDIR 0x0000010 56 #define UDF_DEBUG_FIDS 0x0000020 57 #define UDF_DEBUG_DESCRIPTOR 0x0000040 58 #define UDF_DEBUG_TRANSLATE 0x0000080 59 #define UDF_DEBUG_STRATEGY 0x0000100 60 #define UDF_DEBUG_READ 0x0000200 61 #define UDF_DEBUG_WRITE 0x0000400 62 #define UDF_DEBUG_CALL 0x0000800 63 #define UDF_DEBUG_ATTR 0x0001000 64 #define UDF_DEBUG_EXTATTR 0x0002000 65 #define UDF_DEBUG_ALLOC 0x0004000 66 #define UDF_DEBUG_ADWLK 0x0008000 67 #define UDF_DEBUG_DIRHASH 0x0010000 68 #define UDF_DEBUG_NOTIMPL 0x0020000 69 #define UDF_DEBUG_SHEDULE 0x0040000 70 #define UDF_DEBUG_ECCLINE 0x0080000 71 #define UDF_DEBUG_SYNC 0x0100000 72 #define UDF_DEBUG_PARANOIA 0x0200000 73 #define UDF_DEBUG_PARANOIDADWLK 0x0400000 74 #define UDF_DEBUG_NODEDUMP 0x0800000 75 #define UDF_DEBUG_RESERVE 0x1000000 76 77 /* initial value of udf_verbose */ 78 #define UDF_DEBUGGING 0 79 80 #ifdef DEBUG 81 #define DPRINTF(name, arg) { \ 82 if (udf_verbose & UDF_DEBUG_##name) {\ 83 printf arg;\ 84 };\ 85 } 86 #define DPRINTFIF(name, cond, arg) { \ 87 if (udf_verbose & UDF_DEBUG_##name) { \ 88 if (cond) printf arg;\ 89 };\ 90 } 91 #else 92 #define DPRINTF(name, arg) {} 93 #define DPRINTFIF(name, cond, arg) {} 94 #endif 95 96 97 /* constants to identify what kind of identifier we are dealing with */ 98 #define UDF_REGID_DOMAIN 1 99 #define UDF_REGID_UDF 2 100 #define UDF_REGID_IMPLEMENTATION 3 101 #define UDF_REGID_APPLICATION 4 102 #define UDF_REGID_NAME 99 103 104 105 /* DON'T change these: they identify 13thmonkey's UDF implementation */ 106 #define APP_NAME "*NetBSD UDF" 107 #define APP_VERSION_MAIN 0 108 #define APP_VERSION_SUB 5 109 #define IMPL_NAME "*NetBSD kernel UDF" 110 111 112 /* Configuration values */ 113 #define UDF_INODE_HASHBITS 10 114 #define UDF_INODE_HASHSIZE (1<<UDF_INODE_HASHBITS) 115 #define UDF_INODE_HASHMASK (UDF_INODE_HASHSIZE - 1) 116 #define UDF_ECCBUF_HASHBITS 10 117 #define UDF_ECCBUF_HASHSIZE (1<<UDF_ECCBUF_HASHBITS) 118 #define UDF_ECCBUF_HASHMASK (UDF_ECCBUF_HASHSIZE -1) 119 120 #define UDF_ECCLINE_MAXFREE 5 /* picked, needs calculation */ 121 #define UDF_ECCLINE_MAXBUSY 300 /* picked, needs calculation */ 122 123 #define UDF_MAX_MAPPINGS (MAXPHYS/DEV_BSIZE) /* 128 */ 124 #define UDF_VAT_CHUNKSIZE (64*1024) /* picked */ 125 #define UDF_SYMLINKBUFLEN (64*1024) /* picked */ 126 127 #define UDF_ISO_VRS_SIZE (32*2048) /* 32 ISO `sectors' */ 128 129 130 /* structure space */ 131 #define UDF_ANCHORS 4 /* 256, 512, N-256, N */ 132 #define UDF_PARTITIONS 4 /* overkill */ 133 #define UDF_PMAPS 5 /* overkill */ 134 #define UDF_LVDINT_SEGMENTS 100 /* big overkill */ 135 #define UDF_LVINT_LOSSAGE 4 /* lose 2 openings */ 136 #define UDF_MAX_ALLOC_EXTENTS 50 /* overkill */ 137 138 139 /* constants */ 140 #define UDF_MAX_NAMELEN 255 /* as per SPEC */ 141 #define UDF_TRANS_ZERO ((uint64_t) -1) 142 #define UDF_TRANS_UNMAPPED ((uint64_t) -2) 143 #define UDF_TRANS_INTERN ((uint64_t) -3) 144 #define UDF_MAX_SECTOR ((uint64_t) -10) /* high water mark */ 145 146 147 /* RW content hint for allocation and other purposes */ 148 #define UDF_C_ABSOLUTE 0 /* blob to write at absolute */ 149 #define UDF_C_PROCESSED 0 /* not relevant */ 150 #define UDF_C_USERDATA 1 /* all but userdata is metadata */ 151 #define UDF_C_DSCR 2 /* update sectornr and CRC */ 152 #define UDF_C_FLOAT_DSCR 3 /* update sectornr and CRC; sequential */ 153 #define UDF_C_NODE 4 /* file/dir node, update sectornr and CRC */ 154 #define UDF_C_FIDS 5 /* update all contained fids */ 155 #define UDF_C_METADATA_SBM 6 /* space bitmap, update sectornr and CRC */ 156 #define UDF_C_EXTATTRS 7 /* dunno what to do yet */ 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_INVALID 0 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_FINALISE_DISC 0x04 /* close session after writing VAT */ 187 #define UDF_WRITE_VAT 0x08 /* sequential VAT filesystem */ 188 #define UDF_WRITE_LVINT 0x10 /* write out open lvint */ 189 #define UDF_WRITE_PART_BITMAPS 0x20 /* write out partition space bitmaps */ 190 #define UDF_APPENDONLY_LVINT 0x40 /* no shifting, only appending */ 191 #define UDFLOGVOL_BITS "\20\1OPEN_SESSION\2CLOSE_SESSION\3FINALISE_DISC" \ 192 "\4WRITE_VAT\5WRITE_LVINT\6WRITE_PART_BITMAPS" \ 193 "\7APPENDONLY_LVINT" 194 195 /* logical volume error handling actions */ 196 #define UDF_UPDATE_TRACKINFO 0x01 /* update trackinfo and re-shedule */ 197 #define UDF_REMAP_BLOCK 0x02 /* remap the failing block length */ 198 #define UDFONERROR_BITS "\20\1UPDATE_TRACKINFO\2REMAP_BLOCK" 199 200 201 /* readdir cookies */ 202 #define UDF_DIRCOOKIE_DOT 1 203 204 205 /* malloc pools */ 206 MALLOC_DECLARE(M_UDFMNT); 207 MALLOC_DECLARE(M_UDFVOLD); 208 MALLOC_DECLARE(M_UDFTEMP); 209 210 struct pool udf_node_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 /* logical to physical translations */ 287 int vtop[UDF_PMAPS+1]; /* vpartnr trans */ 288 int vtop_tp[UDF_PMAPS+1]; /* type of trans */ 289 290 /* disc allocation / writing method */ 291 kmutex_t allocate_mutex; 292 int lvreadwrite; /* error handling */ 293 int vtop_alloc[UDF_PMAPS+1]; /* alloc scheme */ 294 int data_part; 295 int node_part; 296 int fids_part; 297 298 /* sequential track info */ 299 struct mmc_trackinfo data_track; 300 struct mmc_trackinfo metadata_track; 301 302 /* VAT */ 303 uint32_t first_possible_vat_location; 304 uint32_t last_possible_vat_location; 305 uint32_t vat_entries; 306 uint32_t vat_offset; /* offset in table */ 307 uint32_t vat_last_free_lb; /* last free lb_num */ 308 uint32_t vat_table_len; 309 uint32_t vat_table_alloc_len; 310 uint8_t *vat_table; 311 uint8_t *vat_pages; /* TODO */ 312 struct udf_node *vat_node; /* system node */ 313 314 /* space bitmaps for physical partitions */ 315 struct space_bitmap_desc*part_unalloc_dscr[UDF_PARTITIONS]; 316 struct space_bitmap_desc*part_freed_dscr [UDF_PARTITIONS]; 317 struct udf_bitmap part_unalloc_bits[UDF_PARTITIONS]; 318 struct udf_bitmap part_freed_bits [UDF_PARTITIONS]; 319 320 /* sparable */ 321 uint32_t sparable_packet_size; 322 uint32_t packet_size; 323 struct udf_sparing_table*sparing_table; 324 325 /* meta */ 326 struct udf_node *metadata_node; /* system node */ 327 struct udf_node *metadatamirror_node; /* system node */ 328 struct udf_node *metadatabitmap_node; /* system node */ 329 struct space_bitmap_desc*metadata_unalloc_dscr; 330 struct udf_bitmap metadata_unalloc_bits; 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 /* 357 * UDF node describing a file/directory. 358 * 359 * BUGALERT claim node_mutex before reading/writing to prevent inconsistencies ! 360 */ 361 struct udf_node { 362 struct genfs_node i_gnode; /* has to be first */ 363 struct vnode *vnode; /* vnode associated */ 364 struct udf_mount *ump; 365 366 kmutex_t node_mutex; 367 kcondvar_t node_lock; /* sleeping lock */ 368 char const *lock_fname; 369 int lock_lineno; 370 371 /* one of `fe' or `efe' can be set, not both (UDF file entry dscr.) */ 372 struct file_entry *fe; 373 struct extfile_entry *efe; 374 struct alloc_ext_entry *ext[UDF_MAX_ALLOC_EXTENTS]; 375 int num_extensions; 376 377 /* location found, recording location & hints */ 378 struct long_ad loc; /* FID/hash loc. */ 379 struct long_ad write_loc; /* strat 4096 loc */ 380 int needs_indirect; /* has missing indr. */ 381 struct long_ad ext_loc[UDF_MAX_ALLOC_EXTENTS]; 382 383 struct dirhash *dir_hash; 384 385 /* misc */ 386 uint32_t i_flags; /* associated flags */ 387 struct lockf *lockf; /* lock list */ 388 uint32_t outstanding_bufs; /* file data */ 389 uint32_t outstanding_nodedscr; /* node dscr */ 390 391 /* references to associated nodes */ 392 struct udf_node *extattr; 393 struct udf_node *streamdir; 394 struct udf_node *my_parent; /* if extended attr. */ 395 396 LIST_ENTRY(udf_node) hashchain; /* inside hash line */ 397 LIST_ENTRY(udf_node) sortchain; /* sorted udf nodes */ 398 }; 399 400 401 /* misc. flags stored in i_flags (XXX needs cleaning up) */ 402 #define IN_ACCESS 0x0001 /* Inode access time update request */ 403 #define IN_CHANGE 0x0002 /* Inode change time update request */ 404 #define IN_UPDATE 0x0004 /* Inode was written to; update mtime*/ 405 #define IN_MODIFY 0x0008 /* Modification time update request */ 406 #define IN_MODIFIED 0x0010 /* node has been modified */ 407 #define IN_ACCESSED 0x0020 /* node has been accessed */ 408 #define IN_RENAME 0x0040 /* node is being renamed. XXX ?? */ 409 #define IN_DELETED 0x0080 /* node is unlinked, no FID reference*/ 410 #define IN_LOCKED 0x0100 /* node is locked by condvar */ 411 #define IN_SYNCED 0x0200 /* node is being used by sync */ 412 #define IN_CALLBACK_ULK 0x0400 /* node will be unlocked by callback */ 413 #define IN_NODE_REBUILD 0x0800 /* node is rebuild */ 414 415 416 #define IN_FLAGBITS \ 417 "\10\1IN_ACCESS\2IN_CHANGE\3IN_UPDATE\4IN_MODIFY\5IN_MODIFIED" \ 418 "\6IN_ACCESSED\7IN_RENAME\10IN_DELETED\11IN_LOCKED\12IN_SYNCED" \ 419 "\13IN_CALLBACK_ULK\14IN_NODE_REBUILD" 420 421 #endif /* !_FS_UDF_UDF_H_ */ 422
Indexes created Tue Sep 23 07:09:52 GMT 2025