toolkit/components/telemetry/gen-process-data.py
author Georg Fritzsche <georg.fritzsche@googlemail.com>
Mon, 22 May 2017 15:33:29 +0700
changeset 359994 78e8b1f01c25b51564815772c4fa869cb38755b0
permissions -rw-r--r--
Bug 1361661 - Part 1: Generate headers with process data from Processes.yaml. r=dexter Adding the Gecko enums to Processes.yaml allows us to generate mappings from ProcessID to GeckoProcessType. We generate string tables with the Telemetry process names, so we can use these names consistently throughout Telemetry.

# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.

# Write out processes data for C++. The processes are defined
# in a file provided as a command-line argument.

from __future__ import print_function
from shared_telemetry_utils import ParserError, load_processes

import sys
import collections

# The banner/text at the top of the generated file.
banner = """/* This file is auto-generated from Telemetry build scripts,
   see gen-processes-data.py. */
"""

file_header = """\
#ifndef mozilla_TelemetryProcessData_h
#define mozilla_TelemetryProcessData_h

#include "mozilla/TelemetryProcessEnums.h"

namespace mozilla {
namespace Telemetry {
"""

file_footer = """
} // namespace Telemetry
} // namespace mozilla
#endif // mozilla_TelemetryProcessData_h"""


def to_enum_label(name):
    return name.title().replace('_', '')


def write_processes_data(processes, output):
    def p(line):
        print(line, file=output)
    processes = collections.OrderedDict(processes)

    p("static GeckoProcessType ProcessIDToGeckoProcessType[%d] = {" % len(processes))
    for i, (name, value) in enumerate(processes.iteritems()):
        p("  /* %d: ProcessID::%s = */ %s," % (i, to_enum_label(name), value['gecko_enum']))
    p("};")
    p("")
    p("static const char* const ProcessIDToString[%d] = {" % len(processes))
    for i, (name, value) in enumerate(processes.iteritems()):
        p("  /* %d: ProcessID::%s = */ \"%s\"," % (i, to_enum_label(name), name))
    p("};")


def main(output, *filenames):
    if len(filenames) > 1:
        raise Exception('We don\'t support loading from more than one file.')

    try:
        processes = load_yaml_file(filenames[0])

        # Write the process data file.
        print(banner, file=output)
        print(file_header, file=output)
        write_processes_data(processes, output)
        print(file_footer, file=output)
    except ParserError as ex:
        print("\nError generating processes data:\n" + str(ex) + "\n")
        sys.exit(1)

if __name__ == '__main__':
    main(sys.stdout, *sys.argv[1:])