Subversion Repositories openrisc

/* Dump-to-file commands, for GDB, the GNU debugger.

   Copyright (c) 2002, 2005, 2007, 2008 Free Software Foundation, Inc.

   Contributed by Red Hat.

   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 "gdb_string.h"

#include "cli/cli-decode.h"

#include "cli/cli-cmds.h"

#include "value.h"

#include "completer.h"

#include "cli/cli-dump.h"

#include "gdb_assert.h"

#include <ctype.h>

#include "target.h"

#include "readline/readline.h"

#define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))

char *

skip_spaces (char *chp)

{

  if (chp == NULL)

    return NULL;

  while (isspace (*chp))

    chp++;

  return chp;

}

char *

scan_expression_with_cleanup (char **cmd, const char *def)

{

  if ((*cmd) == NULL || (**cmd) == '\0')

    {

      char *exp = xstrdup (def);

      make_cleanup (xfree, exp);

      return exp;

    }

  else

    {

      char *exp;

      char *end;

      end = (*cmd) + strcspn (*cmd, " \t");

      exp = savestring ((*cmd), end - (*cmd));

      make_cleanup (xfree, exp);

      (*cmd) = skip_spaces (end);

      return exp;

    }

}

static void

do_fclose_cleanup (void *arg)

{

  FILE *file = arg;

  fclose (arg);

}

static struct cleanup *

make_cleanup_fclose (FILE *file)

{

  return make_cleanup (do_fclose_cleanup, file);

}

char *

scan_filename_with_cleanup (char **cmd, const char *defname)

{

  char *filename;

  char *fullname;

  /* FIXME: Need to get the ``/a(ppend)'' flag from somewhere.  */

  /* File.  */

  if ((*cmd) == NULL)

    {

      if (defname == NULL)

        error (_("Missing filename."));

      filename = xstrdup (defname);

      make_cleanup (xfree, filename);

    }

  else

    {

      /* FIXME: should parse a possibly quoted string.  */

      char *end;

      (*cmd) = skip_spaces (*cmd);

      end = *cmd + strcspn (*cmd, " \t");

      filename = savestring ((*cmd), end - (*cmd));

      make_cleanup (xfree, filename);

      (*cmd) = skip_spaces (end);

    }

  gdb_assert (filename != NULL);

  fullname = tilde_expand (filename);

  make_cleanup (xfree, fullname);

  return fullname;

}

FILE *

fopen_with_cleanup (const char *filename, const char *mode)

{

  FILE *file = fopen (filename, mode);

  if (file == NULL)

    perror_with_name (filename);

  make_cleanup_fclose (file);

  return file;

}

static bfd *

bfd_openr_with_cleanup (const char *filename, const char *target)

{

  bfd *ibfd;

  ibfd = bfd_openr (filename, target);

  if (ibfd == NULL)

    error (_("Failed to open %s: %s."), filename,

           bfd_errmsg (bfd_get_error ()));

  make_cleanup_bfd_close (ibfd);

  if (!bfd_check_format (ibfd, bfd_object))

    error (_("'%s' is not a recognized file format."), filename);

  return ibfd;

}

static bfd *

bfd_openw_with_cleanup (const char *filename, const char *target,

                        const char *mode)

{

  bfd *obfd;

  if (*mode == 'w')     /* Write: create new file */

    {

      obfd = bfd_openw (filename, target);

      if (obfd == NULL)

        error (_("Failed to open %s: %s."), filename,

               bfd_errmsg (bfd_get_error ()));

      make_cleanup_bfd_close (obfd);

      if (!bfd_set_format (obfd, bfd_object))

        error (_("bfd_openw_with_cleanup: %s."), bfd_errmsg (bfd_get_error ()));

    }

  else if (*mode == 'a')        /* Append to existing file */

    {   /* FIXME -- doesn't work... */

      error (_("bfd_openw does not work with append."));

    }

  else

    error (_("bfd_openw_with_cleanup: unknown mode %s."), mode);

  return obfd;

}

struct cmd_list_element *dump_cmdlist;

struct cmd_list_element *append_cmdlist;

struct cmd_list_element *srec_cmdlist;

struct cmd_list_element *ihex_cmdlist;

struct cmd_list_element *tekhex_cmdlist;

struct cmd_list_element *binary_dump_cmdlist;

struct cmd_list_element *binary_append_cmdlist;

static void

dump_command (char *cmd, int from_tty)

{

  printf_unfiltered (_("\"dump\" must be followed by a subcommand.\n\n"));

  help_list (dump_cmdlist, "dump ", -1, gdb_stdout);

}

static void

append_command (char *cmd, int from_tty)

