bsd/isofs/cd9660/iso.h

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