gdb/python/py-objfile.c

   1 /* Python interface to objfiles.
   2
   3    Copyright (C) 2008-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 "python-internal.h"
  22 #include "charset.h"
  23 #include "objfiles.h"
  24 #include "language.h"
  25 #include "build-id.h"
  26 #include "symtab.h"
  27
  28 typedef struct
  29 {
  30   PyObject_HEAD
  31
  32   /* The corresponding objfile.  */
  33   struct objfile *objfile;
  34
  35   /* Dictionary holding user-added attributes.
  36      This is the __dict__ attribute of the object.  */
  37   PyObject *dict;
  38
  39   /* The pretty-printer list of functions.  */
  40   PyObject *printers;
  41
  42   /* The frame filter list of functions.  */
  43   PyObject *frame_filters;
  44
  45   /* The list of frame unwinders.  */
  46   PyObject *frame_unwinders;
  47
  48   /* The type-printer list.  */
  49   PyObject *type_printers;
  50
  51   /* The debug method matcher list.  */
  52   PyObject *xmethods;
  53 } objfile_object;
  54
  55 extern PyTypeObject objfile_object_type
  56     CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("objfile_object");
  57
  58 static const struct objfile_data *objfpy_objfile_data_key;
  59
  60 /* Require that OBJF be a valid objfile.  */
  61 #define OBJFPY_REQUIRE_VALID(obj)                               \
  62   do {                                                          \
  63     if (!(obj)->objfile)                                        \
  64       {                                                         \
  65         PyErr_SetString (PyExc_RuntimeError,                    \
  66                          _("Objfile no longer exists."));       \
  67         return NULL;                                            \
  68       }                                                         \
  69   } while (0)
  70
  71 \f
  72
  73 /* An Objfile method which returns the objfile's file name, or None.  */
  74
  75 static PyObject *
  76 objfpy_get_filename (PyObject *self, void *closure)
  77 {
  78   objfile_object *obj = (objfile_object *) self;
  79
  80   if (obj->objfile)
  81     return (host_string_to_python_string (objfile_name (obj->objfile))
  82             .release ());
  83   Py_RETURN_NONE;
  84 }
  85
  86 /* An Objfile method which returns the objfile's file name, as specified
  87    by the user, or None.  */
  88
  89 static PyObject *
  90 objfpy_get_username (PyObject *self, void *closure)
  91 {
  92   objfile_object *obj = (objfile_object *) self;
  93
  94   if (obj->objfile)
  95     {
  96       const char *username = obj->objfile->original_name;
  97
  98       return host_string_to_python_string (username).release ();
  99     }
 100
 101   Py_RETURN_NONE;
 102 }
 103
 104 /* If SELF is a separate debug-info file, return the "backlink" field.
 105    Otherwise return None.  */
 106
 107 static PyObject *
 108 objfpy_get_owner (PyObject *self, void *closure)
 109 {
 110   objfile_object *obj = (objfile_object *) self;
 111   struct objfile *objfile = obj->objfile;
 112   struct objfile *owner;
 113
 114   OBJFPY_REQUIRE_VALID (obj);
 115
 116   owner = objfile->separate_debug_objfile_backlink;
 117   if (owner != NULL)
 118     return objfile_to_objfile_object (owner).release ();
 119   Py_RETURN_NONE;
 120 }
 121
 122 /* An Objfile method which returns the objfile's build id, or None.  */
 123
 124 static PyObject *
 125 objfpy_get_build_id (PyObject *self, void *closure)
 126 {
 127   objfile_object *obj = (objfile_object *) self;
 128   struct objfile *objfile = obj->objfile;
 129   const struct bfd_build_id *build_id = NULL;
 130
 131   OBJFPY_REQUIRE_VALID (obj);
 132
 133   try
 134     {
 135       build_id = build_id_bfd_get (objfile->obfd);
 136     }
 137   catch (const gdb_exception &except)
 138     {
 139       GDB_PY_HANDLE_EXCEPTION (except);
 140     }
 141
 142   if (build_id != NULL)
 143     {
 144       gdb::unique_xmalloc_ptr<char> hex_form
 145         (make_hex_string (build_id->data, build_id->size));
 146
 147       return host_string_to_python_string (hex_form.get ()).release ();
 148     }
 149
 150   Py_RETURN_NONE;
 151 }
 152
 153 /* An Objfile method which returns the objfile's progspace, or None.  */
 154
 155 static PyObject *
 156 objfpy_get_progspace (PyObject *self, void *closure)
 157 {
 158   objfile_object *obj = (objfile_object *) self;
 159
 160   if (obj->objfile)
 161     return pspace_to_pspace_object (obj->objfile->pspace).release ();
 162
 163   Py_RETURN_NONE;
 164 }
 165
 166 static void
 167 objfpy_dealloc (PyObject *o)
 168 {
 169   objfile_object *self = (objfile_object *) o;
 170
 171   Py_XDECREF (self->dict);
 172   Py_XDECREF (self->printers);
 173   Py_XDECREF (self->frame_filters);
 174   Py_XDECREF (self->frame_unwinders);
 175   Py_XDECREF (self->type_printers);
 176   Py_XDECREF (self->xmethods);
 177   Py_TYPE (self)->tp_free (self);
 178 }
 179
 180 /* Initialize an objfile_object.
 181    The result is a boolean indicating success.  */
 182
 183 static int
 184 objfpy_initialize (objfile_object *self)
 185 {
 186   self->objfile = NULL;
 187
 188   self->dict = PyDict_New ();
 189   if (self->dict == NULL)
 190     return 0;
 191
 192   self->printers = PyList_New (0);
 193   if (self->printers == NULL)
 194     return 0;
 195
 196   self->frame_filters = PyDict_New ();
 197   if (self->frame_filters == NULL)
 198     return 0;
 199
 200   self->frame_unwinders = PyList_New (0);
 201   if (self->frame_unwinders == NULL)
 202     return 0;
 203
 204   self->type_printers = PyList_New (0);
 205   if (self->type_printers == NULL)
 206     return 0;
 207
 208   self->xmethods = PyList_New (0);
 209   if (self->xmethods == NULL)
 210     return 0;
 211
 212   return 1;
 213 }
 214
 215 static PyObject *
 216 objfpy_new (PyTypeObject *type, PyObject *args, PyObject *keywords)
 217 {
 218   gdbpy_ref<objfile_object> self ((objfile_object *) type->tp_alloc (type, 0));
 219
 220   if (self != NULL)
 221     {
 222       if (!objfpy_initialize (self.get ()))
 223         return NULL;
 224     }
 225
 226   return (PyObject *) self.release ();
 227 }
 228
 229 PyObject *
 230 objfpy_get_printers (PyObject *o, void *ignore)
 231 {
 232   objfile_object *self = (objfile_object *) o;
 233
 234   Py_INCREF (self->printers);
 235   return self->printers;
 236 }
 237
 238 static int
 239 objfpy_set_printers (PyObject *o, PyObject *value, void *ignore)
 240 {
 241   objfile_object *self = (objfile_object *) o;
 242
 243   if (! value)
 244     {
 245       PyErr_SetString (PyExc_TypeError,
 246                        _("Cannot delete the pretty_printers attribute."));
 247       return -1;
 248     }
 249
 250   if (! PyList_Check (value))
 251     {
 252       PyErr_SetString (PyExc_TypeError,
 253                        _("The pretty_printers attribute must be a list."));
 254       return -1;
 255     }
 256
 257   /* Take care in case the LHS and RHS are related somehow.  */
 258   gdbpy_ref<> tmp (self->printers);
 259   Py_INCREF (value);
 260   self->printers = value;
 261
 262   return 0;
 263 }
 264
 265 /* Return the Python dictionary attribute containing frame filters for
 266    this object file.  */
 267 PyObject *
 268 objfpy_get_frame_filters (PyObject *o, void *ignore)
 269 {
 270   objfile_object *self = (objfile_object *) o;
 271
 272   Py_INCREF (self->frame_filters);
 273   return self->frame_filters;
 274 }
 275
 276 /* Set this object file's frame filters dictionary to FILTERS.  */
 277 static int
 278 objfpy_set_frame_filters (PyObject *o, PyObject *filters, void *ignore)
 279 {
 280   objfile_object *self = (objfile_object *) o;
 281
 282   if (! filters)
 283     {
 284       PyErr_SetString (PyExc_TypeError,
 285                        _("Cannot delete the frame filters attribute."));
 286       return -1;
 287     }
 288
 289   if (! PyDict_Check (filters))
 290     {
 291       PyErr_SetString (PyExc_TypeError,
 292                        _("The frame_filters attribute must be a dictionary."));
 293       return -1;
 294     }
 295
 296   /* Take care in case the LHS and RHS are related somehow.  */
 297   gdbpy_ref<> tmp (self->frame_filters);
 298   Py_INCREF (filters);
 299   self->frame_filters = filters;
 300
 301   return 0;
 302 }
 303
 304 /* Return the frame unwinders attribute for this object file.  */
 305
 306 PyObject *
 307 objfpy_get_frame_unwinders (PyObject *o, void *ignore)
 308 {
 309   objfile_object *self = (objfile_object *) o;
 310
 311   Py_INCREF (self->frame_unwinders);
 312   return self->frame_unwinders;
 313 }
 314
 315 /* Set this object file's frame unwinders list to UNWINDERS.  */
 316
 317 static int
 318 objfpy_set_frame_unwinders (PyObject *o, PyObject *unwinders, void *ignore)
 319 {
 320   objfile_object *self = (objfile_object *) o;
 321
 322   if (!unwinders)
 323     {
 324       PyErr_SetString (PyExc_TypeError,
 325                        _("Cannot delete the frame unwinders attribute."));
 326       return -1;
 327     }
 328
 329   if (!PyList_Check (unwinders))
 330     {
 331       PyErr_SetString (PyExc_TypeError,
 332                        _("The frame_unwinders attribute must be a list."));
 333       return -1;
 334     }
 335
 336   /* Take care in case the LHS and RHS are related somehow.  */
 337   gdbpy_ref<> tmp (self->frame_unwinders);
 338   Py_INCREF (unwinders);
 339   self->frame_unwinders = unwinders;
 340
 341   return 0;
 342 }
 343
 344 /* Get the 'type_printers' attribute.  */
 345
 346 static PyObject *
 347 objfpy_get_type_printers (PyObject *o, void *ignore)
 348 {
 349   objfile_object *self = (objfile_object *) o;
 350
 351   Py_INCREF (self->type_printers);
 352   return self->type_printers;
 353 }
 354
 355 /* Get the 'xmethods' attribute.  */
 356
 357 PyObject *
 358 objfpy_get_xmethods (PyObject *o, void *ignore)
 359 {
 360   objfile_object *self = (objfile_object *) o;
 361
 362   Py_INCREF (self->xmethods);
 363   return self->xmethods;
 364 }
 365
 366 /* Set the 'type_printers' attribute.  */
 367
 368 static int
 369 objfpy_set_type_printers (PyObject *o, PyObject *value, void *ignore)
 370 {
 371   objfile_object *self = (objfile_object *) o;
 372
 373   if (! value)
 374     {
 375       PyErr_SetString (PyExc_TypeError,
 376                        _("Cannot delete the type_printers attribute."));
 377       return -1;
 378     }
 379
 380   if (! PyList_Check (value))
 381     {
 382       PyErr_SetString (PyExc_TypeError,
 383                        _("The type_printers attribute must be a list."));
 384       return -1;
 385     }
 386
 387   /* Take care in case the LHS and RHS are related somehow.  */
 388   gdbpy_ref<> tmp (self->type_printers);
 389   Py_INCREF (value);
 390   self->type_printers = value;
 391
 392   return 0;
 393 }
 394
 395 /* Implementation of gdb.Objfile.is_valid (self) -> Boolean.
 396    Returns True if this object file still exists in GDB.  */
 397
 398 static PyObject *
 399 objfpy_is_valid (PyObject *self, PyObject *args)
 400 {
 401   objfile_object *obj = (objfile_object *) self;
 402
 403   if (! obj->objfile)
 404     Py_RETURN_FALSE;
 405
 406   Py_RETURN_TRUE;
 407 }
 408
 409 /* Implementation of gdb.Objfile.add_separate_debug_file (self) -> Boolean.  */
 410
 411 static PyObject *
 412 objfpy_add_separate_debug_file (PyObject *self, PyObject *args, PyObject *kw)
 413 {
 414   static const char *keywords[] = { "file_name", NULL };
 415   objfile_object *obj = (objfile_object *) self;
 416   const char *file_name;
 417
 418   OBJFPY_REQUIRE_VALID (obj);
 419
 420   if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "s", keywords, &file_name))
 421     return NULL;
 422
 423   try
 424     {
 425       gdb_bfd_ref_ptr abfd (symfile_bfd_open (file_name));
 426
 427       symbol_file_add_separate (abfd.get (), file_name, 0, obj->objfile);
 428     }
 429   catch (const gdb_exception &except)
 430     {
 431       GDB_PY_HANDLE_EXCEPTION (except);
 432     }
 433
 434   Py_RETURN_NONE;
 435 }
 436
 437 /* Implement repr() for gdb.Objfile.  */
 438
 439 static PyObject *
 440 objfpy_repr (PyObject *self_)
 441 {
 442   objfile_object *self = (objfile_object *) self_;
 443   objfile *obj = self->objfile;
 444
 445   if (obj == nullptr)
 446     return PyString_FromString ("<gdb.Objfile (invalid)>");
 447
 448   return PyString_FromFormat ("<gdb.Objfile filename=%s>",
 449                               objfile_filename (obj));
 450 }
 451
 452 /* Subroutine of gdbpy_lookup_objfile_by_build_id to simplify it.
 453    Return non-zero if STRING is a potentially valid build id.  */
 454
 455 static int
 456 objfpy_build_id_ok (const char *string)
 457 {
 458   size_t i, n = strlen (string);
 459
 460   if (n % 2 != 0)
 461     return 0;
 462   for (i = 0; i < n; ++i)
 463     {
 464       if (!isxdigit (string[i]))
 465         return 0;
 466     }
 467   return 1;
 468 }
 469
 470 /* Subroutine of gdbpy_lookup_objfile_by_build_id to simplify it.
 471    Returns non-zero if BUILD_ID matches STRING.
 472    It is assumed that objfpy_build_id_ok (string) returns TRUE.  */
 473
 474 static int
 475 objfpy_build_id_matches (const struct bfd_build_id *build_id,
 476                          const char *string)
 477 {
 478   size_t i;
 479
 480   if (strlen (string) != 2 * build_id->size)
 481     return 0;
 482
 483   for (i = 0; i < build_id->size; ++i)
 484     {
 485       char c1 = string[i * 2], c2 = string[i * 2 + 1];
 486       int byte = (host_hex_value (c1) << 4) | host_hex_value (c2);
 487
 488       if (byte != build_id->data[i])
 489         return 0;
 490     }
 491
 492   return 1;
 493 }
 494
 495 /* Subroutine of gdbpy_lookup_objfile to simplify it.
 496    Look up an objfile by its file name.  */
 497
 498 static struct objfile *
 499 objfpy_lookup_objfile_by_name (const char *name)
 500 {
 501   for (objfile *objfile : current_program_space->objfiles ())
 502     {
 503       const char *filename;
 504
 505       if ((objfile->flags & OBJF_NOT_FILENAME) != 0)
 506         continue;
 507       /* Don't return separate debug files.  */
 508       if (objfile->separate_debug_objfile_backlink != NULL)
 509         continue;
 510
 511       filename = objfile_filename (objfile);
 512       if (filename != NULL && compare_filenames_for_search (filename, name))
 513         return objfile;
 514       if (compare_filenames_for_search (objfile->original_name, name))
 515         return objfile;
 516     }
 517
 518   return NULL;
 519 }
 520
 521 /* Subroutine of gdbpy_lookup_objfile to simplify it.
 522    Look up an objfile by its build id.  */
 523
 524 static struct objfile *
 525 objfpy_lookup_objfile_by_build_id (const char *build_id)
 526 {
 527   for (objfile *objfile : current_program_space->objfiles ())
 528     {
 529       const struct bfd_build_id *obfd_build_id;
 530
 531       if (objfile->obfd == NULL)
 532         continue;
 533       /* Don't return separate debug files.  */
 534       if (objfile->separate_debug_objfile_backlink != NULL)
 535         continue;
 536       obfd_build_id = build_id_bfd_get (objfile->obfd);
 537       if (obfd_build_id == NULL)
 538         continue;
 539       if (objfpy_build_id_matches (obfd_build_id, build_id))
 540         return objfile;
 541     }
 542
 543   return NULL;
 544 }
 545
 546 /* Implementation of gdb.lookup_objfile.  */
 547
 548 PyObject *
 549 gdbpy_lookup_objfile (PyObject *self, PyObject *args, PyObject *kw)
 550 {
 551   static const char *keywords[] = { "name", "by_build_id", NULL };
 552   const char *name;
 553   PyObject *by_build_id_obj = NULL;
 554   int by_build_id;
 555   struct objfile *objfile;
 556
 557   if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "s|O!", keywords,
 558                                         &name, &PyBool_Type, &by_build_id_obj))
 559     return NULL;
 560
 561   by_build_id = 0;
 562   if (by_build_id_obj != NULL)
 563     {
 564       int cmp = PyObject_IsTrue (by_build_id_obj);
 565
 566       if (cmp < 0)
 567         return NULL;
 568       by_build_id = cmp;
 569     }
 570
 571   if (by_build_id)
 572     {
 573       if (!objfpy_build_id_ok (name))
 574         {
 575           PyErr_SetString (PyExc_TypeError, _("Not a valid build id."));
 576           return NULL;
 577         }
 578       objfile = objfpy_lookup_objfile_by_build_id (name);
 579     }
 580   else
 581     objfile = objfpy_lookup_objfile_by_name (name);
 582
 583   if (objfile != NULL)
 584     return objfile_to_objfile_object (objfile).release ();
 585
 586   PyErr_SetString (PyExc_ValueError, _("Objfile not found."));
 587   return NULL;
 588 }
 589
 590 \f
 591
 592 /* Clear the OBJFILE pointer in an Objfile object and remove the
 593    reference.  */
 594 static void
 595 py_free_objfile (struct objfile *objfile, void *datum)
 596 {
 597   gdbpy_enter enter_py (get_objfile_arch (objfile), current_language);
 598   gdbpy_ref<objfile_object> object ((objfile_object *) datum);
 599   object->objfile = NULL;
 600 }
 601
 602 /* Return a new reference to the Python object of type Objfile
 603    representing OBJFILE.  If the object has already been created,
 604    return it.  Otherwise, create it.  Return NULL and set the Python
 605    error on failure.  */
 606
 607 gdbpy_ref<>
 608 objfile_to_objfile_object (struct objfile *objfile)
 609 {
 610   PyObject *result
 611     = ((PyObject *) objfile_data (objfile, objfpy_objfile_data_key));
 612   if (result == NULL)
 613     {
 614       gdbpy_ref<objfile_object> object
 615         ((objfile_object *) PyObject_New (objfile_object, &objfile_object_type));
 616       if (object == NULL)
 617         return NULL;
 618       if (!objfpy_initialize (object.get ()))
 619         return NULL;
 620
 621       object->objfile = objfile;
 622       set_objfile_data (objfile, objfpy_objfile_data_key, object.get ());
 623       result = (PyObject *) object.release ();
 624     }
 625
 626   return gdbpy_ref<>::new_reference (result);
 627 }
 628
 629 int
 630 gdbpy_initialize_objfile (void)
 631 {
 632   objfpy_objfile_data_key
 633     = register_objfile_data_with_cleanup (NULL, py_free_objfile);
 634
 635   if (PyType_Ready (&objfile_object_type) < 0)
 636     return -1;
 637
 638   return gdb_pymodule_addobject (gdb_module, "Objfile",
 639                                  (PyObject *) &objfile_object_type);
 640 }
 641
 642 \f
 643
 644 static PyMethodDef objfile_object_methods[] =
 645 {
 646   { "is_valid", objfpy_is_valid, METH_NOARGS,
 647     "is_valid () -> Boolean.\n\
 648 Return true if this object file is valid, false if not." },
 649
 650   { "add_separate_debug_file", (PyCFunction) objfpy_add_separate_debug_file,
 651     METH_VARARGS | METH_KEYWORDS,
 652     "add_separate_debug_file (file_name).\n\
 653 Add FILE_NAME to the list of files containing debug info for the objfile." },
 654
 655   { NULL }
 656 };
 657
 658 static gdb_PyGetSetDef objfile_getset[] =
 659 {
 660   { "__dict__", gdb_py_generic_dict, NULL,
 661     "The __dict__ for this objfile.", &objfile_object_type },
 662   { "filename", objfpy_get_filename, NULL,
 663     "The objfile's filename, or None.", NULL },
 664   { "username", objfpy_get_username, NULL,
 665     "The name of the objfile as provided by the user, or None.", NULL },
 666   { "owner", objfpy_get_owner, NULL,
 667     "The objfile owner of separate debug info objfiles, or None.",
 668     NULL },
 669   { "build_id", objfpy_get_build_id, NULL,
 670     "The objfile's build id, or None.", NULL },
 671   { "progspace", objfpy_get_progspace, NULL,
 672     "The objfile's progspace, or None.", NULL },
 673   { "pretty_printers", objfpy_get_printers, objfpy_set_printers,
 674     "Pretty printers.", NULL },
 675   { "frame_filters", objfpy_get_frame_filters,
 676     objfpy_set_frame_filters, "Frame Filters.", NULL },
 677   { "frame_unwinders", objfpy_get_frame_unwinders,
 678     objfpy_set_frame_unwinders, "Frame Unwinders", NULL },
 679   { "type_printers", objfpy_get_type_printers, objfpy_set_type_printers,
 680     "Type printers.", NULL },
 681   { "xmethods", objfpy_get_xmethods, NULL,
 682     "Debug methods.", NULL },
 683   { NULL }
 684 };
 685
 686 PyTypeObject objfile_object_type =
 687 {
 688   PyVarObject_HEAD_INIT (NULL, 0)
 689   "gdb.Objfile",                  /*tp_name*/
 690   sizeof (objfile_object),        /*tp_basicsize*/
 691   0,                              /*tp_itemsize*/
 692   objfpy_dealloc,                 /*tp_dealloc*/
 693   0,                              /*tp_print*/
 694   0,                              /*tp_getattr*/
 695   0,                              /*tp_setattr*/
 696   0,                              /*tp_compare*/
 697   objfpy_repr,                    /*tp_repr*/
 698   0,                              /*tp_as_number*/
 699   0,                              /*tp_as_sequence*/
 700   0,                              /*tp_as_mapping*/
 701   0,                              /*tp_hash */
 702   0,                              /*tp_call*/
 703   0,                              /*tp_str*/
 704   0,                              /*tp_getattro*/
 705   0,                              /*tp_setattro*/
 706   0,                              /*tp_as_buffer*/
 707   Py_TPFLAGS_DEFAULT,             /*tp_flags*/
 708   "GDB objfile object",           /* tp_doc */
 709   0,                              /* tp_traverse */
 710   0,                              /* tp_clear */
 711   0,                              /* tp_richcompare */
 712   0,                              /* tp_weaklistoffset */
 713   0,                              /* tp_iter */
 714   0,                              /* tp_iternext */
 715   objfile_object_methods,         /* tp_methods */
 716   0,                              /* tp_members */
 717   objfile_getset,                 /* tp_getset */
 718   0,                              /* tp_base */
 719   0,                              /* tp_dict */
 720   0,                              /* tp_descr_get */
 721   0,                              /* tp_descr_set */
 722   offsetof (objfile_object, dict), /* tp_dictoffset */
 723   0,                              /* tp_init */
 724   0,                              /* tp_alloc */
 725   objfpy_new,                     /* tp_new */
 726 };