xref: /openbmc/phosphor-fan-presence/monitor/gen-fan-monitor-defs.py (revision 8e5d197b840d4498dcb714b60cc1d38202a7a7a7) 
1#!/usr/bin/env python
2
3import os
4import sys
5import yaml
6from argparse import ArgumentParser
7from mako.template import Template
8
9"""
10This script generates the data structures for the
11phosphor-fan-monitor application.
12
13A future improvement is to get the fan inventory names
14from a separate file, so just that file could be generated
15from the MRW.
16"""
17
18
19tmpl = '''/* This is a generated file. */
20#include "fan_defs.hpp"
21#include "types.hpp"
22#include "groups.hpp"
23
24using namespace phosphor::fan::monitor;
25using namespace phosphor::fan::trust;
26
27const std::vector<FanDefinition> fanDefinitions
28{
29%for fan_data in data.get('fans', {}):
30    FanDefinition{"${fan_data['inventory']}",
31                  ${fan_data['allowed_out_of_range_time']},
32                  ${fan_data['deviation']},
33                  ${fan_data['num_sensors_nonfunc_for_fan_nonfunc']},
34                  std::vector<SensorDefinition>{
35                  %for sensor in fan_data['sensors']:
36                  <%
37                      #has_target is a bool, and we need a true instead of True
38                      has_target = str(sensor['has_target']).lower()
39                      factor = sensor.get('factor', 1)
40                      offset = sensor.get('offset', 0)
41                  %> \
42                      SensorDefinition{"${sensor['name']}",
43                                       ${has_target},
44                                       ${factor},
45                                       ${offset}},
46                  %endfor
47                  },
48    },
49%endfor
50};
51
52##Function to generate the group creation lambda.
53##If a group were to ever need a different constructor,
54##it could be handled here.
55<%def name="get_lambda_contents(group)">
56            std::vector<std::string> names{
57            %for sensor in group['sensors']:
58                "${sensor['name']}",
59            %endfor
60            };
61            return std::make_unique<${group['class']}>(names);
62</%def>
63const std::vector<CreateGroupFunction> trustGroups
64{
65%for group in data.get('sensor_trust_groups', {}):
66    {
67        []()
68        {\
69${get_lambda_contents(group)}\
70        }
71    },
72%endfor
73};
74'''
75
76
77if __name__ == '__main__':
78    parser = ArgumentParser(
79        description="Phosphor fan monitor definition parser")
80
81    parser.add_argument('-m', '--monitor_yaml', dest='monitor_yaml',
82                        default="example/monitor.yaml",
83                        help='fan monitor definitional yaml')
84    parser.add_argument('-o', '--output_dir', dest='output_dir',
85                        default=".",
86                        help='output directory')
87    args = parser.parse_args()
88
89    if not args.monitor_yaml:
90        parser.print_usage()
91        sys.exit(-1)
92
93    with open(args.monitor_yaml, 'r') as monitor_input:
94        monitor_data = yaml.safe_load(monitor_input) or {}
95
96    #Do some minor input validation
97    for fan in monitor_data.get('fans', {}):
98        if ((fan['deviation'] < 0) or (fan['deviation'] > 100)):
99            sys.exit("Invalid deviation value " + str(fan['deviation']))
100
101    output_file = os.path.join(args.output_dir, "fan_monitor_defs.cpp")
102    with open(output_file, 'w') as output:
103        output.write(Template(tmpl).render(data=monitor_data))
104