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
58 /* Python 2.4 doesn't include stdint.h soon enough to get {u,}intptr_t
59 needed by pyport.h. */
62 /* /usr/include/features.h on linux systems will define _POSIX_C_SOURCE
63 if it sees _GNU_SOURCE (which config.h will define).
64 pyconfig.h defines _POSIX_C_SOURCE to a different value than
65 /usr/include/features.h does causing compilation to fail.
66 To work around this, undef _POSIX_C_SOURCE before we include Python.h.
68 Same problem with _XOPEN_SOURCE. */
69 #undef _POSIX_C_SOURCE
72 /* On sparc-solaris, /usr/include/sys/feature_tests.h defines
73 _FILE_OFFSET_BITS, which pyconfig.h also defines. Same work
74 around technique as above. */
75 #undef _FILE_OFFSET_BITS
77 /* A kludge to avoid redefinition of snprintf on Windows by pyerrors.h. */
78 #if defined(_WIN32) && defined(HAVE_DECL_SNPRINTF)
79 #define HAVE_SNPRINTF 1
82 /* Request clean size types from Python. */
83 #define PY_SSIZE_T_CLEAN
85 /* Include the Python header files using angle brackets rather than
86 double quotes. On case-insensitive filesystems, this prevents us
87 from including our python/python.h header file. */
89 #include <frameobject.h>
91 #if PY_MAJOR_VERSION >= 3
96 #define Py_TPFLAGS_HAVE_ITER 0
97 #define Py_TPFLAGS_CHECKTYPES 0
99 #define PyInt_Check PyLong_Check
100 #define PyInt_FromLong PyLong_FromLong
101 #define PyInt_AsLong PyLong_AsLong
103 #define PyString_FromString PyUnicode_FromString
104 #define PyString_Decode PyUnicode_Decode
105 #define PyString_FromFormat PyUnicode_FromFormat
106 #define PyString_Check PyUnicode_Check
109 #if HAVE_LIBPYTHON2_4
110 /* Py_ssize_t is not defined until 2.5.
111 Logical type for Py_ssize_t is Py_intptr_t, but that fails in 64-bit
112 compilation due to several apparent mistakes in python2.4 API, so we
113 use 'int' instead. */
114 typedef int Py_ssize_t
;
117 #ifndef PyVarObject_HEAD_INIT
118 /* Python 2.4 does not define PyVarObject_HEAD_INIT. */
119 #define PyVarObject_HEAD_INIT(type, size) \
120 PyObject_HEAD_INIT(type) size,
125 /* Python 2.4 does not define Py_TYPE. */
126 #define Py_TYPE(ob) (((PyObject*)(ob))->ob_type)
129 /* If Python.h does not define WITH_THREAD, then the various
130 GIL-related functions will not be defined. However,
131 PyGILState_STATE will be. */
133 #define PyGILState_Ensure() ((PyGILState_STATE) 0)
134 #define PyGILState_Release(ARG) ((void)(ARG))
135 #define PyEval_InitThreads()
136 #define PyThreadState_Swap(ARG) ((void)(ARG))
137 #define PyEval_ReleaseLock()
140 /* Python supplies HAVE_LONG_LONG and some `long long' support when it
141 is available. These defines let us handle the differences more
143 #ifdef HAVE_LONG_LONG
145 #define GDB_PY_LL_ARG "L"
146 #define GDB_PY_LLU_ARG "K"
147 typedef PY_LONG_LONG gdb_py_longest
;
148 typedef unsigned PY_LONG_LONG gdb_py_ulongest
;
149 #define gdb_py_long_from_longest PyLong_FromLongLong
150 #define gdb_py_long_from_ulongest PyLong_FromUnsignedLongLong
151 #define gdb_py_long_as_ulongest PyLong_AsUnsignedLongLong
153 #else /* HAVE_LONG_LONG */
155 #define GDB_PY_LL_ARG "L"
156 #define GDB_PY_LLU_ARG "K"
157 typedef long gdb_py_longest
;
158 typedef unsigned long gdb_py_ulongest
;
159 #define gdb_py_long_from_longest PyLong_FromLong
160 #define gdb_py_long_from_ulongest PyLong_FromUnsignedLong
161 #define gdb_py_long_as_ulongest PyLong_AsUnsignedLong
163 #endif /* HAVE_LONG_LONG */
166 /* In order to be able to parse symtab_and_line_to_sal_object function
167 a real symtab_and_line structure is needed. */
170 /* Also needed to parse enum var_types. */
172 #include "breakpoint.h"
174 #include "exceptions.h"
176 enum gdbpy_iter_kind
{ iter_keys
, iter_values
, iter_items
};
180 struct language_defn
;
181 struct program_space
;
185 extern PyObject
*gdb_module
;
186 extern PyObject
*gdb_python_module
;
187 extern PyTypeObject value_object_type
188 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("value_object");
189 extern PyTypeObject block_object_type
190 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF("block_object");
191 extern PyTypeObject symbol_object_type
192 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("symbol_object");
193 extern PyTypeObject event_object_type
194 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("event_object");
195 extern PyTypeObject stop_event_object_type
196 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("event_object");
197 extern PyTypeObject breakpoint_object_type
198 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("breakpoint_object");
199 extern PyTypeObject frame_object_type
200 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("frame_object");
202 typedef struct breakpoint_object
206 /* The breakpoint number according to gdb. */
209 /* The gdb breakpoint object, or NULL if the breakpoint has been
211 struct breakpoint
*bp
;
213 /* 1 is this is a FinishBreakpoint object, 0 otherwise. */
217 /* Require that BREAKPOINT be a valid breakpoint ID; throw a Python
218 exception if it is invalid. */
219 #define BPPY_REQUIRE_VALID(Breakpoint) \
221 if ((Breakpoint)->bp == NULL) \
222 return PyErr_Format (PyExc_RuntimeError, \
223 _("Breakpoint %d is invalid."), \
224 (Breakpoint)->number); \
227 /* Require that BREAKPOINT be a valid breakpoint ID; throw a Python
228 exception if it is invalid. This macro is for use in setter functions. */
229 #define BPPY_SET_REQUIRE_VALID(Breakpoint) \
231 if ((Breakpoint)->bp == NULL) \
233 PyErr_Format (PyExc_RuntimeError, _("Breakpoint %d is invalid."), \
234 (Breakpoint)->number); \
240 /* Variables used to pass information between the Breakpoint
241 constructor and the breakpoint-created hook function. */
242 extern breakpoint_object
*bppy_pending_object
;
249 /* The thread we represent. */
250 struct thread_info
*thread
;
252 /* The Inferior object to which this thread belongs. */
256 extern struct cmd_list_element
*set_python_list
;
257 extern struct cmd_list_element
*show_python_list
;
259 PyObject
*gdbpy_history (PyObject
*self
, PyObject
*args
);
260 PyObject
*gdbpy_breakpoints (PyObject
*, PyObject
*);
261 PyObject
*gdbpy_frame_stop_reason_string (PyObject
*, PyObject
*);
262 PyObject
*gdbpy_lookup_symbol (PyObject
*self
, PyObject
*args
, PyObject
*kw
);
263 PyObject
*gdbpy_lookup_global_symbol (PyObject
*self
, PyObject
*args
,
265 PyObject
*gdbpy_newest_frame (PyObject
*self
, PyObject
*args
);
266 PyObject
*gdbpy_selected_frame (PyObject
*self
, PyObject
*args
);
267 PyObject
*gdbpy_block_for_pc (PyObject
*self
, PyObject
*args
);
268 PyObject
*gdbpy_lookup_type (PyObject
*self
, PyObject
*args
, PyObject
*kw
);
269 PyObject
*gdbpy_create_lazy_string_object (CORE_ADDR address
, long length
,
270 const char *encoding
,
272 PyObject
*gdbpy_inferiors (PyObject
*unused
, PyObject
*unused2
);
273 PyObject
*gdbpy_selected_thread (PyObject
*self
, PyObject
*args
);
274 PyObject
*gdbpy_selected_inferior (PyObject
*self
, PyObject
*args
);
275 PyObject
*gdbpy_string_to_argv (PyObject
*self
, PyObject
*args
);
276 PyObject
*gdbpy_parameter (PyObject
*self
, PyObject
*args
);
277 PyObject
*gdbpy_parameter_value (enum var_types type
, void *var
);
278 char *gdbpy_parse_command_name (const char *name
,
279 struct cmd_list_element
***base_list
,
280 struct cmd_list_element
**start_list
);
282 PyObject
*symtab_and_line_to_sal_object (struct symtab_and_line sal
);
283 PyObject
*symtab_to_symtab_object (struct symtab
*symtab
);
284 PyObject
*symbol_to_symbol_object (struct symbol
*sym
);
285 PyObject
*block_to_block_object (const struct block
*block
,
286 struct objfile
*objfile
);
287 PyObject
*value_to_value_object (struct value
*v
);
288 PyObject
*type_to_type_object (struct type
*);
289 PyObject
*frame_info_to_frame_object (struct frame_info
*frame
);
291 PyObject
*pspace_to_pspace_object (struct program_space
*)
292 CPYCHECKER_RETURNS_BORROWED_REF
;
293 PyObject
*pspy_get_printers (PyObject
*, void *);
294 PyObject
*pspy_get_frame_filters (PyObject
*, void *);
296 PyObject
*objfile_to_objfile_object (struct objfile
*)
297 CPYCHECKER_RETURNS_BORROWED_REF
;
298 PyObject
*objfpy_get_printers (PyObject
*, void *);
299 PyObject
*objfpy_get_frame_filters (PyObject
*, void *);
301 PyObject
*gdbarch_to_arch_object (struct gdbarch
*gdbarch
);
303 thread_object
*create_thread_object (struct thread_info
*tp
);
304 thread_object
*find_thread_object (ptid_t ptid
)
305 CPYCHECKER_RETURNS_BORROWED_REF
;
306 PyObject
*find_inferior_object (int pid
);
307 PyObject
*inferior_to_inferior_object (struct inferior
*inferior
);
309 const struct block
*block_object_to_block (PyObject
*obj
);
310 struct symbol
*symbol_object_to_symbol (PyObject
*obj
);
311 struct value
*value_object_to_value (PyObject
*self
);
312 struct value
*convert_value_from_python (PyObject
*obj
);
313 struct type
*type_object_to_type (PyObject
*obj
);
314 struct symtab
*symtab_object_to_symtab (PyObject
*obj
);
315 struct symtab_and_line
*sal_object_to_symtab_and_line (PyObject
*obj
);
316 struct frame_info
*frame_object_to_frame_info (PyObject
*frame_obj
);
317 struct gdbarch
*arch_object_to_gdbarch (PyObject
*obj
);
319 void gdbpy_initialize_gdb_readline (void);
320 void gdbpy_initialize_auto_load (void);
321 void gdbpy_initialize_values (void);
322 void gdbpy_initialize_frames (void);
323 void gdbpy_initialize_symtabs (void);
324 void gdbpy_initialize_commands (void);
325 void gdbpy_initialize_symbols (void);
326 void gdbpy_initialize_symtabs (void);
327 void gdbpy_initialize_blocks (void);
328 void gdbpy_initialize_types (void);
329 void gdbpy_initialize_functions (void);
330 void gdbpy_initialize_pspace (void);
331 void gdbpy_initialize_objfile (void);
332 void gdbpy_initialize_breakpoints (void);
333 void gdbpy_initialize_finishbreakpoints (void);
334 void gdbpy_initialize_lazy_string (void);
335 void gdbpy_initialize_parameters (void);
336 void gdbpy_initialize_thread (void);
337 void gdbpy_initialize_inferior (void);
338 void gdbpy_initialize_eventregistry (void);
339 void gdbpy_initialize_event (void);
340 void gdbpy_initialize_py_events (void);
341 void gdbpy_initialize_stop_event (void);
342 void gdbpy_initialize_signal_event (void);
343 void gdbpy_initialize_breakpoint_event (void);
344 void gdbpy_initialize_continue_event (void);
345 void gdbpy_initialize_exited_event (void);
346 void gdbpy_initialize_thread_event (void);
347 void gdbpy_initialize_new_objfile_event (void);
348 void gdbpy_initialize_arch (void);
350 struct cleanup
*make_cleanup_py_decref (PyObject
*py
);
351 struct cleanup
*make_cleanup_py_xdecref (PyObject
*py
);
353 struct cleanup
*ensure_python_env (struct gdbarch
*gdbarch
,
354 const struct language_defn
*language
);
356 extern struct gdbarch
*python_gdbarch
;
357 extern const struct language_defn
*python_language
;
359 /* Use this after a TRY_EXCEPT to throw the appropriate Python
361 #define GDB_PY_HANDLE_EXCEPTION(Exception) \
363 if (Exception.reason < 0) \
365 gdbpy_convert_exception (Exception); \
370 /* Use this after a TRY_EXCEPT to throw the appropriate Python
371 exception. This macro is for use inside setter functions. */
372 #define GDB_PY_SET_HANDLE_EXCEPTION(Exception) \
374 if (Exception.reason < 0) \
376 gdbpy_convert_exception (Exception); \
381 void gdbpy_print_stack (void);
383 void source_python_script_for_objfile (struct objfile
*objfile
, FILE *file
,
384 const char *filename
);
386 PyObject
*python_string_to_unicode (PyObject
*obj
);
387 char *unicode_to_target_string (PyObject
*unicode_str
);
388 char *python_string_to_target_string (PyObject
*obj
);
389 PyObject
*python_string_to_target_python_string (PyObject
*obj
);
390 char *python_string_to_host_string (PyObject
*obj
);
391 int gdbpy_is_string (PyObject
*obj
);
392 char *gdbpy_obj_to_string (PyObject
*obj
);
393 char *gdbpy_exception_to_string (PyObject
*ptype
, PyObject
*pvalue
);
395 int gdbpy_is_lazy_string (PyObject
*result
);
396 void gdbpy_extract_lazy_string (PyObject
*string
, CORE_ADDR
*addr
,
397 struct type
**str_type
,
398 long *length
, char **encoding
);
400 int gdbpy_is_value_object (PyObject
*obj
);
402 /* Note that these are declared here, and not in python.h with the
403 other pretty-printer functions, because they refer to PyObject. */
404 PyObject
*apply_varobj_pretty_printer (PyObject
*print_obj
,
405 struct value
**replacement
,
406 struct ui_file
*stream
);
407 PyObject
*gdbpy_get_varobj_pretty_printer (struct value
*value
);
408 char *gdbpy_get_display_hint (PyObject
*printer
);
409 PyObject
*gdbpy_default_visualizer (PyObject
*self
, PyObject
*args
);
411 void bpfinishpy_pre_stop_hook (struct breakpoint_object
*bp_obj
);
412 void bpfinishpy_post_stop_hook (struct breakpoint_object
*bp_obj
);
414 extern PyObject
*gdbpy_doc_cst
;
415 extern PyObject
*gdbpy_children_cst
;
416 extern PyObject
*gdbpy_to_string_cst
;
417 extern PyObject
*gdbpy_display_hint_cst
;
418 extern PyObject
*gdbpy_enabled_cst
;
419 extern PyObject
*gdbpy_value_cst
;
421 /* Exception types. */
422 extern PyObject
*gdbpy_gdb_error
;
423 extern PyObject
*gdbpy_gdb_memory_error
;
424 extern PyObject
*gdbpy_gdberror_exc
;
426 extern void gdbpy_convert_exception (struct gdb_exception
)
427 CPYCHECKER_SETS_EXCEPTION
;
429 int get_addr_from_python (PyObject
*obj
, CORE_ADDR
*addr
);
431 PyObject
*gdb_py_object_from_longest (LONGEST l
);
432 PyObject
*gdb_py_object_from_ulongest (ULONGEST l
);
433 int gdb_py_int_as_long (PyObject
*, long *);
435 PyObject
*gdb_py_generic_dict (PyObject
*self
, void *closure
);
437 #endif /* GDB_PYTHON_INTERNAL_H */