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                      target_interface = sensor.get(
40                          'target_interface',
41                          'xyz.openbmc_project.Control.FanSpeed')
42                      factor = sensor.get('factor', 1)
43                      offset = sensor.get('offset', 0)
44                  %> \
45                      SensorDefinition{"${sensor['name']}",
46                                       ${has_target},
47                                       "${target_interface}",
48                                       ${factor},
49                                       ${offset}},
50                  %endfor
51                  },
52    },
53%endfor
54};
55
56##Function to generate the group creation lambda.
57##If a group were to ever need a different constructor,
58##it could be handled here.
59<%def name="get_lambda_contents(group)">
60            std::vector<std::string> names{
61            %for sensor in group['sensors']:
62                "${sensor['name']}",
63            %endfor
64            };
65            return std::make_unique<${group['class']}>(names);
66</%def>
67const std::vector<CreateGroupFunction> trustGroups
68{
69%for group in data.get('sensor_trust_groups', {}):
70    {
71        []()
72        {\
73${get_lambda_contents(group)}\
74        }
75    },
76%endfor
77};
78'''
79
80
81if __name__ == '__main__':
82    parser = ArgumentParser(
83        description="Phosphor fan monitor definition parser")
84
85    parser.add_argument('-m', '--monitor_yaml', dest='monitor_yaml',
86                        default="example/monitor.yaml",
87                        help='fan monitor definitional yaml')
88    parser.add_argument('-o', '--output_dir', dest='output_dir',
89                        default=".",
90                        help='output directory')
91    args = parser.parse_args()
92
93    if not args.monitor_yaml:
94        parser.print_usage()
95        sys.exit(-1)
96
97    with open(args.monitor_yaml, 'r') as monitor_input:
98        monitor_data = yaml.safe_load(monitor_input) or {}
99
100    #Do some minor input validation
101    for fan in monitor_data.get('fans', {}):
102        if ((fan['deviation'] < 0) or (fan['deviation'] > 100)):
103            sys.exit("Invalid deviation value " + str(fan['deviation']))
104
105    output_file = os.path.join(args.output_dir, "fan_monitor_defs.cpp")
106    with open(output_file, 'w') as output:
107        output.write(Template(tmpl).render(data=monitor_data))
108