gdb/python/python-internal.h

   1 /* Gdb/Python header for private use by Python module.
   2
   3    Copyright (C) 2008-2013 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   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.
  11
  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.
  16
  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/>.  */
  19
  20 #ifndef GDB_PYTHON_INTERNAL_H
  21 #define GDB_PYTHON_INTERNAL_H
  22
  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
  27    exposes.  */
  28
  29 #ifdef WITH_CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF_ATTRIBUTE
  30 #define CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF(ARG)         \
  31   __attribute__ ((cpychecker_type_object_for_typedef (ARG)))
  32 #else
  33 #define CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF(ARG)
  34 #endif
  35
  36 #include <stdio.h>
  37
  38 /* Python 2.4 doesn't include stdint.h soon enough to get {u,}intptr_t
  39    needed by pyport.h.  */
  40 #include <stdint.h>
  41
  42 /* /usr/include/features.h on linux systems will define _POSIX_C_SOURCE
  43    if it sees _GNU_SOURCE (which config.h will define).
  44    pyconfig.h defines _POSIX_C_SOURCE to a different value than
  45    /usr/include/features.h does causing compilation to fail.
  46    To work around this, undef _POSIX_C_SOURCE before we include Python.h.
  47
  48    Same problem with _XOPEN_SOURCE.  */
  49 #undef _POSIX_C_SOURCE
  50 #undef _XOPEN_SOURCE
  51
  52 /* On sparc-solaris, /usr/include/sys/feature_tests.h defines
  53    _FILE_OFFSET_BITS, which pyconfig.h also defines.  Same work
  54    around technique as above.  */
  55 #undef _FILE_OFFSET_BITS
  56
  57 /* A kludge to avoid redefinition of snprintf on Windows by pyerrors.h.  */
  58 #if defined(_WIN32) && defined(HAVE_DECL_SNPRINTF)
  59 #define HAVE_SNPRINTF 1
  60 #endif
  61
  62 /* Request clean size types from Python.  */
  63 #define PY_SSIZE_T_CLEAN
  64
  65 /* Include the Python header files using angle brackets rather than
  66    double quotes.  On case-insensitive filesystems, this prevents us
  67    from including our python/python.h header file.  */
  68 #include <Python.h>
  69 #include <frameobject.h>
  70
  71 #if PY_MAJOR_VERSION >= 3
  72 #define IS_PY3K 1
  73 #endif
  74
  75 #ifdef IS_PY3K
  76 #define Py_TPFLAGS_HAVE_ITER 0
  77 #define Py_TPFLAGS_CHECKTYPES 0
  78
  79 #define PyInt_Check PyLong_Check
  80 #define PyInt_FromLong PyLong_FromLong
  81 #define PyInt_AsLong PyLong_AsLong
  82
  83 #define PyString_FromString PyUnicode_FromString
  84 #define PyString_Decode PyUnicode_Decode
  85 #define PyString_FromFormat PyUnicode_FromFormat
  86 #define PyString_Check PyUnicode_Check
  87 #endif
  88
  89 #if HAVE_LIBPYTHON2_4
  90 /* Py_ssize_t is not defined until 2.5.
  91    Logical type for Py_ssize_t is Py_intptr_t, but that fails in 64-bit
  92    compilation due to several apparent mistakes in python2.4 API, so we
  93    use 'int' instead.  */
  94 typedef int Py_ssize_t;
  95 #endif
  96
  97 #ifndef PyVarObject_HEAD_INIT
  98 /* Python 2.4 does not define PyVarObject_HEAD_INIT.  */
  99 #define PyVarObject_HEAD_INIT(type, size)       \
 100     PyObject_HEAD_INIT(type) size,
 101
 102 #endif
 103
 104 #ifndef Py_TYPE
 105 /* Python 2.4 does not define Py_TYPE.  */
 106 #define Py_TYPE(ob)             (((PyObject*)(ob))->ob_type)
 107 #endif
 108
 109 /* If Python.h does not define WITH_THREAD, then the various
 110    GIL-related functions will not be defined.  However,
 111    PyGILState_STATE will be.  */
 112 #ifndef WITH_THREAD
 113 #define PyGILState_Ensure() ((PyGILState_STATE) 0)
 114 #define PyGILState_Release(ARG) ((void)(ARG))
 115 #define PyEval_InitThreads()
 116 #define PyThreadState_Swap(ARG) ((void)(ARG))
 117 #define PyEval_ReleaseLock()
 118 #endif
 119
 120 /* Python supplies HAVE_LONG_LONG and some `long long' support when it
 121    is available.  These defines let us handle the differences more
 122    cleanly.  */
 123 #ifdef HAVE_LONG_LONG
 124
 125 #define GDB_PY_LL_ARG "L"
 126 #define GDB_PY_LLU_ARG "K"
 127 typedef PY_LONG_LONG gdb_py_longest;
 128 typedef unsigned PY_LONG_LONG gdb_py_ulongest;
 129 #define gdb_py_long_from_longest PyLong_FromLongLong
 130 #define gdb_py_long_from_ulongest PyLong_FromUnsignedLongLong
 131 #define gdb_py_long_as_ulongest PyLong_AsUnsignedLongLong
 132
 133 #else /* HAVE_LONG_LONG */
 134
 135 #define GDB_PY_LL_ARG "L"
 136 #define GDB_PY_LLU_ARG "K"
 137 typedef long gdb_py_longest;
 138 typedef unsigned long gdb_py_ulongest;
 139 #define gdb_py_long_from_longest PyLong_FromLong
 140 #define gdb_py_long_from_ulongest PyLong_FromUnsignedLong
 141 #define gdb_py_long_as_ulongest PyLong_AsUnsignedLong
 142
 143 #endif /* HAVE_LONG_LONG */
 144
 145
 146 /* In order to be able to parse symtab_and_line_to_sal_object function
 147    a real symtab_and_line structure is needed.  */
 148 #include "symtab.h"
 149
 150 /* Also needed to parse enum var_types. */
 151 #include "command.h"
 152 #include "breakpoint.h"
 153
 154 #include "exceptions.h"
 155
 156 enum gdbpy_iter_kind { iter_keys, iter_values, iter_items };
 157
 158 struct block;
 159 struct value;
 160 struct language_defn;
 161 struct program_space;
 162 struct bpstats;
 163 struct inferior;
 164
 165 extern PyObject *gdb_module;
 166 extern PyObject *gdb_python_module;
 167 extern PyTypeObject value_object_type
 168     CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("value_object");
 169 extern PyTypeObject block_object_type
 170     CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF("block_object");
 171 extern PyTypeObject symbol_object_type
 172     CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("symbol_object");
 173 extern PyTypeObject event_object_type
 174     CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("event_object");
 175 extern PyTypeObject events_object_type;
 176 extern PyTypeObject stop_event_object_type
 177     CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("event_object");
 178 extern PyTypeObject breakpoint_object_type
 179     CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("breakpoint_object");
 180 extern PyTypeObject frame_object_type
 181     CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("frame_object");
 182
 183 typedef struct breakpoint_object
 184 {
 185   PyObject_HEAD
 186
 187   /* The breakpoint number according to gdb.  */
 188   int number;
 189
 190   /* The gdb breakpoint object, or NULL if the breakpoint has been
 191      deleted.  */
 192   struct breakpoint *bp;
 193
 194   /* 1 is this is a FinishBreakpoint object, 0 otherwise.  */
 195   int is_finish_bp;
 196 } breakpoint_object;
 197
 198 /* Require that BREAKPOINT be a valid breakpoint ID; throw a Python
 199    exception if it is invalid.  */
 200 #define BPPY_REQUIRE_VALID(Breakpoint)                                  \
 201     do {                                                                \
 202       if ((Breakpoint)->bp == NULL)                                     \
 203         return PyErr_Format (PyExc_RuntimeError,                        \
 204                              _("Breakpoint %d is invalid."),            \
 205                              (Breakpoint)->number);                     \
 206     } while (0)
 207
 208 /* Require that BREAKPOINT be a valid breakpoint ID; throw a Python
 209    exception if it is invalid.  This macro is for use in setter functions.  */
 210 #define BPPY_SET_REQUIRE_VALID(Breakpoint)                              \
 211     do {                                                                \
 212       if ((Breakpoint)->bp == NULL)                                     \
 213         {                                                               \
 214           PyErr_Format (PyExc_RuntimeError, _("Breakpoint %d is invalid."), \
 215                         (Breakpoint)->number);                          \
 216           return -1;                                                    \
 217         }                                                               \
 218     } while (0)
 219
 220
 221 /* Variables used to pass information between the Breakpoint
 222    constructor and the breakpoint-created hook function.  */
 223 extern breakpoint_object *bppy_pending_object;
 224
 225
 226 typedef struct
 227 {
 228   PyObject_HEAD
 229
 230   /* The thread we represent.  */
 231   struct thread_info *thread;
 232
 233   /* The Inferior object to which this thread belongs.  */
 234   PyObject *inf_obj;
 235 } thread_object;
 236
 237 extern struct cmd_list_element *set_python_list;
 238 extern struct cmd_list_element *show_python_list;
 239
 240 PyObject *gdbpy_history (PyObject *self, PyObject *args);
 241 PyObject *gdbpy_breakpoints (PyObject *, PyObject *);
 242 PyObject *gdbpy_frame_stop_reason_string (PyObject *, PyObject *);
 243 PyObject *gdbpy_lookup_symbol (PyObject *self, PyObject *args, PyObject *kw);
 244 PyObject *gdbpy_lookup_global_symbol (PyObject *self, PyObject *args,
 245                                       PyObject *kw);
 246 PyObject *gdbpy_newest_frame (PyObject *self, PyObject *args);
 247 PyObject *gdbpy_selected_frame (PyObject *self, PyObject *args);
 248 PyObject *gdbpy_block_for_pc (PyObject *self, PyObject *args);
 249 PyObject *gdbpy_lookup_type (PyObject *self, PyObject *args, PyObject *kw);
 250 PyObject *gdbpy_create_lazy_string_object (CORE_ADDR address, long length,
 251                                            const char *encoding,
 252                                            struct type *type);
 253 PyObject *gdbpy_inferiors (PyObject *unused, PyObject *unused2);
 254 PyObject *gdbpy_selected_thread (PyObject *self, PyObject *args);
 255 PyObject *gdbpy_selected_inferior (PyObject *self, PyObject *args);
 256 PyObject *gdbpy_string_to_argv (PyObject *self, PyObject *args);
 257 PyObject *gdbpy_parameter (PyObject *self, PyObject *args);
 258 PyObject *gdbpy_parameter_value (enum var_types type, void *var);
 259 char *gdbpy_parse_command_name (const char *name,
 260                                 struct cmd_list_element ***base_list,
 261                                 struct cmd_list_element **start_list);
 262
 263 PyObject *symtab_and_line_to_sal_object (struct symtab_and_line sal);
 264 PyObject *symtab_to_symtab_object (struct symtab *symtab);
 265 PyObject *symbol_to_symbol_object (struct symbol *sym);
 266 PyObject *block_to_block_object (const struct block *block,
 267                                  struct objfile *objfile);
 268 PyObject *value_to_value_object (struct value *v);
 269 PyObject *type_to_type_object (struct type *);
 270 PyObject *frame_info_to_frame_object (struct frame_info *frame);
 271
 272 PyObject *pspace_to_pspace_object (struct program_space *);
 273 PyObject *pspy_get_printers (PyObject *, void *);
 274 PyObject *pspy_get_frame_filters (PyObject *, void *);
 275
 276 PyObject *objfile_to_objfile_object (struct objfile *);
 277 PyObject *objfpy_get_printers (PyObject *, void *);
 278 PyObject *objfpy_get_frame_filters (PyObject *, void *);
 279
 280 PyObject *gdbarch_to_arch_object (struct gdbarch *gdbarch);
 281
 282 thread_object *create_thread_object (struct thread_info *tp);
 283 thread_object *find_thread_object (ptid_t ptid);
 284 PyObject *find_inferior_object (int pid);
 285 PyObject *inferior_to_inferior_object (struct inferior *inferior);
 286
 287 const struct block *block_object_to_block (PyObject *obj);
 288 struct symbol *symbol_object_to_symbol (PyObject *obj);
 289 struct value *value_object_to_value (PyObject *self);
 290 struct value *convert_value_from_python (PyObject *obj);
 291 struct type *type_object_to_type (PyObject *obj);
 292 struct symtab *symtab_object_to_symtab (PyObject *obj);
 293 struct symtab_and_line *sal_object_to_symtab_and_line (PyObject *obj);
 294 struct frame_info *frame_object_to_frame_info (PyObject *frame_obj);
 295 struct gdbarch *arch_object_to_gdbarch (PyObject *obj);
 296
 297 void gdbpy_initialize_gdb_readline (void);
 298 void gdbpy_initialize_auto_load (void);
 299 void gdbpy_initialize_values (void);
 300 void gdbpy_initialize_frames (void);
 301 void gdbpy_initialize_symtabs (void);
 302 void gdbpy_initialize_commands (void);
 303 void gdbpy_initialize_symbols (void);
 304 void gdbpy_initialize_symtabs (void);
 305 void gdbpy_initialize_blocks (void);
 306 void gdbpy_initialize_types (void);
 307 void gdbpy_initialize_functions (void);
 308 void gdbpy_initialize_pspace (void);
 309 void gdbpy_initialize_objfile (void);
 310 void gdbpy_initialize_breakpoints (void);
 311 void gdbpy_initialize_finishbreakpoints (void);
 312 void gdbpy_initialize_lazy_string (void);
 313 void gdbpy_initialize_parameters (void);
 314 void gdbpy_initialize_thread (void);
 315 void gdbpy_initialize_inferior (void);
 316 void gdbpy_initialize_eventregistry (void);
 317 void gdbpy_initialize_event (void);
 318 void gdbpy_initialize_py_events (void);
 319 void gdbpy_initialize_stop_event (void);
 320 void gdbpy_initialize_signal_event (void);
 321 void gdbpy_initialize_breakpoint_event (void);
 322 void gdbpy_initialize_continue_event (void);
 323 void gdbpy_initialize_exited_event (void);
 324 void gdbpy_initialize_thread_event (void);
 325 void gdbpy_initialize_new_objfile_event (void);
 326 void gdbpy_initialize_arch (void);
 327
 328 struct cleanup *make_cleanup_py_decref (PyObject *py);
 329 struct cleanup *make_cleanup_py_xdecref (PyObject *py);
 330
 331 struct cleanup *ensure_python_env (struct gdbarch *gdbarch,
 332                                    const struct language_defn *language);
 333
 334 extern struct gdbarch *python_gdbarch;
 335 extern const struct language_defn *python_language;
 336
 337 /* Use this after a TRY_EXCEPT to throw the appropriate Python
 338    exception.  */
 339 #define GDB_PY_HANDLE_EXCEPTION(Exception)                              \
 340     do {                                                                \
 341       if (Exception.reason < 0)                                         \
 342         return gdbpy_convert_exception (Exception);                     \
 343     } while (0)
 344
 345 /* Use this after a TRY_EXCEPT to throw the appropriate Python
 346    exception.  This macro is for use inside setter functions.  */
 347 #define GDB_PY_SET_HANDLE_EXCEPTION(Exception)                          \
 348     do {                                                                \
 349       if (Exception.reason < 0)                                         \
 350         {                                                               \
 351           gdbpy_convert_exception (Exception);                          \
 352           return -1;                                                    \
 353         }                                                               \
 354     } while (0)
 355
 356 void gdbpy_print_stack (void);
 357
 358 void source_python_script_for_objfile (struct objfile *objfile, FILE *file,
 359                                        const char *filename);
 360
 361 PyObject *python_string_to_unicode (PyObject *obj);
 362 char *unicode_to_target_string (PyObject *unicode_str);
 363 char *python_string_to_target_string (PyObject *obj);
 364 PyObject *python_string_to_target_python_string (PyObject *obj);
 365 char *python_string_to_host_string (PyObject *obj);
 366 int gdbpy_is_string (PyObject *obj);
 367 char *gdbpy_obj_to_string (PyObject *obj);
 368 char *gdbpy_exception_to_string (PyObject *ptype, PyObject *pvalue);
 369
 370 int gdbpy_is_lazy_string (PyObject *result);
 371 void gdbpy_extract_lazy_string (PyObject *string, CORE_ADDR *addr,
 372                                 struct type **str_type,
 373                                 long *length, char **encoding);
 374
 375 int gdbpy_is_value_object (PyObject *obj);
 376
 377 /* Note that these are declared here, and not in python.h with the
 378    other pretty-printer functions, because they refer to PyObject.  */
 379 PyObject *apply_varobj_pretty_printer (PyObject *print_obj,
 380                                        struct value **replacement,
 381                                        struct ui_file *stream);
 382 PyObject *gdbpy_get_varobj_pretty_printer (struct value *value);
 383 char *gdbpy_get_display_hint (PyObject *printer);
 384 PyObject *gdbpy_default_visualizer (PyObject *self, PyObject *args);
 385
 386 void bpfinishpy_pre_stop_hook (struct breakpoint_object *bp_obj);
 387 void bpfinishpy_post_stop_hook (struct breakpoint_object *bp_obj);
 388
 389 extern PyObject *gdbpy_doc_cst;
 390 extern PyObject *gdbpy_children_cst;
 391 extern PyObject *gdbpy_to_string_cst;
 392 extern PyObject *gdbpy_display_hint_cst;
 393 extern PyObject *gdbpy_enabled_cst;
 394 extern PyObject *gdbpy_value_cst;
 395
 396 /* Exception types.  */
 397 extern PyObject *gdbpy_gdb_error;
 398 extern PyObject *gdbpy_gdb_memory_error;
 399 extern PyObject *gdbpy_gdberror_exc;
 400
 401 extern PyObject *gdbpy_convert_exception (struct gdb_exception);
 402
 403 int get_addr_from_python (PyObject *obj, CORE_ADDR *addr);
 404
 405 PyObject *gdb_py_object_from_longest (LONGEST l);
 406 PyObject *gdb_py_object_from_ulongest (ULONGEST l);
 407 int gdb_py_int_as_long (PyObject *, long *);
 408
 409 PyObject *gdb_py_generic_dict (PyObject *self, void *closure);
 410
 411 #endif /* GDB_PYTHON_INTERNAL_H */