udf.h revision 1.14
1 /* $NetBSD: udf.h,v 1.14 2008/06/28 01:34:05 rumble 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_NOTIMPL 0x010000 68 #define UDF_DEBUG_SHEDULE 0x020000 69 #define UDF_DEBUG_ECCLINE 0x040000 70 #define UDF_DEBUG_SYNC 0x080000 71 #define UDF_DEBUG_PARANOIA 0x100000 72 73 /* initial value of udf_verbose */ 74 #define UDF_DEBUGGING 0 75 76 #ifdef DEBUG 77 #define DPRINTF(name, arg) { \ 78 if (udf_verbose & UDF_DEBUG_##name) {\ 79 printf arg;\ 80 };\ 81 } 82 #define DPRINTFIF(name, cond, arg) { \ 83 if (udf_verbose & UDF_DEBUG_##name) { \ 84 if (cond) printf arg;\ 85 };\ 86 } 87 #else 88 #define DPRINTF(name, arg) {} 89 #define DPRINTFIF(name, cond, arg) {} 90 #endif 91 92 93 /* constants to identify what kind of identifier we are dealing with */ 94 #define UDF_REGID_DOMAIN 1 95 #define UDF_REGID_UDF 2 96 #define UDF_REGID_IMPLEMENTATION 3 97 #define UDF_REGID_APPLICATION 4 98 #define UDF_REGID_NAME 99 99 100 101 /* DON'T change these: they identify 13thmonkey's UDF implementation */ 102 #define APP_NAME "*NetBSD UDF" 103 #define APP_VERSION_MAIN 0 104 #define APP_VERSION_SUB 4 105 #define IMPL_NAME "*NetBSD kernel UDF" 106 107 108 /* Configuration values */ 109 #define UDF_INODE_HASHBITS 10 110 #define UDF_INODE_HASHSIZE (1<<UDF_INODE_HASHBITS) 111 #define UDF_INODE_HASHMASK (UDF_INODE_HASHSIZE - 1) 112 #define UDF_ECCBUF_HASHBITS 10 113 #define UDF_ECCBUF_HASHSIZE (1<<UDF_ECCBUF_HASHBITS) 114 #define UDF_ECCBUF_HASHMASK (UDF_ECCBUF_HASHSIZE -1) 115 116 #define UDF_ECCLINE_MAXFREE 10 /* picked */ 117 #define UDF_ECCLINE_MAXBUSY 100 /* picked */ 118 119 #define UDF_MAX_MAPPINGS (MAXPHYS/DEV_BSIZE) /* 128 */ 120 #define UDF_VAT_CHUNKSIZE (64*1024) /* picked */ 121 #define UDF_SYMLINKBUFLEN (64*1024) /* picked */ 122 123 124 /* structure space */ 125 #define UDF_ANCHORS 4 /* 256, 512, N-256, N */ 126 #define UDF_PARTITIONS 4 /* overkill */ 127 #define UDF_PMAPS 5 /* overkill */ 128 #define UDF_LVDINT_SEGMENTS 100 /* big overkill */ 129 #define UDF_LVINT_LOSSAGE 4 /* lose 2 openings */ 130 #define UDF_MAX_ALLOC_EXTENTS 50 /* overkill */ 131 132 133 /* constants */ 134 #define UDF_MAX_NAMELEN 255 /* as per SPEC */ 135 #define UDF_TRANS_ZERO ((uint64_t) -1) 136 #define UDF_TRANS_UNMAPPED ((uint64_t) -2) 137 #define UDF_TRANS_INTERN ((uint64_t) -3) 138 #define UDF_MAX_SECTOR ((uint64_t) -10) /* high water mark */ 139 140 141 /* RW content hint for allocation and other purposes */ 142 #define UDF_C_PROCESSED 0 /* not relevant */ 143 #define UDF_C_USERDATA 1 /* all but userdata is metadata */ 144 //#define UDF_C_METADATA 2 /* unspecified metadata */ 145 #define UDF_C_DSCR 3 /* update sectornr and CRC */ 146 #define UDF_C_NODE 4 /* file/dir node, update sectornr and CRC */ 147 #define UDF_C_EXTATTRS 5 /* dunno what to do yet */ 148 #define UDF_C_FIDS 6 /* update all contained fids */ 149 150 151 /* use unused b_freelistindex for our UDF_C_TYPE */ 152 #define b_udf_c_type b_freelistindex 153 154 155 /* virtual to physical mapping types */ 156 #define UDF_VTOP_RAWPART UDF_PMAPS /* [0..UDF_PMAPS> are normal */ 157 158 #define UDF_VTOP_TYPE_RAW 0 159 #define UDF_VTOP_TYPE_UNKNOWN 0 160 #define UDF_VTOP_TYPE_PHYS 1 161 #define UDF_VTOP_TYPE_VIRT 2 162 #define UDF_VTOP_TYPE_SPARABLE 3 163 #define UDF_VTOP_TYPE_META 4 164 165 166 /* allocation strategies */ 167 #define UDF_ALLOC_SEQUENTIAL 1 /* linear on NWA */ 168 #define UDF_ALLOC_VAT 2 /* VAT handling */ 169 #define UDF_ALLOC_SPACEMAP 3 /* spacemaps */ 170 #define UDF_ALLOC_METABITMAP 4 /* metadata bitmap */ 171 #define UDF_ALLOC_METASEQUENTIAL 5 /* in chunks seq., nodes not seq */ 172 #define UDF_ALLOC_RELAXEDSEQUENTIAL 6 /* only nodes not seq. */ 173 174 175 /* logical volume open/close actions */ 176 #define UDF_OPEN_SESSION 0x01 /* if needed writeout VRS + VDS */ 177 #define UDF_CLOSE_SESSION 0x02 /* close session after writing VAT */ 178 #define UDF_WRITE_VAT 0x04 /* sequential VAT filesystem */ 179 #define UDF_WRITE_LVINT 0x08 /* write out open lvint */ 180 #define UDF_WRITE_PART_BITMAPS 0x10 /* write out partition space bitmaps */ 181 #define UDF_APPENDONLY_LVINT 0x20 /* no shifting, only appending */ 182 #define UDFLOGVOL_BITS "\20\1OPENSESSION\2CLOSESESSION\3WRITEVAT\4WRITELVINT"\ 183 "\5APPENDONLY" 184 185 /* logical volume error handling actions */ 186 #define UDF_UPDATE_TRACKINFO 0x01 /* update trackinfo and re-shedule */ 187 #define UDF_REMAP_BLOCK 0x02 /* remap the failing block length */ 188 #define UDFONERROR_BITS "\20\1UPDATE_TRACKINFO\2REMAP_BLOCK" 189 190 191 /* readdir cookies */ 192 #define UDF_DIRCOOKIE_DOT 1 193 194 195 /* malloc pools */ 196 MALLOC_DECLARE(M_UDFMNT); 197 MALLOC_DECLARE(M_UDFVOLD); 198 MALLOC_DECLARE(M_UDFTEMP); 199 200 struct pool udf_node_pool; 201 struct udf_node; 202 struct udf_strategy; 203 204 205 struct udf_lvintq { 206 uint32_t start; 207 uint32_t end; 208 uint32_t pos; 209 uint32_t wpos; 210 }; 211 212 213 struct udf_bitmap { 214 uint8_t *blob; /* allocated */ 215 uint8_t *bits; /* bits themselves */ 216 uint8_t *pages; /* dirty pages */ 217 uint32_t max_offset; /* in bits */ 218 uint32_t data_pos; /* position in data */ 219 uint32_t metadata_pos; /* .. in metadata */ 220 }; 221 222 223 struct udf_strat_args { 224 struct udf_mount *ump; 225 struct udf_node *udf_node; 226 struct long_ad *icb; 227 union dscrptr *dscr; 228 struct buf *nestbuf; 229 kauth_cred_t cred; 230 int waitfor; 231 }; 232 233 struct udf_strategy { 234 int (*create_logvol_dscr) (struct udf_strat_args *args); 235 void (*free_logvol_dscr) (struct udf_strat_args *args); 236 int (*read_logvol_dscr) (struct udf_strat_args *args); 237 int (*write_logvol_dscr) (struct udf_strat_args *args); 238 void (*queuebuf) (struct udf_strat_args *args); 239 void (*discstrat_init) (struct udf_strat_args *args); 240 void (*discstrat_finish) (struct udf_strat_args *args); 241 }; 242 243 extern struct udf_strategy udf_strat_bootstrap; 244 extern struct udf_strategy udf_strat_sequential; 245 extern struct udf_strategy udf_strat_direct; 246 extern struct udf_strategy udf_strat_rmw; 247 248 249 /* pre cleanup */ 250 struct udf_mount { 251 struct mount *vfs_mountp; 252 struct vnode *devvp; 253 struct mmc_discinfo discinfo; 254 struct udf_args mount_args; 255 256 /* format descriptors */ 257 kmutex_t logvol_mutex; 258 struct anchor_vdp *anchors[UDF_ANCHORS]; /* anchors to VDS */ 259 struct pri_vol_desc *primary_vol; /* identification */ 260 struct logvol_desc *logical_vol; /* main mapping v->p */ 261 struct unalloc_sp_desc *unallocated; /* free UDF space */ 262 struct impvol_desc *implementation; /* likely reduntant */ 263 struct logvol_int_desc *logvol_integrity; /* current integrity */ 264 struct part_desc *partitions[UDF_PARTITIONS]; /* partitions */ 265 /* logvol_info is derived; points *into* other structures */ 266 struct udf_logvol_info *logvol_info; /* integrity descr. */ 267 268 /* fileset and root directories */ 269 struct fileset_desc *fileset_desc; /* normally one */ 270 271 /* tracing logvol integrity history */ 272 struct udf_lvintq lvint_trace[UDF_LVDINT_SEGMENTS]; 273 int lvopen; /* logvol actions */ 274 int lvclose; /* logvol actions */ 275 276 /* disc allocation / writing method */ 277 int lvreadwrite; /* bits */ 278 int data_alloc; /* all userdata */ 279 int meta_alloc; /* all metadata */ 280 int data_part; 281 int metadata_part; 282 kmutex_t allocate_mutex; 283 284 /* logical to physical translations */ 285 int vtop[UDF_PMAPS+1]; /* vpartnr trans */ 286 int vtop_tp[UDF_PMAPS+1]; /* type of trans */ 287 288 /* sequential track info */ 289 struct mmc_trackinfo data_track; 290 struct mmc_trackinfo metadata_track; 291 292 /* VAT */ 293 uint32_t first_possible_vat_location; 294 uint32_t last_possible_vat_location; 295 uint32_t vat_entries; 296 uint32_t vat_offset; /* offset in table */ 297 uint32_t vat_last_free_lb; /* last free lb_num */ 298 uint32_t vat_table_len; 299 uint32_t vat_table_alloc_len; 300 uint8_t *vat_table; 301 uint8_t *vat_pages; /* TODO */ 302 struct udf_node *vat_node; /* system node */ 303 304 /* space bitmaps */ 305 struct space_bitmap_desc*part_unalloc_dscr[UDF_PARTITIONS]; 306 struct space_bitmap_desc*part_freed_dscr [UDF_PARTITIONS]; 307 struct udf_bitmap part_unalloc_bits[UDF_PARTITIONS]; 308 struct udf_bitmap part_freed_bits [UDF_PARTITIONS]; 309 310 /* sparable */ 311 uint32_t sparable_packet_size; 312 uint32_t packet_size; 313 struct udf_sparing_table*sparing_table; 314 315 /* meta */ 316 struct udf_node *metadata_node; /* system node */ 317 struct udf_node *metadatamirror_node; /* system node */ 318 struct udf_node *metadatabitmap_node; /* system node */ 319 struct udf_bitmap metadata_bitmap; /* TODO : readin */ 320 321 /* hash table to lookup icb -> udf_node and sorted list for sync */ 322 kmutex_t ihash_lock; 323 kmutex_t get_node_lock; 324 LIST_HEAD(, udf_node) udf_nodes[UDF_INODE_HASHSIZE]; 325 LIST_HEAD(, udf_node) sorted_udf_nodes; /* sorted sync list */ 326 327 /* syncing */ 328 int syncing; /* are we syncing? */ 329 kcondvar_t dirtynodes_cv; /* sleeping on sync */ 330 331 /* late allocation */ 332 uint32_t uncomitted_lb; /* for free space */ 333 struct long_ad *la_node_ad_cpy; /* issue buf */ 334 uint64_t *la_lmapping, *la_pmapping; /* issue buf */ 335 336 /* lists */ 337 STAILQ_HEAD(udfmntpts, udf_mount) all_udf_mntpnts; 338 339 /* device strategy */ 340 struct udf_strategy *strategy; 341 void *strategy_private; 342 }; 343 344 /* 345 * UDF node describing a file/directory. 346 * 347 * BUGALERT claim node_mutex before reading/writing to prevent inconsistencies ! 348 */ 349 struct udf_node { 350 struct genfs_node i_gnode; /* has to be first */ 351 struct vnode *vnode; /* vnode associated */ 352 struct udf_mount *ump; 353 354 kmutex_t node_mutex; 355 kcondvar_t node_lock; /* sleeping lock */ 356 char const *lock_fname; 357 int lock_lineno; 358 359 /* one of `fe' or `efe' can be set, not both (UDF file entry dscr.) */ 360 struct file_entry *fe; 361 struct extfile_entry *efe; 362 struct alloc_ext_entry *ext[UDF_MAX_ALLOC_EXTENTS]; 363 int num_extensions; 364 365 /* location found, recording location & hints */ 366 struct long_ad loc; /* FID/hash loc. */ 367 struct long_ad write_loc; /* strat 4096 loc */ 368 int needs_indirect; /* has missing indr. */ 369 struct long_ad ext_loc[UDF_MAX_ALLOC_EXTENTS]; 370 371 uint64_t last_diroffset; /* speeding up lookup*/ 372 373 /* misc */ 374 uint32_t i_flags; /* associated flags */ 375 struct lockf *lockf; /* lock list */ 376 uint32_t outstanding_bufs; /* file data */ 377 uint32_t outstanding_nodedscr; /* node dscr */ 378 379 /* references to associated nodes */ 380 struct udf_node *extattr; 381 struct udf_node *streamdir; 382 struct udf_node *my_parent; /* if extended attr. */ 383 384 LIST_ENTRY(udf_node) hashchain; /* inside hash line */ 385 LIST_ENTRY(udf_node) sortchain; /* sorted udf nodes */ 386 }; 387 388 389 /* misc. flags stored in i_flags (XXX needs cleaning up) */ 390 #define IN_ACCESS 0x0001 /* Inode access time update request. */ 391 #define IN_CHANGE 0x0002 /* Inode change time update request. */ 392 #define IN_UPDATE 0x0004 /* Inode was written to; update mtime*/ 393 #define IN_MODIFY 0x0008 /* Modification time update request. */ 394 #define IN_MODIFIED 0x0010 /* node has been modified. */ 395 #define IN_ACCESSED 0x0020 /* node has been accessed. */ 396 #define IN_RENAME 0x0040 /* node is being renamed. XXX ?? */ 397 #define IN_DELETED 0x0080 /* node is unlinked, no FID reference */ 398 #define IN_LOCKED 0x0100 /* node is locked by condvar */ 399 #define IN_SYNCED 0x0200 /* node is being used by sync */ 400 #define IN_CALLBACK_ULK 0x0400 /* node will be unlocked by callback */ 401 402 403 #define IN_FLAGBITS \ 404 "\10\1IN_ACCESS\2IN_CHANGE\3IN_UPDATE\4IN_MODIFY\5IN_MODIFIED" \ 405 "\6IN_ACCESSED\7IN_RENAME\10IN_DELETED\11IN_LOCKED\12IN_SYNCED" \ 406 "\13IN_CALLBACK_ULK" 407 408 #endif /* !_FS_UDF_UDF_H_ */ 409
Indexes created Thu Oct 02 10:09:58 GMT 2025