xref: /netbsd-src/sys/fs/cd9660/iso.h (revision e5548b402ae4c44fb816de42c7bba9581ce23ef5)
1 /*	$NetBSD: iso.h,v 1.6 2005/12/03 17:34:43 christos Exp $	*/
2 
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 /*
40  * Definitions describing ISO9660 file system structure, as well as
41  * the functions necessary to access fields of ISO9660 file system
42  * structures.
43  */
44 
45 #ifndef _ISOFS_CD9660_ISO_H_
46 #define _ISOFS_CD9660_ISO_H_
47 
48 #define ISODCL(from, to) (to - from + 1)
49 
50 struct iso_volume_descriptor {
51 	char type[ISODCL(1,1)]; /* 711 */
52 	char id[ISODCL(2,6)];
53 	char version[ISODCL(7,7)];
54 	char data[ISODCL(8,2048)];
55 };
56 
57 /* volume descriptor types */
58 #define ISO_VD_PRIMARY 1
59 #define ISO_VD_SUPPLEMENTARY 2
60 #define ISO_VD_END 255
61 
62 #define ISO_STANDARD_ID "CD001"
63 #define ISO_ECMA_ID     "CDW01"
64 
65 struct iso_primary_descriptor {
66 	char 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 	char 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 };
100 #define ISO_DEFAULT_BLOCK_SIZE		2048
101 
102 struct iso_supplementary_descriptor {
103 	char type			[ISODCL (  1,	1)]; /* 711 */
104 	char id				[ISODCL (  2,	6)];
105 	char version			[ISODCL (  7,	7)]; /* 711 */
106 	char flags			[ISODCL (  8,	8)]; /* 711? */
107 	char system_id			[ISODCL (  9,  40)]; /* achars */
108 	char volume_id			[ISODCL ( 41,  72)]; /* dchars */
109 	char unused2			[ISODCL ( 73,  80)];
110 	char volume_space_size		[ISODCL ( 81,  88)]; /* 733 */
111 	char escape			[ISODCL ( 89, 120)];
112 	char volume_set_size		[ISODCL (121, 124)]; /* 723 */
113 	char volume_sequence_number	[ISODCL (125, 128)]; /* 723 */
114 	char logical_block_size		[ISODCL (129, 132)]; /* 723 */
115 	char path_table_size		[ISODCL (133, 140)]; /* 733 */
116 	char type_l_path_table		[ISODCL (141, 144)]; /* 731 */
117 	char opt_type_l_path_table	[ISODCL (145, 148)]; /* 731 */
118 	char type_m_path_table		[ISODCL (149, 152)]; /* 732 */
119 	char opt_type_m_path_table	[ISODCL (153, 156)]; /* 732 */
120 	char root_directory_record	[ISODCL (157, 190)]; /* 9.1 */
121 	char volume_set_id		[ISODCL (191, 318)]; /* dchars */
122 	char publisher_id		[ISODCL (319, 446)]; /* achars */
123 	char preparer_id		[ISODCL (447, 574)]; /* achars */
124 	char application_id		[ISODCL (575, 702)]; /* achars */
125 	char copyright_file_id		[ISODCL (703, 739)]; /* 7.5 dchars */
126 	char abstract_file_id		[ISODCL (740, 776)]; /* 7.5 dchars */
127 	char bibliographic_file_id	[ISODCL (777, 813)]; /* 7.5 dchars */
128 	char creation_date		[ISODCL (814, 830)]; /* 8.4.26.1 */
129 	char modification_date		[ISODCL (831, 847)]; /* 8.4.26.1 */
130 	char expiration_date		[ISODCL (848, 864)]; /* 8.4.26.1 */
131 	char effective_date		[ISODCL (865, 881)]; /* 8.4.26.1 */
132 	char file_structure_version	[ISODCL (882, 882)]; /* 711 */
133 	char unused4			[ISODCL (883, 883)];
134 	char application_data		[ISODCL (884, 1395)];
135 	char unused5			[ISODCL (1396, 2048)];
136 };
137 
138 struct iso_directory_record {
139 	char length			[ISODCL (1, 1)]; /* 711 */
140 	char ext_attr_length		[ISODCL (2, 2)]; /* 711 */
141 	u_char extent			[ISODCL (3, 10)]; /* 733 */
142 	u_char size			[ISODCL (11, 18)]; /* 733 */
143 	char date			[ISODCL (19, 25)]; /* 7 by 711 */
144 	char flags			[ISODCL (26, 26)];
145 	char file_unit_size		[ISODCL (27, 27)]; /* 711 */
146 	char interleave			[ISODCL (28, 28)]; /* 711 */
147 	char volume_sequence_number	[ISODCL (29, 32)]; /* 723 */
148 	char name_len			[ISODCL (33, 33)]; /* 711 */
149 	char name			[1];			/* XXX */
150 };
151 /* can't take sizeof(iso_directory_record), because of possible alignment
152    of the last entry (34 instead of 33) */
153 #define ISO_DIRECTORY_RECORD_SIZE	33
154 
155 struct iso_extended_attributes {
156 	u_char owner			[ISODCL (1, 4)]; /* 723 */
157 	u_char group			[ISODCL (5, 8)]; /* 723 */
158 	u_char perm			[ISODCL (9, 10)]; /* 9.5.3 */
159 	char ctime			[ISODCL (11, 27)]; /* 8.4.26.1 */
160 	char mtime			[ISODCL (28, 44)]; /* 8.4.26.1 */
161 	char xtime			[ISODCL (45, 61)]; /* 8.4.26.1 */
162 	char ftime			[ISODCL (62, 78)]; /* 8.4.26.1 */
163 	char recfmt			[ISODCL (79, 79)]; /* 711 */
164 	char recattr			[ISODCL (80, 80)]; /* 711 */
165 	u_char reclen			[ISODCL (81, 84)]; /* 723 */
166 	char system_id			[ISODCL (85, 116)]; /* achars */
167 	char system_use			[ISODCL (117, 180)];
168 	char version			[ISODCL (181, 181)]; /* 711 */
169 	char len_esc			[ISODCL (182, 182)]; /* 711 */
170 	char reserved			[ISODCL (183, 246)];
171 	u_char len_au			[ISODCL (247, 250)]; /* 723 */
172 };
173 
174 static __inline int isonum_711(u_char *) __attribute__ ((unused));
175 static __inline int isonum_712(char *) __attribute__ ((unused));
176 static __inline uint16_t isonum_721(u_char *) __attribute__ ((unused));
177 static __inline uint16_t isonum_722(u_char *) __attribute__ ((unused));
178 static __inline uint16_t isonum_723(u_char *) __attribute__ ((unused));
179 static __inline uint32_t isonum_731(u_char *) __attribute__ ((unused));
180 static __inline uint32_t isonum_732(u_char *) __attribute__ ((unused));
181 static __inline uint32_t isonum_733(u_char *) __attribute__ ((unused));
182 
183 /* 7.1.1: unsigned char */
184 static __inline int
185 isonum_711(u_char *p)
186 {
187 	return *p;
188 }
189 
190 /* 7.1.2: signed(?) char */
191 static __inline int
192 isonum_712(char *p)
193 {
194 	return *p;
195 }
196 
197 /* 7.2.1: unsigned little-endian 16-bit value.  NOT USED IN KERNEL. */
198 static __inline uint16_t
199 isonum_721(u_char *p)
200 {
201 #if defined(UNALIGNED_ACCESS) && (BYTE_ORDER == LITTLE_ENDIAN)
202 	return *(uint16_t *)p;
203 #else
204 	return *p|((char)p[1] << 8);
205 #endif
206 }
207 
208 /* 7.2.2: unsigned big-endian 16-bit value.  NOT USED IN KERNEL. */
209 static __inline uint16_t
210 isonum_722(u_char *p)
211 {
212 #if defined(UNALIGNED_ACCESS) && (BYTE_ORDER == BIG_ENDIAN)
213 	return *(uint16_t *)p;
214 #else
215 	return ((char)*p << 8)|p[1];
216 #endif
217 }
218 
219 /* 7.2.3: unsigned both-endian (little, then big) 16-bit value */
220 static __inline uint16_t
221 isonum_723(u_char *p)
222 {
223 #if defined(UNALIGNED_ACCESS) && \
224     ((BYTE_ORDER == LITTLE_ENDIAN) || (BYTE_ORDER == BIG_ENDIAN))
225 #if BYTE_ORDER == LITTLE_ENDIAN
226 	return *(uint16_t *)p;
227 #else
228 	return *(uint16_t *)(p + 2);
229 #endif
230 #else /* !UNALIGNED_ACCESS or weird byte order */
231 	return *p|(p[1] << 8);
232 #endif
233 }
234 
235 /* 7.3.1: unsigned little-endian 32-bit value.  NOT USED IN KERNEL. */
236 static __inline uint32_t
237 isonum_731(u_char *p)
238 {
239 #if defined(UNALIGNED_ACCESS) && (BYTE_ORDER == LITTLE_ENDIAN)
240 	return *(uint32_t *)p;
241 #else
242 	return *p|(p[1] << 8)|(p[2] << 16)|(p[3] << 24);
243 #endif
244 }
245 
246 /* 7.3.2: unsigned big-endian 32-bit value.  NOT USED IN KERNEL. */
247 static __inline uint32_t
248 isonum_732(u_char *p)
249 {
250 #if defined(UNALIGNED_ACCESS) && (BYTE_ORDER == BIG_ENDIAN)
251 	return *(uint32_t *)p;
252 #else
253 	return (*p << 24)|(p[1] << 16)|(p[2] << 8)|p[3];
254 #endif
255 }
256 
257 /* 7.3.3: unsigned both-endian (little, then big) 32-bit value */
258 static __inline uint32_t
259 isonum_733(u_char *p)
260 {
261 #if defined(UNALIGNED_ACCESS) && \
262     ((BYTE_ORDER == LITTLE_ENDIAN) || (BYTE_ORDER == BIG_ENDIAN))
263 #if BYTE_ORDER == LITTLE_ENDIAN
264 	return *(uint32_t *)p;
265 #else
266 	return *(uint32_t *)(p + 4);
267 #endif
268 #else /* !UNALIGNED_ACCESS or weird byte order */
269 	return *p|(p[1] << 8)|(p[2] << 16)|(p[3] << 24);
270 #endif
271 }
272 
273 /*
274  * Associated files have a leading '='.
275  */
276 #define	ASSOCCHAR	'='
277 
278 #endif /* _ISOFS_CD9660_ISO_H_ */
279