1 /* Dump-to-file commands, for GDB, the GNU debugger.
3 Copyright (c) 2002, 2005, 2007, 2008, 2009, 2010
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"
36 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
40 skip_spaces (char *chp
)
44 while (isspace (*chp
))
50 scan_expression_with_cleanup (char **cmd
, const char *def
)
52 if ((*cmd
) == NULL
|| (**cmd
) == '\0')
54 char *exp
= xstrdup (def
);
55 make_cleanup (xfree
, exp
);
63 end
= (*cmd
) + strcspn (*cmd
, " \t");
64 exp
= savestring ((*cmd
), end
- (*cmd
));
65 make_cleanup (xfree
, exp
);
66 (*cmd
) = skip_spaces (end
);
73 scan_filename_with_cleanup (char **cmd
, const char *defname
)
78 /* FIXME: Need to get the ``/a(ppend)'' flag from somewhere. */
84 error (_("Missing filename."));
85 filename
= xstrdup (defname
);
86 make_cleanup (xfree
, filename
);
90 /* FIXME: should parse a possibly quoted string. */
93 (*cmd
) = skip_spaces (*cmd
);
94 end
= *cmd
+ strcspn (*cmd
, " \t");
95 filename
= savestring ((*cmd
), end
- (*cmd
));
96 make_cleanup (xfree
, filename
);
97 (*cmd
) = skip_spaces (end
);
99 gdb_assert (filename
!= NULL
);
101 fullname
= tilde_expand (filename
);
102 make_cleanup (xfree
, fullname
);
108 fopen_with_cleanup (const char *filename
, const char *mode
)
110 FILE *file
= fopen (filename
, mode
);
112 perror_with_name (filename
);
113 make_cleanup_fclose (file
);
118 bfd_openr_with_cleanup (const char *filename
, const char *target
)
122 ibfd
= bfd_openr (filename
, target
);
124 error (_("Failed to open %s: %s."), filename
,
125 bfd_errmsg (bfd_get_error ()));
127 make_cleanup_bfd_close (ibfd
);
128 if (!bfd_check_format (ibfd
, bfd_object
))
129 error (_("'%s' is not a recognized file format."), filename
);
135 bfd_openw_with_cleanup (const char *filename
, const char *target
,
140 if (*mode
== 'w') /* Write: create new file */
142 obfd
= bfd_openw (filename
, target
);
144 error (_("Failed to open %s: %s."), filename
,
145 bfd_errmsg (bfd_get_error ()));
146 make_cleanup_bfd_close (obfd
);
147 if (!bfd_set_format (obfd
, bfd_object
))
148 error (_("bfd_openw_with_cleanup: %s."), bfd_errmsg (bfd_get_error ()));
150 else if (*mode
== 'a') /* Append to existing file */
151 { /* FIXME -- doesn't work... */
152 error (_("bfd_openw does not work with append."));
155 error (_("bfd_openw_with_cleanup: unknown mode %s."), mode
);
160 struct cmd_list_element
*dump_cmdlist
;
161 struct cmd_list_element
*append_cmdlist
;
162 struct cmd_list_element
*srec_cmdlist
;
163 struct cmd_list_element
*ihex_cmdlist
;
164 struct cmd_list_element
*tekhex_cmdlist
;
165 struct cmd_list_element
*binary_dump_cmdlist
;
166 struct cmd_list_element
*binary_append_cmdlist
;
169 dump_command (char *cmd
, int from_tty
)
171 printf_unfiltered (_("\"dump\" must be followed by a subcommand.\n\n"));
172 help_list (dump_cmdlist
, "dump ", -1, gdb_stdout
);
176 append_command (char *cmd
, int from_tty
)
178 printf_unfiltered (_("\"append\" must be followed by a subcommand.\n\n"));
179 help_list (dump_cmdlist
, "append ", -1, gdb_stdout
);
183 dump_binary_file (const char *filename
, const char *mode
,
184 const bfd_byte
*buf
, int len
)
189 file
= fopen_with_cleanup (filename
, mode
);
190 status
= fwrite (buf
, len
, 1, file
);
192 perror_with_name (filename
);
196 dump_bfd_file (const char *filename
, const char *mode
,
197 const char *target
, CORE_ADDR vaddr
,
198 const bfd_byte
*buf
, int len
)
203 obfd
= bfd_openw_with_cleanup (filename
, target
, mode
);
204 osection
= bfd_make_section_anyway (obfd
, ".newsec");
205 bfd_set_section_size (obfd
, osection
, len
);
206 bfd_set_section_vma (obfd
, osection
, vaddr
);
207 bfd_set_section_alignment (obfd
, osection
, 0);
208 bfd_set_section_flags (obfd
, osection
, (SEC_HAS_CONTENTS
211 osection
->entsize
= 0;
212 bfd_set_section_contents (obfd
, osection
, buf
, 0, len
);
216 dump_memory_to_file (char *cmd
, char *mode
, char *file_format
)
218 struct cleanup
*old_cleanups
= make_cleanup (null_cleanup
, NULL
);
229 filename
= scan_filename_with_cleanup (&cmd
, NULL
);
231 /* Find the low address. */
232 if (cmd
== NULL
|| *cmd
== '\0')
233 error (_("Missing start address."));
234 lo_exp
= scan_expression_with_cleanup (&cmd
, NULL
);
236 /* Find the second address - rest of line. */
237 if (cmd
== NULL
|| *cmd
== '\0')
238 error (_("Missing stop address."));
241 lo
= parse_and_eval_address (lo_exp
);
242 hi
= parse_and_eval_address (hi_exp
);
244 error (_("Invalid memory address range (start >= end)."));
247 /* FIXME: Should use read_memory_partial() and a magic blocking
249 buf
= xmalloc (count
);
250 make_cleanup (xfree
, buf
);
251 read_memory (lo
, buf
, count
);
253 /* Have everything. Open/write the data. */
254 if (file_format
== NULL
|| strcmp (file_format
, "binary") == 0)
256 dump_binary_file (filename
, mode
, buf
, count
);
260 dump_bfd_file (filename
, mode
, file_format
, lo
, buf
, count
);
263 do_cleanups (old_cleanups
);
267 dump_memory_command (char *cmd
, char *mode
)
269 dump_memory_to_file (cmd
, mode
, "binary");
273 dump_value_to_file (char *cmd
, char *mode
, char *file_format
)
275 struct cleanup
*old_cleanups
= make_cleanup (null_cleanup
, NULL
);
280 filename
= scan_filename_with_cleanup (&cmd
, NULL
);
282 /* Find the value. */
283 if (cmd
== NULL
|| *cmd
== '\0')
284 error (_("No value to %s."), *mode
== 'a' ? "append" : "dump");
285 val
= parse_and_eval (cmd
);
287 error (_("Invalid expression."));
289 /* Have everything. Open/write the data. */
290 if (file_format
== NULL
|| strcmp (file_format
, "binary") == 0)
292 dump_binary_file (filename
, mode
, value_contents (val
),
293 TYPE_LENGTH (value_type (val
)));
299 if (VALUE_LVAL (val
))
301 vaddr
= value_address (val
);
306 warning (_("value is not an lval: address assumed to be zero"));
309 dump_bfd_file (filename
, mode
, file_format
, vaddr
,
310 value_contents (val
),
311 TYPE_LENGTH (value_type (val
)));
314 do_cleanups (old_cleanups
);
318 dump_value_command (char *cmd
, char *mode
)
320 dump_value_to_file (cmd
, mode
, "binary");
324 dump_srec_memory (char *args
, int from_tty
)
326 dump_memory_to_file (args
, FOPEN_WB
, "srec");
330 dump_srec_value (char *args
, int from_tty
)
332 dump_value_to_file (args
, FOPEN_WB
, "srec");
336 dump_ihex_memory (char *args
, int from_tty
)
338 dump_memory_to_file (args
, FOPEN_WB
, "ihex");
342 dump_ihex_value (char *args
, int from_tty
)
344 dump_value_to_file (args
, FOPEN_WB
, "ihex");
348 dump_tekhex_memory (char *args
, int from_tty
)
350 dump_memory_to_file (args
, FOPEN_WB
, "tekhex");
354 dump_tekhex_value (char *args
, int from_tty
)
356 dump_value_to_file (args
, FOPEN_WB
, "tekhex");
360 dump_binary_memory (char *args
, int from_tty
)
362 dump_memory_to_file (args
, FOPEN_WB
, "binary");
366 dump_binary_value (char *args
, int from_tty
)
368 dump_value_to_file (args
, FOPEN_WB
, "binary");
372 append_binary_memory (char *args
, int from_tty
)
374 dump_memory_to_file (args
, FOPEN_AB
, "binary");
378 append_binary_value (char *args
, int from_tty
)
380 dump_value_to_file (args
, FOPEN_AB
, "binary");
385 void (*func
) (char *cmd
, char *mode
);
390 call_dump_func (struct cmd_list_element
*c
, char *args
, int from_tty
)
392 struct dump_context
*d
= get_cmd_context (c
);
393 d
->func (args
, d
->mode
);
397 add_dump_command (char *name
, void (*func
) (char *args
, char *mode
),
401 struct cmd_list_element
*c
;
402 struct dump_context
*d
;
404 c
= add_cmd (name
, all_commands
, NULL
, descr
, &dump_cmdlist
);
405 c
->completer
= filename_completer
;
406 d
= XMALLOC (struct dump_context
);
409 set_cmd_context (c
, d
);
410 c
->func
= call_dump_func
;
412 c
= add_cmd (name
, all_commands
, NULL
, descr
, &append_cmdlist
);
413 c
->completer
= filename_completer
;
414 d
= XMALLOC (struct dump_context
);
417 set_cmd_context (c
, d
);
418 c
->func
= call_dump_func
;
420 /* Replace "Dump " at start of docstring with "Append " (borrowed
421 from [deleted] deprecated_add_show_from_set). */
422 if ( c
->doc
[0] == 'W'
428 c
->doc
= concat ("Append ", c
->doc
+ 6, (char *)NULL
);
431 /* Opaque data for restore_section_callback. */
432 struct callback_data
{
433 CORE_ADDR load_offset
;
434 CORE_ADDR load_start
;
438 /* Function: restore_section_callback.
440 Callback function for bfd_map_over_sections.
441 Selectively loads the sections into memory. */
444 restore_section_callback (bfd
*ibfd
, asection
*isec
, void *args
)
446 struct callback_data
*data
= args
;
447 bfd_vma sec_start
= bfd_section_vma (ibfd
, isec
);
448 bfd_size_type size
= bfd_section_size (ibfd
, isec
);
449 bfd_vma sec_end
= sec_start
+ size
;
450 bfd_size_type sec_offset
= 0;
451 bfd_size_type sec_load_count
= size
;
452 struct cleanup
*old_chain
;
456 /* Ignore non-loadable sections, eg. from elf files. */
457 if (!(bfd_get_section_flags (ibfd
, isec
) & SEC_LOAD
))
460 /* Does the section overlap with the desired restore range? */
461 if (sec_end
<= data
->load_start
462 || (data
->load_end
> 0 && sec_start
>= data
->load_end
))
464 /* No, no useable data in this section. */
465 printf_filtered (_("skipping section %s...\n"),
466 bfd_section_name (ibfd
, isec
));
470 /* Compare section address range with user-requested
471 address range (if any). Compute where the actual
472 transfer should start and end. */
473 if (sec_start
< data
->load_start
)
474 sec_offset
= data
->load_start
- sec_start
;
475 /* Size of a partial transfer: */
476 sec_load_count
-= sec_offset
;
477 if (data
->load_end
> 0 && sec_end
> data
->load_end
)
478 sec_load_count
-= sec_end
- data
->load_end
;
481 buf
= xmalloc (size
);
482 old_chain
= make_cleanup (xfree
, buf
);
483 if (!bfd_get_section_contents (ibfd
, isec
, buf
, 0, size
))
484 error (_("Failed to read bfd file %s: '%s'."), bfd_get_filename (ibfd
),
485 bfd_errmsg (bfd_get_error ()));
487 printf_filtered ("Restoring section %s (0x%lx to 0x%lx)",
488 bfd_section_name (ibfd
, isec
),
489 (unsigned long) sec_start
,
490 (unsigned long) sec_end
);
492 if (data
->load_offset
!= 0 || data
->load_start
!= 0 || data
->load_end
!= 0)
493 printf_filtered (" into memory (%s to %s)\n",
494 paddress (target_gdbarch
,
495 (unsigned long) sec_start
496 + sec_offset
+ data
->load_offset
),
497 paddress (target_gdbarch
,
498 (unsigned long) sec_start
+ sec_offset
499 + data
->load_offset
+ sec_load_count
));
501 puts_filtered ("\n");
503 /* Write the data. */
504 ret
= target_write_memory (sec_start
+ sec_offset
+ data
->load_offset
,
505 buf
+ sec_offset
, sec_load_count
);
507 warning (_("restore: memory write failed (%s)."), safe_strerror (ret
));
508 do_cleanups (old_chain
);
513 restore_binary_file (char *filename
, struct callback_data
*data
)
515 FILE *file
= fopen_with_cleanup (filename
, FOPEN_RB
);
520 /* Get the file size for reading. */
521 if (fseek (file
, 0, SEEK_END
) == 0)
524 perror_with_name (filename
);
526 if (len
<= data
->load_start
)
527 error (_("Start address is greater than length of binary file %s."),
530 /* Chop off "len" if it exceeds the requested load_end addr. */
531 if (data
->load_end
!= 0 && data
->load_end
< len
)
532 len
= data
->load_end
;
533 /* Chop off "len" if the requested load_start addr skips some bytes. */
534 if (data
->load_start
> 0)
535 len
-= data
->load_start
;
538 ("Restoring binary file %s into memory (0x%lx to 0x%lx)\n",
540 (unsigned long) (data
->load_start
+ data
->load_offset
),
541 (unsigned long) (data
->load_start
+ data
->load_offset
+ len
));
543 /* Now set the file pos to the requested load start pos. */
544 if (fseek (file
, data
->load_start
, SEEK_SET
) != 0)
545 perror_with_name (filename
);
547 /* Now allocate a buffer and read the file contents. */
549 make_cleanup (xfree
, buf
);
550 if (fread (buf
, 1, len
, file
) != len
)
551 perror_with_name (filename
);
553 /* Now write the buffer into target memory. */
554 len
= target_write_memory (data
->load_start
+ data
->load_offset
, buf
, len
);
556 warning (_("restore: memory write failed (%s)."), safe_strerror (len
));
561 restore_command (char *args
, int from_tty
)
564 struct callback_data data
;
568 if (!target_has_execution
)
571 data
.load_offset
= 0;
575 /* Parse the input arguments. First is filename (required). */
576 filename
= scan_filename_with_cleanup (&args
, NULL
);
577 if (args
!= NULL
&& *args
!= '\0')
579 char *binary_string
= "binary";
581 /* Look for optional "binary" flag. */
582 if (strncmp (args
, binary_string
, strlen (binary_string
)) == 0)
585 args
+= strlen (binary_string
);
586 args
= skip_spaces (args
);
588 /* Parse offset (optional). */
589 if (args
!= NULL
&& *args
!= '\0')
591 parse_and_eval_address (scan_expression_with_cleanup (&args
, NULL
));
592 if (args
!= NULL
&& *args
!= '\0')
594 /* Parse start address (optional). */
596 parse_and_eval_long (scan_expression_with_cleanup (&args
, NULL
));
597 if (args
!= NULL
&& *args
!= '\0')
599 /* Parse end address (optional). */
600 data
.load_end
= parse_and_eval_long (args
);
601 if (data
.load_end
<= data
.load_start
)
602 error (_("Start must be less than end."));
608 printf_filtered ("Restore file %s offset 0x%lx start 0x%lx end 0x%lx\n",
609 filename
, (unsigned long) data
.load_offset
,
610 (unsigned long) data
.load_start
,
611 (unsigned long) data
.load_end
);
615 restore_binary_file (filename
, &data
);
619 /* Open the file for loading. */
620 ibfd
= bfd_openr_with_cleanup (filename
, NULL
);
622 /* Process the sections. */
623 bfd_map_over_sections (ibfd
, restore_section_callback
, &data
);
629 srec_dump_command (char *cmd
, int from_tty
)
631 printf_unfiltered ("\"dump srec\" must be followed by a subcommand.\n");
632 help_list (srec_cmdlist
, "dump srec ", -1, gdb_stdout
);
636 ihex_dump_command (char *cmd
, int from_tty
)
638 printf_unfiltered ("\"dump ihex\" must be followed by a subcommand.\n");
639 help_list (ihex_cmdlist
, "dump ihex ", -1, gdb_stdout
);
643 tekhex_dump_command (char *cmd
, int from_tty
)
645 printf_unfiltered ("\"dump tekhex\" must be followed by a subcommand.\n");
646 help_list (tekhex_cmdlist
, "dump tekhex ", -1, gdb_stdout
);
650 binary_dump_command (char *cmd
, int from_tty
)
652 printf_unfiltered ("\"dump binary\" must be followed by a subcommand.\n");
653 help_list (binary_dump_cmdlist
, "dump binary ", -1, gdb_stdout
);
657 binary_append_command (char *cmd
, int from_tty
)
659 printf_unfiltered ("\"append binary\" must be followed by a subcommand.\n");
660 help_list (binary_append_cmdlist
, "append binary ", -1, gdb_stdout
);
663 extern initialize_file_ftype _initialize_cli_dump
; /* -Wmissing-prototypes */
666 _initialize_cli_dump (void)
668 struct cmd_list_element
*c
;
669 add_prefix_cmd ("dump", class_vars
, dump_command
, _("\
670 Dump target code/data to a local file."),
671 &dump_cmdlist
, "dump ",
674 add_prefix_cmd ("append", class_vars
, append_command
, _("\
675 Append target code/data to a local file."),
676 &append_cmdlist
, "append ",
680 add_dump_command ("memory", dump_memory_command
, "\
681 Write contents of memory to a raw binary file.\n\
682 Arguments are FILE START STOP. Writes the contents of memory within the\n\
683 range [START .. STOP) to the specifed FILE in raw target ordered bytes.");
685 add_dump_command ("value", dump_value_command
, "\
686 Write the value of an expression to a raw binary file.\n\
687 Arguments are FILE EXPRESSION. Writes the value of EXPRESSION to\n\
688 the specified FILE in raw target ordered bytes.");
690 add_prefix_cmd ("srec", all_commands
, srec_dump_command
, _("\
691 Write target code/data to an srec file."),
692 &srec_cmdlist
, "dump srec ",
696 add_prefix_cmd ("ihex", all_commands
, ihex_dump_command
, _("\
697 Write target code/data to an intel hex file."),
698 &ihex_cmdlist
, "dump ihex ",
702 add_prefix_cmd ("tekhex", all_commands
, tekhex_dump_command
, _("\
703 Write target code/data to a tekhex file."),
704 &tekhex_cmdlist
, "dump tekhex ",
708 add_prefix_cmd ("binary", all_commands
, binary_dump_command
, _("\
709 Write target code/data to a raw binary file."),
710 &binary_dump_cmdlist
, "dump binary ",
714 add_prefix_cmd ("binary", all_commands
, binary_append_command
, _("\
715 Append target code/data to a raw binary file."),
716 &binary_append_cmdlist
, "append binary ",
720 add_cmd ("memory", all_commands
, dump_srec_memory
, _("\
721 Write contents of memory to an srec file.\n\
722 Arguments are FILE START STOP. Writes the contents of memory\n\
723 within the range [START .. STOP) to the specifed FILE in srec format."),
726 add_cmd ("value", all_commands
, dump_srec_value
, _("\
727 Write the value of an expression to an srec file.\n\
728 Arguments are FILE EXPRESSION. Writes the value of EXPRESSION\n\
729 to the specified FILE in srec format."),
732 add_cmd ("memory", all_commands
, dump_ihex_memory
, _("\
733 Write contents of memory to an ihex file.\n\
734 Arguments are FILE START STOP. Writes the contents of memory within\n\
735 the range [START .. STOP) to the specifed FILE in intel hex format."),
738 add_cmd ("value", all_commands
, dump_ihex_value
, _("\
739 Write the value of an expression to an ihex file.\n\
740 Arguments are FILE EXPRESSION. Writes the value of EXPRESSION\n\
741 to the specified FILE in intel hex format."),
744 add_cmd ("memory", all_commands
, dump_tekhex_memory
, _("\
745 Write contents of memory to a tekhex file.\n\
746 Arguments are FILE START STOP. Writes the contents of memory\n\
747 within the range [START .. STOP) to the specifed FILE in tekhex format."),
750 add_cmd ("value", all_commands
, dump_tekhex_value
, _("\
751 Write the value of an expression to a tekhex file.\n\
752 Arguments are FILE EXPRESSION. Writes the value of EXPRESSION\n\
753 to the specified FILE in tekhex format."),
756 add_cmd ("memory", all_commands
, dump_binary_memory
, _("\
757 Write contents of memory to a raw binary file.\n\
758 Arguments are FILE START STOP. Writes the contents of memory\n\
759 within the range [START .. STOP) to the specifed FILE in binary format."),
760 &binary_dump_cmdlist
);
762 add_cmd ("value", all_commands
, dump_binary_value
, _("\
763 Write the value of an expression to a raw binary file.\n\
764 Arguments are FILE EXPRESSION. Writes the value of EXPRESSION\n\
765 to the specified FILE in raw target ordered bytes."),
766 &binary_dump_cmdlist
);
768 add_cmd ("memory", all_commands
, append_binary_memory
, _("\
769 Append contents of memory to a raw binary file.\n\
770 Arguments are FILE START STOP. Writes the contents of memory within the\n\
771 range [START .. STOP) to the specifed FILE in raw target ordered bytes."),
772 &binary_append_cmdlist
);
774 add_cmd ("value", all_commands
, append_binary_value
, _("\
775 Append the value of an expression to a raw binary file.\n\
776 Arguments are FILE EXPRESSION. Writes the value of EXPRESSION\n\
777 to the specified FILE in raw target ordered bytes."),
778 &binary_append_cmdlist
);
780 c
= add_com ("restore", class_vars
, restore_command
, _("\
781 Restore the contents of FILE to target memory.\n\
782 Arguments are FILE OFFSET START END where all except FILE are optional.\n\
783 OFFSET will be added to the base address of the file (default zero).\n\
784 If START and END are given, only the file contents within that range\n\
785 (file relative) will be restored to target memory."));
786 c
->completer
= filename_completer
;
787 /* FIXME: completers for other commands. */