udf.h revision 1.13
1 /* $NetBSD: udf.h,v 1.13 2008/06/25 15:27:14 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_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 77 #ifdef DEBUG 78 #ifdef SYSCTL_SETUP_PROTO 79 SYSCTL_SETUP_PROTO(sysctl_vfs_udf_setup); 80 #endif /* SYSCTL_SETUP_PROTO */ 81 #endif 82 83 84 #ifdef DEBUG 85 #define DPRINTF(name, arg) { \ 86 if (udf_verbose & UDF_DEBUG_##name) {\ 87 printf arg;\ 88 };\ 89 } 90 #define DPRINTFIF(name, cond, arg) { \ 91 if (udf_verbose & UDF_DEBUG_##name) { \ 92 if (cond) printf arg;\ 93 };\ 94 } 95 #else 96 #define DPRINTF(name, arg) {} 97 #define DPRINTFIF(name, cond, arg) {} 98 #endif 99 100 101 /* constants to identify what kind of identifier we are dealing with */ 102 #define UDF_REGID_DOMAIN 1 103 #define UDF_REGID_UDF 2 104 #define UDF_REGID_IMPLEMENTATION 3 105 #define UDF_REGID_APPLICATION 4 106 #define UDF_REGID_NAME 99 107 108 109 /* DON'T change these: they identify 13thmonkey's UDF implementation */ 110 #define APP_NAME "*NetBSD UDF" 111 #define APP_VERSION_MAIN 0 112 #define APP_VERSION_SUB 4 113 #define IMPL_NAME "*NetBSD kernel UDF" 114 115 116 /* Configuration values */ 117 #define UDF_INODE_HASHBITS 10 118 #define UDF_INODE_HASHSIZE (1<<UDF_INODE_HASHBITS) 119 #define UDF_INODE_HASHMASK (UDF_INODE_HASHSIZE - 1) 120 #define UDF_ECCBUF_HASHBITS 10 121 #define UDF_ECCBUF_HASHSIZE (1<<UDF_ECCBUF_HASHBITS) 122 #define UDF_ECCBUF_HASHMASK (UDF_ECCBUF_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_METADATA 2 /* unspecified metadata */ 153 #define UDF_C_DSCR 3 /* update sectornr and CRC */ 154 #define UDF_C_NODE 4 /* file/dir node, update sectornr and CRC */ 155 #define UDF_C_EXTATTRS 5 /* dunno what to do yet */ 156 #define UDF_C_FIDS 6 /* update all contained fids */ 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 udf_node; 210 struct udf_strategy; 211 212 213 struct udf_lvintq { 214 uint32_t start; 215 uint32_t end; 216 uint32_t pos; 217 uint32_t wpos; 218 }; 219 220 221 struct udf_bitmap { 222 uint8_t *blob; /* allocated */ 223 uint8_t *bits; /* bits themselves */ 224 uint8_t *pages; /* dirty pages */ 225 uint32_t max_offset; /* in bits */ 226 uint32_t data_pos; /* position in data */ 227 uint32_t metadata_pos; /* .. in metadata */ 228 }; 229 230 231 struct udf_strat_args { 232 struct udf_mount *ump; 233 struct udf_node *udf_node; 234 struct long_ad *icb; 235 union dscrptr *dscr; 236 struct buf *nestbuf; 237 kauth_cred_t cred; 238 int waitfor; 239 }; 240 241 struct udf_strategy { 242 int (*create_logvol_dscr) (struct udf_strat_args *args); 243 void (*free_logvol_dscr) (struct udf_strat_args *args); 244 int (*read_logvol_dscr) (struct udf_strat_args *args); 245 int (*write_logvol_dscr) (struct udf_strat_args *args); 246 void (*queuebuf) (struct udf_strat_args *args); 247 void (*discstrat_init) (struct udf_strat_args *args); 248 void (*discstrat_finish) (struct udf_strat_args *args); 249 }; 250 251 extern struct udf_strategy udf_strat_bootstrap; 252 extern struct udf_strategy udf_strat_sequential; 253 extern struct udf_strategy udf_strat_direct; 254 extern struct udf_strategy udf_strat_rmw; 255 256 257 /* pre cleanup */ 258 struct udf_mount { 259 struct mount *vfs_mountp; 260 struct vnode *devvp; 261 struct mmc_discinfo discinfo; 262 struct udf_args mount_args; 263 264 /* format descriptors */ 265 kmutex_t logvol_mutex; 266 struct anchor_vdp *anchors[UDF_ANCHORS]; /* anchors to VDS */ 267 struct pri_vol_desc *primary_vol; /* identification */ 268 struct logvol_desc *logical_vol; /* main mapping v->p */ 269 struct unalloc_sp_desc *unallocated; /* free UDF space */ 270 struct impvol_desc *implementation; /* likely reduntant */ 271 struct logvol_int_desc *logvol_integrity; /* current integrity */ 272 struct part_desc *partitions[UDF_PARTITIONS]; /* partitions */ 273 /* logvol_info is derived; points *into* other structures */ 274 struct udf_logvol_info *logvol_info; /* integrity descr. */ 275 276 /* fileset and root directories */ 277 struct fileset_desc *fileset_desc; /* normally one */ 278 279 /* tracing logvol integrity history */ 280 struct udf_lvintq lvint_trace[UDF_LVDINT_SEGMENTS]; 281 int lvopen; /* logvol actions */ 282 int lvclose; /* logvol actions */ 283 284 /* disc allocation / writing method */ 285 int lvreadwrite; /* bits */ 286 int data_alloc; /* all userdata */ 287 int meta_alloc; /* all metadata */ 288 int data_part; 289 int metadata_part; 290 kmutex_t allocate_mutex; 291 292 /* logical to physical translations */ 293 int vtop[UDF_PMAPS+1]; /* vpartnr trans */ 294 int vtop_tp[UDF_PMAPS+1]; /* type of trans */ 295 296 /* sequential track info */ 297 struct mmc_trackinfo data_track; 298 struct mmc_trackinfo metadata_track; 299 300 /* VAT */ 301 uint32_t first_possible_vat_location; 302 uint32_t last_possible_vat_location; 303 uint32_t vat_entries; 304 uint32_t vat_offset; /* offset in table */ 305 uint32_t vat_last_free_lb; /* last free lb_num */ 306 uint32_t vat_table_len; 307 uint32_t vat_table_alloc_len; 308 uint8_t *vat_table; 309 uint8_t *vat_pages; /* TODO */ 310 struct udf_node *vat_node; /* system node */ 311 312 /* space bitmaps */ 313 struct space_bitmap_desc*part_unalloc_dscr[UDF_PARTITIONS]; 314 struct space_bitmap_desc*part_freed_dscr [UDF_PARTITIONS]; 315 struct udf_bitmap part_unalloc_bits[UDF_PARTITIONS]; 316 struct udf_bitmap part_freed_bits [UDF_PARTITIONS]; 317 318 /* sparable */ 319 uint32_t sparable_packet_size; 320 uint32_t packet_size; 321 struct udf_sparing_table*sparing_table; 322 323 /* meta */ 324 struct udf_node *metadata_node; /* system node */ 325 struct udf_node *metadatamirror_node; /* system node */ 326 struct udf_node *metadatabitmap_node; /* system node */ 327 struct udf_bitmap metadata_bitmap; /* TODO : readin */ 328 329 /* hash table to lookup icb -> udf_node and sorted list for sync */ 330 kmutex_t ihash_lock; 331 kmutex_t get_node_lock; 332 LIST_HEAD(, udf_node) udf_nodes[UDF_INODE_HASHSIZE]; 333 LIST_HEAD(, udf_node) sorted_udf_nodes; /* sorted sync list */ 334 335 /* syncing */ 336 int syncing; /* are we syncing? */ 337 kcondvar_t dirtynodes_cv; /* sleeping on sync */ 338 339 /* late allocation */ 340 uint32_t uncomitted_lb; /* for free space */ 341 struct long_ad *la_node_ad_cpy; /* issue buf */ 342 uint64_t *la_lmapping, *la_pmapping; /* issue buf */ 343 344 /* lists */ 345 STAILQ_HEAD(udfmntpts, udf_mount) all_udf_mntpnts; 346 347 /* device strategy */ 348 struct udf_strategy *strategy; 349 void *strategy_private; 350 }; 351 352 /* 353 * UDF node describing a file/directory. 354 * 355 * BUGALERT claim node_mutex before reading/writing to prevent inconsistencies ! 356 */ 357 struct udf_node { 358 struct genfs_node i_gnode; /* has to be first */ 359 struct vnode *vnode; /* vnode associated */ 360 struct udf_mount *ump; 361 362 kmutex_t node_mutex; 363 kcondvar_t node_lock; /* sleeping lock */ 364 char const *lock_fname; 365 int lock_lineno; 366 367 /* one of `fe' or `efe' can be set, not both (UDF file entry dscr.) */ 368 struct file_entry *fe; 369 struct extfile_entry *efe; 370 struct alloc_ext_entry *ext[UDF_MAX_ALLOC_EXTENTS]; 371 int num_extensions; 372 373 /* location found, recording location & hints */ 374 struct long_ad loc; /* FID/hash loc. */ 375 struct long_ad write_loc; /* strat 4096 loc */ 376 int needs_indirect; /* has missing indr. */ 377 struct long_ad ext_loc[UDF_MAX_ALLOC_EXTENTS]; 378 379 uint64_t last_diroffset; /* speeding up lookup*/ 380 381 /* misc */ 382 uint32_t i_flags; /* associated flags */ 383 struct lockf *lockf; /* lock list */ 384 uint32_t outstanding_bufs; /* file data */ 385 uint32_t outstanding_nodedscr; /* node dscr */ 386 387 /* references to associated nodes */ 388 struct udf_node *extattr; 389 struct udf_node *streamdir; 390 struct udf_node *my_parent; /* if extended attr. */ 391 392 LIST_ENTRY(udf_node) hashchain; /* inside hash line */ 393 LIST_ENTRY(udf_node) sortchain; /* sorted udf nodes */ 394 }; 395 396 397 /* misc. flags stored in i_flags (XXX needs cleaning up) */ 398 #define IN_ACCESS 0x0001 /* Inode access time update request. */ 399 #define IN_CHANGE 0x0002 /* Inode change time update request. */ 400 #define IN_UPDATE 0x0004 /* Inode was written to; update mtime*/ 401 #define IN_MODIFY 0x0008 /* Modification time update request. */ 402 #define IN_MODIFIED 0x0010 /* node has been modified. */ 403 #define IN_ACCESSED 0x0020 /* node has been accessed. */ 404 #define IN_RENAME 0x0040 /* node is being renamed. XXX ?? */ 405 #define IN_DELETED 0x0080 /* node is unlinked, no FID reference */ 406 #define IN_LOCKED 0x0100 /* node is locked by condvar */ 407 #define IN_SYNCED 0x0200 /* node is being used by sync */ 408 #define IN_CALLBACK_ULK 0x0400 /* node will be unlocked by callback */ 409 410 411 #define IN_FLAGBITS \ 412 "\10\1IN_ACCESS\2IN_CHANGE\3IN_UPDATE\4IN_MODIFY\5IN_MODIFIED" \ 413 "\6IN_ACCESSED\7IN_RENAME\10IN_DELETED\11IN_LOCKED\12IN_SYNCED" \ 414 "\13IN_CALLBACK_ULK" 415 416 #endif /* !_FS_UDF_UDF_H_ */ 417
Indexes created Mon Sep 22 21:09:42 GMT 2025