gdb/python/py-inferior.c

   1 /* Python interface to inferiors.
   2
   3    Copyright (C) 2009-2018 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 (!find_thread_ptid (inferior_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 /* Finds the Python Inferior object for the given PID.  Returns a
 296    reference, or NULL if PID does not match any inferior object. */
 297
 298 PyObject *
 299 find_inferior_object (int pid)
 300 {
 301   struct inferior *inf = find_inferior_pid (pid);
 302
 303   if (inf)
 304     return (PyObject *) inferior_to_inferior_object (inf);
 305
 306   return NULL;
 307 }
 308
 309 thread_object *
 310 thread_to_thread_object (thread_info *thr)
 311 {
 312   gdbpy_ref<inferior_object> inf_obj (inferior_to_inferior_object (thr->inf));
 313   if (inf_obj == NULL)
 314     return NULL;
 315
 316   for (threadlist_entry *thread = inf_obj->threads;
 317        thread != NULL;
 318        thread = thread->next)
 319     if (thread->thread_obj->thread == thr)
 320       return thread->thread_obj;
 321
 322   return NULL;
 323 }
 324
 325 static void
 326 add_thread_object (struct thread_info *tp)
 327 {
 328   thread_object *thread_obj;
 329   inferior_object *inf_obj;
 330   struct threadlist_entry *entry;
 331
 332   if (!gdb_python_initialized)
 333     return;
 334
 335   gdbpy_enter enter_py (python_gdbarch, python_language);
 336
 337   thread_obj = create_thread_object (tp);
 338   if (!thread_obj)
 339     {
 340       gdbpy_print_stack ();
 341       return;
 342     }
 343
 344   inf_obj = (inferior_object *) thread_obj->inf_obj;
 345
 346   entry = XNEW (struct threadlist_entry);
 347   entry->thread_obj = thread_obj;
 348   entry->next = inf_obj->threads;
 349
 350   inf_obj->threads = entry;
 351   inf_obj->nthreads++;
 352
 353   if (evregpy_no_listeners_p (gdb_py_events.new_thread))
 354     return;
 355
 356   gdbpy_ref<> event = create_thread_event_object (&new_thread_event_object_type,
 357                                                   (PyObject *) thread_obj);
 358   if (event == NULL
 359       || evpy_emit_event (event.get (), gdb_py_events.new_thread) < 0)
 360     gdbpy_print_stack ();
 361 }
 362
 363 static void
 364 delete_thread_object (struct thread_info *tp, int ignore)
 365 {
 366   struct threadlist_entry **entry, *tmp;
 367
 368   if (!gdb_python_initialized)
 369     return;
 370
 371   gdbpy_enter enter_py (python_gdbarch, python_language);
 372
 373   gdbpy_ref<inferior_object> inf_obj
 374     ((inferior_object *) inferior_to_inferior_object (tp->inf));
 375   if (inf_obj == NULL)
 376     return;
 377
 378   /* Find thread entry in its inferior's thread_list.  */
 379   for (entry = &inf_obj->threads; *entry != NULL; entry =
 380          &(*entry)->next)
 381     if ((*entry)->thread_obj->thread == tp)
 382       break;
 383
 384   if (!*entry)
 385     return;
 386
 387   tmp = *entry;
 388   tmp->thread_obj->thread = NULL;
 389
 390   *entry = (*entry)->next;
 391   inf_obj->nthreads--;
 392
 393   Py_DECREF (tmp->thread_obj);
 394   xfree (tmp);
 395 }
 396
 397 static PyObject *
 398 infpy_threads (PyObject *self, PyObject *args)
 399 {
 400   int i;
 401   struct threadlist_entry *entry;
 402   inferior_object *inf_obj = (inferior_object *) self;
 403   PyObject *tuple;
 404
 405   INFPY_REQUIRE_VALID (inf_obj);
 406
 407   TRY
 408     {
 409       update_thread_list ();
 410     }
 411   CATCH (except, RETURN_MASK_ALL)
 412     {
 413       GDB_PY_HANDLE_EXCEPTION (except);
 414     }
 415   END_CATCH
 416
 417   tuple = PyTuple_New (inf_obj->nthreads);
 418   if (!tuple)
 419     return NULL;
 420
 421   for (i = 0, entry = inf_obj->threads; i < inf_obj->nthreads;
 422        i++, entry = entry->next)
 423     {
 424       Py_INCREF (entry->thread_obj);
 425       PyTuple_SET_ITEM (tuple, i, (PyObject *) entry->thread_obj);
 426     }
 427
 428   return tuple;
 429 }
 430
 431 static PyObject *
 432 infpy_get_num (PyObject *self, void *closure)
 433 {
 434   inferior_object *inf = (inferior_object *) self;
 435
 436   INFPY_REQUIRE_VALID (inf);
 437
 438   return PyLong_FromLong (inf->inferior->num);
 439 }
 440
 441 static PyObject *
 442 infpy_get_pid (PyObject *self, void *closure)
 443 {
 444   inferior_object *inf = (inferior_object *) self;
 445
 446   INFPY_REQUIRE_VALID (inf);
 447
 448   return PyLong_FromLong (inf->inferior->pid);
 449 }
 450
 451 static PyObject *
 452 infpy_get_was_attached (PyObject *self, void *closure)
 453 {
 454   inferior_object *inf = (inferior_object *) self;
 455
 456   INFPY_REQUIRE_VALID (inf);
 457   if (inf->inferior->attach_flag)
 458     Py_RETURN_TRUE;
 459   Py_RETURN_FALSE;
 460 }
 461
 462 /* Getter of gdb.Inferior.progspace.  */
 463
 464 static PyObject *
 465 infpy_get_progspace (PyObject *self, void *closure)
 466 {
 467   inferior_object *inf = (inferior_object *) self;
 468
 469   INFPY_REQUIRE_VALID (inf);
 470
 471   program_space *pspace = inf->inferior->pspace;
 472   gdb_assert (pspace != nullptr);
 473
 474   return pspace_to_pspace_object (pspace).release ();
 475 }
 476
 477 static int
 478 build_inferior_list (struct inferior *inf, void *arg)
 479 {
 480   PyObject *list = (PyObject *) arg;
 481   gdbpy_ref<inferior_object> inferior (inferior_to_inferior_object (inf));
 482
 483   if (inferior == NULL)
 484     return 0;
 485
 486   return PyList_Append (list, (PyObject *) inferior.get ()) ? 1 : 0;
 487 }
 488
 489 /* Implementation of gdb.inferiors () -> (gdb.Inferior, ...).
 490    Returns a tuple of all inferiors.  */
 491 PyObject *
 492 gdbpy_inferiors (PyObject *unused, PyObject *unused2)
 493 {
 494   gdbpy_ref<> list (PyList_New (0));
 495   if (list == NULL)
 496     return NULL;
 497
 498   if (iterate_over_inferiors (build_inferior_list, list.get ()))
 499     return NULL;
 500
 501   return PyList_AsTuple (list.get ());
 502 }
 503
 504 /* Membuf and memory manipulation.  */
 505
 506 /* Implementation of Inferior.read_memory (address, length).
 507    Returns a Python buffer object with LENGTH bytes of the inferior's
 508    memory at ADDRESS.  Both arguments are integers.  Returns NULL on error,
 509    with a python exception set.  */
 510 static PyObject *
 511 infpy_read_memory (PyObject *self, PyObject *args, PyObject *kw)
 512 {
 513   CORE_ADDR addr, length;
 514   gdb_byte *buffer = NULL;
 515   PyObject *addr_obj, *length_obj, *result;
 516   static const char *keywords[] = { "address", "length", NULL };
 517
 518   if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "OO", keywords,
 519                                         &addr_obj, &length_obj))
 520     return NULL;
 521
 522   if (get_addr_from_python (addr_obj, &addr) < 0
 523       || get_addr_from_python (length_obj, &length) < 0)
 524     return NULL;
 525
 526   TRY
 527     {
 528       buffer = (gdb_byte *) xmalloc (length);
 529
 530       read_memory (addr, buffer, length);
 531     }
 532   CATCH (except, RETURN_MASK_ALL)
 533     {
 534       xfree (buffer);
 535       GDB_PY_HANDLE_EXCEPTION (except);
 536     }
 537   END_CATCH
 538
 539   gdbpy_ref<membuf_object> membuf_obj (PyObject_New (membuf_object,
 540                                                      &membuf_object_type));
 541   if (membuf_obj == NULL)
 542     {
 543       xfree (buffer);
 544       return NULL;
 545     }
 546
 547   membuf_obj->buffer = buffer;
 548   membuf_obj->addr = addr;
 549   membuf_obj->length = length;
 550
 551 #ifdef IS_PY3K
 552   result = PyMemoryView_FromObject ((PyObject *) membuf_obj.get ());
 553 #else
 554   result = PyBuffer_FromReadWriteObject ((PyObject *) membuf_obj.get (), 0,
 555                                          Py_END_OF_BUFFER);
 556 #endif
 557
 558   return result;
 559 }
 560
 561 /* Implementation of Inferior.write_memory (address, buffer [, length]).
 562    Writes the contents of BUFFER (a Python object supporting the read
 563    buffer protocol) at ADDRESS in the inferior's memory.  Write LENGTH
 564    bytes from BUFFER, or its entire contents if the argument is not
 565    provided.  The function returns nothing.  Returns NULL on error, with
 566    a python exception set.  */
 567 static PyObject *
 568 infpy_write_memory (PyObject *self, PyObject *args, PyObject *kw)
 569 {
 570   struct gdb_exception except = exception_none;
 571   Py_ssize_t buf_len;
 572   const gdb_byte *buffer;
 573   CORE_ADDR addr, length;
 574   PyObject *addr_obj, *length_obj = NULL;
 575   static const char *keywords[] = { "address", "buffer", "length", NULL };
 576 #ifdef IS_PY3K
 577   Py_buffer pybuf;
 578
 579   if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "Os*|O", keywords,
 580                                         &addr_obj, &pybuf, &length_obj))
 581     return NULL;
 582
 583   buffer = (const gdb_byte *) pybuf.buf;
 584   buf_len = pybuf.len;
 585 #else
 586   if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "Os#|O", keywords,
 587                                         &addr_obj, &buffer, &buf_len,
 588                                         &length_obj))
 589     return NULL;
 590
 591   buffer = (const gdb_byte *) buffer;
 592 #endif
 593
 594   if (get_addr_from_python (addr_obj, &addr) < 0)
 595     goto fail;
 596
 597   if (!length_obj)
 598     length = buf_len;
 599   else if (get_addr_from_python (length_obj, &length) < 0)
 600     goto fail;
 601
 602   TRY
 603     {
 604       write_memory_with_notification (addr, buffer, length);
 605     }
 606   CATCH (ex, RETURN_MASK_ALL)
 607     {
 608       except = ex;
 609     }
 610   END_CATCH
 611
 612 #ifdef IS_PY3K
 613   PyBuffer_Release (&pybuf);
 614 #endif
 615   GDB_PY_HANDLE_EXCEPTION (except);
 616
 617   Py_RETURN_NONE;
 618
 619  fail:
 620 #ifdef IS_PY3K
 621   PyBuffer_Release (&pybuf);
 622 #endif
 623   return NULL;
 624 }
 625
 626 /* Destructor of Membuf objects.  */
 627 static void
 628 mbpy_dealloc (PyObject *self)
 629 {
 630   xfree (((membuf_object *) self)->buffer);
 631   Py_TYPE (self)->tp_free (self);
 632 }
 633
 634 /* Return a description of the Membuf object.  */
 635 static PyObject *
 636 mbpy_str (PyObject *self)
 637 {
 638   membuf_object *membuf_obj = (membuf_object *) self;
 639
 640   return PyString_FromFormat (_("Memory buffer for address %s, \
 641 which is %s bytes long."),
 642                               paddress (python_gdbarch, membuf_obj->addr),
 643                               pulongest (membuf_obj->length));
 644 }
 645
 646 #ifdef IS_PY3K
 647
 648 static int
 649 get_buffer (PyObject *self, Py_buffer *buf, int flags)
 650 {
 651   membuf_object *membuf_obj = (membuf_object *) self;
 652   int ret;
 653
 654   ret = PyBuffer_FillInfo (buf, self, membuf_obj->buffer,
 655                            membuf_obj->length, 0,
 656                            PyBUF_CONTIG);
 657
 658   /* Despite the documentation saying this field is a "const char *",
 659      in Python 3.4 at least, it's really a "char *".  */
 660   buf->format = (char *) "c";
 661
 662   return ret;
 663 }
 664
 665 #else
 666
 667 static Py_ssize_t
 668 get_read_buffer (PyObject *self, Py_ssize_t segment, void **ptrptr)
 669 {
 670   membuf_object *membuf_obj = (membuf_object *) self;
 671
 672   if (segment)
 673     {
 674       PyErr_SetString (PyExc_SystemError,
 675                        _("The memory buffer supports only one segment."));
 676       return -1;
 677     }
 678
 679   *ptrptr = membuf_obj->buffer;
 680
 681   return membuf_obj->length;
 682 }
 683
 684 static Py_ssize_t
 685 get_write_buffer (PyObject *self, Py_ssize_t segment, void **ptrptr)
 686 {
 687   return get_read_buffer (self, segment, ptrptr);
 688 }
 689
 690 static Py_ssize_t
 691 get_seg_count (PyObject *self, Py_ssize_t *lenp)
 692 {
 693   if (lenp)
 694     *lenp = ((membuf_object *) self)->length;
 695
 696   return 1;
 697 }
 698
 699 static Py_ssize_t
 700 get_char_buffer (PyObject *self, Py_ssize_t segment, char **ptrptr)
 701 {
 702   void *ptr = NULL;
 703   Py_ssize_t ret;
 704
 705   ret = get_read_buffer (self, segment, &ptr);
 706   *ptrptr = (char *) ptr;
 707
 708   return ret;
 709 }
 710
 711 #endif  /* IS_PY3K */
 712
 713 /* Implementation of
 714    gdb.search_memory (address, length, pattern).  ADDRESS is the
 715    address to start the search.  LENGTH specifies the scope of the
 716    search from ADDRESS.  PATTERN is the pattern to search for (and
 717    must be a Python object supporting the buffer protocol).
 718    Returns a Python Long object holding the address where the pattern
 719    was located, or if the pattern was not found, returns None.  Returns NULL
 720    on error, with a python exception set.  */
 721 static PyObject *
 722 infpy_search_memory (PyObject *self, PyObject *args, PyObject *kw)
 723 {
 724   struct gdb_exception except = exception_none;
 725   CORE_ADDR start_addr, length;
 726   static const char *keywords[] = { "address", "length", "pattern", NULL };
 727   PyObject *start_addr_obj, *length_obj;
 728   Py_ssize_t pattern_size;
 729   const gdb_byte *buffer;
 730   CORE_ADDR found_addr;
 731   int found = 0;
 732 #ifdef IS_PY3K
 733   Py_buffer pybuf;
 734
 735   if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "OOs*", keywords,
 736                                         &start_addr_obj, &length_obj,
 737                                         &pybuf))
 738     return NULL;
 739
 740   buffer = (const gdb_byte *) pybuf.buf;
 741   pattern_size = pybuf.len;
 742 #else
 743   PyObject *pattern;
 744   const void *vbuffer;
 745
 746   if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "OOO", keywords,
 747                                         &start_addr_obj, &length_obj,
 748                                         &pattern))
 749      return NULL;
 750
 751   if (!PyObject_CheckReadBuffer (pattern))
 752     {
 753       PyErr_SetString (PyExc_RuntimeError,
 754                        _("The pattern is not a Python buffer."));
 755
 756       return NULL;
 757     }
 758
 759   if (PyObject_AsReadBuffer (pattern, &vbuffer, &pattern_size) == -1)
 760     return NULL;
 761
 762   buffer = (const gdb_byte *) vbuffer;
 763 #endif
 764
 765   if (get_addr_from_python (start_addr_obj, &start_addr) < 0)
 766     goto fail;
 767
 768   if (get_addr_from_python (length_obj, &length) < 0)
 769     goto fail;
 770
 771   if (!length)
 772     {
 773       PyErr_SetString (PyExc_ValueError,
 774                        _("Search range is empty."));
 775       goto fail;
 776     }
 777   /* Watch for overflows.  */
 778   else if (length > CORE_ADDR_MAX
 779            || (start_addr + length - 1) < start_addr)
 780     {
 781       PyErr_SetString (PyExc_ValueError,
 782                        _("The search range is too large."));
 783       goto fail;
 784     }
 785
 786   TRY
 787     {
 788       found = target_search_memory (start_addr, length,
 789                                     buffer, pattern_size,
 790                                     &found_addr);
 791     }
 792   CATCH (ex, RETURN_MASK_ALL)
 793     {
 794       except = ex;
 795     }
 796   END_CATCH
 797
 798 #ifdef IS_PY3K
 799   PyBuffer_Release (&pybuf);
 800 #endif
 801   GDB_PY_HANDLE_EXCEPTION (except);
 802
 803   if (found)
 804     return PyLong_FromLong (found_addr);
 805   else
 806     Py_RETURN_NONE;
 807
 808  fail:
 809 #ifdef IS_PY3K
 810   PyBuffer_Release (&pybuf);
 811 #endif
 812   return NULL;
 813 }
 814
 815 /* Implementation of gdb.Inferior.is_valid (self) -> Boolean.
 816    Returns True if this inferior object still exists in GDB.  */
 817
 818 static PyObject *
 819 infpy_is_valid (PyObject *self, PyObject *args)
 820 {
 821   inferior_object *inf = (inferior_object *) self;
 822
 823   if (! inf->inferior)
 824     Py_RETURN_FALSE;
 825
 826   Py_RETURN_TRUE;
 827 }
 828
 829 /* Implementation of gdb.Inferior.thread_from_thread_handle (self, handle)
 830                         ->  gdb.InferiorThread.  */
 831
 832 static PyObject *
 833 infpy_thread_from_thread_handle (PyObject *self, PyObject *args, PyObject *kw)
 834 {
 835   PyObject *handle_obj, *result;
 836   inferior_object *inf_obj = (inferior_object *) self;
 837   static const char *keywords[] = { "thread_handle", NULL };
 838
 839   INFPY_REQUIRE_VALID (inf_obj);
 840
 841   if (! gdb_PyArg_ParseTupleAndKeywords (args, kw, "O", keywords, &handle_obj))
 842     return NULL;
 843
 844   result = Py_None;
 845
 846   if (!gdbpy_is_value_object (handle_obj))
 847     {
 848       PyErr_SetString (PyExc_TypeError,
 849                        _("Argument 'handle_obj' must be a thread handle object."));
 850
 851       return NULL;
 852     }
 853   else
 854     {
 855       TRY
 856         {
 857           struct thread_info *thread_info;
 858           struct value *val = value_object_to_value (handle_obj);
 859
 860           thread_info = find_thread_by_handle (val, inf_obj->inferior);
 861           if (thread_info != NULL)
 862             {
 863               result = (PyObject *) thread_to_thread_object (thread_info);
 864               if (result != NULL)
 865                 Py_INCREF (result);
 866             }
 867         }
 868       CATCH (except, RETURN_MASK_ALL)
 869         {
 870           GDB_PY_HANDLE_EXCEPTION (except);
 871         }
 872       END_CATCH
 873     }
 874
 875   return result;
 876 }
 877
 878 /* Implement repr() for gdb.Inferior.  */
 879
 880 static PyObject *
 881 infpy_repr (PyObject *obj)
 882 {
 883   inferior_object *self = (inferior_object *) obj;
 884   inferior *inf = self->inferior;
 885
 886   if (inf == nullptr)
 887     return PyString_FromString ("<gdb.Inferior (invalid)>");
 888
 889   return PyString_FromFormat ("<gdb.Inferior num=%d, pid=%d>",
 890                               inf->num, inf->pid);
 891 }
 892
 893
 894 static void
 895 infpy_dealloc (PyObject *obj)
 896 {
 897   inferior_object *inf_obj = (inferior_object *) obj;
 898   struct inferior *inf = inf_obj->inferior;
 899
 900   if (! inf)
 901     return;
 902
 903   set_inferior_data (inf, infpy_inf_data_key, NULL);
 904 }
 905
 906 /* Clear the INFERIOR pointer in an Inferior object and clear the
 907    thread list.  */
 908 static void
 909 py_free_inferior (struct inferior *inf, void *datum)
 910 {
 911   gdbpy_ref<inferior_object> inf_obj ((inferior_object *) datum);
 912   struct threadlist_entry *th_entry, *th_tmp;
 913
 914   if (!gdb_python_initialized)
 915     return;
 916
 917   gdbpy_enter enter_py (python_gdbarch, python_language);
 918
 919   inf_obj->inferior = NULL;
 920
 921   /* Deallocate threads list.  */
 922   for (th_entry = inf_obj->threads; th_entry != NULL;)
 923     {
 924       Py_DECREF (th_entry->thread_obj);
 925
 926       th_tmp = th_entry;
 927       th_entry = th_entry->next;
 928       xfree (th_tmp);
 929     }
 930
 931   inf_obj->nthreads = 0;
 932 }
 933
 934 /* Implementation of gdb.selected_inferior() -> gdb.Inferior.
 935    Returns the current inferior object.  */
 936
 937 PyObject *
 938 gdbpy_selected_inferior (PyObject *self, PyObject *args)
 939 {
 940   return (PyObject *) inferior_to_inferior_object (current_inferior ());
 941 }
 942
 943 int
 944 gdbpy_initialize_inferior (void)
 945 {
 946   if (PyType_Ready (&inferior_object_type) < 0)
 947     return -1;
 948
 949   if (gdb_pymodule_addobject (gdb_module, "Inferior",
 950                               (PyObject *) &inferior_object_type) < 0)
 951     return -1;
 952
 953   infpy_inf_data_key =
 954     register_inferior_data_with_cleanup (NULL, py_free_inferior);
 955
 956   gdb::observers::new_thread.attach (add_thread_object);
 957   gdb::observers::thread_exit.attach (delete_thread_object);
 958   gdb::observers::normal_stop.attach (python_on_normal_stop);
 959   gdb::observers::target_resumed.attach (python_on_resume);
 960   gdb::observers::inferior_call_pre.attach (python_on_inferior_call_pre);
 961   gdb::observers::inferior_call_post.attach (python_on_inferior_call_post);
 962   gdb::observers::memory_changed.attach (python_on_memory_change);
 963   gdb::observers::register_changed.attach (python_on_register_change);
 964   gdb::observers::inferior_exit.attach (python_inferior_exit);
 965   gdb::observers::new_objfile.attach (python_new_objfile);
 966   gdb::observers::inferior_added.attach (python_new_inferior);
 967   gdb::observers::inferior_removed.attach (python_inferior_deleted);
 968
 969   membuf_object_type.tp_new = PyType_GenericNew;
 970   if (PyType_Ready (&membuf_object_type) < 0)
 971     return -1;
 972
 973   return gdb_pymodule_addobject (gdb_module, "Membuf", (PyObject *)
 974                                  &membuf_object_type);
 975 }
 976
 977 static gdb_PyGetSetDef inferior_object_getset[] =
 978 {
 979   { "num", infpy_get_num, NULL, "ID of inferior, as assigned by GDB.", NULL },
 980   { "pid", infpy_get_pid, NULL, "PID of inferior, as assigned by the OS.",
 981     NULL },
 982   { "was_attached", infpy_get_was_attached, NULL,
 983     "True if the inferior was created using 'attach'.", NULL },
 984   { "progspace", infpy_get_progspace, NULL, "Program space of this inferior" },
 985   { NULL }
 986 };
 987
 988 static PyMethodDef inferior_object_methods[] =
 989 {
 990   { "is_valid", infpy_is_valid, METH_NOARGS,
 991     "is_valid () -> Boolean.\n\
 992 Return true if this inferior is valid, false if not." },
 993   { "threads", infpy_threads, METH_NOARGS,
 994     "Return all the threads of this inferior." },
 995   { "read_memory", (PyCFunction) infpy_read_memory,
 996     METH_VARARGS | METH_KEYWORDS,
 997     "read_memory (address, length) -> buffer\n\
 998 Return a buffer object for reading from the inferior's memory." },
 999   { "write_memory", (PyCFunction) infpy_write_memory,
1000     METH_VARARGS | METH_KEYWORDS,
1001     "write_memory (address, buffer [, length])\n\
1002 Write the given buffer object to the inferior's memory." },
1003   { "search_memory", (PyCFunction) infpy_search_memory,
1004     METH_VARARGS | METH_KEYWORDS,
1005     "search_memory (address, length, pattern) -> long\n\
1006 Return a long with the address of a match, or None." },
1007   { "thread_from_thread_handle", (PyCFunction) infpy_thread_from_thread_handle,
1008     METH_VARARGS | METH_KEYWORDS,
1009     "thread_from_thread_handle (handle) -> gdb.InferiorThread.\n\
1010 Return thread object corresponding to thread handle." },
1011   { NULL }
1012 };
1013
1014 PyTypeObject inferior_object_type =
1015 {
1016   PyVarObject_HEAD_INIT (NULL, 0)
1017   "gdb.Inferior",                 /* tp_name */
1018   sizeof (inferior_object),       /* tp_basicsize */
1019   0,                              /* tp_itemsize */
1020   infpy_dealloc,                  /* tp_dealloc */
1021   0,                              /* tp_print */
1022   0,                              /* tp_getattr */
1023   0,                              /* tp_setattr */
1024   0,                              /* tp_compare */
1025   infpy_repr,                     /* tp_repr */
1026   0,                              /* tp_as_number */
1027   0,                              /* tp_as_sequence */
1028   0,                              /* tp_as_mapping */
1029   0,                              /* tp_hash  */
1030   0,                              /* tp_call */
1031   0,                              /* tp_str */
1032   0,                              /* tp_getattro */
1033   0,                              /* tp_setattro */
1034   0,                              /* tp_as_buffer */
1035   Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_ITER,  /* tp_flags */
1036   "GDB inferior object",          /* tp_doc */
1037   0,                              /* tp_traverse */
1038   0,                              /* tp_clear */
1039   0,                              /* tp_richcompare */
1040   0,                              /* tp_weaklistoffset */
1041   0,                              /* tp_iter */
1042   0,                              /* tp_iternext */
1043   inferior_object_methods,        /* tp_methods */
1044   0,                              /* tp_members */
1045   inferior_object_getset,         /* tp_getset */
1046   0,                              /* tp_base */
1047   0,                              /* tp_dict */
1048   0,                              /* tp_descr_get */
1049   0,                              /* tp_descr_set */
1050   0,                              /* tp_dictoffset */
1051   0,                              /* tp_init */
1052   0                               /* tp_alloc */
1053 };
1054
1055 #ifdef IS_PY3K
1056
1057 static PyBufferProcs buffer_procs =
1058 {
1059   get_buffer
1060 };
1061
1062 #else
1063
1064 /* Python doesn't provide a decent way to get compatibility here.  */
1065 #if HAVE_LIBPYTHON2_4
1066 #define CHARBUFFERPROC_NAME getcharbufferproc
1067 #else
1068 #define CHARBUFFERPROC_NAME charbufferproc
1069 #endif
1070
1071 static PyBufferProcs buffer_procs = {
1072   get_read_buffer,
1073   get_write_buffer,
1074   get_seg_count,
1075   /* The cast here works around a difference between Python 2.4 and
1076      Python 2.5.  */
1077   (CHARBUFFERPROC_NAME) get_char_buffer
1078 };
1079 #endif  /* IS_PY3K */
1080
1081 PyTypeObject membuf_object_type = {
1082   PyVarObject_HEAD_INIT (NULL, 0)
1083   "gdb.Membuf",                   /*tp_name*/
1084   sizeof (membuf_object),         /*tp_basicsize*/
1085   0,                              /*tp_itemsize*/
1086   mbpy_dealloc,                   /*tp_dealloc*/
1087   0,                              /*tp_print*/
1088   0,                              /*tp_getattr*/
1089   0,                              /*tp_setattr*/
1090   0,                              /*tp_compare*/
1091   0,                              /*tp_repr*/
1092   0,                              /*tp_as_number*/
1093   0,                              /*tp_as_sequence*/
1094   0,                              /*tp_as_mapping*/
1095   0,                              /*tp_hash */
1096   0,                              /*tp_call*/
1097   mbpy_str,                       /*tp_str*/
1098   0,                              /*tp_getattro*/
1099   0,                              /*tp_setattro*/
1100   &buffer_procs,                  /*tp_as_buffer*/
1101   Py_TPFLAGS_DEFAULT,             /*tp_flags*/
1102   "GDB memory buffer object",     /*tp_doc*/
1103   0,                              /* tp_traverse */
1104   0,                              /* tp_clear */
1105   0,                              /* tp_richcompare */
1106   0,                              /* tp_weaklistoffset */
1107   0,                              /* tp_iter */
1108   0,                              /* tp_iternext */
1109   0,                              /* tp_methods */
1110   0,                              /* tp_members */
1111   0,                              /* tp_getset */
1112   0,                              /* tp_base */
1113   0,                              /* tp_dict */
1114   0,                              /* tp_descr_get */
1115   0,                              /* tp_descr_set */
1116   0,                              /* tp_dictoffset */
1117   0,                              /* tp_init */
1118   0,                              /* tp_alloc */
1119 };