1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
|
/* Python interface to values.
Copyright (C) 2008 Free Software Foundation, Inc.
This file is part of GDB.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
#include "defs.h"
#include "charset.h"
#include "value.h"
#include "exceptions.h"
#include "language.h"
#include "dfp.h"
/* List of all values which are currently exposed to Python. It is
maintained so that when an objfile is discarded, preserve_values
can copy the values' types if needed. This is declared
unconditionally to reduce the number of uses of HAVE_PYTHON in the
generic code. */
struct value *values_in_python;
#ifdef HAVE_PYTHON
#include "python-internal.h"
/* Even though Python scalar types directly map to host types, we use
target types here to remain consistent with the the values system in
GDB (which uses target arithmetic). */
/* Python's integer type corresponds to C's long type. */
#define builtin_type_pyint builtin_type (current_gdbarch)->builtin_long
/* Python's float type corresponds to C's double type. */
#define builtin_type_pyfloat builtin_type (current_gdbarch)->builtin_double
/* Python's long type corresponds to C's long long type. */
#define builtin_type_pylong builtin_type (current_gdbarch)->builtin_long_long
#define builtin_type_pybool \
language_bool_type (current_language, current_gdbarch)
typedef struct {
PyObject_HEAD
struct value *value;
int owned_by_gdb;
} value_object;
static void valpy_dealloc (PyObject *obj);
static PyObject *valpy_new (PyTypeObject *subtype, PyObject *args,
PyObject *keywords);
static Py_ssize_t valpy_length (PyObject *self);
static PyObject *valpy_getitem (PyObject *self, PyObject *key);
static int valpy_setitem (PyObject *self, PyObject *key, PyObject *value);
static PyObject *valpy_str (PyObject *self);
static PyObject *valpy_add (PyObject *self, PyObject *other);
static PyObject *valpy_subtract (PyObject *self, PyObject *other);
static PyObject *valpy_multiply (PyObject *self, PyObject *other);
static PyObject *valpy_divide (PyObject *self, PyObject *other);
static PyObject *valpy_remainder (PyObject *self, PyObject *other);
static PyObject *valpy_power (PyObject *self, PyObject *other, PyObject *unused);
static PyObject *valpy_negative (PyObject *self);
static PyObject *valpy_positive (PyObject *self);
static PyObject *valpy_absolute (PyObject *self);
static int valpy_nonzero (PyObject *self);
static PyObject *valpy_richcompare (PyObject *self, PyObject *other, int op);
static PyObject *valpy_dereference (PyObject *self, PyObject *args);
static PyMethodDef value_object_methods[] = {
{ "dereference", valpy_dereference, METH_NOARGS, "Dereferences the value." },
{NULL} /* Sentinel */
};
static PyNumberMethods value_object_as_number = {
valpy_add,
valpy_subtract,
valpy_multiply,
valpy_divide,
valpy_remainder,
NULL, /* nb_divmod */
valpy_power, /* nb_power */
valpy_negative, /* nb_negative */
valpy_positive, /* nb_positive */
valpy_absolute, /* nb_absolute */
valpy_nonzero /* nb_nonzero */
};
static PyMappingMethods value_object_as_mapping = {
valpy_length,
valpy_getitem,
valpy_setitem
};
PyTypeObject value_object_type = {
PyObject_HEAD_INIT (NULL)
0, /*ob_size*/
"gdb.Value", /*tp_name*/
sizeof (value_object), /*tp_basicsize*/
0, /*tp_itemsize*/
valpy_dealloc, /*tp_dealloc*/
0, /*tp_print*/
0, /*tp_getattr*/
0, /*tp_setattr*/
0, /*tp_compare*/
0, /*tp_repr*/
&value_object_as_number, /*tp_as_number*/
0, /*tp_as_sequence*/
&value_object_as_mapping, /*tp_as_mapping*/
0, /*tp_hash */
0, /*tp_call*/
valpy_str, /*tp_str*/
0, /*tp_getattro*/
0, /*tp_setattro*/
0, /*tp_as_buffer*/
Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES, /*tp_flags*/
"GDB value object", /* tp_doc */
0, /* tp_traverse */
0, /* tp_clear */
valpy_richcompare, /* tp_richcompare */
0, /* tp_weaklistoffset */
0, /* tp_iter */
0, /* tp_iternext */
value_object_methods /* tp_methods */
};
/* Called by the Python interpreter when deallocating a value object. */
static void
valpy_dealloc (PyObject *obj)
{
value_object *self = (value_object *) obj;
value_remove_from_list (&values_in_python, self->value);
if (!self->owned_by_gdb)
value_free (self->value);
self->ob_type->tp_free (self);
}
/* Called when a new gdb.Value object needs to be allocated. */
static PyObject *
valpy_new (PyTypeObject *subtype, PyObject *args, PyObject *keywords)
{
struct value *value = NULL; /* Initialize to appease gcc warning. */
value_object *value_obj;
volatile struct gdb_exception except;
if (PyTuple_Size (args) != 1)
{
PyErr_SetString (PyExc_TypeError, _("Value object creation takes only "
"1 argument"));
return NULL;
}
value_obj = (value_object *) subtype->tp_alloc (subtype, 1);
if (value_obj == NULL)
{
PyErr_SetString (PyExc_MemoryError, _("Could not allocate memory to "
"create Value object."));
return NULL;
}
TRY_CATCH (except, RETURN_MASK_ALL)
{
value = convert_value_from_python (PyTuple_GetItem (args, 0));
}
if (except.reason < 0)
{
subtype->tp_free (value_obj);
return PyErr_Format (except.reason == RETURN_QUIT
? PyExc_KeyboardInterrupt : PyExc_TypeError,
"%s", except.message);
}
value_obj->value = value;
release_value (value);
value_prepend_to_list (&values_in_python, value);
return (PyObject *) value_obj;
}
/* Given a value of a pointer type, apply the C unary * operator to it. */
static PyObject *
valpy_dereference (PyObject *self, PyObject *args)
{
struct value *res_val = NULL; /* Initialize to appease gcc warning. */
volatile struct gdb_exception except;
TRY_CATCH (except, RETURN_MASK_ALL)
{
res_val = value_ind (((value_object *) self)->value);
}
GDB_PY_HANDLE_EXCEPTION (except);
return value_to_value_object (res_val);
}
static Py_ssize_t
valpy_length (PyObject *self)
{
/* We don't support getting the number of elements in a struct / class. */
PyErr_SetString (PyExc_NotImplementedError,
"Invalid operation on gdb.Value.");
return -1;
}
/* Given string name of an element inside structure, return its value
object. */
static PyObject *
valpy_getitem (PyObject *self, PyObject *key)
{
value_object *self_value = (value_object *) self;
char *field;
struct value *res_val = NULL; /* Initialize to appease gcc warning. */
struct cleanup *old;
volatile struct gdb_exception except;
field = python_string_to_target_string (key);
if (field == NULL)
return NULL;
old = make_cleanup (xfree, field);
TRY_CATCH (except, RETURN_MASK_ALL)
{
res_val = value_struct_elt (&self_value->value, NULL, field, 0, NULL);
}
GDB_PY_HANDLE_EXCEPTION (except);
do_cleanups (old);
return value_to_value_object (res_val);
}
static int
valpy_setitem (PyObject *self, PyObject *key, PyObject *value)
{
PyErr_Format (PyExc_NotImplementedError,
_("Setting of struct elements is not currently supported."));
return -1;
}
/* Called by the Python interpreter to obtain string representation
of the object. */
static PyObject *
valpy_str (PyObject *self)
{
char *s = NULL;
long dummy;
struct ui_file *stb;
struct cleanup *old_chain;
PyObject *result;
volatile struct gdb_exception except;
stb = mem_fileopen ();
old_chain = make_cleanup_ui_file_delete (stb);
TRY_CATCH (except, RETURN_MASK_ALL)
{
common_val_print (((value_object *) self)->value, stb, 0, 0, 0,
Val_pretty_default, current_language);
s = ui_file_xstrdup (stb, &dummy);
}
GDB_PY_HANDLE_EXCEPTION (except);
do_cleanups (old_chain);
result = PyUnicode_Decode (s, strlen (s), host_charset (), NULL);
xfree (s);
return result;
}
enum valpy_opcode
{
VALPY_ADD,
VALPY_SUB,
VALPY_MUL,
VALPY_DIV,
VALPY_REM,
VALPY_POW
};
/* If TYPE is a reference, return the target; otherwise return TYPE. */
#define STRIP_REFERENCE(TYPE) \
((TYPE_CODE (TYPE) == TYPE_CODE_REF) ? (TYPE_TARGET_TYPE (TYPE)) : (TYPE))
/* Returns a value object which is the result of applying the operation
specified by OPCODE to the given arguments. */
static PyObject *
valpy_binop (enum valpy_opcode opcode, PyObject *self, PyObject *other)
{
struct value *res_val = NULL; /* Initialize to appease gcc warning. */
volatile struct gdb_exception except;
TRY_CATCH (except, RETURN_MASK_ALL)
{
struct value *arg1, *arg2;
/* If the gdb.Value object is the second operand, then it will be passed
to us as the OTHER argument, and SELF will be an entirely different
kind of object, altogether. Because of this, we can't assume self is
a gdb.Value object and need to convert it from python as well. */
arg1 = convert_value_from_python (self);
arg2 = convert_value_from_python (other);
switch (opcode)
{
case VALPY_ADD:
{
struct type *ltype = value_type (arg1);
struct type *rtype = value_type (arg2);
CHECK_TYPEDEF (ltype);
ltype = STRIP_REFERENCE (ltype);
CHECK_TYPEDEF (rtype);
rtype = STRIP_REFERENCE (rtype);
if (TYPE_CODE (ltype) == TYPE_CODE_PTR)
res_val = value_ptradd (arg1, arg2);
else if (TYPE_CODE (rtype) == TYPE_CODE_PTR)
res_val = value_ptradd (arg2, arg1);
else
res_val = value_binop (arg1, arg2, BINOP_ADD);
}
break;
case VALPY_SUB:
{
struct type *ltype = value_type (arg1);
struct type *rtype = value_type (arg2);
CHECK_TYPEDEF (ltype);
ltype = STRIP_REFERENCE (ltype);
CHECK_TYPEDEF (rtype);
rtype = STRIP_REFERENCE (rtype);
if (TYPE_CODE (ltype) == TYPE_CODE_PTR)
{
if (TYPE_CODE (rtype) == TYPE_CODE_PTR)
/* A ptrdiff_t for the target would be preferable
here. */
res_val = value_from_longest (builtin_type_pyint,
value_ptrdiff (arg1, arg2));
else
res_val = value_ptrsub (arg1, arg2);
}
else
res_val = value_binop (arg1, arg2, BINOP_SUB);
}
break;
case VALPY_MUL:
res_val = value_binop (arg1, arg2, BINOP_MUL);
break;
case VALPY_DIV:
res_val = value_binop (arg1, arg2, BINOP_DIV);
break;
case VALPY_REM:
res_val = value_binop (arg1, arg2, BINOP_REM);
break;
case VALPY_POW:
res_val = value_binop (arg1, arg2, BINOP_EXP);
break;
}
}
GDB_PY_HANDLE_EXCEPTION (except);
return value_to_value_object (res_val);
}
static PyObject *
valpy_add (PyObject *self, PyObject *other)
{
return valpy_binop (VALPY_ADD, self, other);
}
static PyObject *
valpy_subtract (PyObject *self, PyObject *other)
{
return valpy_binop (VALPY_SUB, self, other);
}
static PyObject *
valpy_multiply (PyObject *self, PyObject *other)
{
return valpy_binop (VALPY_MUL, self, other);
}
static PyObject *
valpy_divide (PyObject *self, PyObject *other)
{
return valpy_binop (VALPY_DIV, self, other);
}
static PyObject *
valpy_remainder (PyObject *self, PyObject *other)
{
return valpy_binop (VALPY_REM, self, other);
}
static PyObject *
valpy_power (PyObject *self, PyObject *other, PyObject *unused)
{
/* We don't support the ternary form of pow. I don't know how to express
that, so let's just throw NotImplementedError to at least do something
about it. */
if (unused != Py_None)
{
PyErr_SetString (PyExc_NotImplementedError,
"Invalid operation on gdb.Value.");
return NULL;
}
return valpy_binop (VALPY_POW, self, other);
}
static PyObject *
valpy_negative (PyObject *self)
{
struct value *val = NULL;
volatile struct gdb_exception except;
TRY_CATCH (except, RETURN_MASK_ALL)
{
val = value_neg (((value_object *) self)->value);
}
GDB_PY_HANDLE_EXCEPTION (except);
return value_to_value_object (val);
}
static PyObject *
valpy_positive (PyObject *self)
{
struct value *copy = value_copy (((value_object *) self)->value);
return value_to_value_object (copy);
}
static PyObject *
valpy_absolute (PyObject *self)
{
if (value_less (((value_object *) self)->value,
value_from_longest (builtin_type_int8, 0)))
return valpy_negative (self);
else
return valpy_positive (self);
}
/* Implements boolean evaluation of gdb.Value. */
static int
valpy_nonzero (PyObject *self)
{
value_object *self_value = (value_object *) self;
struct type *type;
type = check_typedef (value_type (self_value->value));
if (is_integral_type (type) || TYPE_CODE (type) == TYPE_CODE_PTR)
return !!value_as_long (self_value->value);
else if (TYPE_CODE (type) == TYPE_CODE_FLT)
return value_as_double (self_value->value) != 0;
else if (TYPE_CODE (type) == TYPE_CODE_DECFLOAT)
return !decimal_is_zero (value_contents (self_value->value),
TYPE_LENGTH (type));
else
{
PyErr_SetString (PyExc_TypeError, _("Attempted truth testing on invalid "
"gdb.Value type."));
return 0;
}
}
/* Implements comparison operations for value objects. */
static PyObject *
valpy_richcompare (PyObject *self, PyObject *other, int op)
{
int result = 0;
struct value *value_self, *value_other;
volatile struct gdb_exception except;
if (PyObject_TypeCheck (other, &value_object_type))
value_other = ((value_object *) other)->value;
else if (PyInt_Check (other))
{
LONGEST l;
l = PyInt_AsLong (other);
if (PyErr_Occurred ())
return NULL;
value_other = value_from_longest (builtin_type_pyint, l);
}
else if (PyFloat_Check (other))
{
DOUBLEST d;
d = PyFloat_AsDouble (other);
if (PyErr_Occurred ())
return NULL;
value_other = value_from_double (builtin_type_pyfloat, d);
}
else if (PyString_Check (other) || PyUnicode_Check (other))
{
char *str;
str = python_string_to_target_string (other);
value_other = value_from_string (str);
xfree (str);
}
else if (other == Py_None)
/* Comparing with None is special. From what I can tell, in Python
None is smaller than anything else. */
switch (op) {
case Py_LT:
case Py_LE:
case Py_EQ:
Py_RETURN_FALSE;
case Py_NE:
case Py_GT:
case Py_GE:
Py_RETURN_TRUE;
default:
/* Can't happen. */
PyErr_SetString (PyExc_NotImplementedError,
"Invalid operation on gdb.Value.");
return NULL;
}
else
{
PyErr_SetString (PyExc_NotImplementedError,
"Operation not supported on gdb.Value of this type.");
return NULL;
}
TRY_CATCH (except, RETURN_MASK_ALL)
{
switch (op) {
case Py_LT:
result = value_less (((value_object *) self)->value, value_other);
break;
case Py_LE:
result = value_less (((value_object *) self)->value, value_other)
|| value_equal (((value_object *) self)->value, value_other);
break;
case Py_EQ:
result = value_equal (((value_object *) self)->value, value_other);
break;
case Py_NE:
result = !value_equal (((value_object *) self)->value, value_other);
break;
case Py_GT:
result = value_less (value_other, ((value_object *) self)->value);
break;
case Py_GE:
result = value_less (value_other, ((value_object *) self)->value)
|| value_equal (((value_object *) self)->value, value_other);
break;
default:
/* Can't happen. */
PyErr_SetString (PyExc_NotImplementedError,
"Invalid operation on gdb.Value.");
return NULL;
}
}
GDB_PY_HANDLE_EXCEPTION (except);
if (result == 1)
Py_RETURN_TRUE;
Py_RETURN_FALSE;
}
/* Returns an object for a value which is released from the all_values chain,
so its lifetime is not bound to the execution of a command. */
PyObject *
value_to_value_object (struct value *val)
{
value_object *val_obj;
val_obj = PyObject_New (value_object, &value_object_type);
if (val_obj != NULL)
{
val_obj->value = val;
release_value (val);
value_prepend_to_list (&values_in_python, val);
}
return (PyObject *) val_obj;
}
/* Try to convert a Python value to a gdb value. If the value cannot
be converted, throw a gdb exception. */
struct value *
convert_value_from_python (PyObject *obj)
{
struct value *value = NULL; /* -Wall */
PyObject *target_str, *unicode_str;
struct cleanup *old;
if (! obj)
error (_("Internal error while converting Python value."));
if (PyBool_Check (obj))
value = value_from_longest (builtin_type_pybool, obj == Py_True);
else if (PyInt_Check (obj))
value = value_from_longest (builtin_type_pyint, PyInt_AsLong (obj));
else if (PyLong_Check (obj))
{
LONGEST l = PyLong_AsLongLong (obj);
if (! PyErr_Occurred ())
value = value_from_longest (builtin_type_pylong, l);
}
else if (PyFloat_Check (obj))
{
double d = PyFloat_AsDouble (obj);
if (! PyErr_Occurred ())
value = value_from_double (builtin_type_pyfloat, d);
}
else if (PyString_Check (obj) || PyUnicode_Check (obj))
{
char *s;
s = python_string_to_target_string (obj);
if (s == NULL)
return NULL;
old = make_cleanup (xfree, s);
value = value_from_string (s);
do_cleanups (old);
}
else if (PyObject_TypeCheck (obj, &value_object_type))
value = ((value_object *) obj)->value;
else
error (_("Could not convert Python object: %s"),
PyString_AsString (PyObject_Str (obj)));
if (PyErr_Occurred ())
error (_("Error converting Python value."));
return value;
}
/* Returns value object in the ARGth position in GDB's history. */
PyObject *
gdbpy_get_value_from_history (PyObject *self, PyObject *args)
{
int i;
struct value *res_val = NULL; /* Initialize to appease gcc warning. */
volatile struct gdb_exception except;
if (!PyArg_ParseTuple (args, "i", &i))
return NULL;
TRY_CATCH (except, RETURN_MASK_ALL)
{
res_val = access_value_history (i);
}
GDB_PY_HANDLE_EXCEPTION (except);
return value_to_value_object (res_val);
}
void
gdbpy_initialize_values (void)
{
value_object_type.tp_new = valpy_new;
if (PyType_Ready (&value_object_type) < 0)
return;
Py_INCREF (&value_object_type);
PyModule_AddObject (gdb_module, "Value", (PyObject *) &value_object_type);
values_in_python = NULL;
}
#endif /* HAVE_PYTHON */
|