Sync usage with man page.
[netbsd-mini2440.git] / sys / fs / udf / udf.h
blobefe9133d9e628492457a738705fa2cd71b02735d
1 /* $NetBSD: udf.h,v 1.37 2009/07/08 14:53:23 reinoud Exp $ */
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.
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.
29 #ifndef _FS_UDF_UDF_H_
30 #define _FS_UDF_UDF_H_
32 #include <sys/queue.h>
33 #include <sys/rb.h>
34 #include <sys/uio.h>
35 #include <sys/mutex.h>
37 #include "udf_osta.h"
38 #include "ecma167-udf.h"
39 #include <sys/cdio.h>
40 #include <sys/bufq.h>
41 #include <sys/disk.h>
42 #include <sys/kthread.h>
43 #include <miscfs/genfs/genfs_node.h>
45 /* debug section */
46 extern int udf_verbose;
48 /* undefine UDF_COMPLETE_DELETE to need `purge'; but purge is not implemented */
49 #define UDF_COMPLETE_DELETE
51 /* debug categories */
52 #define UDF_DEBUG_VOLUMES 0x0000001
53 #define UDF_DEBUG_LOCKING 0x0000002
54 #define UDF_DEBUG_NODE 0x0000004
55 #define UDF_DEBUG_LOOKUP 0x0000008
56 #define UDF_DEBUG_READDIR 0x0000010
57 #define UDF_DEBUG_FIDS 0x0000020
58 #define UDF_DEBUG_DESCRIPTOR 0x0000040
59 #define UDF_DEBUG_TRANSLATE 0x0000080
60 #define UDF_DEBUG_STRATEGY 0x0000100
61 #define UDF_DEBUG_READ 0x0000200
62 #define UDF_DEBUG_WRITE 0x0000400
63 #define UDF_DEBUG_CALL 0x0000800
64 #define UDF_DEBUG_ATTR 0x0001000
65 #define UDF_DEBUG_EXTATTR 0x0002000
66 #define UDF_DEBUG_ALLOC 0x0004000
67 #define UDF_DEBUG_ADWLK 0x0008000
68 #define UDF_DEBUG_DIRHASH 0x0010000
69 #define UDF_DEBUG_NOTIMPL 0x0020000
70 #define UDF_DEBUG_SHEDULE 0x0040000
71 #define UDF_DEBUG_ECCLINE 0x0080000
72 #define UDF_DEBUG_SYNC 0x0100000
73 #define UDF_DEBUG_PARANOIA 0x0200000
74 #define UDF_DEBUG_PARANOIDADWLK 0x0400000
75 #define UDF_DEBUG_NODEDUMP 0x0800000
76 #define UDF_DEBUG_RESERVE 0x1000000
78 /* initial value of udf_verbose */
79 #define UDF_DEBUGGING 0
81 #ifdef DEBUG
82 #define DPRINTF(name, arg) { \
83 if (udf_verbose & UDF_DEBUG_##name) {\
84 printf arg;\
85 };\
87 #define DPRINTFIF(name, cond, arg) { \
88 if (udf_verbose & UDF_DEBUG_##name) { \
89 if (cond) printf arg;\
90 };\
92 #else
93 #define DPRINTF(name, arg) {}
94 #define DPRINTFIF(name, cond, arg) {}
95 #endif
98 /* constants to identify what kind of identifier we are dealing with */
99 #define UDF_REGID_DOMAIN 1
100 #define UDF_REGID_UDF 2
101 #define UDF_REGID_IMPLEMENTATION 3
102 #define UDF_REGID_APPLICATION 4
103 #define UDF_REGID_NAME 99
106 /* DON'T change these: they identify 13thmonkey's UDF implementation */
107 #define APP_NAME "*NetBSD UDF"
108 #define APP_VERSION_MAIN 0
109 #define APP_VERSION_SUB 5
110 #define IMPL_NAME "*NetBSD kernel UDF"
113 /* Configuration values */
114 #define UDF_INODE_HASHBITS 10
115 #define UDF_INODE_HASHSIZE (1<<UDF_INODE_HASHBITS)
116 #define UDF_INODE_HASHMASK (UDF_INODE_HASHSIZE - 1)
117 #define UDF_ECCBUF_HASHBITS 10
118 #define UDF_ECCBUF_HASHSIZE (1<<UDF_ECCBUF_HASHBITS)
119 #define UDF_ECCBUF_HASHMASK (UDF_ECCBUF_HASHSIZE -1)
121 #define UDF_ECCLINE_MAXFREE 5 /* picked, needs calculation */
122 #define UDF_ECCLINE_MAXBUSY 100 /* picked, needs calculation */
124 #define UDF_MAX_MAPPINGS (MAXPHYS/DEV_BSIZE) /* 128 */
125 #define UDF_VAT_CHUNKSIZE (64*1024) /* picked */
126 #define UDF_SYMLINKBUFLEN (64*1024) /* picked */
128 #define UDF_DISC_SLACK (128) /* picked, at least 64 kb or 128 */
129 #define UDF_ISO_VRS_SIZE (32*2048) /* 32 ISO `sectors' */
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 */
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 */
149 /* RW content hint for allocation and other purposes */
150 #define UDF_C_ABSOLUTE 0 /* blob to write at absolute */
151 #define UDF_C_PROCESSED 0 /* not relevant */
152 #define UDF_C_USERDATA 1 /* all but userdata is metadata */
153 #define UDF_C_DSCR 2 /* update sectornr and CRC */
154 #define UDF_C_FLOAT_DSCR 3 /* update sectornr and CRC; sequential */
155 #define UDF_C_NODE 4 /* file/dir node, update sectornr and CRC */
156 #define UDF_C_FIDS 5 /* update all contained fids */
157 #define UDF_C_METADATA_SBM 6 /* space bitmap, update sectornr and CRC */
158 #define UDF_C_EXTATTRS 7 /* dunno what to do yet */
160 /* use unused b_freelistindex for our UDF_C_TYPE */
161 #define b_udf_c_type b_freelistindex
164 /* virtual to physical mapping types */
165 #define UDF_VTOP_RAWPART UDF_PMAPS /* [0..UDF_PMAPS> are normal */
167 #define UDF_VTOP_TYPE_RAW 0
168 #define UDF_VTOP_TYPE_UNKNOWN 0
169 #define UDF_VTOP_TYPE_PHYS 1
170 #define UDF_VTOP_TYPE_VIRT 2
171 #define UDF_VTOP_TYPE_SPARABLE 3
172 #define UDF_VTOP_TYPE_META 4
175 /* allocation strategies */
176 #define UDF_ALLOC_INVALID 0
177 #define UDF_ALLOC_SEQUENTIAL 1 /* linear on NWA */
178 #define UDF_ALLOC_VAT 2 /* VAT handling */
179 #define UDF_ALLOC_SPACEMAP 3 /* spacemaps */
180 #define UDF_ALLOC_METABITMAP 4 /* metadata bitmap */
181 #define UDF_ALLOC_METASEQUENTIAL 5 /* in chunks seq., nodes not seq */
182 #define UDF_ALLOC_RELAXEDSEQUENTIAL 6 /* only nodes not seq. */
185 /* logical volume open/close actions */
186 #define UDF_OPEN_SESSION 0x01 /* if needed writeout VRS + VDS */
187 #define UDF_CLOSE_SESSION 0x02 /* close session after writing VAT */
188 #define UDF_FINALISE_DISC 0x04 /* close session after writing VAT */
189 #define UDF_WRITE_VAT 0x08 /* sequential VAT filesystem */
190 #define UDF_WRITE_LVINT 0x10 /* write out open lvint */
191 #define UDF_WRITE_PART_BITMAPS 0x20 /* write out partition space bitmaps */
192 #define UDF_APPENDONLY_LVINT 0x40 /* no shifting, only appending */
193 #define UDFLOGVOL_BITS "\20\1OPEN_SESSION\2CLOSE_SESSION\3FINALISE_DISC" \
194 "\4WRITE_VAT\5WRITE_LVINT\6WRITE_PART_BITMAPS" \
195 "\7APPENDONLY_LVINT"
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"
203 /* readdir cookies */
204 #define UDF_DIRCOOKIE_DOT 1
207 /* malloc pools */
208 MALLOC_DECLARE(M_UDFMNT);
209 MALLOC_DECLARE(M_UDFVOLD);
210 MALLOC_DECLARE(M_UDFTEMP);
212 struct pool udf_node_pool;
213 struct udf_node;
214 struct udf_strategy;
217 struct udf_lvintq {
218 uint32_t start;
219 uint32_t end;
220 uint32_t pos;
221 uint32_t wpos;
225 struct udf_bitmap {
226 uint8_t *blob; /* allocated */
227 uint8_t *bits; /* bits themselves */
228 uint8_t *pages; /* dirty pages */
229 uint32_t max_offset; /* in bits */
230 uint32_t data_pos; /* position in data */
231 uint32_t metadata_pos; /* .. in metadata */
235 struct udf_strat_args {
236 struct udf_mount *ump;
237 struct udf_node *udf_node;
238 struct long_ad *icb;
239 union dscrptr *dscr;
240 struct buf *nestbuf;
241 kauth_cred_t cred;
242 int waitfor;
245 struct udf_strategy {
246 int (*create_logvol_dscr) (struct udf_strat_args *args);
247 void (*free_logvol_dscr) (struct udf_strat_args *args);
248 int (*read_logvol_dscr) (struct udf_strat_args *args);
249 int (*write_logvol_dscr) (struct udf_strat_args *args);
250 void (*queuebuf) (struct udf_strat_args *args);
251 void (*discstrat_init) (struct udf_strat_args *args);
252 void (*discstrat_finish) (struct udf_strat_args *args);
255 extern struct udf_strategy udf_strat_bootstrap;
256 extern struct udf_strategy udf_strat_sequential;
257 extern struct udf_strategy udf_strat_direct;
258 extern struct udf_strategy udf_strat_rmw;
261 /* pre cleanup */
262 struct udf_mount {
263 struct mount *vfs_mountp;
264 struct vnode *devvp;
265 struct mmc_discinfo discinfo;
266 struct udf_args mount_args;
268 /* format descriptors */
269 kmutex_t logvol_mutex;
270 struct anchor_vdp *anchors[UDF_ANCHORS]; /* anchors to VDS */
271 struct pri_vol_desc *primary_vol; /* identification */
272 struct logvol_desc *logical_vol; /* main mapping v->p */
273 struct unalloc_sp_desc *unallocated; /* free UDF space */
274 struct impvol_desc *implementation; /* likely reduntant */
275 struct logvol_int_desc *logvol_integrity; /* current integrity */
276 struct part_desc *partitions[UDF_PARTITIONS]; /* partitions */
277 /* logvol_info is derived; points *into* other structures */
278 struct udf_logvol_info *logvol_info; /* integrity descr. */
280 /* fileset and root directories */
281 struct fileset_desc *fileset_desc; /* normally one */
283 /* tracing logvol integrity history */
284 struct udf_lvintq lvint_trace[UDF_LVDINT_SEGMENTS];
285 int lvopen; /* logvol actions */
286 int lvclose; /* logvol actions */
288 /* logical to physical translations */
289 int vtop[UDF_PMAPS+1]; /* vpartnr trans */
290 int vtop_tp[UDF_PMAPS+1]; /* type of trans */
292 /* disc allocation / writing method */
293 kmutex_t allocate_mutex;
294 int lvreadwrite; /* error handling */
295 int vtop_alloc[UDF_PMAPS+1]; /* alloc scheme */
296 int data_part;
297 int node_part;
298 int fids_part;
300 /* sequential track info */
301 struct mmc_trackinfo data_track;
302 struct mmc_trackinfo metadata_track;
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 */
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];
322 /* sparable */
323 uint32_t sparable_packet_size;
324 uint32_t packet_size;
325 struct udf_sparing_table*sparing_table;
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;
334 /* rb tree for lookup icb to udf_node and sorted list for sync */
335 kmutex_t ihash_lock;
336 kmutex_t get_node_lock;
337 struct rb_tree udf_node_tree;
339 /* syncing */
340 int syncing; /* are we syncing? */
341 kcondvar_t dirtynodes_cv; /* sleeping on sync */
343 /* late allocation */
344 int32_t uncommitted_lbs[UDF_PARTITIONS];
345 struct long_ad *la_node_ad_cpy; /* issue buf */
346 uint64_t *la_lmapping, *la_pmapping; /* issue buf */
348 /* lists */
349 STAILQ_HEAD(udfmntpts, udf_mount) all_udf_mntpnts;
351 /* device strategy */
352 struct udf_strategy *strategy;
353 void *strategy_private;
357 #define RBTOUDFNODE(node) \
358 ((node) ? \
359 (void *)((uintptr_t)(node) - offsetof(struct udf_node, rbnode)) \
360 : NULL)
363 * UDF node describing a file/directory.
365 * BUGALERT claim node_mutex before reading/writing to prevent inconsistencies !
367 struct udf_node {
368 struct genfs_node i_gnode; /* has to be first */
369 struct vnode *vnode; /* vnode associated */
370 struct udf_mount *ump;
372 kmutex_t node_mutex;
373 kcondvar_t node_lock; /* sleeping lock */
374 char const *lock_fname;
375 int lock_lineno;
377 /* rb_node for fast lookup and fast sequential visiting */
378 struct rb_node rbnode;
380 /* one of `fe' or `efe' can be set, not both (UDF file entry dscr.) */
381 struct file_entry *fe;
382 struct extfile_entry *efe;
383 struct alloc_ext_entry *ext[UDF_MAX_ALLOC_EXTENTS];
384 int num_extensions;
386 /* location found, recording location & hints */
387 struct long_ad loc; /* FID/hash loc. */
388 struct long_ad write_loc; /* strat 4096 loc */
389 int needs_indirect; /* has missing indr. */
390 struct long_ad ext_loc[UDF_MAX_ALLOC_EXTENTS];
392 struct dirhash *dir_hash;
394 /* misc */
395 uint32_t i_flags; /* associated flags */
396 struct lockf *lockf; /* lock list */
397 uint32_t outstanding_bufs; /* file data */
398 uint32_t outstanding_nodedscr; /* node dscr */
399 int32_t uncommitted_lbs; /* in UBC */
401 /* references to associated nodes */
402 struct udf_node *extattr;
403 struct udf_node *streamdir;
404 struct udf_node *my_parent; /* if extended attr. */
408 /* misc. flags stored in i_flags (XXX needs cleaning up) */
409 #define IN_ACCESS 0x0001 /* Inode access time update request */
410 #define IN_CHANGE 0x0002 /* Inode change time update request */
411 #define IN_UPDATE 0x0004 /* Inode was written to; update mtime*/
412 #define IN_MODIFY 0x0008 /* Modification time update request */
413 #define IN_MODIFIED 0x0010 /* node has been modified */
414 #define IN_ACCESSED 0x0020 /* node has been accessed */
415 #define IN_RENAME 0x0040 /* node is being renamed. XXX ?? */
416 #define IN_DELETED 0x0080 /* node is unlinked, no FID reference*/
417 #define IN_LOCKED 0x0100 /* node is locked by condvar */
418 #define IN_SYNCED 0x0200 /* node is being used by sync */
419 #define IN_CALLBACK_ULK 0x0400 /* node will be unlocked by callback */
420 #define IN_NODE_REBUILD 0x0800 /* node is rebuild */
423 #define IN_FLAGBITS \
424 "\10\1IN_ACCESS\2IN_CHANGE\3IN_UPDATE\4IN_MODIFY\5IN_MODIFIED" \
425 "\6IN_ACCESSED\7IN_RENAME\10IN_DELETED\11IN_LOCKED\12IN_SYNCED" \
426 "\13IN_CALLBACK_ULK\14IN_NODE_REBUILD"
428 #endif /* !_FS_UDF_UDF_H_ */