1/*	$OpenBSD: cd9660.h,v 1.15 2021/09/01 15:19:00 deraadt Exp $	*/
2/*	$NetBSD: cd9660.h,v 1.21 2015/12/24 15:52:37 christos Exp $	*/
3
4/*
5 * Copyright (c) 2005 Daniel Watt, Walter Deignan, Ryan Gabrys, Alan
6 * Perez-Rathke and Ram Vedam.  All rights reserved.
7 *
8 * This code was written by Daniel Watt, Walter Deignan, Ryan Gabrys,
9 * Alan Perez-Rathke and Ram Vedam.
10 *
11 * Redistribution and use in source and binary forms, with or
12 * without modification, are permitted provided that the following
13 * conditions are met:
14 * 1. Redistributions of source code must retain the above copyright
15 *    notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above
17 *    copyright notice, this list of conditions and the following
18 *    disclaimer in the documentation and/or other materials provided
19 *    with the distribution.
20 *
21 * THIS SOFTWARE IS PROVIDED BY DANIEL WATT, WALTER DEIGNAN, RYAN
22 * GABRYS, ALAN PEREZ-RATHKE AND RAM VEDAM ``AS IS'' AND ANY EXPRESS OR
23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25 * DISCLAIMED.  IN NO EVENT SHALL DANIEL WATT, WALTER DEIGNAN, RYAN
26 * GABRYS, ALAN PEREZ-RATHKE AND RAM VEDAM BE LIABLE FOR ANY DIRECT, INDIRECT,
27 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
28 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
29 * USE,DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
30 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
31 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
33 * OF SUCH DAMAGE.
34 */
35
36#ifndef _MAKEFS_CD9660_H
37#define _MAKEFS_CD9660_H
38
39#include <sys/queue.h>
40#include <sys/endian.h>
41
42#include <assert.h>
43#include <errno.h>
44#include <fcntl.h>
45#include <stdarg.h>
46#include <stdio.h>
47#include <stdlib.h>
48#include <string.h>
49#include <unistd.h>
50#include <time.h>
51#include <limits.h>
52
53#include "makefs.h"
54#include "cd9660/iso.h"
55#include "cd9660/iso_rrip.h"
56#include "cd9660/cd9660_eltorito.h"
57
58#ifdef DEBUG
59#define	INODE_WARNX(__x)	warnx __x
60#else /* DEBUG */
61#define	INODE_WARNX(__x)
62#endif /* DEBUG */
63
64/******** STRUCTURES **********/
65
66#define ISO_VOLUME_DESCRIPTOR_STANDARD_ID "CD001"
67#define ISO_VOLUME_DESCRIPTOR_BOOT 0
68#define ISO_VOLUME_DESCRIPTOR_PVD 1
69#define ISO_VOLUME_DESCRIPTOR_TERMINATOR 255
70
71/*30 for name and extension, as well as version number and padding bit*/
72#define ISO_FILENAME_MAXLENGTH_BEFORE_VERSION 30
73#define ISO_FILENAME_MAXLENGTH	36
74#define ISO_FILENAME_MAXLENGTH_WITH_PADDING 37
75
76#define ISO_FLAG_CLEAR 0x00
77#define ISO_FLAG_HIDDEN 0x01
78#define ISO_FLAG_DIRECTORY 0x02
79#define ISO_FLAG_ASSOCIATED 0x04
80#define ISO_FLAG_PERMISSIONS 0x08
81#define ISO_FLAG_RESERVED5 0x10
82#define ISO_FLAG_RESERVED6 0x20
83#define ISO_FLAG_FINAL_RECORD 0x40
84
85#define ISO_PATHTABLE_ENTRY_BASESIZE 8
86
87#define ISO_RRIP_DEFAULT_MOVE_DIR_NAME "RR_MOVED"
88#define RRIP_DEFAULT_MOVE_DIR_NAME ".rr_moved"
89
90#define	CD9660_BLOCKS(__sector_size, __bytes)	\
91	howmany((__bytes), (__sector_size))
92
93#define CD9660_MEM_ALLOC_ERROR(_F)	\
94    err(1, "%s, %s l. %d", _F, __FILE__, __LINE__)
95
96#define CD9660_TYPE_FILE	0x01
97#define CD9660_TYPE_DIR		0x02
98#define CD9660_TYPE_DOT		0x04
99#define CD9660_TYPE_DOTDOT	0x08
100#define CD9660_TYPE_VIRTUAL	0x80
101
102#define CD9660_INODE_HASH_SIZE	1024
103#define CD9660_SECTOR_SIZE	2048
104
105#define CD9660_END_PADDING	150
106
107/* Slight modification of the ISO structure in iso.h */
108typedef struct _iso_directory_record_cd9660 {
109	u_char length			[ISODCL (1, 1)];	/* 711 */
110	u_char ext_attr_length		[ISODCL (2, 2)];	/* 711 */
111	u_char extent			[ISODCL (3, 10)];	/* 733 */
112	u_char size			[ISODCL (11, 18)];	/* 733 */
113	u_char date			[ISODCL (19, 25)];	/* 7 by 711 */
114	u_char flags			[ISODCL (26, 26)];
115	u_char file_unit_size		[ISODCL (27, 27)];	/* 711 */
116	u_char interleave		[ISODCL (28, 28)];	/* 711 */
117	u_char volume_sequence_number	[ISODCL (29, 32)];	/* 723 */
118	u_char name_len			[ISODCL (33, 33)];	/* 711 */
119	char name			[ISO_FILENAME_MAXLENGTH_WITH_PADDING];
120} iso_directory_record_cd9660;
121
122/* TODO: Lots of optimization of this structure */
123typedef struct _cd9660node {
124	u_char	type;/* Used internally */
125	/* Tree structure */
126	struct _cd9660node	*parent;	/* parent (NULL if root) */
127	TAILQ_HEAD(cd9660_children_head, _cd9660node)	cn_children;
128	TAILQ_ENTRY(_cd9660node)		cn_next_child;
129
130	struct _cd9660node *dot_record; /* For directories, used mainly in RRIP */
131	struct _cd9660node *dot_dot_record;
132
133	fsnode		*node;		/* pointer to fsnode */
134	struct _iso_directory_record_cd9660	*isoDirRecord;
135	struct iso_extended_attributes	*isoExtAttributes;
136
137	/***** SIZE CALCULATION *****/
138	/*already stored in isoDirRecord, but this is an int version, and will be
139		copied to isoDirRecord on writing*/
140	uint32_t fileDataSector;
141
142	/*
143	 * same thing, though some notes:
144	 * If a file, this is the file size
145	 * If a directory, this is the size of all its children's
146	 *	directory records
147	 * plus necessary padding
148	 */
149	int64_t fileDataLength;
150
151	int64_t fileSectorsUsed;
152	int fileRecordSize;/*copy of a variable, int for quicker calculations*/
153
154	/* Old name, used for renaming - needs to be optimized but low priority */
155	char o_name [ISO_FILENAME_MAXLENGTH_WITH_PADDING];
156
157	/***** SPACE RESERVED FOR EXTENSIONS *****/
158	/* For memory efficiency's sake - we should move this to a separate struct
159		and point to null if not needed */
160	/* For Rock Ridge */
161	struct _cd9660node *rr_real_parent, *rr_relocated;
162
163	int64_t susp_entry_size;
164	int64_t susp_dot_entry_size;
165	int64_t susp_dot_dot_entry_size;
166
167	/* Continuation area stuff */
168	int64_t susp_entry_ce_start;
169	int64_t susp_dot_ce_start;
170	int64_t susp_dot_dot_ce_start;
171
172	int64_t susp_entry_ce_length;
173	int64_t susp_dot_ce_length;
174	int64_t susp_dot_dot_ce_length;
175
176	/* Data to put at the end of the System Use field */
177	int64_t su_tail_size;
178	char *su_tail_data;
179
180	/*** PATH TABLE STUFF ***/
181	int level;			/*depth*/
182	int ptnumber;
183	struct _cd9660node *ptnext, *ptprev, *ptlast;
184
185	/* SUSP entries */
186	TAILQ_HEAD(susp_linked_list, ISO_SUSP_ATTRIBUTES) head;
187} cd9660node;
188
189typedef struct _path_table_entry
190{
191	u_char length[ISODCL (1, 1)];
192	u_char extended_attribute_length[ISODCL (2, 2)];
193	u_char first_sector[ISODCL (3, 6)];
194	u_char parent_number[ISODCL (7, 8)];
195	u_char name[ISO_FILENAME_MAXLENGTH_WITH_PADDING];
196} path_table_entry;
197
198typedef struct _volume_descriptor
199{
200	u_char *volumeDescriptorData; /*ALWAYS 2048 bytes long*/
201	int64_t sector;
202	struct _volume_descriptor *next;
203} volume_descriptor;
204
205typedef struct _iso9660_disk {
206	int sectorSize;
207	struct iso_primary_descriptor		primaryDescriptor;
208	struct iso_supplementary_descriptor	supplementaryDescriptor;
209
210	volume_descriptor *firstVolumeDescriptor;
211
212	cd9660node *rootNode;
213
214	/* Important sector numbers here */
215	/* primaryDescriptor.type_l_path_table*/
216	int64_t primaryBigEndianTableSector;
217
218	/* primaryDescriptor.type_m_path_table*/
219	int64_t primaryLittleEndianTableSector;
220
221	/* primaryDescriptor.opt_type_l_path_table*/
222	int64_t secondaryBigEndianTableSector;
223
224	/* primaryDescriptor.opt_type_m_path_table*/
225	int64_t secondaryLittleEndianTableSector;
226
227	/* primaryDescriptor.path_table_size*/
228	int pathTableLength;
229	int64_t dataFirstSector;
230
231	int64_t totalSectors;
232	/* OPTIONS GO HERE */
233	int	isoLevel;
234
235	int include_padding_areas;
236
237	/* SUSP options and variables */
238	int64_t susp_continuation_area_start_sector;
239	int64_t susp_continuation_area_size;
240	int64_t susp_continuation_area_current_free;
241
242	int rock_ridge_enabled;
243	/* Other Rock Ridge Variables */
244	char *rock_ridge_renamed_dir_name;
245	int rock_ridge_move_count;
246	cd9660node *rr_moved_dir;
247
248	/* Spec breaking options */
249	int allow_deep_trees;
250	int allow_multidot;
251	int omit_trailing_period;
252
253	/* BOOT INFORMATION HERE */
254	int has_generic_bootimage; /* Default to 0 */
255	char *generic_bootimage;
256
257	int is_bootable;/* Default to 0 */
258	int64_t boot_catalog_sector;
259	boot_volume_descriptor *boot_descriptor;
260
261	TAILQ_HEAD(boot_image_list,cd9660_boot_image) boot_images;
262	int image_serialno;
263	LIST_HEAD(boot_catalog_entries,boot_catalog_entry) boot_entries;
264
265} iso9660_disk;
266
267/************ FUNCTIONS **************/
268int			cd9660_valid_a_chars(const char *);
269int			cd9660_valid_d_chars(const char *);
270void			cd9660_uppercase_characters(char *, size_t);
271
272/* ISO Data Types */
273void			cd9660_721(uint16_t, unsigned char *);
274void			cd9660_731(uint32_t, unsigned char *);
275void			cd9660_722(uint16_t, unsigned char *);
276void			cd9660_732(uint32_t, unsigned char *);
277void			cd9660_bothendian_dword(uint32_t dw, unsigned char *);
278void			cd9660_bothendian_word(uint16_t dw, unsigned char *);
279void			cd9660_set_date(char *, time_t);
280void			cd9660_time_8426(unsigned char *, time_t);
281void			cd9660_time_915(unsigned char *, time_t);
282
283/*** Boot Functions ***/
284int	cd9660_write_generic_bootimage(FILE *);
285int	cd9660_write_boot(iso9660_disk *, FILE *);
286int	cd9660_add_boot_disk(iso9660_disk *, const char *);
287int	cd9660_eltorito_add_boot_option(iso9660_disk *, const char *,
288    const char *);
289int	cd9660_setup_boot(iso9660_disk *, int);
290int	cd9660_setup_boot_volume_descriptor(iso9660_disk *,
291    volume_descriptor *);
292
293
294/*** Write Functions ***/
295int	cd9660_write_image(iso9660_disk *, const char *image);
296int	cd9660_copy_file(iso9660_disk *, FILE *, off_t, const char *);
297
298char	*cd9660_compute_full_filename(cd9660node *);
299int	cd9660_compute_record_size(iso9660_disk *, cd9660node *);
300
301/* Debugging functions */
302void	debug_print_tree(iso9660_disk *, cd9660node *,int);
303void	debug_print_path_tree(cd9660node *);
304void	debug_print_volume_descriptor_information(iso9660_disk *);
305void	debug_dump_to_xml_ptentry(path_table_entry *,int, int);
306void	debug_dump_to_xml_path_table(FILE *, off_t, int, int);
307void	debug_dump_to_xml(FILE *);
308int	debug_get_encoded_number(unsigned char *, int);
309void	debug_dump_integer(const char *, char *,int);
310void	debug_dump_string(const char *,unsigned char *,int);
311void	debug_dump_directory_record_9_1(unsigned char *);
312void	debug_dump_to_xml_volume_descriptor(unsigned char *,int);
313
314void	cd9660_pad_string_spaces(char *, int);
315
316#endif
317