-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathpy-framefilter.c
More file actions
1626 lines (1409 loc) · 43.2 KB
/
py-framefilter.c
File metadata and controls
1626 lines (1409 loc) · 43.2 KB
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
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* Python frame filters
Copyright (C) 2013-2017 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 "objfiles.h"
#include "symtab.h"
#include "language.h"
#include "arch-utils.h"
#include "python.h"
#include "ui-out.h"
#include "valprint.h"
#include "annotate.h"
#include "hashtab.h"
#include "demangle.h"
#include "mi/mi-cmds.h"
#include "python-internal.h"
enum mi_print_types
{
MI_PRINT_ARGS,
MI_PRINT_LOCALS
};
/* Helper function to extract a symbol, a name and a language
definition from a Python object that conforms to the "Symbol Value"
interface. OBJ is the Python object to extract the values from.
NAME is a pass-through argument where the name of the symbol will
be written. NAME is allocated in this function, but the caller is
responsible for clean up. SYM is a pass-through argument where the
symbol will be written and SYM_BLOCK is a pass-through argument to
write the block where the symbol lies in. In the case of the API
returning a string, this will be set to NULL. LANGUAGE is also a
pass-through argument denoting the language attributed to the
Symbol. In the case of SYM being NULL, this will be set to the
current language. Returns EXT_LANG_BT_ERROR on error with the
appropriate Python exception set, and EXT_LANG_BT_OK on success. */
static enum ext_lang_bt_status
extract_sym (PyObject *obj, char **name, struct symbol **sym,
struct block **sym_block, const struct language_defn **language)
{
PyObject *result = PyObject_CallMethod (obj, "symbol", NULL);
if (result == NULL)
return EXT_LANG_BT_ERROR;
/* For 'symbol' callback, the function can return a symbol or a
string. */
if (gdbpy_is_string (result))
{
*name = python_string_to_host_string (result);
Py_DECREF (result);
if (*name == NULL)
return EXT_LANG_BT_ERROR;
/* If the API returns a string (and not a symbol), then there is
no symbol derived language available and the frame filter has
either overridden the symbol with a string, or supplied a
entirely synthetic symbol/value pairing. In that case, use
python_language. */
*language = python_language;
*sym = NULL;
*sym_block = NULL;
}
else
{
/* This type checks 'result' during the conversion so we
just call it unconditionally and check the return. */
*sym = symbol_object_to_symbol (result);
/* TODO: currently, we have no way to recover the block in which SYMBOL
was found, so we have no block to return. Trying to evaluate SYMBOL
will yield an incorrect value when it's located in a FRAME and
evaluated from another frame (as permitted in nested functions). */
*sym_block = NULL;
Py_DECREF (result);
if (*sym == NULL)
{
PyErr_SetString (PyExc_RuntimeError,
_("Unexpected value. Expecting a "
"gdb.Symbol or a Python string."));
return EXT_LANG_BT_ERROR;
}
/* Duplicate the symbol name, so the caller has consistency
in garbage collection. */
*name = xstrdup (SYMBOL_PRINT_NAME (*sym));
/* If a symbol is specified attempt to determine the language
from the symbol. If mode is not "auto", then the language
has been explicitly set, use that. */
if (language_mode == language_mode_auto)
*language = language_def (SYMBOL_LANGUAGE (*sym));
else
*language = current_language;
}
return EXT_LANG_BT_OK;
}
/* Helper function to extract a value from an object that conforms to
the "Symbol Value" interface. OBJ is the Python object to extract
the value from. VALUE is a pass-through argument where the value
will be written. If the object does not have the value attribute,
or provides the Python None for a value, VALUE will be set to NULL
and this function will return as successful. Returns EXT_LANG_BT_ERROR
on error with the appropriate Python exception set, and EXT_LANG_BT_OK on
success. */
static enum ext_lang_bt_status
extract_value (PyObject *obj, struct value **value)
{
if (PyObject_HasAttrString (obj, "value"))
{
PyObject *vresult = PyObject_CallMethod (obj, "value", NULL);
if (vresult == NULL)
return EXT_LANG_BT_ERROR;
/* The Python code has returned 'None' for a value, so we set
value to NULL. This flags that GDB should read the
value. */
if (vresult == Py_None)
{
Py_DECREF (vresult);
*value = NULL;
return EXT_LANG_BT_OK;
}
else
{
*value = convert_value_from_python (vresult);
Py_DECREF (vresult);
if (*value == NULL)
return EXT_LANG_BT_ERROR;
return EXT_LANG_BT_OK;
}
}
else
*value = NULL;
return EXT_LANG_BT_OK;
}
/* MI prints only certain values according to the type of symbol and
also what the user has specified. SYM is the symbol to check, and
MI_PRINT_TYPES is an enum specifying what the user wants emitted
for the MI command in question. */
static int
mi_should_print (struct symbol *sym, enum mi_print_types type)
{
int print_me = 0;
switch (SYMBOL_CLASS (sym))
{
default:
case LOC_UNDEF: /* catches errors */
case LOC_CONST: /* constant */
case LOC_TYPEDEF: /* local typedef */
case LOC_LABEL: /* local label */
case LOC_BLOCK: /* local function */
case LOC_CONST_BYTES: /* loc. byte seq. */
case LOC_UNRESOLVED: /* unresolved static */
case LOC_OPTIMIZED_OUT: /* optimized out */
print_me = 0;
break;
case LOC_ARG: /* argument */
case LOC_REF_ARG: /* reference arg */
case LOC_REGPARM_ADDR: /* indirect register arg */
case LOC_LOCAL: /* stack local */
case LOC_STATIC: /* static */
case LOC_REGISTER: /* register */
case LOC_COMPUTED: /* computed location */
if (type == MI_PRINT_LOCALS)
print_me = ! SYMBOL_IS_ARGUMENT (sym);
else
print_me = SYMBOL_IS_ARGUMENT (sym);
}
return print_me;
}
/* Helper function which outputs a type name extracted from VAL to a
"type" field in the output stream OUT. OUT is the ui-out structure
the type name will be output too, and VAL is the value that the
type will be extracted from. Returns EXT_LANG_BT_ERROR on error, with
any GDB exceptions converted to a Python exception, or EXT_LANG_BT_OK on
success. */
static enum ext_lang_bt_status
py_print_type (struct ui_out *out, struct value *val)
{
TRY
{
struct ui_file *stb;
struct cleanup *cleanup;
stb = mem_fileopen ();
cleanup = make_cleanup_ui_file_delete (stb);
check_typedef (value_type (val));
type_print (value_type (val), "", stb, -1);
ui_out_field_stream (out, "type", stb);
do_cleanups (cleanup);
}
CATCH (except, RETURN_MASK_ALL)
{
gdbpy_convert_exception (except);
return EXT_LANG_BT_ERROR;
}
END_CATCH
return EXT_LANG_BT_OK;
}
/* Helper function which outputs a value to an output field in a
stream. OUT is the ui-out structure the value will be output to,
VAL is the value that will be printed, OPTS contains the value
printing options, ARGS_TYPE is an enumerator describing the
argument format, and LANGUAGE is the language_defn that the value
will be printed with. Returns EXT_LANG_BT_ERROR on error, with any GDB
exceptions converted to a Python exception, or EXT_LANG_BT_OK on
success. */
static enum ext_lang_bt_status
py_print_value (struct ui_out *out, struct value *val,
const struct value_print_options *opts,
int indent,
enum ext_lang_frame_args args_type,
const struct language_defn *language)
{
int should_print = 0;
/* MI does not print certain values, differentiated by type,
depending on what ARGS_TYPE indicates. Test type against option.
For CLI print all values. */
if (args_type == MI_PRINT_SIMPLE_VALUES
|| args_type == MI_PRINT_ALL_VALUES)
{
struct type *type = NULL;
TRY
{
type = check_typedef (value_type (val));
}
CATCH (except, RETURN_MASK_ALL)
{
gdbpy_convert_exception (except);
return EXT_LANG_BT_ERROR;
}
END_CATCH
if (args_type == MI_PRINT_ALL_VALUES)
should_print = 1;
else if (args_type == MI_PRINT_SIMPLE_VALUES
&& TYPE_CODE (type) != TYPE_CODE_ARRAY
&& TYPE_CODE (type) != TYPE_CODE_STRUCT
&& TYPE_CODE (type) != TYPE_CODE_UNION)
should_print = 1;
}
else if (args_type != NO_VALUES)
should_print = 1;
if (should_print)
{
TRY
{
struct ui_file *stb;
struct cleanup *cleanup;
stb = mem_fileopen ();
cleanup = make_cleanup_ui_file_delete (stb);
common_val_print (val, stb, indent, opts, language);
ui_out_field_stream (out, "value", stb);
do_cleanups (cleanup);
}
CATCH (except, RETURN_MASK_ALL)
{
gdbpy_convert_exception (except);
return EXT_LANG_BT_ERROR;
}
END_CATCH
}
return EXT_LANG_BT_OK;
}
/* Helper function to call a Python method and extract an iterator
from the result. If the function returns anything but an iterator
the exception is preserved and NULL is returned. FILTER is the
Python object to call, and FUNC is the name of the method. Returns
a PyObject, or NULL on error with the appropriate exception set.
This function can return an iterator, or NULL. */
static PyObject *
get_py_iter_from_func (PyObject *filter, char *func)
{
if (PyObject_HasAttrString (filter, func))
{
PyObject *result = PyObject_CallMethod (filter, func, NULL);
if (result != NULL)
{
if (result == Py_None)
{
return result;
}
else
{
PyObject *iterator = PyObject_GetIter (result);
Py_DECREF (result);
return iterator;
}
}
}
else
Py_RETURN_NONE;
return NULL;
}
/* Helper function to output a single frame argument and value to an
output stream. This function will account for entry values if the
FV parameter is populated, the frame argument has entry values
associated with them, and the appropriate "set entry-value"
options are set. Will output in CLI or MI like format depending
on the type of output stream detected. OUT is the output stream,
SYM_NAME is the name of the symbol. If SYM_NAME is populated then
it must have an accompanying value in the parameter FV. FA is a
frame argument structure. If FA is populated, both SYM_NAME and
FV are ignored. OPTS contains the value printing options,
ARGS_TYPE is an enumerator describing the argument format,
PRINT_ARGS_FIELD is a flag which indicates if we output "ARGS=1"
in MI output in commands where both arguments and locals are
printed. Returns EXT_LANG_BT_ERROR on error, with any GDB exceptions
converted to a Python exception, or EXT_LANG_BT_OK on success. */
static enum ext_lang_bt_status
py_print_single_arg (struct ui_out *out,
const char *sym_name,
struct frame_arg *fa,
struct value *fv,
const struct value_print_options *opts,
enum ext_lang_frame_args args_type,
int print_args_field,
const struct language_defn *language)
{
struct value *val;
enum ext_lang_bt_status retval = EXT_LANG_BT_OK;
if (fa != NULL)
{
if (fa->val == NULL && fa->error == NULL)
return EXT_LANG_BT_OK;
language = language_def (SYMBOL_LANGUAGE (fa->sym));
val = fa->val;
}
else
val = fv;
TRY
{
struct cleanup *cleanups = make_cleanup (null_cleanup, NULL);
/* MI has varying rules for tuples, but generally if there is only
one element in each item in the list, do not start a tuple. The
exception is -stack-list-variables which emits an ARGS="1" field
if the value is a frame argument. This is denoted in this
function with PRINT_ARGS_FIELD which is flag from the caller to
emit the ARGS field. */
if (ui_out_is_mi_like_p (out))
{
if (print_args_field || args_type != NO_VALUES)
make_cleanup_ui_out_tuple_begin_end (out, NULL);
}
annotate_arg_begin ();
/* If frame argument is populated, check for entry-values and the
entry value options. */
if (fa != NULL)
{
struct ui_file *stb;
stb = mem_fileopen ();
make_cleanup_ui_file_delete (stb);
fprintf_symbol_filtered (stb, SYMBOL_PRINT_NAME (fa->sym),
SYMBOL_LANGUAGE (fa->sym),
DMGL_PARAMS | DMGL_ANSI);
if (fa->entry_kind == print_entry_values_compact)
{
fputs_filtered ("=", stb);
fprintf_symbol_filtered (stb, SYMBOL_PRINT_NAME (fa->sym),
SYMBOL_LANGUAGE (fa->sym),
DMGL_PARAMS | DMGL_ANSI);
}
if (fa->entry_kind == print_entry_values_only
|| fa->entry_kind == print_entry_values_compact)
{
fputs_filtered ("@entry", stb);
}
ui_out_field_stream (out, "name", stb);
}
else
/* Otherwise, just output the name. */
ui_out_field_string (out, "name", sym_name);
annotate_arg_name_end ();
if (! ui_out_is_mi_like_p (out))
ui_out_text (out, "=");
if (print_args_field)
ui_out_field_int (out, "arg", 1);
/* For MI print the type, but only for simple values. This seems
weird, but this is how MI choose to format the various output
types. */
if (args_type == MI_PRINT_SIMPLE_VALUES && val != NULL)
{
if (py_print_type (out, val) == EXT_LANG_BT_ERROR)
{
retval = EXT_LANG_BT_ERROR;
do_cleanups (cleanups);
}
}
if (retval != EXT_LANG_BT_ERROR)
{
if (val != NULL)
annotate_arg_value (value_type (val));
/* If the output is to the CLI, and the user option "set print
frame-arguments" is set to none, just output "...". */
if (! ui_out_is_mi_like_p (out) && args_type == NO_VALUES)
ui_out_field_string (out, "value", "...");
else
{
/* Otherwise, print the value for both MI and the CLI, except
for the case of MI_PRINT_NO_VALUES. */
if (args_type != NO_VALUES)
{
if (val == NULL)
{
gdb_assert (fa != NULL && fa->error != NULL);
ui_out_field_fmt (out, "value",
_("<error reading variable: %s>"),
fa->error);
}
else if (py_print_value (out, val, opts, 0, args_type, language)
== EXT_LANG_BT_ERROR)
retval = EXT_LANG_BT_ERROR;
}
}
do_cleanups (cleanups);
}
}
CATCH (except, RETURN_MASK_ERROR)
{
gdbpy_convert_exception (except);
}
END_CATCH
return retval;
}
/* Helper function to loop over frame arguments provided by the
"frame_arguments" Python API. Elements in the iterator must
conform to the "Symbol Value" interface. ITER is the Python
iterable object, OUT is the output stream, ARGS_TYPE is an
enumerator describing the argument format, PRINT_ARGS_FIELD is a
flag which indicates if we output "ARGS=1" in MI output in commands
where both arguments and locals are printed, and FRAME is the
backing frame. Returns EXT_LANG_BT_ERROR on error, with any GDB
exceptions converted to a Python exception, or EXT_LANG_BT_OK on
success. */
static enum ext_lang_bt_status
enumerate_args (PyObject *iter,
struct ui_out *out,
enum ext_lang_frame_args args_type,
int print_args_field,
struct frame_info *frame)
{
PyObject *item;
struct value_print_options opts;
get_user_print_options (&opts);
if (args_type == CLI_SCALAR_VALUES)
{
/* True in "summary" mode, false otherwise. */
opts.summary = 1;
}
opts.deref_ref = 1;
TRY
{
annotate_frame_args ();
}
CATCH (except, RETURN_MASK_ALL)
{
gdbpy_convert_exception (except);
goto error;
}
END_CATCH
/* Collect the first argument outside of the loop, so output of
commas in the argument output is correct. At the end of the
loop block collect another item from the iterator, and, if it is
not null emit a comma. */
item = PyIter_Next (iter);
if (item == NULL && PyErr_Occurred ())
goto error;
while (item)
{
const struct language_defn *language;
char *sym_name;
struct symbol *sym;
struct block *sym_block;
struct value *val;
enum ext_lang_bt_status success = EXT_LANG_BT_ERROR;
success = extract_sym (item, &sym_name, &sym, &sym_block, &language);
if (success == EXT_LANG_BT_ERROR)
{
Py_DECREF (item);
goto error;
}
success = extract_value (item, &val);
if (success == EXT_LANG_BT_ERROR)
{
xfree (sym_name);
Py_DECREF (item);
goto error;
}
Py_DECREF (item);
item = NULL;
if (sym && ui_out_is_mi_like_p (out)
&& ! mi_should_print (sym, MI_PRINT_ARGS))
{
xfree (sym_name);
continue;
}
/* If the object did not provide a value, read it using
read_frame_args and account for entry values, if any. */
if (val == NULL)
{
struct frame_arg arg, entryarg;
/* If there is no value, and also no symbol, set error and
exit. */
if (sym == NULL)
{
PyErr_SetString (PyExc_RuntimeError,
_("No symbol or value provided."));
xfree (sym_name);
goto error;
}
TRY
{
read_frame_arg (sym, frame, &arg, &entryarg);
}
CATCH (except, RETURN_MASK_ALL)
{
xfree (sym_name);
gdbpy_convert_exception (except);
goto error;
}
END_CATCH
/* The object has not provided a value, so this is a frame
argument to be read by GDB. In this case we have to
account for entry-values. */
if (arg.entry_kind != print_entry_values_only)
{
if (py_print_single_arg (out, NULL, &arg,
NULL, &opts,
args_type,
print_args_field,
NULL) == EXT_LANG_BT_ERROR)
{
xfree (arg.error);
xfree (entryarg.error);
xfree (sym_name);
goto error;
}
}
if (entryarg.entry_kind != print_entry_values_no)
{
if (arg.entry_kind != print_entry_values_only)
{
TRY
{
ui_out_text (out, ", ");
ui_out_wrap_hint (out, " ");
}
CATCH (except, RETURN_MASK_ALL)
{
xfree (arg.error);
xfree (entryarg.error);
xfree (sym_name);
gdbpy_convert_exception (except);
goto error;
}
END_CATCH
}
if (py_print_single_arg (out, NULL, &entryarg, NULL, &opts,
args_type, print_args_field, NULL)
== EXT_LANG_BT_ERROR)
{
xfree (arg.error);
xfree (entryarg.error);
xfree (sym_name);
goto error;
}
}
xfree (arg.error);
xfree (entryarg.error);
}
else
{
/* If the object has provided a value, we just print that. */
if (val != NULL)
{
if (py_print_single_arg (out, sym_name, NULL, val, &opts,
args_type, print_args_field,
language) == EXT_LANG_BT_ERROR)
{
xfree (sym_name);
goto error;
}
}
}
xfree (sym_name);
/* Collect the next item from the iterator. If
this is the last item, do not print the
comma. */
item = PyIter_Next (iter);
if (item != NULL)
{
TRY
{
ui_out_text (out, ", ");
}
CATCH (except, RETURN_MASK_ALL)
{
Py_DECREF (item);
gdbpy_convert_exception (except);
goto error;
}
END_CATCH
}
else if (PyErr_Occurred ())
goto error;
TRY
{
annotate_arg_end ();
}
CATCH (except, RETURN_MASK_ALL)
{
Py_DECREF (item);
gdbpy_convert_exception (except);
goto error;
}
END_CATCH
}
return EXT_LANG_BT_OK;
error:
return EXT_LANG_BT_ERROR;
}
/* Helper function to loop over variables provided by the
"frame_locals" Python API. Elements in the iterable must conform
to the "Symbol Value" interface. ITER is the Python iterable
object, OUT is the output stream, INDENT is whether we should
indent the output (for CLI), ARGS_TYPE is an enumerator describing
the argument format, PRINT_ARGS_FIELD is flag which indicates
whether to output the ARGS field in the case of
-stack-list-variables and FRAME is the backing frame. Returns
EXT_LANG_BT_ERROR on error, with any GDB exceptions converted to a Python
exception, or EXT_LANG_BT_OK on success. */
static enum ext_lang_bt_status
enumerate_locals (PyObject *iter,
struct ui_out *out,
int indent,
enum ext_lang_frame_args args_type,
int print_args_field,
struct frame_info *frame)
{
PyObject *item;
struct value_print_options opts;
get_user_print_options (&opts);
opts.deref_ref = 1;
while ((item = PyIter_Next (iter)))
{
const struct language_defn *language;
char *sym_name;
struct value *val;
enum ext_lang_bt_status success = EXT_LANG_BT_ERROR;
struct symbol *sym;
struct block *sym_block;
int local_indent = 8 + (8 * indent);
struct cleanup *locals_cleanups;
locals_cleanups = make_cleanup_py_decref (item);
success = extract_sym (item, &sym_name, &sym, &sym_block, &language);
if (success == EXT_LANG_BT_ERROR)
{
do_cleanups (locals_cleanups);
goto error;
}
make_cleanup (xfree, sym_name);
success = extract_value (item, &val);
if (success == EXT_LANG_BT_ERROR)
{
do_cleanups (locals_cleanups);
goto error;
}
if (sym != NULL && ui_out_is_mi_like_p (out)
&& ! mi_should_print (sym, MI_PRINT_LOCALS))
{
do_cleanups (locals_cleanups);
continue;
}
/* If the object did not provide a value, read it. */
if (val == NULL)
{
TRY
{
val = read_var_value (sym, sym_block, frame);
}
CATCH (except, RETURN_MASK_ERROR)
{
gdbpy_convert_exception (except);
do_cleanups (locals_cleanups);
goto error;
}
END_CATCH
}
/* With PRINT_NO_VALUES, MI does not emit a tuple normally as
each output contains only one field. The exception is
-stack-list-variables, which always provides a tuple. */
if (ui_out_is_mi_like_p (out))
{
if (print_args_field || args_type != NO_VALUES)
make_cleanup_ui_out_tuple_begin_end (out, NULL);
}
TRY
{
if (! ui_out_is_mi_like_p (out))
{
/* If the output is not MI we indent locals. */
ui_out_spaces (out, local_indent);
}
ui_out_field_string (out, "name", sym_name);
if (! ui_out_is_mi_like_p (out))
ui_out_text (out, " = ");
}
CATCH (except, RETURN_MASK_ERROR)
{
gdbpy_convert_exception (except);
do_cleanups (locals_cleanups);
goto error;
}
END_CATCH
if (args_type == MI_PRINT_SIMPLE_VALUES)
{
if (py_print_type (out, val) == EXT_LANG_BT_ERROR)
{
do_cleanups (locals_cleanups);
goto error;
}
}
/* CLI always prints values for locals. MI uses the
simple/no/all system. */
if (! ui_out_is_mi_like_p (out))
{
int val_indent = (indent + 1) * 4;
if (py_print_value (out, val, &opts, val_indent, args_type,
language) == EXT_LANG_BT_ERROR)
{
do_cleanups (locals_cleanups);
goto error;
}
}
else
{
if (args_type != NO_VALUES)
{
if (py_print_value (out, val, &opts, 0, args_type,
language) == EXT_LANG_BT_ERROR)
{
do_cleanups (locals_cleanups);
goto error;
}
}
}
do_cleanups (locals_cleanups);
TRY
{
ui_out_text (out, "\n");
}
CATCH (except, RETURN_MASK_ERROR)
{
gdbpy_convert_exception (except);
goto error;
}
END_CATCH
}
if (item == NULL && PyErr_Occurred ())
goto error;
return EXT_LANG_BT_OK;
error:
return EXT_LANG_BT_ERROR;
}
/* Helper function for -stack-list-variables. Returns EXT_LANG_BT_ERROR on
error, or EXT_LANG_BT_OK on success. */
static enum ext_lang_bt_status
py_mi_print_variables (PyObject *filter, struct ui_out *out,
struct value_print_options *opts,
enum ext_lang_frame_args args_type,
struct frame_info *frame)
{
struct cleanup *old_chain;
PyObject *args_iter;
PyObject *locals_iter;
args_iter = get_py_iter_from_func (filter, "frame_args");
old_chain = make_cleanup_py_xdecref (args_iter);
if (args_iter == NULL)
goto error;
locals_iter = get_py_iter_from_func (filter, "frame_locals");
if (locals_iter == NULL)
goto error;
make_cleanup_py_decref (locals_iter);
make_cleanup_ui_out_list_begin_end (out, "variables");
if (args_iter != Py_None)
if (enumerate_args (args_iter, out, args_type, 1, frame)
== EXT_LANG_BT_ERROR)
goto error;
if (locals_iter != Py_None)
if (enumerate_locals (locals_iter, out, 1, args_type, 1, frame)
== EXT_LANG_BT_ERROR)
goto error;
do_cleanups (old_chain);
return EXT_LANG_BT_OK;
error:
do_cleanups (old_chain);
return EXT_LANG_BT_ERROR;
}
/* Helper function for printing locals. This function largely just
creates the wrapping tuple, and calls enumerate_locals. Returns
EXT_LANG_BT_ERROR on error, or EXT_LANG_BT_OK on success. */
static enum ext_lang_bt_status
py_print_locals (PyObject *filter,
struct ui_out *out,
enum ext_lang_frame_args args_type,
int indent,
struct frame_info *frame)
{
PyObject *locals_iter = get_py_iter_from_func (filter,
"frame_locals");
struct cleanup *old_chain = make_cleanup_py_xdecref (locals_iter);
if (locals_iter == NULL)
goto locals_error;
make_cleanup_ui_out_list_begin_end (out, "locals");
if (locals_iter != Py_None)
if (enumerate_locals (locals_iter, out, indent, args_type,
0, frame) == EXT_LANG_BT_ERROR)
goto locals_error;
do_cleanups (old_chain);
return EXT_LANG_BT_OK;
locals_error:
do_cleanups (old_chain);
return EXT_LANG_BT_ERROR;
}
/* Helper function for printing frame arguments. This function
largely just creates the wrapping tuple, and calls enumerate_args.
Returns EXT_LANG_BT_ERROR on error, with any GDB exceptions converted to
a Python exception, or EXT_LANG_BT_OK on success. */
static enum ext_lang_bt_status
py_print_args (PyObject *filter,
struct ui_out *out,
enum ext_lang_frame_args args_type,
struct frame_info *frame)
{
PyObject *args_iter = get_py_iter_from_func (filter, "frame_args");
struct cleanup *old_chain = make_cleanup_py_xdecref (args_iter);
if (args_iter == NULL)
goto args_error;
make_cleanup_ui_out_list_begin_end (out, "args");
TRY
{
annotate_frame_args ();
if (! ui_out_is_mi_like_p (out))
ui_out_text (out, " (");
}
CATCH (except, RETURN_MASK_ALL)
{
gdbpy_convert_exception (except);
goto args_error;
}
END_CATCH
if (args_iter != Py_None)
if (enumerate_args (args_iter, out, args_type, 0, frame)
== EXT_LANG_BT_ERROR)
goto args_error;
TRY
{
if (! ui_out_is_mi_like_p (out))
ui_out_text (out, ")");
}
CATCH (except, RETURN_MASK_ALL)
{
gdbpy_convert_exception (except);
goto args_error;
}
END_CATCH
do_cleanups (old_chain);