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 | cbd12c8 | 2017-01-17 08:50:55 -0600 | [diff] [blame^] | 21 | def check_error_inheritance(i_errors, i_parents): |
| 22 | for parent in i_parents: |
| 23 | if(parent and (parent not in i_errors)): |
| 24 | print parent + " inhertied from, but not defined" |
| 25 | return False |
| 26 | return True |
| 27 | |
| 28 | |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 29 | def get_error_yaml_files(i_yaml_dir): |
| 30 | yaml_files = filter( |
| 31 | lambda file: file.endswith('.errors.yaml'), |
| 32 | os.listdir(i_yaml_dir)) |
| 33 | return yaml_files |
| 34 | |
| 35 | |
| 36 | def get_meta_yaml_file(i_error_yaml_file): |
| 37 | # the meta data will be defined in file name where we replace |
| 38 | # <Interface>.errors.yaml with <Interface>.metadata.yaml |
| 39 | meta_yaml = i_error_yaml_file.replace("errors", "metadata") |
| 40 | return meta_yaml |
| 41 | |
| 42 | |
Deepak Kodihalli | 9916119 | 2017-01-16 04:00:07 -0600 | [diff] [blame] | 43 | def get_cpp_type(i_type): |
| 44 | typeMap = { |
| 45 | 'int16': 'int16_t', |
| 46 | 'int32': 'int32_t', |
| 47 | 'int64': 'int64_t', |
| 48 | 'uint16': 'uint16_t', |
| 49 | 'uint32': 'uint32_t', |
| 50 | 'uint64': 'uint64_t', |
| 51 | 'double': 'double', |
| 52 | # const char* aids usage of constexpr |
| 53 | 'string': 'const char*'} |
| 54 | |
| 55 | return typeMap[i_type] |
| 56 | |
| 57 | |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 58 | def gen_elog_hpp(i_yaml_dir, i_output_hpp, |
| 59 | i_template_dir, i_elog_mako, i_error_namespace): |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 60 | r""" |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 61 | Read yaml file(s) under input yaml dir, grab the relevant data and call |
| 62 | the mako template to generate the output header file. |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 63 | |
| 64 | Description of arguments: |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 65 | i_yaml_dir directory containing error yaml files |
| 66 | i_output_hpp name of the to be generated output hpp |
| 67 | i_template_dir directory containing error mako templates |
| 68 | i_elog_mako error mako template to render |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 69 | """ |
| 70 | |
| 71 | # Input parameters to mako template |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 72 | errors = list() # Main error codes |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 73 | error_msg = dict() # Error msg that corresponds to error code |
| 74 | error_lvl = dict() # Error code log level (debug, info, error, ...) |
Andrew Geissler | 184690d | 2016-11-03 08:06:31 -0500 | [diff] [blame] | 75 | meta = list() # The meta data names associated (ERRNO, FILE_NAME, ...) |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 76 | meta_data = dict() # The meta data info (type, format) |
Deepak Kodihalli | 82b7de7 | 2017-01-17 07:59:29 -0600 | [diff] [blame] | 77 | parents = list() |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 78 | |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 79 | error_yamls = get_error_yaml_files(i_yaml_dir) |
| 80 | |
| 81 | for error_yaml in error_yamls: |
| 82 | # Verify the error yaml file |
| 83 | error_yaml = "/".join((i_yaml_dir, error_yaml)) |
| 84 | if (not (os.path.isfile(error_yaml))): |
| 85 | print "Can not find input yaml file " + error_yaml |
| 86 | exit(1) |
| 87 | |
| 88 | # Verify the metadata yaml file |
| 89 | meta_yaml = get_meta_yaml_file(error_yaml) |
| 90 | if (not (os.path.isfile(meta_yaml))): |
| 91 | print "Can not find meta yaml file " + meta_yaml |
| 92 | exit(1) |
| 93 | |
| 94 | # Verify the input mako file |
| 95 | template_path = "/".join((i_template_dir, i_elog_mako)) |
| 96 | if (not (os.path.isfile(template_path))): |
| 97 | print "Can not find input template file " + template_path |
| 98 | exit(1) |
| 99 | |
| 100 | get_elog_data(error_yaml, |
| 101 | meta_yaml, |
| 102 | # 3rd arg is a tuple |
| 103 | (errors, |
| 104 | error_msg, |
| 105 | error_lvl, |
| 106 | meta, |
Deepak Kodihalli | 82b7de7 | 2017-01-17 07:59:29 -0600 | [diff] [blame] | 107 | meta_data, |
| 108 | parents)) |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 109 | |
Deepak Kodihalli | cbd12c8 | 2017-01-17 08:50:55 -0600 | [diff] [blame^] | 110 | if(not check_error_inheritance(errors, parents)): |
| 111 | print "Error - failed to validate error inheritance" |
| 112 | exit(1) |
| 113 | |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 114 | # Load the mako template and call it with the required data |
| 115 | yaml_dir = i_yaml_dir.strip("./") |
| 116 | yaml_dir = yaml_dir.strip("../") |
| 117 | template = Template(filename=template_path) |
| 118 | f = open(i_output_hpp, 'w') |
| 119 | f.write(template.render( |
| 120 | errors=errors, error_msg=error_msg, |
| 121 | error_lvl=error_lvl, meta=meta, |
| 122 | meta_data=meta_data, error_namespace=i_error_namespace)) |
| 123 | f.close() |
| 124 | |
| 125 | |
| 126 | def get_elog_data(i_elog_yaml, |
| 127 | i_elog_meta_yaml, |
| 128 | o_elog_data): |
| 129 | r""" |
| 130 | Parse the error and metadata yaml files in order to pull out |
| 131 | error metadata. |
| 132 | |
| 133 | Description of arguments: |
| 134 | i_elog_yaml error yaml file |
| 135 | i_elog_meta_yaml metadata yaml file |
| 136 | o_elog_data error metadata |
| 137 | """ |
Deepak Kodihalli | 82b7de7 | 2017-01-17 07:59:29 -0600 | [diff] [blame] | 138 | errors, error_msg, error_lvl, meta, meta_data, parents = o_elog_data |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 139 | ifile = yaml.safe_load(open(i_elog_yaml)) |
Andrew Geissler | e859630 | 2016-11-21 16:06:53 -0600 | [diff] [blame] | 140 | mfile = yaml.safe_load(open(i_elog_meta_yaml)) |
Andrew Geissler | 5e81bfb | 2016-11-21 12:49:01 -0600 | [diff] [blame] | 141 | for i in ifile: |
Andrew Geissler | e859630 | 2016-11-21 16:06:53 -0600 | [diff] [blame] | 142 | match = None |
| 143 | # Find the corresponding meta data for this entry |
| 144 | for m in mfile: |
| 145 | if m['name'] == i['name']: |
| 146 | match = m |
| 147 | break |
| 148 | if (match is None): |
| 149 | print "Error - Did not find meta data for " + i['name'] |
| 150 | exit(1) |
Andrew Geissler | df048c1 | 2016-11-10 16:50:35 -0600 | [diff] [blame] | 151 | # Grab the main error and it's info |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 152 | errors.append(i['name']) |
Deepak Kodihalli | 82b7de7 | 2017-01-17 07:59:29 -0600 | [diff] [blame] | 153 | parent = None |
| 154 | if('inherits' in i): |
| 155 | # xyz.openbmc.Foo, we need Foo |
| 156 | # Get 0th inherited error (current support - single inheritance) |
| 157 | parent = i['inherits'][0].split(".").pop() |
| 158 | parents.append(parent) |
Andrew Geissler | 5e81bfb | 2016-11-21 12:49:01 -0600 | [diff] [blame] | 159 | error_msg[i['name']] = i['description'] |
Andrew Geissler | e859630 | 2016-11-21 16:06:53 -0600 | [diff] [blame] | 160 | error_lvl[i['name']] = match['level'] |
Andrew Geissler | 184690d | 2016-11-03 08:06:31 -0500 | [diff] [blame] | 161 | tmp_meta = [] |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 162 | # grab all the meta data fields and info |
Andrew Geissler | e859630 | 2016-11-21 16:06:53 -0600 | [diff] [blame] | 163 | for j in match['meta']: |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 164 | str_short = j['str'].split('=')[0] |
| 165 | tmp_meta.append(str_short) |
| 166 | meta_data[str_short] = {} |
| 167 | meta_data[str_short]['str'] = j['str'] |
| 168 | meta_data[str_short]['str_short'] = str_short |
Deepak Kodihalli | 9916119 | 2017-01-16 04:00:07 -0600 | [diff] [blame] | 169 | meta_data[str_short]['type'] = get_cpp_type(j['type']) |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 170 | meta.append(tmp_meta) |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 171 | |
| 172 | # Debug |
Andrew Geissler | 184690d | 2016-11-03 08:06:31 -0500 | [diff] [blame] | 173 | # for i in errors: |
Andrew Geissler | df048c1 | 2016-11-10 16:50:35 -0600 | [diff] [blame] | 174 | # print "ERROR: " + errors[i] |
| 175 | # print " MSG: " + error_msg[errors[i]] |
| 176 | # print " LVL: " + error_lvl[errors[i]] |
| 177 | # print " META: " |
| 178 | # print meta[i] |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 179 | |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 180 | |
| 181 | def main(i_args): |
| 182 | parser = OptionParser() |
| 183 | |
Andrew Geissler | 184690d | 2016-11-03 08:06:31 -0500 | [diff] [blame] | 184 | parser.add_option("-m", "--mako", dest="elog_mako", |
| 185 | default="elog-gen-template.mako.hpp", |
Andrew Geissler | df048c1 | 2016-11-10 16:50:35 -0600 | [diff] [blame] | 186 | help="input mako template file to use") |
Andrew Geissler | 184690d | 2016-11-03 08:06:31 -0500 | [diff] [blame] | 187 | |
| 188 | parser.add_option("-o", "--output", dest="output_hpp", |
| 189 | default="elog-gen.hpp", |
Andrew Geissler | df048c1 | 2016-11-10 16:50:35 -0600 | [diff] [blame] | 190 | help="output hpp to generate, elog-gen.hpp is default") |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 191 | |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 192 | parser.add_option("-y", "--yamldir", dest="yamldir", |
| 193 | default="./example/xyz/openbmc_project/Example", |
Andrew Geissler | f1f2cfa | 2016-11-21 15:16:45 -0600 | [diff] [blame] | 194 | help="Base directory of yaml files to process") |
| 195 | |
| 196 | parser.add_option("-t", "--templatedir", dest="templatedir", |
| 197 | default="phosphor-logging/templates/", |
| 198 | help="Base directory of files to process") |
| 199 | |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 200 | parser.add_option("-n", "--namespace", dest="error_namespace", |
| 201 | default="example/xyz/openbmc_project/Example", |
| 202 | help="Error d-bus namespace") |
| 203 | |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 204 | (options, args) = parser.parse_args(i_args) |
| 205 | |
Deepak Kodihalli | 160d3e0 | 2017-01-17 04:25:22 -0600 | [diff] [blame] | 206 | gen_elog_hpp(options.yamldir, |
| 207 | options.output_hpp, |
| 208 | options.templatedir, |
| 209 | options.elog_mako, |
| 210 | options.error_namespace) |
Andrew Geissler | c830e0f | 2016-10-18 12:51:29 -0500 | [diff] [blame] | 211 | |
| 212 | # Only run if it's a script |
| 213 | if __name__ == '__main__': |
Andrew Geissler | 184690d | 2016-11-03 08:06:31 -0500 | [diff] [blame] | 214 | main(sys.argv[1:]) |