1 /* Dump-to-file commands, for GDB, the GNU debugger.
3 Copyright 2002, 2005 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 2 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, write to the Free Software
21 Foundation, Inc., 59 Temple Place - Suite 330,
22 Boston, MA 02111-1307, USA. */
25 #include "gdb_string.h"
26 #include "cli/cli-decode.h"
27 #include "cli/cli-cmds.h"
29 #include "completer.h"
30 #include "cli/cli-dump.h"
31 #include "gdb_assert.h"
34 #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 do_fclose_cleanup (void *arg)
79 static struct cleanup *
80 make_cleanup_fclose (FILE *file)
82 return make_cleanup (do_fclose_cleanup, file);
86 scan_filename_with_cleanup (char **cmd, const char *defname)
91 /* FIXME: Need to get the ``/a(ppend)'' flag from somewhere. */
97 error (_("Missing filename."));
98 filename = xstrdup (defname);
99 make_cleanup (xfree, filename);
103 /* FIXME: should parse a possibly quoted string. */
106 (*cmd) = skip_spaces (*cmd);
107 end = *cmd + strcspn (*cmd, " \t");
108 filename = savestring ((*cmd), end - (*cmd));
109 make_cleanup (xfree, filename);
110 (*cmd) = skip_spaces (end);
112 gdb_assert (filename != NULL);
114 fullname = tilde_expand (filename);
115 make_cleanup (xfree, fullname);
121 fopen_with_cleanup (const char *filename, const char *mode)
123 FILE *file = fopen (filename, mode);
125 perror_with_name (filename);
126 make_cleanup_fclose (file);
131 bfd_openr_with_cleanup (const char *filename, const char *target)
135 ibfd = bfd_openr (filename, target);
137 error (_("Failed to open %s: %s."), filename,
138 bfd_errmsg (bfd_get_error ()));
140 make_cleanup_bfd_close (ibfd);
141 if (!bfd_check_format (ibfd, bfd_object))
142 error (_("'%s' is not a recognized file format."), filename);
148 bfd_openw_with_cleanup (const char *filename, const char *target,
153 if (*mode == 'w') /* Write: create new file */
155 obfd = bfd_openw (filename, target);
157 error (_("Failed to open %s: %s."), filename,
158 bfd_errmsg (bfd_get_error ()));
159 make_cleanup_bfd_close (obfd);
160 if (!bfd_set_format (obfd, bfd_object))
161 error (_("bfd_openw_with_cleanup: %s."), bfd_errmsg (bfd_get_error ()));
163 else if (*mode == 'a') /* Append to existing file */
164 { /* FIXME -- doesn't work... */
165 error (_("bfd_openw does not work with append."));
168 error (_("bfd_openw_with_cleanup: unknown mode %s."), mode);
173 struct cmd_list_element *dump_cmdlist;
174 struct cmd_list_element *append_cmdlist;
175 struct cmd_list_element *srec_cmdlist;
176 struct cmd_list_element *ihex_cmdlist;
177 struct cmd_list_element *tekhex_cmdlist;
178 struct cmd_list_element *binary_dump_cmdlist;
179 struct cmd_list_element *binary_append_cmdlist;
182 dump_command (char *cmd, int from_tty)
184 printf_unfiltered ("\"dump\" must be followed by a subcommand.\n\n");
185 help_list (dump_cmdlist, "dump ", -1, gdb_stdout);
189 append_command (char *cmd, int from_tty)
191 printf_unfiltered ("\"append\" must be followed by a subcommand.\n\n");
192 help_list (dump_cmdlist, "append ", -1, gdb_stdout);
196 dump_binary_file (const char *filename, const char *mode,
197 const bfd_byte *buf, int len)
202 file = fopen_with_cleanup (filename, mode);
203 status = fwrite (buf, len, 1, file);
205 perror_with_name (filename);
209 dump_bfd_file (const char *filename, const char *mode,
210 const char *target, CORE_ADDR vaddr,
211 const bfd_byte *buf, int len)
216 obfd = bfd_openw_with_cleanup (filename, target, mode);
217 osection = bfd_make_section_anyway (obfd, ".newsec");
218 bfd_set_section_size (obfd, osection, len);
219 bfd_set_section_vma (obfd, osection, vaddr);
220 bfd_set_section_alignment (obfd, osection, 0);
221 bfd_set_section_flags (obfd, osection, 0x203);
222 osection->entsize = 0;
223 bfd_set_section_contents (obfd, osection, buf, 0, len);
227 dump_memory_to_file (char *cmd, char *mode, char *file_format)
229 struct cleanup *old_cleanups = make_cleanup (null_cleanup, NULL);
240 filename = scan_filename_with_cleanup (&cmd, NULL);
242 /* Find the low address. */
243 if (cmd == NULL || *cmd == '\0')
244 error (_("Missing start address."));
245 lo_exp = scan_expression_with_cleanup (&cmd, NULL);
247 /* Find the second address - rest of line. */
248 if (cmd == NULL || *cmd == '\0')
249 error (_("Missing stop address."));
252 lo = parse_and_eval_address (lo_exp);
253 hi = parse_and_eval_address (hi_exp);
255 error (_("Invalid memory address range (start >= end)."));
258 /* FIXME: Should use read_memory_partial() and a magic blocking
260 buf = xmalloc (count);
261 make_cleanup (xfree, buf);
262 target_read_memory (lo, buf, count);
264 /* Have everything. Open/write the data. */
265 if (file_format == NULL || strcmp (file_format, "binary") == 0)
267 dump_binary_file (filename, mode, buf, count);
271 dump_bfd_file (filename, mode, file_format, lo, buf, count);
274 do_cleanups (old_cleanups);
278 dump_memory_command (char *cmd, char *mode)
280 dump_memory_to_file (cmd, mode, "binary");
284 dump_value_to_file (char *cmd, char *mode, char *file_format)
286 struct cleanup *old_cleanups = make_cleanup (null_cleanup, NULL);
291 filename = scan_filename_with_cleanup (&cmd, NULL);
293 /* Find the value. */
294 if (cmd == NULL || *cmd == '\0')
295 error (_("No value to %s."), *mode == 'a' ? "append" : "dump");
296 val = parse_and_eval (cmd);
298 error (_("Invalid expression."));
300 /* Have everything. Open/write the data. */
301 if (file_format == NULL || strcmp (file_format, "binary") == 0)
303 dump_binary_file (filename, mode, value_contents (val),
304 TYPE_LENGTH (value_type (val)));
310 if (VALUE_LVAL (val))
312 vaddr = VALUE_ADDRESS (val);
317 warning (_("value is not an lval: address assumed to be zero"));
320 dump_bfd_file (filename, mode, file_format, vaddr,
321 value_contents (val),
322 TYPE_LENGTH (value_type (val)));
325 do_cleanups (old_cleanups);
329 dump_value_command (char *cmd, char *mode)
331 dump_value_to_file (cmd, mode, "binary");
335 dump_srec_memory (char *args, int from_tty)
337 dump_memory_to_file (args, FOPEN_WB, "srec");
341 dump_srec_value (char *args, int from_tty)
343 dump_value_to_file (args, FOPEN_WB, "srec");
347 dump_ihex_memory (char *args, int from_tty)
349 dump_memory_to_file (args, FOPEN_WB, "ihex");
353 dump_ihex_value (char *args, int from_tty)
355 dump_value_to_file (args, FOPEN_WB, "ihex");
359 dump_tekhex_memory (char *args, int from_tty)
361 dump_memory_to_file (args, FOPEN_WB, "tekhex");
365 dump_tekhex_value (char *args, int from_tty)
367 dump_value_to_file (args, FOPEN_WB, "tekhex");
371 dump_binary_memory (char *args, int from_tty)
373 dump_memory_to_file (args, FOPEN_WB, "binary");
377 dump_binary_value (char *args, int from_tty)
379 dump_value_to_file (args, FOPEN_WB, "binary");
383 append_binary_memory (char *args, int from_tty)
385 dump_memory_to_file (args, FOPEN_AB, "binary");
389 append_binary_value (char *args, int from_tty)
391 dump_value_to_file (args, FOPEN_AB, "binary");
396 void (*func) (char *cmd, char *mode);
401 call_dump_func (struct cmd_list_element *c, char *args, int from_tty)
403 struct dump_context *d = get_cmd_context (c);
404 d->func (args, d->mode);
408 add_dump_command (char *name, void (*func) (char *args, char *mode),
412 struct cmd_list_element *c;
413 struct dump_context *d;
415 c = add_cmd (name, all_commands, NULL, descr, &dump_cmdlist);
416 c->completer = filename_completer;
417 d = XMALLOC (struct dump_context);
420 set_cmd_context (c, d);
421 c->func = call_dump_func;
423 c = add_cmd (name, all_commands, NULL, descr, &append_cmdlist);
424 c->completer = filename_completer;
425 d = XMALLOC (struct dump_context);
428 set_cmd_context (c, d);
429 c->func = call_dump_func;
431 /* Replace "Dump " at start of docstring with "Append " (borrowed
432 from deprecated_add_show_from_set). */
433 if ( c->doc[0] == 'W'
439 c->doc = concat ("Append ", c->doc + 6, NULL);
442 /* Opaque data for restore_section_callback. */
443 struct callback_data {
444 unsigned long load_offset;
445 CORE_ADDR load_start;
449 /* Function: restore_section_callback.
451 Callback function for bfd_map_over_sections.
452 Selectively loads the sections into memory. */
455 restore_section_callback (bfd *ibfd, asection *isec, void *args)
457 struct callback_data *data = args;
458 bfd_vma sec_start = bfd_section_vma (ibfd, isec);
459 bfd_size_type size = bfd_section_size (ibfd, isec);
460 bfd_vma sec_end = sec_start + size;
461 bfd_size_type sec_offset = 0;
462 bfd_size_type sec_load_count = size;
463 struct cleanup *old_chain;
467 /* Ignore non-loadable sections, eg. from elf files. */
468 if (!(bfd_get_section_flags (ibfd, isec) & SEC_LOAD))
471 /* Does the section overlap with the desired restore range? */
472 if (sec_end <= data->load_start
473 || (data->load_end > 0 && sec_start >= data->load_end))
475 /* No, no useable data in this section. */
476 printf_filtered ("skipping section %s...\n",
477 bfd_section_name (ibfd, isec));
481 /* Compare section address range with user-requested
482 address range (if any). Compute where the actual
483 transfer should start and end. */
484 if (sec_start < data->load_start)
485 sec_offset = data->load_start - sec_start;
486 /* Size of a partial transfer: */
487 sec_load_count -= sec_offset;
488 if (data->load_end > 0 && sec_end > data->load_end)
489 sec_load_count -= sec_end - data->load_end;
492 buf = xmalloc (size);
493 old_chain = make_cleanup (xfree, buf);
494 if (!bfd_get_section_contents (ibfd, isec, buf, 0, size))
495 error (_("Failed to read bfd file %s: '%s'."), bfd_get_filename (ibfd),
496 bfd_errmsg (bfd_get_error ()));
498 printf_filtered ("Restoring section %s (0x%lx to 0x%lx)",
499 bfd_section_name (ibfd, isec),
500 (unsigned long) sec_start,
501 (unsigned long) sec_end);
503 if (data->load_offset != 0 || data->load_start != 0 || data->load_end != 0)
504 printf_filtered (" into memory (0x%s to 0x%s)\n",
505 paddr_nz ((unsigned long) sec_start
506 + sec_offset + data->load_offset),
507 paddr_nz ((unsigned long) sec_start + sec_offset
508 + data->load_offset + sec_load_count));
510 puts_filtered ("\n");
512 /* Write the data. */
513 ret = target_write_memory (sec_start + sec_offset + data->load_offset,
514 buf + sec_offset, sec_load_count);
516 warning (_("restore: memory write failed (%s)."), safe_strerror (ret));
517 do_cleanups (old_chain);
522 restore_binary_file (char *filename, struct callback_data *data)
524 FILE *file = fopen_with_cleanup (filename, FOPEN_RB);
529 /* Get the file size for reading. */
530 if (fseek (file, 0, SEEK_END) == 0)
533 perror_with_name (filename);
535 if (len <= data->load_start)
536 error (_("Start address is greater than length of binary file %s."),
539 /* Chop off "len" if it exceeds the requested load_end addr. */
540 if (data->load_end != 0 && data->load_end < len)
541 len = data->load_end;
542 /* Chop off "len" if the requested load_start addr skips some bytes. */
543 if (data->load_start > 0)
544 len -= data->load_start;
547 ("Restoring binary file %s into memory (0x%lx to 0x%lx)\n",
549 (unsigned long) data->load_start + data->load_offset,
550 (unsigned long) data->load_start + data->load_offset + len);
552 /* Now set the file pos to the requested load start pos. */
553 if (fseek (file, data->load_start, SEEK_SET) != 0)
554 perror_with_name (filename);
556 /* Now allocate a buffer and read the file contents. */
558 make_cleanup (xfree, buf);
559 if (fread (buf, 1, len, file) != len)
560 perror_with_name (filename);
562 /* Now write the buffer into target memory. */
563 len = target_write_memory (data->load_start + data->load_offset, buf, len);
565 warning (_("restore: memory write failed (%s)."), safe_strerror (len));
570 restore_command (char *args, int from_tty)
573 struct callback_data data;
577 if (!target_has_execution)
580 data.load_offset = 0;
584 /* Parse the input arguments. First is filename (required). */
585 filename = scan_filename_with_cleanup (&args, NULL);
586 if (args != NULL && *args != '\0')
588 char *binary_string = "binary";
590 /* Look for optional "binary" flag. */
591 if (strncmp (args, binary_string, strlen (binary_string)) == 0)
594 args += strlen (binary_string);
595 args = skip_spaces (args);
597 /* Parse offset (optional). */
598 if (args != NULL && *args != '\0')
600 parse_and_eval_long (scan_expression_with_cleanup (&args, NULL));
601 if (args != NULL && *args != '\0')
603 /* Parse start address (optional). */
605 parse_and_eval_long (scan_expression_with_cleanup (&args, NULL));
606 if (args != NULL && *args != '\0')
608 /* Parse end address (optional). */
609 data.load_end = parse_and_eval_long (args);
610 if (data.load_end <= data.load_start)
611 error (_("Start must be less than end."));
617 printf_filtered ("Restore file %s offset 0x%lx start 0x%lx end 0x%lx\n",
618 filename, (unsigned long) data.load_offset,
619 (unsigned long) data.load_start,
620 (unsigned long) data.load_end);
624 restore_binary_file (filename, &data);
628 /* Open the file for loading. */
629 ibfd = bfd_openr_with_cleanup (filename, NULL);
631 /* Process the sections. */
632 bfd_map_over_sections (ibfd, restore_section_callback, &data);
638 srec_dump_command (char *cmd, int from_tty)
640 printf_unfiltered ("\"dump srec\" must be followed by a subcommand.\n");
641 help_list (srec_cmdlist, "dump srec ", -1, gdb_stdout);
645 ihex_dump_command (char *cmd, int from_tty)
647 printf_unfiltered ("\"dump ihex\" must be followed by a subcommand.\n");
648 help_list (ihex_cmdlist, "dump ihex ", -1, gdb_stdout);
652 tekhex_dump_command (char *cmd, int from_tty)
654 printf_unfiltered ("\"dump tekhex\" must be followed by a subcommand.\n");
655 help_list (tekhex_cmdlist, "dump tekhex ", -1, gdb_stdout);
659 binary_dump_command (char *cmd, int from_tty)
661 printf_unfiltered ("\"dump binary\" must be followed by a subcommand.\n");
662 help_list (binary_dump_cmdlist, "dump binary ", -1, gdb_stdout);
666 binary_append_command (char *cmd, int from_tty)
668 printf_unfiltered ("\"append binary\" must be followed by a subcommand.\n");
669 help_list (binary_append_cmdlist, "append binary ", -1, gdb_stdout);
672 extern initialize_file_ftype _initialize_cli_dump; /* -Wmissing-prototypes */
675 _initialize_cli_dump (void)
677 struct cmd_list_element *c;
678 add_prefix_cmd ("dump", class_vars, dump_command, "\
679 Dump target code/data to a local file.",
680 &dump_cmdlist, "dump ",
683 add_prefix_cmd ("append", class_vars, append_command, "\
684 Append target code/data to a local file.",
685 &append_cmdlist, "append ",
689 add_dump_command ("memory", dump_memory_command, "\
690 Write contents of memory to a raw binary file.\n\
691 Arguments are FILE START STOP. Writes the contents of memory within the\n\
692 range [START .. STOP) to the specifed FILE in raw target ordered bytes.");
694 add_dump_command ("value", dump_value_command, "\
695 Write the value of an expression to a raw binary file.\n\
696 Arguments are FILE EXPRESSION. Writes the value of EXPRESSION to\n\
697 the specified FILE in raw target ordered bytes.");
699 add_prefix_cmd ("srec", all_commands, srec_dump_command, "\
700 Write target code/data to an srec file.",
701 &srec_cmdlist, "dump srec ",
705 add_prefix_cmd ("ihex", all_commands, ihex_dump_command, "\
706 Write target code/data to an intel hex file.",
707 &ihex_cmdlist, "dump ihex ",
711 add_prefix_cmd ("tekhex", all_commands, tekhex_dump_command, "\
712 Write target code/data to a tekhex file.",
713 &tekhex_cmdlist, "dump tekhex ",
717 add_prefix_cmd ("binary", all_commands, binary_dump_command, "\
718 Write target code/data to a raw binary file.",
719 &binary_dump_cmdlist, "dump binary ",
723 add_prefix_cmd ("binary", all_commands, binary_append_command, "\
724 Append target code/data to a raw binary file.",
725 &binary_append_cmdlist, "append binary ",
729 add_cmd ("memory", all_commands, dump_srec_memory, "\
730 Write contents of memory to an srec file.\n\
731 Arguments are FILE START STOP. Writes the contents of memory\n\
732 within the range [START .. STOP) to the specifed FILE in srec format.",
735 add_cmd ("value", all_commands, dump_srec_value, "\
736 Write the value of an expression to an srec file.\n\
737 Arguments are FILE EXPRESSION. Writes the value of EXPRESSION\n\
738 to the specified FILE in srec format.",
741 add_cmd ("memory", all_commands, dump_ihex_memory, "\
742 Write contents of memory to an ihex file.\n\
743 Arguments are FILE START STOP. Writes the contents of memory within\n\
744 the range [START .. STOP) to the specifed FILE in intel hex format.",
747 add_cmd ("value", all_commands, dump_ihex_value, "\
748 Write the value of an expression to an ihex file.\n\
749 Arguments are FILE EXPRESSION. Writes the value of EXPRESSION\n\
750 to the specified FILE in intel hex format.",
753 add_cmd ("memory", all_commands, dump_tekhex_memory, "\
754 Write contents of memory to a tekhex 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 tekhex format.",
759 add_cmd ("value", all_commands, dump_tekhex_value, "\
760 Write the value of an expression to a tekhex file.\n\
761 Arguments are FILE EXPRESSION. Writes the value of EXPRESSION\n\
762 to the specified FILE in tekhex format.",
765 add_cmd ("memory", all_commands, dump_binary_memory, "\
766 Write contents of memory to a raw binary file.\n\
767 Arguments are FILE START STOP. Writes the contents of memory\n\
768 within the range [START .. STOP) to the specifed FILE in binary format.",
769 &binary_dump_cmdlist);
771 add_cmd ("value", all_commands, dump_binary_value, "\
772 Write 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_dump_cmdlist);
777 add_cmd ("memory", all_commands, append_binary_memory, "\
778 Append contents of memory to a raw binary file.\n\
779 Arguments are FILE START STOP. Writes the contents of memory within the\n\
780 range [START .. STOP) to the specifed FILE in raw target ordered bytes.",
781 &binary_append_cmdlist);
783 add_cmd ("value", all_commands, append_binary_value, "\
784 Append the value of an expression to a raw binary file.\n\
785 Arguments are FILE EXPRESSION. Writes the value of EXPRESSION\n\
786 to the specified FILE in raw target ordered bytes.",
787 &binary_append_cmdlist);
789 c = add_com ("restore", class_vars, restore_command,
790 "Restore the contents of FILE to target memory.\n\
791 Arguments are FILE OFFSET START END where all except FILE are optional.\n\
792 OFFSET will be added to the base address of the file (default zero).\n\
793 If START and END are given, only the file contents within that range\n\
794 (file relative) will be restored to target memory.");
795 c->completer = filename_completer;
796 /* FIXME: completers for other commands. */