Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 1 | #!/usr/bin/env python |
| 2 | |
| 3 | r""" |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 4 | This script will parse error log yaml file(s) and generate |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 5 | a header file which will then be used by the error logging client and |
| 6 | server to collect and validate the error information generated by the |
| 7 | openbmc software components. |
| 8 | |
| 9 | This code uses a mako template to provide the basic template of the header |
| 10 | file we're going to generate. We then call it with information from the |
| 11 | yaml to generate the header file. |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 12 | """ |
| 13 | |
| 14 | from mako.template import Template |
| 15 | from optparse import OptionParser |
| 16 | import yaml |
| 17 | import sys |
| 18 | import os |
| 19 | |
Andrew Geissler | 184690d | 2016-11-03 08:06:31 -0500 | [diff] [blame] | 20 | |
Deepak Kodihalli | 5d1aace | 2017-01-18 00:17:39 -0600 | [diff] [blame] | 21 | def 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 |
| 33 | # definitions preceed child error definitions. |
| 34 | 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 Kodihalli | cbd12c8 | 2017-01-17 08:50:55 -0600 | [diff] [blame] | 50 | def check_error_inheritance(i_errors, i_parents): |
Deepak Kodihalli | 5d1aace | 2017-01-18 00:17:39 -0600 | [diff] [blame] | 51 | for error in i_errors: |
| 52 | if(i_parents[error] and (i_parents[error] not in i_errors)): |
Patrick Williams | 6f29913 | 2017-02-16 13:27:39 -0600 | [diff] [blame] | 53 | print(error + " inherits " + i_parents[error] + |
| 54 | " but the latter is not defined") |
Deepak Kodihalli | cbd12c8 | 2017-01-17 08:50:55 -0600 | [diff] [blame] | 55 | return False |
| 56 | return True |
| 57 | |
| 58 | |
Adriana Kobylak | 6a9db6e | 2017-02-21 12:58:05 -0600 | [diff] [blame] | 59 | def get_error_yaml_files(i_yaml_dir, i_test_dir): |
Adriana Kobylak | 371a38b | 2017-02-19 13:45:42 -0600 | [diff] [blame] | 60 | yaml_files = dict() |
Adriana Kobylak | 6a9db6e | 2017-02-21 12:58:05 -0600 | [diff] [blame] | 61 | if i_yaml_dir != "None": |
| 62 | for root, dirs, files in os.walk(i_yaml_dir): |
| 63 | for files in filter(lambda file: |
| 64 | file.endswith('.errors.yaml'), files): |
Adriana Kobylak | 371a38b | 2017-02-19 13:45:42 -0600 | [diff] [blame] | 65 | splitdir = root.split(i_yaml_dir)[1] |
| 66 | yaml_files[(os.path.join(root, files))] = splitdir |
Adriana Kobylak | 6a9db6e | 2017-02-21 12:58:05 -0600 | [diff] [blame] | 67 | for root, dirs, files in os.walk(i_test_dir): |
Adriana Kobylak | f469073 | 2017-02-19 09:53:34 -0600 | [diff] [blame] | 68 | for files in filter(lambda file: file.endswith('.errors.yaml'), files): |
Adriana Kobylak | 371a38b | 2017-02-19 13:45:42 -0600 | [diff] [blame] | 69 | splitdir = root.split(i_test_dir)[1] |
| 70 | yaml_files[(os.path.join(root, files))] = splitdir |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 71 | return yaml_files |
| 72 | |
| 73 | |
| 74 | def get_meta_yaml_file(i_error_yaml_file): |
| 75 | # the meta data will be defined in file name where we replace |
| 76 | # <Interface>.errors.yaml with <Interface>.metadata.yaml |
| 77 | meta_yaml = i_error_yaml_file.replace("errors", "metadata") |
| 78 | return meta_yaml |
| 79 | |
| 80 | |
Deepak Kodihalli | 9916119 | 2017-01-16 04:00:07 -0600 | [diff] [blame] | 81 | def get_cpp_type(i_type): |
| 82 | typeMap = { |
| 83 | 'int16': 'int16_t', |
| 84 | 'int32': 'int32_t', |
| 85 | 'int64': 'int64_t', |
| 86 | 'uint16': 'uint16_t', |
| 87 | 'uint32': 'uint32_t', |
| 88 | 'uint64': 'uint64_t', |
| 89 | 'double': 'double', |
| 90 | # const char* aids usage of constexpr |
| 91 | 'string': 'const char*'} |
| 92 | |
| 93 | return typeMap[i_type] |
| 94 | |
| 95 | |
Adriana Kobylak | 6a9db6e | 2017-02-21 12:58:05 -0600 | [diff] [blame] | 96 | def gen_elog_hpp(i_yaml_dir, i_test_dir, i_output_hpp, |
Adriana Kobylak | 371a38b | 2017-02-19 13:45:42 -0600 | [diff] [blame] | 97 | i_template_dir, i_elog_mako): |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 98 | r""" |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 99 | Read yaml file(s) under input yaml dir, grab the relevant data and call |
| 100 | the mako template to generate the output header file. |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 101 | |
| 102 | Description of arguments: |
Adriana Kobylak | 6a9db6e | 2017-02-21 12:58:05 -0600 | [diff] [blame] | 103 | i_yaml_dir directory containing base error yaml files |
| 104 | i_test_dir directory containing test error yaml files |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 105 | i_output_hpp name of the to be generated output hpp |
| 106 | i_template_dir directory containing error mako templates |
| 107 | i_elog_mako error mako template to render |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 108 | """ |
| 109 | |
| 110 | # Input parameters to mako template |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 111 | errors = list() # Main error codes |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 112 | error_msg = dict() # Error msg that corresponds to error code |
| 113 | error_lvl = dict() # Error code log level (debug, info, error, ...) |
Deepak Kodihalli | 5d1aace | 2017-01-18 00:17:39 -0600 | [diff] [blame] | 114 | meta = dict() # The meta data names associated (ERRNO, FILE_NAME, ...) |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 115 | meta_data = dict() # The meta data info (type, format) |
Deepak Kodihalli | 5d1aace | 2017-01-18 00:17:39 -0600 | [diff] [blame] | 116 | parents = dict() |
Adriana Kobylak | 371a38b | 2017-02-19 13:45:42 -0600 | [diff] [blame] | 117 | namespace = dict() |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 118 | |
Adriana Kobylak | 6a9db6e | 2017-02-21 12:58:05 -0600 | [diff] [blame] | 119 | error_yamls = get_error_yaml_files(i_yaml_dir, i_test_dir) |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 120 | |
| 121 | for error_yaml in error_yamls: |
| 122 | # Verify the error yaml file |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 123 | if (not (os.path.isfile(error_yaml))): |
Patrick Williams | 6f29913 | 2017-02-16 13:27:39 -0600 | [diff] [blame] | 124 | print("Can not find input yaml file " + error_yaml) |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 125 | exit(1) |
| 126 | |
| 127 | # Verify the metadata yaml file |
| 128 | meta_yaml = get_meta_yaml_file(error_yaml) |
| 129 | if (not (os.path.isfile(meta_yaml))): |
Patrick Williams | 6f29913 | 2017-02-16 13:27:39 -0600 | [diff] [blame] | 130 | print("Can not find meta yaml file " + meta_yaml) |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 131 | exit(1) |
| 132 | |
| 133 | # Verify the input mako file |
| 134 | template_path = "/".join((i_template_dir, i_elog_mako)) |
| 135 | if (not (os.path.isfile(template_path))): |
Patrick Williams | 6f29913 | 2017-02-16 13:27:39 -0600 | [diff] [blame] | 136 | print("Can not find input template file " + template_path) |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 137 | exit(1) |
| 138 | |
| 139 | get_elog_data(error_yaml, |
| 140 | meta_yaml, |
Adriana Kobylak | 371a38b | 2017-02-19 13:45:42 -0600 | [diff] [blame] | 141 | error_yamls[error_yaml], |
| 142 | # Last arg is a tuple |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 143 | (errors, |
| 144 | error_msg, |
| 145 | error_lvl, |
| 146 | meta, |
Deepak Kodihalli | 82b7de7 | 2017-01-17 07:59:29 -0600 | [diff] [blame] | 147 | meta_data, |
Adriana Kobylak | 371a38b | 2017-02-19 13:45:42 -0600 | [diff] [blame] | 148 | parents, |
| 149 | namespace)) |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 150 | |
Deepak Kodihalli | cbd12c8 | 2017-01-17 08:50:55 -0600 | [diff] [blame] | 151 | if(not check_error_inheritance(errors, parents)): |
Patrick Williams | 6f29913 | 2017-02-16 13:27:39 -0600 | [diff] [blame] | 152 | print("Error - failed to validate error inheritance") |
Deepak Kodihalli | cbd12c8 | 2017-01-17 08:50:55 -0600 | [diff] [blame] | 153 | exit(1) |
| 154 | |
Deepak Kodihalli | 5d1aace | 2017-01-18 00:17:39 -0600 | [diff] [blame] | 155 | errors = order_inherited_errors(errors, parents) |
| 156 | |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 157 | # Load the mako template and call it with the required data |
| 158 | yaml_dir = i_yaml_dir.strip("./") |
| 159 | yaml_dir = yaml_dir.strip("../") |
| 160 | template = Template(filename=template_path) |
| 161 | f = open(i_output_hpp, 'w') |
| 162 | f.write(template.render( |
| 163 | errors=errors, error_msg=error_msg, |
| 164 | error_lvl=error_lvl, meta=meta, |
Adriana Kobylak | 371a38b | 2017-02-19 13:45:42 -0600 | [diff] [blame] | 165 | meta_data=meta_data, error_namespace=namespace, |
Deepak Kodihalli | f2462f0 | 2017-01-19 03:40:12 -0600 | [diff] [blame] | 166 | parents=parents)) |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 167 | f.close() |
| 168 | |
| 169 | |
| 170 | def get_elog_data(i_elog_yaml, |
| 171 | i_elog_meta_yaml, |
Adriana Kobylak | 371a38b | 2017-02-19 13:45:42 -0600 | [diff] [blame] | 172 | i_namespace, |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 173 | o_elog_data): |
| 174 | r""" |
| 175 | Parse the error and metadata yaml files in order to pull out |
| 176 | error metadata. |
| 177 | |
| 178 | Description of arguments: |
| 179 | i_elog_yaml error yaml file |
| 180 | i_elog_meta_yaml metadata yaml file |
Adriana Kobylak | 371a38b | 2017-02-19 13:45:42 -0600 | [diff] [blame] | 181 | i_namespace namespace data |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 182 | o_elog_data error metadata |
| 183 | """ |
Adriana Kobylak | 371a38b | 2017-02-19 13:45:42 -0600 | [diff] [blame] | 184 | errors, error_msg, error_lvl, meta, meta_data, parents, namespace = \ |
| 185 | o_elog_data |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 186 | ifile = yaml.safe_load(open(i_elog_yaml)) |
Andrew Geissler | e859630 | 2016-11-21 16:06:53 -0600 | [diff] [blame] | 187 | mfile = yaml.safe_load(open(i_elog_meta_yaml)) |
Adriana Kobylak | 17944e1 | 2017-02-13 22:29:21 -0600 | [diff] [blame] | 188 | for i in mfile: |
Andrew Geissler | e859630 | 2016-11-21 16:06:53 -0600 | [diff] [blame] | 189 | match = None |
| 190 | # Find the corresponding meta data for this entry |
Adriana Kobylak | 17944e1 | 2017-02-13 22:29:21 -0600 | [diff] [blame] | 191 | for j in ifile: |
| 192 | if j['name'] == i['name']: |
| 193 | match = j |
Andrew Geissler | e859630 | 2016-11-21 16:06:53 -0600 | [diff] [blame] | 194 | break |
| 195 | if (match is None): |
Patrick Williams | 6f29913 | 2017-02-16 13:27:39 -0600 | [diff] [blame] | 196 | print("Error - Did not find meta data for " + i['name']) |
Andrew Geissler | e859630 | 2016-11-21 16:06:53 -0600 | [diff] [blame] | 197 | exit(1) |
Andrew Geissler | df048c1 | 2016-11-10 16:50:35 -0600 | [diff] [blame] | 198 | # Grab the main error and it's info |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 199 | errors.append(i['name']) |
Deepak Kodihalli | 82b7de7 | 2017-01-17 07:59:29 -0600 | [diff] [blame] | 200 | parent = None |
| 201 | if('inherits' in i): |
| 202 | # xyz.openbmc.Foo, we need Foo |
| 203 | # Get 0th inherited error (current support - single inheritance) |
| 204 | parent = i['inherits'][0].split(".").pop() |
Deepak Kodihalli | 5d1aace | 2017-01-18 00:17:39 -0600 | [diff] [blame] | 205 | parents[i['name']] = parent |
Adriana Kobylak | 17944e1 | 2017-02-13 22:29:21 -0600 | [diff] [blame] | 206 | error_msg[i['name']] = match['description'] |
Adriana Kobylak | 8c3857c | 2017-02-19 13:56:41 -0600 | [diff] [blame] | 207 | try: |
| 208 | error_lvl[i['name']] = i['level'] |
| 209 | except: |
| 210 | print ("No level found for: " + i['name'] + ", using INFO") |
| 211 | error_lvl[i['name']] = "INFO" |
Andrew Geissler | 184690d | 2016-11-03 08:06:31 -0500 | [diff] [blame] | 212 | tmp_meta = [] |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 213 | # grab all the meta data fields and info |
Adriana Kobylak | 17944e1 | 2017-02-13 22:29:21 -0600 | [diff] [blame] | 214 | for j in i['meta']: |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 215 | str_short = j['str'].split('=')[0] |
| 216 | tmp_meta.append(str_short) |
| 217 | meta_data[str_short] = {} |
| 218 | meta_data[str_short]['str'] = j['str'] |
| 219 | meta_data[str_short]['str_short'] = str_short |
Deepak Kodihalli | 9916119 | 2017-01-16 04:00:07 -0600 | [diff] [blame] | 220 | meta_data[str_short]['type'] = get_cpp_type(j['type']) |
Deepak Kodihalli | 5d1aace | 2017-01-18 00:17:39 -0600 | [diff] [blame] | 221 | meta[i['name']] = tmp_meta |
Adriana Kobylak | 371a38b | 2017-02-19 13:45:42 -0600 | [diff] [blame] | 222 | namespace[i['name']] = i_namespace |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 223 | |
| 224 | # Debug |
Andrew Geissler | 184690d | 2016-11-03 08:06:31 -0500 | [diff] [blame] | 225 | # for i in errors: |
Andrew Geissler | df048c1 | 2016-11-10 16:50:35 -0600 | [diff] [blame] | 226 | # print "ERROR: " + errors[i] |
| 227 | # print " MSG: " + error_msg[errors[i]] |
| 228 | # print " LVL: " + error_lvl[errors[i]] |
| 229 | # print " META: " |
| 230 | # print meta[i] |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 231 | |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 232 | |
| 233 | def main(i_args): |
| 234 | parser = OptionParser() |
| 235 | |
Andrew Geissler | 184690d | 2016-11-03 08:06:31 -0500 | [diff] [blame] | 236 | parser.add_option("-m", "--mako", dest="elog_mako", |
| 237 | default="elog-gen-template.mako.hpp", |
Andrew Geissler | df048c1 | 2016-11-10 16:50:35 -0600 | [diff] [blame] | 238 | help="input mako template file to use") |
Andrew Geissler | 184690d | 2016-11-03 08:06:31 -0500 | [diff] [blame] | 239 | |
| 240 | parser.add_option("-o", "--output", dest="output_hpp", |
Adriana Kobylak | ebd59fa | 2017-02-06 20:55:39 -0600 | [diff] [blame^] | 241 | default="elog-errors.hpp", |
| 242 | help="output hpp to generate, elog-errors.hpp default") |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 243 | |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 244 | parser.add_option("-y", "--yamldir", dest="yamldir", |
Adriana Kobylak | 6a9db6e | 2017-02-21 12:58:05 -0600 | [diff] [blame] | 245 | default="None", |
Andrew Geissler | f1f2cfa | 2016-11-21 15:16:45 -0600 | [diff] [blame] | 246 | help="Base directory of yaml files to process") |
| 247 | |
Adriana Kobylak | 6a9db6e | 2017-02-21 12:58:05 -0600 | [diff] [blame] | 248 | parser.add_option("-u", "--testdir", dest="testdir", |
| 249 | default="./tools/example/", |
| 250 | help="Unit test directory of yaml files to process") |
| 251 | |
Andrew Geissler | f1f2cfa | 2016-11-21 15:16:45 -0600 | [diff] [blame] | 252 | parser.add_option("-t", "--templatedir", dest="templatedir", |
| 253 | default="phosphor-logging/templates/", |
| 254 | help="Base directory of files to process") |
| 255 | |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 256 | (options, args) = parser.parse_args(i_args) |
| 257 | |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 258 | gen_elog_hpp(options.yamldir, |
Adriana Kobylak | 6a9db6e | 2017-02-21 12:58:05 -0600 | [diff] [blame] | 259 | options.testdir, |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 260 | options.output_hpp, |
| 261 | options.templatedir, |
Adriana Kobylak | 371a38b | 2017-02-19 13:45:42 -0600 | [diff] [blame] | 262 | options.elog_mako) |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 263 | |
| 264 | # Only run if it's a script |
| 265 | if __name__ == '__main__': |
Andrew Geissler | 184690d | 2016-11-03 08:06:31 -0500 | [diff] [blame] | 266 | main(sys.argv[1:]) |