1 /* Python interface to symbols.
3 Copyright (C) 2008-2019 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/>. */
24 #include "python-internal.h"
27 typedef struct sympy_symbol_object
{
29 /* The GDB symbol structure this object is wrapping. */
30 struct symbol
*symbol
;
31 /* A symbol object is associated with an objfile, so keep track with
32 doubly-linked list, rooted in the objfile. This lets us
33 invalidate the underlying struct symbol when the objfile is
35 struct sympy_symbol_object
*prev
;
36 struct sympy_symbol_object
*next
;
39 /* Require a valid symbol. All access to symbol_object->symbol should be
40 gated by this call. */
41 #define SYMPY_REQUIRE_VALID(symbol_obj, symbol) \
43 symbol = symbol_object_to_symbol (symbol_obj); \
46 PyErr_SetString (PyExc_RuntimeError, \
47 _("Symbol is invalid.")); \
52 static const struct objfile_data
*sympy_objfile_data_key
;
55 sympy_str (PyObject
*self
)
58 struct symbol
*symbol
= NULL
;
60 SYMPY_REQUIRE_VALID (self
, symbol
);
62 result
= PyString_FromString (SYMBOL_PRINT_NAME (symbol
));
68 sympy_get_type (PyObject
*self
, void *closure
)
70 struct symbol
*symbol
= NULL
;
72 SYMPY_REQUIRE_VALID (self
, symbol
);
74 if (SYMBOL_TYPE (symbol
) == NULL
)
80 return type_to_type_object (SYMBOL_TYPE (symbol
));
84 sympy_get_symtab (PyObject
*self
, void *closure
)
86 struct symbol
*symbol
= NULL
;
88 SYMPY_REQUIRE_VALID (self
, symbol
);
90 if (!SYMBOL_OBJFILE_OWNED (symbol
))
93 return symtab_to_symtab_object (symbol_symtab (symbol
));
97 sympy_get_name (PyObject
*self
, void *closure
)
99 struct symbol
*symbol
= NULL
;
101 SYMPY_REQUIRE_VALID (self
, symbol
);
103 return PyString_FromString (SYMBOL_NATURAL_NAME (symbol
));
107 sympy_get_linkage_name (PyObject
*self
, void *closure
)
109 struct symbol
*symbol
= NULL
;
111 SYMPY_REQUIRE_VALID (self
, symbol
);
113 return PyString_FromString (SYMBOL_LINKAGE_NAME (symbol
));
117 sympy_get_print_name (PyObject
*self
, void *closure
)
119 struct symbol
*symbol
= NULL
;
121 SYMPY_REQUIRE_VALID (self
, symbol
);
123 return sympy_str (self
);
127 sympy_get_addr_class (PyObject
*self
, void *closure
)
129 struct symbol
*symbol
= NULL
;
131 SYMPY_REQUIRE_VALID (self
, symbol
);
133 return PyInt_FromLong (SYMBOL_CLASS (symbol
));
137 sympy_is_argument (PyObject
*self
, void *closure
)
139 struct symbol
*symbol
= NULL
;
141 SYMPY_REQUIRE_VALID (self
, symbol
);
143 return PyBool_FromLong (SYMBOL_IS_ARGUMENT (symbol
));
147 sympy_is_constant (PyObject
*self
, void *closure
)
149 struct symbol
*symbol
= NULL
;
150 enum address_class theclass
;
152 SYMPY_REQUIRE_VALID (self
, symbol
);
154 theclass
= SYMBOL_CLASS (symbol
);
156 return PyBool_FromLong (theclass
== LOC_CONST
|| theclass
== LOC_CONST_BYTES
);
160 sympy_is_function (PyObject
*self
, void *closure
)
162 struct symbol
*symbol
= NULL
;
163 enum address_class theclass
;
165 SYMPY_REQUIRE_VALID (self
, symbol
);
167 theclass
= SYMBOL_CLASS (symbol
);
169 return PyBool_FromLong (theclass
== LOC_BLOCK
);
173 sympy_is_variable (PyObject
*self
, void *closure
)
175 struct symbol
*symbol
= NULL
;
176 enum address_class theclass
;
178 SYMPY_REQUIRE_VALID (self
, symbol
);
180 theclass
= SYMBOL_CLASS (symbol
);
182 return PyBool_FromLong (!SYMBOL_IS_ARGUMENT (symbol
)
183 && (theclass
== LOC_LOCAL
|| theclass
== LOC_REGISTER
184 || theclass
== LOC_STATIC
|| theclass
== LOC_COMPUTED
185 || theclass
== LOC_OPTIMIZED_OUT
));
188 /* Implementation of gdb.Symbol.needs_frame -> Boolean.
189 Returns true iff the symbol needs a frame for evaluation. */
192 sympy_needs_frame (PyObject
*self
, void *closure
)
194 struct symbol
*symbol
= NULL
;
197 SYMPY_REQUIRE_VALID (self
, symbol
);
201 result
= symbol_read_needs_frame (symbol
);
203 catch (const gdb_exception
&except
)
205 GDB_PY_HANDLE_EXCEPTION (except
);
213 /* Implementation of gdb.Symbol.line -> int.
214 Returns the line number at which the symbol was defined. */
217 sympy_line (PyObject
*self
, void *closure
)
219 struct symbol
*symbol
= NULL
;
221 SYMPY_REQUIRE_VALID (self
, symbol
);
223 return PyInt_FromLong (SYMBOL_LINE (symbol
));
226 /* Implementation of gdb.Symbol.is_valid (self) -> Boolean.
227 Returns True if this Symbol still exists in GDB. */
230 sympy_is_valid (PyObject
*self
, PyObject
*args
)
232 struct symbol
*symbol
= NULL
;
234 symbol
= symbol_object_to_symbol (self
);
241 /* Implementation of gdb.Symbol.value (self[, frame]) -> gdb.Value. Returns
242 the value of the symbol, or an error in various circumstances. */
245 sympy_value (PyObject
*self
, PyObject
*args
)
247 struct symbol
*symbol
= NULL
;
248 struct frame_info
*frame_info
= NULL
;
249 PyObject
*frame_obj
= NULL
;
250 struct value
*value
= NULL
;
252 if (!PyArg_ParseTuple (args
, "|O", &frame_obj
))
255 if (frame_obj
!= NULL
&& !PyObject_TypeCheck (frame_obj
, &frame_object_type
))
257 PyErr_SetString (PyExc_TypeError
, "argument is not a frame");
261 SYMPY_REQUIRE_VALID (self
, symbol
);
262 if (SYMBOL_CLASS (symbol
) == LOC_TYPEDEF
)
264 PyErr_SetString (PyExc_TypeError
, "cannot get the value of a typedef");
270 if (frame_obj
!= NULL
)
272 frame_info
= frame_object_to_frame_info (frame_obj
);
273 if (frame_info
== NULL
)
274 error (_("invalid frame"));
277 if (symbol_read_needs_frame (symbol
) && frame_info
== NULL
)
278 error (_("symbol requires a frame to compute its value"));
280 /* TODO: currently, we have no way to recover the block in which SYMBOL
281 was found, so we have no block to pass to read_var_value. This will
282 yield an incorrect value when symbol is not local to FRAME_INFO (this
283 can happen with nested functions). */
284 value
= read_var_value (symbol
, NULL
, frame_info
);
286 catch (const gdb_exception
&except
)
288 GDB_PY_HANDLE_EXCEPTION (except
);
291 return value_to_value_object (value
);
294 /* Given a symbol, and a symbol_object that has previously been
295 allocated and initialized, populate the symbol_object with the
296 struct symbol data. Also, register the symbol_object life-cycle
297 with the life-cycle of the object file associated with this
298 symbol, if needed. */
300 set_symbol (symbol_object
*obj
, struct symbol
*symbol
)
302 obj
->symbol
= symbol
;
304 if (SYMBOL_OBJFILE_OWNED (symbol
)
305 && symbol_symtab (symbol
) != NULL
)
307 struct objfile
*objfile
= symbol_objfile (symbol
);
309 obj
->next
= ((struct sympy_symbol_object
*)
310 objfile_data (objfile
, sympy_objfile_data_key
));
312 obj
->next
->prev
= obj
;
313 set_objfile_data (objfile
, sympy_objfile_data_key
, obj
);
319 /* Create a new symbol object (gdb.Symbol) that encapsulates the struct
320 symbol object from GDB. */
322 symbol_to_symbol_object (struct symbol
*sym
)
324 symbol_object
*sym_obj
;
326 sym_obj
= PyObject_New (symbol_object
, &symbol_object_type
);
328 set_symbol (sym_obj
, sym
);
330 return (PyObject
*) sym_obj
;
333 /* Return the symbol that is wrapped by this symbol object. */
335 symbol_object_to_symbol (PyObject
*obj
)
337 if (! PyObject_TypeCheck (obj
, &symbol_object_type
))
339 return ((symbol_object
*) obj
)->symbol
;
343 sympy_dealloc (PyObject
*obj
)
345 symbol_object
*sym_obj
= (symbol_object
*) obj
;
348 sym_obj
->prev
->next
= sym_obj
->next
;
349 else if (sym_obj
->symbol
!= NULL
350 && SYMBOL_OBJFILE_OWNED (sym_obj
->symbol
)
351 && symbol_symtab (sym_obj
->symbol
) != NULL
)
353 set_objfile_data (symbol_objfile (sym_obj
->symbol
),
354 sympy_objfile_data_key
, sym_obj
->next
);
357 sym_obj
->next
->prev
= sym_obj
->prev
;
358 sym_obj
->symbol
= NULL
;
362 gdb.lookup_symbol (name [, block] [, domain]) -> (symbol, is_field_of_this)
363 A tuple with 2 elements is always returned. The first is the symbol
364 object or None, the second is a boolean with the value of
365 is_a_field_of_this (see comment in lookup_symbol_in_language). */
368 gdbpy_lookup_symbol (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
370 int domain
= VAR_DOMAIN
;
371 struct field_of_this_result is_a_field_of_this
;
373 static const char *keywords
[] = { "name", "block", "domain", NULL
};
374 struct symbol
*symbol
= NULL
;
375 PyObject
*block_obj
= NULL
, *sym_obj
, *bool_obj
;
376 const struct block
*block
= NULL
;
378 if (!gdb_PyArg_ParseTupleAndKeywords (args
, kw
, "s|O!i", keywords
, &name
,
379 &block_object_type
, &block_obj
,
384 block
= block_object_to_block (block_obj
);
387 struct frame_info
*selected_frame
;
391 selected_frame
= get_selected_frame (_("No frame selected."));
392 block
= get_frame_block (selected_frame
, NULL
);
394 catch (const gdb_exception
&except
)
396 GDB_PY_HANDLE_EXCEPTION (except
);
402 symbol
= lookup_symbol (name
, block
, (domain_enum
) domain
,
403 &is_a_field_of_this
).symbol
;
405 catch (const gdb_exception
&except
)
407 GDB_PY_HANDLE_EXCEPTION (except
);
410 gdbpy_ref
<> ret_tuple (PyTuple_New (2));
411 if (ret_tuple
== NULL
)
416 sym_obj
= symbol_to_symbol_object (symbol
);
425 PyTuple_SET_ITEM (ret_tuple
.get (), 0, sym_obj
);
427 bool_obj
= (is_a_field_of_this
.type
!= NULL
) ? Py_True
: Py_False
;
428 Py_INCREF (bool_obj
);
429 PyTuple_SET_ITEM (ret_tuple
.get (), 1, bool_obj
);
431 return ret_tuple
.release ();
435 gdb.lookup_global_symbol (name [, domain]) -> symbol or None. */
438 gdbpy_lookup_global_symbol (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
440 int domain
= VAR_DOMAIN
;
442 static const char *keywords
[] = { "name", "domain", NULL
};
443 struct symbol
*symbol
= NULL
;
446 if (!gdb_PyArg_ParseTupleAndKeywords (args
, kw
, "s|i", keywords
, &name
,
452 symbol
= lookup_global_symbol (name
, NULL
, (domain_enum
) domain
).symbol
;
454 catch (const gdb_exception
&except
)
456 GDB_PY_HANDLE_EXCEPTION (except
);
461 sym_obj
= symbol_to_symbol_object (symbol
);
474 /* This function is called when an objfile is about to be freed.
475 Invalidate the symbol as further actions on the symbol would result
476 in bad data. All access to obj->symbol should be gated by
477 SYMPY_REQUIRE_VALID which will raise an exception on invalid
480 del_objfile_symbols (struct objfile
*objfile
, void *datum
)
482 symbol_object
*obj
= (symbol_object
*) datum
;
485 symbol_object
*next
= obj
->next
;
496 gdbpy_initialize_symbols (void)
498 if (PyType_Ready (&symbol_object_type
) < 0)
501 /* Register an objfile "free" callback so we can properly
502 invalidate symbol when an object file that is about to be
504 sympy_objfile_data_key
505 = register_objfile_data_with_cleanup (NULL
, del_objfile_symbols
);
507 if (PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_UNDEF", LOC_UNDEF
) < 0
508 || PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_CONST",
510 || PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_STATIC",
512 || PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_REGISTER",
514 || PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_ARG",
516 || PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_REF_ARG",
518 || PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_LOCAL",
520 || PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_TYPEDEF",
522 || PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_LABEL",
524 || PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_BLOCK",
526 || PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_CONST_BYTES",
528 || PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_UNRESOLVED",
530 || PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_OPTIMIZED_OUT",
531 LOC_OPTIMIZED_OUT
) < 0
532 || PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_COMPUTED",
534 || PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_COMMON_BLOCK",
535 LOC_COMMON_BLOCK
) < 0
536 || PyModule_AddIntConstant (gdb_module
, "SYMBOL_LOC_REGPARM_ADDR",
537 LOC_REGPARM_ADDR
) < 0
538 || PyModule_AddIntConstant (gdb_module
, "SYMBOL_UNDEF_DOMAIN",
540 || PyModule_AddIntConstant (gdb_module
, "SYMBOL_VAR_DOMAIN",
542 || PyModule_AddIntConstant (gdb_module
, "SYMBOL_STRUCT_DOMAIN",
544 || PyModule_AddIntConstant (gdb_module
, "SYMBOL_MODULE_DOMAIN",
546 || PyModule_AddIntConstant (gdb_module
, "SYMBOL_COMMON_BLOCK_DOMAIN",
547 COMMON_BLOCK_DOMAIN
) < 0)
550 /* These remain defined for compatibility, but as they were never
551 correct, they are no longer documented. Eventually we can remove
552 them. These exist because at one time, enum search_domain and
553 enum domain_enum_tag were combined -- but different values were
554 used differently. Here we try to give them values that will make
555 sense if they are passed to gdb.lookup_symbol. */
556 if (PyModule_AddIntConstant (gdb_module
, "SYMBOL_VARIABLES_DOMAIN",
558 || PyModule_AddIntConstant (gdb_module
, "SYMBOL_FUNCTIONS_DOMAIN",
560 || PyModule_AddIntConstant (gdb_module
, "SYMBOL_TYPES_DOMAIN",
564 return gdb_pymodule_addobject (gdb_module
, "Symbol",
565 (PyObject
*) &symbol_object_type
);
570 static gdb_PyGetSetDef symbol_object_getset
[] = {
571 { "type", sympy_get_type
, NULL
,
572 "Type of the symbol.", NULL
},
573 { "symtab", sympy_get_symtab
, NULL
,
574 "Symbol table in which the symbol appears.", NULL
},
575 { "name", sympy_get_name
, NULL
,
576 "Name of the symbol, as it appears in the source code.", NULL
},
577 { "linkage_name", sympy_get_linkage_name
, NULL
,
578 "Name of the symbol, as used by the linker (i.e., may be mangled).",
580 { "print_name", sympy_get_print_name
, NULL
,
581 "Name of the symbol in a form suitable for output.\n\
582 This is either name or linkage_name, depending on whether the user asked GDB\n\
583 to display demangled or mangled names.", NULL
},
584 { "addr_class", sympy_get_addr_class
, NULL
, "Address class of the symbol." },
585 { "is_argument", sympy_is_argument
, NULL
,
586 "True if the symbol is an argument of a function." },
587 { "is_constant", sympy_is_constant
, NULL
,
588 "True if the symbol is a constant." },
589 { "is_function", sympy_is_function
, NULL
,
590 "True if the symbol is a function or method." },
591 { "is_variable", sympy_is_variable
, NULL
,
592 "True if the symbol is a variable." },
593 { "needs_frame", sympy_needs_frame
, NULL
,
594 "True if the symbol requires a frame for evaluation." },
595 { "line", sympy_line
, NULL
,
596 "The source line number at which the symbol was defined." },
597 { NULL
} /* Sentinel */
600 static PyMethodDef symbol_object_methods
[] = {
601 { "is_valid", sympy_is_valid
, METH_NOARGS
,
602 "is_valid () -> Boolean.\n\
603 Return true if this symbol is valid, false if not." },
604 { "value", sympy_value
, METH_VARARGS
,
605 "value ([frame]) -> gdb.Value\n\
606 Return the value of the symbol." },
607 {NULL
} /* Sentinel */
610 PyTypeObject symbol_object_type
= {
611 PyVarObject_HEAD_INIT (NULL
, 0)
612 "gdb.Symbol", /*tp_name*/
613 sizeof (symbol_object
), /*tp_basicsize*/
615 sympy_dealloc
, /*tp_dealloc*/
622 0, /*tp_as_sequence*/
626 sympy_str
, /*tp_str*/
630 Py_TPFLAGS_DEFAULT
, /*tp_flags*/
631 "GDB symbol object", /*tp_doc */
634 0, /*tp_richcompare */
635 0, /*tp_weaklistoffset */
638 symbol_object_methods
, /*tp_methods */
640 symbol_object_getset
/*tp_getset */