cd9660.h revision 1.4
1 /* $NetBSD: cd9660.h,v 1.4 2005/10/25 02:22:04 dyoung Exp $ */ 2 3 /* 4 * Copyright (c) 2005 Daniel Watt, Walter Deignan, Ryan Gabrys, Alan 5 * Perez-Rathke and Ram Vedam. All rights reserved. 6 * 7 * This code was written by Daniel Watt, Walter Deignan, Ryan Gabrys, 8 * Alan Perez-Rathke and Ram Vedam. 9 * 10 * Redistribution and use in source and binary forms, with or 11 * without modification, are permitted provided that the following 12 * conditions are met: 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. 19 * 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 32 * OF SUCH DAMAGE. 33 */ 34 35 #ifndef _MAKEFS_CD9660_H 36 #define _MAKEFS_CD9660_H 37 38 #if HAVE_NBTOOL_CONFIG_H 39 #include "nbtool_config.h" 40 #endif 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 #include <sys/queue.h> 53 #include <sys/param.h> 54 55 #include "makefs.h" 56 #include "cd9660/iso.h" 57 #include "cd9660/iso_rrip.h" 58 #include "cd9660/cd9660_eltorito.h" 59 60 61 #define CD9660MAXPATH 4096 62 63 #define ISO_STRING_FILTER_NONE = 0x00 64 #define ISO_STRING_FILTER_DCHARS = 0x01 65 #define ISO_STRING_FILTER_ACHARS = 0x02 66 67 /* 68 Extended preferences type, in the spirit of what makefs gives us (only ints) 69 */ 70 typedef struct { 71 const char *shortName; /* Short option */ 72 const char *name; /* option name */ 73 char *value; /* where to stuff the value */ 74 int minLength; /* minimum for value */ 75 int maxLength; /* maximum for value */ 76 const char *desc; /* option description */ 77 int filterFlags; 78 } string_option_t; 79 80 /******** STRUCTURES **********/ 81 82 /*Defaults*/ 83 #define ISO_DEFAULT_VOLUMEID "MAKEFS_CD9660_IMAGE" 84 #define ISO_DEFAULT_APPID "MAKEFS" 85 #define ISO_DEFAULT_PUBLISHER "MAKEFS" 86 #define ISO_DEFAULT_PREPARER "MAKEFS" 87 88 #define ISO_VOLUME_DESCRIPTOR_STANDARD_ID "CD001" 89 #define ISO_VOLUME_DESCRIPTOR_BOOT 0 90 #define ISO_VOLUME_DESCRIPTOR_PVD 1 91 #define ISO_VOLUME_DESCRIPTOR_TERMINATOR 255 92 93 /*30 for name and extension, as well as version number and padding bit*/ 94 #define ISO_FILENAME_MAXLENGTH_BEFORE_VERSION 30 95 #define ISO_FILENAME_MAXLENGTH 36 96 #define ISO_FILENAME_MAXLENGTH_WITH_PADDING 37 97 98 #define ISO_FLAG_CLEAR 0x00 99 #define ISO_FLAG_HIDDEN 0x01 100 #define ISO_FLAG_DIRECTORY 0x02 101 #define ISO_FLAG_ASSOCIATED 0x04 102 #define ISO_FLAG_PERMISSIONS 0x08 103 #define ISO_FLAG_RESERVED5 0x10 104 #define ISO_FLAG_RESERVED6 0x20 105 #define ISO_FLAG_FINAL_RECORD 0x40 106 107 #define ISO_PATHTABLE_ENTRY_BASESIZE 8 108 109 #define ISO_RRIP_DEFAULT_MOVE_DIR_NAME "RR_MOVED" 110 #define RRIP_DEFAULT_MOVE_DIR_NAME ".rr_moved" 111 112 #define CD9660_BLOCKS(S,X) (((X) / S) + (((X)%S)?1:0)) 113 114 #define CD9660_MEM_ALLOC_ERROR(_F) \ 115 err(EXIT_FAILURE, "%s, %s l. %d", _F, __FILE__, __LINE__) 116 117 #define CD9660_IS_COMMAND_ARG_DUAL(var,short,long)\ 118 (strcmp((var),(short)) == 0) || (strcmp((var),(long))==0) 119 120 #define CD9660_IS_COMMAND_ARG(var,arg)\ 121 (strcmp((var),(arg)) == 0) 122 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 128 129 #define CD9660_HASH_SIZE 512 130 131 #define CD9660_END_PADDING 150 132 133 /* Slight modification of the ISO structure in iso.h */ 134 typedef struct _iso_directory_record_cd9660 { 135 u_char length [ISODCL (1, 1)]; /* 711 */ 136 u_char ext_attr_length [ISODCL (2, 2)]; /* 711 */ 137 u_char extent [ISODCL (3, 10)]; /* 733 */ 138 u_char size [ISODCL (11, 18)]; /* 733 */ 139 u_char date [ISODCL (19, 25)]; /* 7 by 711 */ 140 u_char flags [ISODCL (26, 26)]; 141 u_char file_unit_size [ISODCL (27, 27)]; /* 711 */ 142 u_char interleave [ISODCL (28, 28)]; /* 711 */ 143 u_char volume_sequence_number [ISODCL (29, 32)]; /* 723 */ 144 u_char name_len [ISODCL (33, 33)]; /* 711 */ 145 char name [ISO_FILENAME_MAXLENGTH_WITH_PADDING]; 146 } iso_directory_record_cd9660; 147 148 /* TODO: Lots of optimization of this structure */ 149 typedef struct _cd9660node { 150 u_char type;/* Used internally */ 151 /* Tree structure */ 152 struct _cd9660node *parent; /* parent (NULL if root) */ 153 TAILQ_HEAD(cd9660_children_head, _cd9660node) cn_children; 154 TAILQ_ENTRY(_cd9660node) cn_next_child; 155 156 struct _cd9660node *dot_record; /* For directories, used mainly in RRIP */ 157 struct _cd9660node *dot_dot_record; 158 159 fsnode *node; /* pointer to fsnode */ 160 struct _iso_directory_record_cd9660 *isoDirRecord; 161 struct iso_extended_attributes *isoExtAttributes; 162 163 /***** SIZE CALCULATION *****/ 164 /*already stored in isoDirRecord, but this is an int version, and will be 165 copied to isoDirRecord on writing*/ 166 int fileDataSector; 167 168 /* 169 * same thing, though some notes: 170 * If a file, this is the file size 171 * If a directory, this is the size of all its children's 172 * directory records 173 * plus necessary padding 174 */ 175 int64_t fileDataLength; 176 177 /* 178 * XXXfvdl sectors are int 179 */ 180 int fileSectorsUsed; 181 int fileRecordSize;/*copy of a variable, int for quicker calculations*/ 182 183 /* Old name, used for renaming - needs to be optimized but low priority */ 184 char o_name [ISO_FILENAME_MAXLENGTH_WITH_PADDING]; 185 186 /***** SPACE RESERVED FOR EXTENSIONS *****/ 187 /* For memory efficiency's sake - we should move this to a separate struct 188 and point to null if not needed */ 189 /* For Rock Ridge */ 190 struct _cd9660node *rr_real_parent, *rr_relocated; 191 192 int susp_entry_size; 193 int susp_dot_entry_size; 194 int susp_dot_dot_entry_size; 195 196 /* Continuation area stuff */ 197 int susp_entry_ce_start; 198 int susp_dot_ce_start; 199 int susp_dot_dot_ce_start; 200 201 int susp_entry_ce_length; 202 int susp_dot_ce_length; 203 int susp_dot_dot_ce_length; 204 205 /*** PATH TABLE STUFF ***/ 206 int level; /*depth*/ 207 int ptnumber; 208 struct _cd9660node *ptnext, *ptprev, *ptlast; 209 210 /* SUSP entries */ 211 TAILQ_HEAD(susp_linked_list, ISO_SUSP_ATTRIBUTES) head; 212 } cd9660node; 213 214 #if 0 215 struct cd9660hash_node { 216 cd9660node *thenode; 217 LIST_ENTRY(cd9660hash_node) ll_struct; 218 }; 219 220 struct cd9660hash_table { 221 LIST_HEAD(node_hash_table,cd9660_node_hash) node_hash[CD9660_HASH_SIZE]; 222 }; 223 #endif 224 225 typedef struct _path_table_entry 226 { 227 u_char length[ISODCL (1, 1)]; 228 u_char extended_attribute_length[ISODCL (2, 2)]; 229 u_char first_sector[ISODCL (3, 6)]; 230 u_char parent_number[ISODCL (7, 8)]; 231 u_char name[ISO_FILENAME_MAXLENGTH_WITH_PADDING]; 232 } path_table_entry; 233 234 typedef struct _volume_descriptor 235 { 236 u_char *volumeDescriptorData; /*ALWAYS 2048 bytes long*/ 237 int sector; 238 struct _volume_descriptor *next; 239 } volume_descriptor; 240 241 typedef struct _iso9660_disk { 242 int sectorSize; 243 struct iso_primary_descriptor primaryDescriptor; 244 struct iso_supplementary_descriptor supplementaryDescriptor; 245 246 volume_descriptor *firstVolumeDescriptor; 247 248 cd9660node *rootNode; 249 /*struct cd9660hash_table name_hash;*/ 250 251 const char *rootFilesystemPath; 252 253 /* Important sector numbers here */ 254 /* primaryDescriptor.type_l_path_table*/ 255 int primaryBigEndianTableSector; 256 257 /* primaryDescriptor.type_m_path_table*/ 258 int primaryLittleEndianTableSector; 259 260 /* primaryDescriptor.opt_type_l_path_table*/ 261 int secondaryBigEndianTableSector; 262 263 /* primaryDescriptor.opt_type_m_path_table*/ 264 int secondaryLittleEndianTableSector; 265 266 /* primaryDescriptor.path_table_size*/ 267 int pathTableLength; 268 int dataFirstSector; 269 270 int totalSectors; 271 /* OPTIONS GO HERE */ 272 int isoLevel; 273 274 int include_padding_areas; 275 276 int follow_sym_links; 277 int verbose_level; 278 int displayHelp; 279 int keep_bad_images; 280 281 /* SUSP options and variables */ 282 int susp_continuation_area_start_sector; 283 int susp_continuation_area_size; 284 int susp_continuation_area_current_free; 285 286 int rock_ridge_enabled; 287 /* Other Rock Ridge Variables */ 288 char *rock_ridge_renamed_dir_name; 289 int rock_ridge_move_count; 290 cd9660node *rr_moved_dir; 291 292 293 /* Spec breaking options */ 294 u_char allow_deep_trees; 295 u_char allow_start_dot; 296 u_char allow_max_name; /* Allow 37 char filenames*/ 297 u_char allow_illegal_chars; /* ~, !, # */ 298 u_char allow_lowercase; 299 u_char allow_multidot; 300 u_char omit_trailing_period; 301 302 /* BOOT INFORMATION HERE */ 303 int is_bootable;/* Default to 0 */ 304 int boot_catalog_sector; 305 boot_volume_descriptor *boot_descriptor; 306 char * boot_image_directory; 307 308 LIST_HEAD(boot_image_list,cd9660_boot_image) boot_images; 309 LIST_HEAD(boot_catalog_entries,boot_catalog_entry) boot_entries; 310 311 } iso9660_disk; 312 313 /******** GLOBAL VARIABLES ***********/ 314 extern iso9660_disk diskStructure; 315 316 /************ FUNCTIONS **************/ 317 int cd9660_valid_a_chars(const char *); 318 int cd9660_valid_d_chars(const char *); 319 void cd9660_uppercase_characters(char *, int); 320 321 /* ISO Data Types */ 322 void cd9660_721(uint16_t, unsigned char *); 323 void cd9660_731(uint32_t, unsigned char *); 324 void cd9660_722(uint16_t, unsigned char *); 325 void cd9660_732(uint32_t, unsigned char *); 326 void cd9660_bothendian_dword(uint32_t dw, unsigned char *); 327 void cd9660_bothendian_word(uint16_t dw, unsigned char *); 328 void cd9660_set_date(char *, time_t); 329 void cd9660_time_8426(unsigned char *, time_t); 330 void cd9660_time_915(unsigned char *, time_t); 331 332 /*** Boot Functions ***/ 333 int cd9660_write_boot(FILE *); 334 int cd9660_add_boot_disk(const char *); 335 int cd9660_eltorito_add_boot_option(const char *, const char *); 336 int cd9660_setup_boot(int); 337 int cd9660_setup_boot_volume_descritpor(volume_descriptor *); 338 339 340 /*** Write Functions ***/ 341 int cd9660_write_image(const char *image); 342 int cd9660_copy_file(FILE *, int, const char *); 343 344 void cd9660_compute_full_filename(cd9660node *, char *, int); 345 int cd9660_compute_record_size(cd9660node *); 346 347 /* Debugging functions */ 348 void debug_print_tree(cd9660node *,int); 349 void debug_print_path_tree(cd9660node *); 350 void debug_print_volume_descriptor_information(void); 351 void debug_dump_to_xml_ptentry(path_table_entry *,int, int); 352 void debug_dump_to_xml_path_table(FILE *, int, int, int); 353 void debug_dump_to_xml(FILE *); 354 int debug_get_encoded_number(unsigned char *, int); 355 void debug_dump_integer(const char *, char *,int); 356 void debug_dump_string(const char *,unsigned char *,int); 357 void debug_dump_directory_record_9_1(unsigned char *); 358 void debug_dump_to_xml_volume_descriptor(unsigned char *,int); 359 360 void cd9660_pad_string_spaces(char *, int); 361 362 #endif 363
Indexes created Thu Sep 25 08:09:54 GMT 2025