xref: /freebsd/sys/fs/cd9660/iso.h (revision 9088779e3c8b810afb701adb80be154a7b2e0523)
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 #ifndef _ISOFS_CD9660_ISO_H_
41 #define _ISOFS_CD9660_ISO_H_
42 
43 #define ISODCL(from, to) (to - from + 1)
44 
45 struct iso_volume_descriptor {
46 	char type[ISODCL(1,1)]; /* 711 */
47 	char id[ISODCL(2,6)];
48 	char version[ISODCL(7,7)];
49 	char unused[ISODCL(8,8)];
50 	char type_sierra[ISODCL(9,9)]; /* 711 */
51 	char id_sierra[ISODCL(10,14)];
52 	char version_sierra[ISODCL(15,15)];
53 	char data[ISODCL(16,2048)];
54 };
55 
56 /* volume descriptor types */
57 #define ISO_VD_PRIMARY 1
58 #define ISO_VD_SUPPLEMENTARY 2
59 #define ISO_VD_END 255
60 
61 #define ISO_STANDARD_ID "CD001"
62 #define ISO_ECMA_ID	"CDW01"
63 
64 #define ISO_SIERRA_ID	"CDROM"
65 
66 struct iso_primary_descriptor {
67 	u_char type			[ISODCL (  1,	1)]; /* 711 */
68 	char id				[ISODCL (  2,	6)];
69 	char version			[ISODCL (  7,	7)]; /* 711 */
70 	char unused1			[ISODCL (  8,	8)];
71 	char system_id			[ISODCL (  9,  40)]; /* achars */
72 	char volume_id			[ISODCL ( 41,  72)]; /* dchars */
73 	char unused2			[ISODCL ( 73,  80)];
74 	char volume_space_size		[ISODCL ( 81,  88)]; /* 733 */
75 	char unused3			[ISODCL ( 89, 120)];
76 	char volume_set_size		[ISODCL (121, 124)]; /* 723 */
77 	char volume_sequence_number	[ISODCL (125, 128)]; /* 723 */
78 	u_char logical_block_size	[ISODCL (129, 132)]; /* 723 */
79 	char path_table_size		[ISODCL (133, 140)]; /* 733 */
80 	char type_l_path_table		[ISODCL (141, 144)]; /* 731 */
81 	char opt_type_l_path_table	[ISODCL (145, 148)]; /* 731 */
82 	char type_m_path_table		[ISODCL (149, 152)]; /* 732 */
83 	char opt_type_m_path_table	[ISODCL (153, 156)]; /* 732 */
84 	char root_directory_record	[ISODCL (157, 190)]; /* 9.1 */
85 	char volume_set_id		[ISODCL (191, 318)]; /* dchars */
86 	char publisher_id		[ISODCL (319, 446)]; /* achars */
87 	char preparer_id		[ISODCL (447, 574)]; /* achars */
88 	char application_id		[ISODCL (575, 702)]; /* achars */
89 	char copyright_file_id		[ISODCL (703, 739)]; /* 7.5 dchars */
90 	char abstract_file_id		[ISODCL (740, 776)]; /* 7.5 dchars */
91 	char bibliographic_file_id	[ISODCL (777, 813)]; /* 7.5 dchars */
92 	char creation_date		[ISODCL (814, 830)]; /* 8.4.26.1 */
93 	char modification_date		[ISODCL (831, 847)]; /* 8.4.26.1 */
94 	char expiration_date		[ISODCL (848, 864)]; /* 8.4.26.1 */
95 	char effective_date		[ISODCL (865, 881)]; /* 8.4.26.1 */
96 	char file_structure_version	[ISODCL (882, 882)]; /* 711 */
97 	char unused4			[ISODCL (883, 883)];
98 	char application_data		[ISODCL (884, 1395)];
99 	char unused5			[ISODCL (1396, 2048)];
100 } __packed;
101 #define ISO_DEFAULT_BLOCK_SHIFT		11
102 #define ISO_DEFAULT_BLOCK_SIZE		(1 << ISO_DEFAULT_BLOCK_SHIFT)
103 
104 /*
105  * Used by Microsoft Joliet extension to ISO9660. Almost the same
106  * as PVD, but byte position 8 is a flag, and 89-120 is for escape.
107  */
108 
109 struct iso_supplementary_descriptor {
110       char type                       [ISODCL (  1,   1)]; /* 711 */
111       char id                         [ISODCL (  2,   6)];
112       char version                    [ISODCL (  7,   7)]; /* 711 */
113       char flags                      [ISODCL (  8,   8)]; /* 711? */
114       char system_id                  [ISODCL (  9,  40)]; /* achars */
115       char volume_id                  [ISODCL ( 41,  72)]; /* dchars */
116       char unused2                    [ISODCL ( 73,  80)];
117       char volume_space_size          [ISODCL ( 81,  88)]; /* 733 */
118       char escape                     [ISODCL ( 89, 120)];
119       char volume_set_size            [ISODCL (121, 124)]; /* 723 */
120       char volume_sequence_number     [ISODCL (125, 128)]; /* 723 */
121       u_char logical_block_size         [ISODCL (129, 132)]; /* 723 */
122       char path_table_size            [ISODCL (133, 140)]; /* 733 */
123       char type_l_path_table          [ISODCL (141, 144)]; /* 731 */
124       char opt_type_l_path_table      [ISODCL (145, 148)]; /* 731 */
125       char type_m_path_table          [ISODCL (149, 152)]; /* 732 */
126       char opt_type_m_path_table      [ISODCL (153, 156)]; /* 732 */
127       char root_directory_record      [ISODCL (157, 190)]; /* 9.1 */
128       char volume_set_id              [ISODCL (191, 318)]; /* dchars */
129       char publisher_id               [ISODCL (319, 446)]; /* achars */
130       char preparer_id                [ISODCL (447, 574)]; /* achars */
131       char application_id             [ISODCL (575, 702)]; /* achars */
132       char copyright_file_id          [ISODCL (703, 739)]; /* 7.5 dchars */
133       char abstract_file_id           [ISODCL (740, 776)]; /* 7.5 dchars */
134       char bibliographic_file_id      [ISODCL (777, 813)]; /* 7.5 dchars */
135       char creation_date              [ISODCL (814, 830)]; /* 8.4.26.1 */
136       char modification_date          [ISODCL (831, 847)]; /* 8.4.26.1 */
137       char expiration_date            [ISODCL (848, 864)]; /* 8.4.26.1 */
138       char effective_date             [ISODCL (865, 881)]; /* 8.4.26.1 */
139       char file_structure_version     [ISODCL (882, 882)]; /* 711 */
140       char unused4                    [ISODCL (883, 883)];
141       char application_data           [ISODCL (884, 1395)];
142       char unused5                    [ISODCL (1396, 2048)];
143 };
144 
145 struct iso_sierra_primary_descriptor {
146 	char unknown1			[ISODCL (  1,	8)]; /* 733 */
147 	char type			[ISODCL (  9,	9)]; /* 711 */
148 	char id				[ISODCL ( 10,  14)];
149 	char version			[ISODCL ( 15,  15)]; /* 711 */
150 	char unused1			[ISODCL ( 16,  16)];
151 	char system_id			[ISODCL ( 17,  48)]; /* achars */
152 	char volume_id			[ISODCL ( 49,  80)]; /* dchars */
153 	char unused2			[ISODCL ( 81,  88)];
154 	char volume_space_size		[ISODCL ( 89,  96)]; /* 733 */
155 	char unused3			[ISODCL ( 97, 128)];
156 	char volume_set_size		[ISODCL (129, 132)]; /* 723 */
157 	char volume_sequence_number	[ISODCL (133, 136)]; /* 723 */
158 	u_char logical_block_size	[ISODCL (137, 140)]; /* 723 */
159 	char path_table_size		[ISODCL (141, 148)]; /* 733 */
160 	char type_l_path_table		[ISODCL (149, 152)]; /* 731 */
161 	char opt_type_l_path_table	[ISODCL (153, 156)]; /* 731 */
162 	char unknown2			[ISODCL (157, 160)]; /* 731 */
163 	char unknown3			[ISODCL (161, 164)]; /* 731 */
164 	char type_m_path_table		[ISODCL (165, 168)]; /* 732 */
165 	char opt_type_m_path_table	[ISODCL (169, 172)]; /* 732 */
166 	char unknown4			[ISODCL (173, 176)]; /* 732 */
167 	char unknown5			[ISODCL (177, 180)]; /* 732 */
168 	char root_directory_record	[ISODCL (181, 214)]; /* 9.1 */
169 	char volume_set_id		[ISODCL (215, 342)]; /* dchars */
170 	char publisher_id		[ISODCL (343, 470)]; /* achars */
171 	char preparer_id		[ISODCL (471, 598)]; /* achars */
172 	char application_id		[ISODCL (599, 726)]; /* achars */
173 	char copyright_id		[ISODCL (727, 790)]; /* achars */
174 	char creation_date		[ISODCL (791, 806)]; /* ? */
175 	char modification_date		[ISODCL (807, 822)]; /* ? */
176 	char expiration_date		[ISODCL (823, 838)]; /* ? */
177 	char effective_date		[ISODCL (839, 854)]; /* ? */
178 	char file_structure_version	[ISODCL (855, 855)]; /* 711 */
179 	char unused4			[ISODCL (856, 2048)];
180 };
181 
182 struct iso_directory_record {
183 	u_char length			[ISODCL (1, 1)]; /* 711 */
184 	u_char ext_attr_length		[ISODCL (2, 2)]; /* 711 */
185 	u_char extent			[ISODCL (3, 10)]; /* 733 */
186 	u_char size			[ISODCL (11, 18)]; /* 733 */
187 	u_char date			[ISODCL (19, 25)]; /* 7 by 711 */
188 	u_char flags			[ISODCL (26, 26)];
189 	u_char file_unit_size		[ISODCL (27, 27)]; /* 711 */
190 	u_char interleave		[ISODCL (28, 28)]; /* 711 */
191 	u_char volume_sequence_number	[ISODCL (29, 32)]; /* 723 */
192 	u_char name_len			[ISODCL (33, 33)]; /* 711 */
193 	char name			[1];			/* XXX */
194 } __packed;
195 /* can't take sizeof(iso_directory_record), because of possible alignment
196    of the last entry (34 instead of 33) */
197 #define ISO_DIRECTORY_RECORD_SIZE	33
198 
199 struct iso_extended_attributes {
200 	u_char owner			[ISODCL (1, 4)]; /* 723 */
201 	u_char group			[ISODCL (5, 8)]; /* 723 */
202 	u_char perm			[ISODCL (9, 10)]; /* 9.5.3 */
203 	char ctime			[ISODCL (11, 27)]; /* 8.4.26.1 */
204 	char mtime			[ISODCL (28, 44)]; /* 8.4.26.1 */
205 	char xtime			[ISODCL (45, 61)]; /* 8.4.26.1 */
206 	char ftime			[ISODCL (62, 78)]; /* 8.4.26.1 */
207 	char recfmt			[ISODCL (79, 79)]; /* 711 */
208 	char recattr			[ISODCL (80, 80)]; /* 711 */
209 	u_char reclen			[ISODCL (81, 84)]; /* 723 */
210 	char system_id			[ISODCL (85, 116)]; /* achars */
211 	char system_use			[ISODCL (117, 180)];
212 	char version			[ISODCL (181, 181)]; /* 711 */
213 	char len_esc			[ISODCL (182, 182)]; /* 711 */
214 	char reserved			[ISODCL (183, 246)];
215 	u_char len_au			[ISODCL (247, 250)]; /* 723 */
216 };
217 
218 #ifdef _KERNEL
219 
220 /* CD-ROM Format type */
221 enum ISO_FTYPE	{ ISO_FTYPE_DEFAULT, ISO_FTYPE_9660, ISO_FTYPE_RRIP,
222 		  ISO_FTYPE_JOLIET, ISO_FTYPE_ECMA, ISO_FTYPE_HIGH_SIERRA };
223 
224 #ifndef	ISOFSMNT_ROOT
225 #define	ISOFSMNT_ROOT	0
226 #endif
227 
228 /*
229  * When ino_t becomes 64-bit, we can remove this definition in favor of ino_t.
230  */
231 typedef __uint64_t cd_ino_t;
232 
233 struct iso_mnt {
234 	uint64_t im_flags;
235 
236 	struct mount *im_mountp;
237 	struct cdev *im_dev;
238 	struct vnode *im_devvp;
239 
240 	struct g_consumer *im_cp;
241 	struct bufobj *im_bo;
242 
243 	int logical_block_size;
244 	int im_bshift;
245 	int im_bmask;
246 
247 	int volume_space_size;
248 
249 	char root[ISODCL (157, 190)];
250 	int root_extent;
251 	int root_size;
252 	enum ISO_FTYPE	iso_ftype;
253 
254 	int rr_skip;
255 	int rr_skip0;
256 
257 	int joliet_level;
258 
259 	void *im_d2l;
260 	void *im_l2d;
261 };
262 
263 struct ifid {
264 	u_short		ifid_len;
265 	u_short		ifid_pad;
266 	cd_ino_t	ifid_ino;
267 	long		ifid_start;
268 };
269 
270 #define VFSTOISOFS(mp)	((struct iso_mnt *)((mp)->mnt_data))
271 
272 #define blkoff(imp, loc)	((loc) & (imp)->im_bmask)
273 #define lblktosize(imp, blk)	((blk) << (imp)->im_bshift)
274 #define lblkno(imp, loc)	((loc) >> (imp)->im_bshift)
275 #define blksize(imp, ip, lbn)	((imp)->logical_block_size)
276 
277 int cd9660_vget_internal(struct mount *, cd_ino_t, int, struct vnode **, int,
278 			 struct iso_directory_record *);
279 #define cd9660_sysctl ((int (*)(int *, u_int, void *, size_t *, void *, \
280 				size_t, struct proc *))eopnotsupp)
281 
282 extern struct vop_vector cd9660_vnodeops;
283 extern struct vop_vector cd9660_fifoops;
284 
285 int isochar(u_char *, u_char *, int, u_short *, int *, int, void *);
286 int isofncmp(u_char *, int, u_char *, int, int, int, void *, void *);
287 void isofntrans(u_char *, int, u_char *, u_short *, int, int, int, int, void *);
288 cd_ino_t isodirino(struct iso_directory_record *, struct iso_mnt *);
289 u_short sgetrune(const char *, size_t, char const **, int, void *);
290 
291 #endif /* _KERNEL */
292 
293 /*
294  * The isonum_xxx functions are inlined anyway, and could come handy even
295  * outside the kernel.  Thus we don't hide them here.
296  */
297 
298 /*
299  * 7xy
300  *  x -> 1 = 8 bits, 2 = 16 bits, 3 = 32 bits
301  *   y -> 1 = little-endian, 2 = big-endian, 3 = both (le then be)
302  */
303 
304 static __inline uint8_t
305 isonum_711(const unsigned char *p)
306 {
307 
308 	return (p[0]);
309 }
310 
311 static __inline int8_t
312 isonum_712(const unsigned char *p)
313 {
314 
315 	return ((signed char)p[0]);
316 }
317 
318 static __inline uint8_t
319 isonum_713(const unsigned char *p)
320 {
321 
322 	return (p[0]);
323 }
324 
325 static __inline uint16_t
326 isonum_721(const unsigned char *p)
327 {
328 
329 	return (p[0] | p[1] << 8);
330 }
331 
332 static __inline uint16_t
333 isonum_722(const unsigned char *p)
334 {
335 
336 	return (p[1] | p[0] << 8);
337 }
338 
339 static __inline uint16_t
340 isonum_723(const unsigned char *p)
341 {
342 
343 	return (p[0] | p[1] << 8);
344 }
345 
346 static __inline uint32_t
347 isonum_731(const unsigned char *p)
348 {
349 
350 	return (p[0] | p[1] << 8 | p[2] << 16 | p[3] << 24);
351 }
352 
353 static __inline uint32_t
354 isonum_732(const unsigned char *p)
355 {
356 
357 	return (p[3] | p[2] << 8 | p[1] << 16 | p[0] << 24);
358 }
359 
360 static __inline uint32_t
361 isonum_733(const unsigned char *p)
362 {
363 
364 	return (p[0] | p[1] << 8 | p[2] << 16 | p[3] << 24);
365 }
366 
367 /*
368  * Associated files have a leading '='.
369  */
370 #define	ASSOCCHAR	'='
371 
372 #endif /* _ISOFS_CD9660_ISO_H_ */
373