sim/common/sim-load.c

   1 /* Utility to load a file into the simulator.
   2    Copyright (C) 1997-2019 Free Software Foundation, Inc.
   3
   4 This program is free software; you can redistribute it and/or modify
   5 it under the terms of the GNU General Public License as published by
   6 the Free Software Foundation; either version 3 of the License, or
   7 (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 GNU General Public License for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  16
  17 /* This is a standalone loader, independent of the sim-basic.h machinery,
  18    as it is used by simulators that don't use it [though that doesn't mean
  19    to suggest that they shouldn't :-)].  */
  20
  21 #ifdef HAVE_CONFIG_H
  22 #include "config.h"
  23 #endif
  24 #include "ansidecl.h"
  25 #include <stdio.h> /* for NULL */
  26 #include <stdarg.h>
  27 #ifdef HAVE_STDLIB_H
  28 #include <stdlib.h>
  29 #endif
  30 #include <time.h>
  31
  32 #include "sim-basics.h"
  33 #include "bfd.h"
  34 #include "sim-utils.h"
  35
  36 #include "gdb/callback.h"
  37 #include "gdb/remote-sim.h"
  38
  39 static void eprintf (host_callback *, const char *, ...);
  40 static void xprintf (host_callback *, const char *, ...);
  41 static void report_transfer_performance
  42   (host_callback *, unsigned long, time_t, time_t);
  43 static void xprintf_bfd_vma (host_callback *, bfd_vma);
  44
  45 /* Load program PROG into the simulator using the function DO_LOAD.
  46    If PROG_BFD is non-NULL, the file has already been opened.
  47    If VERBOSE_P is non-zero statistics are printed of each loaded section
  48    and the transfer rate (for consistency with gdb).
  49    If LMA_P is non-zero the program sections are loaded at the LMA
  50    rather than the VMA
  51    If this fails an error message is printed and NULL is returned.
  52    If it succeeds the bfd is returned.
  53    NOTE: For historical reasons, older hardware simulators incorrectly
  54    write the program sections at LMA interpreted as a virtual address.
  55    This is still accommodated for backward compatibility reasons. */
  56
  57
  58 bfd *
  59 sim_load_file (SIM_DESC sd, const char *myname, host_callback *callback,
  60                const char *prog, bfd *prog_bfd, int verbose_p, int lma_p,
  61                sim_write_fn do_write)
  62 {
  63   asection *s;
  64   /* Record separately as we don't want to close PROG_BFD if it was passed.  */
  65   bfd *result_bfd;
  66   time_t start_time = 0;        /* Start and end times of download */
  67   time_t end_time = 0;
  68   unsigned long data_count = 0; /* Number of bytes transferred to memory */
  69   int found_loadable_section;
  70
  71   if (prog_bfd != NULL)
  72     result_bfd = prog_bfd;
  73   else
  74     {
  75       result_bfd = bfd_openr (prog, 0);
  76       if (result_bfd == NULL)
  77         {
  78           eprintf (callback, "%s: can't open \"%s\": %s\n",
  79                    myname, prog, bfd_errmsg (bfd_get_error ()));
  80           return NULL;
  81         }
  82     }
  83
  84   if (!bfd_check_format (result_bfd, bfd_object))
  85     {
  86       eprintf (callback, "%s: \"%s\" is not an object file: %s\n",
  87                myname, prog, bfd_errmsg (bfd_get_error ()));
  88       /* Only close if we opened it.  */
  89       if (prog_bfd == NULL)
  90         bfd_close (result_bfd);
  91       return NULL;
  92     }
  93
  94   if (verbose_p)
  95     start_time = time (NULL);
  96
  97   found_loadable_section = 0;
  98   for (s = result_bfd->sections; s; s = s->next)
  99     {
 100       if (s->flags & SEC_LOAD)
 101         {
 102           bfd_size_type size;
 103
 104           size = bfd_get_section_size (s);
 105           if (size > 0)
 106             {
 107               unsigned char *buffer;
 108               bfd_vma lma;
 109
 110               buffer = malloc (size);
 111               if (buffer == NULL)
 112                 {
 113                   eprintf (callback,
 114                            "%s: insufficient memory to load \"%s\"\n",
 115                            myname, prog);
 116                   /* Only close if we opened it.  */
 117                   if (prog_bfd == NULL)
 118                     bfd_close (result_bfd);
 119                   return NULL;
 120                 }
 121               if (lma_p)
 122                 lma = bfd_section_lma (result_bfd, s);
 123               else
 124                 lma = bfd_section_vma (result_bfd, s);
 125               if (verbose_p)
 126                 {
 127                   xprintf (callback, "Loading section %s, size 0x%lx %s ",
 128                            bfd_get_section_name (result_bfd, s),
 129                            (unsigned long) size,
 130                            (lma_p ? "lma" : "vma"));
 131                   xprintf_bfd_vma (callback, lma);
 132                   xprintf (callback, "\n");
 133                 }
 134               data_count += size;
 135               bfd_get_section_contents (result_bfd, s, buffer, 0, size);
 136               do_write (sd, lma, buffer, size);
 137               found_loadable_section = 1;
 138               free (buffer);
 139             }
 140         }
 141     }
 142
 143   if (!found_loadable_section)
 144     {
 145       eprintf (callback,
 146                "%s: no loadable sections \"%s\"\n",
 147                myname, prog);
 148       return NULL;
 149     }
 150
 151   if (verbose_p)
 152     {
 153       end_time = time (NULL);
 154       xprintf (callback, "Start address ");
 155       xprintf_bfd_vma (callback, bfd_get_start_address (result_bfd));
 156       xprintf (callback, "\n");
 157       report_transfer_performance (callback, data_count, start_time, end_time);
 158     }
 159
 160   bfd_cache_close (result_bfd);
 161
 162   return result_bfd;
 163 }
 164
 165 static void
 166 xprintf (host_callback *callback, const char *fmt, ...)
 167 {
 168   va_list ap;
 169
 170   va_start (ap, fmt);
 171
 172   (*callback->vprintf_filtered) (callback, fmt, ap);
 173
 174   va_end (ap);
 175 }
 176
 177 static void
 178 eprintf (host_callback *callback, const char *fmt, ...)
 179 {
 180   va_list ap;
 181
 182   va_start (ap, fmt);
 183
 184   (*callback->evprintf_filtered) (callback, fmt, ap);
 185
 186   va_end (ap);
 187 }
 188
 189 /* Report how fast the transfer went. */
 190
 191 static void
 192 report_transfer_performance (host_callback *callback, unsigned long data_count,
 193                              time_t start_time, time_t end_time)
 194 {
 195   xprintf (callback, "Transfer rate: ");
 196   if (end_time != start_time)
 197     xprintf (callback, "%ld bits/sec",
 198              (data_count * 8) / (end_time - start_time));
 199   else
 200     xprintf (callback, "%ld bits in <1 sec", (data_count * 8));
 201   xprintf (callback, ".\n");
 202 }
 203
 204 /* Print a bfd_vma.
 205    This is intended to handle the vagaries of 32 vs 64 bits, etc.  */
 206
 207 static void
 208 xprintf_bfd_vma (host_callback *callback, bfd_vma vma)
 209 {
 210   /* FIXME: for now */
 211   xprintf (callback, "0x%lx", (unsigned long) vma);
 212 }