Let commands free "name"
[deliverable/binutils-gdb.git] / gdb / python / py-inferior.c
CommitLineData
595939de
PM
1/* Python interface to inferiors.
2
42a4f53d 3 Copyright (C) 2009-2019 Free Software Foundation, Inc.
595939de
PM
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#include "defs.h"
595939de
PM
21#include "gdbcore.h"
22#include "gdbthread.h"
23#include "inferior.h"
20c168b5 24#include "objfiles.h"
76727919 25#include "observable.h"
595939de
PM
26#include "python-internal.h"
27#include "arch-utils.h"
28#include "language.h"
268a13a5 29#include "gdbsupport/gdb_signals.h"
505500db
SW
30#include "py-event.h"
31#include "py-stopevent.h"
595939de 32
05b08ac1
TT
33struct threadlist_entry
34{
35 threadlist_entry (gdbpy_ref<thread_object> &&ref)
36 : thread_obj (std::move (ref))
37 {
38 }
39
40 gdbpy_ref<thread_object> thread_obj;
595939de
PM
41 struct threadlist_entry *next;
42};
43
00431a78 44struct inferior_object
595939de
PM
45{
46 PyObject_HEAD
47
48 /* The inferior we represent. */
49 struct inferior *inferior;
50
51 /* thread_object instances under this inferior. This list owns a
52 reference to each object it contains. */
53 struct threadlist_entry *threads;
54
55 /* Number of threads in the list. */
56 int nthreads;
00431a78 57};
595939de 58
e36122e9 59extern PyTypeObject inferior_object_type
62eec1a5 60 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("inferior_object");
595939de
PM
61
62static const struct inferior_data *infpy_inf_data_key;
63
64typedef struct {
65 PyObject_HEAD
66 void *buffer;
67
68 /* These are kept just for mbpy_str. */
69 CORE_ADDR addr;
70 CORE_ADDR length;
71} membuf_object;
72
e36122e9 73extern PyTypeObject membuf_object_type
62eec1a5 74 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("membuf_object");
595939de
PM
75
76/* Require that INFERIOR be a valid inferior ID. */
77#define INFPY_REQUIRE_VALID(Inferior) \
78 do { \
79 if (!Inferior->inferior) \
80 { \
81 PyErr_SetString (PyExc_RuntimeError, \
82 _("Inferior no longer exists.")); \
83 return NULL; \
84 } \
85 } while (0)
86
505500db
SW
87static void
88python_on_normal_stop (struct bpstats *bs, int print_frame)
89{
2ea28649 90 enum gdb_signal stop_signal;
505500db 91
0646da15
TT
92 if (!gdb_python_initialized)
93 return;
94
151bb4a5
PA
95 if (inferior_ptid == null_ptid)
96 return;
505500db
SW
97
98 stop_signal = inferior_thread ()->suspend.stop_signal;
99
07bc7329 100 gdbpy_enter enter_py (get_current_arch (), current_language);
505500db
SW
101
102 if (emit_stop_event (bs, stop_signal) < 0)
103 gdbpy_print_stack ();
505500db
SW
104}
105
106static void
107python_on_resume (ptid_t ptid)
108{
0646da15
TT
109 if (!gdb_python_initialized)
110 return;
111
07bc7329 112 gdbpy_enter enter_py (target_gdbarch (), current_language);
505500db
SW
113
114 if (emit_continue_event (ptid) < 0)
115 gdbpy_print_stack ();
505500db
SW
116}
117
162078c8
NB
118/* Callback, registered as an observer, that notifies Python listeners
119 when an inferior function call is about to be made. */
120
121static void
122python_on_inferior_call_pre (ptid_t thread, CORE_ADDR address)
123{
07bc7329 124 gdbpy_enter enter_py (target_gdbarch (), current_language);
162078c8
NB
125
126 if (emit_inferior_call_event (INFERIOR_CALL_PRE, thread, address) < 0)
127 gdbpy_print_stack ();
162078c8
NB
128}
129
130/* Callback, registered as an observer, that notifies Python listeners
131 when an inferior function call has completed. */
132
133static void
134python_on_inferior_call_post (ptid_t thread, CORE_ADDR address)
135{
07bc7329 136 gdbpy_enter enter_py (target_gdbarch (), current_language);
162078c8
NB
137
138 if (emit_inferior_call_event (INFERIOR_CALL_POST, thread, address) < 0)
139 gdbpy_print_stack ();
162078c8
NB
140}
141
142/* Callback, registered as an observer, that notifies Python listeners
143 when a part of memory has been modified by user action (eg via a
144 'set' command). */
145
146static void
147python_on_memory_change (struct inferior *inferior, CORE_ADDR addr, ssize_t len, const bfd_byte *data)
148{
07bc7329 149 gdbpy_enter enter_py (target_gdbarch (), current_language);
162078c8
NB
150
151 if (emit_memory_changed_event (addr, len) < 0)
152 gdbpy_print_stack ();
162078c8
NB
153}
154
155/* Callback, registered as an observer, that notifies Python listeners
156 when a register has been modified by user action (eg via a 'set'
157 command). */
158
159static void
160python_on_register_change (struct frame_info *frame, int regnum)
161{
07bc7329 162 gdbpy_enter enter_py (target_gdbarch (), current_language);
162078c8
NB
163
164 if (emit_register_changed_event (frame, regnum) < 0)
165 gdbpy_print_stack ();
162078c8
NB
166}
167
505500db
SW
168static void
169python_inferior_exit (struct inferior *inf)
170{
8cf64490 171 const LONGEST *exit_code = NULL;
505500db 172
0646da15
TT
173 if (!gdb_python_initialized)
174 return;
175
07bc7329 176 gdbpy_enter enter_py (target_gdbarch (), current_language);
505500db 177
8cf64490
TT
178 if (inf->has_exit_code)
179 exit_code = &inf->exit_code;
505500db 180
cb6be26b 181 if (emit_exited_event (exit_code, inf) < 0)
505500db 182 gdbpy_print_stack ();
505500db
SW
183}
184
20c168b5 185/* Callback used to notify Python listeners about new objfiles loaded in the
4ffbba72
DE
186 inferior. OBJFILE may be NULL which means that the objfile list has been
187 cleared (emptied). */
20c168b5
KP
188
189static void
190python_new_objfile (struct objfile *objfile)
191{
0646da15
TT
192 if (!gdb_python_initialized)
193 return;
194
07bc7329
TT
195 gdbpy_enter enter_py (objfile != NULL
196 ? get_objfile_arch (objfile)
197 : target_gdbarch (),
198 current_language);
20c168b5 199
4ffbba72
DE
200 if (objfile == NULL)
201 {
202 if (emit_clear_objfiles_event () < 0)
203 gdbpy_print_stack ();
204 }
205 else
206 {
207 if (emit_new_objfile_event (objfile) < 0)
208 gdbpy_print_stack ();
209 }
20c168b5
KP
210}
211
754eadd1 212/* Return a reference to the Python object of type Inferior
595939de 213 representing INFERIOR. If the object has already been created,
754eadd1
PM
214 return it and increment the reference count, otherwise, create it.
215 Return NULL on failure. */
00431a78 216
61fd3e73 217gdbpy_ref<inferior_object>
595939de
PM
218inferior_to_inferior_object (struct inferior *inferior)
219{
220 inferior_object *inf_obj;
221
19ba03f4 222 inf_obj = (inferior_object *) inferior_data (inferior, infpy_inf_data_key);
595939de
PM
223 if (!inf_obj)
224 {
595939de
PM
225 inf_obj = PyObject_New (inferior_object, &inferior_object_type);
226 if (!inf_obj)
61fd3e73 227 return NULL;
595939de
PM
228
229 inf_obj->inferior = inferior;
230 inf_obj->threads = NULL;
231 inf_obj->nthreads = 0;
232
72bc1d24
SM
233 /* PyObject_New initializes the new object with a refcount of 1. This
234 counts for the reference we are keeping in the inferior data. */
595939de 235 set_inferior_data (inferior, infpy_inf_data_key, inf_obj);
595939de 236 }
72bc1d24
SM
237
238 /* We are returning a new reference. */
61fd3e73
TT
239 gdb_assert (inf_obj != nullptr);
240 return gdbpy_ref<inferior_object>::new_reference (inf_obj);
595939de
PM
241}
242
7c96f8c1
TT
243/* Called when a new inferior is created. Notifies any Python event
244 listeners. */
245static void
246python_new_inferior (struct inferior *inf)
247{
248 if (!gdb_python_initialized)
249 return;
250
251 gdbpy_enter enter_py (python_gdbarch, python_language);
252
253 if (evregpy_no_listeners_p (gdb_py_events.new_inferior))
254 return;
255
61fd3e73 256 gdbpy_ref<inferior_object> inf_obj = inferior_to_inferior_object (inf);
7c96f8c1
TT
257 if (inf_obj == NULL)
258 {
259 gdbpy_print_stack ();
260 return;
261 }
262
d98fc15b 263 gdbpy_ref<> event = create_event_object (&new_inferior_event_object_type);
7c96f8c1 264 if (event == NULL
00431a78
PA
265 || evpy_add_attribute (event.get (), "inferior",
266 (PyObject *) inf_obj.get ()) < 0
7c96f8c1
TT
267 || evpy_emit_event (event.get (), gdb_py_events.new_inferior) < 0)
268 gdbpy_print_stack ();
269}
270
271/* Called when an inferior is removed. Notifies any Python event
272 listeners. */
273static void
274python_inferior_deleted (struct inferior *inf)
275{
276 if (!gdb_python_initialized)
277 return;
278
279 gdbpy_enter enter_py (python_gdbarch, python_language);
280
281 if (evregpy_no_listeners_p (gdb_py_events.inferior_deleted))
282 return;
283
61fd3e73 284 gdbpy_ref<inferior_object> inf_obj = inferior_to_inferior_object (inf);
7c96f8c1
TT
285 if (inf_obj == NULL)
286 {
287 gdbpy_print_stack ();
288 return;
289 }
290
d98fc15b 291 gdbpy_ref<> event = create_event_object (&inferior_deleted_event_object_type);
7c96f8c1 292 if (event == NULL
00431a78
PA
293 || evpy_add_attribute (event.get (), "inferior",
294 (PyObject *) inf_obj.get ()) < 0
7c96f8c1
TT
295 || evpy_emit_event (event.get (), gdb_py_events.inferior_deleted) < 0)
296 gdbpy_print_stack ();
297}
298
db1337cc 299gdbpy_ref<>
00431a78 300thread_to_thread_object (thread_info *thr)
595939de 301{
61fd3e73 302 gdbpy_ref<inferior_object> inf_obj = inferior_to_inferior_object (thr->inf);
9205649a 303 if (inf_obj == NULL)
754eadd1
PM
304 return NULL;
305
00431a78
PA
306 for (threadlist_entry *thread = inf_obj->threads;
307 thread != NULL;
754eadd1 308 thread = thread->next)
00431a78 309 if (thread->thread_obj->thread == thr)
05b08ac1 310 return gdbpy_ref<>::new_reference ((PyObject *) thread->thread_obj.get ());
595939de 311
4a137fec
TT
312 PyErr_SetString (PyExc_SystemError,
313 _("could not find gdb thread object"));
595939de
PM
314 return NULL;
315}
316
317static void
318add_thread_object (struct thread_info *tp)
319{
595939de
PM
320 inferior_object *inf_obj;
321 struct threadlist_entry *entry;
322
0646da15
TT
323 if (!gdb_python_initialized)
324 return;
325
07bc7329 326 gdbpy_enter enter_py (python_gdbarch, python_language);
595939de 327
05b08ac1
TT
328 gdbpy_ref<thread_object> thread_obj = create_thread_object (tp);
329 if (thread_obj == NULL)
595939de
PM
330 {
331 gdbpy_print_stack ();
595939de
PM
332 return;
333 }
334
335 inf_obj = (inferior_object *) thread_obj->inf_obj;
336
05b08ac1 337 entry = new threadlist_entry (std::move (thread_obj));
595939de
PM
338 entry->next = inf_obj->threads;
339
340 inf_obj->threads = entry;
341 inf_obj->nthreads++;
7c96f8c1
TT
342
343 if (evregpy_no_listeners_p (gdb_py_events.new_thread))
344 return;
345
d98fc15b 346 gdbpy_ref<> event = create_thread_event_object (&new_thread_event_object_type,
72ee03ff 347 (PyObject *) inf_obj);
7c96f8c1
TT
348 if (event == NULL
349 || evpy_emit_event (event.get (), gdb_py_events.new_thread) < 0)
350 gdbpy_print_stack ();
595939de
PM
351}
352
353static void
354delete_thread_object (struct thread_info *tp, int ignore)
355{
595939de 356 struct threadlist_entry **entry, *tmp;
256458bc 357
0646da15
TT
358 if (!gdb_python_initialized)
359 return;
360
07bc7329 361 gdbpy_enter enter_py (python_gdbarch, python_language);
595939de 362
61fd3e73 363 gdbpy_ref<inferior_object> inf_obj = inferior_to_inferior_object (tp->inf);
88b6faea 364 if (inf_obj == NULL)
07bc7329 365 return;
595939de
PM
366
367 /* Find thread entry in its inferior's thread_list. */
368 for (entry = &inf_obj->threads; *entry != NULL; entry =
369 &(*entry)->next)
370 if ((*entry)->thread_obj->thread == tp)
371 break;
372
373 if (!*entry)
88b6faea 374 return;
595939de 375
595939de
PM
376 tmp = *entry;
377 tmp->thread_obj->thread = NULL;
378
379 *entry = (*entry)->next;
380 inf_obj->nthreads--;
381
05b08ac1 382 delete tmp;
595939de
PM
383}
384
385static PyObject *
386infpy_threads (PyObject *self, PyObject *args)
387{
388 int i;
389 struct threadlist_entry *entry;
390 inferior_object *inf_obj = (inferior_object *) self;
391 PyObject *tuple;
392
393 INFPY_REQUIRE_VALID (inf_obj);
394
a70b8144 395 try
492d29ea
PA
396 {
397 update_thread_list ();
398 }
230d2906 399 catch (const gdb_exception &except)
492d29ea
PA
400 {
401 GDB_PY_HANDLE_EXCEPTION (except);
402 }
f66713d2 403
595939de
PM
404 tuple = PyTuple_New (inf_obj->nthreads);
405 if (!tuple)
406 return NULL;
407
408 for (i = 0, entry = inf_obj->threads; i < inf_obj->nthreads;
409 i++, entry = entry->next)
410 {
05b08ac1
TT
411 PyObject *thr = (PyObject *) entry->thread_obj.get ();
412 Py_INCREF (thr);
413 PyTuple_SET_ITEM (tuple, i, thr);
595939de
PM
414 }
415
416 return tuple;
417}
418
419static PyObject *
420infpy_get_num (PyObject *self, void *closure)
421{
422 inferior_object *inf = (inferior_object *) self;
423
424 INFPY_REQUIRE_VALID (inf);
425
426 return PyLong_FromLong (inf->inferior->num);
427}
428
429static PyObject *
430infpy_get_pid (PyObject *self, void *closure)
431{
432 inferior_object *inf = (inferior_object *) self;
433
434 INFPY_REQUIRE_VALID (inf);
435
436 return PyLong_FromLong (inf->inferior->pid);
437}
438
439static PyObject *
440infpy_get_was_attached (PyObject *self, void *closure)
441{
442 inferior_object *inf = (inferior_object *) self;
443
444 INFPY_REQUIRE_VALID (inf);
445 if (inf->inferior->attach_flag)
446 Py_RETURN_TRUE;
447 Py_RETURN_FALSE;
448}
449
a40bf0c2
SM
450/* Getter of gdb.Inferior.progspace. */
451
452static PyObject *
453infpy_get_progspace (PyObject *self, void *closure)
454{
455 inferior_object *inf = (inferior_object *) self;
456
457 INFPY_REQUIRE_VALID (inf);
458
459 program_space *pspace = inf->inferior->pspace;
460 gdb_assert (pspace != nullptr);
461
3c7aa307 462 return pspace_to_pspace_object (pspace).release ();
a40bf0c2
SM
463}
464
595939de
PM
465static int
466build_inferior_list (struct inferior *inf, void *arg)
467{
19ba03f4 468 PyObject *list = (PyObject *) arg;
61fd3e73 469 gdbpy_ref<inferior_object> inferior = inferior_to_inferior_object (inf);
754eadd1 470
00431a78 471 if (inferior == NULL)
754eadd1
PM
472 return 0;
473
00431a78 474 return PyList_Append (list, (PyObject *) inferior.get ()) ? 1 : 0;
595939de
PM
475}
476
477/* Implementation of gdb.inferiors () -> (gdb.Inferior, ...).
478 Returns a tuple of all inferiors. */
479PyObject *
480gdbpy_inferiors (PyObject *unused, PyObject *unused2)
481{
7780f186 482 gdbpy_ref<> list (PyList_New (0));
f59fe7f8 483 if (list == NULL)
595939de
PM
484 return NULL;
485
f59fe7f8
TT
486 if (iterate_over_inferiors (build_inferior_list, list.get ()))
487 return NULL;
27ca1a5b 488
f59fe7f8 489 return PyList_AsTuple (list.get ());
595939de
PM
490}
491
492/* Membuf and memory manipulation. */
493
2678e2af 494/* Implementation of Inferior.read_memory (address, length).
595939de 495 Returns a Python buffer object with LENGTH bytes of the inferior's
8dc78533
JK
496 memory at ADDRESS. Both arguments are integers. Returns NULL on error,
497 with a python exception set. */
595939de
PM
498static PyObject *
499infpy_read_memory (PyObject *self, PyObject *args, PyObject *kw)
500{
595939de 501 CORE_ADDR addr, length;
075c55e0 502 gdb::unique_xmalloc_ptr<gdb_byte> buffer;
cc0265cd 503 PyObject *addr_obj, *length_obj, *result;
2adadf51 504 static const char *keywords[] = { "address", "length", NULL };
595939de 505
2adadf51
PA
506 if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "OO", keywords,
507 &addr_obj, &length_obj))
595939de
PM
508 return NULL;
509
b86af38a
TT
510 if (get_addr_from_python (addr_obj, &addr) < 0
511 || get_addr_from_python (length_obj, &length) < 0)
512 return NULL;
513
a70b8144 514 try
595939de 515 {
075c55e0 516 buffer.reset ((gdb_byte *) xmalloc (length));
595939de 517
075c55e0 518 read_memory (addr, buffer.get (), length);
595939de 519 }
230d2906 520 catch (const gdb_exception &except)
595939de 521 {
595939de
PM
522 GDB_PY_HANDLE_EXCEPTION (except);
523 }
524
88b6faea
TT
525 gdbpy_ref<membuf_object> membuf_obj (PyObject_New (membuf_object,
526 &membuf_object_type));
595939de 527 if (membuf_obj == NULL)
075c55e0 528 return NULL;
595939de 529
075c55e0 530 membuf_obj->buffer = buffer.release ();
595939de
PM
531 membuf_obj->addr = addr;
532 membuf_obj->length = length;
533
9a27f2c6 534#ifdef IS_PY3K
88b6faea 535 result = PyMemoryView_FromObject ((PyObject *) membuf_obj.get ());
9a27f2c6 536#else
88b6faea 537 result = PyBuffer_FromReadWriteObject ((PyObject *) membuf_obj.get (), 0,
cc0265cd 538 Py_END_OF_BUFFER);
9a27f2c6 539#endif
9a27f2c6 540
cc0265cd 541 return result;
595939de
PM
542}
543
2678e2af 544/* Implementation of Inferior.write_memory (address, buffer [, length]).
595939de
PM
545 Writes the contents of BUFFER (a Python object supporting the read
546 buffer protocol) at ADDRESS in the inferior's memory. Write LENGTH
547 bytes from BUFFER, or its entire contents if the argument is not
8dc78533
JK
548 provided. The function returns nothing. Returns NULL on error, with
549 a python exception set. */
595939de
PM
550static PyObject *
551infpy_write_memory (PyObject *self, PyObject *args, PyObject *kw)
552{
cc06b668 553 struct gdb_exception except;
ddd49eee 554 Py_ssize_t buf_len;
7c543f7b 555 const gdb_byte *buffer;
595939de
PM
556 CORE_ADDR addr, length;
557 PyObject *addr_obj, *length_obj = NULL;
2adadf51 558 static const char *keywords[] = { "address", "buffer", "length", NULL };
9a27f2c6 559 Py_buffer pybuf;
595939de 560
2adadf51
PA
561 if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "Os*|O", keywords,
562 &addr_obj, &pybuf, &length_obj))
9a27f2c6 563 return NULL;
595939de 564
6ca62222 565 Py_buffer_up buffer_up (&pybuf);
7c543f7b 566 buffer = (const gdb_byte *) pybuf.buf;
9a27f2c6 567 buf_len = pybuf.len;
595939de 568
b86af38a 569 if (get_addr_from_python (addr_obj, &addr) < 0)
6ca62222 570 return nullptr;
b86af38a
TT
571
572 if (!length_obj)
573 length = buf_len;
574 else if (get_addr_from_python (length_obj, &length) < 0)
6ca62222 575 return nullptr;
b86af38a 576
a70b8144 577 try
595939de 578 {
7c543f7b 579 write_memory_with_notification (addr, buffer, length);
595939de 580 }
94aeb44b 581 catch (gdb_exception &ex)
492d29ea 582 {
94aeb44b 583 except = std::move (ex);
492d29ea 584 }
492d29ea 585
595939de
PM
586 GDB_PY_HANDLE_EXCEPTION (except);
587
595939de
PM
588 Py_RETURN_NONE;
589}
590
591/* Destructor of Membuf objects. */
592static void
593mbpy_dealloc (PyObject *self)
594{
595 xfree (((membuf_object *) self)->buffer);
9a27f2c6 596 Py_TYPE (self)->tp_free (self);
595939de
PM
597}
598
599/* Return a description of the Membuf object. */
600static PyObject *
601mbpy_str (PyObject *self)
602{
603 membuf_object *membuf_obj = (membuf_object *) self;
604
605 return PyString_FromFormat (_("Memory buffer for address %s, \
606which is %s bytes long."),
607 paddress (python_gdbarch, membuf_obj->addr),
608 pulongest (membuf_obj->length));
609}
610
9a27f2c6
PK
611#ifdef IS_PY3K
612
613static int
614get_buffer (PyObject *self, Py_buffer *buf, int flags)
615{
616 membuf_object *membuf_obj = (membuf_object *) self;
617 int ret;
256458bc 618
9a27f2c6 619 ret = PyBuffer_FillInfo (buf, self, membuf_obj->buffer,
256458bc 620 membuf_obj->length, 0,
9a27f2c6 621 PyBUF_CONTIG);
a121b7c1
PA
622
623 /* Despite the documentation saying this field is a "const char *",
624 in Python 3.4 at least, it's really a "char *". */
625 buf->format = (char *) "c";
9a27f2c6
PK
626
627 return ret;
628}
629
630#else
631
595939de
PM
632static Py_ssize_t
633get_read_buffer (PyObject *self, Py_ssize_t segment, void **ptrptr)
634{
635 membuf_object *membuf_obj = (membuf_object *) self;
636
637 if (segment)
638 {
639 PyErr_SetString (PyExc_SystemError,
640 _("The memory buffer supports only one segment."));
641 return -1;
642 }
643
644 *ptrptr = membuf_obj->buffer;
645
646 return membuf_obj->length;
647}
648
649static Py_ssize_t
650get_write_buffer (PyObject *self, Py_ssize_t segment, void **ptrptr)
651{
652 return get_read_buffer (self, segment, ptrptr);
653}
654
655static Py_ssize_t
656get_seg_count (PyObject *self, Py_ssize_t *lenp)
657{
658 if (lenp)
659 *lenp = ((membuf_object *) self)->length;
660
661 return 1;
662}
663
664static Py_ssize_t
665get_char_buffer (PyObject *self, Py_ssize_t segment, char **ptrptr)
666{
667 void *ptr = NULL;
668 Py_ssize_t ret;
669
670 ret = get_read_buffer (self, segment, &ptr);
671 *ptrptr = (char *) ptr;
672
673 return ret;
674}
675
9a27f2c6
PK
676#endif /* IS_PY3K */
677
595939de
PM
678/* Implementation of
679 gdb.search_memory (address, length, pattern). ADDRESS is the
680 address to start the search. LENGTH specifies the scope of the
681 search from ADDRESS. PATTERN is the pattern to search for (and
682 must be a Python object supporting the buffer protocol).
683 Returns a Python Long object holding the address where the pattern
8dc78533
JK
684 was located, or if the pattern was not found, returns None. Returns NULL
685 on error, with a python exception set. */
595939de
PM
686static PyObject *
687infpy_search_memory (PyObject *self, PyObject *args, PyObject *kw)
688{
cc06b668 689 struct gdb_exception except;
595939de 690 CORE_ADDR start_addr, length;
2adadf51 691 static const char *keywords[] = { "address", "length", "pattern", NULL };
9a27f2c6 692 PyObject *start_addr_obj, *length_obj;
595939de 693 Py_ssize_t pattern_size;
7c543f7b 694 const gdb_byte *buffer;
595939de
PM
695 CORE_ADDR found_addr;
696 int found = 0;
9a27f2c6 697 Py_buffer pybuf;
595939de 698
2adadf51
PA
699 if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "OOs*", keywords,
700 &start_addr_obj, &length_obj,
701 &pybuf))
9a27f2c6
PK
702 return NULL;
703
6ca62222 704 Py_buffer_up buffer_up (&pybuf);
7c543f7b 705 buffer = (const gdb_byte *) pybuf.buf;
9a27f2c6 706 pattern_size = pybuf.len;
595939de 707
b86af38a 708 if (get_addr_from_python (start_addr_obj, &start_addr) < 0)
6ca62222 709 return nullptr;
256458bc 710
b86af38a 711 if (get_addr_from_python (length_obj, &length) < 0)
6ca62222 712 return nullptr;
9a27f2c6 713
b86af38a
TT
714 if (!length)
715 {
716 PyErr_SetString (PyExc_ValueError,
717 _("Search range is empty."));
6ca62222 718 return nullptr;
b86af38a
TT
719 }
720 /* Watch for overflows. */
721 else if (length > CORE_ADDR_MAX
722 || (start_addr + length - 1) < start_addr)
723 {
724 PyErr_SetString (PyExc_ValueError,
725 _("The search range is too large."));
6ca62222 726 return nullptr;
595939de 727 }
595939de 728
a70b8144 729 try
595939de
PM
730 {
731 found = target_search_memory (start_addr, length,
732 buffer, pattern_size,
733 &found_addr);
734 }
94aeb44b 735 catch (gdb_exception &ex)
492d29ea 736 {
94aeb44b 737 except = std::move (ex);
492d29ea 738 }
492d29ea 739
b86af38a 740 GDB_PY_HANDLE_EXCEPTION (except);
9a27f2c6 741
595939de
PM
742 if (found)
743 return PyLong_FromLong (found_addr);
744 else
745 Py_RETURN_NONE;
746}
747
29703da4
PM
748/* Implementation of gdb.Inferior.is_valid (self) -> Boolean.
749 Returns True if this inferior object still exists in GDB. */
750
751static PyObject *
752infpy_is_valid (PyObject *self, PyObject *args)
753{
754 inferior_object *inf = (inferior_object *) self;
755
756 if (! inf->inferior)
757 Py_RETURN_FALSE;
758
759 Py_RETURN_TRUE;
760}
761
2b0c8b01 762/* Implementation of gdb.Inferior.thread_from_handle (self, handle)
fbbe5337
KB
763 -> gdb.InferiorThread. */
764
7d221512 765static PyObject *
fbbe5337
KB
766infpy_thread_from_thread_handle (PyObject *self, PyObject *args, PyObject *kw)
767{
db1337cc 768 PyObject *handle_obj;
fbbe5337 769 inferior_object *inf_obj = (inferior_object *) self;
2b0c8b01 770 static const char *keywords[] = { "handle", NULL };
fbbe5337
KB
771
772 INFPY_REQUIRE_VALID (inf_obj);
773
774 if (! gdb_PyArg_ParseTupleAndKeywords (args, kw, "O", keywords, &handle_obj))
775 return NULL;
776
50a82723
KB
777 const gdb_byte *bytes;
778 size_t bytes_len;
779 Py_buffer_up buffer_up;
780 Py_buffer py_buf;
781
782 if (PyObject_CheckBuffer (handle_obj)
783 && PyObject_GetBuffer (handle_obj, &py_buf, PyBUF_SIMPLE) == 0)
784 {
785 buffer_up.reset (&py_buf);
786 bytes = (const gdb_byte *) py_buf.buf;
787 bytes_len = py_buf.len;
788 }
789 else if (gdbpy_is_value_object (handle_obj))
790 {
791 struct value *val = value_object_to_value (handle_obj);
792 bytes = value_contents_all (val);
793 bytes_len = TYPE_LENGTH (value_type (val));
794 }
795 else
fbbe5337
KB
796 {
797 PyErr_SetString (PyExc_TypeError,
2b0c8b01 798 _("Argument 'handle' must be a thread handle object."));
fbbe5337
KB
799
800 return NULL;
801 }
db1337cc 802
a70b8144 803 try
db1337cc
TT
804 {
805 struct thread_info *thread_info;
db1337cc 806
50a82723
KB
807 thread_info = find_thread_by_handle
808 (gdb::array_view<const gdb_byte> (bytes, bytes_len),
809 inf_obj->inferior);
db1337cc 810 if (thread_info != NULL)
4a137fec 811 return thread_to_thread_object (thread_info).release ();
db1337cc 812 }
230d2906 813 catch (const gdb_exception &except)
fbbe5337 814 {
db1337cc 815 GDB_PY_HANDLE_EXCEPTION (except);
fbbe5337
KB
816 }
817
4a137fec 818 Py_RETURN_NONE;
fbbe5337
KB
819}
820
add5ded5
TT
821/* Implementation of gdb.Inferior.architecture. */
822
823static PyObject *
824infpy_architecture (PyObject *self, PyObject *args)
825{
826 inferior_object *inf = (inferior_object *) self;
827
828 INFPY_REQUIRE_VALID (inf);
829
830 return gdbarch_to_arch_object (inf->inferior->gdbarch);
831}
832
1256af7d
SM
833/* Implement repr() for gdb.Inferior. */
834
835static PyObject *
836infpy_repr (PyObject *obj)
837{
838 inferior_object *self = (inferior_object *) obj;
839 inferior *inf = self->inferior;
840
841 if (inf == nullptr)
842 return PyString_FromString ("<gdb.Inferior (invalid)>");
843
844 return PyString_FromFormat ("<gdb.Inferior num=%d, pid=%d>",
845 inf->num, inf->pid);
846}
847
fbbe5337 848
754eadd1
PM
849static void
850infpy_dealloc (PyObject *obj)
851{
852 inferior_object *inf_obj = (inferior_object *) obj;
853 struct inferior *inf = inf_obj->inferior;
854
855 if (! inf)
856 return;
857
858 set_inferior_data (inf, infpy_inf_data_key, NULL);
2e953aca 859 Py_TYPE (obj)->tp_free (obj);
754eadd1 860}
595939de
PM
861
862/* Clear the INFERIOR pointer in an Inferior object and clear the
863 thread list. */
864static void
865py_free_inferior (struct inferior *inf, void *datum)
866{
595939de
PM
867 struct threadlist_entry *th_entry, *th_tmp;
868
0646da15
TT
869 if (!gdb_python_initialized)
870 return;
871
07bc7329 872 gdbpy_enter enter_py (python_gdbarch, python_language);
05b08ac1 873 gdbpy_ref<inferior_object> inf_obj ((inferior_object *) datum);
595939de
PM
874
875 inf_obj->inferior = NULL;
876
877 /* Deallocate threads list. */
878 for (th_entry = inf_obj->threads; th_entry != NULL;)
879 {
595939de
PM
880 th_tmp = th_entry;
881 th_entry = th_entry->next;
05b08ac1 882 delete th_tmp;
595939de
PM
883 }
884
885 inf_obj->nthreads = 0;
595939de
PM
886}
887
2aa48337
KP
888/* Implementation of gdb.selected_inferior() -> gdb.Inferior.
889 Returns the current inferior object. */
890
891PyObject *
892gdbpy_selected_inferior (PyObject *self, PyObject *args)
893{
61fd3e73
TT
894 return ((PyObject *)
895 inferior_to_inferior_object (current_inferior ()).release ());
2aa48337
KP
896}
897
999633ed 898int
595939de
PM
899gdbpy_initialize_inferior (void)
900{
901 if (PyType_Ready (&inferior_object_type) < 0)
999633ed 902 return -1;
595939de 903
aa36459a
TT
904 if (gdb_pymodule_addobject (gdb_module, "Inferior",
905 (PyObject *) &inferior_object_type) < 0)
999633ed 906 return -1;
595939de
PM
907
908 infpy_inf_data_key =
8e260fc0 909 register_inferior_data_with_cleanup (NULL, py_free_inferior);
595939de 910
76727919
TT
911 gdb::observers::new_thread.attach (add_thread_object);
912 gdb::observers::thread_exit.attach (delete_thread_object);
913 gdb::observers::normal_stop.attach (python_on_normal_stop);
914 gdb::observers::target_resumed.attach (python_on_resume);
915 gdb::observers::inferior_call_pre.attach (python_on_inferior_call_pre);
916 gdb::observers::inferior_call_post.attach (python_on_inferior_call_post);
917 gdb::observers::memory_changed.attach (python_on_memory_change);
918 gdb::observers::register_changed.attach (python_on_register_change);
919 gdb::observers::inferior_exit.attach (python_inferior_exit);
920 gdb::observers::new_objfile.attach (python_new_objfile);
921 gdb::observers::inferior_added.attach (python_new_inferior);
922 gdb::observers::inferior_removed.attach (python_inferior_deleted);
595939de 923
6a1b1664 924 membuf_object_type.tp_new = PyType_GenericNew;
595939de 925 if (PyType_Ready (&membuf_object_type) < 0)
999633ed 926 return -1;
595939de 927
8833fbf0
TT
928 return gdb_pymodule_addobject (gdb_module, "Membuf",
929 (PyObject *) &membuf_object_type);
595939de
PM
930}
931
0d1f4ceb 932static gdb_PyGetSetDef inferior_object_getset[] =
595939de
PM
933{
934 { "num", infpy_get_num, NULL, "ID of inferior, as assigned by GDB.", NULL },
935 { "pid", infpy_get_pid, NULL, "PID of inferior, as assigned by the OS.",
936 NULL },
937 { "was_attached", infpy_get_was_attached, NULL,
938 "True if the inferior was created using 'attach'.", NULL },
a40bf0c2 939 { "progspace", infpy_get_progspace, NULL, "Program space of this inferior" },
595939de
PM
940 { NULL }
941};
942
943static PyMethodDef inferior_object_methods[] =
944{
29703da4
PM
945 { "is_valid", infpy_is_valid, METH_NOARGS,
946 "is_valid () -> Boolean.\n\
947Return true if this inferior is valid, false if not." },
595939de
PM
948 { "threads", infpy_threads, METH_NOARGS,
949 "Return all the threads of this inferior." },
950 { "read_memory", (PyCFunction) infpy_read_memory,
951 METH_VARARGS | METH_KEYWORDS,
952 "read_memory (address, length) -> buffer\n\
953Return a buffer object for reading from the inferior's memory." },
954 { "write_memory", (PyCFunction) infpy_write_memory,
955 METH_VARARGS | METH_KEYWORDS,
956 "write_memory (address, buffer [, length])\n\
957Write the given buffer object to the inferior's memory." },
958 { "search_memory", (PyCFunction) infpy_search_memory,
959 METH_VARARGS | METH_KEYWORDS,
960 "search_memory (address, length, pattern) -> long\n\
961Return a long with the address of a match, or None." },
2b0c8b01 962 /* thread_from_thread_handle is deprecated. */
fbbe5337
KB
963 { "thread_from_thread_handle", (PyCFunction) infpy_thread_from_thread_handle,
964 METH_VARARGS | METH_KEYWORDS,
965 "thread_from_thread_handle (handle) -> gdb.InferiorThread.\n\
2b0c8b01
KB
966Return thread object corresponding to thread handle.\n\
967This method is deprecated - use thread_from_handle instead." },
968 { "thread_from_handle", (PyCFunction) infpy_thread_from_thread_handle,
969 METH_VARARGS | METH_KEYWORDS,
970 "thread_from_handle (handle) -> gdb.InferiorThread.\n\
fbbe5337 971Return thread object corresponding to thread handle." },
add5ded5
TT
972 { "architecture", (PyCFunction) infpy_architecture, METH_NOARGS,
973 "architecture () -> gdb.Architecture\n\
974Return architecture of this inferior." },
595939de
PM
975 { NULL }
976};
977
e36122e9 978PyTypeObject inferior_object_type =
595939de 979{
9a27f2c6 980 PyVarObject_HEAD_INIT (NULL, 0)
595939de
PM
981 "gdb.Inferior", /* tp_name */
982 sizeof (inferior_object), /* tp_basicsize */
983 0, /* tp_itemsize */
754eadd1 984 infpy_dealloc, /* tp_dealloc */
595939de
PM
985 0, /* tp_print */
986 0, /* tp_getattr */
987 0, /* tp_setattr */
988 0, /* tp_compare */
1256af7d 989 infpy_repr, /* tp_repr */
595939de
PM
990 0, /* tp_as_number */
991 0, /* tp_as_sequence */
992 0, /* tp_as_mapping */
993 0, /* tp_hash */
994 0, /* tp_call */
995 0, /* tp_str */
996 0, /* tp_getattro */
997 0, /* tp_setattro */
998 0, /* tp_as_buffer */
999 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_ITER, /* tp_flags */
1000 "GDB inferior object", /* tp_doc */
1001 0, /* tp_traverse */
1002 0, /* tp_clear */
1003 0, /* tp_richcompare */
1004 0, /* tp_weaklistoffset */
1005 0, /* tp_iter */
1006 0, /* tp_iternext */
1007 inferior_object_methods, /* tp_methods */
1008 0, /* tp_members */
1009 inferior_object_getset, /* tp_getset */
1010 0, /* tp_base */
1011 0, /* tp_dict */
1012 0, /* tp_descr_get */
1013 0, /* tp_descr_set */
1014 0, /* tp_dictoffset */
1015 0, /* tp_init */
1016 0 /* tp_alloc */
1017};
1018
9a27f2c6
PK
1019#ifdef IS_PY3K
1020
1021static PyBufferProcs buffer_procs =
1022{
1023 get_buffer
1024};
1025
1026#else
1027
595939de
PM
1028static PyBufferProcs buffer_procs = {
1029 get_read_buffer,
1030 get_write_buffer,
1031 get_seg_count,
6c28e44a 1032 get_char_buffer
595939de 1033};
9a27f2c6 1034#endif /* IS_PY3K */
595939de 1035
e36122e9 1036PyTypeObject membuf_object_type = {
9a27f2c6 1037 PyVarObject_HEAD_INIT (NULL, 0)
595939de
PM
1038 "gdb.Membuf", /*tp_name*/
1039 sizeof (membuf_object), /*tp_basicsize*/
1040 0, /*tp_itemsize*/
1041 mbpy_dealloc, /*tp_dealloc*/
1042 0, /*tp_print*/
1043 0, /*tp_getattr*/
1044 0, /*tp_setattr*/
1045 0, /*tp_compare*/
1046 0, /*tp_repr*/
1047 0, /*tp_as_number*/
1048 0, /*tp_as_sequence*/
1049 0, /*tp_as_mapping*/
1050 0, /*tp_hash */
1051 0, /*tp_call*/
1052 mbpy_str, /*tp_str*/
1053 0, /*tp_getattro*/
1054 0, /*tp_setattro*/
1055 &buffer_procs, /*tp_as_buffer*/
1056 Py_TPFLAGS_DEFAULT, /*tp_flags*/
1057 "GDB memory buffer object", /*tp_doc*/
1058 0, /* tp_traverse */
1059 0, /* tp_clear */
1060 0, /* tp_richcompare */
1061 0, /* tp_weaklistoffset */
1062 0, /* tp_iter */
1063 0, /* tp_iternext */
1064 0, /* tp_methods */
1065 0, /* tp_members */
1066 0, /* tp_getset */
1067 0, /* tp_base */
1068 0, /* tp_dict */
1069 0, /* tp_descr_get */
1070 0, /* tp_descr_set */
1071 0, /* tp_dictoffset */
1072 0, /* tp_init */
1073 0, /* tp_alloc */
595939de 1074};
This page took 0.962327 seconds and 4 git commands to generate.