summaryrefslogtreecommitdiffstats
path: root/toolkit/components/telemetry/build_scripts/gen_userinteraction_phf.py
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
commit36d22d82aa202bb199967e9512281e9a53db42c9 (patch)
tree105e8c98ddea1c1e4784a60a5a6410fa416be2de /toolkit/components/telemetry/build_scripts/gen_userinteraction_phf.py
parentInitial commit. (diff)
downloadfirefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.tar.xz
firefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.zip
Adding upstream version 115.7.0esr.upstream/115.7.0esr
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'toolkit/components/telemetry/build_scripts/gen_userinteraction_phf.py')
-rw-r--r--toolkit/components/telemetry/build_scripts/gen_userinteraction_phf.py70
1 files changed, 70 insertions, 0 deletions
diff --git a/toolkit/components/telemetry/build_scripts/gen_userinteraction_phf.py b/toolkit/components/telemetry/build_scripts/gen_userinteraction_phf.py
new file mode 100644
index 0000000000..f1c7256414
--- /dev/null
+++ b/toolkit/components/telemetry/build_scripts/gen_userinteraction_phf.py
@@ -0,0 +1,70 @@
+# 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/.
+
+from mozparsers.shared_telemetry_utils import ParserError
+from perfecthash import PerfectHash
+
+PHFSIZE = 1024
+
+import sys
+
+from mozparsers import parse_user_interactions
+
+banner = """/* This file is auto-generated, see gen_userinteraction_phf.py. */
+"""
+
+header = """
+#ifndef mozilla_TelemetryUserInteractionNameMap_h
+#define mozilla_TelemetryUserInteractionNameMap_h
+
+#include "mozilla/PerfectHash.h"
+
+namespace mozilla {
+namespace Telemetry {
+"""
+
+footer = """
+} // namespace mozilla
+} // namespace Telemetry
+#endif // mozilla_TelemetryUserInteractionNameMap_h
+"""
+
+
+def main(output, *filenames):
+ """
+ Generate a Perfect Hash Table for the UserInteraction name -> UserInteraction ID lookup.
+ The table is immutable once generated and we can avoid any dynamic memory allocation.
+ """
+
+ output.write(banner)
+ output.write(header)
+
+ try:
+ user_interactions = list(parse_user_interactions.from_files(filenames))
+ except ParserError as ex:
+ print("\nError processing UserInteractions:\n" + str(ex) + "\n")
+ sys.exit(1)
+
+ user_interactions = [
+ (bytearray(ui.label, "ascii"), idx)
+ for (idx, ui) in enumerate(user_interactions)
+ ]
+ name_phf = PerfectHash(user_interactions, PHFSIZE)
+
+ output.write(
+ name_phf.cxx_codegen(
+ name="UserInteractionIDByNameLookup",
+ entry_type="uint32_t",
+ lower_entry=lambda x: str(x[1]),
+ key_type="const nsACString&",
+ key_bytes="aKey.BeginReading()",
+ key_length="aKey.Length()",
+ )
+ )
+
+ output.write(footer)
+
+
+if __name__ == "__main__":
+ main(sys.stdout, *sys.argv[1:])