bsd/isofs/cd9660/iso.h

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