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