1 /* Support for debug methods in Python.
3 Copyright (C) 2013-2017 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21 #include "arch-utils.h"
22 #include "extension-priv.h"
28 #include "python-internal.h"
31 static const char enabled_field_name
[] = "enabled";
32 static const char match_method_name
[] = "match";
33 static const char get_arg_types_method_name
[] = "get_arg_types";
34 static const char get_result_type_method_name
[] = "get_result_type";
35 static const char matchers_attr_str
[] = "xmethods";
37 static PyObject
*py_match_method_name
= NULL
;
38 static PyObject
*py_get_arg_types_method_name
= NULL
;
40 struct gdbpy_worker_data
46 static struct xmethod_worker
*new_python_xmethod_worker (PyObject
*item
,
47 PyObject
*py_obj_type
);
49 /* Implementation of free_xmethod_worker_data for Python. */
52 gdbpy_free_xmethod_worker_data (const struct extension_language_defn
*extlang
,
55 struct gdbpy_worker_data
*worker_data
= (struct gdbpy_worker_data
*) data
;
57 gdb_assert (worker_data
->worker
!= NULL
&& worker_data
->this_type
!= NULL
);
59 /* We don't do much here, but we still need the GIL. */
60 gdbpy_enter
enter_py (get_current_arch (), current_language
);
62 Py_DECREF (worker_data
->worker
);
63 Py_DECREF (worker_data
->this_type
);
67 /* Implementation of clone_xmethod_worker_data for Python. */
70 gdbpy_clone_xmethod_worker_data (const struct extension_language_defn
*extlang
,
73 struct gdbpy_worker_data
*worker_data
74 = (struct gdbpy_worker_data
*) data
, *new_data
;
76 gdb_assert (worker_data
->worker
!= NULL
&& worker_data
->this_type
!= NULL
);
78 /* We don't do much here, but we still need the GIL. */
79 gdbpy_enter
enter_py (get_current_arch (), current_language
);
81 new_data
= XCNEW (struct gdbpy_worker_data
);
82 new_data
->worker
= worker_data
->worker
;
83 new_data
->this_type
= worker_data
->this_type
;
84 Py_INCREF (new_data
->worker
);
85 Py_INCREF (new_data
->this_type
);
90 /* Invoke the "match" method of the MATCHER and return a new reference
91 to the result. Returns NULL on error. */
94 invoke_match_method (PyObject
*matcher
, PyObject
*py_obj_type
,
95 const char *xmethod_name
)
99 gdbpy_ref
enabled_field (PyObject_GetAttrString (matcher
,
100 enabled_field_name
));
101 if (enabled_field
== NULL
)
104 enabled
= PyObject_IsTrue (enabled_field
.get ());
109 /* Return 'None' if the matcher is not enabled. */
113 gdbpy_ref
match_method (PyObject_GetAttrString (matcher
, match_method_name
));
114 if (match_method
== NULL
)
117 gdbpy_ref
py_xmethod_name (PyString_FromString (xmethod_name
));
118 if (py_xmethod_name
== NULL
)
121 return PyObject_CallMethodObjArgs (matcher
, py_match_method_name
,
122 py_obj_type
, py_xmethod_name
.get (),
126 /* Implementation of get_matching_xmethod_workers for Python. */
129 gdbpy_get_matching_xmethod_workers
130 (const struct extension_language_defn
*extlang
,
131 struct type
*obj_type
, const char *method_name
,
132 xmethod_worker_vec
**dm_vec
)
134 struct objfile
*objfile
;
135 VEC (xmethod_worker_ptr
) *worker_vec
= NULL
;
136 PyObject
*py_progspace
;
138 gdb_assert (obj_type
!= NULL
&& method_name
!= NULL
);
140 gdbpy_enter
enter_py (get_current_arch (), current_language
);
142 gdbpy_ref
py_type (type_to_type_object (obj_type
));
145 gdbpy_print_stack ();
146 return EXT_LANG_RC_ERROR
;
149 /* Create an empty list of debug methods. */
150 gdbpy_ref
py_xmethod_matcher_list (PyList_New (0));
151 if (py_xmethod_matcher_list
== NULL
)
153 gdbpy_print_stack ();
154 return EXT_LANG_RC_ERROR
;
157 /* Gather debug method matchers registered with the object files.
158 This could be done differently by iterating over each objfile's matcher
159 list individually, but there's no data yet to show it's needed. */
160 ALL_OBJFILES (objfile
)
162 PyObject
*py_objfile
= objfile_to_objfile_object (objfile
);
164 if (py_objfile
== NULL
)
166 gdbpy_print_stack ();
167 return EXT_LANG_RC_ERROR
;
170 gdbpy_ref
objfile_matchers (objfpy_get_xmethods (py_objfile
, NULL
));
171 gdbpy_ref
temp (PySequence_Concat (py_xmethod_matcher_list
.get (),
172 objfile_matchers
.get ()));
175 gdbpy_print_stack ();
176 return EXT_LANG_RC_ERROR
;
179 py_xmethod_matcher_list
= std::move (temp
);
182 /* Gather debug methods matchers registered with the current program
184 py_progspace
= pspace_to_pspace_object (current_program_space
);
185 if (py_progspace
!= NULL
)
187 gdbpy_ref
pspace_matchers (pspy_get_xmethods (py_progspace
, NULL
));
189 gdbpy_ref
temp (PySequence_Concat (py_xmethod_matcher_list
.get (),
190 pspace_matchers
.get ()));
193 gdbpy_print_stack ();
194 return EXT_LANG_RC_ERROR
;
197 py_xmethod_matcher_list
= std::move (temp
);
201 gdbpy_print_stack ();
202 return EXT_LANG_RC_ERROR
;
205 /* Gather debug method matchers registered globally. */
206 if (gdb_python_module
!= NULL
207 && PyObject_HasAttrString (gdb_python_module
, matchers_attr_str
))
209 gdbpy_ref
gdb_matchers (PyObject_GetAttrString (gdb_python_module
,
211 if (gdb_matchers
!= NULL
)
213 gdbpy_ref
temp (PySequence_Concat (py_xmethod_matcher_list
.get (),
214 gdb_matchers
.get ()));
217 gdbpy_print_stack ();
218 return EXT_LANG_RC_ERROR
;
221 py_xmethod_matcher_list
= std::move (temp
);
225 gdbpy_print_stack ();
226 return EXT_LANG_RC_ERROR
;
230 gdbpy_ref
list_iter (PyObject_GetIter (py_xmethod_matcher_list
.get ()));
231 if (list_iter
== NULL
)
233 gdbpy_print_stack ();
234 return EXT_LANG_RC_ERROR
;
238 gdbpy_ref
matcher (PyIter_Next (list_iter
.get ()));
241 if (PyErr_Occurred ())
243 gdbpy_print_stack ();
244 return EXT_LANG_RC_ERROR
;
249 gdbpy_ref
match_result (invoke_match_method (matcher
.get (),
253 if (match_result
== NULL
)
255 gdbpy_print_stack ();
256 return EXT_LANG_RC_ERROR
;
258 if (match_result
== Py_None
)
259 ; /* This means there was no match. */
260 else if (PySequence_Check (match_result
.get ()))
262 gdbpy_ref
iter (PyObject_GetIter (match_result
.get ()));
266 gdbpy_print_stack ();
267 return EXT_LANG_RC_ERROR
;
271 struct xmethod_worker
*worker
;
273 gdbpy_ref
py_worker (PyIter_Next (iter
.get ()));
274 if (py_worker
== NULL
)
276 if (PyErr_Occurred ())
278 gdbpy_print_stack ();
279 return EXT_LANG_RC_ERROR
;
284 worker
= new_python_xmethod_worker (py_worker
.get (),
286 VEC_safe_push (xmethod_worker_ptr
, worker_vec
, worker
);
291 struct xmethod_worker
*worker
;
293 worker
= new_python_xmethod_worker (match_result
.get (),
295 VEC_safe_push (xmethod_worker_ptr
, worker_vec
, worker
);
299 *dm_vec
= worker_vec
;
301 return EXT_LANG_RC_OK
;
304 /* Implementation of get_xmethod_arg_types for Python. */
307 gdbpy_get_xmethod_arg_types (const struct extension_language_defn
*extlang
,
308 struct xmethod_worker
*worker
,
309 int *nargs
, struct type
***arg_types
)
311 /* The gdbpy_enter object needs to be placed first, so that it's the last to
313 gdbpy_enter
enter_py (get_current_arch (), current_language
);
314 struct gdbpy_worker_data
*worker_data
315 = (struct gdbpy_worker_data
*) worker
->data
;
316 PyObject
*py_worker
= worker_data
->worker
;
317 struct type
*obj_type
;
318 int i
= 1, arg_count
;
321 /* Set nargs to -1 so that any premature return from this function returns
322 an invalid/unusable number of arg types. */
325 gdbpy_ref get_arg_types_method
326 (PyObject_GetAttrString (py_worker
, get_arg_types_method_name
));
327 if (get_arg_types_method
== NULL
)
329 gdbpy_print_stack ();
330 return EXT_LANG_RC_ERROR
;
333 gdbpy_ref py_argtype_list
334 (PyObject_CallMethodObjArgs (py_worker
, py_get_arg_types_method_name
,
336 if (py_argtype_list
== NULL
)
338 gdbpy_print_stack ();
339 return EXT_LANG_RC_ERROR
;
342 if (py_argtype_list
== Py_None
)
344 else if (PySequence_Check (py_argtype_list
.get ()))
346 arg_count
= PySequence_Size (py_argtype_list
.get ());
349 gdbpy_print_stack ();
350 return EXT_LANG_RC_ERROR
;
353 list_iter
.reset (PyObject_GetIter (py_argtype_list
.get ()));
354 if (list_iter
== NULL
)
356 gdbpy_print_stack ();
357 return EXT_LANG_RC_ERROR
;
363 /* Include the 'this' argument in the size. */
364 gdb::unique_xmalloc_ptr
<struct type
*> type_array
365 (XCNEWVEC (struct type
*, arg_count
+ 1));
367 if (list_iter
!= NULL
)
371 gdbpy_ref
item (PyIter_Next (list_iter
.get ()));
374 if (PyErr_Occurred ())
376 gdbpy_print_stack ();
377 return EXT_LANG_RC_ERROR
;
382 struct type
*arg_type
= type_object_to_type (item
.get ());
383 if (arg_type
== NULL
)
385 PyErr_SetString (PyExc_TypeError
,
386 _("Arg type returned by the get_arg_types "
387 "method of a debug method worker object is "
388 "not a gdb.Type object."));
389 return EXT_LANG_RC_ERROR
;
392 (type_array
.get ())[i
] = arg_type
;
396 else if (arg_count
== 1)
398 /* py_argtype_list is not actually a list but a single gdb.Type
400 struct type
*arg_type
= type_object_to_type (py_argtype_list
.get ());
402 if (arg_type
== NULL
)
404 PyErr_SetString (PyExc_TypeError
,
405 _("Arg type returned by the get_arg_types method "
406 "of an xmethod worker object is not a gdb.Type "
408 return EXT_LANG_RC_ERROR
;
412 (type_array
.get ())[i
] = arg_type
;
417 /* Add the type of 'this' as the first argument. The 'this' pointer should
418 be a 'const' value. Hence, create a 'const' variant of the 'this' pointer
420 obj_type
= type_object_to_type (worker_data
->this_type
);
421 (type_array
.get ())[0] = make_cv_type (1, 0, lookup_pointer_type (obj_type
),
424 *arg_types
= type_array
.release ();
426 return EXT_LANG_RC_OK
;
429 /* Implementation of get_xmethod_result_type for Python. */
432 gdbpy_get_xmethod_result_type (const struct extension_language_defn
*extlang
,
433 struct xmethod_worker
*worker
,
435 struct value
**args
, int nargs
,
436 struct type
**result_type_ptr
)
438 struct gdbpy_worker_data
*worker_data
439 = (struct gdbpy_worker_data
*) worker
->data
;
440 PyObject
*py_worker
= worker_data
->worker
;
441 struct type
*obj_type
, *this_type
;
444 gdbpy_enter
enter_py (get_current_arch (), current_language
);
446 /* First see if there is a get_result_type method.
447 If not this could be an old xmethod (pre 7.9.1). */
448 gdbpy_ref get_result_type_method
449 (PyObject_GetAttrString (py_worker
, get_result_type_method_name
));
450 if (get_result_type_method
== NULL
)
453 *result_type_ptr
= NULL
;
454 return EXT_LANG_RC_OK
;
457 obj_type
= check_typedef (value_type (obj
));
458 this_type
= check_typedef (type_object_to_type (worker_data
->this_type
));
459 if (TYPE_CODE (obj_type
) == TYPE_CODE_PTR
)
461 struct type
*this_ptr
= lookup_pointer_type (this_type
);
463 if (!types_equal (obj_type
, this_ptr
))
464 obj
= value_cast (this_ptr
, obj
);
466 else if (TYPE_CODE (obj_type
) == TYPE_CODE_REF
)
468 struct type
*this_ref
= lookup_reference_type (this_type
);
470 if (!types_equal (obj_type
, this_ref
))
471 obj
= value_cast (this_ref
, obj
);
475 if (!types_equal (obj_type
, this_type
))
476 obj
= value_cast (this_type
, obj
);
478 gdbpy_ref
py_value_obj (value_to_value_object (obj
));
479 if (py_value_obj
== NULL
)
481 gdbpy_print_stack ();
482 return EXT_LANG_RC_ERROR
;
485 gdbpy_ref
py_arg_tuple (PyTuple_New (nargs
+ 1));
486 if (py_arg_tuple
== NULL
)
488 gdbpy_print_stack ();
489 return EXT_LANG_RC_ERROR
;
492 /* PyTuple_SET_ITEM steals the reference of the element, hence the
494 PyTuple_SET_ITEM (py_arg_tuple
.get (), 0, py_value_obj
.release ());
496 for (i
= 0; i
< nargs
; i
++)
498 PyObject
*py_value_arg
= value_to_value_object (args
[i
]);
500 if (py_value_arg
== NULL
)
502 gdbpy_print_stack ();
503 return EXT_LANG_RC_ERROR
;
505 PyTuple_SET_ITEM (py_arg_tuple
.get (), i
+ 1, py_value_arg
);
508 gdbpy_ref py_result_type
509 (PyObject_CallObject (get_result_type_method
.get (), py_arg_tuple
.get ()));
510 if (py_result_type
== NULL
)
512 gdbpy_print_stack ();
513 return EXT_LANG_RC_ERROR
;
516 *result_type_ptr
= type_object_to_type (py_result_type
.get ());
517 if (*result_type_ptr
== NULL
)
519 PyErr_SetString (PyExc_TypeError
,
520 _("Type returned by the get_result_type method of an"
521 " xmethod worker object is not a gdb.Type object."));
522 gdbpy_print_stack ();
523 return EXT_LANG_RC_ERROR
;
526 return EXT_LANG_RC_OK
;
529 /* Implementation of invoke_xmethod for Python. */
532 gdbpy_invoke_xmethod (const struct extension_language_defn
*extlang
,
533 struct xmethod_worker
*worker
,
534 struct value
*obj
, struct value
**args
, int nargs
)
537 struct type
*obj_type
, *this_type
;
538 struct value
*res
= NULL
;
539 struct gdbpy_worker_data
*worker_data
540 = (struct gdbpy_worker_data
*) worker
->data
;
541 PyObject
*xmethod_worker
= worker_data
->worker
;
543 gdbpy_enter
enter_py (get_current_arch (), current_language
);
545 obj_type
= check_typedef (value_type (obj
));
546 this_type
= check_typedef (type_object_to_type (worker_data
->this_type
));
547 if (TYPE_CODE (obj_type
) == TYPE_CODE_PTR
)
549 struct type
*this_ptr
= lookup_pointer_type (this_type
);
551 if (!types_equal (obj_type
, this_ptr
))
552 obj
= value_cast (this_ptr
, obj
);
554 else if (TYPE_CODE (obj_type
) == TYPE_CODE_REF
)
556 struct type
*this_ref
= lookup_reference_type (this_type
);
558 if (!types_equal (obj_type
, this_ref
))
559 obj
= value_cast (this_ref
, obj
);
563 if (!types_equal (obj_type
, this_type
))
564 obj
= value_cast (this_type
, obj
);
566 gdbpy_ref
py_value_obj (value_to_value_object (obj
));
567 if (py_value_obj
== NULL
)
569 gdbpy_print_stack ();
570 error (_("Error while executing Python code."));
573 gdbpy_ref
py_arg_tuple (PyTuple_New (nargs
+ 1));
574 if (py_arg_tuple
== NULL
)
576 gdbpy_print_stack ();
577 error (_("Error while executing Python code."));
580 /* PyTuple_SET_ITEM steals the reference of the element, hence the
582 PyTuple_SET_ITEM (py_arg_tuple
.get (), 0, py_value_obj
.release ());
584 for (i
= 0; i
< nargs
; i
++)
586 PyObject
*py_value_arg
= value_to_value_object (args
[i
]);
588 if (py_value_arg
== NULL
)
590 gdbpy_print_stack ();
591 error (_("Error while executing Python code."));
594 PyTuple_SET_ITEM (py_arg_tuple
.get (), i
+ 1, py_value_arg
);
597 gdbpy_ref
py_result (PyObject_CallObject (xmethod_worker
,
598 py_arg_tuple
.get ()));
599 if (py_result
== NULL
)
601 gdbpy_print_stack ();
602 error (_("Error while executing Python code."));
605 if (py_result
!= Py_None
)
607 res
= convert_value_from_python (py_result
.get ());
610 gdbpy_print_stack ();
611 error (_("Error while executing Python code."));
616 res
= allocate_value (lookup_typename (python_language
, python_gdbarch
,
623 /* Creates a new Python xmethod_worker object.
624 The new object has data of type 'struct gdbpy_worker_data' composed
625 with the components PY_WORKER and THIS_TYPE. */
627 static struct xmethod_worker
*
628 new_python_xmethod_worker (PyObject
*py_worker
, PyObject
*this_type
)
630 struct gdbpy_worker_data
*data
;
632 gdb_assert (py_worker
!= NULL
&& this_type
!= NULL
);
634 data
= XCNEW (struct gdbpy_worker_data
);
635 data
->worker
= py_worker
;
636 data
->this_type
= this_type
;
637 Py_INCREF (py_worker
);
638 Py_INCREF (this_type
);
640 return new_xmethod_worker (&extension_language_python
, data
);
644 gdbpy_initialize_xmethods (void)
646 py_match_method_name
= PyString_FromString (match_method_name
);
647 if (py_match_method_name
== NULL
)
650 py_get_arg_types_method_name
651 = PyString_FromString (get_arg_types_method_name
);
652 if (py_get_arg_types_method_name
== NULL
)