usr.sbin/makefs/cd9660.h

   1 /*      $NetBSD: cd9660.h,v 1.12 2008/07/27 10:29:32 reinoud 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 "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
 137 #define CD9660_END_PADDING 150
 138
 139 /* Slight modification of the ISO structure in iso.h */
 140 typedef struct _iso_directory_record_cd9660 {
 141         u_char length                   [ISODCL (1, 1)];        /* 711 */
 142         u_char ext_attr_length          [ISODCL (2, 2)];        /* 711 */
 143         u_char extent                   [ISODCL (3, 10)];       /* 733 */
 144         u_char size                     [ISODCL (11, 18)];      /* 733 */
 145         u_char date                     [ISODCL (19, 25)];      /* 7 by 711 */
 146         u_char flags                    [ISODCL (26, 26)];
 147         u_char file_unit_size           [ISODCL (27, 27)];      /* 711 */
 148         u_char interleave               [ISODCL (28, 28)];      /* 711 */
 149         u_char volume_sequence_number   [ISODCL (29, 32)];      /* 723 */
 150         u_char name_len                 [ISODCL (33, 33)];      /* 711 */
 151         char name                       [ISO_FILENAME_MAXLENGTH_WITH_PADDING];
 152 } iso_directory_record_cd9660;
 153
 154 /* TODO: Lots of optimization of this structure */
 155 typedef struct _cd9660node {
 156         u_char  type;/* Used internally */
 157         /* Tree structure */
 158         struct _cd9660node      *parent;        /* parent (NULL if root) */
 159         TAILQ_HEAD(cd9660_children_head, _cd9660node)   cn_children;
 160         TAILQ_ENTRY(_cd9660node)                cn_next_child;
 161
 162         struct _cd9660node *dot_record; /* For directories, used mainly in RRIP */
 163         struct _cd9660node *dot_dot_record;
 164
 165         fsnode          *node;          /* pointer to fsnode */
 166         struct _iso_directory_record_cd9660     *isoDirRecord;
 167         struct iso_extended_attributes  *isoExtAttributes;
 168
 169         /***** SIZE CALCULATION *****/
 170         /*already stored in isoDirRecord, but this is an int version, and will be
 171                 copied to isoDirRecord on writing*/
 172         uint32_t fileDataSector;
 173
 174         /*
 175          * same thing, though some notes:
 176          * If a file, this is the file size
 177          * If a directory, this is the size of all its children's
 178          *      directory records
 179          * plus necessary padding
 180          */
 181         int64_t fileDataLength;
 182
 183         /*
 184          * XXXfvdl sectors are int
 185          */
 186         int fileSectorsUsed;
 187         int fileRecordSize;/*copy of a variable, int for quicker calculations*/
 188
 189         /* Old name, used for renaming - needs to be optimized but low priority */
 190         char o_name [ISO_FILENAME_MAXLENGTH_WITH_PADDING];
 191
 192         /***** SPACE RESERVED FOR EXTENSIONS *****/
 193         /* For memory efficiency's sake - we should move this to a separate struct
 194                 and point to null if not needed */
 195         /* For Rock Ridge */
 196         struct _cd9660node *rr_real_parent, *rr_relocated;
 197
 198         int susp_entry_size;
 199         int susp_dot_entry_size;
 200         int susp_dot_dot_entry_size;
 201
 202         /* Continuation area stuff */
 203         int susp_entry_ce_start;
 204         int susp_dot_ce_start;
 205         int susp_dot_dot_ce_start;
 206
 207         int susp_entry_ce_length;
 208         int susp_dot_ce_length;
 209         int susp_dot_dot_ce_length;
 210
 211         /* Data to put at the end of the System Use field */
 212         int su_tail_size;
 213         char *su_tail_data;
 214
 215         /*** PATH TABLE STUFF ***/
 216         int level;                      /*depth*/
 217         int ptnumber;
 218         struct _cd9660node *ptnext, *ptprev, *ptlast;
 219
 220         /* SUSP entries */
 221         TAILQ_HEAD(susp_linked_list, ISO_SUSP_ATTRIBUTES) head;
 222 } cd9660node;
 223
 224 typedef struct _path_table_entry
 225 {
 226         u_char length[ISODCL (1, 1)];
 227         u_char extended_attribute_length[ISODCL (2, 2)];
 228         u_char first_sector[ISODCL (3, 6)];
 229         u_char parent_number[ISODCL (7, 8)];
 230         u_char name[ISO_FILENAME_MAXLENGTH_WITH_PADDING];
 231 } path_table_entry;
 232
 233 typedef struct _volume_descriptor
 234 {
 235         u_char *volumeDescriptorData; /*ALWAYS 2048 bytes long*/
 236         int sector;
 237         struct _volume_descriptor *next;
 238 } volume_descriptor;
 239
 240 typedef struct _iso9660_disk {
 241         int sectorSize;
 242         struct iso_primary_descriptor           primaryDescriptor;
 243         struct iso_supplementary_descriptor     supplementaryDescriptor;
 244
 245         volume_descriptor *firstVolumeDescriptor;
 246
 247         cd9660node *rootNode;
 248
 249         const char *rootFilesystemPath;
 250
 251         /* Important sector numbers here */
 252         /* primaryDescriptor.type_l_path_table*/
 253         int primaryBigEndianTableSector;
 254
 255         /* primaryDescriptor.type_m_path_table*/
 256         int primaryLittleEndianTableSector;
 257
 258         /* primaryDescriptor.opt_type_l_path_table*/
 259         int secondaryBigEndianTableSector;
 260
 261         /* primaryDescriptor.opt_type_m_path_table*/
 262         int secondaryLittleEndianTableSector;
 263
 264         /* primaryDescriptor.path_table_size*/
 265         int pathTableLength;
 266         int dataFirstSector;
 267
 268         int totalSectors;
 269         /* OPTIONS GO HERE */
 270         int     isoLevel;
 271
 272         int include_padding_areas;
 273
 274         int follow_sym_links;
 275         int verbose_level;
 276         int displayHelp;
 277         int keep_bad_images;
 278
 279         /* SUSP options and variables */
 280         int susp_continuation_area_start_sector;
 281         int susp_continuation_area_size;
 282         int susp_continuation_area_current_free;
 283
 284         int rock_ridge_enabled;
 285         /* Other Rock Ridge Variables */
 286         char *rock_ridge_renamed_dir_name;
 287         int rock_ridge_move_count;
 288         cd9660node *rr_moved_dir;
 289
 290         int archimedes_enabled;
 291
 292         /* Spec breaking options */
 293         u_char allow_deep_trees;
 294         u_char allow_start_dot;
 295         u_char allow_max_name; /* Allow 37 char filenames*/
 296         u_char allow_illegal_chars; /* ~, !, # */
 297         u_char allow_lowercase;
 298         u_char allow_multidot;
 299         u_char omit_trailing_period;
 300
 301         /* BOOT INFORMATION HERE */
 302         int has_generic_bootimage; /* Default to 0 */
 303         char *generic_bootimage;
 304
 305         int is_bootable;/* Default to 0 */
 306         int boot_catalog_sector;
 307         boot_volume_descriptor *boot_descriptor;
 308         char * boot_image_directory;
 309
 310         TAILQ_HEAD(boot_image_list,cd9660_boot_image) boot_images;
 311         int image_serialno;
 312         LIST_HEAD(boot_catalog_entries,boot_catalog_entry) boot_entries;
 313
 314 } iso9660_disk;
 315
 316 /******** GLOBAL VARIABLES ***********/
 317 extern iso9660_disk diskStructure;
 318
 319 /************ FUNCTIONS **************/
 320 int                     cd9660_valid_a_chars(const char *);
 321 int                     cd9660_valid_d_chars(const char *);
 322 void                    cd9660_uppercase_characters(char *, int);
 323
 324 /* ISO Data Types */
 325 void                    cd9660_721(uint16_t, unsigned char *);
 326 void                    cd9660_731(uint32_t, unsigned char *);
 327 void                    cd9660_722(uint16_t, unsigned char *);
 328 void                    cd9660_732(uint32_t, unsigned char *);
 329 void                    cd9660_bothendian_dword(uint32_t dw, unsigned char *);
 330 void                    cd9660_bothendian_word(uint16_t dw, unsigned char *);
 331 void                    cd9660_set_date(char *, time_t);
 332 void                    cd9660_time_8426(unsigned char *, time_t);
 333 void                    cd9660_time_915(unsigned char *, time_t);
 334
 335 /*** Boot Functions ***/
 336 int     cd9660_write_generic_bootimage(FILE *);
 337 int     cd9660_add_generic_bootimage(const char *);
 338 int     cd9660_write_boot(FILE *);
 339 int     cd9660_add_boot_disk(const char *);
 340 int     cd9660_eltorito_add_boot_option(const char *, const char *);
 341 int     cd9660_setup_boot(int);
 342 int     cd9660_setup_boot_volume_descriptor(volume_descriptor *);
 343
 344
 345 /*** Write Functions ***/
 346 int     cd9660_write_image(const char *image);
 347 int     cd9660_copy_file(FILE *, int, const char *);
 348
 349 void    cd9660_compute_full_filename(cd9660node *, char *, int);
 350 int     cd9660_compute_record_size(cd9660node *);
 351
 352 /* Debugging functions */
 353 void    debug_print_tree(cd9660node *,int);
 354 void    debug_print_path_tree(cd9660node *);
 355 void    debug_print_volume_descriptor_information(void);
 356 void    debug_dump_to_xml_ptentry(path_table_entry *,int, int);
 357 void    debug_dump_to_xml_path_table(FILE *, int, int, int);
 358 void    debug_dump_to_xml(FILE *);
 359 int     debug_get_encoded_number(unsigned char *, int);
 360 void    debug_dump_integer(const char *, char *,int);
 361 void    debug_dump_string(const char *,unsigned char *,int);
 362 void    debug_dump_directory_record_9_1(unsigned char *);
 363 void    debug_dump_to_xml_volume_descriptor(unsigned char *,int);
 364
 365 void    cd9660_pad_string_spaces(char *, int);
 366
 367 #endif