1 /* Gdb/Python header for private use by Python module.
3 Copyright (C) 2008-2013 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/>. */
20 #ifndef GDB_PYTHON_INTERNAL_H
21 #define GDB_PYTHON_INTERNAL_H
23 /* These WITH_* macros are defined by the CPython API checker that
24 comes with the Python plugin for GCC. See:
25 https://gcc-python-plugin.readthedocs.org/en/latest/cpychecker.html
26 The checker defines a WITH_ macro for each attribute it
29 #ifdef WITH_CPYCHECKER_RETURNS_BORROWED_REF_ATTRIBUTE
30 #define CPYCHECKER_RETURNS_BORROWED_REF \
31 __attribute__ ((cpychecker_returns_borrowed_ref))
33 #define CPYCHECKER_RETURNS_BORROWED_REF
36 #ifdef WITH_CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF_ATTRIBUTE
37 #define CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF(ARG) \
38 __attribute__ ((cpychecker_type_object_for_typedef (ARG)))
40 #define CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF(ARG)
43 #ifdef WITH_CPYCHECKER_STEALS_REFERENCE_TO_ARG_ATTRIBUTE
44 #define CPYCHECKER_STEALS_REFERENCE_TO_ARG(n) \
45 __attribute__ ((cpychecker_steals_reference_to_arg (n)))
47 #define CPYCHECKER_STEALS_REFERENCE_TO_ARG(n)
50 #ifdef WITH_CPYCHECKER_SETS_EXCEPTION_ATTRIBUTE
51 #define CPYCHECKER_SETS_EXCEPTION __attribute__ ((cpychecker_sets_exception))
53 #define CPYCHECKER_SETS_EXCEPTION
56 #ifdef WITH_CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION_ATTRIBUTE
57 #define CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION \
58 __attribute__ ((cpychecker_negative_result_sets_exception))
60 #define CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
65 /* Python 2.4 doesn't include stdint.h soon enough to get {u,}intptr_t
66 needed by pyport.h. */
69 /* /usr/include/features.h on linux systems will define _POSIX_C_SOURCE
70 if it sees _GNU_SOURCE (which config.h will define).
71 pyconfig.h defines _POSIX_C_SOURCE to a different value than
72 /usr/include/features.h does causing compilation to fail.
73 To work around this, undef _POSIX_C_SOURCE before we include Python.h.
75 Same problem with _XOPEN_SOURCE. */
76 #undef _POSIX_C_SOURCE
79 /* On sparc-solaris, /usr/include/sys/feature_tests.h defines
80 _FILE_OFFSET_BITS, which pyconfig.h also defines. Same work
81 around technique as above. */
82 #undef _FILE_OFFSET_BITS
84 /* A kludge to avoid redefinition of snprintf on Windows by pyerrors.h. */
85 #if defined(_WIN32) && defined(HAVE_DECL_SNPRINTF)
86 #define HAVE_SNPRINTF 1
89 /* Request clean size types from Python. */
90 #define PY_SSIZE_T_CLEAN
92 /* Include the Python header files using angle brackets rather than
93 double quotes. On case-insensitive filesystems, this prevents us
94 from including our python/python.h header file. */
96 #include <frameobject.h>
98 #if PY_MAJOR_VERSION >= 3
103 #define Py_TPFLAGS_HAVE_ITER 0
104 #define Py_TPFLAGS_CHECKTYPES 0
106 #define PyInt_Check PyLong_Check
107 #define PyInt_FromLong PyLong_FromLong
108 #define PyInt_AsLong PyLong_AsLong
110 #define PyString_FromString PyUnicode_FromString
111 #define PyString_Decode PyUnicode_Decode
112 #define PyString_FromFormat PyUnicode_FromFormat
113 #define PyString_Check PyUnicode_Check
116 #if HAVE_LIBPYTHON2_4
117 /* Py_ssize_t is not defined until 2.5.
118 Logical type for Py_ssize_t is Py_intptr_t, but that fails in 64-bit
119 compilation due to several apparent mistakes in python2.4 API, so we
120 use 'int' instead. */
121 typedef int Py_ssize_t;
124 #ifndef PyVarObject_HEAD_INIT
125 /* Python 2.4 does not define PyVarObject_HEAD_INIT. */
126 #define PyVarObject_HEAD_INIT(type, size) \
127 PyObject_HEAD_INIT(type) size,
132 /* Python 2.4 does not define Py_TYPE. */
133 #define Py_TYPE(ob) (((PyObject*)(ob))->ob_type)
136 /* If Python.h does not define WITH_THREAD, then the various
137 GIL-related functions will not be defined. However,
138 PyGILState_STATE will be. */
140 #define PyGILState_Ensure() ((PyGILState_STATE) 0)
141 #define PyGILState_Release(ARG) ((void)(ARG))
142 #define PyEval_InitThreads()
143 #define PyThreadState_Swap(ARG) ((void)(ARG))
144 #define PyEval_ReleaseLock()
147 /* Python supplies HAVE_LONG_LONG and some `long long' support when it
148 is available. These defines let us handle the differences more
150 #ifdef HAVE_LONG_LONG
152 #define GDB_PY_LL_ARG "L"
153 #define GDB_PY_LLU_ARG "K"
154 typedef PY_LONG_LONG gdb_py_longest;
155 typedef unsigned PY_LONG_LONG gdb_py_ulongest;
156 #define gdb_py_long_from_longest PyLong_FromLongLong
157 #define gdb_py_long_from_ulongest PyLong_FromUnsignedLongLong
158 #define gdb_py_long_as_ulongest PyLong_AsUnsignedLongLong
160 #else /* HAVE_LONG_LONG */
162 #define GDB_PY_LL_ARG "L"
163 #define GDB_PY_LLU_ARG "K"
164 typedef long gdb_py_longest;
165 typedef unsigned long gdb_py_ulongest;
166 #define gdb_py_long_from_longest PyLong_FromLong
167 #define gdb_py_long_from_ulongest PyLong_FromUnsignedLong
168 #define gdb_py_long_as_ulongest PyLong_AsUnsignedLong
170 #endif /* HAVE_LONG_LONG */
173 /* In order to be able to parse symtab_and_line_to_sal_object function
174 a real symtab_and_line structure is needed. */
177 /* Also needed to parse enum var_types. */
179 #include "breakpoint.h"
181 #include "exceptions.h"
183 enum gdbpy_iter_kind { iter_keys, iter_values, iter_items };
187 struct language_defn;
188 struct program_space;
192 extern PyObject *gdb_module;
193 extern PyObject *gdb_python_module;
194 extern PyTypeObject value_object_type
195 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("value_object");
196 extern PyTypeObject block_object_type
197 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF("block_object");
198 extern PyTypeObject symbol_object_type
199 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("symbol_object");
200 extern PyTypeObject event_object_type
201 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("event_object");
202 extern PyTypeObject stop_event_object_type
203 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("event_object");
204 extern PyTypeObject breakpoint_object_type
205 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("breakpoint_object");
206 extern PyTypeObject frame_object_type
207 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("frame_object");
209 typedef struct breakpoint_object
213 /* The breakpoint number according to gdb. */
216 /* The gdb breakpoint object, or NULL if the breakpoint has been
218 struct breakpoint *bp;
220 /* 1 is this is a FinishBreakpoint object, 0 otherwise. */
224 /* Require that BREAKPOINT be a valid breakpoint ID; throw a Python
225 exception if it is invalid. */
226 #define BPPY_REQUIRE_VALID(Breakpoint) \
228 if ((Breakpoint)->bp == NULL) \
229 return PyErr_Format (PyExc_RuntimeError, \
230 _("Breakpoint %d is invalid."), \
231 (Breakpoint)->number); \
234 /* Require that BREAKPOINT be a valid breakpoint ID; throw a Python
235 exception if it is invalid. This macro is for use in setter functions. */
236 #define BPPY_SET_REQUIRE_VALID(Breakpoint) \
238 if ((Breakpoint)->bp == NULL) \
240 PyErr_Format (PyExc_RuntimeError, _("Breakpoint %d is invalid."), \
241 (Breakpoint)->number); \
247 /* Variables used to pass information between the Breakpoint
248 constructor and the breakpoint-created hook function. */
249 extern breakpoint_object *bppy_pending_object;
256 /* The thread we represent. */
257 struct thread_info *thread;
259 /* The Inferior object to which this thread belongs. */
263 extern struct cmd_list_element *set_python_list;
264 extern struct cmd_list_element *show_python_list;
266 PyObject *gdbpy_history (PyObject *self, PyObject *args);
267 PyObject *gdbpy_breakpoints (PyObject *, PyObject *);
268 PyObject *gdbpy_frame_stop_reason_string (PyObject *, PyObject *);
269 PyObject *gdbpy_lookup_symbol (PyObject *self, PyObject *args, PyObject *kw);
270 PyObject *gdbpy_lookup_global_symbol (PyObject *self, PyObject *args,
272 PyObject *gdbpy_newest_frame (PyObject *self, PyObject *args);
273 PyObject *gdbpy_selected_frame (PyObject *self, PyObject *args);
274 PyObject *gdbpy_block_for_pc (PyObject *self, PyObject *args);
275 PyObject *gdbpy_lookup_type (PyObject *self, PyObject *args, PyObject *kw);
276 PyObject *gdbpy_create_lazy_string_object (CORE_ADDR address, long length,
277 const char *encoding,
279 PyObject *gdbpy_inferiors (PyObject *unused, PyObject *unused2);
280 PyObject *gdbpy_selected_thread (PyObject *self, PyObject *args);
281 PyObject *gdbpy_selected_inferior (PyObject *self, PyObject *args);
282 PyObject *gdbpy_string_to_argv (PyObject *self, PyObject *args);
283 PyObject *gdbpy_parameter (PyObject *self, PyObject *args);
284 PyObject *gdbpy_parameter_value (enum var_types type, void *var);
285 char *gdbpy_parse_command_name (const char *name,
286 struct cmd_list_element ***base_list,
287 struct cmd_list_element **start_list);
289 PyObject *symtab_and_line_to_sal_object (struct symtab_and_line sal);
290 PyObject *symtab_to_symtab_object (struct symtab *symtab);
291 PyObject *symbol_to_symbol_object (struct symbol *sym);
292 PyObject *block_to_block_object (const struct block *block,
293 struct objfile *objfile);
294 PyObject *value_to_value_object (struct value *v);
295 PyObject *type_to_type_object (struct type *);
296 PyObject *frame_info_to_frame_object (struct frame_info *frame);
298 PyObject *pspace_to_pspace_object (struct program_space *)
299 CPYCHECKER_RETURNS_BORROWED_REF;
300 PyObject *pspy_get_printers (PyObject *, void *);
301 PyObject *pspy_get_frame_filters (PyObject *, void *);
303 PyObject *objfile_to_objfile_object (struct objfile *)
304 CPYCHECKER_RETURNS_BORROWED_REF;
305 PyObject *objfpy_get_printers (PyObject *, void *);
306 PyObject *objfpy_get_frame_filters (PyObject *, void *);
308 PyObject *gdbarch_to_arch_object (struct gdbarch *gdbarch);
310 thread_object *create_thread_object (struct thread_info *tp);
311 thread_object *find_thread_object (ptid_t ptid)
312 CPYCHECKER_RETURNS_BORROWED_REF;
313 PyObject *find_inferior_object (int pid);
314 PyObject *inferior_to_inferior_object (struct inferior *inferior);
316 const struct block *block_object_to_block (PyObject *obj);
317 struct symbol *symbol_object_to_symbol (PyObject *obj);
318 struct value *value_object_to_value (PyObject *self);
319 struct value *convert_value_from_python (PyObject *obj);
320 struct type *type_object_to_type (PyObject *obj);
321 struct symtab *symtab_object_to_symtab (PyObject *obj);
322 struct symtab_and_line *sal_object_to_symtab_and_line (PyObject *obj);
323 struct frame_info *frame_object_to_frame_info (PyObject *frame_obj);
324 struct gdbarch *arch_object_to_gdbarch (PyObject *obj);
326 void gdbpy_initialize_gdb_readline (void);
327 int gdbpy_initialize_auto_load (void)
328 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
329 int gdbpy_initialize_values (void)
330 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
331 int gdbpy_initialize_frames (void)
332 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
333 int gdbpy_initialize_symtabs (void)
334 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
335 int gdbpy_initialize_commands (void)
336 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
337 int gdbpy_initialize_symbols (void)
338 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
339 int gdbpy_initialize_symtabs (void)
340 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
341 int gdbpy_initialize_blocks (void)
342 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
343 int gdbpy_initialize_types (void)
344 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
345 int gdbpy_initialize_functions (void)
346 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
347 int gdbpy_initialize_pspace (void)
348 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
349 int gdbpy_initialize_objfile (void)
350 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
351 int gdbpy_initialize_breakpoints (void)
352 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
353 int gdbpy_initialize_finishbreakpoints (void)
354 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
355 int gdbpy_initialize_lazy_string (void)
356 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
357 int gdbpy_initialize_parameters (void)
358 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
359 int gdbpy_initialize_thread (void)
360 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
361 int gdbpy_initialize_inferior (void)
362 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
363 int gdbpy_initialize_eventregistry (void)
364 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
365 int gdbpy_initialize_event (void)
366 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
367 int gdbpy_initialize_py_events (void)
368 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
369 int gdbpy_initialize_stop_event (void)
370 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
371 int gdbpy_initialize_signal_event (void)
372 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
373 int gdbpy_initialize_breakpoint_event (void)
374 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
375 int gdbpy_initialize_continue_event (void)
376 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
377 int gdbpy_initialize_exited_event (void)
378 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
379 int gdbpy_initialize_thread_event (void)
380 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
381 int gdbpy_initialize_new_objfile_event (void)
382 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
383 int gdbpy_initialize_arch (void)
384 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
386 struct cleanup *make_cleanup_py_decref (PyObject *py);
387 struct cleanup *make_cleanup_py_xdecref (PyObject *py);
389 struct cleanup *ensure_python_env (struct gdbarch *gdbarch,
390 const struct language_defn *language);
392 extern struct gdbarch *python_gdbarch;
393 extern const struct language_defn *python_language;
395 /* Use this after a TRY_EXCEPT to throw the appropriate Python
397 #define GDB_PY_HANDLE_EXCEPTION(Exception) \
399 if (Exception.reason < 0) \
401 gdbpy_convert_exception (Exception); \
406 /* Use this after a TRY_EXCEPT to throw the appropriate Python
407 exception. This macro is for use inside setter functions. */
408 #define GDB_PY_SET_HANDLE_EXCEPTION(Exception) \
410 if (Exception.reason < 0) \
412 gdbpy_convert_exception (Exception); \
417 void gdbpy_print_stack (void);
419 void source_python_script_for_objfile (struct objfile *objfile, FILE *file,
420 const char *filename);
422 PyObject *python_string_to_unicode (PyObject *obj);
423 char *unicode_to_target_string (PyObject *unicode_str);
424 char *python_string_to_target_string (PyObject *obj);
425 PyObject *python_string_to_target_python_string (PyObject *obj);
426 char *python_string_to_host_string (PyObject *obj);
427 int gdbpy_is_string (PyObject *obj);
428 char *gdbpy_obj_to_string (PyObject *obj);
429 char *gdbpy_exception_to_string (PyObject *ptype, PyObject *pvalue);
431 int gdbpy_is_lazy_string (PyObject *result);
432 void gdbpy_extract_lazy_string (PyObject *string, CORE_ADDR *addr,
433 struct type **str_type,
434 long *length, char **encoding);
436 int gdbpy_is_value_object (PyObject *obj);
438 /* Note that these are declared here, and not in python.h with the
439 other pretty-printer functions, because they refer to PyObject. */
440 PyObject *apply_varobj_pretty_printer (PyObject *print_obj,
441 struct value **replacement,
442 struct ui_file *stream);
443 PyObject *gdbpy_get_varobj_pretty_printer (struct value *value);
444 char *gdbpy_get_display_hint (PyObject *printer);
445 PyObject *gdbpy_default_visualizer (PyObject *self, PyObject *args);
447 void bpfinishpy_pre_stop_hook (struct breakpoint_object *bp_obj);
448 void bpfinishpy_post_stop_hook (struct breakpoint_object *bp_obj);
450 extern PyObject *gdbpy_doc_cst;
451 extern PyObject *gdbpy_children_cst;
452 extern PyObject *gdbpy_to_string_cst;
453 extern PyObject *gdbpy_display_hint_cst;
454 extern PyObject *gdbpy_enabled_cst;
455 extern PyObject *gdbpy_value_cst;
457 /* Exception types. */
458 extern PyObject *gdbpy_gdb_error;
459 extern PyObject *gdbpy_gdb_memory_error;
460 extern PyObject *gdbpy_gdberror_exc;
462 extern void gdbpy_convert_exception (struct gdb_exception)
463 CPYCHECKER_SETS_EXCEPTION;
465 int get_addr_from_python (PyObject *obj, CORE_ADDR *addr)
466 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
468 PyObject *gdb_py_object_from_longest (LONGEST l);
469 PyObject *gdb_py_object_from_ulongest (ULONGEST l);
470 int gdb_py_int_as_long (PyObject *, long *);
472 PyObject *gdb_py_generic_dict (PyObject *self, void *closure);
474 #endif /* GDB_PYTHON_INTERNAL_H */