1 /* Python interface to symbols.
3 Copyright (C) 2008, 2009, 2010 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #include "exceptions.h"
25 #include "python-internal.h"
28 typedef struct sympy_symbol_object
{
30 /* The GDB symbol structure this object is wrapping. */
31 struct symbol
*symbol
;
32 /* A symbol object is associated with an objfile, so keep track with
33 doubly-linked list, rooted in the objfile. This lets us
34 invalidate the underlying struct symbol when the objfile is
36 struct sympy_symbol_object
*prev
;
37 struct sympy_symbol_object
*next
;
40 /* Require a valid symbol. All access to symbol_object->symbol should be
41 gated by this call. */
42 #define SYMPY_REQUIRE_VALID(symbol_obj, symbol) \
44 symbol = symbol_object_to_symbol (symbol_obj); \
47 PyErr_SetString (PyExc_RuntimeError, \
48 _("Symbol is invalid.")); \
53 static const struct objfile_data
*sympy_objfile_data_key
;
56 sympy_str (PyObject
*self
)
59 struct symbol
*symbol
= NULL
;
61 SYMPY_REQUIRE_VALID (self
, symbol
);
63 result
= PyString_FromString (SYMBOL_PRINT_NAME (symbol
));
69 sympy_get_symtab (PyObject
*self
, void *closure
)
71 struct symbol
*symbol
= NULL
;
73 SYMPY_REQUIRE_VALID (self
, symbol
);
75 return symtab_to_symtab_object (SYMBOL_SYMTAB (symbol
));
79 sympy_get_name (PyObject
*self
, void *closure
)
81 struct symbol
*symbol
= NULL
;
83 SYMPY_REQUIRE_VALID (self
, symbol
);
85 return PyString_FromString (SYMBOL_NATURAL_NAME (symbol
));
89 sympy_get_linkage_name (PyObject
*self
, void *closure
)
91 struct symbol
*symbol
= NULL
;
93 SYMPY_REQUIRE_VALID (self
, symbol
);
95 return PyString_FromString (SYMBOL_LINKAGE_NAME (symbol
));
99 sympy_get_print_name (PyObject
*self
, void *closure
)
101 struct symbol
*symbol
= NULL
;
103 SYMPY_REQUIRE_VALID (self
, symbol
);
105 return sympy_str (self
);
109 sympy_get_addr_class (PyObject
*self
, void *closure
)
111 struct symbol
*symbol
= NULL
;
113 SYMPY_REQUIRE_VALID (self
, symbol
);
115 return PyInt_FromLong (SYMBOL_CLASS (symbol
));
119 sympy_is_argument (PyObject
*self
, void *closure
)
121 struct symbol
*symbol
= NULL
;
123 SYMPY_REQUIRE_VALID (self
, symbol
);
125 return PyBool_FromLong (SYMBOL_IS_ARGUMENT (symbol
));
129 sympy_is_constant (PyObject
*self
, void *closure
)
131 struct symbol
*symbol
= NULL
;
132 enum address_class
class;
134 SYMPY_REQUIRE_VALID (self
, symbol
);
136 class = SYMBOL_CLASS (symbol
);
138 return PyBool_FromLong (class == LOC_CONST
|| class == LOC_CONST_BYTES
);
142 sympy_is_function (PyObject
*self
, void *closure
)
144 struct symbol
*symbol
= NULL
;
145 enum address_class
class;
147 SYMPY_REQUIRE_VALID (self
, symbol
);
149 class = SYMBOL_CLASS (symbol
);
151 return PyBool_FromLong (class == LOC_BLOCK
);
155 sympy_is_variable (PyObject
*self
, void *closure
)
157 struct symbol
*symbol
= NULL
;
158 enum address_class
class;
160 SYMPY_REQUIRE_VALID (self
, symbol
);
162 class = SYMBOL_CLASS (symbol
);
164 return PyBool_FromLong (!SYMBOL_IS_ARGUMENT (symbol
)
165 && (class == LOC_LOCAL
|| class == LOC_REGISTER
166 || class == LOC_STATIC
|| class == LOC_COMPUTED
167 || class == LOC_OPTIMIZED_OUT
));
170 /* Given a symbol, and a symbol_object that has previously been
171 allocated and initialized, populate the symbol_object with the
172 struct symbol data. Also, register the symbol_object life-cycle
173 with the life-cycle of the the object file associated with this
174 symbol, if needed. */
176 set_symbol (symbol_object
*obj
, struct symbol
*symbol
)
178 obj
->symbol
= symbol
;
180 if (SYMBOL_SYMTAB (symbol
))
182 obj
->next
= objfile_data (SYMBOL_SYMTAB (symbol
)->objfile
,
183 sympy_objfile_data_key
);
186 obj
->next
->prev
= obj
;
187 set_objfile_data (SYMBOL_SYMTAB (symbol
)->objfile
,
188 sympy_objfile_data_key
, obj
);
194 /* Create a new symbol object (gdb.Symbol) that encapsulates the struct
195 symbol object from GDB. */
197 symbol_to_symbol_object (struct symbol
*sym
)
199 symbol_object
*sym_obj
;
201 sym_obj
= PyObject_New (symbol_object
, &symbol_object_type
);
203 set_symbol (sym_obj
, sym
);
205 return (PyObject
*) sym_obj
;
208 /* Return the symbol that is wrapped by this symbol object. */
210 symbol_object_to_symbol (PyObject
*obj
)
212 if (! PyObject_TypeCheck (obj
, &symbol_object_type
))
214 return ((symbol_object
*) obj
)->symbol
;
218 sympy_dealloc (PyObject
*obj
)
220 symbol_object
*sym_obj
= (symbol_object
*) obj
;
223 sym_obj
->prev
->next
= sym_obj
->next
;
224 else if (SYMBOL_SYMTAB (sym_obj
->symbol
))
226 set_objfile_data (SYMBOL_SYMTAB (sym_obj
->symbol
)->objfile
,
227 sympy_objfile_data_key
, sym_obj
->next
);
230 sym_obj
->next
->prev
= sym_obj
->prev
;
231 sym_obj
->symbol
= NULL
;
235 gdb.lookup_symbol (name [, block] [, domain]) -> (symbol, is_field_of_this)
236 A tuple with 2 elements is always returned. The first is the symbol
237 object or None, the second is a boolean with the value of
238 is_a_field_of_this (see comment in lookup_symbol_in_language). */
240 gdbpy_lookup_symbol (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
242 int domain
= VAR_DOMAIN
, is_a_field_of_this
= 0;
244 static char *keywords
[] = { "name", "block", "domain", NULL
};
245 struct symbol
*symbol
;
246 PyObject
*block_obj
= NULL
, *ret_tuple
, *sym_obj
, *bool_obj
;
247 struct block
*block
= NULL
;
249 if (! PyArg_ParseTupleAndKeywords (args
, kw
, "s|O!i", keywords
, &name
,
250 &block_object_type
, &block_obj
, &domain
))
254 block
= block_object_to_block (block_obj
);
257 struct frame_info
*selected_frame
;
258 volatile struct gdb_exception except
;
260 TRY_CATCH (except
, RETURN_MASK_ALL
)
262 selected_frame
= get_selected_frame (_("No frame selected."));
263 block
= block_for_pc (get_frame_address_in_block (selected_frame
));
265 GDB_PY_HANDLE_EXCEPTION (except
);
268 symbol
= lookup_symbol (name
, block
, domain
, &is_a_field_of_this
);
270 ret_tuple
= PyTuple_New (2);
276 sym_obj
= symbol_to_symbol_object (symbol
);
279 Py_DECREF (ret_tuple
);
288 PyTuple_SET_ITEM (ret_tuple
, 0, sym_obj
);
290 bool_obj
= is_a_field_of_this
? Py_True
: Py_False
;
291 Py_INCREF (bool_obj
);
292 PyTuple_SET_ITEM (ret_tuple
, 1, bool_obj
);
297 /* This function is called when an objfile is about to be freed.
298 Invalidate the symbol as further actions on the symbol would result
299 in bad data. All access to obj->symbol should be gated by
300 SYMPY_REQUIRE_VALID which will raise an exception on invalid
303 del_objfile_symbols (struct objfile
*objfile
, void *datum
)
305 symbol_object
*obj
= datum
;
308 symbol_object
*next
= obj
->next
;
319 gdbpy_initialize_symbols (void)
321 if (PyType_Ready (&symbol_object_type
) < 0)
324 /* Register an objfile "free" callback so we can properly
325 invalidate symbol when an object file that is about to be
327 sympy_objfile_data_key
328 = register_objfile_data_with_cleanup (NULL
, del_objfile_symbols
);
330 PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_UNDEF", LOC_UNDEF
);
331 PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_CONST", LOC_CONST
);
332 PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_STATIC", LOC_STATIC
);
333 PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_REGISTER", LOC_REGISTER
);
334 PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_ARG", LOC_ARG
);
335 PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_REF_ARG", LOC_REF_ARG
);
336 PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_LOCAL", LOC_LOCAL
);
337 PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_TYPEDEF", LOC_TYPEDEF
);
338 PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_LABEL", LOC_LABEL
);
339 PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_BLOCK", LOC_BLOCK
);
340 PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_CONST_BYTES",
342 PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_UNRESOLVED", LOC_UNRESOLVED
);
343 PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_OPTIMIZED_OUT",
345 PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_COMPUTED", LOC_COMPUTED
);
346 PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_REGPARM_ADDR",
348 PyModule_AddIntConstant (gdb_module
, "SYMBOL_UNDEF_DOMAIN", UNDEF_DOMAIN
);
349 PyModule_AddIntConstant (gdb_module
, "SYMBOL_VAR_DOMAIN", VAR_DOMAIN
);
350 PyModule_AddIntConstant (gdb_module
, "SYMBOL_STRUCT_DOMAIN", STRUCT_DOMAIN
);
351 PyModule_AddIntConstant (gdb_module
, "SYMBOL_LABEL_DOMAIN", LABEL_DOMAIN
);
352 PyModule_AddIntConstant (gdb_module
, "SYMBOL_VARIABLES_DOMAIN",
354 PyModule_AddIntConstant (gdb_module
, "SYMBOL_FUNCTIONS_DOMAIN",
356 PyModule_AddIntConstant (gdb_module
, "SYMBOL_TYPES_DOMAIN", TYPES_DOMAIN
);
358 Py_INCREF (&symbol_object_type
);
359 PyModule_AddObject (gdb_module
, "Symbol", (PyObject
*) &symbol_object_type
);
364 static PyGetSetDef symbol_object_getset
[] = {
365 { "symtab", sympy_get_symtab
, NULL
,
366 "Symbol table in which the symbol appears.", NULL
},
367 { "name", sympy_get_name
, NULL
,
368 "Name of the symbol, as it appears in the source code.", NULL
},
369 { "linkage_name", sympy_get_linkage_name
, NULL
,
370 "Name of the symbol, as used by the linker (i.e., may be mangled).", NULL
},
371 { "print_name", sympy_get_print_name
, NULL
,
372 "Name of the symbol in a form suitable for output.\n\
373 This is either name or linkage_name, depending on whether the user asked GDB\n\
374 to display demangled or mangled names.", NULL
},
375 { "addr_class", sympy_get_addr_class
, NULL
, "Address class of the symbol." },
376 { "is_argument", sympy_is_argument
, NULL
,
377 "True if the symbol is an argument of a function." },
378 { "is_constant", sympy_is_constant
, NULL
,
379 "True if the symbol is a constant." },
380 { "is_function", sympy_is_function
, NULL
,
381 "True if the symbol is a function or method." },
382 { "is_variable", sympy_is_variable
, NULL
,
383 "True if the symbol is a variable." },
384 { NULL
} /* Sentinel */
387 PyTypeObject symbol_object_type
= {
388 PyObject_HEAD_INIT (NULL
)
390 "gdb.Symbol", /*tp_name*/
391 sizeof (symbol_object
), /*tp_basicsize*/
393 sympy_dealloc
, /*tp_dealloc*/
400 0, /*tp_as_sequence*/
404 sympy_str
, /*tp_str*/
408 Py_TPFLAGS_DEFAULT
, /*tp_flags*/
409 "GDB symbol object", /*tp_doc */
412 0, /*tp_richcompare */
413 0, /*tp_weaklistoffset */
418 symbol_object_getset
/*tp_getset */