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 */
172 /* Python 2.6 did not wrap Py_DECREF in 'do {...} while (0)', leading
173 to 'suggest explicit braces to avoid ambiguous ‘else’' gcc errors.
174 Wrap it ourselves, so that callers don't need to care. */
177 gdb_Py_DECREF (void *op
) /* ARI: editCase function */
179 /* ... and Python 2.4 didn't cast OP to PyObject pointer on the
180 '(op)->ob_refcnt' references within the macro. Cast it ourselves
182 Py_DECREF ((PyObject
*) op
);
186 #define Py_DECREF(op) gdb_Py_DECREF (op)
188 /* In order to be able to parse symtab_and_line_to_sal_object function
189 a real symtab_and_line structure is needed. */
192 /* Also needed to parse enum var_types. */
194 #include "breakpoint.h"
196 #include "exceptions.h"
198 enum gdbpy_iter_kind
{ iter_keys
, iter_values
, iter_items
};
202 struct language_defn
;
203 struct program_space
;
207 extern int gdb_python_initialized
;
209 extern PyObject
*gdb_module
;
210 extern PyObject
*gdb_python_module
;
211 extern PyTypeObject value_object_type
212 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("value_object");
213 extern PyTypeObject block_object_type
214 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF("block_object");
215 extern PyTypeObject symbol_object_type
216 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("symbol_object");
217 extern PyTypeObject event_object_type
218 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("event_object");
219 extern PyTypeObject stop_event_object_type
220 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("event_object");
221 extern PyTypeObject breakpoint_object_type
222 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("breakpoint_object");
223 extern PyTypeObject frame_object_type
224 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("frame_object");
226 typedef struct gdbpy_breakpoint_object
230 /* The breakpoint number according to gdb. */
233 /* The gdb breakpoint object, or NULL if the breakpoint has been
235 struct breakpoint
*bp
;
237 /* 1 is this is a FinishBreakpoint object, 0 otherwise. */
239 } gdbpy_breakpoint_object
;
241 /* Require that BREAKPOINT be a valid breakpoint ID; throw a Python
242 exception if it is invalid. */
243 #define BPPY_REQUIRE_VALID(Breakpoint) \
245 if ((Breakpoint)->bp == NULL) \
246 return PyErr_Format (PyExc_RuntimeError, \
247 _("Breakpoint %d is invalid."), \
248 (Breakpoint)->number); \
251 /* Require that BREAKPOINT be a valid breakpoint ID; throw a Python
252 exception if it is invalid. This macro is for use in setter functions. */
253 #define BPPY_SET_REQUIRE_VALID(Breakpoint) \
255 if ((Breakpoint)->bp == NULL) \
257 PyErr_Format (PyExc_RuntimeError, _("Breakpoint %d is invalid."), \
258 (Breakpoint)->number); \
264 /* Variables used to pass information between the Breakpoint
265 constructor and the breakpoint-created hook function. */
266 extern gdbpy_breakpoint_object
*bppy_pending_object
;
273 /* The thread we represent. */
274 struct thread_info
*thread
;
276 /* The Inferior object to which this thread belongs. */
280 extern struct cmd_list_element
*set_python_list
;
281 extern struct cmd_list_element
*show_python_list
;
283 PyObject
*gdbpy_history (PyObject
*self
, PyObject
*args
);
284 PyObject
*gdbpy_breakpoints (PyObject
*, PyObject
*);
285 PyObject
*gdbpy_frame_stop_reason_string (PyObject
*, PyObject
*);
286 PyObject
*gdbpy_lookup_symbol (PyObject
*self
, PyObject
*args
, PyObject
*kw
);
287 PyObject
*gdbpy_lookup_global_symbol (PyObject
*self
, PyObject
*args
,
289 PyObject
*gdbpy_newest_frame (PyObject
*self
, PyObject
*args
);
290 PyObject
*gdbpy_selected_frame (PyObject
*self
, PyObject
*args
);
291 PyObject
*gdbpy_block_for_pc (PyObject
*self
, PyObject
*args
);
292 PyObject
*gdbpy_lookup_type (PyObject
*self
, PyObject
*args
, PyObject
*kw
);
293 PyObject
*gdbpy_create_lazy_string_object (CORE_ADDR address
, long length
,
294 const char *encoding
,
296 PyObject
*gdbpy_inferiors (PyObject
*unused
, PyObject
*unused2
);
297 PyObject
*gdbpy_selected_thread (PyObject
*self
, PyObject
*args
);
298 PyObject
*gdbpy_selected_inferior (PyObject
*self
, PyObject
*args
);
299 PyObject
*gdbpy_string_to_argv (PyObject
*self
, PyObject
*args
);
300 PyObject
*gdbpy_parameter (PyObject
*self
, PyObject
*args
);
301 PyObject
*gdbpy_parameter_value (enum var_types type
, void *var
);
302 char *gdbpy_parse_command_name (const char *name
,
303 struct cmd_list_element
***base_list
,
304 struct cmd_list_element
**start_list
);
306 PyObject
*symtab_and_line_to_sal_object (struct symtab_and_line sal
);
307 PyObject
*symtab_to_symtab_object (struct symtab
*symtab
);
308 PyObject
*symbol_to_symbol_object (struct symbol
*sym
);
309 PyObject
*block_to_block_object (const struct block
*block
,
310 struct objfile
*objfile
);
311 PyObject
*value_to_value_object (struct value
*v
);
312 PyObject
*type_to_type_object (struct type
*);
313 PyObject
*frame_info_to_frame_object (struct frame_info
*frame
);
314 PyObject
*symtab_to_linetable_object (PyObject
*symtab
);
315 PyObject
*pspace_to_pspace_object (struct program_space
*)
316 CPYCHECKER_RETURNS_BORROWED_REF
;
317 PyObject
*pspy_get_printers (PyObject
*, void *);
318 PyObject
*pspy_get_frame_filters (PyObject
*, void *);
320 PyObject
*objfile_to_objfile_object (struct objfile
*)
321 CPYCHECKER_RETURNS_BORROWED_REF
;
322 PyObject
*objfpy_get_printers (PyObject
*, void *);
323 PyObject
*objfpy_get_frame_filters (PyObject
*, void *);
325 PyObject
*gdbarch_to_arch_object (struct gdbarch
*gdbarch
);
327 thread_object
*create_thread_object (struct thread_info
*tp
);
328 thread_object
*find_thread_object (ptid_t ptid
)
329 CPYCHECKER_RETURNS_BORROWED_REF
;
330 PyObject
*find_inferior_object (int pid
);
331 PyObject
*inferior_to_inferior_object (struct inferior
*inferior
);
333 const struct block
*block_object_to_block (PyObject
*obj
);
334 struct symbol
*symbol_object_to_symbol (PyObject
*obj
);
335 struct value
*value_object_to_value (PyObject
*self
);
336 struct value
*convert_value_from_python (PyObject
*obj
);
337 struct type
*type_object_to_type (PyObject
*obj
);
338 struct symtab
*symtab_object_to_symtab (PyObject
*obj
);
339 struct symtab_and_line
*sal_object_to_symtab_and_line (PyObject
*obj
);
340 struct frame_info
*frame_object_to_frame_info (PyObject
*frame_obj
);
341 struct gdbarch
*arch_object_to_gdbarch (PyObject
*obj
);
343 void gdbpy_initialize_gdb_readline (void);
344 int gdbpy_initialize_auto_load (void)
345 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
346 int gdbpy_initialize_values (void)
347 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
348 int gdbpy_initialize_frames (void)
349 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
350 int gdbpy_initialize_symtabs (void)
351 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
352 int gdbpy_initialize_commands (void)
353 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
354 int gdbpy_initialize_symbols (void)
355 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
356 int gdbpy_initialize_symtabs (void)
357 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
358 int gdbpy_initialize_blocks (void)
359 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
360 int gdbpy_initialize_types (void)
361 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
362 int gdbpy_initialize_functions (void)
363 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
364 int gdbpy_initialize_pspace (void)
365 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
366 int gdbpy_initialize_objfile (void)
367 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
368 int gdbpy_initialize_breakpoints (void)
369 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
370 int gdbpy_initialize_finishbreakpoints (void)
371 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
372 int gdbpy_initialize_lazy_string (void)
373 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
374 int gdbpy_initialize_linetable (void)
375 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
376 int gdbpy_initialize_parameters (void)
377 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
378 int gdbpy_initialize_thread (void)
379 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
380 int gdbpy_initialize_inferior (void)
381 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
382 int gdbpy_initialize_eventregistry (void)
383 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
384 int gdbpy_initialize_event (void)
385 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
386 int gdbpy_initialize_py_events (void)
387 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
388 int gdbpy_initialize_stop_event (void)
389 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
390 int gdbpy_initialize_signal_event (void)
391 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
392 int gdbpy_initialize_breakpoint_event (void)
393 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
394 int gdbpy_initialize_continue_event (void)
395 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
396 int gdbpy_initialize_exited_event (void)
397 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
398 int gdbpy_initialize_thread_event (void)
399 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
400 int gdbpy_initialize_new_objfile_event (void)
401 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
402 int gdbpy_initialize_arch (void)
403 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
405 struct cleanup
*make_cleanup_py_decref (PyObject
*py
);
406 struct cleanup
*make_cleanup_py_xdecref (PyObject
*py
);
408 struct cleanup
*ensure_python_env (struct gdbarch
*gdbarch
,
409 const struct language_defn
*language
);
411 extern struct gdbarch
*python_gdbarch
;
412 extern const struct language_defn
*python_language
;
414 /* Use this after a TRY_EXCEPT to throw the appropriate Python
416 #define GDB_PY_HANDLE_EXCEPTION(Exception) \
418 if (Exception.reason < 0) \
420 gdbpy_convert_exception (Exception); \
425 /* Use this after a TRY_EXCEPT to throw the appropriate Python
426 exception. This macro is for use inside setter functions. */
427 #define GDB_PY_SET_HANDLE_EXCEPTION(Exception) \
429 if (Exception.reason < 0) \
431 gdbpy_convert_exception (Exception); \
436 void gdbpy_print_stack (void);
438 void source_python_script_for_objfile (struct objfile
*objfile
, FILE *file
,
439 const char *filename
);
441 PyObject
*python_string_to_unicode (PyObject
*obj
);
442 char *unicode_to_target_string (PyObject
*unicode_str
);
443 char *python_string_to_target_string (PyObject
*obj
);
444 PyObject
*python_string_to_target_python_string (PyObject
*obj
);
445 char *python_string_to_host_string (PyObject
*obj
);
446 int gdbpy_is_string (PyObject
*obj
);
447 char *gdbpy_obj_to_string (PyObject
*obj
);
448 char *gdbpy_exception_to_string (PyObject
*ptype
, PyObject
*pvalue
);
450 int gdbpy_is_lazy_string (PyObject
*result
);
451 void gdbpy_extract_lazy_string (PyObject
*string
, CORE_ADDR
*addr
,
452 struct type
**str_type
,
453 long *length
, char **encoding
);
455 int gdbpy_is_value_object (PyObject
*obj
);
457 /* Note that these are declared here, and not in python.h with the
458 other pretty-printer functions, because they refer to PyObject. */
459 PyObject
*apply_varobj_pretty_printer (PyObject
*print_obj
,
460 struct value
**replacement
,
461 struct ui_file
*stream
);
462 PyObject
*gdbpy_get_varobj_pretty_printer (struct value
*value
);
463 char *gdbpy_get_display_hint (PyObject
*printer
);
464 PyObject
*gdbpy_default_visualizer (PyObject
*self
, PyObject
*args
);
466 void bpfinishpy_pre_stop_hook (struct gdbpy_breakpoint_object
*bp_obj
);
467 void bpfinishpy_post_stop_hook (struct gdbpy_breakpoint_object
*bp_obj
);
469 extern PyObject
*gdbpy_doc_cst
;
470 extern PyObject
*gdbpy_children_cst
;
471 extern PyObject
*gdbpy_to_string_cst
;
472 extern PyObject
*gdbpy_display_hint_cst
;
473 extern PyObject
*gdbpy_enabled_cst
;
474 extern PyObject
*gdbpy_value_cst
;
476 /* Exception types. */
477 extern PyObject
*gdbpy_gdb_error
;
478 extern PyObject
*gdbpy_gdb_memory_error
;
479 extern PyObject
*gdbpy_gdberror_exc
;
481 extern void gdbpy_convert_exception (struct gdb_exception
)
482 CPYCHECKER_SETS_EXCEPTION
;
484 int get_addr_from_python (PyObject
*obj
, CORE_ADDR
*addr
)
485 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
487 PyObject
*gdb_py_object_from_longest (LONGEST l
);
488 PyObject
*gdb_py_object_from_ulongest (ULONGEST l
);
489 int gdb_py_int_as_long (PyObject
*, long *);
491 PyObject
*gdb_py_generic_dict (PyObject
*self
, void *closure
);
493 int gdb_pymodule_addobject (PyObject
*module
, const char *name
,
495 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
;
497 #endif /* GDB_PYTHON_INTERNAL_H */