1 /* Python interface to inferiors.
3 Copyright (C) 2009-2012 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 gdb_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 inf_obj
= PyObject_New (inferior_object
, &inferior_object_type
);
164 inf_obj
->inferior
= inferior
;
165 inf_obj
->threads
= NULL
;
166 inf_obj
->nthreads
= 0;
168 set_inferior_data (inferior
, infpy_inf_data_key
, inf_obj
);
172 Py_INCREF ((PyObject
*)inf_obj
);
174 return (PyObject
*) inf_obj
;
177 /* Finds the Python Inferior object for the given PID. Returns a
178 reference, or NULL if PID does not match any inferior object. */
181 find_inferior_object (int pid
)
183 struct inferior
*inf
= find_inferior_pid (pid
);
186 return inferior_to_inferior_object (inf
);
192 find_thread_object (ptid_t ptid
)
195 struct threadlist_entry
*thread
;
197 thread_object
*found
= NULL
;
203 inf_obj
= find_inferior_object (pid
);
208 for (thread
= ((inferior_object
*)inf_obj
)->threads
; thread
;
209 thread
= thread
->next
)
210 if (ptid_equal (thread
->thread_obj
->thread
->ptid
, ptid
))
212 found
= thread
->thread_obj
;
225 add_thread_object (struct thread_info
*tp
)
227 struct cleanup
*cleanup
;
228 thread_object
*thread_obj
;
229 inferior_object
*inf_obj
;
230 struct threadlist_entry
*entry
;
232 cleanup
= ensure_python_env (python_gdbarch
, python_language
);
234 thread_obj
= create_thread_object (tp
);
237 gdbpy_print_stack ();
238 do_cleanups (cleanup
);
242 inf_obj
= (inferior_object
*) thread_obj
->inf_obj
;
244 entry
= xmalloc (sizeof (struct threadlist_entry
));
245 entry
->thread_obj
= thread_obj
;
246 entry
->next
= inf_obj
->threads
;
248 inf_obj
->threads
= entry
;
251 do_cleanups (cleanup
);
255 delete_thread_object (struct thread_info
*tp
, int ignore
)
257 struct cleanup
*cleanup
;
258 inferior_object
*inf_obj
;
259 struct threadlist_entry
**entry
, *tmp
;
261 cleanup
= ensure_python_env (python_gdbarch
, python_language
);
263 inf_obj
= (inferior_object
*) find_inferior_object (PIDGET(tp
->ptid
));
266 do_cleanups (cleanup
);
270 /* Find thread entry in its inferior's thread_list. */
271 for (entry
= &inf_obj
->threads
; *entry
!= NULL
; entry
=
273 if ((*entry
)->thread_obj
->thread
== tp
)
279 do_cleanups (cleanup
);
284 tmp
->thread_obj
->thread
= NULL
;
286 *entry
= (*entry
)->next
;
289 Py_DECREF (tmp
->thread_obj
);
293 do_cleanups (cleanup
);
297 infpy_threads (PyObject
*self
, PyObject
*args
)
300 struct threadlist_entry
*entry
;
301 inferior_object
*inf_obj
= (inferior_object
*) self
;
303 volatile struct gdb_exception except
;
305 INFPY_REQUIRE_VALID (inf_obj
);
307 TRY_CATCH (except
, RETURN_MASK_ALL
)
308 update_thread_list ();
309 GDB_PY_HANDLE_EXCEPTION (except
);
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 Inferior.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
, *result
;
412 volatile struct gdb_exception except
;
413 static char *keywords
[] = { "address", "length", NULL
};
415 if (! PyArg_ParseTupleAndKeywords (args
, kw
, "OO", keywords
,
416 &addr_obj
, &length_obj
))
419 TRY_CATCH (except
, RETURN_MASK_ALL
)
421 if (!get_addr_from_python (addr_obj
, &addr
)
422 || !get_addr_from_python (length_obj
, &length
))
428 buffer
= xmalloc (length
);
430 read_memory (addr
, buffer
, length
);
432 if (except
.reason
< 0)
435 GDB_PY_HANDLE_EXCEPTION (except
);
444 membuf_obj
= PyObject_New (membuf_object
, &membuf_object_type
);
445 if (membuf_obj
== NULL
)
448 PyErr_SetString (PyExc_MemoryError
,
449 _("Could not allocate memory buffer object."));
453 membuf_obj
->buffer
= buffer
;
454 membuf_obj
->addr
= addr
;
455 membuf_obj
->length
= length
;
457 result
= PyBuffer_FromReadWriteObject ((PyObject
*) membuf_obj
, 0,
459 Py_DECREF (membuf_obj
);
463 /* Implementation of Inferior.write_memory (address, buffer [, length]).
464 Writes the contents of BUFFER (a Python object supporting the read
465 buffer protocol) at ADDRESS in the inferior's memory. Write LENGTH
466 bytes from BUFFER, or its entire contents if the argument is not
467 provided. The function returns nothing. Returns NULL on error, with
468 a python exception set. */
470 infpy_write_memory (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
475 CORE_ADDR addr
, length
;
476 PyObject
*addr_obj
, *length_obj
= NULL
;
477 volatile struct gdb_exception except
;
478 static char *keywords
[] = { "address", "buffer", "length", NULL
};
481 if (! PyArg_ParseTupleAndKeywords (args
, kw
, "Os#|O", keywords
,
482 &addr_obj
, &buffer
, &buf_len
,
486 TRY_CATCH (except
, RETURN_MASK_ALL
)
488 if (!get_addr_from_python (addr_obj
, &addr
))
496 else if (!get_addr_from_python (length_obj
, &length
))
501 write_memory_with_notification (addr
, buffer
, length
);
503 GDB_PY_HANDLE_EXCEPTION (except
);
511 /* Destructor of Membuf objects. */
513 mbpy_dealloc (PyObject
*self
)
515 xfree (((membuf_object
*) self
)->buffer
);
516 self
->ob_type
->tp_free (self
);
519 /* Return a description of the Membuf object. */
521 mbpy_str (PyObject
*self
)
523 membuf_object
*membuf_obj
= (membuf_object
*) self
;
525 return PyString_FromFormat (_("Memory buffer for address %s, \
526 which is %s bytes long."),
527 paddress (python_gdbarch
, membuf_obj
->addr
),
528 pulongest (membuf_obj
->length
));
532 get_read_buffer (PyObject
*self
, Py_ssize_t segment
, void **ptrptr
)
534 membuf_object
*membuf_obj
= (membuf_object
*) self
;
538 PyErr_SetString (PyExc_SystemError
,
539 _("The memory buffer supports only one segment."));
543 *ptrptr
= membuf_obj
->buffer
;
545 return membuf_obj
->length
;
549 get_write_buffer (PyObject
*self
, Py_ssize_t segment
, void **ptrptr
)
551 return get_read_buffer (self
, segment
, ptrptr
);
555 get_seg_count (PyObject
*self
, Py_ssize_t
*lenp
)
558 *lenp
= ((membuf_object
*) self
)->length
;
564 get_char_buffer (PyObject
*self
, Py_ssize_t segment
, char **ptrptr
)
569 ret
= get_read_buffer (self
, segment
, &ptr
);
570 *ptrptr
= (char *) ptr
;
576 gdb.search_memory (address, length, pattern). ADDRESS is the
577 address to start the search. LENGTH specifies the scope of the
578 search from ADDRESS. PATTERN is the pattern to search for (and
579 must be a Python object supporting the buffer protocol).
580 Returns a Python Long object holding the address where the pattern
581 was located, or if the pattern was not found, returns None. Returns NULL
582 on error, with a python exception set. */
584 infpy_search_memory (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
586 CORE_ADDR start_addr
, length
;
587 static char *keywords
[] = { "address", "length", "pattern", NULL
};
588 PyObject
*pattern
, *start_addr_obj
, *length_obj
;
589 volatile struct gdb_exception except
;
590 Py_ssize_t pattern_size
;
592 CORE_ADDR found_addr
;
595 if (! PyArg_ParseTupleAndKeywords (args
, kw
, "OOO", keywords
,
596 &start_addr_obj
, &length_obj
,
600 if (get_addr_from_python (start_addr_obj
, &start_addr
)
601 && get_addr_from_python (length_obj
, &length
))
605 PyErr_SetString (PyExc_ValueError
,
606 _("Search range is empty."));
609 /* Watch for overflows. */
610 else if (length
> CORE_ADDR_MAX
611 || (start_addr
+ length
- 1) < start_addr
)
613 PyErr_SetString (PyExc_ValueError
,
614 _("The search range is too large."));
622 if (!PyObject_CheckReadBuffer (pattern
))
624 PyErr_SetString (PyExc_RuntimeError
,
625 _("The pattern is not a Python buffer."));
630 if (PyObject_AsReadBuffer (pattern
, &buffer
, &pattern_size
) == -1)
633 TRY_CATCH (except
, RETURN_MASK_ALL
)
635 found
= target_search_memory (start_addr
, length
,
636 buffer
, pattern_size
,
639 GDB_PY_HANDLE_EXCEPTION (except
);
642 return PyLong_FromLong (found_addr
);
647 /* Implementation of gdb.Inferior.is_valid (self) -> Boolean.
648 Returns True if this inferior object still exists in GDB. */
651 infpy_is_valid (PyObject
*self
, PyObject
*args
)
653 inferior_object
*inf
= (inferior_object
*) self
;
662 infpy_dealloc (PyObject
*obj
)
664 inferior_object
*inf_obj
= (inferior_object
*) obj
;
665 struct inferior
*inf
= inf_obj
->inferior
;
670 set_inferior_data (inf
, infpy_inf_data_key
, NULL
);
673 /* Clear the INFERIOR pointer in an Inferior object and clear the
676 py_free_inferior (struct inferior
*inf
, void *datum
)
679 struct cleanup
*cleanup
;
680 inferior_object
*inf_obj
= datum
;
681 struct threadlist_entry
*th_entry
, *th_tmp
;
683 cleanup
= ensure_python_env (python_gdbarch
, python_language
);
685 inf_obj
->inferior
= NULL
;
687 /* Deallocate threads list. */
688 for (th_entry
= inf_obj
->threads
; th_entry
!= NULL
;)
690 Py_DECREF (th_entry
->thread_obj
);
693 th_entry
= th_entry
->next
;
697 inf_obj
->nthreads
= 0;
699 Py_DECREF ((PyObject
*) inf_obj
);
700 do_cleanups (cleanup
);
703 /* Implementation of gdb.selected_inferior() -> gdb.Inferior.
704 Returns the current inferior object. */
707 gdbpy_selected_inferior (PyObject
*self
, PyObject
*args
)
711 inf_obj
= inferior_to_inferior_object (current_inferior ());
718 gdbpy_initialize_inferior (void)
720 if (PyType_Ready (&inferior_object_type
) < 0)
723 Py_INCREF (&inferior_object_type
);
724 PyModule_AddObject (gdb_module
, "Inferior",
725 (PyObject
*) &inferior_object_type
);
728 register_inferior_data_with_cleanup (py_free_inferior
);
730 observer_attach_new_thread (add_thread_object
);
731 observer_attach_thread_exit (delete_thread_object
);
732 observer_attach_normal_stop (python_on_normal_stop
);
733 observer_attach_target_resumed (python_on_resume
);
734 observer_attach_inferior_exit (python_inferior_exit
);
735 observer_attach_new_objfile (python_new_objfile
);
737 membuf_object_type
.tp_new
= PyType_GenericNew
;
738 if (PyType_Ready (&membuf_object_type
) < 0)
741 Py_INCREF (&membuf_object_type
);
742 PyModule_AddObject (gdb_module
, "Membuf", (PyObject
*)
743 &membuf_object_type
);
746 static PyGetSetDef inferior_object_getset
[] =
748 { "num", infpy_get_num
, NULL
, "ID of inferior, as assigned by GDB.", NULL
},
749 { "pid", infpy_get_pid
, NULL
, "PID of inferior, as assigned by the OS.",
751 { "was_attached", infpy_get_was_attached
, NULL
,
752 "True if the inferior was created using 'attach'.", NULL
},
756 static PyMethodDef inferior_object_methods
[] =
758 { "is_valid", infpy_is_valid
, METH_NOARGS
,
759 "is_valid () -> Boolean.\n\
760 Return true if this inferior is valid, false if not." },
761 { "threads", infpy_threads
, METH_NOARGS
,
762 "Return all the threads of this inferior." },
763 { "read_memory", (PyCFunction
) infpy_read_memory
,
764 METH_VARARGS
| METH_KEYWORDS
,
765 "read_memory (address, length) -> buffer\n\
766 Return a buffer object for reading from the inferior's memory." },
767 { "write_memory", (PyCFunction
) infpy_write_memory
,
768 METH_VARARGS
| METH_KEYWORDS
,
769 "write_memory (address, buffer [, length])\n\
770 Write the given buffer object to the inferior's memory." },
771 { "search_memory", (PyCFunction
) infpy_search_memory
,
772 METH_VARARGS
| METH_KEYWORDS
,
773 "search_memory (address, length, pattern) -> long\n\
774 Return a long with the address of a match, or None." },
778 static PyTypeObject inferior_object_type
=
780 PyObject_HEAD_INIT (NULL
)
782 "gdb.Inferior", /* tp_name */
783 sizeof (inferior_object
), /* tp_basicsize */
785 infpy_dealloc
, /* tp_dealloc */
791 0, /* tp_as_number */
792 0, /* tp_as_sequence */
793 0, /* tp_as_mapping */
799 0, /* tp_as_buffer */
800 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_HAVE_ITER
, /* tp_flags */
801 "GDB inferior object", /* tp_doc */
804 0, /* tp_richcompare */
805 0, /* tp_weaklistoffset */
808 inferior_object_methods
, /* tp_methods */
810 inferior_object_getset
, /* tp_getset */
813 0, /* tp_descr_get */
814 0, /* tp_descr_set */
815 0, /* tp_dictoffset */
820 /* Python doesn't provide a decent way to get compatibility here. */
821 #if HAVE_LIBPYTHON2_4
822 #define CHARBUFFERPROC_NAME getcharbufferproc
824 #define CHARBUFFERPROC_NAME charbufferproc
827 static PyBufferProcs buffer_procs
= {
831 /* The cast here works around a difference between Python 2.4 and
833 (CHARBUFFERPROC_NAME
) get_char_buffer
836 static PyTypeObject membuf_object_type
= {
837 PyObject_HEAD_INIT (NULL
)
839 "gdb.Membuf", /*tp_name*/
840 sizeof (membuf_object
), /*tp_basicsize*/
842 mbpy_dealloc
, /*tp_dealloc*/
849 0, /*tp_as_sequence*/
856 &buffer_procs
, /*tp_as_buffer*/
857 Py_TPFLAGS_DEFAULT
, /*tp_flags*/
858 "GDB memory buffer object", /*tp_doc*/
861 0, /* tp_richcompare */
862 0, /* tp_weaklistoffset */
870 0, /* tp_descr_get */
871 0, /* tp_descr_set */
872 0, /* tp_dictoffset */