1 /* Dump-to-file commands, for GDB, the GNU debugger.
3 Copyright (c) 2002, 2005, 2007, 2008, 2009, 2010, 2011
4 Free Software Foundation, Inc.
6 Contributed by Red Hat.
8 This file is part of GDB.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>. */
24 #include "gdb_string.h"
25 #include "cli/cli-decode.h"
26 #include "cli/cli-cmds.h"
28 #include "completer.h"
29 #include "cli/cli-dump.h"
30 #include "gdb_assert.h"
33 #include "readline/readline.h"
35 #include "cli/cli-utils.h"
37 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
41 scan_expression_with_cleanup (char **cmd
, const char *def
)
43 if ((*cmd
) == NULL
|| (**cmd
) == '\0')
45 char *exp
= xstrdup (def
);
47 make_cleanup (xfree
, exp
);
55 end
= (*cmd
) + strcspn (*cmd
, " \t");
56 exp
= savestring ((*cmd
), end
- (*cmd
));
57 make_cleanup (xfree
, exp
);
58 (*cmd
) = skip_spaces (end
);
65 scan_filename_with_cleanup (char **cmd
, const char *defname
)
70 /* FIXME: Need to get the ``/a(ppend)'' flag from somewhere. */
76 error (_("Missing filename."));
77 filename
= xstrdup (defname
);
78 make_cleanup (xfree
, filename
);
82 /* FIXME: should parse a possibly quoted string. */
85 (*cmd
) = skip_spaces (*cmd
);
86 end
= *cmd
+ strcspn (*cmd
, " \t");
87 filename
= savestring ((*cmd
), end
- (*cmd
));
88 make_cleanup (xfree
, filename
);
89 (*cmd
) = skip_spaces (end
);
91 gdb_assert (filename
!= NULL
);
93 fullname
= tilde_expand (filename
);
94 make_cleanup (xfree
, fullname
);
100 fopen_with_cleanup (const char *filename
, const char *mode
)
102 FILE *file
= fopen (filename
, mode
);
105 perror_with_name (filename
);
106 make_cleanup_fclose (file
);
111 bfd_openr_with_cleanup (const char *filename
, const char *target
)
115 ibfd
= bfd_openr (filename
, target
);
117 error (_("Failed to open %s: %s."), filename
,
118 bfd_errmsg (bfd_get_error ()));
120 make_cleanup_bfd_close (ibfd
);
121 if (!bfd_check_format (ibfd
, bfd_object
))
122 error (_("'%s' is not a recognized file format."), filename
);
128 bfd_openw_with_cleanup (const char *filename
, const char *target
,
133 if (*mode
== 'w') /* Write: create new file */
135 obfd
= bfd_openw (filename
, target
);
137 error (_("Failed to open %s: %s."), filename
,
138 bfd_errmsg (bfd_get_error ()));
139 make_cleanup_bfd_close (obfd
);
140 if (!bfd_set_format (obfd
, bfd_object
))
141 error (_("bfd_openw_with_cleanup: %s."), bfd_errmsg (bfd_get_error ()));
143 else if (*mode
== 'a') /* Append to existing file. */
144 { /* FIXME -- doesn't work... */
145 error (_("bfd_openw does not work with append."));
148 error (_("bfd_openw_with_cleanup: unknown mode %s."), mode
);
153 struct cmd_list_element
*dump_cmdlist
;
154 struct cmd_list_element
*append_cmdlist
;
155 struct cmd_list_element
*srec_cmdlist
;
156 struct cmd_list_element
*ihex_cmdlist
;
157 struct cmd_list_element
*tekhex_cmdlist
;
158 struct cmd_list_element
*binary_dump_cmdlist
;
159 struct cmd_list_element
*binary_append_cmdlist
;
162 dump_command (char *cmd
, int from_tty
)
164 printf_unfiltered (_("\"dump\" must be followed by a subcommand.\n\n"));
165 help_list (dump_cmdlist
, "dump ", -1, gdb_stdout
);
169 append_command (char *cmd
, int from_tty
)
171 printf_unfiltered (_("\"append\" must be followed by a subcommand.\n\n"));
172 help_list (dump_cmdlist
, "append ", -1, gdb_stdout
);
176 dump_binary_file (const char *filename
, const char *mode
,
177 const bfd_byte
*buf
, int len
)
182 file
= fopen_with_cleanup (filename
, mode
);
183 status
= fwrite (buf
, len
, 1, file
);
185 perror_with_name (filename
);
189 dump_bfd_file (const char *filename
, const char *mode
,
190 const char *target
, CORE_ADDR vaddr
,
191 const bfd_byte
*buf
, int len
)
196 obfd
= bfd_openw_with_cleanup (filename
, target
, mode
);
197 osection
= bfd_make_section_anyway (obfd
, ".newsec");
198 bfd_set_section_size (obfd
, osection
, len
);
199 bfd_set_section_vma (obfd
, osection
, vaddr
);
200 bfd_set_section_alignment (obfd
, osection
, 0);
201 bfd_set_section_flags (obfd
, osection
, (SEC_HAS_CONTENTS
204 osection
->entsize
= 0;
205 bfd_set_section_contents (obfd
, osection
, buf
, 0, len
);
209 dump_memory_to_file (char *cmd
, char *mode
, char *file_format
)
211 struct cleanup
*old_cleanups
= make_cleanup (null_cleanup
, NULL
);
221 filename
= scan_filename_with_cleanup (&cmd
, NULL
);
223 /* Find the low address. */
224 if (cmd
== NULL
|| *cmd
== '\0')
225 error (_("Missing start address."));
226 lo_exp
= scan_expression_with_cleanup (&cmd
, NULL
);
228 /* Find the second address - rest of line. */
229 if (cmd
== NULL
|| *cmd
== '\0')
230 error (_("Missing stop address."));
233 lo
= parse_and_eval_address (lo_exp
);
234 hi
= parse_and_eval_address (hi_exp
);
236 error (_("Invalid memory address range (start >= end)."));
239 /* FIXME: Should use read_memory_partial() and a magic blocking
241 buf
= xmalloc (count
);
242 make_cleanup (xfree
, buf
);
243 read_memory (lo
, buf
, count
);
245 /* Have everything. Open/write the data. */
246 if (file_format
== NULL
|| strcmp (file_format
, "binary") == 0)
248 dump_binary_file (filename
, mode
, buf
, count
);
252 dump_bfd_file (filename
, mode
, file_format
, lo
, buf
, count
);
255 do_cleanups (old_cleanups
);
259 dump_memory_command (char *cmd
, char *mode
)
261 dump_memory_to_file (cmd
, mode
, "binary");
265 dump_value_to_file (char *cmd
, char *mode
, char *file_format
)
267 struct cleanup
*old_cleanups
= make_cleanup (null_cleanup
, NULL
);
272 filename
= scan_filename_with_cleanup (&cmd
, NULL
);
274 /* Find the value. */
275 if (cmd
== NULL
|| *cmd
== '\0')
276 error (_("No value to %s."), *mode
== 'a' ? "append" : "dump");
277 val
= parse_and_eval (cmd
);
279 error (_("Invalid expression."));
281 /* Have everything. Open/write the data. */
282 if (file_format
== NULL
|| strcmp (file_format
, "binary") == 0)
284 dump_binary_file (filename
, mode
, value_contents (val
),
285 TYPE_LENGTH (value_type (val
)));
291 if (VALUE_LVAL (val
))
293 vaddr
= value_address (val
);
298 warning (_("value is not an lval: address assumed to be zero"));
301 dump_bfd_file (filename
, mode
, file_format
, vaddr
,
302 value_contents (val
),
303 TYPE_LENGTH (value_type (val
)));
306 do_cleanups (old_cleanups
);
310 dump_value_command (char *cmd
, char *mode
)
312 dump_value_to_file (cmd
, mode
, "binary");
316 dump_srec_memory (char *args
, int from_tty
)
318 dump_memory_to_file (args
, FOPEN_WB
, "srec");
322 dump_srec_value (char *args
, int from_tty
)
324 dump_value_to_file (args
, FOPEN_WB
, "srec");
328 dump_ihex_memory (char *args
, int from_tty
)
330 dump_memory_to_file (args
, FOPEN_WB
, "ihex");
334 dump_ihex_value (char *args
, int from_tty
)
336 dump_value_to_file (args
, FOPEN_WB
, "ihex");
340 dump_tekhex_memory (char *args
, int from_tty
)
342 dump_memory_to_file (args
, FOPEN_WB
, "tekhex");
346 dump_tekhex_value (char *args
, int from_tty
)
348 dump_value_to_file (args
, FOPEN_WB
, "tekhex");
352 dump_binary_memory (char *args
, int from_tty
)
354 dump_memory_to_file (args
, FOPEN_WB
, "binary");
358 dump_binary_value (char *args
, int from_tty
)
360 dump_value_to_file (args
, FOPEN_WB
, "binary");
364 append_binary_memory (char *args
, int from_tty
)
366 dump_memory_to_file (args
, FOPEN_AB
, "binary");
370 append_binary_value (char *args
, int from_tty
)
372 dump_value_to_file (args
, FOPEN_AB
, "binary");
377 void (*func
) (char *cmd
, char *mode
);
382 call_dump_func (struct cmd_list_element
*c
, char *args
, int from_tty
)
384 struct dump_context
*d
= get_cmd_context (c
);
386 d
->func (args
, d
->mode
);
390 add_dump_command (char *name
, void (*func
) (char *args
, char *mode
),
394 struct cmd_list_element
*c
;
395 struct dump_context
*d
;
397 c
= add_cmd (name
, all_commands
, NULL
, descr
, &dump_cmdlist
);
398 c
->completer
= filename_completer
;
399 d
= XMALLOC (struct dump_context
);
402 set_cmd_context (c
, d
);
403 c
->func
= call_dump_func
;
405 c
= add_cmd (name
, all_commands
, NULL
, descr
, &append_cmdlist
);
406 c
->completer
= filename_completer
;
407 d
= XMALLOC (struct dump_context
);
410 set_cmd_context (c
, d
);
411 c
->func
= call_dump_func
;
413 /* Replace "Dump " at start of docstring with "Append " (borrowed
414 from [deleted] deprecated_add_show_from_set). */
415 if ( c
->doc
[0] == 'W'
421 c
->doc
= concat ("Append ", c
->doc
+ 6, (char *)NULL
);
424 /* Opaque data for restore_section_callback. */
425 struct callback_data
{
426 CORE_ADDR load_offset
;
427 CORE_ADDR load_start
;
431 /* Function: restore_section_callback.
433 Callback function for bfd_map_over_sections.
434 Selectively loads the sections into memory. */
437 restore_section_callback (bfd
*ibfd
, asection
*isec
, void *args
)
439 struct callback_data
*data
= args
;
440 bfd_vma sec_start
= bfd_section_vma (ibfd
, isec
);
441 bfd_size_type size
= bfd_section_size (ibfd
, isec
);
442 bfd_vma sec_end
= sec_start
+ size
;
443 bfd_size_type sec_offset
= 0;
444 bfd_size_type sec_load_count
= size
;
445 struct cleanup
*old_chain
;
449 /* Ignore non-loadable sections, eg. from elf files. */
450 if (!(bfd_get_section_flags (ibfd
, isec
) & SEC_LOAD
))
453 /* Does the section overlap with the desired restore range? */
454 if (sec_end
<= data
->load_start
455 || (data
->load_end
> 0 && sec_start
>= data
->load_end
))
457 /* No, no useable data in this section. */
458 printf_filtered (_("skipping section %s...\n"),
459 bfd_section_name (ibfd
, isec
));
463 /* Compare section address range with user-requested
464 address range (if any). Compute where the actual
465 transfer should start and end. */
466 if (sec_start
< data
->load_start
)
467 sec_offset
= data
->load_start
- sec_start
;
468 /* Size of a partial transfer. */
469 sec_load_count
-= sec_offset
;
470 if (data
->load_end
> 0 && sec_end
> data
->load_end
)
471 sec_load_count
-= sec_end
- data
->load_end
;
474 buf
= xmalloc (size
);
475 old_chain
= make_cleanup (xfree
, buf
);
476 if (!bfd_get_section_contents (ibfd
, isec
, buf
, 0, size
))
477 error (_("Failed to read bfd file %s: '%s'."), bfd_get_filename (ibfd
),
478 bfd_errmsg (bfd_get_error ()));
480 printf_filtered ("Restoring section %s (0x%lx to 0x%lx)",
481 bfd_section_name (ibfd
, isec
),
482 (unsigned long) sec_start
,
483 (unsigned long) sec_end
);
485 if (data
->load_offset
!= 0 || data
->load_start
!= 0 || data
->load_end
!= 0)
486 printf_filtered (" into memory (%s to %s)\n",
487 paddress (target_gdbarch
,
488 (unsigned long) sec_start
489 + sec_offset
+ data
->load_offset
),
490 paddress (target_gdbarch
,
491 (unsigned long) sec_start
+ sec_offset
492 + data
->load_offset
+ sec_load_count
));
494 puts_filtered ("\n");
496 /* Write the data. */
497 ret
= target_write_memory (sec_start
+ sec_offset
+ data
->load_offset
,
498 buf
+ sec_offset
, sec_load_count
);
500 warning (_("restore: memory write failed (%s)."), safe_strerror (ret
));
501 do_cleanups (old_chain
);
506 restore_binary_file (char *filename
, struct callback_data
*data
)
508 FILE *file
= fopen_with_cleanup (filename
, FOPEN_RB
);
512 /* Get the file size for reading. */
513 if (fseek (file
, 0, SEEK_END
) == 0)
517 perror_with_name (filename
);
520 perror_with_name (filename
);
522 if (len
<= data
->load_start
)
523 error (_("Start address is greater than length of binary file %s."),
526 /* Chop off "len" if it exceeds the requested load_end addr. */
527 if (data
->load_end
!= 0 && data
->load_end
< len
)
528 len
= data
->load_end
;
529 /* Chop off "len" if the requested load_start addr skips some bytes. */
530 if (data
->load_start
> 0)
531 len
-= data
->load_start
;
534 ("Restoring binary file %s into memory (0x%lx to 0x%lx)\n",
536 (unsigned long) (data
->load_start
+ data
->load_offset
),
537 (unsigned long) (data
->load_start
+ data
->load_offset
+ len
));
539 /* Now set the file pos to the requested load start pos. */
540 if (fseek (file
, data
->load_start
, SEEK_SET
) != 0)
541 perror_with_name (filename
);
543 /* Now allocate a buffer and read the file contents. */
545 make_cleanup (xfree
, buf
);
546 if (fread (buf
, 1, len
, file
) != len
)
547 perror_with_name (filename
);
549 /* Now write the buffer into target memory. */
550 len
= target_write_memory (data
->load_start
+ data
->load_offset
, buf
, len
);
552 warning (_("restore: memory write failed (%s)."), safe_strerror (len
));
557 restore_command (char *args
, int from_tty
)
560 struct callback_data data
;
564 if (!target_has_execution
)
567 data
.load_offset
= 0;
571 /* Parse the input arguments. First is filename (required). */
572 filename
= scan_filename_with_cleanup (&args
, NULL
);
573 if (args
!= NULL
&& *args
!= '\0')
575 char *binary_string
= "binary";
577 /* Look for optional "binary" flag. */
578 if (strncmp (args
, binary_string
, strlen (binary_string
)) == 0)
581 args
+= strlen (binary_string
);
582 args
= skip_spaces (args
);
584 /* Parse offset (optional). */
585 if (args
!= NULL
&& *args
!= '\0')
587 parse_and_eval_address (scan_expression_with_cleanup (&args
, NULL
));
588 if (args
!= NULL
&& *args
!= '\0')
590 /* Parse start address (optional). */
592 parse_and_eval_long (scan_expression_with_cleanup (&args
, NULL
));
593 if (args
!= NULL
&& *args
!= '\0')
595 /* Parse end address (optional). */
596 data
.load_end
= parse_and_eval_long (args
);
597 if (data
.load_end
<= data
.load_start
)
598 error (_("Start must be less than end."));
604 printf_filtered ("Restore file %s offset 0x%lx start 0x%lx end 0x%lx\n",
605 filename
, (unsigned long) data
.load_offset
,
606 (unsigned long) data
.load_start
,
607 (unsigned long) data
.load_end
);
611 restore_binary_file (filename
, &data
);
615 /* Open the file for loading. */
616 ibfd
= bfd_openr_with_cleanup (filename
, NULL
);
618 /* Process the sections. */
619 bfd_map_over_sections (ibfd
, restore_section_callback
, &data
);
625 srec_dump_command (char *cmd
, int from_tty
)
627 printf_unfiltered ("\"dump srec\" must be followed by a subcommand.\n");
628 help_list (srec_cmdlist
, "dump srec ", -1, gdb_stdout
);
632 ihex_dump_command (char *cmd
, int from_tty
)
634 printf_unfiltered ("\"dump ihex\" must be followed by a subcommand.\n");
635 help_list (ihex_cmdlist
, "dump ihex ", -1, gdb_stdout
);
639 tekhex_dump_command (char *cmd
, int from_tty
)
641 printf_unfiltered ("\"dump tekhex\" must be followed by a subcommand.\n");
642 help_list (tekhex_cmdlist
, "dump tekhex ", -1, gdb_stdout
);
646 binary_dump_command (char *cmd
, int from_tty
)
648 printf_unfiltered ("\"dump binary\" must be followed by a subcommand.\n");
649 help_list (binary_dump_cmdlist
, "dump binary ", -1, gdb_stdout
);
653 binary_append_command (char *cmd
, int from_tty
)
655 printf_unfiltered ("\"append binary\" must be followed by a subcommand.\n");
656 help_list (binary_append_cmdlist
, "append binary ", -1, gdb_stdout
);
659 extern initialize_file_ftype _initialize_cli_dump
; /* -Wmissing-prototypes */
662 _initialize_cli_dump (void)
664 struct cmd_list_element
*c
;
666 add_prefix_cmd ("dump", class_vars
, dump_command
,
667 _("Dump target code/data to a local file."),
668 &dump_cmdlist
, "dump ",
671 add_prefix_cmd ("append", class_vars
, append_command
,
672 _("Append target code/data to a local file."),
673 &append_cmdlist
, "append ",
677 add_dump_command ("memory", dump_memory_command
, "\
678 Write contents of memory to a raw binary file.\n\
679 Arguments are FILE START STOP. Writes the contents of memory within the\n\
680 range [START .. STOP) to the specifed FILE in raw target ordered bytes.");
682 add_dump_command ("value", dump_value_command
, "\
683 Write the value of an expression to a raw binary file.\n\
684 Arguments are FILE EXPRESSION. Writes the value of EXPRESSION to\n\
685 the specified FILE in raw target ordered bytes.");
687 add_prefix_cmd ("srec", all_commands
, srec_dump_command
,
688 _("Write target code/data to an srec file."),
689 &srec_cmdlist
, "dump srec ",
693 add_prefix_cmd ("ihex", all_commands
, ihex_dump_command
,
694 _("Write target code/data to an intel hex file."),
695 &ihex_cmdlist
, "dump ihex ",
699 add_prefix_cmd ("tekhex", all_commands
, tekhex_dump_command
,
700 _("Write target code/data to a tekhex file."),
701 &tekhex_cmdlist
, "dump tekhex ",
705 add_prefix_cmd ("binary", all_commands
, binary_dump_command
,
706 _("Write target code/data to a raw binary file."),
707 &binary_dump_cmdlist
, "dump binary ",
711 add_prefix_cmd ("binary", all_commands
, binary_append_command
,
712 _("Append target code/data to a raw binary file."),
713 &binary_append_cmdlist
, "append binary ",
717 add_cmd ("memory", all_commands
, dump_srec_memory
, _("\
718 Write contents of memory to an srec file.\n\
719 Arguments are FILE START STOP. Writes the contents of memory\n\
720 within the range [START .. STOP) to the specifed FILE in srec format."),
723 add_cmd ("value", all_commands
, dump_srec_value
, _("\
724 Write the value of an expression to an srec file.\n\
725 Arguments are FILE EXPRESSION. Writes the value of EXPRESSION\n\
726 to the specified FILE in srec format."),
729 add_cmd ("memory", all_commands
, dump_ihex_memory
, _("\
730 Write contents of memory to an ihex file.\n\
731 Arguments are FILE START STOP. Writes the contents of memory within\n\
732 the range [START .. STOP) to the specifed FILE in intel hex format."),
735 add_cmd ("value", all_commands
, dump_ihex_value
, _("\
736 Write the value of an expression to an ihex file.\n\
737 Arguments are FILE EXPRESSION. Writes the value of EXPRESSION\n\
738 to the specified FILE in intel hex format."),
741 add_cmd ("memory", all_commands
, dump_tekhex_memory
, _("\
742 Write contents of memory to a tekhex file.\n\
743 Arguments are FILE START STOP. Writes the contents of memory\n\
744 within the range [START .. STOP) to the specifed FILE in tekhex format."),
747 add_cmd ("value", all_commands
, dump_tekhex_value
, _("\
748 Write the value of an expression to a tekhex file.\n\
749 Arguments are FILE EXPRESSION. Writes the value of EXPRESSION\n\
750 to the specified FILE in tekhex format."),
753 add_cmd ("memory", all_commands
, dump_binary_memory
, _("\
754 Write contents of memory to a raw binary file.\n\
755 Arguments are FILE START STOP. Writes the contents of memory\n\
756 within the range [START .. STOP) to the specifed FILE in binary format."),
757 &binary_dump_cmdlist
);
759 add_cmd ("value", all_commands
, dump_binary_value
, _("\
760 Write the value of an expression to a raw binary file.\n\
761 Arguments are FILE EXPRESSION. Writes the value of EXPRESSION\n\
762 to the specified FILE in raw target ordered bytes."),
763 &binary_dump_cmdlist
);
765 add_cmd ("memory", all_commands
, append_binary_memory
, _("\
766 Append contents of memory to a raw binary file.\n\
767 Arguments are FILE START STOP. Writes the contents of memory within the\n\
768 range [START .. STOP) to the specifed FILE in raw target ordered bytes."),
769 &binary_append_cmdlist
);
771 add_cmd ("value", all_commands
, append_binary_value
, _("\
772 Append the value of an expression to a raw binary file.\n\
773 Arguments are FILE EXPRESSION. Writes the value of EXPRESSION\n\
774 to the specified FILE in raw target ordered bytes."),
775 &binary_append_cmdlist
);
777 c
= add_com ("restore", class_vars
, restore_command
, _("\
778 Restore the contents of FILE to target memory.\n\
779 Arguments are FILE OFFSET START END where all except FILE are optional.\n\
780 OFFSET will be added to the base address of the file (default zero).\n\
781 If START and END are given, only the file contents within that range\n\
782 (file relative) will be restored to target memory."));
783 c
->completer
= filename_completer
;
784 /* FIXME: completers for other commands. */