1 /* Dump-to-file commands, for GDB, the GNU debugger.
3 Copyright (c) 2002, 2005, 2007, 2008, 2009 Free Software Foundation, Inc.
5 Contributed by Red Hat.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
23 #include "gdb_string.h"
24 #include "cli/cli-decode.h"
25 #include "cli/cli-cmds.h"
27 #include "completer.h"
28 #include "cli/cli-dump.h"
29 #include "gdb_assert.h"
32 #include "readline/readline.h"
35 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
39 skip_spaces (char *chp
)
43 while (isspace (*chp
))
49 scan_expression_with_cleanup (char **cmd
, const char *def
)
51 if ((*cmd
) == NULL
|| (**cmd
) == '\0')
53 char *exp
= xstrdup (def
);
54 make_cleanup (xfree
, exp
);
62 end
= (*cmd
) + strcspn (*cmd
, " \t");
63 exp
= savestring ((*cmd
), end
- (*cmd
));
64 make_cleanup (xfree
, exp
);
65 (*cmd
) = skip_spaces (end
);
72 scan_filename_with_cleanup (char **cmd
, const char *defname
)
77 /* FIXME: Need to get the ``/a(ppend)'' flag from somewhere. */
83 error (_("Missing filename."));
84 filename
= xstrdup (defname
);
85 make_cleanup (xfree
, filename
);
89 /* FIXME: should parse a possibly quoted string. */
92 (*cmd
) = skip_spaces (*cmd
);
93 end
= *cmd
+ strcspn (*cmd
, " \t");
94 filename
= savestring ((*cmd
), end
- (*cmd
));
95 make_cleanup (xfree
, filename
);
96 (*cmd
) = skip_spaces (end
);
98 gdb_assert (filename
!= NULL
);
100 fullname
= tilde_expand (filename
);
101 make_cleanup (xfree
, fullname
);
107 fopen_with_cleanup (const char *filename
, const char *mode
)
109 FILE *file
= fopen (filename
, mode
);
111 perror_with_name (filename
);
112 make_cleanup_fclose (file
);
117 bfd_openr_with_cleanup (const char *filename
, const char *target
)
121 ibfd
= bfd_openr (filename
, target
);
123 error (_("Failed to open %s: %s."), filename
,
124 bfd_errmsg (bfd_get_error ()));
126 make_cleanup_bfd_close (ibfd
);
127 if (!bfd_check_format (ibfd
, bfd_object
))
128 error (_("'%s' is not a recognized file format."), filename
);
134 bfd_openw_with_cleanup (const char *filename
, const char *target
,
139 if (*mode
== 'w') /* Write: create new file */
141 obfd
= bfd_openw (filename
, target
);
143 error (_("Failed to open %s: %s."), filename
,
144 bfd_errmsg (bfd_get_error ()));
145 make_cleanup_bfd_close (obfd
);
146 if (!bfd_set_format (obfd
, bfd_object
))
147 error (_("bfd_openw_with_cleanup: %s."), bfd_errmsg (bfd_get_error ()));
149 else if (*mode
== 'a') /* Append to existing file */
150 { /* FIXME -- doesn't work... */
151 error (_("bfd_openw does not work with append."));
154 error (_("bfd_openw_with_cleanup: unknown mode %s."), mode
);
159 struct cmd_list_element
*dump_cmdlist
;
160 struct cmd_list_element
*append_cmdlist
;
161 struct cmd_list_element
*srec_cmdlist
;
162 struct cmd_list_element
*ihex_cmdlist
;
163 struct cmd_list_element
*tekhex_cmdlist
;
164 struct cmd_list_element
*binary_dump_cmdlist
;
165 struct cmd_list_element
*binary_append_cmdlist
;
168 dump_command (char *cmd
, int from_tty
)
170 printf_unfiltered (_("\"dump\" must be followed by a subcommand.\n\n"));
171 help_list (dump_cmdlist
, "dump ", -1, gdb_stdout
);
175 append_command (char *cmd
, int from_tty
)
177 printf_unfiltered (_("\"append\" must be followed by a subcommand.\n\n"));
178 help_list (dump_cmdlist
, "append ", -1, gdb_stdout
);
182 dump_binary_file (const char *filename
, const char *mode
,
183 const bfd_byte
*buf
, int len
)
188 file
= fopen_with_cleanup (filename
, mode
);
189 status
= fwrite (buf
, len
, 1, file
);
191 perror_with_name (filename
);
195 dump_bfd_file (const char *filename
, const char *mode
,
196 const char *target
, CORE_ADDR vaddr
,
197 const bfd_byte
*buf
, int len
)
202 obfd
= bfd_openw_with_cleanup (filename
, target
, mode
);
203 osection
= bfd_make_section_anyway (obfd
, ".newsec");
204 bfd_set_section_size (obfd
, osection
, len
);
205 bfd_set_section_vma (obfd
, osection
, vaddr
);
206 bfd_set_section_alignment (obfd
, osection
, 0);
207 bfd_set_section_flags (obfd
, osection
, (SEC_HAS_CONTENTS
210 osection
->entsize
= 0;
211 bfd_set_section_contents (obfd
, osection
, buf
, 0, len
);
215 dump_memory_to_file (char *cmd
, char *mode
, char *file_format
)
217 struct cleanup
*old_cleanups
= make_cleanup (null_cleanup
, NULL
);
228 filename
= scan_filename_with_cleanup (&cmd
, NULL
);
230 /* Find the low address. */
231 if (cmd
== NULL
|| *cmd
== '\0')
232 error (_("Missing start address."));
233 lo_exp
= scan_expression_with_cleanup (&cmd
, NULL
);
235 /* Find the second address - rest of line. */
236 if (cmd
== NULL
|| *cmd
== '\0')
237 error (_("Missing stop address."));
240 lo
= parse_and_eval_address (lo_exp
);
241 hi
= parse_and_eval_address (hi_exp
);
243 error (_("Invalid memory address range (start >= end)."));
246 /* FIXME: Should use read_memory_partial() and a magic blocking
248 buf
= xmalloc (count
);
249 make_cleanup (xfree
, buf
);
250 read_memory (lo
, buf
, count
);
252 /* Have everything. Open/write the data. */
253 if (file_format
== NULL
|| strcmp (file_format
, "binary") == 0)
255 dump_binary_file (filename
, mode
, buf
, count
);
259 dump_bfd_file (filename
, mode
, file_format
, lo
, buf
, count
);
262 do_cleanups (old_cleanups
);
266 dump_memory_command (char *cmd
, char *mode
)
268 dump_memory_to_file (cmd
, mode
, "binary");
272 dump_value_to_file (char *cmd
, char *mode
, char *file_format
)
274 struct cleanup
*old_cleanups
= make_cleanup (null_cleanup
, NULL
);
279 filename
= scan_filename_with_cleanup (&cmd
, NULL
);
281 /* Find the value. */
282 if (cmd
== NULL
|| *cmd
== '\0')
283 error (_("No value to %s."), *mode
== 'a' ? "append" : "dump");
284 val
= parse_and_eval (cmd
);
286 error (_("Invalid expression."));
288 /* Have everything. Open/write the data. */
289 if (file_format
== NULL
|| strcmp (file_format
, "binary") == 0)
291 dump_binary_file (filename
, mode
, value_contents (val
),
292 TYPE_LENGTH (value_type (val
)));
298 if (VALUE_LVAL (val
))
300 vaddr
= value_address (val
);
305 warning (_("value is not an lval: address assumed to be zero"));
308 dump_bfd_file (filename
, mode
, file_format
, vaddr
,
309 value_contents (val
),
310 TYPE_LENGTH (value_type (val
)));
313 do_cleanups (old_cleanups
);
317 dump_value_command (char *cmd
, char *mode
)
319 dump_value_to_file (cmd
, mode
, "binary");
323 dump_srec_memory (char *args
, int from_tty
)
325 dump_memory_to_file (args
, FOPEN_WB
, "srec");
329 dump_srec_value (char *args
, int from_tty
)
331 dump_value_to_file (args
, FOPEN_WB
, "srec");
335 dump_ihex_memory (char *args
, int from_tty
)
337 dump_memory_to_file (args
, FOPEN_WB
, "ihex");
341 dump_ihex_value (char *args
, int from_tty
)
343 dump_value_to_file (args
, FOPEN_WB
, "ihex");
347 dump_tekhex_memory (char *args
, int from_tty
)
349 dump_memory_to_file (args
, FOPEN_WB
, "tekhex");
353 dump_tekhex_value (char *args
, int from_tty
)
355 dump_value_to_file (args
, FOPEN_WB
, "tekhex");
359 dump_binary_memory (char *args
, int from_tty
)
361 dump_memory_to_file (args
, FOPEN_WB
, "binary");
365 dump_binary_value (char *args
, int from_tty
)
367 dump_value_to_file (args
, FOPEN_WB
, "binary");
371 append_binary_memory (char *args
, int from_tty
)
373 dump_memory_to_file (args
, FOPEN_AB
, "binary");
377 append_binary_value (char *args
, int from_tty
)
379 dump_value_to_file (args
, FOPEN_AB
, "binary");
384 void (*func
) (char *cmd
, char *mode
);
389 call_dump_func (struct cmd_list_element
*c
, char *args
, int from_tty
)
391 struct dump_context
*d
= get_cmd_context (c
);
392 d
->func (args
, d
->mode
);
396 add_dump_command (char *name
, void (*func
) (char *args
, char *mode
),
400 struct cmd_list_element
*c
;
401 struct dump_context
*d
;
403 c
= add_cmd (name
, all_commands
, NULL
, descr
, &dump_cmdlist
);
404 c
->completer
= filename_completer
;
405 d
= XMALLOC (struct dump_context
);
408 set_cmd_context (c
, d
);
409 c
->func
= call_dump_func
;
411 c
= add_cmd (name
, all_commands
, NULL
, descr
, &append_cmdlist
);
412 c
->completer
= filename_completer
;
413 d
= XMALLOC (struct dump_context
);
416 set_cmd_context (c
, d
);
417 c
->func
= call_dump_func
;
419 /* Replace "Dump " at start of docstring with "Append " (borrowed
420 from [deleted] deprecated_add_show_from_set). */
421 if ( c
->doc
[0] == 'W'
427 c
->doc
= concat ("Append ", c
->doc
+ 6, (char *)NULL
);
430 /* Opaque data for restore_section_callback. */
431 struct callback_data
{
432 CORE_ADDR load_offset
;
433 CORE_ADDR load_start
;
437 /* Function: restore_section_callback.
439 Callback function for bfd_map_over_sections.
440 Selectively loads the sections into memory. */
443 restore_section_callback (bfd
*ibfd
, asection
*isec
, void *args
)
445 struct callback_data
*data
= args
;
446 bfd_vma sec_start
= bfd_section_vma (ibfd
, isec
);
447 bfd_size_type size
= bfd_section_size (ibfd
, isec
);
448 bfd_vma sec_end
= sec_start
+ size
;
449 bfd_size_type sec_offset
= 0;
450 bfd_size_type sec_load_count
= size
;
451 struct cleanup
*old_chain
;
455 /* Ignore non-loadable sections, eg. from elf files. */
456 if (!(bfd_get_section_flags (ibfd
, isec
) & SEC_LOAD
))
459 /* Does the section overlap with the desired restore range? */
460 if (sec_end
<= data
->load_start
461 || (data
->load_end
> 0 && sec_start
>= data
->load_end
))
463 /* No, no useable data in this section. */
464 printf_filtered (_("skipping section %s...\n"),
465 bfd_section_name (ibfd
, isec
));
469 /* Compare section address range with user-requested
470 address range (if any). Compute where the actual
471 transfer should start and end. */
472 if (sec_start
< data
->load_start
)
473 sec_offset
= data
->load_start
- sec_start
;
474 /* Size of a partial transfer: */
475 sec_load_count
-= sec_offset
;
476 if (data
->load_end
> 0 && sec_end
> data
->load_end
)
477 sec_load_count
-= sec_end
- data
->load_end
;
480 buf
= xmalloc (size
);
481 old_chain
= make_cleanup (xfree
, buf
);
482 if (!bfd_get_section_contents (ibfd
, isec
, buf
, 0, size
))
483 error (_("Failed to read bfd file %s: '%s'."), bfd_get_filename (ibfd
),
484 bfd_errmsg (bfd_get_error ()));
486 printf_filtered ("Restoring section %s (0x%lx to 0x%lx)",
487 bfd_section_name (ibfd
, isec
),
488 (unsigned long) sec_start
,
489 (unsigned long) sec_end
);
491 if (data
->load_offset
!= 0 || data
->load_start
!= 0 || data
->load_end
!= 0)
492 printf_filtered (" into memory (%s to %s)\n",
493 paddress (target_gdbarch
,
494 (unsigned long) sec_start
495 + sec_offset
+ data
->load_offset
),
496 paddress (target_gdbarch
,
497 (unsigned long) sec_start
+ sec_offset
498 + data
->load_offset
+ sec_load_count
));
500 puts_filtered ("\n");
502 /* Write the data. */
503 ret
= target_write_memory (sec_start
+ sec_offset
+ data
->load_offset
,
504 buf
+ sec_offset
, sec_load_count
);
506 warning (_("restore: memory write failed (%s)."), safe_strerror (ret
));
507 do_cleanups (old_chain
);
512 restore_binary_file (char *filename
, struct callback_data
*data
)
514 FILE *file
= fopen_with_cleanup (filename
, FOPEN_RB
);
519 /* Get the file size for reading. */
520 if (fseek (file
, 0, SEEK_END
) == 0)
523 perror_with_name (filename
);
525 if (len
<= data
->load_start
)
526 error (_("Start address is greater than length of binary file %s."),
529 /* Chop off "len" if it exceeds the requested load_end addr. */
530 if (data
->load_end
!= 0 && data
->load_end
< len
)
531 len
= data
->load_end
;
532 /* Chop off "len" if the requested load_start addr skips some bytes. */
533 if (data
->load_start
> 0)
534 len
-= data
->load_start
;
537 ("Restoring binary file %s into memory (0x%lx to 0x%lx)\n",
539 (unsigned long) (data
->load_start
+ data
->load_offset
),
540 (unsigned long) (data
->load_start
+ data
->load_offset
+ len
));
542 /* Now set the file pos to the requested load start pos. */
543 if (fseek (file
, data
->load_start
, SEEK_SET
) != 0)
544 perror_with_name (filename
);
546 /* Now allocate a buffer and read the file contents. */
548 make_cleanup (xfree
, buf
);
549 if (fread (buf
, 1, len
, file
) != len
)
550 perror_with_name (filename
);
552 /* Now write the buffer into target memory. */
553 len
= target_write_memory (data
->load_start
+ data
->load_offset
, buf
, len
);
555 warning (_("restore: memory write failed (%s)."), safe_strerror (len
));
560 restore_command (char *args
, int from_tty
)
563 struct callback_data data
;
567 if (!target_has_execution
)
570 data
.load_offset
= 0;
574 /* Parse the input arguments. First is filename (required). */
575 filename
= scan_filename_with_cleanup (&args
, NULL
);
576 if (args
!= NULL
&& *args
!= '\0')
578 char *binary_string
= "binary";
580 /* Look for optional "binary" flag. */
581 if (strncmp (args
, binary_string
, strlen (binary_string
)) == 0)
584 args
+= strlen (binary_string
);
585 args
= skip_spaces (args
);
587 /* Parse offset (optional). */
588 if (args
!= NULL
&& *args
!= '\0')
590 parse_and_eval_address (scan_expression_with_cleanup (&args
, NULL
));
591 if (args
!= NULL
&& *args
!= '\0')
593 /* Parse start address (optional). */
595 parse_and_eval_long (scan_expression_with_cleanup (&args
, NULL
));
596 if (args
!= NULL
&& *args
!= '\0')
598 /* Parse end address (optional). */
599 data
.load_end
= parse_and_eval_long (args
);
600 if (data
.load_end
<= data
.load_start
)
601 error (_("Start must be less than end."));
607 printf_filtered ("Restore file %s offset 0x%lx start 0x%lx end 0x%lx\n",
608 filename
, (unsigned long) data
.load_offset
,
609 (unsigned long) data
.load_start
,
610 (unsigned long) data
.load_end
);
614 restore_binary_file (filename
, &data
);
618 /* Open the file for loading. */
619 ibfd
= bfd_openr_with_cleanup (filename
, NULL
);
621 /* Process the sections. */
622 bfd_map_over_sections (ibfd
, restore_section_callback
, &data
);
628 srec_dump_command (char *cmd
, int from_tty
)
630 printf_unfiltered ("\"dump srec\" must be followed by a subcommand.\n");
631 help_list (srec_cmdlist
, "dump srec ", -1, gdb_stdout
);
635 ihex_dump_command (char *cmd
, int from_tty
)
637 printf_unfiltered ("\"dump ihex\" must be followed by a subcommand.\n");
638 help_list (ihex_cmdlist
, "dump ihex ", -1, gdb_stdout
);
642 tekhex_dump_command (char *cmd
, int from_tty
)
644 printf_unfiltered ("\"dump tekhex\" must be followed by a subcommand.\n");
645 help_list (tekhex_cmdlist
, "dump tekhex ", -1, gdb_stdout
);
649 binary_dump_command (char *cmd
, int from_tty
)
651 printf_unfiltered ("\"dump binary\" must be followed by a subcommand.\n");
652 help_list (binary_dump_cmdlist
, "dump binary ", -1, gdb_stdout
);
656 binary_append_command (char *cmd
, int from_tty
)
658 printf_unfiltered ("\"append binary\" must be followed by a subcommand.\n");
659 help_list (binary_append_cmdlist
, "append binary ", -1, gdb_stdout
);
662 extern initialize_file_ftype _initialize_cli_dump
; /* -Wmissing-prototypes */
665 _initialize_cli_dump (void)
667 struct cmd_list_element
*c
;
668 add_prefix_cmd ("dump", class_vars
, dump_command
, _("\
669 Dump target code/data to a local file."),
670 &dump_cmdlist
, "dump ",
673 add_prefix_cmd ("append", class_vars
, append_command
, _("\
674 Append target code/data to a local file."),
675 &append_cmdlist
, "append ",
679 add_dump_command ("memory", dump_memory_command
, "\
680 Write contents of memory to a raw binary file.\n\
681 Arguments are FILE START STOP. Writes the contents of memory within the\n\
682 range [START .. STOP) to the specifed FILE in raw target ordered bytes.");
684 add_dump_command ("value", dump_value_command
, "\
685 Write the value of an expression to a raw binary file.\n\
686 Arguments are FILE EXPRESSION. Writes the value of EXPRESSION to\n\
687 the specified FILE in raw target ordered bytes.");
689 add_prefix_cmd ("srec", all_commands
, srec_dump_command
, _("\
690 Write target code/data to an srec file."),
691 &srec_cmdlist
, "dump srec ",
695 add_prefix_cmd ("ihex", all_commands
, ihex_dump_command
, _("\
696 Write target code/data to an intel hex file."),
697 &ihex_cmdlist
, "dump ihex ",
701 add_prefix_cmd ("tekhex", all_commands
, tekhex_dump_command
, _("\
702 Write target code/data to a tekhex file."),
703 &tekhex_cmdlist
, "dump tekhex ",
707 add_prefix_cmd ("binary", all_commands
, binary_dump_command
, _("\
708 Write target code/data to a raw binary file."),
709 &binary_dump_cmdlist
, "dump binary ",
713 add_prefix_cmd ("binary", all_commands
, binary_append_command
, _("\
714 Append target code/data to a raw binary file."),
715 &binary_append_cmdlist
, "append binary ",
719 add_cmd ("memory", all_commands
, dump_srec_memory
, _("\
720 Write contents of memory to an srec file.\n\
721 Arguments are FILE START STOP. Writes the contents of memory\n\
722 within the range [START .. STOP) to the specifed FILE in srec format."),
725 add_cmd ("value", all_commands
, dump_srec_value
, _("\
726 Write the value of an expression to an srec file.\n\
727 Arguments are FILE EXPRESSION. Writes the value of EXPRESSION\n\
728 to the specified FILE in srec format."),
731 add_cmd ("memory", all_commands
, dump_ihex_memory
, _("\
732 Write contents of memory to an ihex file.\n\
733 Arguments are FILE START STOP. Writes the contents of memory within\n\
734 the range [START .. STOP) to the specifed FILE in intel hex format."),
737 add_cmd ("value", all_commands
, dump_ihex_value
, _("\
738 Write the value of an expression to an ihex file.\n\
739 Arguments are FILE EXPRESSION. Writes the value of EXPRESSION\n\
740 to the specified FILE in intel hex format."),
743 add_cmd ("memory", all_commands
, dump_tekhex_memory
, _("\
744 Write contents of memory to a tekhex file.\n\
745 Arguments are FILE START STOP. Writes the contents of memory\n\
746 within the range [START .. STOP) to the specifed FILE in tekhex format."),
749 add_cmd ("value", all_commands
, dump_tekhex_value
, _("\
750 Write the value of an expression to a tekhex file.\n\
751 Arguments are FILE EXPRESSION. Writes the value of EXPRESSION\n\
752 to the specified FILE in tekhex format."),
755 add_cmd ("memory", all_commands
, dump_binary_memory
, _("\
756 Write contents of memory to a raw binary file.\n\
757 Arguments are FILE START STOP. Writes the contents of memory\n\
758 within the range [START .. STOP) to the specifed FILE in binary format."),
759 &binary_dump_cmdlist
);
761 add_cmd ("value", all_commands
, dump_binary_value
, _("\
762 Write the value of an expression to a raw binary file.\n\
763 Arguments are FILE EXPRESSION. Writes the value of EXPRESSION\n\
764 to the specified FILE in raw target ordered bytes."),
765 &binary_dump_cmdlist
);
767 add_cmd ("memory", all_commands
, append_binary_memory
, _("\
768 Append contents of memory to a raw binary file.\n\
769 Arguments are FILE START STOP. Writes the contents of memory within the\n\
770 range [START .. STOP) to the specifed FILE in raw target ordered bytes."),
771 &binary_append_cmdlist
);
773 add_cmd ("value", all_commands
, append_binary_value
, _("\
774 Append the value of an expression to a raw binary file.\n\
775 Arguments are FILE EXPRESSION. Writes the value of EXPRESSION\n\
776 to the specified FILE in raw target ordered bytes."),
777 &binary_append_cmdlist
);
779 c
= add_com ("restore", class_vars
, restore_command
, _("\
780 Restore the contents of FILE to target memory.\n\
781 Arguments are FILE OFFSET START END where all except FILE are optional.\n\
782 OFFSET will be added to the base address of the file (default zero).\n\
783 If START and END are given, only the file contents within that range\n\
784 (file relative) will be restored to target memory."));
785 c
->completer
= filename_completer
;
786 /* FIXME: completers for other commands. */