Debian Codegraph @

libdrgn/build-aux/gen_constants.py

raw
1 # Copyright (c) Meta Platforms, Inc. and affiliates.
2 # SPDX-License-Identifier: LGPL-2.1-or-later
3
4 import re
5 import sys
6 from typing import NamedTuple, Sequence, TextIO, Tuple
7
8
9 class ConstantClass(NamedTuple):
10 name: str
11 enum_class: str
12 regex: str
13 constants: Sequence[Tuple[str, str]] = ()
14
15
16 CONSTANTS = (
17 ConstantClass("AbsenceReason", "Enum", r"DRGN_ABSENCE_REASON_([a-zA-Z0-9_]+)"),
18 ConstantClass("Architecture", "Enum", r"DRGN_ARCH_([a-zA-Z0-9_]+)"),
19 ConstantClass("FindObjectFlags", "Flag", r"DRGN_FIND_OBJECT_([a-zA-Z0-9_]+)"),
20 ConstantClass("KmodSearchMethod", "Enum", r"DRGN_KMOD_SEARCH_([a-zA-Z0-9_]+)"),
21 ConstantClass("ModuleFileStatus", "Enum", r"DRGN_MODULE_FILE_([a-zA-Z0-9_]+)"),
22 ConstantClass(
23 "PlatformFlags",
24 "Flag",
25 r"DRGN_PLATFORM_([a-zA-Z0-9_]+)(?<!DRGN_PLATFORM_DEFAULT_FLAGS)",
26 ),
27 ConstantClass("PrimitiveType", "Enum", r"DRGN_(C)_TYPE_([a-zA-Z0-9_]+)"),
28 ConstantClass(
29 "ProgramFlags", "Flag", r"DRGN_PROGRAM_([a-zA-Z0-9_]+)(?<!DRGN_PROGRAM_ENDIAN)"
30 ),
31 ConstantClass(
32 "Qualifiers", "Flag", r"DRGN_QUALIFIER_([a-zA-Z0-9_]+)", [("NONE", "0")]
33 ),
34 ConstantClass(
35 "SupplementaryFileKind",
36 "Enum",
37 r"DRGN_SUPPLEMENTARY_FILE_([a-z-A-Z0-9_]+)(?<!DRGN_SUPPLEMENTARY_FILE_NONE)",
38 ),
39 ConstantClass("SymbolBinding", "Enum", r"DRGN_SYMBOL_BINDING_([a-z-A-Z0-9_]+)"),
40 ConstantClass("SymbolKind", "Enum", r"DRGN_SYMBOL_KIND_([a-z-A-Z0-9_]+)"),
41 ConstantClass("TypeKind", "Enum", r"DRGN_TYPE_([a-zA-Z0-9_]+)"),
42 )
43
44
45 def gen_constant_class(
46 drgn_h: str, output_file: TextIO, constant_class: ConstantClass
47 ) -> None:
48 constants = list(constant_class.constants)
49 constants.extend(
50 ("_".join(groups[1:]), groups[0])
51 for groups in re.findall(
52 r"^\s*(" + constant_class.regex + r")\s*[=,]", drgn_h, flags=re.MULTILINE
53 )
54 )
55 output_file.write(
56 f"""
57 static int add_{constant_class.name}(PyObject *m, PyObject *enum_module)
58 {{
59 PyObject *tmp, *item;
60 int ret = -1;
61
62 tmp = PyList_New({len(constants)});
63 if (!tmp)
64 goto out;
65 """
66 )
67 for i, (name, value) in enumerate(constants):
68 output_file.write(
69 f"""\
70 item = Py_BuildValue("sK", "{name}", (unsigned long long){value});
71 if (!item)
72 goto out;
73 PyList_SET_ITEM(tmp, {i}, item);
74 """
75 )
76 output_file.write(
77 f"""\
78 {constant_class.name}_class = PyObject_CallMethod(enum_module, "{constant_class.enum_class}", "sO", "{constant_class.name}", tmp);
79 if (PyModule_AddObjectRef(m, "{constant_class.name}", {constant_class.name}_class))
80 goto out;
81 Py_DECREF(tmp);
82 tmp = PyUnicode_FromString(drgn_{constant_class.name}_DOC);
83 if (!tmp)
84 goto out;
85 if (PyObject_SetAttrString({constant_class.name}_class, "__doc__", tmp) == -1)
86 goto out;
87
88 ret = 0;
89 out:
90 Py_XDECREF(tmp);
91 return ret;
92 }}
93 """
94 )
95
96
97 def gen_constants(input_file: TextIO, output_file: TextIO) -> None:
98 drgn_h = input_file.read()
99 output_file.write(
100 """\
101 /* Generated by libdrgn/build-aux/gen_constants.py. */
102
103 #include "drgnpy.h"
104
105 """
106 )
107 for constant_class in CONSTANTS:
108 output_file.write(f"PyObject *{constant_class.name}_class;\n")
109 for constant_class in CONSTANTS:
110 gen_constant_class(drgn_h, output_file, constant_class)
111 output_file.write(
112 """
113 int add_module_constants(PyObject *m)
114 {
115 PyObject *enum_module;
116 int ret;
117
118 enum_module = PyImport_ImportModule("enum");
119 if (!enum_module)
120 return -1;
121
122 """
123 )
124 for i, constant_class in enumerate(CONSTANTS):
125 if i == 0:
126 output_file.write("\tif (")
127 else:
128 output_file.write("\t ")
129 output_file.write(f"add_{constant_class.name}(m, enum_module) == -1")
130 if i == len(CONSTANTS) - 1:
131 output_file.write(")\n")
132 else:
133 output_file.write(" ||\n")
134 output_file.write(
135 """\
136 ret = -1;
137 else
138 ret = 0;
139 Py_DECREF(enum_module);
140 return ret;
141 }
142 """
143 )
144
145
146 if __name__ == "__main__":
147 gen_constants(sys.stdin, sys.stdout)