{

  printf_unfiltered (_("\"append\" must be followed by a subcommand.\n\n"));

  help_list (dump_cmdlist, "append ", -1, gdb_stdout);

}

static void

dump_binary_file (const char *filename, const char *mode,

                  const bfd_byte *buf, int len)

{

  FILE *file;

  int status;

  file = fopen_with_cleanup (filename, mode);

  status = fwrite (buf, len, 1, file);

  if (status != 1)

    perror_with_name (filename);

}

static void

dump_bfd_file (const char *filename, const char *mode,

               const char *target, CORE_ADDR vaddr,

               const bfd_byte *buf, int len)

{

  bfd *obfd;

  asection *osection;

  obfd = bfd_openw_with_cleanup (filename, target, mode);

  osection = bfd_make_section_anyway (obfd, ".newsec");

  bfd_set_section_size (obfd, osection, len);

  bfd_set_section_vma (obfd, osection, vaddr);

  bfd_set_section_alignment (obfd, osection, 0);

  bfd_set_section_flags (obfd, osection, (SEC_HAS_CONTENTS

                                          | SEC_ALLOC

                                          | SEC_LOAD));

  osection->entsize = 0;

  bfd_set_section_contents (obfd, osection, buf, 0, len);

}

static void

dump_memory_to_file (char *cmd, char *mode, char *file_format)

{

  struct cleanup *old_cleanups = make_cleanup (null_cleanup, NULL);

  CORE_ADDR lo;

  CORE_ADDR hi;

  ULONGEST count;

  char *filename;

  void *buf;

  char *lo_exp;

  char *hi_exp;

  int len;

  /* Open the file.  */

  filename = scan_filename_with_cleanup (&cmd, NULL);

  /* Find the low address.  */

  if (cmd == NULL || *cmd == '\0')

    error (_("Missing start address."));

  lo_exp = scan_expression_with_cleanup (&cmd, NULL);

  /* Find the second address - rest of line.  */

  if (cmd == NULL || *cmd == '\0')

    error (_("Missing stop address."));

  hi_exp = cmd;

  lo = parse_and_eval_address (lo_exp);

  hi = parse_and_eval_address (hi_exp);

  if (hi <= lo)

    error (_("Invalid memory address range (start >= end)."));

  count = hi - lo;

  /* FIXME: Should use read_memory_partial() and a magic blocking

     value.  */

  buf = xmalloc (count);

  make_cleanup (xfree, buf);

  target_read_memory (lo, buf, count);

  /* Have everything.  Open/write the data.  */

  if (file_format == NULL || strcmp (file_format, "binary") == 0)

    {

      dump_binary_file (filename, mode, buf, count);

    }

  else

    {

      dump_bfd_file (filename, mode, file_format, lo, buf, count);

    }

  do_cleanups (old_cleanups);

}

static void

dump_memory_command (char *cmd, char *mode)

{

  dump_memory_to_file (cmd, mode, "binary");

}

static void

dump_value_to_file (char *cmd, char *mode, char *file_format)

{

  struct cleanup *old_cleanups = make_cleanup (null_cleanup, NULL);

  struct value *val;

  char *filename;

  /* Open the file.  */

  filename = scan_filename_with_cleanup (&cmd, NULL);

  /* Find the value.  */

  if (cmd == NULL || *cmd == '\0')

    error (_("No value to %s."), *mode == 'a' ? "append" : "dump");

  val = parse_and_eval (cmd);

  if (val == NULL)

    error (_("Invalid expression."));

  /* Have everything.  Open/write the data.  */

  if (file_format == NULL || strcmp (file_format, "binary") == 0)

    {

      dump_binary_file (filename, mode, value_contents (val),

                        TYPE_LENGTH (value_type (val)));

    }

  else

    {

      CORE_ADDR vaddr;

      if (VALUE_LVAL (val))

        {

          vaddr = VALUE_ADDRESS (val);

        }

      else

        {

          vaddr = 0;

          warning (_("value is not an lval: address assumed to be zero"));

        }

      dump_bfd_file (filename, mode, file_format, vaddr,

                     value_contents (val),

                     TYPE_LENGTH (value_type (val)));

    }

  do_cleanups (old_cleanups);

}

static void

dump_value_command (char *cmd, char *mode)

{

  dump_value_to_file (cmd, mode, "binary");

}

static void

dump_srec_memory (char *args, int from_tty)

{

  dump_memory_to_file (args, FOPEN_WB, "srec");

}

static void

dump_srec_value (char *args, int from_tty)

{

  dump_value_to_file (args, FOPEN_WB, "srec");

}

static void

dump_ihex_memory (char *args, int from_tty)

