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