Debian Codegraph @

libdrgn/python/symbol.c

raw
1 // Copyright (c) Meta Platforms, Inc. and affiliates.
2 // SPDX-License-Identifier: LGPL-2.1-or-later
3
4 #include <inttypes.h>
5
6 #include "drgnpy.h"
7
8 PyObject *Symbol_wrap(struct drgn_symbol *sym, PyObject *name_obj)
9 {
10 Symbol *ret = call_tp_alloc(Symbol);
11 if (ret) {
12 ret->sym = sym;
13 ret->name_obj = name_obj;
14 Py_XINCREF(name_obj);
15 }
16 return (PyObject *)ret;
17 }
18
19 PyObject *Symbol_list_wrap(struct drgn_symbol **symbols, size_t count,
20 PyObject *name_obj)
21 {
22 _cleanup_pydecref_ PyObject *list = PyList_New(count);
23 if (!list) {
24 drgn_symbols_destroy(symbols, count);
25 return NULL;
26 }
27 for (size_t i = 0; i < count; i++) {
28 PyObject *pysym = Symbol_wrap(symbols[i], name_obj);
29 if (!pysym) {
30 /* Free symbols which aren't yet added to list. */
31 drgn_symbols_destroy(symbols, count);
32 /* Free list and all symbols already added. */
33 return NULL;
34 }
35 symbols[i] = NULL;
36 PyList_SET_ITEM(list, i, pysym);
37 }
38 free(symbols);
39 return_ptr(list);
40 }
41
42 static PyObject *Symbol_new(PyTypeObject *subtype, PyObject *args, PyObject *kwds)
43 {
44 struct drgn_symbol *sym;
45 static char *keywords[] = {"name", "address", "size", "binding", "kind", NULL};
46 PyObject *name_obj;
47 struct index_arg address = {}, size = {};
48 struct enum_arg binding = {
49 .type = SymbolBinding_class,
50 };
51 struct enum_arg kind = {
52 .type = SymbolKind_class,
53 };
54
55 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O!O&O&O&O&:Symbol", keywords,
56 &PyUnicode_Type, &name_obj,
57 index_converter, &address,
58 index_converter, &size,
59 enum_converter, &binding,
60 enum_converter, &kind))
61 return NULL;
62
63 const char *name = PyUnicode_AsUTF8(name_obj);
64 if (!name)
65 return NULL;
66
67 struct drgn_error *err = drgn_symbol_create(
68 name, address.uvalue,size.uvalue, binding.value, kind.value,
69 DRGN_LIFETIME_EXTERNAL, &sym);
70 if (err)
71 return set_drgn_error(err);
72
73 PyObject *ret = Symbol_wrap(sym, name_obj);
74 if (!ret)
75 drgn_symbol_destroy(sym);
76 return ret;
77 }
78
79 static void Symbol_dealloc(Symbol *self)
80 {
81 drgn_symbol_destroy(self->sym);
82 Py_XDECREF(self->name_obj);
83 Py_TYPE(self)->tp_free((PyObject *)self);
84 }
85
86 static PyObject *Symbol_richcompare(Symbol *self, PyObject *other, int op)
87 {
88 if (!PyObject_TypeCheck(other, &Symbol_type) ||
89 (op != Py_EQ && op != Py_NE))
90 Py_RETURN_NOTIMPLEMENTED;
91 bool ret = drgn_symbol_eq(self->sym, ((Symbol *)other)->sym);
92 if (op == Py_NE)
93 ret = !ret;
94 Py_RETURN_BOOL(ret);
95 }
96
97 static PyObject *Symbol_get_name(Symbol *self, void *arg)
98 {
99 return PyUnicode_FromString(drgn_symbol_name(self->sym));
100 }
101
102 static PyObject *Symbol_get_address(Symbol *self, void *arg)
103 {
104 return PyLong_FromUInt64(drgn_symbol_address(self->sym));
105 }
106
107 static PyObject *Symbol_get_size(Symbol *self, void *arg)
108 {
109 return PyLong_FromUInt64(drgn_symbol_size(self->sym));
110 }
111
112 static PyObject *Symbol_get_binding(Symbol *self, void *arg)
113 {
114 return PyObject_CallFunction(SymbolBinding_class, "k",
115 (unsigned long)drgn_symbol_binding(self->sym));
116 }
117
118 static PyObject *Symbol_get_kind(Symbol *self, void *arg)
119 {
120 return PyObject_CallFunction(SymbolKind_class, "k",
121 (unsigned long)drgn_symbol_kind(self->sym));
122 }
123
124 static PyObject *Symbol_repr(Symbol *self)
125 {
126 _cleanup_pydecref_ PyObject *name =
127 PyUnicode_FromString(drgn_symbol_name(self->sym));
128 if (!name)
129 return NULL;
130 _cleanup_pydecref_ PyObject *binding = Symbol_get_binding(self, NULL);
131 if (!binding)
132 return NULL;
133 _cleanup_pydecref_ PyObject *kind = Symbol_get_kind(self, NULL);
134 if (!kind)
135 return NULL;
136
137 char address[19], size[19];
138 sprintf(address, "0x%" PRIx64, drgn_symbol_address(self->sym));
139 sprintf(size, "0x%" PRIx64, drgn_symbol_size(self->sym));
140 return PyUnicode_FromFormat("Symbol(name=%R, address=%s, size=%s, binding=%R, kind=%R)",
141 name, address, size, binding, kind);
142 }
143
144 static PyGetSetDef Symbol_getset[] = {
145 {"name", (getter)Symbol_get_name, NULL, drgn_Symbol_name_DOC},
146 {"address", (getter)Symbol_get_address, NULL, drgn_Symbol_address_DOC},
147 {"size", (getter)Symbol_get_size, NULL, drgn_Symbol_size_DOC},
148 {"binding", (getter)Symbol_get_binding, NULL, drgn_Symbol_binding_DOC},
149 {"kind", (getter)Symbol_get_kind, NULL, drgn_Symbol_kind_DOC},
150 {},
151 };
152
153 PyTypeObject Symbol_type = {
154 PyVarObject_HEAD_INIT(NULL, 0)
155 .tp_name = "_drgn.Symbol",
156 .tp_basicsize = sizeof(Symbol),
157 .tp_dealloc = (destructor)Symbol_dealloc,
158 .tp_repr = (reprfunc)Symbol_repr,
159 // Only references str objects, no GC needed.
160 .tp_flags = Py_TPFLAGS_DEFAULT,
161 .tp_doc = drgn_Symbol_DOC,
162 .tp_richcompare = (richcmpfunc)Symbol_richcompare,
163 .tp_getset = Symbol_getset,
164 .tp_new = Symbol_new,
165 };