bsd/isofs/cd9660/iso.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /*      $NetBSD: iso.h,v 1.9 1995/01/18 09:23:19 mycroft Exp $  */
  23
  24 /*-
  25  * Copyright (c) 1994
  26  *      The Regents of the University of California.  All rights reserved.
  27  *
  28  * This code is derived from software contributed to Berkeley
  29  * by Pace Willisson (pace@blitz.com).  The Rock Ridge Extension
  30  * Support code is derived from software contributed to Berkeley
  31  * by Atsushi Murai (amurai@spec.co.jp).
  32  *
  33  * Redistribution and use in source and binary forms, with or without
  34  * modification, are permitted provided that the following conditions
  35  * are met:
  36  * 1. Redistributions of source code must retain the above copyright
  37  *    notice, this list of conditions and the following disclaimer.
  38  * 2. Redistributions in binary form must reproduce the above copyright
  39  *    notice, this list of conditions and the following disclaimer in the
  40  *    documentation and/or other materials provided with the distribution.
  41  * 3. All advertising materials mentioning features or use of this software
  42  *    must display the following acknowledgement:
  43  *      This product includes software developed by the University of
  44  *      California, Berkeley and its contributors.
  45  * 4. Neither the name of the University nor the names of its contributors
  46  *    may be used to endorse or promote products derived from this software
  47  *    without specific prior written permission.
  48  *
  49  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  50  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  51  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  52  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  53  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  54  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  55  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  56  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  57  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  58  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  59  * SUCH DAMAGE.
  60  *
  61  *      @(#)iso.h       8.4 (Berkeley) 12/5/94
  62  */
  63 #ifndef _ISO_H_
  64 #define _ISO_H_
  65
  66 #define ISODCL(from, to) (to - from + 1)
  67
  68 struct iso_volume_descriptor {
  69         char type            [ISODCL(1,1)]; /* 711 */
  70         char volume_desc_id  [ISODCL(2,6)];
  71         char version         [ISODCL(7,7)];
  72         char data            [ISODCL(8,2048)];
  73 };
  74
  75 /* volume descriptor types */
  76 #define ISO_VD_BOOT            0
  77 #define ISO_VD_PRIMARY         1
  78 #define ISO_VD_SUPPLEMENTARY   2
  79 #define ISO_VD_PARTITION       3
  80 #define ISO_VD_END           255
  81
  82 #define ISO_STANDARD_ID "CD001"
  83 #define ISO_ECMA_ID     "CDW01"
  84 #define ISO_XA_ID               "CD-XA001"      /* XA style disk signature */
  85 #define ISO9660SIGNATURE 0x4147         /* for getattrlist ATTR_VOL_SIGNATURE */
  86
  87 /* Universal Character Set implementation levels (for Joliet) */
  88 #define ISO_UCS2_Level_1        "%/@"   /* No combining chars */
  89 #define ISO_UCS2_Level_2        "%/C"   /* Combining chars allowed with restrictions */
  90 #define ISO_UCS2_Level_3        "%/E"   /* Combining chars allowed, no restrictions */
  91
  92 #define UCS_SEPARATOR1  0x002e
  93 #define UCS_SEPARATOR2  0x003b
  94
  95 /* pathconf filename lengths */
  96 #define ISO_NAMEMAX             (31+1)
  97 #define ISO_JOLIET_NAMEMAX      (64*3)
  98 #define ISO_RRIP_NAMEMAX        255
  99
 100 /* Finder flags, from Technical Note 40 */
 101 #define         fLockedBit              0x8000
 102 #define         fInvisibleBit   0x4000
 103 #define         fHasBundleBit   0x2000
 104 #define         fSystemBit              0x1000
 105 #define         fNoCopyBit              0x0800
 106 #define         fBusyBit                0x0400
 107 #define         fChangedBit             0x0200
 108 #define         fInitedBit              0x0100
 109 #define         fCachedBit              0x0080
 110 #define         fSharedBit              0x0040
 111 #define         fAlwaysBit              0x0020          /* always switch-launch */
 112 #define         fNeverBit               0x0010          /* never switch-launch */
 113 #define         fOwnApplBit             0x0002
 114 #define         fOnDesktopBit   0x0001
 115
 116 #define         EXTFNDRINFOSIZE         16
 117
 118 struct finder_info {
 119         unsigned long           fdType;
 120         unsigned long           fdCreator;
 121         unsigned short          fdFlags;
 122         unsigned short          fdReserved[3];
 123 };
 124
 125 struct iso_primary_descriptor {
 126         char type                       [ISODCL (  1,   1)]; /* 711 */
 127         char volume_desc_id             [ISODCL (  2,   6)];
 128         char version                    [ISODCL (  7,   7)]; /* 711 */
 129         char flags                      [ISODCL (  8,   8)]; /* SVD only */
 130         char system_id                  [ISODCL (  9,  40)]; /* achars */
 131         char volume_id                  [ISODCL ( 41,  72)]; /* dchars */
 132         char unused2                    [ISODCL ( 73,  80)];
 133         char volume_space_size          [ISODCL ( 81,  88)]; /* 733 */
 134         char escape_seq                 [ISODCL ( 89, 120)]; /* SVD only */
 135         char volume_set_size            [ISODCL (121, 124)]; /* 723 */
 136         char volume_sequence_number     [ISODCL (125, 128)]; /* 723 */
 137         char logical_block_size         [ISODCL (129, 132)]; /* 723 */
 138         char path_table_size            [ISODCL (133, 140)]; /* 733 */
 139         char type_l_path_table          [ISODCL (141, 144)]; /* 731 */
 140         char opt_type_l_path_table      [ISODCL (145, 148)]; /* 731 */
 141         char type_m_path_table          [ISODCL (149, 152)]; /* 732 */
 142         char opt_type_m_path_table      [ISODCL (153, 156)]; /* 732 */
 143         char root_directory_record      [ISODCL (157, 190)]; /* 9.1 */
 144         char volume_set_id              [ISODCL (191, 318)]; /* dchars */
 145         char publisher_id               [ISODCL (319, 446)]; /* achars */
 146         char preparer_id                [ISODCL (447, 574)]; /* achars */
 147         char application_id             [ISODCL (575, 702)]; /* achars */
 148         char copyright_file_id          [ISODCL (703, 739)]; /* 7.5 dchars */
 149         char abstract_file_id           [ISODCL (740, 776)]; /* 7.5 dchars */
 150         char bibliographic_file_id      [ISODCL (777, 813)]; /* 7.5 dchars */
 151         char creation_date              [ISODCL (814, 830)]; /* 8.4.26.1 */
 152         char modification_date          [ISODCL (831, 847)]; /* 8.4.26.1 */
 153         char expiration_date            [ISODCL (848, 864)]; /* 8.4.26.1 */
 154         char effective_date             [ISODCL (865, 881)]; /* 8.4.26.1 */
 155         char file_structure_version     [ISODCL (882, 882)]; /* 711 */
 156         char unused4                    [ISODCL (883, 883)];
 157         char application_data1          [ISODCL (884, 1024)];
 158         char CDXASignature                      [ISODCL (1025, 1032)];
 159         char CDXAResv                           [ISODCL (1033, 1050)];
 160         char application_data2          [ISODCL (1051, 1395)];
 161 };
 162 #define ISO_DEFAULT_BLOCK_SIZE          2048
 163
 164 /* from HighSierra.h in MacOS land */
 165 typedef struct
 166 {
 167         char    signature               [ISODCL (1, 2)];        /* x42 x41 - 'BA' signature */
 168         u_char  systemUseID             [ISODCL (3, 3)];        /* 02 = no icon, 03 = icon, 04 = icon + bundle */
 169         u_char  fileType                [ISODCL (4, 7)];        /* such as 'TEXT' or 'STAK' */
 170         u_char  fileCreator             [ISODCL (8, 11)];       /* such as 'hscd' or 'WILD' */
 171         u_char  finderFlags             [ISODCL (12, 13)];      /* optional for type 06 */
 172 } AppleExtension;
 173
 174 typedef struct
 175 {
 176         char    signature               [ISODCL (1, 2)];        /* x41 x41 - 'AA' signature */
 177         u_char  OSULength               [ISODCL (3, 3)];        /* optional SystemUse length (size of this struct) */
 178         u_char  systemUseID             [ISODCL (4, 4)];        /* 1 = ProDOS 2 = HFS */
 179         u_char  fileType                [ISODCL (5, 8)];        /* such as 'TEXT' or 'STAK' */
 180         u_char  fileCreator             [ISODCL (9, 12)];       /* such as 'hscd' or 'WILD' */
 181         u_char  finderFlags             [ISODCL (13, 14)];      /* only certain bits of this are used */
 182 } NewAppleExtension;
 183
 184 struct iso_directory_record {
 185         char length                     [ISODCL (1, 1)]; /* 711 */
 186         char ext_attr_length            [ISODCL (2, 2)]; /* 711 */
 187         u_char extent                   [ISODCL (3, 10)]; /* 733 */
 188         u_char size                     [ISODCL (11, 18)]; /* 733 */
 189         char date                       [ISODCL (19, 25)]; /* 7 by 711 */
 190         char flags                      [ISODCL (26, 26)];
 191         char file_unit_size             [ISODCL (27, 27)]; /* 711 */
 192         char interleave                 [ISODCL (28, 28)]; /* 711 */
 193         char volume_sequence_number     [ISODCL (29, 32)]; /* 723 */
 194         char name_len                   [ISODCL (33, 33)]; /* 711 */
 195         char name                       [1];                    /* XXX */
 196 };
 197 /*
 198  *  cannot take sizeof(iso_directory_record), because of
 199  *      possible alignment
 200  *      of the last entry (34 instead of 33)
 201  */
 202 #define ISO_DIRECTORY_RECORD_SIZE       33
 203
 204 /*
 205  * iso_directory_record.flags for Directory Records (except CD-I discs)
 206  */
 207 #define existenceBit    0x01    /* Invisible */
 208 #define directoryBit    0x02
 209 #define associatedBit   0x04
 210 #define recordBit               0x08
 211 #define protectionBit   0x10
 212 #define multiextentBit  0x80
 213
 214 struct iso_extended_attributes {
 215         u_char owner                    [ISODCL (1, 4)]; /* 723 */
 216         u_char group                    [ISODCL (5, 8)]; /* 723 */
 217         u_char perm                     [ISODCL (9, 10)]; /* 9.5.3 */
 218         char ctime                      [ISODCL (11, 27)]; /* 8.4.26.1 */
 219         char mtime                      [ISODCL (28, 44)]; /* 8.4.26.1 */
 220         char xtime                      [ISODCL (45, 61)]; /* 8.4.26.1 */
 221         char ftime                      [ISODCL (62, 78)]; /* 8.4.26.1 */
 222         char recfmt                     [ISODCL (79, 79)]; /* 711 */
 223         char recattr                    [ISODCL (80, 80)]; /* 711 */
 224         u_char reclen                   [ISODCL (81, 84)]; /* 723 */
 225         char system_id                  [ISODCL (85, 116)]; /* achars */
 226         char system_use                 [ISODCL (117, 180)];
 227         char version                    [ISODCL (181, 181)]; /* 711 */
 228         char len_esc                    [ISODCL (182, 182)]; /* 711 */
 229         char reserved                   [ISODCL (183, 246)];
 230         u_char len_au                   [ISODCL (247, 250)]; /* 723 */
 231 };
 232
 233 /* CD-ROM Format type */
 234 enum ISO_FTYPE  { ISO_FTYPE_DEFAULT, ISO_FTYPE_9660, ISO_FTYPE_RRIP,
 235                   ISO_FTYPE_JOLIET, ISO_FTYPE_ECMA };
 236
 237 #ifndef ISOFSMNT_ROOT
 238 #define ISOFSMNT_ROOT   0
 239 #endif
 240
 241 struct iso_mnt {
 242         int im_flags;           /* mount flags */
 243         int im_flags2;          /* misc flags */
 244
 245         struct mount *im_mountp;
 246         dev_t im_dev;
 247         struct vnode *im_devvp;
 248
 249         int logical_block_size;
 250         int im_bshift;
 251         int im_bmask;
 252
 253         int volume_space_size;
 254         struct netexport im_export;
 255
 256         char root[ISODCL (157, 190)];
 257         int root_extent;
 258         int root_size;
 259         enum ISO_FTYPE  iso_ftype;
 260
 261         int rr_skip;
 262         int rr_skip0;
 263
 264         struct timespec creation_date;                          /* needed for getattrlist */
 265         struct timespec modification_date;                      /* needed for getattrlist */
 266         u_char volume_id[32];                                           /* name of volume */
 267 };
 268
 269 /* bit settings for iso_mnt.im_flags2 */
 270
 271 /*
 272  *  CD is in XA format. Need this to find where apple extensions
 273  *      are in the iso_directory_record
 274  */
 275 #define IMF2_IS_CDXA    0x00000001
 276
 277 #define VFSTOISOFS(mp)  ((struct iso_mnt *)((mp)->mnt_data))
 278
 279 #define blkoff(imp, loc)        ((loc) & (imp)->im_bmask)
 280 #define lblktosize(imp, blk)    ((blk) << (imp)->im_bshift)
 281 #define lblkno(imp, loc)        ((loc) >> (imp)->im_bshift)
 282 #define blksize(imp, ip, lbn)   ((imp)->logical_block_size)
 283
 284 int cd9660_mount __P((struct mount *,
 285             char *, caddr_t, struct nameidata *, struct proc *));
 286 int cd9660_start __P((struct mount *, int, struct proc *));
 287 int cd9660_unmount __P((struct mount *, int, struct proc *));
 288 int cd9660_root __P((struct mount *, struct vnode **));
 289 int cd9660_quotactl __P((struct mount *, int, uid_t, caddr_t, struct proc *));
 290 int cd9660_statfs __P((struct mount *, struct statfs *, struct proc *));
 291 int cd9660_sync __P((struct mount *, int, struct ucred *, struct proc *));
 292 int cd9660_vget __P((struct mount *, void *, struct vnode **));
 293 int cd9660_fhtovp __P((struct mount *, struct fid *, struct mbuf *,
 294             struct vnode **, int *, struct ucred **));
 295 int cd9660_vptofh __P((struct vnode *, struct fid *));
 296 int cd9660_init __P(());
 297
 298 int cd9660_mountroot __P((void));
 299
 300 int cd9660_sysctl __P((int *, u_int, void *, size_t *, void *, size_t, struct proc *));
 301
 302 extern int (**cd9660_vnodeop_p)(void *);
 303 extern int (**cd9660_specop_p)(void *);
 304 #if FIFO
 305 extern int (**cd9660_fifoop_p)(void *);
 306 #endif
 307
 308 static __inline int
 309 isonum_711(p)
 310         u_char *p;
 311 {
 312         return *p;
 313 }
 314
 315 static __inline int
 316 isonum_712(p)
 317         char *p;
 318 {
 319         return *p;
 320 }
 321
 322 #ifndef UNALIGNED_ACCESS
 323
 324 static __inline int
 325 isonum_723(p)
 326         u_char *p;
 327 {
 328         return *p|(p[1] << 8);
 329 }
 330
 331 static __inline int
 332 isonum_733(p)
 333         u_char *p;
 334 {
 335         return *p|(p[1] << 8)|(p[2] << 16)|(p[3] << 24);
 336 }
 337
 338 #else /* UNALIGNED_ACCESS */
 339
 340 #if BYTE_ORDER == LITTLE_ENDIAN
 341
 342 static __inline int
 343 isonum_723(p)
 344         u_char *p
 345 {
 346         return *(u_int16t *)p;
 347 }
 348
 349 static __inline int
 350 isonum_733(p)
 351         u_char *p;
 352 {
 353         return *(u_int32t *)p;
 354 }
 355
 356 #endif
 357
 358 #if BYTE_ORDER == BIG_ENDIAN
 359
 360 static __inline int
 361 isonum_723(p)
 362         u_char *p
 363 {
 364         return *(u_int16t *)(p + 2);
 365 }
 366
 367 static __inline int
 368 isonum_733(p)
 369         u_char *p;
 370 {
 371         return *(u_int32t *)(p + 4);
 372 }
 373
 374 #endif
 375
 376 #endif /* UNALIGNED_ACCESS */
 377
 378 int isofncmp __P((u_char *, int, u_char *, int));
 379 int ucsfncmp __P((u_int16_t *, int, u_int16_t *, int));
 380 void isofntrans __P((u_char *, int, u_char *, u_short *, int));
 381 void ucsfntrans __P((u_int16_t *, int, u_char *, u_short *, int));
 382 ino_t isodirino __P((struct iso_directory_record *, struct iso_mnt *));
 383 int attrcalcsize __P((struct attrlist *attrlist));
 384 void packattrblk __P((struct attrlist *alist, struct vnode *vp,
 385                                           void **attrbufptrptr, void **varbufptrptr));
 386
 387
 388 /*
 389  * Associated files have a leading '='.
 390  */
 391 #define ASSOCCHAR       '='
 392
 393 #endif /* ! _ISO_H_ */