blob: af2e1fff4b0689a94f70ce471047668b0f561da9 [file] [log] [blame]
Matt Spinlerd9c2fea2020-03-05 16:53:41 -06001#!/usr/bin/env python3
Andrew Geisslerc830e0f2016-10-18 12:51:29 -05002
3r"""
Deepak Kodihalli160d3e02017-01-17 04:25:22 -06004This script will parse error log yaml file(s) and generate
Andrew Geisslerc830e0f2016-10-18 12:51:29 -05005a header file which will then be used by the error logging client and
6server to collect and validate the error information generated by the
7openbmc software components.
8
9This code uses a mako template to provide the basic template of the header
10file we're going to generate. We then call it with information from the
11yaml to generate the header file.
Andrew Geisslerc830e0f2016-10-18 12:51:29 -050012"""
13
14from mako.template import Template
15from optparse import OptionParser
16import yaml
17import sys
18import os
19
Andrew Geissler184690d2016-11-03 08:06:31 -050020
Deepak Kodihalli5d1aace2017-01-18 00:17:39 -060021def order_inherited_errors(i_errors, i_parents):
22 # the ordered list of errors
23 errors = list()
24 has_inheritance = False
25 for error in i_errors:
26 if(i_parents[error] is not None):
27 has_inheritance = True
28 break
29
30 if(has_inheritance):
31 # Order the error codes list such that an error is never placed
32 # before it's parent. This way generated code can ensure parent
Gunnar Millsdeae3ca2017-10-25 17:22:22 -050033 # definitions precede child error definitions.
Deepak Kodihalli5d1aace2017-01-18 00:17:39 -060034 while(len(errors) < len(i_errors)):
35 for error in i_errors:
36 if(error in errors):
37 # already ordererd
38 continue
39 if((not i_parents[error]) or (i_parents[error] in errors)):
40 # parent present, or has no parent, either way this error
41 # can be added
42 errors.append(error)
43 else:
44 # no inherited errors
45 errors = i_errors
46
47 return errors
48
49
Deepak Kodihallicbd12c82017-01-17 08:50:55 -060050def check_error_inheritance(i_errors, i_parents):
Deepak Kodihalli5d1aace2017-01-18 00:17:39 -060051 for error in i_errors:
52 if(i_parents[error] and (i_parents[error] not in i_errors)):
Patrick Williams6f299132017-02-16 13:27:39 -060053 print(error + " inherits " + i_parents[error] +
54 " but the latter is not defined")
Deepak Kodihallicbd12c82017-01-17 08:50:55 -060055 return False
56 return True
57
58
Adriana Kobylak465aaec2017-02-20 11:58:03 -060059# Return the yaml files with their directory structure plus the file name
60# without the yaml extension, which will be used to set the namespaces.
61# Ex: file xyz/openbmc_project/Error/Callout/Device.errors.yaml
62# will have namespce xyz/openbmc_project/Error/Callout/Device
Adriana Kobylak6a9db6e2017-02-21 12:58:05 -060063def get_error_yaml_files(i_yaml_dir, i_test_dir):
Adriana Kobylak371a38b2017-02-19 13:45:42 -060064 yaml_files = dict()
Adriana Kobylak6a9db6e2017-02-21 12:58:05 -060065 if i_yaml_dir != "None":
66 for root, dirs, files in os.walk(i_yaml_dir):
Matt Spinlerd9c2fea2020-03-05 16:53:41 -060067 for files in \
68 [file for file in files if file.endswith('.errors.yaml')]:
Adriana Kobylak465aaec2017-02-20 11:58:03 -060069 splitdir = root.split(i_yaml_dir)[1] + "/" + files[:-12]
70 if splitdir.startswith("/"):
71 splitdir = splitdir[1:]
Adriana Kobylak371a38b2017-02-19 13:45:42 -060072 yaml_files[(os.path.join(root, files))] = splitdir
Adriana Kobylak6a9db6e2017-02-21 12:58:05 -060073 for root, dirs, files in os.walk(i_test_dir):
Matt Spinlerd9c2fea2020-03-05 16:53:41 -060074 for files in [file for file in files if file.endswith('.errors.yaml')]:
Adriana Kobylak465aaec2017-02-20 11:58:03 -060075 splitdir = root.split(i_test_dir)[1] + "/" + files[:-12]
Adriana Kobylak371a38b2017-02-19 13:45:42 -060076 yaml_files[(os.path.join(root, files))] = splitdir
Deepak Kodihalli160d3e02017-01-17 04:25:22 -060077 return yaml_files
78
79
80def get_meta_yaml_file(i_error_yaml_file):
81 # the meta data will be defined in file name where we replace
82 # <Interface>.errors.yaml with <Interface>.metadata.yaml
83 meta_yaml = i_error_yaml_file.replace("errors", "metadata")
84 return meta_yaml
85
86
Deepak Kodihalli99161192017-01-16 04:00:07 -060087def get_cpp_type(i_type):
88 typeMap = {
89 'int16': 'int16_t',
90 'int32': 'int32_t',
91 'int64': 'int64_t',
92 'uint16': 'uint16_t',
93 'uint32': 'uint32_t',
94 'uint64': 'uint64_t',
95 'double': 'double',
96 # const char* aids usage of constexpr
97 'string': 'const char*'}
98
99 return typeMap[i_type]
100
101
Adriana Kobylak6a9db6e2017-02-21 12:58:05 -0600102def gen_elog_hpp(i_yaml_dir, i_test_dir, i_output_hpp,
Adriana Kobylak371a38b2017-02-19 13:45:42 -0600103 i_template_dir, i_elog_mako):
Andrew Geisslerc830e0f2016-10-18 12:51:29 -0500104 r"""
Deepak Kodihalli160d3e02017-01-17 04:25:22 -0600105 Read yaml file(s) under input yaml dir, grab the relevant data and call
106 the mako template to generate the output header file.
Andrew Geisslerc830e0f2016-10-18 12:51:29 -0500107
108 Description of arguments:
Adriana Kobylak6a9db6e2017-02-21 12:58:05 -0600109 i_yaml_dir directory containing base error yaml files
110 i_test_dir directory containing test error yaml files
Deepak Kodihalli160d3e02017-01-17 04:25:22 -0600111 i_output_hpp name of the to be generated output hpp
112 i_template_dir directory containing error mako templates
113 i_elog_mako error mako template to render
Andrew Geisslerc830e0f2016-10-18 12:51:29 -0500114 """
115
116 # Input parameters to mako template
Deepak Kodihalli160d3e02017-01-17 04:25:22 -0600117 errors = list() # Main error codes
Andrew Geisslerc830e0f2016-10-18 12:51:29 -0500118 error_msg = dict() # Error msg that corresponds to error code
119 error_lvl = dict() # Error code log level (debug, info, error, ...)
Deepak Kodihalli5d1aace2017-01-18 00:17:39 -0600120 meta = dict() # The meta data names associated (ERRNO, FILE_NAME, ...)
Andrew Geisslerc830e0f2016-10-18 12:51:29 -0500121 meta_data = dict() # The meta data info (type, format)
Deepak Kodihalli5d1aace2017-01-18 00:17:39 -0600122 parents = dict()
Deepak Kodihalli38f69742017-02-28 02:18:09 -0600123 metadata_process = dict() # metadata that have the 'process' keyword set
Andrew Geisslerc830e0f2016-10-18 12:51:29 -0500124
Adriana Kobylak6a9db6e2017-02-21 12:58:05 -0600125 error_yamls = get_error_yaml_files(i_yaml_dir, i_test_dir)
Deepak Kodihalli160d3e02017-01-17 04:25:22 -0600126
127 for error_yaml in error_yamls:
128 # Verify the error yaml file
Deepak Kodihalli160d3e02017-01-17 04:25:22 -0600129 if (not (os.path.isfile(error_yaml))):
Marri Devender Raodf7cb5c2017-05-14 08:30:40 -0500130 print("Cannot find input yaml file " + error_yaml)
Deepak Kodihalli160d3e02017-01-17 04:25:22 -0600131 exit(1)
132
133 # Verify the metadata yaml file
134 meta_yaml = get_meta_yaml_file(error_yaml)
Deepak Kodihalli160d3e02017-01-17 04:25:22 -0600135
136 # Verify the input mako file
137 template_path = "/".join((i_template_dir, i_elog_mako))
138 if (not (os.path.isfile(template_path))):
Marri Devender Raodf7cb5c2017-05-14 08:30:40 -0500139 print("Cannot find input template file " + template_path)
Deepak Kodihalli160d3e02017-01-17 04:25:22 -0600140 exit(1)
141
142 get_elog_data(error_yaml,
143 meta_yaml,
Adriana Kobylak371a38b2017-02-19 13:45:42 -0600144 error_yamls[error_yaml],
145 # Last arg is a tuple
Deepak Kodihalli160d3e02017-01-17 04:25:22 -0600146 (errors,
147 error_msg,
148 error_lvl,
149 meta,
Deepak Kodihalli82b7de72017-01-17 07:59:29 -0600150 meta_data,
Deepak Kodihalli38f69742017-02-28 02:18:09 -0600151 parents,
152 metadata_process))
Deepak Kodihalli160d3e02017-01-17 04:25:22 -0600153
Deepak Kodihallicbd12c82017-01-17 08:50:55 -0600154 if(not check_error_inheritance(errors, parents)):
Patrick Williams6f299132017-02-16 13:27:39 -0600155 print("Error - failed to validate error inheritance")
Deepak Kodihallicbd12c82017-01-17 08:50:55 -0600156 exit(1)
157
Deepak Kodihalli5d1aace2017-01-18 00:17:39 -0600158 errors = order_inherited_errors(errors, parents)
159
Deepak Kodihalli160d3e02017-01-17 04:25:22 -0600160 # Load the mako template and call it with the required data
161 yaml_dir = i_yaml_dir.strip("./")
162 yaml_dir = yaml_dir.strip("../")
163 template = Template(filename=template_path)
164 f = open(i_output_hpp, 'w')
165 f.write(template.render(
Deepak Kodihalli38f69742017-02-28 02:18:09 -0600166 errors=errors,
167 error_msg=error_msg,
168 error_lvl=error_lvl,
169 meta=meta,
Adriana Kobylak465aaec2017-02-20 11:58:03 -0600170 meta_data=meta_data,
Deepak Kodihalli38f69742017-02-28 02:18:09 -0600171 parents=parents,
172 metadata_process=metadata_process))
Deepak Kodihalli160d3e02017-01-17 04:25:22 -0600173 f.close()
174
Deepak Kodihalli160d3e02017-01-17 04:25:22 -0600175def get_elog_data(i_elog_yaml,
176 i_elog_meta_yaml,
Adriana Kobylak371a38b2017-02-19 13:45:42 -0600177 i_namespace,
Deepak Kodihalli160d3e02017-01-17 04:25:22 -0600178 o_elog_data):
179 r"""
180 Parse the error and metadata yaml files in order to pull out
181 error metadata.
182
Marri Devender Raodf7cb5c2017-05-14 08:30:40 -0500183 Use default values if metadata yaml file is not found.
184
Deepak Kodihalli160d3e02017-01-17 04:25:22 -0600185 Description of arguments:
186 i_elog_yaml error yaml file
187 i_elog_meta_yaml metadata yaml file
Adriana Kobylak371a38b2017-02-19 13:45:42 -0600188 i_namespace namespace data
Deepak Kodihalli160d3e02017-01-17 04:25:22 -0600189 o_elog_data error metadata
190 """
Deepak Kodihalli38f69742017-02-28 02:18:09 -0600191 (errors, error_msg, error_lvl, meta,
192 meta_data, parents, metadata_process) = o_elog_data
Deepak Kodihalli160d3e02017-01-17 04:25:22 -0600193 ifile = yaml.safe_load(open(i_elog_yaml))
Marri Devender Raodf7cb5c2017-05-14 08:30:40 -0500194
195 #for all the errors in error yaml file
196 for error in ifile:
197 if 'name' not in error:
Patrick Williams4952aa62017-06-03 15:47:55 -0500198 print("Error - Did not find name in entry %s in file %s " % (
199 str(error), i_elog_yaml))
Andrew Geisslere8596302016-11-21 16:06:53 -0600200 exit(1)
Marri Devender Raodf7cb5c2017-05-14 08:30:40 -0500201 fullname = i_namespace.replace('/', '.') + ('.') + error['name']
Adriana Kobylak465aaec2017-02-20 11:58:03 -0600202 errors.append(fullname)
Marri Devender Raodf7cb5c2017-05-14 08:30:40 -0500203
204 if 'description' in error:
205 error_msg[fullname] = error['description'].strip()
206
207 #set default values
208 error_lvl[fullname] = "ERR"
209 parents[fullname] = None
210
211 #check if meta data yaml file is found
212 if not os.path.isfile(i_elog_meta_yaml):
213 continue
214 mfile = yaml.safe_load(open(i_elog_meta_yaml))
215
216 # Find the meta data entry
217 match = None
218 for meta_entry in mfile:
219 if meta_entry['name'] == error['name']:
220 match = meta_entry
221 break
222
223 if match is None:
William A. Kennington IIIb17e8762018-10-04 18:58:14 -0700224 print("Error - Did not find error named %s in %s" % (
225 error['name'], i_elog_meta_yaml))
Marri Devender Raodf7cb5c2017-05-14 08:30:40 -0500226 continue
227
228 error_lvl[fullname] = match.get('level', 'ERR')
229
230 # Get 0th inherited error (current support - single inheritance)
231 if 'inherits' in match:
232 parents[fullname] = match['inherits'][0]
233
Lei YU80aa4762018-07-19 10:29:56 +0800234 # Put all errors in meta[] even the meta is empty
235 # so that child errors could inherits such error without meta
236 tmp_meta = []
Marri Devender Raodf7cb5c2017-05-14 08:30:40 -0500237 if 'meta' in match:
Marri Devender Raodf7cb5c2017-05-14 08:30:40 -0500238 # grab all the meta data fields and info
239 for i in match['meta']:
240 str_short = i['str'].split('=')[0]
Deepak Kodihalli7924b172017-03-08 00:04:33 -0600241 tmp_meta.append(str_short)
242 meta_data[str_short] = {}
Marri Devender Raodf7cb5c2017-05-14 08:30:40 -0500243 meta_data[str_short]['str'] = i['str']
Deepak Kodihalli7924b172017-03-08 00:04:33 -0600244 meta_data[str_short]['str_short'] = str_short
Marri Devender Raodf7cb5c2017-05-14 08:30:40 -0500245 meta_data[str_short]['type'] = get_cpp_type(i['type'])
246 if ('process' in i) and (True == i['process']):
Deepak Kodihalli38f69742017-02-28 02:18:09 -0600247 metadata_process[str_short] = fullname + "." + str_short
Lei YU80aa4762018-07-19 10:29:56 +0800248 meta[fullname] = tmp_meta
Andrew Geisslerc830e0f2016-10-18 12:51:29 -0500249
250 # Debug
Andrew Geissler184690d2016-11-03 08:06:31 -0500251 # for i in errors:
Andrew Geisslerdf048c12016-11-10 16:50:35 -0600252 # print "ERROR: " + errors[i]
253 # print " MSG: " + error_msg[errors[i]]
254 # print " LVL: " + error_lvl[errors[i]]
255 # print " META: "
256 # print meta[i]
Andrew Geisslerc830e0f2016-10-18 12:51:29 -0500257
Andrew Geisslerc830e0f2016-10-18 12:51:29 -0500258
259def main(i_args):
260 parser = OptionParser()
261
Andrew Geissler184690d2016-11-03 08:06:31 -0500262 parser.add_option("-m", "--mako", dest="elog_mako",
263 default="elog-gen-template.mako.hpp",
Andrew Geisslerdf048c12016-11-10 16:50:35 -0600264 help="input mako template file to use")
Andrew Geissler184690d2016-11-03 08:06:31 -0500265
266 parser.add_option("-o", "--output", dest="output_hpp",
Adriana Kobylakebd59fa2017-02-06 20:55:39 -0600267 default="elog-errors.hpp",
268 help="output hpp to generate, elog-errors.hpp default")
Andrew Geisslerc830e0f2016-10-18 12:51:29 -0500269
Deepak Kodihalli160d3e02017-01-17 04:25:22 -0600270 parser.add_option("-y", "--yamldir", dest="yamldir",
Adriana Kobylak6a9db6e2017-02-21 12:58:05 -0600271 default="None",
Andrew Geisslerf1f2cfa2016-11-21 15:16:45 -0600272 help="Base directory of yaml files to process")
273
Adriana Kobylak6a9db6e2017-02-21 12:58:05 -0600274 parser.add_option("-u", "--testdir", dest="testdir",
275 default="./tools/example/",
276 help="Unit test directory of yaml files to process")
277
Andrew Geisslerf1f2cfa2016-11-21 15:16:45 -0600278 parser.add_option("-t", "--templatedir", dest="templatedir",
279 default="phosphor-logging/templates/",
280 help="Base directory of files to process")
281
Andrew Geisslerc830e0f2016-10-18 12:51:29 -0500282 (options, args) = parser.parse_args(i_args)
283
Deepak Kodihalli160d3e02017-01-17 04:25:22 -0600284 gen_elog_hpp(options.yamldir,
Adriana Kobylak6a9db6e2017-02-21 12:58:05 -0600285 options.testdir,
Deepak Kodihalli160d3e02017-01-17 04:25:22 -0600286 options.output_hpp,
287 options.templatedir,
Adriana Kobylak371a38b2017-02-19 13:45:42 -0600288 options.elog_mako)
Andrew Geisslerc830e0f2016-10-18 12:51:29 -0500289
290# Only run if it's a script
291if __name__ == '__main__':
Andrew Geissler184690d2016-11-03 08:06:31 -0500292 main(sys.argv[1:])