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