1 /* Python interface to inferiors.
3 Copyright (C) 2009, 2010, 2011 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/>. */
21 #include "exceptions.h"
23 #include "gdbthread.h"
27 #include "python-internal.h"
28 #include "arch-utils.h"
30 #include "gdb_signals.h"
32 #include "py-stopevent.h"
34 struct threadlist_entry {
35 thread_object *thread_obj;
36 struct threadlist_entry *next;
43 /* The inferior we represent. */
44 struct inferior *inferior;
46 /* thread_object instances under this inferior. This list owns a
47 reference to each object it contains. */
48 struct threadlist_entry *threads;
50 /* Number of threads in the list. */
54 static PyTypeObject inferior_object_type;
56 static const struct inferior_data *infpy_inf_data_key;
62 /* These are kept just for mbpy_str. */
67 static PyTypeObject membuf_object_type;
69 /* Require that INFERIOR be a valid inferior ID. */
70 #define INFPY_REQUIRE_VALID(Inferior) \
72 if (!Inferior->inferior) \
74 PyErr_SetString (PyExc_RuntimeError, \
75 _("Inferior no longer exists.")); \
81 python_on_normal_stop (struct bpstats *bs, int print_frame)
83 struct cleanup *cleanup;
84 enum target_signal stop_signal;
86 if (!find_thread_ptid (inferior_ptid))
89 stop_signal = inferior_thread ()->suspend.stop_signal;
91 cleanup = ensure_python_env (get_current_arch (), current_language);
93 if (emit_stop_event (bs, stop_signal) < 0)
96 do_cleanups (cleanup);
100 python_on_resume (ptid_t ptid)
102 struct cleanup *cleanup;
104 cleanup = ensure_python_env (target_gdbarch, current_language);
106 if (emit_continue_event (ptid) < 0)
107 gdbpy_print_stack ();
109 do_cleanups (cleanup);
113 python_inferior_exit (struct inferior *inf)
115 struct cleanup *cleanup;
116 const LONGEST *exit_code = NULL;
118 cleanup = ensure_python_env (target_gdbarch, current_language);
120 if (inf->has_exit_code)
121 exit_code = &inf->exit_code;
123 if (emit_exited_event (exit_code, inf) < 0)
124 gdbpy_print_stack ();
126 do_cleanups (cleanup);
129 /* Callback used to notify Python listeners about new objfiles loaded in the
133 python_new_objfile (struct objfile *objfile)
135 struct cleanup *cleanup;
140 cleanup = ensure_python_env (get_objfile_arch (objfile), current_language);
142 if (emit_new_objfile_event (objfile) < 0)
143 gdbpy_print_stack ();
145 do_cleanups (cleanup);
148 /* Return a reference to the Python object of type Inferior
149 representing INFERIOR. If the object has already been created,
150 return it and increment the reference count, otherwise, create it.
151 Return NULL on failure. */
153 inferior_to_inferior_object (struct inferior *inferior)
155 inferior_object *inf_obj;
157 inf_obj = inferior_data (inferior, infpy_inf_data_key);
160 struct cleanup *cleanup;
161 cleanup = ensure_python_env (python_gdbarch, python_language);
163 inf_obj = PyObject_New (inferior_object, &inferior_object_type);
166 do_cleanups (cleanup);
170 inf_obj->inferior = inferior;
171 inf_obj->threads = NULL;
172 inf_obj->nthreads = 0;
174 set_inferior_data (inferior, infpy_inf_data_key, inf_obj);
176 do_cleanups (cleanup);
179 Py_INCREF ((PyObject *)inf_obj);
181 return (PyObject *) inf_obj;
184 /* Finds the Python Inferior object for the given PID. Returns a
185 reference, or NULL if PID does not match any inferior object. */
188 find_inferior_object (int pid)
190 struct inflist_entry *p;
191 struct inferior *inf = find_inferior_pid (pid);
194 return inferior_to_inferior_object (inf);
200 find_thread_object (ptid_t ptid)
203 struct threadlist_entry *thread;
205 thread_object *found = NULL;
211 inf_obj = find_inferior_object (pid);
216 for (thread = ((inferior_object *)inf_obj)->threads; thread;
217 thread = thread->next)
218 if (ptid_equal (thread->thread_obj->thread->ptid, ptid))
220 found = thread->thread_obj;
233 add_thread_object (struct thread_info *tp)
235 struct cleanup *cleanup;
236 thread_object *thread_obj;
237 inferior_object *inf_obj;
238 struct threadlist_entry *entry;
240 cleanup = ensure_python_env (python_gdbarch, python_language);
242 thread_obj = create_thread_object (tp);
245 gdbpy_print_stack ();
246 do_cleanups (cleanup);
250 inf_obj = (inferior_object *) thread_obj->inf_obj;
252 entry = xmalloc (sizeof (struct threadlist_entry));
253 entry->thread_obj = thread_obj;
254 entry->next = inf_obj->threads;
256 inf_obj->threads = entry;
259 do_cleanups (cleanup);
263 delete_thread_object (struct thread_info *tp, int ignore)
265 struct cleanup *cleanup;
266 inferior_object *inf_obj;
267 thread_object *thread_obj;
268 struct threadlist_entry **entry, *tmp;
270 inf_obj = (inferior_object *) find_inferior_object (PIDGET(tp->ptid));
274 /* Find thread entry in its inferior's thread_list. */
275 for (entry = &inf_obj->threads; *entry != NULL; entry =
277 if ((*entry)->thread_obj->thread == tp)
286 cleanup = ensure_python_env (python_gdbarch, python_language);
289 tmp->thread_obj->thread = NULL;
291 *entry = (*entry)->next;
294 Py_DECREF (tmp->thread_obj);
298 do_cleanups (cleanup);
302 infpy_threads (PyObject *self, PyObject *args)
305 struct threadlist_entry *entry;
306 inferior_object *inf_obj = (inferior_object *) self;
309 INFPY_REQUIRE_VALID (inf_obj);
311 tuple = PyTuple_New (inf_obj->nthreads);
315 for (i = 0, entry = inf_obj->threads; i < inf_obj->nthreads;
316 i++, entry = entry->next)
318 Py_INCREF (entry->thread_obj);
319 PyTuple_SET_ITEM (tuple, i, (PyObject *) entry->thread_obj);
326 infpy_get_num (PyObject *self, void *closure)
328 inferior_object *inf = (inferior_object *) self;
330 INFPY_REQUIRE_VALID (inf);
332 return PyLong_FromLong (inf->inferior->num);
336 infpy_get_pid (PyObject *self, void *closure)
338 inferior_object *inf = (inferior_object *) self;
340 INFPY_REQUIRE_VALID (inf);
342 return PyLong_FromLong (inf->inferior->pid);
346 infpy_get_was_attached (PyObject *self, void *closure)
348 inferior_object *inf = (inferior_object *) self;
350 INFPY_REQUIRE_VALID (inf);
351 if (inf->inferior->attach_flag)
357 build_inferior_list (struct inferior *inf, void *arg)
359 PyObject *list = arg;
360 PyObject *inferior = inferior_to_inferior_object (inf);
366 success = PyList_Append (list, inferior);
367 Py_DECREF (inferior);
375 /* Implementation of gdb.inferiors () -> (gdb.Inferior, ...).
376 Returns a tuple of all inferiors. */
378 gdbpy_inferiors (PyObject *unused, PyObject *unused2)
380 PyObject *list, *tuple;
382 list = PyList_New (0);
386 if (iterate_over_inferiors (build_inferior_list, list))
392 tuple = PyList_AsTuple (list);
398 /* Membuf and memory manipulation. */
400 /* Implementation of gdb.read_memory (address, length).
401 Returns a Python buffer object with LENGTH bytes of the inferior's
402 memory at ADDRESS. Both arguments are integers. Returns NULL on error,
403 with a python exception set. */
405 infpy_read_memory (PyObject *self, PyObject *args, PyObject *kw)
408 CORE_ADDR addr, length;
410 membuf_object *membuf_obj;
411 PyObject *addr_obj, *length_obj;
412 struct cleanup *cleanups;
413 volatile struct gdb_exception except;
414 static char *keywords[] = { "address", "length", NULL };
416 if (! PyArg_ParseTupleAndKeywords (args, kw, "OO", keywords,
417 &addr_obj, &length_obj))
420 cleanups = make_cleanup (null_cleanup, NULL);
422 TRY_CATCH (except, RETURN_MASK_ALL)
424 if (!get_addr_from_python (addr_obj, &addr)
425 || !get_addr_from_python (length_obj, &length))
431 buffer = xmalloc (length);
432 make_cleanup (xfree, buffer);
434 read_memory (addr, buffer, length);
436 if (except.reason < 0)
438 do_cleanups (cleanups);
439 GDB_PY_HANDLE_EXCEPTION (except);
444 do_cleanups (cleanups);
448 membuf_obj = PyObject_New (membuf_object, &membuf_object_type);
449 if (membuf_obj == NULL)
451 PyErr_SetString (PyExc_MemoryError,
452 _("Could not allocate memory buffer object."));
453 do_cleanups (cleanups);
457 discard_cleanups (cleanups);
459 membuf_obj->buffer = buffer;
460 membuf_obj->addr = addr;
461 membuf_obj->length = length;
463 return PyBuffer_FromReadWriteObject ((PyObject *) membuf_obj, 0,
467 /* Implementation of gdb.write_memory (address, buffer [, length]).
468 Writes the contents of BUFFER (a Python object supporting the read
469 buffer protocol) at ADDRESS in the inferior's memory. Write LENGTH
470 bytes from BUFFER, or its entire contents if the argument is not
471 provided. The function returns nothing. Returns NULL on error, with
472 a python exception set. */
474 infpy_write_memory (PyObject *self, PyObject *args, PyObject *kw)
479 CORE_ADDR addr, length;
480 PyObject *addr_obj, *length_obj = NULL;
481 volatile struct gdb_exception except;
482 static char *keywords[] = { "address", "buffer", "length", NULL };
485 if (! PyArg_ParseTupleAndKeywords (args, kw, "Os#|O", keywords,
486 &addr_obj, &buffer, &buf_len,
490 TRY_CATCH (except, RETURN_MASK_ALL)
492 if (!get_addr_from_python (addr_obj, &addr))
500 else if (!get_addr_from_python (length_obj, &length))
505 write_memory (addr, buffer, length);
507 GDB_PY_HANDLE_EXCEPTION (except);
515 /* Destructor of Membuf objects. */
517 mbpy_dealloc (PyObject *self)
519 xfree (((membuf_object *) self)->buffer);
520 self->ob_type->tp_free (self);
523 /* Return a description of the Membuf object. */
525 mbpy_str (PyObject *self)
527 membuf_object *membuf_obj = (membuf_object *) self;
529 return PyString_FromFormat (_("Memory buffer for address %s, \
530 which is %s bytes long."),
531 paddress (python_gdbarch, membuf_obj->addr),
532 pulongest (membuf_obj->length));
536 get_read_buffer (PyObject *self, Py_ssize_t segment, void **ptrptr)
538 membuf_object *membuf_obj = (membuf_object *) self;
542 PyErr_SetString (PyExc_SystemError,
543 _("The memory buffer supports only one segment."));
547 *ptrptr = membuf_obj->buffer;
549 return membuf_obj->length;
553 get_write_buffer (PyObject *self, Py_ssize_t segment, void **ptrptr)
555 return get_read_buffer (self, segment, ptrptr);
559 get_seg_count (PyObject *self, Py_ssize_t *lenp)
562 *lenp = ((membuf_object *) self)->length;
568 get_char_buffer (PyObject *self, Py_ssize_t segment, char **ptrptr)
573 ret = get_read_buffer (self, segment, &ptr);
574 *ptrptr = (char *) ptr;
580 gdb.search_memory (address, length, pattern). ADDRESS is the
581 address to start the search. LENGTH specifies the scope of the
582 search from ADDRESS. PATTERN is the pattern to search for (and
583 must be a Python object supporting the buffer protocol).
584 Returns a Python Long object holding the address where the pattern
585 was located, or if the pattern was not found, returns None. Returns NULL
586 on error, with a python exception set. */
588 infpy_search_memory (PyObject *self, PyObject *args, PyObject *kw)
590 CORE_ADDR start_addr, length;
591 static char *keywords[] = { "address", "length", "pattern", NULL };
592 PyObject *pattern, *start_addr_obj, *length_obj;
593 volatile struct gdb_exception except;
594 Py_ssize_t pattern_size;
596 CORE_ADDR found_addr;
599 if (! PyArg_ParseTupleAndKeywords (args, kw, "OOO", keywords,
600 &start_addr_obj, &length_obj,
604 if (get_addr_from_python (start_addr_obj, &start_addr)
605 && get_addr_from_python (length_obj, &length))
609 PyErr_SetString (PyExc_ValueError,
610 _("Search range is empty."));
613 /* Watch for overflows. */
614 else if (length > CORE_ADDR_MAX
615 || (start_addr + length - 1) < start_addr)
617 PyErr_SetString (PyExc_ValueError,
618 _("The search range is too large."));
626 if (!PyObject_CheckReadBuffer (pattern))
628 PyErr_SetString (PyExc_RuntimeError,
629 _("The pattern is not a Python buffer."));
634 if (PyObject_AsReadBuffer (pattern, &buffer, &pattern_size) == -1)
637 TRY_CATCH (except, RETURN_MASK_ALL)
639 found = target_search_memory (start_addr, length,
640 buffer, pattern_size,
643 GDB_PY_HANDLE_EXCEPTION (except);
646 return PyLong_FromLong (found_addr);
651 /* Implementation of gdb.Inferior.is_valid (self) -> Boolean.
652 Returns True if this inferior object still exists in GDB. */
655 infpy_is_valid (PyObject *self, PyObject *args)
657 inferior_object *inf = (inferior_object *) self;
666 infpy_dealloc (PyObject *obj)
668 inferior_object *inf_obj = (inferior_object *) obj;
669 struct inferior *inf = inf_obj->inferior;
674 set_inferior_data (inf, infpy_inf_data_key, NULL);
677 /* Clear the INFERIOR pointer in an Inferior object and clear the
680 py_free_inferior (struct inferior *inf, void *datum)
683 struct cleanup *cleanup;
684 inferior_object *inf_obj = datum;
685 struct threadlist_entry *th_entry, *th_tmp;
687 cleanup = ensure_python_env (python_gdbarch, python_language);
689 inf_obj->inferior = NULL;
691 /* Deallocate threads list. */
692 for (th_entry = inf_obj->threads; th_entry != NULL;)
694 Py_DECREF (th_entry->thread_obj);
697 th_entry = th_entry->next;
701 inf_obj->nthreads = 0;
703 Py_DECREF ((PyObject *) inf_obj);
704 do_cleanups (cleanup);
707 /* Implementation of gdb.selected_inferior() -> gdb.Inferior.
708 Returns the current inferior object. */
711 gdbpy_selected_inferior (PyObject *self, PyObject *args)
715 inf_obj = inferior_to_inferior_object (current_inferior ());
722 gdbpy_initialize_inferior (void)
724 if (PyType_Ready (&inferior_object_type) < 0)
727 Py_INCREF (&inferior_object_type);
728 PyModule_AddObject (gdb_module, "Inferior",
729 (PyObject *) &inferior_object_type);
732 register_inferior_data_with_cleanup (py_free_inferior);
734 observer_attach_new_thread (add_thread_object);
735 observer_attach_thread_exit (delete_thread_object);
736 observer_attach_normal_stop (python_on_normal_stop);
737 observer_attach_target_resumed (python_on_resume);
738 observer_attach_inferior_exit (python_inferior_exit);
739 observer_attach_new_objfile (python_new_objfile);
741 membuf_object_type.tp_new = PyType_GenericNew;
742 if (PyType_Ready (&membuf_object_type) < 0)
745 Py_INCREF (&membuf_object_type);
746 PyModule_AddObject (gdb_module, "Membuf", (PyObject *)
747 &membuf_object_type);
750 static PyGetSetDef inferior_object_getset[] =
752 { "num", infpy_get_num, NULL, "ID of inferior, as assigned by GDB.", NULL },
753 { "pid", infpy_get_pid, NULL, "PID of inferior, as assigned by the OS.",
755 { "was_attached", infpy_get_was_attached, NULL,
756 "True if the inferior was created using 'attach'.", NULL },
760 static PyMethodDef inferior_object_methods[] =
762 { "is_valid", infpy_is_valid, METH_NOARGS,
763 "is_valid () -> Boolean.\n\
764 Return true if this inferior is valid, false if not." },
765 { "threads", infpy_threads, METH_NOARGS,
766 "Return all the threads of this inferior." },
767 { "read_memory", (PyCFunction) infpy_read_memory,
768 METH_VARARGS | METH_KEYWORDS,
769 "read_memory (address, length) -> buffer\n\
770 Return a buffer object for reading from the inferior's memory." },
771 { "write_memory", (PyCFunction) infpy_write_memory,
772 METH_VARARGS | METH_KEYWORDS,
773 "write_memory (address, buffer [, length])\n\
774 Write the given buffer object to the inferior's memory." },
775 { "search_memory", (PyCFunction) infpy_search_memory,
776 METH_VARARGS | METH_KEYWORDS,
777 "search_memory (address, length, pattern) -> long\n\
778 Return a long with the address of a match, or None." },
782 static PyTypeObject inferior_object_type =
784 PyObject_HEAD_INIT (NULL)
786 "gdb.Inferior", /* tp_name */
787 sizeof (inferior_object), /* tp_basicsize */
789 infpy_dealloc, /* tp_dealloc */
795 0, /* tp_as_number */
796 0, /* tp_as_sequence */
797 0, /* tp_as_mapping */
803 0, /* tp_as_buffer */
804 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_ITER, /* tp_flags */
805 "GDB inferior object", /* tp_doc */
808 0, /* tp_richcompare */
809 0, /* tp_weaklistoffset */
812 inferior_object_methods, /* tp_methods */
814 inferior_object_getset, /* tp_getset */
817 0, /* tp_descr_get */
818 0, /* tp_descr_set */
819 0, /* tp_dictoffset */
824 /* Python doesn't provide a decent way to get compatibility here. */
825 #if HAVE_LIBPYTHON2_4
826 #define CHARBUFFERPROC_NAME getcharbufferproc
828 #define CHARBUFFERPROC_NAME charbufferproc
831 static PyBufferProcs buffer_procs = {
835 /* The cast here works around a difference between Python 2.4 and
837 (CHARBUFFERPROC_NAME) get_char_buffer
840 static PyTypeObject membuf_object_type = {
841 PyObject_HEAD_INIT (NULL)
843 "gdb.Membuf", /*tp_name*/
844 sizeof (membuf_object), /*tp_basicsize*/
846 mbpy_dealloc, /*tp_dealloc*/
853 0, /*tp_as_sequence*/
860 &buffer_procs, /*tp_as_buffer*/
861 Py_TPFLAGS_DEFAULT, /*tp_flags*/
862 "GDB memory buffer object", /*tp_doc*/
865 0, /* tp_richcompare */
866 0, /* tp_weaklistoffset */
874 0, /* tp_descr_get */
875 0, /* tp_descr_set */
876 0, /* tp_dictoffset */