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