{

  dump_memory_to_file (args, FOPEN_WB, "ihex");

}

static void

dump_ihex_value (char *args, int from_tty)

{

  dump_value_to_file (args, FOPEN_WB, "ihex");

}

static void

dump_tekhex_memory (char *args, int from_tty)

{

  dump_memory_to_file (args, FOPEN_WB, "tekhex");

}

static void

dump_tekhex_value (char *args, int from_tty)

{

  dump_value_to_file (args, FOPEN_WB, "tekhex");

}

static void

dump_binary_memory (char *args, int from_tty)

{

  dump_memory_to_file (args, FOPEN_WB, "binary");

}

static void

dump_binary_value (char *args, int from_tty)

{

  dump_value_to_file (args, FOPEN_WB, "binary");

}

static void

append_binary_memory (char *args, int from_tty)

{

  dump_memory_to_file (args, FOPEN_AB, "binary");

}

static void

append_binary_value (char *args, int from_tty)

{

  dump_value_to_file (args, FOPEN_AB, "binary");

}

struct dump_context

{

  void (*func) (char *cmd, char *mode);

  char *mode;

};

static void

call_dump_func (struct cmd_list_element *c, char *args, int from_tty)

{

  struct dump_context *d = get_cmd_context (c);

  d->func (args, d->mode);

}

void

add_dump_command (char *name, void (*func) (char *args, char *mode),

                  char *descr)

{

  struct cmd_list_element *c;

  struct dump_context *d;

  c = add_cmd (name, all_commands, NULL, descr, &dump_cmdlist);

  c->completer =  filename_completer;

  d = XMALLOC (struct dump_context);

  d->func = func;

  d->mode = FOPEN_WB;

  set_cmd_context (c, d);

  c->func = call_dump_func;

  c = add_cmd (name, all_commands, NULL, descr, &append_cmdlist);

  c->completer =  filename_completer;

  d = XMALLOC (struct dump_context);

  d->func = func;

  d->mode = FOPEN_AB;

  set_cmd_context (c, d);

  c->func = call_dump_func;

  /* Replace "Dump " at start of docstring with "Append " (borrowed

     from [deleted] deprecated_add_show_from_set).  */

  if (   c->doc[0] == 'W'

      && c->doc[1] == 'r'

      && c->doc[2] == 'i'

      && c->doc[3] == 't'

      && c->doc[4] == 'e'

      && c->doc[5] == ' ')

    c->doc = concat ("Append ", c->doc + 6, (char *)NULL);

}

/* Opaque data for restore_section_callback. */

struct callback_data {

  long load_offset;

  CORE_ADDR load_start;

  CORE_ADDR load_end;

};

/* Function: restore_section_callback.

   Callback function for bfd_map_over_sections.

   Selectively loads the sections into memory.  */

static void

restore_section_callback (bfd *ibfd, asection *isec, void *args)

{

  struct callback_data *data = args;

  bfd_vma sec_start  = bfd_section_vma (ibfd, isec);

  bfd_size_type size = bfd_section_size (ibfd, isec);

  bfd_vma sec_end    = sec_start + size;

  bfd_size_type sec_offset = 0;

  bfd_size_type sec_load_count = size;

  struct cleanup *old_chain;

  gdb_byte *buf;

  int ret;

  /* Ignore non-loadable sections, eg. from elf files. */

  if (!(bfd_get_section_flags (ibfd, isec) & SEC_LOAD))

    return;

  /* Does the section overlap with the desired restore range? */

  if (sec_end <= data->load_start

      || (data->load_end > 0 && sec_start >= data->load_end))

    {

      /* No, no useable data in this section. */

      printf_filtered (_("skipping section %s...\n"),

                       bfd_section_name (ibfd, isec));

      return;

    }

  /* Compare section address range with user-requested

     address range (if any).  Compute where the actual

     transfer should start and end.  */

  if (sec_start < data->load_start)

    sec_offset = data->load_start - sec_start;

  /* Size of a partial transfer: */

  sec_load_count -= sec_offset;

  if (data->load_end > 0 && sec_end > data->load_end)

    sec_load_count -= sec_end - data->load_end;

  /* Get the data.  */

  buf = xmalloc (size);

  old_chain = make_cleanup (xfree, buf);

  if (!bfd_get_section_contents (ibfd, isec, buf, 0, size))

    error (_("Failed to read bfd file %s: '%s'."), bfd_get_filename (ibfd),

           bfd_errmsg (bfd_get_error ()));

  printf_filtered ("Restoring section %s (0x%lx to 0x%lx)",

                   bfd_section_name (ibfd, isec),

                   (unsigned long) sec_start,

                   (unsigned long) sec_end);

  if (data->load_offset != 0 || data->load_start != 0 || data->load_end != 0)

    printf_filtered (" into memory (0x%s to 0x%s)\n",

                     paddr_nz ((unsigned long) sec_start

                               + sec_offset + data->load_offset),

                     paddr_nz ((unsigned long) sec_start + sec_offset

                       + data->load_offset + sec_load_count));

  else

    puts_filtered ("\n");

  /* Write the data.  */

  ret = target_write_memory (sec_start + sec_offset + data->load_offset,

                             buf + sec_offset, sec_load_count);

  if (ret != 0)

    warning (_("restore: memory write failed (%s)."), safe_strerror (ret));

  do_cleanups (old_chain);

  return;

}

