gdb/python/py-inferior.c

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