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  * 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 #include <sys/appleapiopts.h>
  67
  68 #ifdef __APPLE_API_PRIVATE
  69 #define ISODCL(from, to) (to - from + 1)
  70
  71 struct iso_volume_descriptor {
  72         char type            [ISODCL(1,1)]; /* 711 */
  73         char volume_desc_id  [ISODCL(2,6)];
  74         char version         [ISODCL(7,7)];
  75         char data            [ISODCL(8,2048)];
  76 };
  77
  78 /* volume descriptor types */
  79 #define ISO_VD_BOOT            0
  80 #define ISO_VD_PRIMARY         1
  81 #define ISO_VD_SUPPLEMENTARY   2
  82 #define ISO_VD_PARTITION       3
  83 #define ISO_VD_END           255
  84
  85 #define ISO_STANDARD_ID "CD001"
  86 #define ISO_ECMA_ID     "CDW01"
  87 #define ISO_XA_ID               "CD-XA001"      /* XA style disk signature */
  88 #define ISO9660SIGNATURE 0x4147         /* for getattrlist ATTR_VOL_SIGNATURE */
  89
  90 /* Universal Character Set implementation levels (for Joliet) */
  91 #define ISO_UCS2_Level_1        "%/@"   /* No combining chars */
  92 #define ISO_UCS2_Level_2        "%/C"   /* Combining chars allowed with restrictions */
  93 #define ISO_UCS2_Level_3        "%/E"   /* Combining chars allowed, no restrictions */
  94
  95 #define UCS_SEPARATOR1  0x002e
  96 #define UCS_SEPARATOR2  0x003b
  97
  98 #define ISO_DFLT_VOLUME_ID "ISO_9660_CD"
  99
 100 /* pathconf filename lengths */
 101 #define ISO_NAMEMAX             (31+1)
 102 #define ISO_JOLIET_NAMEMAX      (64*3)
 103 #define ISO_RRIP_NAMEMAX        255
 104
 105 /* Finder flags, from Technical Note 40 */
 106 #define         fLockedBit              0x8000
 107 #define         fInvisibleBit   0x4000
 108 #define         fHasBundleBit   0x2000
 109 #define         fSystemBit              0x1000
 110 #define         fNoCopyBit              0x0800
 111 #define         fBusyBit                0x0400
 112 #define         fChangedBit             0x0200
 113 #define         fInitedBit              0x0100
 114 #define         fCachedBit              0x0080
 115 #define         fSharedBit              0x0040
 116 #define         fAlwaysBit              0x0020          /* always switch-launch */
 117 #define         fNeverBit               0x0010          /* never switch-launch */
 118 #define         fOwnApplBit             0x0002
 119 #define         fOnDesktopBit   0x0001
 120
 121 #define         EXTFNDRINFOSIZE         16
 122
 123 struct finder_info {
 124         unsigned long           fdType;
 125         unsigned long           fdCreator;
 126         unsigned short          fdFlags;
 127         struct {
 128             short       v;              /* file's location */
 129             short       h;
 130         } fdLocation;
 131         unsigned short          fdReserved;
 132 };
 133
 134 struct iso_primary_descriptor {
 135         char type                       [ISODCL (  1,   1)]; /* 711 */
 136         char volume_desc_id             [ISODCL (  2,   6)];
 137         char version                    [ISODCL (  7,   7)]; /* 711 */
 138         char flags                      [ISODCL (  8,   8)]; /* SVD only */
 139         char system_id                  [ISODCL (  9,  40)]; /* achars */
 140         char volume_id                  [ISODCL ( 41,  72)]; /* dchars */
 141         char unused2                    [ISODCL ( 73,  80)];
 142         char volume_space_size          [ISODCL ( 81,  88)]; /* 733 */
 143         char escape_seq                 [ISODCL ( 89, 120)]; /* SVD only */
 144         char volume_set_size            [ISODCL (121, 124)]; /* 723 */
 145         char volume_sequence_number     [ISODCL (125, 128)]; /* 723 */
 146         char logical_block_size         [ISODCL (129, 132)]; /* 723 */
 147         char path_table_size            [ISODCL (133, 140)]; /* 733 */
 148         char type_l_path_table          [ISODCL (141, 144)]; /* 731 */
 149         char opt_type_l_path_table      [ISODCL (145, 148)]; /* 731 */
 150         char type_m_path_table          [ISODCL (149, 152)]; /* 732 */
 151         char opt_type_m_path_table      [ISODCL (153, 156)]; /* 732 */
 152         char root_directory_record      [ISODCL (157, 190)]; /* 9.1 */
 153         char volume_set_id              [ISODCL (191, 318)]; /* dchars */
 154         char publisher_id               [ISODCL (319, 446)]; /* achars */
 155         char preparer_id                [ISODCL (447, 574)]; /* achars */
 156         char application_id             [ISODCL (575, 702)]; /* achars */
 157         char copyright_file_id          [ISODCL (703, 739)]; /* 7.5 dchars */
 158         char abstract_file_id           [ISODCL (740, 776)]; /* 7.5 dchars */
 159         char bibliographic_file_id      [ISODCL (777, 813)]; /* 7.5 dchars */
 160         char creation_date              [ISODCL (814, 830)]; /* 8.4.26.1 */
 161         char modification_date          [ISODCL (831, 847)]; /* 8.4.26.1 */
 162         char expiration_date            [ISODCL (848, 864)]; /* 8.4.26.1 */
 163         char effective_date             [ISODCL (865, 881)]; /* 8.4.26.1 */
 164         char file_structure_version     [ISODCL (882, 882)]; /* 711 */
 165         char unused4                    [ISODCL (883, 883)];
 166         char application_data1          [ISODCL (884, 1024)];
 167         char CDXASignature                      [ISODCL (1025, 1032)];
 168         char CDXAResv                           [ISODCL (1033, 1050)];
 169         char application_data2          [ISODCL (1051, 1395)];
 170 };
 171 #define ISO_DEFAULT_BLOCK_SIZE          2048
 172
 173 /* from HighSierra.h in MacOS land */
 174 typedef struct
 175 {
 176         char    signature               [ISODCL (1, 2)];        /* x42 x41 - 'BA' signature */
 177         u_char  systemUseID             [ISODCL (3, 3)];        /* 02 = no icon, 03 = icon, 04 = icon + bundle */
 178         u_char  fileType                [ISODCL (4, 7)];        /* such as 'TEXT' or 'STAK' */
 179         u_char  fileCreator             [ISODCL (8, 11)];       /* such as 'hscd' or 'WILD' */
 180         u_char  finderFlags             [ISODCL (12, 13)];      /* optional for type 06 */
 181 } AppleExtension;
 182
 183 typedef struct
 184 {
 185         char    signature               [ISODCL (1, 2)];        /* x41 x41 - 'AA' signature */
 186         u_char  OSULength               [ISODCL (3, 3)];        /* optional SystemUse length (size of this struct) */
 187         u_char  systemUseID             [ISODCL (4, 4)];        /* 1 = ProDOS 2 = HFS */
 188         u_char  fileType                [ISODCL (5, 8)];        /* such as 'TEXT' or 'STAK' */
 189         u_char  fileCreator             [ISODCL (9, 12)];       /* such as 'hscd' or 'WILD' */
 190         u_char  finderFlags             [ISODCL (13, 14)];      /* only certain bits of this are used */
 191 } NewAppleExtension;
 192
 193 struct iso_directory_record {
 194         char length                     [ISODCL (1, 1)]; /* 711 */
 195         char ext_attr_length            [ISODCL (2, 2)]; /* 711 */
 196         u_char extent                   [ISODCL (3, 10)]; /* 733 */
 197         u_char size                     [ISODCL (11, 18)]; /* 733 */
 198         char date                       [ISODCL (19, 25)]; /* 7 by 711 */
 199         char flags                      [ISODCL (26, 26)];
 200         char file_unit_size             [ISODCL (27, 27)]; /* 711 */
 201         char interleave                 [ISODCL (28, 28)]; /* 711 */
 202         char volume_sequence_number     [ISODCL (29, 32)]; /* 723 */
 203         char name_len                   [ISODCL (33, 33)]; /* 711 */
 204         char name                       [1];                    /* XXX */
 205 };
 206 /*
 207  *  cannot take sizeof(iso_directory_record), because of
 208  *      possible alignment
 209  *      of the last entry (34 instead of 33)
 210  */
 211 #define ISO_DIRECTORY_RECORD_SIZE       33
 212
 213 /*
 214  * iso_directory_record.flags for Directory Records (except CD-I discs)
 215  */
 216 #define existenceBit    0x01    /* Invisible */
 217 #define directoryBit    0x02
 218 #define associatedBit   0x04
 219 #define recordBit               0x08
 220 #define protectionBit   0x10
 221 #define multiextentBit  0x80
 222
 223 struct iso_extended_attributes {
 224         u_char owner                    [ISODCL (1, 4)]; /* 723 */
 225         u_char group                    [ISODCL (5, 8)]; /* 723 */
 226         u_char perm                     [ISODCL (9, 10)]; /* 9.5.3 */
 227         char ctime                      [ISODCL (11, 27)]; /* 8.4.26.1 */
 228         char mtime                      [ISODCL (28, 44)]; /* 8.4.26.1 */
 229         char xtime                      [ISODCL (45, 61)]; /* 8.4.26.1 */
 230         char ftime                      [ISODCL (62, 78)]; /* 8.4.26.1 */
 231         char recfmt                     [ISODCL (79, 79)]; /* 711 */
 232         char recattr                    [ISODCL (80, 80)]; /* 711 */
 233         u_char reclen                   [ISODCL (81, 84)]; /* 723 */
 234         char system_id                  [ISODCL (85, 116)]; /* achars */
 235         char system_use                 [ISODCL (117, 180)];
 236         char version                    [ISODCL (181, 181)]; /* 711 */
 237         char len_esc                    [ISODCL (182, 182)]; /* 711 */
 238         char reserved                   [ISODCL (183, 246)];
 239         u_char len_au                   [ISODCL (247, 250)]; /* 723 */
 240 };
 241
 242 /* CD-ROM Format type */
 243 enum ISO_FTYPE  { ISO_FTYPE_DEFAULT, ISO_FTYPE_9660, ISO_FTYPE_RRIP,
 244                   ISO_FTYPE_JOLIET, ISO_FTYPE_ECMA };
 245
 246 #ifndef ISOFSMNT_ROOT
 247 #define ISOFSMNT_ROOT   0
 248 #endif
 249
 250 struct iso_mnt {
 251         int im_flags;           /* mount flags */
 252         int im_flags2;          /* misc flags */
 253
 254         struct mount *im_mountp;
 255         dev_t im_dev;
 256         struct vnode *im_devvp;
 257
 258         int logical_block_size;
 259         int im_bshift;
 260         int im_bmask;
 261         int im_sector_size;
 262
 263         int volume_space_size;
 264         struct netexport im_export;
 265
 266         char root[ISODCL (157, 190)];
 267         int root_extent;
 268         int root_size;
 269         enum ISO_FTYPE  iso_ftype;
 270
 271         int rr_skip;
 272         int rr_skip0;
 273
 274         struct timespec creation_date;                          /* needed for getattrlist */
 275         struct timespec modification_date;                      /* needed for getattrlist */
 276         u_char volume_id[32];                                           /* name of volume */
 277         struct vnode *phys_devvp;                                       /* device for 2352-byte blocks */
 278         struct CDTOC *toc;                                                      /* the TOC, or NULL for none */
 279         int video_dir_start;                                            /* start sector of the "MPEGAV" dir */
 280         int video_dir_end;                                                      /* sector following end of "MPEGAV" dir */
 281 };
 282
 283 /* bit settings for iso_mnt.im_flags2 */
 284
 285 /*
 286  *  CD is in XA format. Need this to find where apple extensions
 287  *      are in the iso_directory_record
 288  */
 289 #define IMF2_IS_CDXA    0x00000001
 290
 291 /* CD is Video CD (version < 2.0) */
 292 #define IMF2_IS_VCD             0x00000002
 293
 294 #define VFSTOISOFS(mp)  ((struct iso_mnt *)((mp)->mnt_data))
 295
 296 #define blkoff(imp, loc)        ((loc) & (imp)->im_bmask)
 297 #define lblktosize(imp, blk)    ((blk) << (imp)->im_bshift)
 298 #define lblkno(imp, loc)        ((loc) >> (imp)->im_bshift)
 299 #define blksize(imp, ip, lbn)   ((imp)->logical_block_size)
 300
 301 #define SECTOFF(imp, off)       \
 302         (off_t)(((off) / (imp)->im_sector_size) * (imp)->im_sector_size)
 303
 304
 305 int cd9660_mount __P((struct mount *,
 306             char *, caddr_t, struct nameidata *, struct proc *));
 307 int cd9660_start __P((struct mount *, int, struct proc *));
 308 int cd9660_unmount __P((struct mount *, int, struct proc *));
 309 int cd9660_root __P((struct mount *, struct vnode **));
 310 int cd9660_quotactl __P((struct mount *, int, uid_t, caddr_t, struct proc *));
 311 int cd9660_statfs __P((struct mount *, struct statfs *, struct proc *));
 312 int cd9660_sync __P((struct mount *, int, struct ucred *, struct proc *));
 313 int cd9660_vget __P((struct mount *, void *, struct vnode **));
 314 int cd9660_fhtovp __P((struct mount *, struct fid *, struct mbuf *,
 315             struct vnode **, int *, struct ucred **));
 316 int cd9660_vptofh __P((struct vnode *, struct fid *));
 317 int cd9660_init __P(());
 318
 319 int cd9660_mountroot __P((void));
 320
 321 int cd9660_sysctl __P((int *, u_int, void *, size_t *, void *, size_t, struct proc *));
 322
 323 extern int (**cd9660_vnodeop_p)(void *);
 324 extern int (**cd9660_specop_p)(void *);
 325 #if FIFO
 326 extern int (**cd9660_fifoop_p)(void *);
 327 #endif
 328 extern int (**cd9660_cdxaop_p)(void *);
 329
 330 static __inline int
 331 isonum_711(p)
 332         u_char *p;
 333 {
 334         return *p;
 335 }
 336
 337 static __inline int
 338 isonum_712(p)
 339         char *p;
 340 {
 341         return *p;
 342 }
 343
 344 #ifndef UNALIGNED_ACCESS
 345
 346 static __inline int
 347 isonum_723(p)
 348         u_char *p;
 349 {
 350         return *p|(p[1] << 8);
 351 }
 352
 353 static __inline int
 354 isonum_733(p)
 355         u_char *p;
 356 {
 357         return *p|(p[1] << 8)|(p[2] << 16)|(p[3] << 24);
 358 }
 359
 360 #else /* UNALIGNED_ACCESS */
 361
 362 #if BYTE_ORDER == LITTLE_ENDIAN
 363
 364 static __inline int
 365 isonum_723(p)
 366         u_char *p
 367 {
 368         return *(u_int16t *)p;
 369 }
 370
 371 static __inline int
 372 isonum_733(p)
 373         u_char *p;
 374 {
 375         return *(u_int32t *)p;
 376 }
 377
 378 #endif
 379
 380 #if BYTE_ORDER == BIG_ENDIAN
 381
 382 static __inline int
 383 isonum_723(p)
 384         u_char *p
 385 {
 386         return *(u_int16t *)(p + 2);
 387 }
 388
 389 static __inline int
 390 isonum_733(p)
 391         u_char *p;
 392 {
 393         return *(u_int32t *)(p + 4);
 394 }
 395
 396 #endif
 397
 398 #endif /* UNALIGNED_ACCESS */
 399
 400 int isofncmp __P((u_char *, int, u_char *, int));
 401 int ucsfncmp __P((u_int16_t *, int, u_int16_t *, int));
 402 void isofntrans __P((u_char *, int, u_char *, u_short *, int, int));
 403 void ucsfntrans __P((u_int16_t *, int, u_char *, u_short *, int, int));
 404 ino_t isodirino __P((struct iso_directory_record *, struct iso_mnt *));
 405 int attrcalcsize __P((struct attrlist *attrlist));
 406 void packattrblk __P((struct attrlist *alist, struct vnode *vp,
 407                                           void **attrbufptrptr, void **varbufptrptr));
 408
 409
 410 /*
 411  * Associated files have a leading "._".
 412  */
 413 #define ASSOCCHAR1      '.'
 414 #define ASSOCCHAR2      '_'
 415
 416 /*
 417  * This header is prepended on media tracks, such as Video CD MPEG files.
 418  */
 419 struct riff_header {
 420         char riff[4];                   // "RIFF"
 421         u_int32_t fileSize;             // little endian file size, not including this field or sig
 422         char cdxa[4];                   // "CDXA"
 423         char fmt[4];                    // "fmt "
 424         u_int32_t fmtSize;              // always 16 (XXX this is an assumption)
 425         char fmtData[16];               // CDXA extension of ISO directory entry, padded to 16 bytes
 426         char data[4];                   // "data"
 427         u_int32_t dataSize;             // number of sectors * 2352, little endian
 428 };
 429
 430 #define CDXA_SECTOR_SIZE        2352
 431
 432
 433 /*
 434  * AppleDouble constants
 435  */
 436 #define APPLEDOUBLE_MAGIC    0x00051607
 437 #define APPLEDOUBLE_VERSION  0x00020000
 438
 439 #define APPLEDOUBLE_DATAFORK     1
 440 #define APPLEDOUBLE_RESFORK      2
 441 #define APPLEDOUBLE_FINDERINFO   9
 442
 443 /*
 444  * Note that  68k alignment is needed to make sure that the first
 445  * AppleDoubleEntry (after the numEntries below) is *immediately*
 446  * after the numEntries, and not padded by 2 bytes.
 447  *
 448  * Consult RFC 1740 for details on AppleSingle/AppleDouble formats.
 449  */
 450 #pragma options align=mac68k
 451
 452 struct apple_double_entry {
 453         u_int32_t  entryID;
 454         u_int32_t  offset;
 455         u_int32_t  length;
 456 };
 457 typedef struct apple_double_entry apple_double_entry_t;
 458
 459 struct apple_double_header {
 460         u_int32_t  magic;
 461         u_int32_t  version;
 462         u_int8_t  filler[16];
 463         u_int16_t  count;
 464         apple_double_entry_t  entries[2];       /* FinderInfo + ResourceFork */
 465         struct finder_info finfo;
 466 };
 467 typedef struct apple_double_header apple_double_header_t;
 468
 469 #define ADH_SIZE  4096
 470 #define ADH_BLKS  2
 471
 472 #pragma options align=reset
 473
 474 #endif /* __APPLE_API_PRIVATE */
 475 #endif /* ! _ISO_H_ */