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
|
/* General utility routines for GDB/Python.
Copyright (C) 2008-2019 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 "python-internal.h"
/* Converts a Python 8-bit string to a unicode string object. Assumes the
8-bit string is in the host charset. If an error occurs during conversion,
returns NULL with a python exception set.
As an added bonus, the functions accepts a unicode string and returns it
right away, so callers don't need to check which kind of string they've
got. In Python 3, all strings are Unicode so this case is always the
one that applies.
If the given object is not one of the mentioned string types, NULL is
returned, with the TypeError python exception set. */
gdbpy_ref<>
python_string_to_unicode (PyObject *obj)
{
PyObject *unicode_str;
/* If obj is already a unicode string, just return it.
I wish life was always that simple... */
if (PyUnicode_Check (obj))
{
unicode_str = obj;
Py_INCREF (obj);
}
#ifndef IS_PY3K
else if (PyString_Check (obj))
unicode_str = PyUnicode_FromEncodedObject (obj, host_charset (), NULL);
#endif
else
{
PyErr_SetString (PyExc_TypeError,
_("Expected a string or unicode object."));
unicode_str = NULL;
}
return gdbpy_ref<> (unicode_str);
}
/* Returns a newly allocated string with the contents of the given unicode
string object converted to CHARSET. If an error occurs during the
conversion, NULL will be returned and a python exception will be
set. */
static gdb::unique_xmalloc_ptr<char>
unicode_to_encoded_string (PyObject *unicode_str, const char *charset)
{
/* Translate string to named charset. */
gdbpy_ref<> string (PyUnicode_AsEncodedString (unicode_str, charset, NULL));
if (string == NULL)
return NULL;
return gdb::unique_xmalloc_ptr<char>
(xstrdup (PyBytes_AsString (string.get ())));
}
/* Returns a PyObject with the contents of the given unicode string
object converted to a named charset. If an error occurs during
the conversion, NULL will be returned and a python exception will
be set. */
static gdbpy_ref<>
unicode_to_encoded_python_string (PyObject *unicode_str, const char *charset)
{
/* Translate string to named charset. */
return gdbpy_ref<> (PyUnicode_AsEncodedString (unicode_str, charset, NULL));
}
/* Returns a newly allocated string with the contents of the given
unicode string object converted to the target's charset. If an
error occurs during the conversion, NULL will be returned and a
python exception will be set. */
gdb::unique_xmalloc_ptr<char>
unicode_to_target_string (PyObject *unicode_str)
{
return unicode_to_encoded_string (unicode_str,
target_charset (python_gdbarch));
}
/* Returns a PyObject with the contents of the given unicode string
object converted to the target's charset. If an error occurs
during the conversion, NULL will be returned and a python exception
will be set. */
static gdbpy_ref<>
unicode_to_target_python_string (PyObject *unicode_str)
{
return unicode_to_encoded_python_string (unicode_str,
target_charset (python_gdbarch));
}
/* Converts a python string (8-bit or unicode) to a target string in
the target's charset. Returns NULL on error, with a python
exception set. */
gdb::unique_xmalloc_ptr<char>
python_string_to_target_string (PyObject *obj)
{
gdbpy_ref<> str = python_string_to_unicode (obj);
if (str == NULL)
return NULL;
return unicode_to_target_string (str.get ());
}
/* Converts a python string (8-bit or unicode) to a target string in the
target's charset. Returns NULL on error, with a python exception
set.
In Python 3, the returned object is a "bytes" object (not a string). */
gdbpy_ref<>
python_string_to_target_python_string (PyObject *obj)
{
gdbpy_ref<> str = python_string_to_unicode (obj);
if (str == NULL)
return str;
return unicode_to_target_python_string (str.get ());
}
/* Converts a python string (8-bit or unicode) to a target string in
the host's charset. Returns NULL on error, with a python exception
set. */
gdb::unique_xmalloc_ptr<char>
python_string_to_host_string (PyObject *obj)
{
gdbpy_ref<> str = python_string_to_unicode (obj);
if (str == NULL)
return NULL;
return unicode_to_encoded_string (str.get (), host_charset ());
}
/* Convert a host string to a python string. */
gdbpy_ref<>
host_string_to_python_string (const char *str)
{
return gdbpy_ref<> (PyString_Decode (str, strlen (str), host_charset (),
NULL));
}
/* Return true if OBJ is a Python string or unicode object, false
otherwise. */
int
gdbpy_is_string (PyObject *obj)
{
#ifdef IS_PY3K
return PyUnicode_Check (obj);
#else
return PyString_Check (obj) || PyUnicode_Check (obj);
#endif
}
/* Return the string representation of OBJ, i.e., str (obj).
If the result is NULL a python error occurred, the caller must clear it. */
gdb::unique_xmalloc_ptr<char>
gdbpy_obj_to_string (PyObject *obj)
{
gdbpy_ref<> str_obj (PyObject_Str (obj));
if (str_obj != NULL)
{
gdb::unique_xmalloc_ptr<char> msg;
#ifdef IS_PY3K
msg = python_string_to_host_string (str_obj.get ());
#else
msg.reset (xstrdup (PyString_AsString (str_obj.get ())));
#endif
return msg;
}
return NULL;
}
/* See python-internal.h. */
gdb::unique_xmalloc_ptr<char>
gdbpy_err_fetch::to_string () const
{
/* There are a few cases to consider.
For example:
value is a string when PyErr_SetString is used.
value is not a string when raise "foo" is used, instead it is None
and type is "foo".
So the algorithm we use is to print `str (value)' if it's not
None, otherwise we print `str (type)'.
Using str (aka PyObject_Str) will fetch the error message from
gdb.GdbError ("message"). */
if (m_error_value && m_error_value != Py_None)
return gdbpy_obj_to_string (m_error_value);
else
return gdbpy_obj_to_string (m_error_type);
}
/* See python-internal.h. */
gdb::unique_xmalloc_ptr<char>
gdbpy_err_fetch::type_to_string () const
{
return gdbpy_obj_to_string (m_error_type);
}
/* Convert a GDB exception to the appropriate Python exception.
This sets the Python error indicator. */
void
gdbpy_convert_exception (struct gdb_exception exception)
{
PyObject *exc_class;
if (exception.reason == RETURN_QUIT)
exc_class = PyExc_KeyboardInterrupt;
else if (exception.error == MEMORY_ERROR)
exc_class = gdbpy_gdb_memory_error;
else
exc_class = gdbpy_gdb_error;
PyErr_Format (exc_class, "%s", exception.message);
}
/* Converts OBJ to a CORE_ADDR value.
Returns 0 on success or -1 on failure, with a Python exception set.
*/
int
get_addr_from_python (PyObject *obj, CORE_ADDR *addr)
{
if (gdbpy_is_value_object (obj))
{
TRY
{
*addr = value_as_address (value_object_to_value (obj));
}
CATCH (except, RETURN_MASK_ALL)
{
GDB_PY_SET_HANDLE_EXCEPTION (except);
}
END_CATCH
}
else
{
gdbpy_ref<> num (PyNumber_Long (obj));
gdb_py_ulongest val;
if (num == NULL)
return -1;
val = gdb_py_long_as_ulongest (num.get ());
if (PyErr_Occurred ())
return -1;
if (sizeof (val) > sizeof (CORE_ADDR) && ((CORE_ADDR) val) != val)
{
PyErr_SetString (PyExc_ValueError,
_("Overflow converting to address."));
return -1;
}
*addr = val;
}
return 0;
}
/* Convert a LONGEST to the appropriate Python object -- either an
integer object or a long object, depending on its value. */
gdbpy_ref<>
gdb_py_object_from_longest (LONGEST l)
{
#ifdef IS_PY3K
if (sizeof (l) > sizeof (long))
return gdbpy_ref<> (PyLong_FromLongLong (l));
return gdbpy_ref<> (PyLong_FromLong (l));
#else
#ifdef HAVE_LONG_LONG /* Defined by Python. */
/* If we have 'long long', and the value overflows a 'long', use a
Python Long; otherwise use a Python Int. */
if (sizeof (l) > sizeof (long)
&& (l > PyInt_GetMax () || l < (- (LONGEST) PyInt_GetMax ()) - 1))
return gdbpy_ref<> (PyLong_FromLongLong (l));
#endif
return gdbpy_ref<> (PyInt_FromLong (l));
#endif
}
/* Convert a ULONGEST to the appropriate Python object -- either an
integer object or a long object, depending on its value. */
gdbpy_ref<>
gdb_py_object_from_ulongest (ULONGEST l)
{
#ifdef IS_PY3K
if (sizeof (l) > sizeof (unsigned long))
return gdbpy_ref<> (PyLong_FromUnsignedLongLong (l));
return gdbpy_ref<> (PyLong_FromUnsignedLong (l));
#else
#ifdef HAVE_LONG_LONG /* Defined by Python. */
/* If we have 'long long', and the value overflows a 'long', use a
Python Long; otherwise use a Python Int. */
if (sizeof (l) > sizeof (unsigned long) && l > PyInt_GetMax ())
return gdbpy_ref<> (PyLong_FromUnsignedLongLong (l));
#endif
if (l > PyInt_GetMax ())
return gdbpy_ref<> (PyLong_FromUnsignedLong (l));
return gdbpy_ref<> (PyInt_FromLong (l));
#endif
}
/* Like PyInt_AsLong, but returns 0 on failure, 1 on success, and puts
the value into an out parameter. */
int
gdb_py_int_as_long (PyObject *obj, long *result)
{
*result = PyInt_AsLong (obj);
return ! (*result == -1 && PyErr_Occurred ());
}
/* Generic implementation of the __dict__ attribute for objects that
have a dictionary. The CLOSURE argument should be the type object.
This only handles positive values for tp_dictoffset. */
PyObject *
gdb_py_generic_dict (PyObject *self, void *closure)
{
PyObject *result;
PyTypeObject *type_obj = (PyTypeObject *) closure;
char *raw_ptr;
raw_ptr = (char *) self + type_obj->tp_dictoffset;
result = * (PyObject **) raw_ptr;
Py_INCREF (result);
return result;
}
/* Like PyModule_AddObject, but does not steal a reference to
OBJECT. */
int
gdb_pymodule_addobject (PyObject *module, const char *name, PyObject *object)
{
int result;
Py_INCREF (object);
result = PyModule_AddObject (module, name, object);
if (result < 0)
Py_DECREF (object);
return result;
}
/* Handle a Python exception when the special gdb.GdbError treatment
is desired. This should only be called when an exception is set.
If the exception is a gdb.GdbError, throw a gdb exception with the
exception text. For other exceptions, print the Python stack and
then throw a gdb exception. */
void
gdbpy_handle_exception ()
{
gdbpy_err_fetch fetched_error;
gdb::unique_xmalloc_ptr<char> msg = fetched_error.to_string ();
if (msg == NULL)
{
/* An error occurred computing the string representation of the
error message. This is rare, but we should inform the user. */
printf_filtered (_("An error occurred in Python "
"and then another occurred computing the "
"error message.\n"));
gdbpy_print_stack ();
}
/* Don't print the stack for gdb.GdbError exceptions.
It is generally used to flag user errors.
We also don't want to print "Error occurred in Python command"
for user errors. However, a missing message for gdb.GdbError
exceptions is arguably a bug, so we flag it as such. */
if (fetched_error.type_matches (PyExc_KeyboardInterrupt))
throw_quit ("Quit");
else if (! fetched_error.type_matches (gdbpy_gdberror_exc)
|| msg == NULL || *msg == '\0')
{
fetched_error.restore ();
gdbpy_print_stack ();
if (msg != NULL && *msg != '\0')
error (_("Error occurred in Python: %s"), msg.get ());
else
error (_("Error occurred in Python."));
}
else
error ("%s", msg.get ());
}
|