static void

restore_binary_file (char *filename, struct callback_data *data)

{

  FILE *file = fopen_with_cleanup (filename, FOPEN_RB);

  int status;

  gdb_byte *buf;

  long len;

  /* Get the file size for reading.  */

  if (fseek (file, 0, SEEK_END) == 0)

    len = ftell (file);

  else

    perror_with_name (filename);

  if (len <= data->load_start)

    error (_("Start address is greater than length of binary file %s."),

           filename);

  /* Chop off "len" if it exceeds the requested load_end addr. */

  if (data->load_end != 0 && data->load_end < len)

    len = data->load_end;

  /* Chop off "len" if the requested load_start addr skips some bytes. */

  if (data->load_start > 0)

    len -= data->load_start;

  printf_filtered

    ("Restoring binary file %s into memory (0x%lx to 0x%lx)\n",

     filename,

     (unsigned long) data->load_start + data->load_offset,

     (unsigned long) data->load_start + data->load_offset + len);

  /* Now set the file pos to the requested load start pos.  */

  if (fseek (file, data->load_start, SEEK_SET) != 0)

    perror_with_name (filename);

  /* Now allocate a buffer and read the file contents.  */

  buf = xmalloc (len);

  make_cleanup (xfree, buf);

  if (fread (buf, 1, len, file) != len)

    perror_with_name (filename);

  /* Now write the buffer into target memory. */

  len = target_write_memory (data->load_start + data->load_offset, buf, len);

  if (len != 0)

    warning (_("restore: memory write failed (%s)."), safe_strerror (len));

  return;

}

static void

restore_command (char *args, int from_tty)

{

  char *filename;

  struct callback_data data;

  bfd *ibfd;

  int binary_flag = 0;

  if (!target_has_execution)

    noprocess ();

  data.load_offset = 0;

  data.load_start  = 0;

  data.load_end    = 0;

  /* Parse the input arguments.  First is filename (required). */

  filename = scan_filename_with_cleanup (&args, NULL);

  if (args != NULL && *args != '\0')

    {

      char *binary_string = "binary";

      /* Look for optional "binary" flag.  */

      if (strncmp (args, binary_string, strlen (binary_string)) == 0)

        {

          binary_flag = 1;

          args += strlen (binary_string);

          args = skip_spaces (args);

        }

      /* Parse offset (optional). */

      if (args != NULL && *args != '\0')

      data.load_offset =

        parse_and_eval_long (scan_expression_with_cleanup (&args, NULL));

      if (args != NULL && *args != '\0')

        {

          /* Parse start address (optional). */

          data.load_start =

            parse_and_eval_long (scan_expression_with_cleanup (&args, NULL));

          if (args != NULL && *args != '\0')

            {

              /* Parse end address (optional). */

              data.load_end = parse_and_eval_long (args);

              if (data.load_end <= data.load_start)

                error (_("Start must be less than end."));

            }

        }

    }

  if (info_verbose)

    printf_filtered ("Restore file %s offset 0x%lx start 0x%lx end 0x%lx\n",

                     filename, (unsigned long) data.load_offset,

                     (unsigned long) data.load_start,

                     (unsigned long) data.load_end);

  if (binary_flag)

    {

      restore_binary_file (filename, &data);

    }

  else

    {

      /* Open the file for loading. */

      ibfd = bfd_openr_with_cleanup (filename, NULL);

      /* Process the sections. */

      bfd_map_over_sections (ibfd, restore_section_callback, &data);

    }

  return;

}

static void

srec_dump_command (char *cmd, int from_tty)

{

  printf_unfiltered ("\"dump srec\" must be followed by a subcommand.\n");

  help_list (srec_cmdlist, "dump srec ", -1, gdb_stdout);

}

static void

ihex_dump_command (char *cmd, int from_tty)

{

  printf_unfiltered ("\"dump ihex\" must be followed by a subcommand.\n");

  help_list (ihex_cmdlist, "dump ihex ", -1, gdb_stdout);

}