sys/fs/udf/udf.h

   1 /* $NetBSD: udf.h,v 1.50 2015/08/24 08:31:56 hannken 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/rbtree.h>
  34 #include <sys/uio.h>
  35 #include <sys/mutex.h>
  36
  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>
  44
  45 /* debug section */
  46 extern int udf_verbose;
  47
  48 /* undefine UDF_COMPLETE_DELETE to need `purge'; but purge is not implemented */
  49 #define UDF_COMPLETE_DELETE
  50
  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
  77
  78 /* initial value of udf_verbose */
  79 #define UDF_DEBUGGING           0
  80
  81 #ifdef UDF_DEBUG
  82 #define DPRINTF(name, arg) { \
  83                 if (udf_verbose & UDF_DEBUG_##name) {\
  84                         printf arg;\
  85                 };\
  86         }
  87 #define DPRINTFIF(name, cond, arg) { \
  88                 if (udf_verbose & UDF_DEBUG_##name) { \
  89                         if (cond) printf arg;\
  90                 };\
  91         }
  92 #else
  93 #define DPRINTF(name, arg) {}
  94 #define DPRINTFIF(name, cond, arg) {}
  95 #endif
  96
  97 VFS_PROTOS(udf);
  98
  99 /* constants to identify what kind of identifier we are dealing with */
 100 #define UDF_REGID_DOMAIN                 1
 101 #define UDF_REGID_UDF                    2
 102 #define UDF_REGID_IMPLEMENTATION         3
 103 #define UDF_REGID_APPLICATION            4
 104 #define UDF_REGID_NAME                  99
 105
 106
 107 /* DON'T change these: they identify 13thmonkey's UDF implementation */
 108 #define APP_NAME                "*NetBSD UDF"
 109 #define APP_VERSION_MAIN        0
 110 #define APP_VERSION_SUB         5
 111 #define IMPL_NAME               "*NetBSD kernel UDF"
 112
 113
 114 /* Configuration values */
 115 #define UDF_INODE_HASHBITS      10
 116 #define UDF_INODE_HASHSIZE      (1<<UDF_INODE_HASHBITS)
 117 #define UDF_INODE_HASHMASK      (UDF_INODE_HASHSIZE - 1)
 118 #define UDF_ECCBUF_HASHBITS     10
 119 #define UDF_ECCBUF_HASHSIZE     (1<<UDF_ECCBUF_HASHBITS)
 120 #define UDF_ECCBUF_HASHMASK     (UDF_ECCBUF_HASHSIZE -1)
 121
 122 #define UDF_ECCLINE_MAXFREE     5                       /* picked, needs calculation */
 123 #define UDF_ECCLINE_MAXBUSY     100                     /* picked, needs calculation */
 124
 125 #define UDF_MAX_MAPPINGS        (MAXPHYS/DEV_BSIZE)     /* 128 */
 126 #define UDF_VAT_CHUNKSIZE       (64*1024)               /* picked */
 127 #define UDF_SYMLINKBUFLEN       (64*1024)               /* picked */
 128
 129 #define UDF_DISC_SLACK          (128)                   /* picked, at least 64 kb or 128 */
 130 #define UDF_ISO_VRS_SIZE        (32*2048)               /* 32 ISO `sectors' */
 131
 132 #define UDF_MAX_INDIRS_FOLLOW   1024                    /* picked */
 133
 134
 135 /* structure space */
 136 #define UDF_ANCHORS             4       /* 256, 512, N-256, N */
 137 #define UDF_PARTITIONS          4       /* overkill */
 138 #define UDF_PMAPS               5       /* overkill */
 139 #define UDF_LVDINT_SEGMENTS     100     /* big overkill */
 140 #define UDF_LVINT_LOSSAGE       4       /* lose 2 openings */
 141 #define UDF_MAX_ALLOC_EXTENTS   50      /* overkill */
 142
 143
 144 /* constants */
 145 #define UDF_MAXNAMLEN           255                     /* as per SPEC */
 146 #define UDF_TRANS_ZERO          ((uint64_t) -1)
 147 #define UDF_TRANS_UNMAPPED      ((uint64_t) -2)
 148 #define UDF_TRANS_INTERN        ((uint64_t) -3)
 149 #define UDF_MAX_SECTOR          ((uint64_t) -10)        /* high water mark */
 150
 151
 152 /* RW content hint for allocation and other purposes */
 153 #define UDF_C_ABSOLUTE           0      /* blob to write at absolute */
 154 #define UDF_C_PROCESSED          0      /* not relevant */
 155 #define UDF_C_USERDATA           1      /* all but userdata is metadata */
 156 #define UDF_C_DSCR               2      /* update sectornr and CRC */
 157 #define UDF_C_FLOAT_DSCR         3      /* update sectornr and CRC; sequential */
 158 #define UDF_C_NODE               4      /* file/dir node, update sectornr and CRC */
 159 #define UDF_C_FIDS               5      /* update all contained fids */
 160 #define UDF_C_METADATA_SBM       6      /* space bitmap, update sectornr and CRC */
 161 #define UDF_C_EXTATTRS           7      /* dunno what to do yet */
 162
 163 /* use unused b_freelistindex for our UDF_C_TYPE */
 164 #define b_udf_c_type    b_freelistindex
 165
 166
 167 /* virtual to physical mapping types */
 168 #define UDF_VTOP_RAWPART UDF_PMAPS      /* [0..UDF_PMAPS> are normal     */
 169
 170 #define UDF_VTOP_TYPE_RAW            0
 171 #define UDF_VTOP_TYPE_UNKNOWN        0
 172 #define UDF_VTOP_TYPE_PHYS           1
 173 #define UDF_VTOP_TYPE_VIRT           2
 174 #define UDF_VTOP_TYPE_SPARABLE       3
 175 #define UDF_VTOP_TYPE_META           4
 176
 177
 178 /* allocation strategies */
 179 #define UDF_ALLOC_INVALID            0
 180 #define UDF_ALLOC_SEQUENTIAL         1  /* linear on NWA                 */
 181 #define UDF_ALLOC_VAT                2  /* VAT handling                  */
 182 #define UDF_ALLOC_SPACEMAP           3  /* spacemaps                     */
 183 #define UDF_ALLOC_METABITMAP         4  /* metadata bitmap               */
 184 #define UDF_ALLOC_METASEQUENTIAL     5  /* in chunks seq., nodes not seq */
 185 #define UDF_ALLOC_RELAXEDSEQUENTIAL  6  /* only nodes not seq.           */
 186
 187
 188 /* logical volume open/close actions */
 189 #define UDF_OPEN_SESSION          0x01  /* if needed writeout VRS + VDS      */
 190 #define UDF_CLOSE_SESSION         0x02  /* close session after writing VAT   */
 191 #define UDF_FINALISE_DISC         0x04  /* close session after writing VAT   */
 192 #define UDF_WRITE_VAT             0x08  /* sequential VAT filesystem         */
 193 #define UDF_WRITE_LVINT           0x10  /* write out open lvint              */
 194 #define UDF_WRITE_PART_BITMAPS    0x20  /* write out partition space bitmaps */
 195 #define UDF_APPENDONLY_LVINT      0x40  /* no shifting, only appending       */
 196 #define UDF_WRITE_METAPART_NODES  0x80  /* write out metadata partition nodes*/
 197 #define UDFLOGVOL_BITS "\20\1OPEN_SESSION\2CLOSE_SESSION\3FINALISE_DISC" \
 198                         "\4WRITE_VAT\5WRITE_LVINT\6WRITE_PART_BITMAPS" \
 199                         "\7APPENDONLY_LVINT\10WRITE_METAPART_NODES"
 200
 201 /* logical volume error handling actions */
 202 #define UDF_UPDATE_TRACKINFO      0x01  /* update trackinfo and re-shedule   */
 203 #define UDF_REMAP_BLOCK           0x02  /* remap the failing block length    */
 204 #define UDFONERROR_BITS "\20\1UPDATE_TRACKINFO\2REMAP_BLOCK"
 205
 206
 207 /* readdir cookies */
 208 #define UDF_DIRCOOKIE_DOT 1
 209
 210
 211 /* malloc pools */
 212 MALLOC_DECLARE(M_UDFMNT);
 213 MALLOC_DECLARE(M_UDFVOLD);
 214 MALLOC_DECLARE(M_UDFTEMP);
 215
 216 extern struct pool udf_node_pool;
 217 struct udf_node;
 218 struct udf_strategy;
 219
 220
 221 struct udf_lvintq {
 222         uint32_t                start;
 223         uint32_t                end;
 224         uint32_t                pos;
 225         uint32_t                wpos;
 226 };
 227
 228
 229 struct udf_bitmap {
 230         uint8_t                 *blob;                  /* allocated         */
 231         uint8_t                 *bits;                  /* bits themselves   */
 232         uint8_t                 *pages;                 /* dirty pages       */
 233         uint32_t                 max_offset;            /* in bits           */
 234         uint32_t                 data_pos;              /* position in data  */
 235         uint32_t                 metadata_pos;          /* .. in metadata    */
 236 };
 237
 238
 239 struct udf_strat_args {
 240         struct udf_mount *ump;
 241         struct udf_node  *udf_node;
 242         struct long_ad   *icb;
 243         union dscrptr    *dscr;
 244         struct buf       *nestbuf;
 245         kauth_cred_t      cred;
 246         int waitfor;
 247 };
 248
 249 struct udf_strategy {
 250         int  (*create_logvol_dscr)  (struct udf_strat_args *args);
 251         void (*free_logvol_dscr)    (struct udf_strat_args *args);
 252         int  (*read_logvol_dscr)    (struct udf_strat_args *args);
 253         int  (*write_logvol_dscr)   (struct udf_strat_args *args);
 254         void (*queuebuf)            (struct udf_strat_args *args);
 255         void (*discstrat_init)      (struct udf_strat_args *args);
 256         void (*discstrat_finish)    (struct udf_strat_args *args);
 257 };
 258
 259 extern struct udf_strategy udf_strat_bootstrap;
 260 extern struct udf_strategy udf_strat_sequential;
 261 extern struct udf_strategy udf_strat_direct;
 262 extern struct udf_strategy udf_strat_rmw;
 263
 264
 265 /* pre cleanup */
 266 struct udf_mount {
 267         struct mount            *vfs_mountp;
 268         struct vnode            *devvp;
 269         struct mmc_discinfo      discinfo;
 270         struct udf_args          mount_args;
 271
 272         /* format descriptors */
 273         kmutex_t                 logvol_mutex;
 274         struct anchor_vdp       *anchors[UDF_ANCHORS];  /* anchors to VDS    */
 275         struct pri_vol_desc     *primary_vol;           /* identification    */
 276         struct logvol_desc      *logical_vol;           /* main mapping v->p */
 277         struct unalloc_sp_desc  *unallocated;           /* free UDF space    */
 278         struct impvol_desc      *implementation;        /* likely reduntant  */
 279         struct logvol_int_desc  *logvol_integrity;      /* current integrity */
 280         struct part_desc        *partitions[UDF_PARTITIONS]; /* partitions   */
 281         /* logvol_info is derived; points *into* other structures */
 282         struct udf_logvol_info  *logvol_info;           /* integrity descr.  */
 283
 284         /* fileset and root directories */
 285         struct fileset_desc     *fileset_desc;          /* normally one      */
 286
 287         /* tracing logvol integrity history */
 288         struct udf_lvintq        lvint_trace[UDF_LVDINT_SEGMENTS];
 289         int                      lvopen;                /* logvol actions    */
 290         int                      lvclose;               /* logvol actions    */
 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         /* disc allocation / writing method */
 297         kmutex_t                 allocate_mutex;
 298         int                      lvreadwrite;           /* error handling    */
 299         int                      vtop_alloc[UDF_PMAPS+1]; /* alloc scheme    */
 300         int                      data_part;
 301         int                      node_part;
 302         int                      fids_part;
 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 for physical partitions */
 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 space_bitmap_desc*metadata_unalloc_dscr;
 336         struct udf_bitmap        metadata_unalloc_bits;
 337         uint32_t                 metadata_alloc_unit_size;
 338         uint16_t                 metadata_alignment_unit_size;
 339         uint8_t                  metadata_flags;
 340
 341         /* rb tree for lookup icb to udf_node and sorted list for sync */
 342         struct rb_tree  udf_node_tree;
 343
 344         /* syncing */
 345         int             syncing;                        /* are we syncing?   */
 346         kmutex_t        sync_lock;                      /* serialize syncing */
 347
 348         /* late allocation */
 349         int32_t                  uncommitted_lbs[UDF_PARTITIONS];
 350         struct long_ad          *la_node_ad_cpy;                /* issue buf */
 351         uint64_t                *la_lmapping, *la_pmapping;     /* issue buf */
 352
 353         /* lists */
 354         STAILQ_HEAD(udfmntpts, udf_mount) all_udf_mntpnts;
 355
 356         /* device strategy */
 357         struct udf_strategy     *strategy;
 358         void                    *strategy_private;
 359 };
 360
 361 /*
 362  * UDF node describing a file/directory.
 363  *
 364  * BUGALERT claim node_mutex before reading/writing to prevent inconsistencies !
 365  */
 366 struct udf_node {
 367         struct genfs_node       i_gnode;                /* has to be first   */
 368         struct vnode            *vnode;                 /* vnode associated  */
 369         struct udf_mount        *ump;
 370
 371         kmutex_t                 node_mutex;
 372         kcondvar_t               node_lock;             /* sleeping lock */
 373         char const              *lock_fname;
 374         int                      lock_lineno;
 375
 376         /* rb_node for fast lookup and fast sequential visiting */
 377         struct rb_node           rbnode;
 378
 379         /* one of `fe' or `efe' can be set, not both (UDF file entry dscr.)  */
 380         struct file_entry       *fe;
 381         struct extfile_entry    *efe;
 382         struct alloc_ext_entry  *ext[UDF_MAX_ALLOC_EXTENTS];
 383         int                      num_extensions;
 384
 385         /* location found, recording location & hints */
 386         struct long_ad           loc;                   /* FID/hash loc.     */
 387         struct long_ad           write_loc;             /* strat 4096 loc    */
 388         int                      needs_indirect;        /* has missing indr. */
 389         struct long_ad           ext_loc[UDF_MAX_ALLOC_EXTENTS];
 390
 391         struct dirhash          *dir_hash;
 392
 393         /* misc */
 394         uint32_t                 i_flags;               /* associated flags  */
 395         struct lockf            *lockf;                 /* lock list         */
 396         uint32_t                 outstanding_bufs;      /* file data         */
 397         uint32_t                 outstanding_nodedscr;  /* node dscr         */
 398         int32_t                  uncommitted_lbs;       /* in UBC            */
 399
 400         /* references to associated nodes */
 401         struct udf_node         *extattr;
 402         struct udf_node         *streamdir;
 403         struct udf_node         *my_parent;             /* if extended attr. */
 404 };
 405
 406
 407 /* misc. flags stored in i_flags (XXX needs cleaning up) */
 408 #define IN_ACCESS               0x0001  /* Inode access time update request  */
 409 #define IN_CHANGE               0x0002  /* Inode change time update request  */
 410 #define IN_UPDATE               0x0004  /* Inode was written to; update mtime*/
 411 #define IN_MODIFY               0x0008  /* Modification time update request  */
 412 #define IN_MODIFIED             0x0010  /* node has been modified */
 413 #define IN_ACCESSED             0x0020  /* node has been accessed */
 414 #define IN_RENAME               0x0040  /* node is being renamed. XXX ?? */
 415 #define IN_DELETED              0x0080  /* node is unlinked, no FID reference*/
 416 #define IN_LOCKED               0x0100  /* node is locked by condvar */
 417 #define IN_SYNCED               0x0200  /* node is being used by sync */
 418 #define IN_CALLBACK_ULK         0x0400  /* node will be unlocked by callback */
 419 #define IN_NODE_REBUILD         0x0800  /* node is rebuild */
 420
 421
 422 #define IN_FLAGBITS \
 423         "\10\1IN_ACCESS\2IN_CHANGE\3IN_UPDATE\4IN_MODIFY\5IN_MODIFIED" \
 424         "\6IN_ACCESSED\7IN_RENAME\10IN_DELETED\11IN_LOCKED\12IN_SYNCED" \
 425         "\13IN_CALLBACK_ULK\14IN_NODE_REBUILD"
 426
 427 #endif /* !_FS_UDF_UDF_H_ */