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