1 /* Gdb/Python header for private use by Python module. 2 3 Copyright (C) 2008, 2009, 2010, 2011 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 #include <stdio.h> 24 25 /* Python 2.4 doesn't include stdint.h soon enough to get {u,}intptr_t 26 needed by pyport.h. */ 27 #include <stdint.h> 28 29 /* /usr/include/features.h on linux systems will define _POSIX_C_SOURCE 30 if it sees _GNU_SOURCE (which config.h will define). 31 pyconfig.h defines _POSIX_C_SOURCE to a different value than 32 /usr/include/features.h does causing compilation to fail. 33 To work around this, undef _POSIX_C_SOURCE before we include Python.h. 34 35 Same problem with _XOPEN_SOURCE. */ 36 #undef _POSIX_C_SOURCE 37 #undef _XOPEN_SOURCE 38 39 /* On sparc-solaris, /usr/include/sys/feature_tests.h defines 40 _FILE_OFFSET_BITS, which pyconfig.h also defines. Same work 41 around technique as above. */ 42 #undef _FILE_OFFSET_BITS 43 44 /* Include the Python header files using angle brackets rather than 45 double quotes. On case-insensitive filesystems, this prevents us 46 from including our python/python.h header file. */ 47 #include <Python.h> 48 #include <frameobject.h> 49 #if HAVE_LIBPYTHON2_4 50 /* Py_ssize_t is not defined until 2.5. 51 Logical type for Py_ssize_t is Py_intptr_t, but that fails in 64-bit 52 compilation due to several apparent mistakes in python2.4 API, so we 53 use 'int' instead. */ 54 typedef int Py_ssize_t; 55 #endif 56 57 /* If Python.h does not define WITH_THREAD, then the various 58 GIL-related functions will not be defined. However, 59 PyGILState_STATE will be. */ 60 #ifndef WITH_THREAD 61 #define PyGILState_Ensure() ((PyGILState_STATE) 0) 62 #define PyGILState_Release(ARG) ((void)(ARG)) 63 #define PyEval_InitThreads() 64 #define PyThreadState_Swap(ARG) ((void)(ARG)) 65 #define PyEval_ReleaseLock() 66 #endif 67 68 /* Python supplies HAVE_LONG_LONG and some `long long' support when it 69 is available. These defines let us handle the differences more 70 cleanly. */ 71 #ifdef HAVE_LONG_LONG 72 73 #define GDB_PY_LL_ARG "L" 74 #define GDB_PY_LLU_ARG "K" 75 typedef PY_LONG_LONG gdb_py_longest; 76 typedef unsigned PY_LONG_LONG gdb_py_ulongest; 77 #define gdb_py_long_from_longest PyLong_FromLongLong 78 #define gdb_py_long_from_ulongest PyLong_FromUnsignedLongLong 79 #define gdb_py_long_as_ulongest PyLong_AsUnsignedLongLong 80 81 #else /* HAVE_LONG_LONG */ 82 83 #define GDB_PY_LL_ARG "L" 84 #define GDB_PY_LLU_ARG "K" 85 typedef long gdb_py_longest; 86 typedef unsigned long gdb_py_ulongest; 87 #define gdb_py_long_from_longest PyLong_FromLong 88 #define gdb_py_long_from_ulongest PyLong_FromUnsignedLong 89 #define gdb_py_long_as_ulongest PyLong_AsUnsignedLong 90 91 #endif /* HAVE_LONG_LONG */ 92 93 94 /* In order to be able to parse symtab_and_line_to_sal_object function 95 a real symtab_and_line structure is needed. */ 96 #include "symtab.h" 97 98 /* Also needed to parse enum var_types. */ 99 #include "command.h" 100 #include "breakpoint.h" 101 102 #include "exceptions.h" 103 104 struct block; 105 struct value; 106 struct language_defn; 107 struct program_space; 108 struct bpstats; 109 110 extern PyObject *gdb_module; 111 extern PyTypeObject value_object_type; 112 extern PyTypeObject block_object_type; 113 extern PyTypeObject symbol_object_type; 114 extern PyTypeObject event_object_type; 115 extern PyTypeObject events_object_type; 116 extern PyTypeObject stop_event_object_type; 117 118 /* Defined in py-breakpoint.c */ 119 typedef struct breakpoint_object breakpoint_object; 120 121 typedef struct 122 { 123 PyObject_HEAD 124 125 /* The thread we represent. */ 126 struct thread_info *thread; 127 128 /* The Inferior object to which this thread belongs. */ 129 PyObject *inf_obj; 130 } thread_object; 131 132 extern struct cmd_list_element *set_python_list; 133 extern struct cmd_list_element *show_python_list; 134 135 PyObject *gdbpy_history (PyObject *self, PyObject *args); 136 PyObject *gdbpy_breakpoints (PyObject *, PyObject *); 137 PyObject *gdbpy_frame_stop_reason_string (PyObject *, PyObject *); 138 PyObject *gdbpy_lookup_symbol (PyObject *self, PyObject *args, PyObject *kw); 139 PyObject *gdbpy_lookup_global_symbol (PyObject *self, PyObject *args, 140 PyObject *kw); 141 PyObject *gdbpy_newest_frame (PyObject *self, PyObject *args); 142 PyObject *gdbpy_selected_frame (PyObject *self, PyObject *args); 143 PyObject *gdbpy_block_for_pc (PyObject *self, PyObject *args); 144 PyObject *gdbpy_lookup_type (PyObject *self, PyObject *args, PyObject *kw); 145 PyObject *gdbpy_create_lazy_string_object (CORE_ADDR address, long length, 146 const char *encoding, 147 struct type *type); 148 PyObject *gdbpy_inferiors (PyObject *unused, PyObject *unused2); 149 PyObject *gdbpy_selected_thread (PyObject *self, PyObject *args); 150 PyObject *gdbpy_string_to_argv (PyObject *self, PyObject *args); 151 PyObject *gdbpy_parameter (PyObject *self, PyObject *args); 152 PyObject *gdbpy_parameter_value (enum var_types type, void *var); 153 char *gdbpy_parse_command_name (char *text, 154 struct cmd_list_element ***base_list, 155 struct cmd_list_element **start_list); 156 157 PyObject *symtab_and_line_to_sal_object (struct symtab_and_line sal); 158 PyObject *symtab_to_symtab_object (struct symtab *symtab); 159 PyObject *symbol_to_symbol_object (struct symbol *sym); 160 PyObject *block_to_block_object (struct block *block, struct objfile *objfile); 161 PyObject *value_to_value_object (struct value *v); 162 PyObject *type_to_type_object (struct type *); 163 PyObject *frame_info_to_frame_object (struct frame_info *frame); 164 165 PyObject *pspace_to_pspace_object (struct program_space *); 166 PyObject *pspy_get_printers (PyObject *, void *); 167 168 PyObject *objfile_to_objfile_object (struct objfile *); 169 PyObject *objfpy_get_printers (PyObject *, void *); 170 171 thread_object *create_thread_object (struct thread_info *tp); 172 thread_object *find_thread_object (ptid_t ptid); 173 PyObject *find_inferior_object (int pid); 174 PyObject *inferior_to_inferior_object (struct inferior *inferior); 175 176 struct block *block_object_to_block (PyObject *obj); 177 struct symbol *symbol_object_to_symbol (PyObject *obj); 178 struct value *value_object_to_value (PyObject *self); 179 struct value *convert_value_from_python (PyObject *obj); 180 struct type *type_object_to_type (PyObject *obj); 181 struct symtab *symtab_object_to_symtab (PyObject *obj); 182 struct symtab_and_line *sal_object_to_symtab_and_line (PyObject *obj); 183 184 void gdbpy_initialize_auto_load (void); 185 void gdbpy_initialize_values (void); 186 void gdbpy_initialize_frames (void); 187 void gdbpy_initialize_symtabs (void); 188 void gdbpy_initialize_commands (void); 189 void gdbpy_initialize_symbols (void); 190 void gdbpy_initialize_symtabs (void); 191 void gdbpy_initialize_blocks (void); 192 void gdbpy_initialize_types (void); 193 void gdbpy_initialize_functions (void); 194 void gdbpy_initialize_pspace (void); 195 void gdbpy_initialize_objfile (void); 196 void gdbpy_initialize_breakpoints (void); 197 void gdbpy_initialize_lazy_string (void); 198 void gdbpy_initialize_parameters (void); 199 void gdbpy_initialize_thread (void); 200 void gdbpy_initialize_inferior (void); 201 void gdbpy_initialize_eventregistry (void); 202 void gdbpy_initialize_event (void); 203 void gdbpy_initialize_py_events (void); 204 void gdbpy_initialize_stop_event (void); 205 void gdbpy_initialize_signal_event (void); 206 void gdbpy_initialize_breakpoint_event (void); 207 void gdbpy_initialize_continue_event (void); 208 void gdbpy_initialize_exited_event (void); 209 void gdbpy_initialize_thread_event (void); 210 211 struct cleanup *make_cleanup_py_decref (PyObject *py); 212 213 struct cleanup *ensure_python_env (struct gdbarch *gdbarch, 214 const struct language_defn *language); 215 216 extern struct gdbarch *python_gdbarch; 217 extern const struct language_defn *python_language; 218 219 /* Use this after a TRY_EXCEPT to throw the appropriate Python 220 exception. */ 221 #define GDB_PY_HANDLE_EXCEPTION(Exception) \ 222 do { \ 223 if (Exception.reason < 0) \ 224 return gdbpy_convert_exception (Exception); \ 225 } while (0) 226 227 /* Use this after a TRY_EXCEPT to throw the appropriate Python 228 exception. This macro is for use inside setter functions. */ 229 #define GDB_PY_SET_HANDLE_EXCEPTION(Exception) \ 230 do { \ 231 if (Exception.reason < 0) \ 232 { \ 233 gdbpy_convert_exception (Exception); \ 234 return -1; \ 235 } \ 236 } while (0) 237 238 void gdbpy_print_stack (void); 239 240 void source_python_script_for_objfile (struct objfile *objfile, 241 FILE *stream, const char *file); 242 243 PyObject *python_string_to_unicode (PyObject *obj); 244 char *unicode_to_target_string (PyObject *unicode_str); 245 char *python_string_to_target_string (PyObject *obj); 246 PyObject *python_string_to_target_python_string (PyObject *obj); 247 char *python_string_to_host_string (PyObject *obj); 248 PyObject *target_string_to_unicode (const gdb_byte *str, int length); 249 int gdbpy_is_string (PyObject *obj); 250 char *gdbpy_obj_to_string (PyObject *obj); 251 char *gdbpy_exception_to_string (PyObject *ptype, PyObject *pvalue); 252 253 int gdbpy_is_lazy_string (PyObject *result); 254 void gdbpy_extract_lazy_string (PyObject *string, CORE_ADDR *addr, 255 struct type **str_type, 256 long *length, char **encoding); 257 258 int gdbpy_is_value_object (PyObject *obj); 259 260 /* Note that these are declared here, and not in python.h with the 261 other pretty-printer functions, because they refer to PyObject. */ 262 PyObject *apply_varobj_pretty_printer (PyObject *print_obj, 263 struct value **replacement, 264 struct ui_file *stream); 265 PyObject *gdbpy_get_varobj_pretty_printer (struct value *value); 266 char *gdbpy_get_display_hint (PyObject *printer); 267 PyObject *gdbpy_default_visualizer (PyObject *self, PyObject *args); 268 269 extern PyObject *gdbpy_doc_cst; 270 extern PyObject *gdbpy_children_cst; 271 extern PyObject *gdbpy_to_string_cst; 272 extern PyObject *gdbpy_display_hint_cst; 273 extern PyObject *gdbpy_enabled_cst; 274 extern PyObject *gdbpy_value_cst; 275 276 /* Exception types. */ 277 extern PyObject *gdbpy_gdb_error; 278 extern PyObject *gdbpy_gdb_memory_error; 279 extern PyObject *gdbpy_gdberror_exc; 280 281 extern PyObject *gdbpy_convert_exception (struct gdb_exception); 282 283 int get_addr_from_python (PyObject *obj, CORE_ADDR *addr); 284 285 PyObject *gdb_py_object_from_longest (LONGEST l); 286 PyObject *gdb_py_object_from_ulongest (ULONGEST l); 287 int gdb_py_int_as_long (PyObject *, long *); 288 289 #endif /* GDB_PYTHON_INTERNAL_H */ 290