1 /* $NetBSD: cd9660_debug.c,v 1.11 2010/10/27 18:51:35 christos 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 #if HAVE_NBTOOL_CONFIG_H 36 #include "nbtool_config.h" 37 #endif 38 39 #include <sys/cdefs.h> 40 #include <sys/param.h> 41 42 #if defined(__RCSID) && !defined(__lint) 43 __RCSID("$NetBSD: cd9660_debug.c,v 1.11 2010/10/27 18:51:35 christos Exp $"); 44 #endif /* !__lint */ 45 46 #if !HAVE_NBTOOL_CONFIG_H 47 #include <sys/mount.h> 48 #endif 49 50 #include "makefs.h" 51 #include "cd9660.h" 52 #include "iso9660_rrip.h" 53 54 static void debug_print_susp_attrs(cd9660node *, int); 55 static void debug_dump_to_xml_padded_hex_output(const char *, unsigned char *, 56 int); 57 58 static inline void 59 print_n_tabs(int n) 60 { 61 int i; 62 63 for (i = 1; i <= n; i ++) 64 printf("\t"); 65 } 66 67 #if 0 68 void 69 debug_print_rrip_info(n) 70 cd9660node *n; 71 { 72 struct ISO_SUSP_ATTRIBUTES *t; 73 TAILQ_FOREACH(t, &node->head, rr_ll) { 74 75 } 76 } 77 #endif 78 79 static void 80 debug_print_susp_attrs(cd9660node *n, int indent) 81 { 82 struct ISO_SUSP_ATTRIBUTES *t; 83 84 TAILQ_FOREACH(t, &n->head, rr_ll) { 85 print_n_tabs(indent); 86 printf("-"); 87 printf("%c%c: L:%i",t->attr.su_entry.SP.h.type[0], 88 t->attr.su_entry.SP.h.type[1], 89 (int)t->attr.su_entry.SP.h.length[0]); 90 printf("\n"); 91 } 92 } 93 94 void 95 debug_print_tree(cd9660node *node, int level) 96 { 97 #if !HAVE_NBTOOL_CONFIG_H 98 cd9660node *cn; 99 100 print_n_tabs(level); 101 if (node->type & CD9660_TYPE_DOT) { 102 printf(". (%i)\n", 103 isonum_733(node->isoDirRecord->extent)); 104 } else if (node->type & CD9660_TYPE_DOTDOT) { 105 printf("..(%i)\n", 106 isonum_733(node->isoDirRecord->extent)); 107 } else if (node->isoDirRecord->name[0]=='\0') { 108 printf("(ROOT) (%" PRIu32 " to %" PRId64 ")\n", 109 node->fileDataSector, 110 node->fileDataSector + 111 node->fileSectorsUsed - 1); 112 } else { 113 printf("%s (%s) (%" PRIu32 " to %" PRId64 ")\n", 114 node->isoDirRecord->name, 115 (node->isoDirRecord->flags[0] 116 & ISO_FLAG_DIRECTORY) ? "DIR" : "FILE", 117 node->fileDataSector, 118 (node->fileSectorsUsed == 0) ? 119 node->fileDataSector : 120 node->fileDataSector 121 + node->fileSectorsUsed - 1); 122 } 123 if (diskStructure.rock_ridge_enabled) 124 debug_print_susp_attrs(node, level + 1); 125 TAILQ_FOREACH(cn, &node->cn_children, cn_next_child) 126 debug_print_tree(cn, level + 1); 127 #else 128 printf("Sorry, debugging is not supported in host-tools mode.\n"); 129 #endif 130 } 131 132 void 133 debug_print_path_tree(cd9660node *n) 134 { 135 cd9660node *iterator = n; 136 137 /* Only display this message when called with the root node */ 138 if (n->parent == NULL) 139 printf("debug_print_path_table: Dumping path table contents\n"); 140 141 while (iterator != NULL) { 142 if (iterator->isoDirRecord->name[0] == '\0') 143 printf("0) (ROOT)\n"); 144 else 145 printf("%i) %s\n", iterator->level, 146 iterator->isoDirRecord->name); 147 148 iterator = iterator->ptnext; 149 } 150 } 151 152 void 153 debug_print_volume_descriptor_information(void) 154 { 155 volume_descriptor *tmp = diskStructure.firstVolumeDescriptor; 156 char temp[CD9660_SECTOR_SIZE]; 157 158 printf("==Listing Volume Descriptors==\n"); 159 160 while (tmp != NULL) { 161 memset(temp, 0, CD9660_SECTOR_SIZE); 162 memcpy(temp, tmp->volumeDescriptorData + 1, 5); 163 printf("Volume descriptor in sector %" PRId64 164 ": type %i, ID %s\n", 165 tmp->sector, tmp->volumeDescriptorData[0], temp); 166 switch(tmp->volumeDescriptorData[0]) { 167 case 0:/*boot record*/ 168 break; 169 170 case 1: /* PVD */ 171 break; 172 173 case 2: /* SVD */ 174 break; 175 176 case 3: /* Volume Partition Descriptor */ 177 break; 178 179 case 255: /* terminator */ 180 break; 181 } 182 tmp = tmp->next; 183 } 184 185 printf("==Done Listing Volume Descriptors==\n"); 186 } 187 188 void 189 debug_dump_to_xml_ptentry(path_table_entry *pttemp, int num, int mode) 190 { 191 printf("<ptentry num=\"%i\">\n" ,num); 192 printf("<length>%i</length>\n", pttemp->length[0]); 193 printf("<extended_attribute_length>%i</extended_attribute_length>\n", 194 pttemp->extended_attribute_length[0]); 195 printf("<parent_number>%i</parent_number>\n", 196 debug_get_encoded_number(pttemp->parent_number,mode)); 197 debug_dump_to_xml_padded_hex_output("name", 198 pttemp->name, pttemp->length[0]); 199 printf("</ptentry>\n"); 200 } 201 202 void 203 debug_dump_to_xml_path_table(FILE *fd, off_t sector, int size, int mode) 204 { 205 path_table_entry pttemp; 206 int t = 0; 207 int n = 0; 208 209 if (fseeko(fd, CD9660_SECTOR_SIZE * sector, SEEK_SET) == -1) 210 err(1, "fseeko"); 211 212 while (t < size) { 213 /* Read fixed data first */ 214 fread(&pttemp, 1, 8, fd); 215 t += 8; 216 /* Read variable */ 217 fread(((unsigned char*)&pttemp) + 8, 1, pttemp.length[0], fd); 218 t += pttemp.length[0]; 219 debug_dump_to_xml_ptentry(&pttemp, n, mode); 220 n++; 221 } 222 223 } 224 225 /* 226 * XML Debug output functions 227 * Dump hierarchy of CD, as well as volume info, to XML 228 * Can be used later to diff against a standard, 229 * or just provide easy to read detailed debug output 230 */ 231 void 232 debug_dump_to_xml(FILE *fd) 233 { 234 unsigned char buf[CD9660_SECTOR_SIZE]; 235 off_t sector; 236 int t, t2; 237 struct iso_primary_descriptor primaryVD; 238 struct _boot_volume_descriptor bootVD; 239 240 printf("<cd9660dump>\n"); 241 242 /* Display Volume Descriptors */ 243 sector = 16; 244 do { 245 if (fseeko(fd, CD9660_SECTOR_SIZE * sector, SEEK_SET) == -1) 246 err(1, "fseeko"); 247 fread(buf, 1, CD9660_SECTOR_SIZE, fd); 248 t = (int)((unsigned char)buf[0]); 249 switch (t) { 250 case 0: 251 memcpy(&bootVD, buf, CD9660_SECTOR_SIZE); 252 break; 253 case 1: 254 memcpy(&primaryVD, buf, CD9660_SECTOR_SIZE); 255 break; 256 } 257 debug_dump_to_xml_volume_descriptor(buf, sector); 258 sector++; 259 } while (t != 255); 260 261 t = debug_get_encoded_number((u_char *)primaryVD.type_l_path_table, 262 731); 263 t2 = debug_get_encoded_number((u_char *)primaryVD.path_table_size, 733); 264 printf("Path table 1 located at sector %i and is %i bytes long\n", 265 t,t2); 266 debug_dump_to_xml_path_table(fd, t, t2, 721); 267 268 t = debug_get_encoded_number((u_char *)primaryVD.type_m_path_table, 269 731); 270 debug_dump_to_xml_path_table(fd, t, t2, 722); 271 272 printf("</cd9660dump>\n"); 273 } 274 275 static void 276 debug_dump_to_xml_padded_hex_output(const char *element, unsigned char *buf, 277 int len) 278 { 279 int i; 280 int t; 281 282 printf("<%s>",element); 283 for (i = 0; i < len; i++) { 284 t = (unsigned char)buf[i]; 285 if (t >= 32 && t < 127) 286 printf("%c",t); 287 } 288 printf("</%s>\n",element); 289 290 printf("<%s:hex>",element); 291 for (i = 0; i < len; i++) { 292 t = (unsigned char)buf[i]; 293 printf(" %x",t); 294 } 295 printf("</%s:hex>\n",element); 296 } 297 298 int 299 debug_get_encoded_number(unsigned char* buf, int mode) 300 { 301 #if !HAVE_NBTOOL_CONFIG_H 302 switch (mode) { 303 /* 711: Single bite */ 304 case 711: 305 return isonum_711(buf); 306 307 /* 712: Single signed byte */ 308 case 712: 309 return isonum_712((signed char *)buf); 310 311 /* 721: 16 bit LE */ 312 case 721: 313 return isonum_721(buf); 314 315 /* 731: 32 bit LE */ 316 case 731: 317 return isonum_731(buf); 318 319 /* 722: 16 bit BE */ 320 case 722: 321 return isonum_722(buf); 322 323 /* 732: 32 bit BE */ 324 case 732: 325 return isonum_732(buf); 326 327 /* 723: 16 bit bothE */ 328 case 723: 329 return isonum_723(buf); 330 331 /* 733: 32 bit bothE */ 332 case 733: 333 return isonum_733(buf); 334 } 335 #endif 336 return 0; 337 } 338 339 void 340 debug_dump_integer(const char *element, char* buf, int mode) 341 { 342 printf("<%s>%i</%s>\n", element, 343 debug_get_encoded_number((unsigned char *)buf, mode), element); 344 } 345 346 void 347 debug_dump_string(const char *element __unused, unsigned char *buf __unused, int len __unused) 348 { 349 350 } 351 352 void 353 debug_dump_directory_record_9_1(unsigned char* buf) 354 { 355 printf("<directoryrecord>\n"); 356 debug_dump_integer("length", 357 ((struct iso_directory_record*) buf)->length, 711); 358 debug_dump_integer("ext_attr_length", 359 ((struct iso_directory_record*) buf)->ext_attr_length,711); 360 debug_dump_integer("extent", 361 (char *)((struct iso_directory_record*) buf)->extent, 733); 362 debug_dump_integer("size", 363 (char *)((struct iso_directory_record*) buf)->size, 733); 364 debug_dump_integer("flags", 365 ((struct iso_directory_record*) buf)->flags, 711); 366 debug_dump_integer("file_unit_size", 367 ((struct iso_directory_record*) buf)->file_unit_size,711); 368 debug_dump_integer("interleave", 369 ((struct iso_directory_record*) buf)->interleave, 711); 370 debug_dump_integer("volume_sequence_number", 371 ((struct iso_directory_record*) buf)->volume_sequence_number, 372 723); 373 debug_dump_integer("name_len", 374 ((struct iso_directory_record*) buf)->name_len, 711); 375 debug_dump_to_xml_padded_hex_output("name", 376 (u_char *)((struct iso_directory_record*) buf)->name, 377 debug_get_encoded_number((u_char *) 378 ((struct iso_directory_record*) buf)->length, 711)); 379 printf("</directoryrecord>\n"); 380 } 381 382 383 void 384 debug_dump_to_xml_volume_descriptor(unsigned char* buf, int sector) 385 { 386 printf("<volumedescriptor sector=\"%i\">\n", sector); 387 printf("<vdtype>"); 388 switch(buf[0]) { 389 case 0: 390 printf("boot"); 391 break; 392 393 case 1: 394 printf("primary"); 395 break; 396 397 case 2: 398 printf("supplementary"); 399 break; 400 401 case 3: 402 printf("volume partition descriptor"); 403 break; 404 405 case 255: 406 printf("terminator"); 407 break; 408 } 409 410 printf("</vdtype>\n"); 411 switch(buf[0]) { 412 case 1: 413 debug_dump_integer("type", 414 ((struct iso_primary_descriptor*)buf)->type, 711); 415 debug_dump_to_xml_padded_hex_output("id", 416 (u_char *)((struct iso_primary_descriptor*) buf)->id, 417 ISODCL ( 2, 6)); 418 debug_dump_integer("version", 419 ((struct iso_primary_descriptor*)buf)->version, 420 711); 421 debug_dump_to_xml_padded_hex_output("system_id", 422 (u_char *)((struct iso_primary_descriptor*)buf)->system_id, 423 ISODCL(9,40)); 424 debug_dump_to_xml_padded_hex_output("volume_id", 425 (u_char *)((struct iso_primary_descriptor*)buf)->volume_id, 426 ISODCL(41,72)); 427 debug_dump_integer("volume_space_size", 428 ((struct iso_primary_descriptor*)buf)->volume_space_size, 429 733); 430 debug_dump_integer("volume_set_size", 431 ((struct iso_primary_descriptor*)buf)->volume_set_size, 432 733); 433 debug_dump_integer("volume_sequence_number", 434 ((struct iso_primary_descriptor*)buf)->volume_sequence_number, 435 723); 436 debug_dump_integer("logical_block_size", 437 ((struct iso_primary_descriptor*)buf)->logical_block_size, 438 723); 439 debug_dump_integer("path_table_size", 440 ((struct iso_primary_descriptor*)buf)->path_table_size, 441 733); 442 debug_dump_integer("type_l_path_table", 443 ((struct iso_primary_descriptor*)buf)->type_l_path_table, 444 731); 445 debug_dump_integer("opt_type_l_path_table", 446 ((struct iso_primary_descriptor*)buf)->opt_type_l_path_table, 447 731); 448 debug_dump_integer("type_m_path_table", 449 ((struct iso_primary_descriptor*)buf)->type_m_path_table, 450 732); 451 debug_dump_integer("opt_type_m_path_table", 452 ((struct iso_primary_descriptor*)buf)->opt_type_m_path_table,732); 453 debug_dump_directory_record_9_1( 454 (u_char *)((struct iso_primary_descriptor*)buf)->root_directory_record); 455 debug_dump_to_xml_padded_hex_output("volume_set_id", 456 (u_char *)((struct iso_primary_descriptor*) buf)->volume_set_id, 457 ISODCL (191, 318)); 458 debug_dump_to_xml_padded_hex_output("publisher_id", 459 (u_char *)((struct iso_primary_descriptor*) buf)->publisher_id, 460 ISODCL (319, 446)); 461 debug_dump_to_xml_padded_hex_output("preparer_id", 462 (u_char *)((struct iso_primary_descriptor*) buf)->preparer_id, 463 ISODCL (447, 574)); 464 debug_dump_to_xml_padded_hex_output("application_id", 465 (u_char *)((struct iso_primary_descriptor*) buf)->application_id, 466 ISODCL (575, 702)); 467 debug_dump_to_xml_padded_hex_output("copyright_file_id", 468 (u_char *)((struct iso_primary_descriptor*) buf)->copyright_file_id, 469 ISODCL (703, 739)); 470 debug_dump_to_xml_padded_hex_output("abstract_file_id", 471 (u_char *)((struct iso_primary_descriptor*) buf)->abstract_file_id, 472 ISODCL (740, 776)); 473 debug_dump_to_xml_padded_hex_output("bibliographic_file_id", 474 (u_char *)((struct iso_primary_descriptor*) buf)->bibliographic_file_id, 475 ISODCL (777, 813)); 476 477 debug_dump_to_xml_padded_hex_output("creation_date", 478 (u_char *)((struct iso_primary_descriptor*) buf)->creation_date, 479 ISODCL (814, 830)); 480 debug_dump_to_xml_padded_hex_output("modification_date", 481 (u_char *)((struct iso_primary_descriptor*) buf)->modification_date, 482 ISODCL (831, 847)); 483 debug_dump_to_xml_padded_hex_output("expiration_date", 484 (u_char *)((struct iso_primary_descriptor*) buf)->expiration_date, 485 ISODCL (848, 864)); 486 debug_dump_to_xml_padded_hex_output("effective_date", 487 (u_char *)((struct iso_primary_descriptor*) buf)->effective_date, 488 ISODCL (865, 881)); 489 490 debug_dump_to_xml_padded_hex_output("file_structure_version", 491 (u_char *)((struct iso_primary_descriptor*) buf)->file_structure_version, 492 ISODCL(882,882)); 493 break; 494 } 495 printf("</volumedescriptor>\n"); 496 } 497 498