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