xref: /freebsd/sys/fs/cd9660/iso.h (revision 6e8394b8baa7d5d9153ab90de6824bcd19b3b4e1)
1 /*-
2  * Copyright (c) 1994
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley
6  * by Pace Willisson (pace@blitz.com).  The Rock Ridge Extension
7  * Support code is derived from software contributed to Berkeley
8  * by Atsushi Murai (amurai@spec.co.jp).
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *	This product includes software developed by the University of
21  *	California, Berkeley and its contributors.
22  * 4. Neither the name of the University nor the names of its contributors
23  *    may be used to endorse or promote products derived from this software
24  *    without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36  * SUCH DAMAGE.
37  *
38  *	@(#)iso.h	8.6 (Berkeley) 5/10/95
39  * $Id: iso.h,v 1.16 1997/05/07 13:23:04 joerg Exp $
40  */
41 
42 #define ISODCL(from, to) (to - from + 1)
43 
44 struct iso_volume_descriptor {
45 	char type[ISODCL(1,1)]; /* 711 */
46 	char id[ISODCL(2,6)];
47 	char version[ISODCL(7,7)];
48 	char unused[ISODCL(8,8)];
49 	char type_sierra[ISODCL(9,9)]; /* 711 */
50 	char id_sierra[ISODCL(10,14)];
51 	char version_sierra[ISODCL(15,15)];
52 	char data[ISODCL(16,2048)];
53 };
54 
55 /* volume descriptor types */
56 #define ISO_VD_PRIMARY 1
57 #define ISO_VD_SUPPLEMENTARY 2
58 #define ISO_VD_END 255
59 
60 #define ISO_STANDARD_ID "CD001"
61 #define ISO_ECMA_ID	"CDW01"
62 
63 #define ISO_SIERRA_ID	"CDROM"
64 
65 struct iso_primary_descriptor {
66 	char type			[ISODCL (  1,	1)]; /* 711 */
67 	char id				[ISODCL (  2,	6)];
68 	char version			[ISODCL (  7,	7)]; /* 711 */
69 	char unused1			[ISODCL (  8,	8)];
70 	char system_id			[ISODCL (  9,  40)]; /* achars */
71 	char volume_id			[ISODCL ( 41,  72)]; /* dchars */
72 	char unused2			[ISODCL ( 73,  80)];
73 	char volume_space_size		[ISODCL ( 81,  88)]; /* 733 */
74 	char unused3			[ISODCL ( 89, 120)];
75 	char volume_set_size		[ISODCL (121, 124)]; /* 723 */
76 	char volume_sequence_number	[ISODCL (125, 128)]; /* 723 */
77 	char logical_block_size		[ISODCL (129, 132)]; /* 723 */
78 	char path_table_size		[ISODCL (133, 140)]; /* 733 */
79 	char type_l_path_table		[ISODCL (141, 144)]; /* 731 */
80 	char opt_type_l_path_table	[ISODCL (145, 148)]; /* 731 */
81 	char type_m_path_table		[ISODCL (149, 152)]; /* 732 */
82 	char opt_type_m_path_table	[ISODCL (153, 156)]; /* 732 */
83 	char root_directory_record	[ISODCL (157, 190)]; /* 9.1 */
84 	char volume_set_id		[ISODCL (191, 318)]; /* dchars */
85 	char publisher_id		[ISODCL (319, 446)]; /* achars */
86 	char preparer_id		[ISODCL (447, 574)]; /* achars */
87 	char application_id		[ISODCL (575, 702)]; /* achars */
88 	char copyright_file_id		[ISODCL (703, 739)]; /* 7.5 dchars */
89 	char abstract_file_id		[ISODCL (740, 776)]; /* 7.5 dchars */
90 	char bibliographic_file_id	[ISODCL (777, 813)]; /* 7.5 dchars */
91 	char creation_date		[ISODCL (814, 830)]; /* 8.4.26.1 */
92 	char modification_date		[ISODCL (831, 847)]; /* 8.4.26.1 */
93 	char expiration_date		[ISODCL (848, 864)]; /* 8.4.26.1 */
94 	char effective_date		[ISODCL (865, 881)]; /* 8.4.26.1 */
95 	char file_structure_version	[ISODCL (882, 882)]; /* 711 */
96 	char unused4			[ISODCL (883, 883)];
97 	char application_data		[ISODCL (884, 1395)];
98 	char unused5			[ISODCL (1396, 2048)];
99 };
100 #define ISO_DEFAULT_BLOCK_SIZE		2048
101 
102 /*
103  * Used by Microsoft Joliet extension to ISO9660. Almost the same
104  * as PVD, but byte position 8 is a flag, and 89-120 is for escape.
105  */
106 
107 struct iso_supplementary_descriptor {
108       char type                       [ISODCL (  1,   1)]; /* 711 */
109       char id                         [ISODCL (  2,   6)];
110       char version                    [ISODCL (  7,   7)]; /* 711 */
111       char flags                      [ISODCL (  8,   8)]; /* 711? */
112       char system_id                  [ISODCL (  9,  40)]; /* achars */
113       char volume_id                  [ISODCL ( 41,  72)]; /* dchars */
114       char unused2                    [ISODCL ( 73,  80)];
115       char volume_space_size          [ISODCL ( 81,  88)]; /* 733 */
116       char escape                     [ISODCL ( 89, 120)];
117       char volume_set_size            [ISODCL (121, 124)]; /* 723 */
118       char volume_sequence_number     [ISODCL (125, 128)]; /* 723 */
119       char logical_block_size         [ISODCL (129, 132)]; /* 723 */
120       char path_table_size            [ISODCL (133, 140)]; /* 733 */
121       char type_l_path_table          [ISODCL (141, 144)]; /* 731 */
122       char opt_type_l_path_table      [ISODCL (145, 148)]; /* 731 */
123       char type_m_path_table          [ISODCL (149, 152)]; /* 732 */
124       char opt_type_m_path_table      [ISODCL (153, 156)]; /* 732 */
125       char root_directory_record      [ISODCL (157, 190)]; /* 9.1 */
126       char volume_set_id              [ISODCL (191, 318)]; /* dchars */
127       char publisher_id               [ISODCL (319, 446)]; /* achars */
128       char preparer_id                [ISODCL (447, 574)]; /* achars */
129       char application_id             [ISODCL (575, 702)]; /* achars */
130       char copyright_file_id          [ISODCL (703, 739)]; /* 7.5 dchars */
131       char abstract_file_id           [ISODCL (740, 776)]; /* 7.5 dchars */
132       char bibliographic_file_id      [ISODCL (777, 813)]; /* 7.5 dchars */
133       char creation_date              [ISODCL (814, 830)]; /* 8.4.26.1 */
134       char modification_date          [ISODCL (831, 847)]; /* 8.4.26.1 */
135       char expiration_date            [ISODCL (848, 864)]; /* 8.4.26.1 */
136       char effective_date             [ISODCL (865, 881)]; /* 8.4.26.1 */
137       char file_structure_version     [ISODCL (882, 882)]; /* 711 */
138       char unused4                    [ISODCL (883, 883)];
139       char application_data           [ISODCL (884, 1395)];
140       char unused5                    [ISODCL (1396, 2048)];
141 };
142 
143 struct iso_sierra_primary_descriptor {
144 	char unknown1			[ISODCL (  1,	8)]; /* 733 */
145 	char type			[ISODCL (  9,	9)]; /* 711 */
146 	char id				[ISODCL ( 10,  14)];
147 	char version			[ISODCL ( 15,  15)]; /* 711 */
148 	char unused1			[ISODCL ( 16,  16)];
149 	char system_id			[ISODCL ( 17,  48)]; /* achars */
150 	char volume_id			[ISODCL ( 49,  80)]; /* dchars */
151 	char unused2			[ISODCL ( 81,  88)];
152 	char volume_space_size		[ISODCL ( 89,  96)]; /* 733 */
153 	char unused3			[ISODCL ( 97, 128)];
154 	char volume_set_size		[ISODCL (129, 132)]; /* 723 */
155 	char volume_sequence_number	[ISODCL (133, 136)]; /* 723 */
156 	char logical_block_size		[ISODCL (137, 140)]; /* 723 */
157 	char path_table_size		[ISODCL (141, 148)]; /* 733 */
158 	char type_l_path_table		[ISODCL (149, 152)]; /* 731 */
159 	char opt_type_l_path_table	[ISODCL (153, 156)]; /* 731 */
160 	char unknown2			[ISODCL (157, 160)]; /* 731 */
161 	char unknown3			[ISODCL (161, 164)]; /* 731 */
162 	char type_m_path_table		[ISODCL (165, 168)]; /* 732 */
163 	char opt_type_m_path_table	[ISODCL (169, 172)]; /* 732 */
164 	char unknown4			[ISODCL (173, 176)]; /* 732 */
165 	char unknown5			[ISODCL (177, 180)]; /* 732 */
166 	char root_directory_record	[ISODCL (181, 214)]; /* 9.1 */
167 	char volume_set_id		[ISODCL (215, 342)]; /* dchars */
168 	char publisher_id		[ISODCL (343, 470)]; /* achars */
169 	char preparer_id		[ISODCL (471, 598)]; /* achars */
170 	char application_id		[ISODCL (599, 726)]; /* achars */
171 	char copyright_id		[ISODCL (727, 790)]; /* achars */
172 	char creation_date		[ISODCL (791, 806)]; /* ? */
173 	char modification_date		[ISODCL (807, 822)]; /* ? */
174 	char expiration_date		[ISODCL (823, 838)]; /* ? */
175 	char effective_date		[ISODCL (839, 854)]; /* ? */
176 	char file_structure_version	[ISODCL (855, 855)]; /* 711 */
177 	char unused4			[ISODCL (856, 2048)];
178 };
179 
180 struct iso_directory_record {
181 	char length			[ISODCL (1, 1)]; /* 711 */
182 	char ext_attr_length		[ISODCL (2, 2)]; /* 711 */
183 	u_char extent			[ISODCL (3, 10)]; /* 733 */
184 	u_char size			[ISODCL (11, 18)]; /* 733 */
185 	char date			[ISODCL (19, 25)]; /* 7 by 711 */
186 	char flags			[ISODCL (26, 26)];
187 	char file_unit_size		[ISODCL (27, 27)]; /* 711 */
188 	char interleave			[ISODCL (28, 28)]; /* 711 */
189 	char volume_sequence_number	[ISODCL (29, 32)]; /* 723 */
190 	char name_len			[ISODCL (33, 33)]; /* 711 */
191 	char name			[1];			/* XXX */
192 };
193 /* can't take sizeof(iso_directory_record), because of possible alignment
194    of the last entry (34 instead of 33) */
195 #define ISO_DIRECTORY_RECORD_SIZE	33
196 
197 struct iso_extended_attributes {
198 	u_char owner			[ISODCL (1, 4)]; /* 723 */
199 	u_char group			[ISODCL (5, 8)]; /* 723 */
200 	u_char perm			[ISODCL (9, 10)]; /* 9.5.3 */
201 	char ctime			[ISODCL (11, 27)]; /* 8.4.26.1 */
202 	char mtime			[ISODCL (28, 44)]; /* 8.4.26.1 */
203 	char xtime			[ISODCL (45, 61)]; /* 8.4.26.1 */
204 	char ftime			[ISODCL (62, 78)]; /* 8.4.26.1 */
205 	char recfmt			[ISODCL (79, 79)]; /* 711 */
206 	char recattr			[ISODCL (80, 80)]; /* 711 */
207 	u_char reclen			[ISODCL (81, 84)]; /* 723 */
208 	char system_id			[ISODCL (85, 116)]; /* achars */
209 	char system_use			[ISODCL (117, 180)];
210 	char version			[ISODCL (181, 181)]; /* 711 */
211 	char len_esc			[ISODCL (182, 182)]; /* 711 */
212 	char reserved			[ISODCL (183, 246)];
213 	u_char len_au			[ISODCL (247, 250)]; /* 723 */
214 };
215 
216 #ifdef KERNEL
217 
218 /* CD-ROM Format type */
219 enum ISO_FTYPE	{ ISO_FTYPE_DEFAULT, ISO_FTYPE_9660, ISO_FTYPE_RRIP,
220 		  ISO_FTYPE_JOLIET, ISO_FTYPE_ECMA, ISO_FTYPE_HIGH_SIERRA };
221 
222 #ifndef	ISOFSMNT_ROOT
223 #define	ISOFSMNT_ROOT	0
224 #endif
225 
226 struct iso_mnt {
227 	int im_flags;
228 
229 	struct mount *im_mountp;
230 	dev_t im_dev;
231 	struct vnode *im_devvp;
232 
233 	int logical_block_size;
234 	int im_bshift;
235 	int im_bmask;
236 
237 	int volume_space_size;
238 	struct netexport im_export;
239 
240 	char root[ISODCL (157, 190)];
241 	int root_extent;
242 	int root_size;
243 	enum ISO_FTYPE	iso_ftype;
244 
245 	int rr_skip;
246 	int rr_skip0;
247 
248 	int joliet_level;
249 };
250 
251 #define VFSTOISOFS(mp)	((struct iso_mnt *)((mp)->mnt_data))
252 
253 #define blkoff(imp, loc)	((loc) & (imp)->im_bmask)
254 #define lblktosize(imp, blk)	((blk) << (imp)->im_bshift)
255 #define lblkno(imp, loc)	((loc) >> (imp)->im_bshift)
256 #define blksize(imp, ip, lbn)	((imp)->logical_block_size)
257 
258 int cd9660_vget_internal __P((struct mount *, ino_t, struct vnode **, int,
259 			      struct iso_directory_record *));
260 int cd9660_init __P((struct vfsconf *));
261 #define cd9660_sysctl ((int (*) __P((int *, u_int, void *, size_t *, void *, \
262                                     size_t, struct proc *)))eopnotsupp)
263 
264 extern vop_t **cd9660_vnodeop_p;
265 extern vop_t **cd9660_specop_p;
266 extern vop_t **cd9660_fifoop_p;
267 
268 int isochar __P((u_char *, u_char *, int, u_char *));
269 int isofncmp __P((u_char *, int, u_char *, int, int));
270 void isofntrans __P((u_char *, int, u_char *, u_short *, int, int, int));
271 ino_t isodirino __P((struct iso_directory_record *, struct iso_mnt *));
272 
273 #endif /* KERNEL */
274 
275 /*
276  * The isonum_xxx functions are inlined anyway, and could come handy even
277  * outside the kernel.  Thus we don't hide them here.
278  */
279 
280 static __inline int isonum_711 __P((u_char *));
281 static __inline int
282 isonum_711(p)
283 	u_char *p;
284 {
285 	return *p;
286 }
287 
288 static __inline int isonum_712 __P((char *));
289 static __inline int
290 isonum_712(p)
291 	char *p;
292 {
293 	return *p;
294 }
295 
296 #ifndef UNALIGNED_ACCESS
297 
298 static __inline int isonum_723 __P((u_char *));
299 static __inline int
300 isonum_723(p)
301 	u_char *p;
302 {
303 	return *p|(p[1] << 8);
304 }
305 
306 static __inline int isonum_733 __P((u_char *));
307 static __inline int
308 isonum_733(p)
309 	u_char *p;
310 {
311 	return *p|(p[1] << 8)|(p[2] << 16)|(p[3] << 24);
312 }
313 
314 #else /* UNALIGNED_ACCESS */
315 
316 #if BYTE_ORDER == LITTLE_ENDIAN
317 
318 static __inline int
319 isonum_723(p)
320 	u_char *p
321 {
322 	return *(u_int16t *)p;
323 }
324 
325 static __inline int
326 isonum_733(p)
327 	u_char *p;
328 {
329 	return *(u_int32t *)p;
330 }
331 
332 #endif
333 
334 #if BYTE_ORDER == BIG_ENDIAN
335 
336 static __inline int
337 isonum_723(p)
338 	u_char *p
339 {
340 	return *(u_int16t *)(p + 2);
341 }
342 
343 static __inline int
344 isonum_733(p)
345 	u_char *p;
346 {
347 	return *(u_int32t *)(p + 4);
348 }
349 
350 #endif
351 
352 #endif /* UNALIGNED_ACCESS */
353 
354 /*
355  * Associated files have a leading '='.
356  */
357 #define	ASSOCCHAR	'='
358