1 /**
2  * A user-space application for generating pseudo-random specification compliant CPER records.
3  *
4  * Author: Lawrence.Tang@arm.com
5  **/
6 
7 #include <stdio.h>
8 #include <stdlib.h>
9 #include <string.h>
10 #include "../edk/Cper.h"
11 #include "cper-generate.h"
12 #include "sections/gen-section.h"
13 
14 void print_help();
15 
16 int main(int argc, char *argv[])
17 {
18 	//If help requested, print help.
19 	if (argc == 2 && strcmp(argv[1], "--help") == 0) {
20 		print_help();
21 		return 0;
22 	}
23 
24 	//Parse the command line arguments.
25 	char *out_file = NULL;
26 	char *single_section = NULL;
27 	char **sections = NULL;
28 	UINT16 num_sections = 0;
29 	for (int i = 1; i < argc; i++) {
30 		if (strcmp(argv[i], "--out") == 0 && i < argc - 1) {
31 			out_file = argv[i + 1];
32 			i++;
33 		} else if (strcmp(argv[i], "--single-section") == 0 &&
34 			   i < argc - 1) {
35 			single_section = argv[i + 1];
36 			i++;
37 		} else if (strcmp(argv[i], "--sections") == 0 && i < argc - 1) {
38 			//All arguments after this must be section names.
39 			num_sections = argc - i - 1;
40 			sections = malloc(sizeof(char *) * num_sections);
41 			i++;
42 
43 			for (int j = i; j < argc; j++) {
44 				sections[j - i] = argv[j];
45 			}
46 			break;
47 		} else {
48 			printf("Unrecognised argument '%s'. For command information, refer to 'cper-generate --help'.\n",
49 			       argv[i]);
50 			return -1;
51 		}
52 	}
53 
54 	//If no output file passed as argument, exit.
55 	if (out_file == NULL) {
56 		printf("No output file provided. For command information, refer to 'cper-generate --help'.\n");
57 		if (sections) {
58 			free(sections);
59 		}
60 		return -1;
61 	}
62 
63 	//Open a file handle to write output.
64 	FILE *cper_file = fopen(out_file, "w");
65 	if (cper_file == NULL) {
66 		printf("Could not get a handle for output file '%s', file handle returned null.\n",
67 		       out_file);
68 		if (sections) {
69 			free(sections);
70 		}
71 		return -1;
72 	}
73 
74 	//Which type are we generating?
75 	if (single_section != NULL && sections == NULL) {
76 		generate_single_section_record(single_section, cper_file);
77 	} else if (sections != NULL && single_section == NULL) {
78 		generate_cper_record(sections, num_sections, cper_file);
79 	} else {
80 		//Invalid arguments.
81 		printf("Invalid argument. Either both '--sections' and '--single-section' were set, or neither. For command information, refer to 'cper-generate --help'.\n");
82 		if (sections) {
83 			free(sections);
84 		}
85 		return -1;
86 	}
87 
88 	//Close & free remaining resources.
89 	fclose(cper_file);
90 	if (sections != NULL) {
91 		free(sections);
92 	}
93 }
94 
95 //Prints command help for this CPER generator.
96 void print_help()
97 {
98 	printf(":: --out cper.file [--sections section1 ...] [--single-section sectiontype]\n");
99 	printf("\tGenerates a pseudo-random CPER file with the provided section types and outputs to the given file name.\n\n");
100 	printf("\tWhen the '--sections' flag is set, all following arguments are section names, and a full CPER log is generated\n");
101 	printf("\tcontaining the given sections.\n");
102 	printf("\tWhen the '--single-section' flag is set, the next argument is the single section that should be generated, and\n");
103 	printf("\ta single section (no header, only a section descriptor & section) CPER file is generated.\n\n");
104 	printf("\tValid section type names are the following:\n");
105 	for (size_t i = 0; i < generator_definitions_len; i++) {
106 		printf("\t\t- %s\n", generator_definitions[i].ShortName);
107 	}
108 	printf("\t\t- unknown\n");
109 	printf("\n:: --help\n");
110 	printf("\tDisplays help information to the console.\n");
111 }
112