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 * $FreeBSD$ 37 */ 38 39 #ifndef _MAKEFS_CD9660_H 40 #define _MAKEFS_CD9660_H 41 42 #include <inttypes.h> 43 #include <assert.h> 44 #include <errno.h> 45 #include <fcntl.h> 46 #include <stdarg.h> 47 #include <stdio.h> 48 #include <stdlib.h> 49 #include <string.h> 50 #include <unistd.h> 51 #include <time.h> 52 #include <limits.h> 53 #include <sys/queue.h> 54 #include <sys/param.h> 55 #include <sys/endian.h> 56 57 #include "makefs.h" 58 #include "iso.h" 59 #include "iso_rrip.h" 60 #include "cd9660/cd9660_eltorito.h" 61 62 #ifdef DEBUG 63 #define INODE_WARNX(__x) warnx __x 64 #else /* DEBUG */ 65 #define INODE_WARNX(__x) 66 #endif /* DEBUG */ 67 68 /******** STRUCTURES **********/ 69 70 #define ISO_VOLUME_DESCRIPTOR_STANDARD_ID "CD001" 71 #define ISO_VOLUME_DESCRIPTOR_BOOT 0 72 #define ISO_VOLUME_DESCRIPTOR_PVD 1 73 #define ISO_VOLUME_DESCRIPTOR_TERMINATOR 255 74 75 /*30 for name and extension, as well as version number and padding bit*/ 76 #define ISO_FILENAME_MAXLENGTH_BEFORE_VERSION 30 77 #define ISO_FILENAME_MAXLENGTH 36 78 #define ISO_FILENAME_MAXLENGTH_WITH_PADDING 37 79 80 #define ISO_FLAG_CLEAR 0x00 81 #define ISO_FLAG_HIDDEN 0x01 82 #define ISO_FLAG_DIRECTORY 0x02 83 #define ISO_FLAG_ASSOCIATED 0x04 84 #define ISO_FLAG_PERMISSIONS 0x08 85 #define ISO_FLAG_RESERVED5 0x10 86 #define ISO_FLAG_RESERVED6 0x20 87 #define ISO_FLAG_FINAL_RECORD 0x40 88 89 #define ISO_PATHTABLE_ENTRY_BASESIZE 8 90 91 #define ISO_RRIP_DEFAULT_MOVE_DIR_NAME "RR_MOVED" 92 #define RRIP_DEFAULT_MOVE_DIR_NAME ".rr_moved" 93 94 #define CD9660_BLOCKS(__sector_size, __bytes) \ 95 howmany((__bytes), (__sector_size)) 96 97 #define CD9660_MEM_ALLOC_ERROR(_F) \ 98 err(EXIT_FAILURE, "%s, %s l. %d", _F, __FILE__, __LINE__) 99 100 #define CD9660_TYPE_FILE 0x01 101 #define CD9660_TYPE_DIR 0x02 102 #define CD9660_TYPE_DOT 0x04 103 #define CD9660_TYPE_DOTDOT 0x08 104 #define CD9660_TYPE_VIRTUAL 0x80 105 106 #define CD9660_INODE_HASH_SIZE 1024 107 #define CD9660_SECTOR_SIZE 2048 108 109 #define CD9660_END_PADDING 150 110 111 /* Slight modification of the ISO structure in iso.h */ 112 typedef struct _iso_directory_record_cd9660 { 113 u_char length [ISODCL (1, 1)]; /* 711 */ 114 u_char ext_attr_length [ISODCL (2, 2)]; /* 711 */ 115 u_char extent [ISODCL (3, 10)]; /* 733 */ 116 u_char size [ISODCL (11, 18)]; /* 733 */ 117 u_char date [ISODCL (19, 25)]; /* 7 by 711 */ 118 u_char flags [ISODCL (26, 26)]; 119 u_char file_unit_size [ISODCL (27, 27)]; /* 711 */ 120 u_char interleave [ISODCL (28, 28)]; /* 711 */ 121 u_char volume_sequence_number [ISODCL (29, 32)]; /* 723 */ 122 u_char name_len [ISODCL (33, 33)]; /* 711 */ 123 char name [ISO_FILENAME_MAXLENGTH_WITH_PADDING]; 124 } iso_directory_record_cd9660; 125 126 /* TODO: Lots of optimization of this structure */ 127 typedef struct _cd9660node { 128 u_char type;/* Used internally */ 129 /* Tree structure */ 130 struct _cd9660node *parent; /* parent (NULL if root) */ 131 TAILQ_HEAD(cd9660_children_head, _cd9660node) cn_children; 132 TAILQ_ENTRY(_cd9660node) cn_next_child; 133 134 struct _cd9660node *dot_record; /* For directories, used mainly in RRIP */ 135 struct _cd9660node *dot_dot_record; 136 137 fsnode *node; /* pointer to fsnode */ 138 struct _iso_directory_record_cd9660 *isoDirRecord; 139 struct iso_extended_attributes *isoExtAttributes; 140 141 /***** SIZE CALCULATION *****/ 142 /*already stored in isoDirRecord, but this is an int version, and will be 143 copied to isoDirRecord on writing*/ 144 uint32_t fileDataSector; 145 146 /* 147 * same thing, though some notes: 148 * If a file, this is the file size 149 * If a directory, this is the size of all its children's 150 * directory records 151 * plus necessary padding 152 */ 153 int64_t fileDataLength; 154 155 int64_t fileSectorsUsed; 156 int fileRecordSize;/*copy of a variable, int for quicker calculations*/ 157 158 /* Old name, used for renaming - needs to be optimized but low priority */ 159 char o_name [ISO_FILENAME_MAXLENGTH_WITH_PADDING]; 160 161 /***** SPACE RESERVED FOR EXTENSIONS *****/ 162 /* For memory efficiency's sake - we should move this to a separate struct 163 and point to null if not needed */ 164 /* For Rock Ridge */ 165 struct _cd9660node *rr_real_parent, *rr_relocated; 166 167 int64_t susp_entry_size; 168 int64_t susp_dot_entry_size; 169 int64_t susp_dot_dot_entry_size; 170 171 /* Continuation area stuff */ 172 int64_t susp_entry_ce_start; 173 int64_t susp_dot_ce_start; 174 int64_t susp_dot_dot_ce_start; 175 176 int64_t susp_entry_ce_length; 177 int64_t susp_dot_ce_length; 178 int64_t susp_dot_dot_ce_length; 179 180 /* Data to put at the end of the System Use field */ 181 int64_t su_tail_size; 182 char *su_tail_data; 183 184 /*** PATH TABLE STUFF ***/ 185 int level; /*depth*/ 186 int ptnumber; 187 struct _cd9660node *ptnext, *ptprev, *ptlast; 188 189 /* SUSP entries */ 190 TAILQ_HEAD(susp_linked_list, ISO_SUSP_ATTRIBUTES) head; 191 } cd9660node; 192 193 typedef struct _path_table_entry 194 { 195 u_char length[ISODCL (1, 1)]; 196 u_char extended_attribute_length[ISODCL (2, 2)]; 197 u_char first_sector[ISODCL (3, 6)]; 198 u_char parent_number[ISODCL (7, 8)]; 199 char name[ISO_FILENAME_MAXLENGTH_WITH_PADDING]; 200 } path_table_entry; 201 202 typedef struct _volume_descriptor 203 { 204 u_char *volumeDescriptorData; /*ALWAYS 2048 bytes long*/ 205 int64_t sector; 206 struct _volume_descriptor *next; 207 } volume_descriptor; 208 209 typedef struct _iso9660_disk { 210 int sectorSize; 211 struct iso_primary_descriptor primaryDescriptor; 212 struct iso_supplementary_descriptor supplementaryDescriptor; 213 214 volume_descriptor *firstVolumeDescriptor; 215 216 cd9660node *rootNode; 217 218 /* Important sector numbers here */ 219 /* primaryDescriptor.type_l_path_table*/ 220 int64_t primaryBigEndianTableSector; 221 222 /* primaryDescriptor.type_m_path_table*/ 223 int64_t primaryLittleEndianTableSector; 224 225 /* primaryDescriptor.opt_type_l_path_table*/ 226 int64_t secondaryBigEndianTableSector; 227 228 /* primaryDescriptor.opt_type_m_path_table*/ 229 int64_t secondaryLittleEndianTableSector; 230 231 /* primaryDescriptor.path_table_size*/ 232 int pathTableLength; 233 int64_t dataFirstSector; 234 235 int64_t totalSectors; 236 /* OPTIONS GO HERE */ 237 int isoLevel; 238 239 int include_padding_areas; 240 241 int verbose_level; 242 int keep_bad_images; 243 244 /* SUSP options and variables */ 245 int64_t susp_continuation_area_start_sector; 246 int64_t susp_continuation_area_size; 247 int64_t susp_continuation_area_current_free; 248 249 int rock_ridge_enabled; 250 /* Other Rock Ridge Variables */ 251 char *rock_ridge_renamed_dir_name; 252 unsigned rock_ridge_move_count; 253 cd9660node *rr_moved_dir; 254 255 int archimedes_enabled; 256 int chrp_boot; 257 258 /* Spec breaking options */ 259 u_char allow_deep_trees; 260 u_char allow_start_dot; 261 u_char allow_max_name; /* Allow 37 char filenames*/ 262 u_char allow_illegal_chars; /* ~, !, # */ 263 u_char allow_lowercase; 264 u_char allow_multidot; 265 u_char omit_trailing_period; 266 267 /* BOOT INFORMATION HERE */ 268 int has_generic_bootimage; /* Default to 0 */ 269 char *generic_bootimage; 270 271 int is_bootable;/* Default to 0 */ 272 int64_t boot_catalog_sector; 273 boot_volume_descriptor *boot_descriptor; 274 char * boot_image_directory; 275 276 TAILQ_HEAD(boot_image_list,cd9660_boot_image) boot_images; 277 int image_serialno; 278 LIST_HEAD(boot_catalog_entries,boot_catalog_entry) boot_entries; 279 280 } iso9660_disk; 281 282 /************ FUNCTIONS **************/ 283 int cd9660_valid_a_chars(const char *); 284 int cd9660_valid_d_chars(const char *); 285 void cd9660_uppercase_characters(char *, size_t); 286 287 /* ISO Data Types */ 288 void cd9660_721(uint16_t, unsigned char *); 289 void cd9660_731(uint32_t, unsigned char *); 290 void cd9660_722(uint16_t, unsigned char *); 291 void cd9660_732(uint32_t, unsigned char *); 292 void cd9660_bothendian_dword(uint32_t dw, unsigned char *); 293 void cd9660_bothendian_word(uint16_t dw, unsigned char *); 294 void cd9660_set_date(char *, time_t); 295 void cd9660_time_8426(unsigned char *, time_t); 296 void cd9660_time_915(unsigned char *, time_t); 297 298 /*** Boot Functions ***/ 299 int cd9660_write_generic_bootimage(FILE *); 300 int cd9660_write_boot(iso9660_disk *, FILE *); 301 int cd9660_add_boot_disk(iso9660_disk *, const char *); 302 int cd9660_eltorito_add_boot_option(iso9660_disk *, const char *, 303 const char *); 304 int cd9660_setup_boot(iso9660_disk *, int); 305 int cd9660_setup_boot_volume_descriptor(iso9660_disk *, 306 volume_descriptor *); 307 308 309 /*** Write Functions ***/ 310 int cd9660_write_image(iso9660_disk *, const char *image); 311 int cd9660_copy_file(iso9660_disk *, FILE *, off_t, const char *); 312 313 void cd9660_compute_full_filename(cd9660node *, char *); 314 int cd9660_compute_record_size(iso9660_disk *, cd9660node *); 315 316 /* Debugging functions */ 317 void debug_print_tree(iso9660_disk *, cd9660node *,int); 318 void debug_print_path_tree(cd9660node *); 319 void debug_print_volume_descriptor_information(iso9660_disk *); 320 void debug_dump_to_xml_ptentry(path_table_entry *,int, int); 321 void debug_dump_to_xml_path_table(FILE *, off_t, int, int); 322 void debug_dump_to_xml(FILE *); 323 int debug_get_encoded_number(const unsigned char *, int); 324 void debug_dump_integer(const char *, const unsigned char *, int); 325 void debug_dump_string(const char *, const unsigned char *, int); 326 void debug_dump_directory_record_9_1(unsigned char *); 327 void debug_dump_to_xml_volume_descriptor(unsigned char *,int); 328 329 void cd9660_pad_string_spaces(char *, int); 330 331 #endif 332