1 /* $NetBSD: cd9660.h,v 1.17 2011/06/23 02:35:56 enami 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 * $FreeBSD$ 35 */ 36 37 #ifndef _MAKEFS_CD9660_H 38 #define _MAKEFS_CD9660_H 39 40 #include <inttypes.h> 41 #include <assert.h> 42 #include <errno.h> 43 #include <fcntl.h> 44 #include <stdarg.h> 45 #include <stdio.h> 46 #include <stdlib.h> 47 #include <string.h> 48 #include <unistd.h> 49 #include <time.h> 50 #include <limits.h> 51 #include <sys/queue.h> 52 #include <sys/param.h> 53 #include <sys/endian.h> 54 55 #include "makefs.h" 56 #include "iso.h" 57 #include "iso_rrip.h" 58 #include "cd9660/cd9660_eltorito.h" 59 60 #ifdef DEBUG 61 #define INODE_WARNX(__x) warnx __x 62 #else /* DEBUG */ 63 #define INODE_WARNX(__x) 64 #endif /* DEBUG */ 65 66 #define CD9660MAXPATH 4096 67 68 #define ISO_STRING_FILTER_NONE = 0x00 69 #define ISO_STRING_FILTER_DCHARS = 0x01 70 #define ISO_STRING_FILTER_ACHARS = 0x02 71 72 /* 73 Extended preferences type, in the spirit of what makefs gives us (only ints) 74 */ 75 typedef struct { 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 */ 82 int filterFlags; 83 } string_option_t; 84 85 /******** STRUCTURES **********/ 86 87 /*Defaults*/ 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" 92 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 97 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 102 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 111 112 #define ISO_PATHTABLE_ENTRY_BASESIZE 8 113 114 #define ISO_RRIP_DEFAULT_MOVE_DIR_NAME "RR_MOVED" 115 #define RRIP_DEFAULT_MOVE_DIR_NAME ".rr_moved" 116 117 #define CD9660_BLOCKS(__sector_size, __bytes) \ 118 howmany((__bytes), (__sector_size)) 119 120 #define CD9660_MEM_ALLOC_ERROR(_F) \ 121 err(EXIT_FAILURE, "%s, %s l. %d", _F, __FILE__, __LINE__) 122 123 #define CD9660_IS_COMMAND_ARG_DUAL(var,short,long)\ 124 (strcmp((var),(short)) == 0) || (strcmp((var),(long))==0) 125 126 #define CD9660_IS_COMMAND_ARG(var,arg)\ 127 (strcmp((var),(arg)) == 0) 128 129 #define CD9660_TYPE_FILE 0x01 130 #define CD9660_TYPE_DIR 0x02 131 #define CD9660_TYPE_DOT 0x04 132 #define CD9660_TYPE_DOTDOT 0x08 133 #define CD9660_TYPE_VIRTUAL 0x80 134 135 #define CD9660_INODE_HASH_SIZE 1024 136 #define CD9660_SECTOR_SIZE 2048 137 138 #define CD9660_END_PADDING 150 139 140 /* Slight modification of the ISO structure in iso.h */ 141 typedef struct _iso_directory_record_cd9660 { 142 u_char length [ISODCL (1, 1)]; /* 711 */ 143 u_char ext_attr_length [ISODCL (2, 2)]; /* 711 */ 144 u_char extent [ISODCL (3, 10)]; /* 733 */ 145 u_char size [ISODCL (11, 18)]; /* 733 */ 146 u_char date [ISODCL (19, 25)]; /* 7 by 711 */ 147 u_char flags [ISODCL (26, 26)]; 148 u_char file_unit_size [ISODCL (27, 27)]; /* 711 */ 149 u_char interleave [ISODCL (28, 28)]; /* 711 */ 150 u_char volume_sequence_number [ISODCL (29, 32)]; /* 723 */ 151 u_char name_len [ISODCL (33, 33)]; /* 711 */ 152 char name [ISO_FILENAME_MAXLENGTH_WITH_PADDING]; 153 } iso_directory_record_cd9660; 154 155 /* TODO: Lots of optimization of this structure */ 156 typedef struct _cd9660node { 157 u_char type;/* Used internally */ 158 /* Tree structure */ 159 struct _cd9660node *parent; /* parent (NULL if root) */ 160 TAILQ_HEAD(cd9660_children_head, _cd9660node) cn_children; 161 TAILQ_ENTRY(_cd9660node) cn_next_child; 162 163 struct _cd9660node *dot_record; /* For directories, used mainly in RRIP */ 164 struct _cd9660node *dot_dot_record; 165 166 fsnode *node; /* pointer to fsnode */ 167 struct _iso_directory_record_cd9660 *isoDirRecord; 168 struct iso_extended_attributes *isoExtAttributes; 169 170 /***** SIZE CALCULATION *****/ 171 /*already stored in isoDirRecord, but this is an int version, and will be 172 copied to isoDirRecord on writing*/ 173 uint32_t fileDataSector; 174 175 /* 176 * same thing, though some notes: 177 * If a file, this is the file size 178 * If a directory, this is the size of all its children's 179 * directory records 180 * plus necessary padding 181 */ 182 int64_t fileDataLength; 183 184 int64_t fileSectorsUsed; 185 int fileRecordSize;/*copy of a variable, int for quicker calculations*/ 186 187 /* Old name, used for renaming - needs to be optimized but low priority */ 188 char o_name [ISO_FILENAME_MAXLENGTH_WITH_PADDING]; 189 190 /***** SPACE RESERVED FOR EXTENSIONS *****/ 191 /* For memory efficiency's sake - we should move this to a separate struct 192 and point to null if not needed */ 193 /* For Rock Ridge */ 194 struct _cd9660node *rr_real_parent, *rr_relocated; 195 196 int64_t susp_entry_size; 197 int64_t susp_dot_entry_size; 198 int64_t susp_dot_dot_entry_size; 199 200 /* Continuation area stuff */ 201 int64_t susp_entry_ce_start; 202 int64_t susp_dot_ce_start; 203 int64_t susp_dot_dot_ce_start; 204 205 int64_t susp_entry_ce_length; 206 int64_t susp_dot_ce_length; 207 int64_t susp_dot_dot_ce_length; 208 209 /* Data to put at the end of the System Use field */ 210 int64_t su_tail_size; 211 char *su_tail_data; 212 213 /*** PATH TABLE STUFF ***/ 214 int level; /*depth*/ 215 int ptnumber; 216 struct _cd9660node *ptnext, *ptprev, *ptlast; 217 218 /* SUSP entries */ 219 TAILQ_HEAD(susp_linked_list, ISO_SUSP_ATTRIBUTES) head; 220 } cd9660node; 221 222 typedef struct _path_table_entry 223 { 224 u_char length[ISODCL (1, 1)]; 225 u_char extended_attribute_length[ISODCL (2, 2)]; 226 u_char first_sector[ISODCL (3, 6)]; 227 u_char parent_number[ISODCL (7, 8)]; 228 u_char name[ISO_FILENAME_MAXLENGTH_WITH_PADDING]; 229 } path_table_entry; 230 231 typedef struct _volume_descriptor 232 { 233 u_char *volumeDescriptorData; /*ALWAYS 2048 bytes long*/ 234 int64_t sector; 235 struct _volume_descriptor *next; 236 } volume_descriptor; 237 238 typedef struct _iso9660_disk { 239 int sectorSize; 240 struct iso_primary_descriptor primaryDescriptor; 241 struct iso_supplementary_descriptor supplementaryDescriptor; 242 243 volume_descriptor *firstVolumeDescriptor; 244 245 cd9660node *rootNode; 246 247 /* Important sector numbers here */ 248 /* primaryDescriptor.type_l_path_table*/ 249 int64_t primaryBigEndianTableSector; 250 251 /* primaryDescriptor.type_m_path_table*/ 252 int64_t primaryLittleEndianTableSector; 253 254 /* primaryDescriptor.opt_type_l_path_table*/ 255 int64_t secondaryBigEndianTableSector; 256 257 /* primaryDescriptor.opt_type_m_path_table*/ 258 int64_t secondaryLittleEndianTableSector; 259 260 /* primaryDescriptor.path_table_size*/ 261 int pathTableLength; 262 int64_t dataFirstSector; 263 264 int64_t totalSectors; 265 /* OPTIONS GO HERE */ 266 int isoLevel; 267 268 int include_padding_areas; 269 270 int follow_sym_links; 271 int verbose_level; 272 int displayHelp; 273 int keep_bad_images; 274 275 /* SUSP options and variables */ 276 int64_t susp_continuation_area_start_sector; 277 int64_t susp_continuation_area_size; 278 int64_t susp_continuation_area_current_free; 279 280 int rock_ridge_enabled; 281 /* Other Rock Ridge Variables */ 282 char *rock_ridge_renamed_dir_name; 283 int rock_ridge_move_count; 284 cd9660node *rr_moved_dir; 285 286 int archimedes_enabled; 287 int chrp_boot; 288 289 /* Spec breaking options */ 290 u_char allow_deep_trees; 291 u_char allow_start_dot; 292 u_char allow_max_name; /* Allow 37 char filenames*/ 293 u_char allow_illegal_chars; /* ~, !, # */ 294 u_char allow_lowercase; 295 u_char allow_multidot; 296 u_char omit_trailing_period; 297 298 /* BOOT INFORMATION HERE */ 299 int has_generic_bootimage; /* Default to 0 */ 300 char *generic_bootimage; 301 302 int is_bootable;/* Default to 0 */ 303 int64_t boot_catalog_sector; 304 boot_volume_descriptor *boot_descriptor; 305 char * boot_image_directory; 306 307 TAILQ_HEAD(boot_image_list,cd9660_boot_image) boot_images; 308 int image_serialno; 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_generic_bootimage(FILE *); 334 int cd9660_add_generic_bootimage(const char *); 335 int cd9660_write_boot(FILE *); 336 int cd9660_add_boot_disk(const char *); 337 int cd9660_eltorito_add_boot_option(const char *, const char *); 338 int cd9660_setup_boot(int); 339 int cd9660_setup_boot_volume_descriptor(volume_descriptor *); 340 341 342 /*** Write Functions ***/ 343 int cd9660_write_image(const char *image); 344 int cd9660_copy_file(FILE *, off_t, const char *); 345 346 void cd9660_compute_full_filename(cd9660node *, char *); 347 int cd9660_compute_record_size(cd9660node *); 348 349 /* Debugging functions */ 350 void debug_print_tree(cd9660node *,int); 351 void debug_print_path_tree(cd9660node *); 352 void debug_print_volume_descriptor_information(void); 353 void debug_dump_to_xml_ptentry(path_table_entry *,int, int); 354 void debug_dump_to_xml_path_table(FILE *, off_t, int, int); 355 void debug_dump_to_xml(FILE *); 356 int debug_get_encoded_number(unsigned char *, int); 357 void debug_dump_integer(const char *, char *,int); 358 void debug_dump_string(const char *,unsigned char *,int); 359 void debug_dump_directory_record_9_1(unsigned char *); 360 void debug_dump_to_xml_volume_descriptor(unsigned char *,int); 361 362 void cd9660_pad_string_spaces(char *, int); 363 364 #endif 365