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
|
/* Process record and replay target for GDB, the GNU debugger.
Copyright (C) 2008-2014 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 "gdbcmd.h"
#include "completer.h"
#include "record.h"
#include "observer.h"
#include "inferior.h"
#include "common/common-utils.h"
#include "cli/cli-utils.h"
#include "disasm.h"
#include <ctype.h>
/* This is the debug switch for process record. */
unsigned int record_debug = 0;
/* The number of instructions to print in "record instruction-history". */
static unsigned int record_insn_history_size = 10;
/* The variable registered as control variable in the "record
instruction-history" command. Necessary for extra input
validation. */
static unsigned int record_insn_history_size_setshow_var;
/* The number of functions to print in "record function-call-history". */
static unsigned int record_call_history_size = 10;
/* The variable registered as control variable in the "record
call-history" command. Necessary for extra input validation. */
static unsigned int record_call_history_size_setshow_var;
struct cmd_list_element *record_cmdlist = NULL;
struct cmd_list_element *record_goto_cmdlist = NULL;
struct cmd_list_element *set_record_cmdlist = NULL;
struct cmd_list_element *show_record_cmdlist = NULL;
struct cmd_list_element *info_record_cmdlist = NULL;
#define DEBUG(msg, args...) \
if (record_debug) \
fprintf_unfiltered (gdb_stdlog, "record: " msg "\n", ##args)
/* Find the record target in the target stack. */
static struct target_ops *
find_record_target (void)
{
struct target_ops *t;
for (t = current_target.beneath; t != NULL; t = t->beneath)
if (t->to_stratum == record_stratum)
return t;
return NULL;
}
/* Check that recording is active. Throw an error, if it isn't. */
static struct target_ops *
require_record_target (void)
{
struct target_ops *t;
t = find_record_target ();
if (t == NULL)
error (_("No record target is currently active.\n"
"Use one of the \"target record-<tab><tab>\" commands first."));
return t;
}
/* See record.h. */
int
record_read_memory (struct gdbarch *gdbarch,
CORE_ADDR memaddr, gdb_byte *myaddr,
ssize_t len)
{
int ret = target_read_memory (memaddr, myaddr, len);
if (ret != 0)
DEBUG ("error reading memory at addr %s len = %ld.\n",
paddress (gdbarch, memaddr), (long) len);
return ret;
}
/* Stop recording. */
static void
record_stop (struct target_ops *t)
{
DEBUG ("stop %s", t->to_shortname);
if (t->to_stop_recording != NULL)
t->to_stop_recording ();
}
/* Unpush the record target. */
static void
record_unpush (struct target_ops *t)
{
DEBUG ("unpush %s", t->to_shortname);
unpush_target (t);
}
/* See record.h. */
void
record_disconnect (struct target_ops *t, char *args, int from_tty)
{
gdb_assert (t->to_stratum == record_stratum);
DEBUG ("disconnect %s", t->to_shortname);
record_stop (t);
record_unpush (t);
target_disconnect (args, from_tty);
}
/* See record.h. */
void
record_detach (struct target_ops *t, const char *args, int from_tty)
{
gdb_assert (t->to_stratum == record_stratum);
DEBUG ("detach %s", t->to_shortname);
record_stop (t);
record_unpush (t);
target_detach (args, from_tty);
}
/* See record.h. */
void
record_mourn_inferior (struct target_ops *t)
{
gdb_assert (t->to_stratum == record_stratum);
DEBUG ("mourn inferior %s", t->to_shortname);
/* It is safer to not stop recording. Resources will be freed when
threads are discarded. */
record_unpush (t);
target_mourn_inferior ();
}
/* See record.h. */
void
record_kill (struct target_ops *t)
{
gdb_assert (t->to_stratum == record_stratum);
DEBUG ("kill %s", t->to_shortname);
/* It is safer to not stop recording. Resources will be freed when
threads are discarded. */
record_unpush (t);
target_kill ();
}
/* Implement "show record debug" command. */
static void
show_record_debug (struct ui_file *file, int from_tty,
struct cmd_list_element *c, const char *value)
{
fprintf_filtered (file, _("Debugging of process record target is %s.\n"),
value);
}
/* Alias for "target record". */
static void
cmd_record_start (char *args, int from_tty)
{
execute_command ("target record-full", from_tty);
}
/* Truncate the record log from the present point
of replay until the end. */
static void
cmd_record_delete (char *args, int from_tty)
{
require_record_target ();
if (!target_record_is_replaying ())
{
printf_unfiltered (_("Already at end of record list.\n"));
return;
}
if (!target_supports_delete_record ())
{
printf_unfiltered (_("The current record target does not support "
"this operation.\n"));
return;
}
if (!from_tty || query (_("Delete the log from this point forward "
"and begin to record the running message "
"at current PC?")))
target_delete_record ();
}
/* Implement the "stoprecord" or "record stop" command. */
static void
cmd_record_stop (char *args, int from_tty)
{
struct target_ops *t;
t = require_record_target ();
record_stop (t);
record_unpush (t);
printf_unfiltered (_("Process record is stopped and all execution "
"logs are deleted.\n"));
observer_notify_record_changed (current_inferior (), 0);
}
/* The "set record" command. */
static void
set_record_command (char *args, int from_tty)
{
printf_unfiltered (_("\"set record\" must be followed "
"by an apporpriate subcommand.\n"));
help_list (set_record_cmdlist, "set record ", all_commands, gdb_stdout);
}
/* The "show record" command. */
static void
show_record_command (char *args, int from_tty)
{
cmd_show_list (show_record_cmdlist, from_tty, "");
}
/* The "info record" command. */
static void
info_record_command (char *args, int from_tty)
{
struct target_ops *t;
t = find_record_target ();
if (t == NULL)
{
printf_filtered (_("No record target is currently active.\n"));
return;
}
printf_filtered (_("Active record target: %s\n"), t->to_shortname);
if (t->to_info_record != NULL)
t->to_info_record ();
}
/* The "record save" command. */
static void
cmd_record_save (char *args, int from_tty)
{
char *recfilename, recfilename_buffer[40];
require_record_target ();
if (args != NULL && *args != 0)
recfilename = args;
else
{
/* Default recfile name is "gdb_record.PID". */
xsnprintf (recfilename_buffer, sizeof (recfilename_buffer),
"gdb_record.%d", ptid_get_pid (inferior_ptid));
recfilename = recfilename_buffer;
}
target_save_record (recfilename);
}
/* "record goto" command. Argument is an instruction number,
as given by "info record".
Rewinds the recording (forward or backward) to the given instruction. */
void
cmd_record_goto (char *arg, int from_tty)
{
ULONGEST insn;
if (arg == NULL || *arg == '\0')
error (_("Command requires an argument (insn number to go to)."));
insn = parse_and_eval_long (arg);
require_record_target ();
target_goto_record (insn);
}
/* The "record goto begin" command. */
static void
cmd_record_goto_begin (char *arg, int from_tty)
{
if (arg != NULL && *arg != '\0')
error (_("Junk after argument: %s."), arg);
require_record_target ();
target_goto_record_begin ();
}
/* The "record goto end" command. */
static void
cmd_record_goto_end (char *arg, int from_tty)
{
if (arg != NULL && *arg != '\0')
error (_("Junk after argument: %s."), arg);
require_record_target ();
target_goto_record_end ();
}
/* Read an instruction number from an argument string. */
static ULONGEST
get_insn_number (char **arg)
{
ULONGEST number;
const char *begin, *end, *pos;
begin = *arg;
pos = skip_spaces_const (begin);
if (!isdigit (*pos))
error (_("Expected positive number, got: %s."), pos);
number = strtoulst (pos, &end, 10);
*arg += (end - begin);
return number;
}
/* Read a context size from an argument string. */
static int
get_context_size (char **arg)
{
char *pos;
int number;
pos = skip_spaces (*arg);
if (!isdigit (*pos))
error (_("Expected positive number, got: %s."), pos);
return strtol (pos, arg, 10);
}
/* Complain about junk at the end of an argument string. */
static void
no_chunk (char *arg)
{
if (*arg != 0)
error (_("Junk after argument: %s."), arg);
}
/* Read instruction-history modifiers from an argument string. */
static int
get_insn_history_modifiers (char **arg)
{
int modifiers;
char *args;
modifiers = 0;
args = *arg;
if (args == NULL)
return modifiers;
while (*args == '/')
{
++args;
if (*args == '\0')
error (_("Missing modifier."));
for (; *args; ++args)
{
if (isspace (*args))
break;
if (*args == '/')
continue;
switch (*args)
{
case 'm':
modifiers |= DISASSEMBLY_SOURCE;
modifiers |= DISASSEMBLY_FILENAME;
break;
case 'r':
modifiers |= DISASSEMBLY_RAW_INSN;
break;
case 'f':
modifiers |= DISASSEMBLY_OMIT_FNAME;
break;
case 'p':
modifiers |= DISASSEMBLY_OMIT_PC;
break;
default:
error (_("Invalid modifier: %c."), *args);
}
}
args = skip_spaces (args);
}
/* Update the argument string. */
*arg = args;
return modifiers;
}
/* The "set record instruction-history-size / set record
function-call-history-size" commands are unsigned, with UINT_MAX
meaning unlimited. The target interfaces works with signed int
though, to indicate direction, so map "unlimited" to INT_MAX, which
is about the same as unlimited in practice. If the user does have
a log that huge, she can fetch it in chunks across several requests,
but she'll likely have other problems first... */
static int
command_size_to_target_size (unsigned int size)
{
gdb_assert (size <= INT_MAX || size == UINT_MAX);
if (size == UINT_MAX)
return INT_MAX;
else
return size;
}
/* The "record instruction-history" command. */
static void
cmd_record_insn_history (char *arg, int from_tty)
{
int flags, size;
require_record_target ();
flags = get_insn_history_modifiers (&arg);
size = command_size_to_target_size (record_insn_history_size);
if (arg == NULL || *arg == 0 || strcmp (arg, "+") == 0)
target_insn_history (size, flags);
else if (strcmp (arg, "-") == 0)
target_insn_history (-size, flags);
else
{
ULONGEST begin, end;
begin = get_insn_number (&arg);
if (*arg == ',')
{
arg = skip_spaces (++arg);
if (*arg == '+')
{
arg += 1;
size = get_context_size (&arg);
no_chunk (arg);
target_insn_history_from (begin, size, flags);
}
else if (*arg == '-')
{
arg += 1;
size = get_context_size (&arg);
no_chunk (arg);
target_insn_history_from (begin, -size, flags);
}
else
{
end = get_insn_number (&arg);
no_chunk (arg);
target_insn_history_range (begin, end, flags);
}
}
else
{
no_chunk (arg);
target_insn_history_from (begin, size, flags);
}
dont_repeat ();
}
}
/* Read function-call-history modifiers from an argument string. */
static int
get_call_history_modifiers (char **arg)
{
int modifiers;
char *args;
modifiers = 0;
args = *arg;
if (args == NULL)
return modifiers;
while (*args == '/')
{
++args;
if (*args == '\0')
error (_("Missing modifier."));
for (; *args; ++args)
{
if (isspace (*args))
break;
if (*args == '/')
continue;
switch (*args)
{
case 'l':
modifiers |= RECORD_PRINT_SRC_LINE;
break;
case 'i':
modifiers |= RECORD_PRINT_INSN_RANGE;
break;
default:
error (_("Invalid modifier: %c."), *args);
}
}
args = skip_spaces (args);
}
/* Update the argument string. */
*arg = args;
return modifiers;
}
/* The "record function-call-history" command. */
static void
cmd_record_call_history (char *arg, int from_tty)
{
int flags, size;
require_record_target ();
flags = get_call_history_modifiers (&arg);
size = command_size_to_target_size (record_call_history_size);
if (arg == NULL || *arg == 0 || strcmp (arg, "+") == 0)
target_call_history (size, flags);
else if (strcmp (arg, "-") == 0)
target_call_history (-size, flags);
else
{
ULONGEST begin, end;
begin = get_insn_number (&arg);
if (*arg == ',')
{
arg = skip_spaces (++arg);
if (*arg == '+')
{
arg += 1;
size = get_context_size (&arg);
no_chunk (arg);
target_call_history_from (begin, size, flags);
}
else if (*arg == '-')
{
arg += 1;
size = get_context_size (&arg);
no_chunk (arg);
target_call_history_from (begin, -size, flags);
}
else
{
end = get_insn_number (&arg);
no_chunk (arg);
target_call_history_range (begin, end, flags);
}
}
else
{
no_chunk (arg);
target_call_history_from (begin, size, flags);
}
dont_repeat ();
}
}
/* Helper for "set record instruction-history-size" and "set record
function-call-history-size" input validation. COMMAND_VAR is the
variable registered in the command as control variable. *SETTING
is the real setting the command allows changing. */
static void
validate_history_size (unsigned int *command_var, unsigned int *setting)
{
if (*command_var != UINT_MAX && *command_var > INT_MAX)
{
unsigned int new_value = *command_var;
/* Restore previous value. */
*command_var = *setting;
error (_("integer %u out of range"), new_value);
}
/* Commit new value. */
*setting = *command_var;
}
/* Called by do_setshow_command. We only want values in the
[0..INT_MAX] range, while the command's machinery accepts
[0..UINT_MAX]. See command_size_to_target_size. */
static void
set_record_insn_history_size (char *args, int from_tty,
struct cmd_list_element *c)
{
validate_history_size (&record_insn_history_size_setshow_var,
&record_insn_history_size);
}
/* Called by do_setshow_command. We only want values in the
[0..INT_MAX] range, while the command's machinery accepts
[0..UINT_MAX]. See command_size_to_target_size. */
static void
set_record_call_history_size (char *args, int from_tty,
struct cmd_list_element *c)
{
validate_history_size (&record_call_history_size_setshow_var,
&record_call_history_size);
}
/* Provide a prototype to silence -Wmissing-prototypes. */
extern initialize_file_ftype _initialize_record;
void
_initialize_record (void)
{
struct cmd_list_element *c;
add_setshow_zuinteger_cmd ("record", no_class, &record_debug,
_("Set debugging of record/replay feature."),
_("Show debugging of record/replay feature."),
_("When enabled, debugging output for "
"record/replay feature is displayed."),
NULL, show_record_debug, &setdebuglist,
&showdebuglist);
add_setshow_uinteger_cmd ("instruction-history-size", no_class,
&record_insn_history_size_setshow_var, _("\
Set number of instructions to print in \"record instruction-history\"."), _("\
Show number of instructions to print in \"record instruction-history\"."), _("\
A size of \"unlimited\" means unlimited instructions. The default is 10."),
set_record_insn_history_size, NULL,
&set_record_cmdlist, &show_record_cmdlist);
add_setshow_uinteger_cmd ("function-call-history-size", no_class,
&record_call_history_size_setshow_var, _("\
Set number of function to print in \"record function-call-history\"."), _("\
Show number of functions to print in \"record function-call-history\"."), _("\
A size of \"unlimited\" means unlimited lines. The default is 10."),
set_record_call_history_size, NULL,
&set_record_cmdlist, &show_record_cmdlist);
c = add_prefix_cmd ("record", class_obscure, cmd_record_start,
_("Start recording."),
&record_cmdlist, "record ", 0, &cmdlist);
set_cmd_completer (c, filename_completer);
add_com_alias ("rec", "record", class_obscure, 1);
add_prefix_cmd ("record", class_support, set_record_command,
_("Set record options"), &set_record_cmdlist,
"set record ", 0, &setlist);
add_alias_cmd ("rec", "record", class_obscure, 1, &setlist);
add_prefix_cmd ("record", class_support, show_record_command,
_("Show record options"), &show_record_cmdlist,
"show record ", 0, &showlist);
add_alias_cmd ("rec", "record", class_obscure, 1, &showlist);
add_prefix_cmd ("record", class_support, info_record_command,
_("Info record options"), &info_record_cmdlist,
"info record ", 0, &infolist);
add_alias_cmd ("rec", "record", class_obscure, 1, &infolist);
c = add_cmd ("save", class_obscure, cmd_record_save,
_("Save the execution log to a file.\n\
Argument is optional filename.\n\
Default filename is 'gdb_record.<process_id>'."),
&record_cmdlist);
set_cmd_completer (c, filename_completer);
add_cmd ("delete", class_obscure, cmd_record_delete,
_("Delete the rest of execution log and start recording it anew."),
&record_cmdlist);
add_alias_cmd ("d", "delete", class_obscure, 1, &record_cmdlist);
add_alias_cmd ("del", "delete", class_obscure, 1, &record_cmdlist);
add_cmd ("stop", class_obscure, cmd_record_stop,
_("Stop the record/replay target."),
&record_cmdlist);
add_alias_cmd ("s", "stop", class_obscure, 1, &record_cmdlist);
add_prefix_cmd ("goto", class_obscure, cmd_record_goto, _("\
Restore the program to its state at instruction number N.\n\
Argument is instruction number, as shown by 'info record'."),
&record_goto_cmdlist, "record goto ", 1, &record_cmdlist);
add_cmd ("begin", class_obscure, cmd_record_goto_begin,
_("Go to the beginning of the execution log."),
&record_goto_cmdlist);
add_alias_cmd ("start", "begin", class_obscure, 1, &record_goto_cmdlist);
add_cmd ("end", class_obscure, cmd_record_goto_end,
_("Go to the end of the execution log."),
&record_goto_cmdlist);
add_cmd ("instruction-history", class_obscure, cmd_record_insn_history, _("\
Print disassembled instructions stored in the execution log.\n\
With a /m modifier, source lines are included (if available).\n\
With a /r modifier, raw instructions in hex are included.\n\
With a /f modifier, function names are omitted.\n\
With a /p modifier, current position markers are omitted.\n\
With no argument, disassembles ten more instructions after the previous \
disassembly.\n\
\"record instruction-history -\" disassembles ten instructions before a \
previous disassembly.\n\
One argument specifies an instruction number as shown by 'info record', and \
ten instructions are disassembled after that instruction.\n\
Two arguments with comma between them specify starting and ending instruction \
numbers to disassemble.\n\
If the second argument is preceded by '+' or '-', it specifies the distance \
from the first argument.\n\
The number of instructions to disassemble can be defined with \"set record \
instruction-history-size\"."),
&record_cmdlist);
add_cmd ("function-call-history", class_obscure, cmd_record_call_history, _("\
Prints the execution history at function granularity.\n\
It prints one line for each sequence of instructions that belong to the same \
function.\n\
Without modifiers, it prints the function name.\n\
With a /l modifier, the source file and line number range is included.\n\
With a /i modifier, the instruction number range is included.\n\
With no argument, prints ten more lines after the previous ten-line print.\n\
\"record function-call-history -\" prints ten lines before a previous ten-line \
print.\n\
One argument specifies a function number as shown by 'info record', and \
ten lines are printed after that function.\n\
Two arguments with comma between them specify a range of functions to print.\n\
If the second argument is preceded by '+' or '-', it specifies the distance \
from the first argument.\n\
The number of functions to print can be defined with \"set record \
function-call-history-size\"."),
&record_cmdlist);
/* Sync command control variables. */
record_insn_history_size_setshow_var = record_insn_history_size;
record_call_history_size_setshow_var = record_call_history_size;
}
|