Home | History | Annotate | Download | only in hdt
      1 /* ----------------------------------------------------------------------- *
      2  *
      3  *   Copyright 2011 Erwan Velu - All Rights Reserved
      4  *
      5  *   Permission is hereby granted, free of charge, to any person
      6  *   obtaining a copy of this software and associated documentation
      7  *   files (the "Software"), to deal in the Software without
      8  *   restriction, including without limitation the rights to use,
      9  *   copy, modify, merge, publish, distribute, sublicense, and/or
     10  *   sell copies of the Software, and to permit persons to whom
     11  *   the Software is furnished to do so, subject to the following
     12  *   conditions:
     13  *
     14  *   The above copyright notice and this permission notice shall
     15  *   be included in all copies or substantial portions of the Software.
     16  *
     17  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
     18  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
     19  *   OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
     20  *   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
     21  *   HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
     22  *   WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
     23  *   FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
     24  *   OTHER DEALINGS IN THE SOFTWARE.
     25  *
     26  * -----------------------------------------------------------------------
     27  */
     28 
     29 #include <stdio.h>
     30 #include <string.h>
     31 #include <stdlib.h>
     32 #include <ctype.h>
     33 #include <getkey.h>
     34 #include <syslinux/config.h>
     35 #include "hdt-common.h"
     36 #include "hdt-dump.h"
     37 
     38 struct print_buf p_buf;
     39 
     40 struct dump_option {
     41     char *flag;
     42     char *item;
     43 };
     44 
     45 char *get_value_from_option(struct s_hardware *hardware, char *option)
     46 {
     47     struct dump_option dump_options[10];
     48     dump_options[0].flag = "%{m}";
     49     dump_options[0].item = hardware->pxe.mac_addr;
     50 
     51     dump_options[1].flag = "%{v}";
     52     dump_options[1].item = hardware->dmi.system.manufacturer;
     53 
     54     dump_options[2].flag = "%{p}";
     55     dump_options[2].item = hardware->dmi.system.product_name;
     56 
     57     dump_options[3].flag = "%{ba}";
     58     dump_options[3].item = hardware->dmi.base_board.asset_tag;
     59 
     60     dump_options[4].flag = "%{bs}";
     61     dump_options[4].item = hardware->dmi.base_board.serial;
     62 
     63     dump_options[5].flag = "%{ca}";
     64     dump_options[5].item = hardware->dmi.chassis.asset_tag;
     65 
     66     dump_options[6].flag = "%{cs}";
     67     dump_options[6].item = hardware->dmi.chassis.serial;
     68 
     69     dump_options[7].flag = "%{sk}";
     70     dump_options[7].item = hardware->dmi.system.sku_number;
     71 
     72     dump_options[8].flag = "%{ss}";
     73     dump_options[8].item = hardware->dmi.system.serial;
     74 
     75     dump_options[9].flag = NULL;
     76     dump_options[9].item = NULL;
     77 
     78     for (int i = 0; i < 9; i++) {
     79 	if (strcmp(option, dump_options[i].flag) == 0) {
     80 	    return remove_spaces(dump_options[i].item);
     81 	}
     82     }
     83 
     84     return NULL;
     85 }
     86 
     87 char *compute_filename(struct s_hardware *hardware)
     88 {
     89 
     90     char *filename = malloc(512);
     91     snprintf(filename, 512, "%s/%s", hardware->dump_path,
     92 	     hardware->dump_filename);
     93 
     94     /* Until we found some dump parameters */
     95     char *buffer;
     96     while ((buffer = strstr(filename, "%{"))) {
     97 	// Find the end of the parameter
     98 	char *buffer_end = strstr(buffer, "}");
     99 
    100 	// Extracting the parameter between %{ and }
    101 	char option[8] = { 0 };
    102 	strncpy(option, buffer, buffer_end - buffer + 1);
    103 
    104 	/* Replace this option by its value in the filename
    105 	 * Filename is longer than the previous filename we had
    106 	 * so let's restart from the beginning */
    107 	filename =
    108 	    strreplace(filename, option,
    109 		       get_value_from_option(hardware, option));
    110     }
    111 
    112     /* We replace the ":" in the filename by some "-"
    113      * This will avoid Microsoft FS turning crazy */
    114     chrreplace(filename, ':', '-');
    115 
    116     /* Avoid space to make filename easier to manipulate */
    117     chrreplace(filename, ' ', '_');
    118 
    119     return filename;
    120 }
    121 
    122 int dumpprintf(FILE * p, const char *format, ...)
    123 {
    124     va_list ap;
    125     int rv;
    126 
    127     (void)p;
    128     va_start(ap, format);
    129     rv = vbufprintf(&p_buf, format, ap);
    130     va_end(ap);
    131     return rv;
    132 }
    133 
    134 void to_cpio(char *filename)
    135 {
    136     cpio_writefile(upload, filename, p_buf.buf, p_buf.len);
    137     if ((p_buf.buf) && (p_buf.len > 0)) {
    138 	memset(p_buf.buf, 0, p_buf.len);
    139 	free(p_buf.buf);
    140 	p_buf.buf = NULL;
    141 	p_buf.size = 0;
    142 	p_buf.len = 0;
    143     }
    144 }
    145 
    146 void flush(ZZJSON_CONFIG * config, ZZJSON ** item)
    147 {
    148     zzjson_print(config, *item);
    149     zzjson_free(config, *item);
    150     *item = NULL;
    151 }
    152 
    153 /**
    154  * dump - dump info
    155  **/
    156 void dump(struct s_hardware *hardware)
    157 {
    158     if (hardware->is_pxe_valid == false) {
    159 	more_printf("PXE stack was not detected, Dump feature is not available\n");
    160 	return;
    161     }
    162 
    163     const union syslinux_derivative_info *sdi = syslinux_derivative_info();
    164     int err = 0;
    165     ZZJSON *json = NULL;
    166     ZZJSON_CONFIG config = { ZZJSON_VERY_STRICT, NULL,
    167 	(int (*)(void *))fgetc,
    168 	NULL,
    169 	malloc, calloc, free, realloc,
    170 	stderr, NULL, stdout,
    171 	(int (*)(void *, const char *,...))dumpprintf,
    172 	(int (*)(int, void *))fputc
    173     };
    174 
    175     memset(&p_buf, 0, sizeof(p_buf));
    176 
    177     /* By now, we only support TFTP reporting */
    178     upload = &upload_tftp;
    179     upload->name = "tftp";
    180 
    181     /* The following defines the behavior of the reporting */
    182     char *arg[64];
    183     char *filename = compute_filename(hardware);
    184 
    185     /* The filename */
    186     arg[0] = filename;
    187     /* The server to upload the file */
    188     if (strlen(hardware->tftp_ip) != 0) {
    189 	arg[1] = hardware->tftp_ip;
    190 	arg[2] = NULL;
    191     } else {
    192 	arg[1] = NULL;
    193 	snprintf(hardware->tftp_ip, sizeof(hardware->tftp_ip),
    194 		 "%u.%u.%u.%u",
    195 		 ((uint8_t *) & sdi->pxe.ipinfo->serverip)[0],
    196 		 ((uint8_t *) & sdi->pxe.ipinfo->serverip)[1],
    197 		 ((uint8_t *) & sdi->pxe.ipinfo->serverip)[2],
    198 		 ((uint8_t *) & sdi->pxe.ipinfo->serverip)[3]);
    199 
    200     }
    201 
    202     /* We initiate the cpio to send */
    203     cpio_init(upload, (const char **)arg);
    204 
    205     dump_cpu(hardware, &config, &json);
    206     dump_pxe(hardware, &config, &json);
    207     dump_syslinux(hardware, &config, &json);
    208     dump_vpd(hardware, &config, &json);
    209     dump_vesa(hardware, &config, &json);
    210     dump_disks(hardware, &config, &json);
    211     dump_dmi(hardware, &config, &json);
    212     dump_memory(hardware, &config, &json);
    213     dump_pci(hardware, &config, &json);
    214     dump_acpi(hardware, &config, &json);
    215     dump_kernel(hardware, &config, &json);
    216     dump_hdt(hardware, &config, &json);
    217 
    218     /* We close & flush the file to send */
    219     cpio_close(upload);
    220 
    221     if ((err = flush_data(upload)) != TFTP_OK) {
    222 	/* As we manage a tftp connection, let's display the associated error message */
    223 	more_printf("Dump failed !\n");
    224 	more_printf("TFTP ERROR on  : %s:/%s \n", hardware->tftp_ip, filename);
    225 	more_printf("TFTP ERROR msg : %s \n", tftp_string_error_message[-err]);
    226     } else {
    227 	more_printf("Dump file sent at %s:/%s\n", hardware->tftp_ip, filename);
    228     }
    229 }
    230