1 /* $NetBSD: cd9660.h,v 1.17 2011/06/23 02:35:56 enami Exp $ */
4 * Copyright (c) 2005 Daniel Watt, Walter Deignan, Ryan Gabrys, Alan
5 * Perez-Rathke and Ram Vedam. All rights reserved.
7 * This code was written by Daniel Watt, Walter Deignan, Ryan Gabrys,
8 * Alan Perez-Rathke and Ram Vedam.
10 * Redistribution and use in source and binary forms, with or
11 * without modification, are permitted provided that the following
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above
16 * copyright notice, this list of conditions and the following
17 * disclaimer in the documentation and/or other materials provided
18 * with the distribution.
20 * THIS SOFTWARE IS PROVIDED BY DANIEL WATT, WALTER DEIGNAN, RYAN
21 * GABRYS, ALAN PEREZ-RATHKE AND RAM VEDAM ``AS IS'' AND ANY EXPRESS OR
22 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24 * DISCLAIMED. IN NO EVENT SHALL DANIEL WATT, WALTER DEIGNAN, RYAN
25 * GABRYS, ALAN PEREZ-RATHKE AND RAM VEDAM BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
28 * USE,DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
29 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
37 #ifndef _MAKEFS_CD9660_H
38 #define _MAKEFS_CD9660_H
51 #include <sys/queue.h>
52 #include <sys/param.h>
53 #include <sys/endian.h>
58 #include "cd9660/cd9660_eltorito.h"
61 #define INODE_WARNX(__x) warnx __x
63 #define INODE_WARNX(__x)
66 #define CD9660MAXPATH 4096
68 #define ISO_STRING_FILTER_NONE = 0x00
69 #define ISO_STRING_FILTER_DCHARS = 0x01
70 #define ISO_STRING_FILTER_ACHARS = 0x02
73 Extended preferences type, in the spirit of what makefs gives us (only ints)
76 const char *shortName; /* Short option */
77 const char *name; /* option name */
78 char *value; /* where to stuff the value */
79 int minLength; /* minimum for value */
80 int maxLength; /* maximum for value */
81 const char *desc; /* option description */
85 /******** STRUCTURES **********/
88 #define ISO_DEFAULT_VOLUMEID "MAKEFS_CD9660_IMAGE"
89 #define ISO_DEFAULT_APPID "MAKEFS"
90 #define ISO_DEFAULT_PUBLISHER "MAKEFS"
91 #define ISO_DEFAULT_PREPARER "MAKEFS"
93 #define ISO_VOLUME_DESCRIPTOR_STANDARD_ID "CD001"
94 #define ISO_VOLUME_DESCRIPTOR_BOOT 0
95 #define ISO_VOLUME_DESCRIPTOR_PVD 1
96 #define ISO_VOLUME_DESCRIPTOR_TERMINATOR 255
98 /*30 for name and extension, as well as version number and padding bit*/
99 #define ISO_FILENAME_MAXLENGTH_BEFORE_VERSION 30
100 #define ISO_FILENAME_MAXLENGTH 36
101 #define ISO_FILENAME_MAXLENGTH_WITH_PADDING 37
103 #define ISO_FLAG_CLEAR 0x00
104 #define ISO_FLAG_HIDDEN 0x01
105 #define ISO_FLAG_DIRECTORY 0x02
106 #define ISO_FLAG_ASSOCIATED 0x04
107 #define ISO_FLAG_PERMISSIONS 0x08
108 #define ISO_FLAG_RESERVED5 0x10
109 #define ISO_FLAG_RESERVED6 0x20
110 #define ISO_FLAG_FINAL_RECORD 0x40
112 #define ISO_PATHTABLE_ENTRY_BASESIZE 8
114 #define ISO_RRIP_DEFAULT_MOVE_DIR_NAME "RR_MOVED"
115 #define RRIP_DEFAULT_MOVE_DIR_NAME ".rr_moved"
117 #define CD9660_BLOCKS(__sector_size, __bytes) \
118 howmany((__bytes), (__sector_size))
120 #define CD9660_MEM_ALLOC_ERROR(_F) \
121 err(EXIT_FAILURE, "%s, %s l. %d", _F, __FILE__, __LINE__)
123 #define CD9660_TYPE_FILE 0x01
124 #define CD9660_TYPE_DIR 0x02
125 #define CD9660_TYPE_DOT 0x04
126 #define CD9660_TYPE_DOTDOT 0x08
127 #define CD9660_TYPE_VIRTUAL 0x80
129 #define CD9660_INODE_HASH_SIZE 1024
130 #define CD9660_SECTOR_SIZE 2048
132 #define CD9660_END_PADDING 150
134 /* Slight modification of the ISO structure in iso.h */
135 typedef struct _iso_directory_record_cd9660 {
136 u_char length [ISODCL (1, 1)]; /* 711 */
137 u_char ext_attr_length [ISODCL (2, 2)]; /* 711 */
138 u_char extent [ISODCL (3, 10)]; /* 733 */
139 u_char size [ISODCL (11, 18)]; /* 733 */
140 u_char date [ISODCL (19, 25)]; /* 7 by 711 */
141 u_char flags [ISODCL (26, 26)];
142 u_char file_unit_size [ISODCL (27, 27)]; /* 711 */
143 u_char interleave [ISODCL (28, 28)]; /* 711 */
144 u_char volume_sequence_number [ISODCL (29, 32)]; /* 723 */
145 u_char name_len [ISODCL (33, 33)]; /* 711 */
146 char name [ISO_FILENAME_MAXLENGTH_WITH_PADDING];
147 } iso_directory_record_cd9660;
149 /* TODO: Lots of optimization of this structure */
150 typedef struct _cd9660node {
151 u_char type;/* Used internally */
153 struct _cd9660node *parent; /* parent (NULL if root) */
154 TAILQ_HEAD(cd9660_children_head, _cd9660node) cn_children;
155 TAILQ_ENTRY(_cd9660node) cn_next_child;
157 struct _cd9660node *dot_record; /* For directories, used mainly in RRIP */
158 struct _cd9660node *dot_dot_record;
160 fsnode *node; /* pointer to fsnode */
161 struct _iso_directory_record_cd9660 *isoDirRecord;
162 struct iso_extended_attributes *isoExtAttributes;
164 /***** SIZE CALCULATION *****/
165 /*already stored in isoDirRecord, but this is an int version, and will be
166 copied to isoDirRecord on writing*/
167 uint32_t fileDataSector;
170 * same thing, though some notes:
171 * If a file, this is the file size
172 * If a directory, this is the size of all its children's
174 * plus necessary padding
176 int64_t fileDataLength;
178 int64_t fileSectorsUsed;
179 int fileRecordSize;/*copy of a variable, int for quicker calculations*/
181 /* Old name, used for renaming - needs to be optimized but low priority */
182 char o_name [ISO_FILENAME_MAXLENGTH_WITH_PADDING];
184 /***** SPACE RESERVED FOR EXTENSIONS *****/
185 /* For memory efficiency's sake - we should move this to a separate struct
186 and point to null if not needed */
188 struct _cd9660node *rr_real_parent, *rr_relocated;
190 int64_t susp_entry_size;
191 int64_t susp_dot_entry_size;
192 int64_t susp_dot_dot_entry_size;
194 /* Continuation area stuff */
195 int64_t susp_entry_ce_start;
196 int64_t susp_dot_ce_start;
197 int64_t susp_dot_dot_ce_start;
199 int64_t susp_entry_ce_length;
200 int64_t susp_dot_ce_length;
201 int64_t susp_dot_dot_ce_length;
203 /* Data to put at the end of the System Use field */
204 int64_t su_tail_size;
207 /*** PATH TABLE STUFF ***/
210 struct _cd9660node *ptnext, *ptprev, *ptlast;
213 TAILQ_HEAD(susp_linked_list, ISO_SUSP_ATTRIBUTES) head;
216 typedef struct _path_table_entry
218 u_char length[ISODCL (1, 1)];
219 u_char extended_attribute_length[ISODCL (2, 2)];
220 u_char first_sector[ISODCL (3, 6)];
221 u_char parent_number[ISODCL (7, 8)];
222 u_char name[ISO_FILENAME_MAXLENGTH_WITH_PADDING];
225 typedef struct _volume_descriptor
227 u_char *volumeDescriptorData; /*ALWAYS 2048 bytes long*/
229 struct _volume_descriptor *next;
232 typedef struct _iso9660_disk {
234 struct iso_primary_descriptor primaryDescriptor;
235 struct iso_supplementary_descriptor supplementaryDescriptor;
237 volume_descriptor *firstVolumeDescriptor;
239 cd9660node *rootNode;
241 /* Important sector numbers here */
242 /* primaryDescriptor.type_l_path_table*/
243 int64_t primaryBigEndianTableSector;
245 /* primaryDescriptor.type_m_path_table*/
246 int64_t primaryLittleEndianTableSector;
248 /* primaryDescriptor.opt_type_l_path_table*/
249 int64_t secondaryBigEndianTableSector;
251 /* primaryDescriptor.opt_type_m_path_table*/
252 int64_t secondaryLittleEndianTableSector;
254 /* primaryDescriptor.path_table_size*/
256 int64_t dataFirstSector;
258 int64_t totalSectors;
259 /* OPTIONS GO HERE */
262 int include_padding_areas;
264 int follow_sym_links;
269 /* SUSP options and variables */
270 int64_t susp_continuation_area_start_sector;
271 int64_t susp_continuation_area_size;
272 int64_t susp_continuation_area_current_free;
274 int rock_ridge_enabled;
275 /* Other Rock Ridge Variables */
276 char *rock_ridge_renamed_dir_name;
277 int rock_ridge_move_count;
278 cd9660node *rr_moved_dir;
280 int archimedes_enabled;
283 /* Spec breaking options */
284 u_char allow_deep_trees;
285 u_char allow_start_dot;
286 u_char allow_max_name; /* Allow 37 char filenames*/
287 u_char allow_illegal_chars; /* ~, !, # */
288 u_char allow_lowercase;
289 u_char allow_multidot;
290 u_char omit_trailing_period;
292 /* BOOT INFORMATION HERE */
293 int has_generic_bootimage; /* Default to 0 */
294 char *generic_bootimage;
296 int is_bootable;/* Default to 0 */
297 int64_t boot_catalog_sector;
298 boot_volume_descriptor *boot_descriptor;
299 char * boot_image_directory;
301 TAILQ_HEAD(boot_image_list,cd9660_boot_image) boot_images;
303 LIST_HEAD(boot_catalog_entries,boot_catalog_entry) boot_entries;
307 /************ FUNCTIONS **************/
308 int cd9660_valid_a_chars(const char *);
309 int cd9660_valid_d_chars(const char *);
310 void cd9660_uppercase_characters(char *, int);
313 void cd9660_721(uint16_t, unsigned char *);
314 void cd9660_731(uint32_t, unsigned char *);
315 void cd9660_722(uint16_t, unsigned char *);
316 void cd9660_732(uint32_t, unsigned char *);
317 void cd9660_bothendian_dword(uint32_t dw, unsigned char *);
318 void cd9660_bothendian_word(uint16_t dw, unsigned char *);
319 void cd9660_set_date(char *, time_t);
320 void cd9660_time_8426(unsigned char *, time_t);
321 void cd9660_time_915(unsigned char *, time_t);
323 /*** Boot Functions ***/
324 int cd9660_write_generic_bootimage(FILE *);
325 int cd9660_write_boot(iso9660_disk *, FILE *);
326 int cd9660_add_boot_disk(iso9660_disk *, const char *);
327 int cd9660_eltorito_add_boot_option(iso9660_disk *, const char *,
329 int cd9660_setup_boot(iso9660_disk *, int);
330 int cd9660_setup_boot_volume_descriptor(iso9660_disk *,
331 volume_descriptor *);
334 /*** Write Functions ***/
335 int cd9660_write_image(iso9660_disk *, const char *image);
336 int cd9660_copy_file(iso9660_disk *, FILE *, off_t, const char *);
338 void cd9660_compute_full_filename(cd9660node *, char *);
339 int cd9660_compute_record_size(iso9660_disk *, cd9660node *);
341 /* Debugging functions */
342 void debug_print_tree(iso9660_disk *, cd9660node *,int);
343 void debug_print_path_tree(cd9660node *);
344 void debug_print_volume_descriptor_information(iso9660_disk *);
345 void debug_dump_to_xml_ptentry(path_table_entry *,int, int);
346 void debug_dump_to_xml_path_table(FILE *, off_t, int, int);
347 void debug_dump_to_xml(FILE *);
348 int debug_get_encoded_number(unsigned char *, int);
349 void debug_dump_integer(const char *, char *,int);
350 void debug_dump_string(const char *,unsigned char *,int);
351 void debug_dump_directory_record_9_1(unsigned char *);
352 void debug_dump_to_xml_volume_descriptor(unsigned char *,int);
354 void cd9660_pad_string_spaces(char *, int);