]> git.saurik.com Git - apple/xnu.git/blob - bsd/isofs/cd9660/iso.h
projects / apple / xnu.git / blob
? search:


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