1 /* Gdb/Python header for private use by Python module.
3 Copyright (C) 2008-2014 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 #include "extension.h"
25 /* These WITH_* macros are defined by the CPython API checker that
26 comes with the Python plugin for GCC. See:
27 https://gcc-python-plugin.readthedocs.org/en/latest/cpychecker.html
28 The checker defines a WITH_ macro for each attribute it
31 #ifdef WITH_CPYCHECKER_RETURNS_BORROWED_REF_ATTRIBUTE
32 #define CPYCHECKER_RETURNS_BORROWED_REF \
33 __attribute__ ((cpychecker_returns_borrowed_ref))
35 #define CPYCHECKER_RETURNS_BORROWED_REF
38 #ifdef WITH_CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF_ATTRIBUTE
39 #define CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF(ARG) \
40 __attribute__ ((cpychecker_type_object_for_typedef (ARG)))
42 #define CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF(ARG)
45 #ifdef WITH_CPYCHECKER_STEALS_REFERENCE_TO_ARG_ATTRIBUTE
46 #define CPYCHECKER_STEALS_REFERENCE_TO_ARG(n) \
47 __attribute__ ((cpychecker_steals_reference_to_arg (n)))
49 #define CPYCHECKER_STEALS_REFERENCE_TO_ARG(n)
52 #ifdef WITH_CPYCHECKER_SETS_EXCEPTION_ATTRIBUTE
53 #define CPYCHECKER_SETS_EXCEPTION __attribute__ ((cpychecker_sets_exception))
55 #define CPYCHECKER_SETS_EXCEPTION
58 #ifdef WITH_CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION_ATTRIBUTE
59 #define CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION \
60 __attribute__ ((cpychecker_negative_result_sets_exception))
62 #define CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
67 /* Python 2.4 doesn't include stdint.h soon enough to get {u,}intptr_t
68 needed by pyport.h. */
71 /* /usr/include/features.h on linux systems will define _POSIX_C_SOURCE
72 if it sees _GNU_SOURCE (which config.h will define).
73 pyconfig.h defines _POSIX_C_SOURCE to a different value than
74 /usr/include/features.h does causing compilation to fail.
75 To work around this, undef _POSIX_C_SOURCE before we include Python.h.
77 Same problem with _XOPEN_SOURCE. */
78 #undef _POSIX_C_SOURCE
81 /* On sparc-solaris, /usr/include/sys/feature_tests.h defines
82 _FILE_OFFSET_BITS, which pyconfig.h also defines. Same work
83 around technique as above. */
84 #undef _FILE_OFFSET_BITS
86 /* A kludge to avoid redefinition of snprintf on Windows by pyerrors.h. */
87 #if defined(_WIN32) && defined(HAVE_DECL_SNPRINTF)
88 #define HAVE_SNPRINTF 1
91 /* Request clean size types from Python. */
92 #define PY_SSIZE_T_CLEAN
94 /* Include the Python header files using angle brackets rather than
95 double quotes. On case-insensitive filesystems, this prevents us
96 from including our python/python.h header file. */
98 #include <frameobject.h>
100 #if PY_MAJOR_VERSION >= 3
105 #define Py_TPFLAGS_HAVE_ITER 0
106 #define Py_TPFLAGS_CHECKTYPES 0
108 #define PyInt_Check PyLong_Check
109 #define PyInt_FromLong PyLong_FromLong
110 #define PyInt_AsLong PyLong_AsLong
112 #define PyString_FromString PyUnicode_FromString
113 #define PyString_Decode PyUnicode_Decode
114 #define PyString_FromFormat PyUnicode_FromFormat
115 #define PyString_Check PyUnicode_Check
118 #if HAVE_LIBPYTHON2_4
119 /* Py_ssize_t is not defined until 2.5.
120 Logical type for Py_ssize_t is Py_intptr_t, but that fails in 64-bit
121 compilation due to several apparent mistakes in python2.4 API, so we
122 use 'int' instead. */
123 typedef int Py_ssize_t
;
126 #ifndef PyVarObject_HEAD_INIT
127 /* Python 2.4 does not define PyVarObject_HEAD_INIT. */
128 #define PyVarObject_HEAD_INIT(type, size) \
129 PyObject_HEAD_INIT(type) size,
134 /* Python 2.4 does not define Py_TYPE. */
135 #define Py_TYPE(ob) (((PyObject*)(ob))->ob_type)
138 /* If Python.h does not define WITH_THREAD, then the various
139 GIL-related functions will not be defined. However,
140 PyGILState_STATE will be. */
142 #define PyGILState_Ensure() ((PyGILState_STATE) 0)
143 #define PyGILState_Release(ARG) ((void)(ARG))
144 #define PyEval_InitThreads()
145 #define PyThreadState_Swap(ARG) ((void)(ARG))
146 #define PyEval_ReleaseLock()
149 /* Python supplies HAVE_LONG_LONG and some `long long' support when it
150 is available. These defines let us handle the differences more
152 #ifdef HAVE_LONG_LONG
154 #define GDB_PY_LL_ARG "L"
155 #define GDB_PY_LLU_ARG "K"
156 typedef PY_LONG_LONG gdb_py_longest
;
157 typedef unsigned PY_LONG_LONG gdb_py_ulongest
;
158 #define gdb_py_long_from_longest PyLong_FromLongLong
159 #define gdb_py_long_from_ulongest PyLong_FromUnsignedLongLong
160 #define gdb_py_long_as_ulongest PyLong_AsUnsignedLongLong
162 #else /* HAVE_LONG_LONG */
164 #define GDB_PY_LL_ARG "L"
165 #define GDB_PY_LLU_ARG "K"
166 typedef long gdb_py_longest
;
167 typedef unsigned long gdb_py_ulongest
;
168 #define gdb_py_long_from_longest PyLong_FromLong
169 #define gdb_py_long_from_ulongest PyLong_FromUnsignedLong
170 #define gdb_py_long_as_ulongest PyLong_AsUnsignedLong
172 #endif /* HAVE_LONG_LONG */
174 /* Python 2.6 did not wrap Py_DECREF in 'do {...} while (0)', leading
175 to 'suggest explicit braces to avoid ambiguous ‘else’' gcc errors.
176 Wrap it ourselves, so that callers don't need to care. */
179 gdb_Py_DECREF (void *op
) /* ARI: editCase function */
181 /* ... and Python 2.4 didn't cast OP to PyObject pointer on the
182 '(op)->ob_refcnt' references within the macro. Cast it ourselves
184 Py_DECREF ((PyObject
*) op
);
188 #define Py_DECREF(op) gdb_Py_DECREF (op)
190 /* In order to be able to parse symtab_and_line_to_sal_object function
191 a real symtab_and_line structure is needed. */
194 /* Also needed to parse enum var_types. */
196 #include "breakpoint.h"
198 #include "exceptions.h"
200 enum gdbpy_iter_kind
{ iter_keys
, iter_values
, iter_items
};
204 struct language_defn
;
205 struct program_space
;
209 extern int gdb_python_initialized
;
211 extern PyObject
*gdb_module
;
212 extern PyObject
*gdb_python_module
;
213 extern PyTypeObject value_object_type
214 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("value_object");
215 extern PyTypeObject block_object_type
216 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF("block_object");
217 extern PyTypeObject symbol_object_type
218 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("symbol_object");
219 extern PyTypeObject event_object_type
220 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("event_object");
221 extern PyTypeObject stop_event_object_type
222 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("event_object");
223 extern PyTypeObject breakpoint_object_type
224 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("breakpoint_object");
225 extern PyTypeObject frame_object_type
226 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("frame_object");
228 typedef struct gdbpy_breakpoint_object
232 /* The breakpoint number according to gdb. */
235 /* The gdb breakpoint object, or NULL if the breakpoint has been
237 struct breakpoint
*bp
;
239 /* 1 is this is a FinishBreakpoint object, 0 otherwise. */
241 } gdbpy_breakpoint_object
;
243 /* Require that BREAKPOINT be a valid breakpoint ID; throw a Python
244 exception if it is invalid. */
245 #define BPPY_REQUIRE_VALID(Breakpoint) \
247 if ((Breakpoint)->bp == NULL) \
248 return PyErr_Format (PyExc_RuntimeError, \
249 _("Breakpoint %d is invalid."), \
250 (Breakpoint)->number); \
253 /* Require that BREAKPOINT be a valid breakpoint ID; throw a Python
254 exception if it is invalid. This macro is for use in setter functions. */
255 #define BPPY_SET_REQUIRE_VALID(Breakpoint) \
257 if ((Breakpoint)->bp == NULL) \
259 PyErr_Format (PyExc_RuntimeError, _("Breakpoint %d is invalid."), \
260 (Breakpoint)->number); \
266 /* Variables used to pass information between the Breakpoint
267 constructor and the breakpoint-created hook function. */
268 extern gdbpy_breakpoint_object
*bppy_pending_object
;
275 /* The thread we represent. */
276 struct thread_info
*thread
;
278 /* The Inferior object to which this thread belongs. */
282 extern struct cmd_list_element
*set_python_list
;
283 extern struct cmd_list_element
*show_python_list
;
285 /* extension_language_script_ops "methods". */
287 extern int gdbpy_auto_load_enabled (const struct extension_language_defn
*);
289 /* extension_language_ops "methods". */
291 extern enum ext_lang_rc gdbpy_apply_val_pretty_printer
292 (const struct extension_language_defn
*,
293 struct type
*type
, const gdb_byte
*valaddr
,
294 int embedded_offset
, CORE_ADDR address
,
295 struct ui_file
*stream
, int recurse
,
296 const struct value
*val
,
297 const struct value_print_options
*options
,
298 const struct language_defn
*language
);
299 extern enum ext_lang_bt_status gdbpy_apply_frame_filter
300 (const struct extension_language_defn
*,
301 struct frame_info
*frame
, int flags
, enum ext_lang_frame_args args_type
,
302 struct ui_out
*out
, int frame_low
, int frame_high
);
303 extern void gdbpy_preserve_values (const struct extension_language_defn
*,
304 struct objfile
*objfile
,
305 htab_t copied_types
);
306 extern enum ext_lang_bp_stop gdbpy_breakpoint_cond_says_stop
307 (const struct extension_language_defn
*, struct breakpoint
*);
308 extern int gdbpy_breakpoint_has_cond (const struct extension_language_defn
*,
309 struct breakpoint
*b
);
311 PyObject
*gdbpy_history (PyObject
*self
, PyObject
*args
);
312 PyObject
*gdbpy_breakpoints (PyObject
*, PyObject
*);
313 PyObject
*gdbpy_frame_stop_reason_string (PyObject
*, PyObject
*);
314 PyObject
*gdbpy_lookup_symbol (PyObject
*self
, PyObject
*args
, PyObject
*kw
);
315 PyObject
*gdbpy_lookup_global_symbol (PyObject
*self
, PyObject
*args
,
317 PyObject
*gdbpy_newest_frame (PyObject
*self
, PyObject
*args
);
318 PyObject
*gdbpy_selected_frame (PyObject
*self
, PyObject
*args
);
319 PyObject
*gdbpy_block_for_pc (PyObject
*self
, PyObject
*args
);
320 PyObject
*gdbpy_lookup_type (PyObject
*self
, PyObject
*args
, PyObject
*kw
);
321 int gdbpy_is_field (PyObject
*obj
);
322 PyObject
*gdbpy_create_lazy_string_object (CORE_ADDR address
, long length
,
323 const char *encoding
,
325 PyObject
*gdbpy_inferiors (PyObject
*unused
, PyObject
*unused2
);
326 PyObject
*gdbpy_selected_thread (PyObject
*self
, PyObject
*args
);
327 PyObject
*gdbpy_selected_inferior (PyObject
*self
, PyObject
*args
);
328 PyObject
*gdbpy_string_to_argv (PyObject
*self
, PyObject
*args
);
329 PyObject
*gdbpy_parameter (PyObject
*self
, PyObject
*args
);
330 PyObject
*gdbpy_parameter_value (enum var_types type
, void *var
);
331 char *gdbpy_parse_command_name (const char *name
,
332 struct cmd_list_element
***base_list
,
333 struct cmd_list_element
**start_list
);
335 PyObject
*symtab_and_line_to_sal_object (struct symtab_and_line sal
);
336 PyObject
*symtab_to_symtab_object (struct symtab
*symtab
);
337 PyObject
*symbol_to_symbol_object (struct symbol
*sym
);
338 PyObject
*block_to_block_object (const struct block
*block
,
339 struct objfile
*objfile
);
340 PyObject
*value_to_value_object (struct value
*v
);
341 PyObject
*type_to_type_object (struct type
*);
342 PyObject
*frame_info_to_frame_object (struct frame_info
*frame
);
343 PyObject
*symtab_to_linetable_object (PyObject
*symtab
);
344 PyObject
*pspace_to_pspace_object (struct program_space
*)
345 CPYCHECKER_RETURNS_BORROWED_REF
;
346 PyObject
*pspy_get_printers (PyObject
*, void *);
347 PyObject
*pspy_get_frame_filters (PyObject
*, void *);
349 PyObject
*objfile_to_objfile_object (struct objfile
*)
350 CPYCHECKER_RETURNS_BORROWED_REF
;
351 PyObject
*objfpy_get_printers (PyObject
*, void *);
352 PyObject
*objfpy_get_frame_filters (PyObject
*, void *);
354 PyObject
*gdbarch_to_arch_object (struct gdbarch
*gdbarch
);
356 thread_object
*create_thread_object (struct thread_info
*tp
);
357 thread_object
*find_thread_object (ptid_t ptid
)
358 CPYCHECKER_RETURNS_BORROWED_REF
;
359 PyObject
*find_inferior_object (int pid
);
360 PyObject
*inferior_to_inferior_object (struct inferior
*inferior
);
362 const struct block
*block_object_to_block (PyObject
*obj
);
363 struct symbol
*symbol_object_to_symbol (PyObject
*obj
);
364 struct value
*value_object_to_value (PyObject
*self
);
365 struct value
*convert_value_from_python (PyObject
*obj
);
366 struct type
*type_object_to_type (PyObject
*obj
);
367 struct symtab
*symtab_object_to_symtab (PyObject
*obj
);
368 struct symtab_and_line
*sal_object_to_symtab_and_line (PyObject
*obj
);
369 struct frame_info
*frame_object_to_frame_info (PyObject
*frame_obj
);
370 struct gdbarch
*arch_object_to_gdbarch (PyObject
*obj
);
372 void gdbpy_initialize_gdb_readline (void);
373 int gdbpy_initialize_auto_load (void)
374 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
375 int gdbpy_initialize_values (void)
376 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
377 int gdbpy_initialize_frames (void)
378 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
379 int gdbpy_initialize_symtabs (void)
380 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
381 int gdbpy_initialize_commands (void)
382 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
383 int gdbpy_initialize_symbols (void)
384 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
385 int gdbpy_initialize_symtabs (void)
386 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
387 int gdbpy_initialize_blocks (void)
388 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
389 int gdbpy_initialize_types (void)
390 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
391 int gdbpy_initialize_functions (void)
392 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
393 int gdbpy_initialize_pspace (void)
394 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
395 int gdbpy_initialize_objfile (void)
396 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
397 int gdbpy_initialize_breakpoints (void)
398 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
399 int gdbpy_initialize_finishbreakpoints (void)
400 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
401 int gdbpy_initialize_lazy_string (void)
402 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
403 int gdbpy_initialize_linetable (void)
404 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
405 int gdbpy_initialize_parameters (void)
406 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
407 int gdbpy_initialize_thread (void)
408 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
409 int gdbpy_initialize_inferior (void)
410 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
411 int gdbpy_initialize_eventregistry (void)
412 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
413 int gdbpy_initialize_event (void)
414 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
415 int gdbpy_initialize_py_events (void)
416 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
417 int gdbpy_initialize_stop_event (void)
418 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
419 int gdbpy_initialize_signal_event (void)
420 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
421 int gdbpy_initialize_breakpoint_event (void)
422 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
423 int gdbpy_initialize_continue_event (void)
424 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
425 int gdbpy_initialize_exited_event (void)
426 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
427 int gdbpy_initialize_thread_event (void)
428 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
429 int gdbpy_initialize_new_objfile_event (void)
430 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
431 int gdbpy_initialize_arch (void)
432 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
434 struct cleanup
*make_cleanup_py_decref (PyObject
*py
);
435 struct cleanup
*make_cleanup_py_xdecref (PyObject
*py
);
437 struct cleanup
*ensure_python_env (struct gdbarch
*gdbarch
,
438 const struct language_defn
*language
);
440 extern struct gdbarch
*python_gdbarch
;
441 extern const struct language_defn
*python_language
;
443 /* Use this after a TRY_EXCEPT to throw the appropriate Python
445 #define GDB_PY_HANDLE_EXCEPTION(Exception) \
447 if (Exception.reason < 0) \
449 gdbpy_convert_exception (Exception); \
454 /* Use this after a TRY_EXCEPT to throw the appropriate Python
455 exception. This macro is for use inside setter functions. */
456 #define GDB_PY_SET_HANDLE_EXCEPTION(Exception) \
458 if (Exception.reason < 0) \
460 gdbpy_convert_exception (Exception); \
465 void gdbpy_print_stack (void);
467 PyObject
*python_string_to_unicode (PyObject
*obj
);
468 char *unicode_to_target_string (PyObject
*unicode_str
);
469 char *python_string_to_target_string (PyObject
*obj
);
470 PyObject
*python_string_to_target_python_string (PyObject
*obj
);
471 char *python_string_to_host_string (PyObject
*obj
);
472 int gdbpy_is_string (PyObject
*obj
);
473 char *gdbpy_obj_to_string (PyObject
*obj
);
474 char *gdbpy_exception_to_string (PyObject
*ptype
, PyObject
*pvalue
);
476 int gdbpy_is_lazy_string (PyObject
*result
);
477 void gdbpy_extract_lazy_string (PyObject
*string
, CORE_ADDR
*addr
,
478 struct type
**str_type
,
479 long *length
, char **encoding
);
481 int gdbpy_is_value_object (PyObject
*obj
);
483 /* Note that these are declared here, and not in python.h with the
484 other pretty-printer functions, because they refer to PyObject. */
485 PyObject
*apply_varobj_pretty_printer (PyObject
*print_obj
,
486 struct value
**replacement
,
487 struct ui_file
*stream
);
488 PyObject
*gdbpy_get_varobj_pretty_printer (struct value
*value
);
489 char *gdbpy_get_display_hint (PyObject
*printer
);
490 PyObject
*gdbpy_default_visualizer (PyObject
*self
, PyObject
*args
);
492 void bpfinishpy_pre_stop_hook (struct gdbpy_breakpoint_object
*bp_obj
);
493 void bpfinishpy_post_stop_hook (struct gdbpy_breakpoint_object
*bp_obj
);
495 extern PyObject
*gdbpy_doc_cst
;
496 extern PyObject
*gdbpy_children_cst
;
497 extern PyObject
*gdbpy_to_string_cst
;
498 extern PyObject
*gdbpy_display_hint_cst
;
499 extern PyObject
*gdbpy_enabled_cst
;
500 extern PyObject
*gdbpy_value_cst
;
502 /* Exception types. */
503 extern PyObject
*gdbpy_gdb_error
;
504 extern PyObject
*gdbpy_gdb_memory_error
;
505 extern PyObject
*gdbpy_gdberror_exc
;
507 extern void gdbpy_convert_exception (struct gdb_exception
)
508 CPYCHECKER_SETS_EXCEPTION
;
510 int get_addr_from_python (PyObject
*obj
, CORE_ADDR
*addr
)
511 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
513 PyObject
*gdb_py_object_from_longest (LONGEST l
);
514 PyObject
*gdb_py_object_from_ulongest (ULONGEST l
);
515 int gdb_py_int_as_long (PyObject
*, long *);
517 PyObject
*gdb_py_generic_dict (PyObject
*self
, void *closure
);
519 int gdb_pymodule_addobject (PyObject
*module
, const char *name
,
521 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
523 #endif /* GDB_PYTHON_INTERNAL_H */