forked from mirrors/gecko-dev
55a00a13ea
The "products" property is optional and defaults to `firefox, fennec`. Recording of scalars is disabled if the probe doesn't have the products property for the current running product. MozReview-Commit-ID: 4HVBrBw1lls --HG-- extra : rebase_source : 5820a8bc8a9397db4ed728354cbb10984bb04946
135 lines
4.3 KiB
Python
135 lines
4.3 KiB
Python
# 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 scalar information for C++. The scalars are defined
|
|
# in a file provided as a command-line argument.
|
|
|
|
from __future__ import print_function
|
|
from collections import OrderedDict
|
|
from shared_telemetry_utils import StringTable, static_assert, ParserError
|
|
|
|
import json
|
|
import parse_scalars
|
|
import sys
|
|
|
|
# The banner/text at the top of the generated file.
|
|
banner = """/* This file is auto-generated, only for internal use in TelemetryScalar.h,
|
|
see gen_scalar_data.py. */
|
|
"""
|
|
|
|
file_header = """\
|
|
#ifndef mozilla_TelemetryScalarData_h
|
|
#define mozilla_TelemetryScalarData_h
|
|
#include "ScalarInfo.h"
|
|
namespace {
|
|
"""
|
|
|
|
file_footer = """\
|
|
} // namespace
|
|
#endif // mozilla_TelemetryScalarData_h
|
|
"""
|
|
|
|
|
|
def write_scalar_info(scalar, output, name_index, expiration_index):
|
|
"""Writes a scalar entry to the output file.
|
|
|
|
:param scalar: a ScalarType instance describing the scalar.
|
|
:param output: the output stream.
|
|
:param name_index: the index of the scalar name in the strings table.
|
|
:param expiration_index: the index of the expiration version in the strings table.
|
|
"""
|
|
cpp_guard = scalar.cpp_guard
|
|
if cpp_guard:
|
|
print("#if defined(%s)" % cpp_guard, file=output)
|
|
|
|
print(" {{ {}, {}, {}, {}, {}, {}, {} }},"
|
|
.format(scalar.nsITelemetry_kind,
|
|
name_index,
|
|
expiration_index,
|
|
scalar.dataset,
|
|
" | ".join(scalar.record_in_processes_enum),
|
|
"true" if scalar.keyed else "false",
|
|
" | ".join(scalar.products_enum)),
|
|
file=output)
|
|
|
|
if cpp_guard:
|
|
print("#endif", file=output)
|
|
|
|
|
|
def write_scalar_tables(scalars, output):
|
|
"""Writes the scalar and strings tables to an header file.
|
|
|
|
:param scalars: a list of ScalarType instances describing the scalars.
|
|
:param output: the output stream.
|
|
"""
|
|
string_table = StringTable()
|
|
|
|
print("const ScalarInfo gScalars[] = {", file=output)
|
|
for s in scalars:
|
|
# We add both the scalar label and the expiration string to the strings
|
|
# table.
|
|
name_index = string_table.stringIndex(s.label)
|
|
exp_index = string_table.stringIndex(s.expires)
|
|
# Write the scalar info entry.
|
|
write_scalar_info(s, output, name_index, exp_index)
|
|
print("};", file=output)
|
|
|
|
string_table_name = "gScalarsStringTable"
|
|
string_table.writeDefinition(output, string_table_name)
|
|
static_assert(output, "sizeof(%s) <= UINT32_MAX" % string_table_name,
|
|
"index overflow")
|
|
|
|
|
|
def parse_scalar_definitions(filenames):
|
|
if len(filenames) > 1:
|
|
raise Exception('We don\'t support loading from more than one file.')
|
|
|
|
try:
|
|
return parse_scalars.load_scalars(filenames[0])
|
|
except ParserError as ex:
|
|
print("\nError processing scalars:\n" + str(ex) + "\n")
|
|
sys.exit(1)
|
|
|
|
|
|
def generate_JSON_definitions(output, *filenames):
|
|
""" Write the scalar definitions to a JSON file.
|
|
|
|
:param output: the file to write the content to.
|
|
:param filenames: a list of filenames provided by the build system.
|
|
We only support a single file.
|
|
"""
|
|
scalars = parse_scalar_definitions(filenames)
|
|
|
|
scalar_definitions = OrderedDict()
|
|
for scalar in scalars:
|
|
category = scalar.category
|
|
|
|
if category not in scalar_definitions:
|
|
scalar_definitions[category] = OrderedDict()
|
|
|
|
scalar_definitions[category][scalar.name] = OrderedDict({
|
|
'kind': scalar.nsITelemetry_kind,
|
|
'keyed': scalar.keyed,
|
|
'record_on_release': True if scalar.dataset_short == 'opt-out' else False,
|
|
# We don't expire dynamic-builtin scalars: they're only meant for
|
|
# use in local developer builds anyway. They will expire when rebuilding.
|
|
'expired': False,
|
|
})
|
|
|
|
json.dump(scalar_definitions, output)
|
|
|
|
|
|
def main(output, *filenames):
|
|
# Load the scalars first.
|
|
scalars = parse_scalar_definitions(filenames)
|
|
|
|
# Write the scalar data file.
|
|
print(banner, file=output)
|
|
print(file_header, file=output)
|
|
write_scalar_tables(scalars, output)
|
|
print(file_footer, file=output)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main(sys.stdout, *sys.argv[1:])
|