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