[thirdparty/binutils-gdb.git] / sim / common / sim-load.c

/* Utility to load a file into the simulator.
   Copyright (C) 1997-2013 Free Software Foundation, Inc.

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/>.  */

/* This is a standalone loader, independent of the sim-basic.h machinery,
   as it is used by simulators that don't use it [though that doesn't mean
   to suggest that they shouldn't :-)].  */

#ifdef HAVE_CONFIG_H
#include "cconfig.h"
#endif
#include "ansidecl.h"
#include <stdio.h> /* for NULL */
#include <stdarg.h>
#ifdef HAVE_STDLIB_H
#include <stdlib.h>
#endif
#include <time.h>

#include "sim-basics.h"
#include "bfd.h"
#include "sim-utils.h"

#include "gdb/callback.h"
#include "gdb/remote-sim.h"

static void eprintf PARAMS ((host_callback *, const char *, ...));
static void xprintf PARAMS ((host_callback *, const char *, ...));
static void report_transfer_performance
  PARAMS ((host_callback *, unsigned long, time_t, time_t));
static void xprintf_bfd_vma PARAMS ((host_callback *, bfd_vma));

/* Load program PROG into the simulator using the function DO_LOAD.
   If PROG_BFD is non-NULL, the file has already been opened.
   If VERBOSE_P is non-zero statistics are printed of each loaded section
   and the transfer rate (for consistency with gdb).
   If LMA_P is non-zero the program sections are loaded at the LMA
   rather than the VMA
   If this fails an error message is printed and NULL is returned.
   If it succeeds the bfd is returned.
   NOTE: For historical reasons, older hardware simulators incorrectly
   write the program sections at LMA interpreted as a virtual address.
   This is still accommodated for backward compatibility reasons. */


bfd *
sim_load_file (sd, myname, callback, prog, prog_bfd, verbose_p, lma_p, do_write)
     SIM_DESC sd;
     const char *myname;
     host_callback *callback;
     char *prog;
     bfd *prog_bfd;
     int verbose_p;
     int lma_p;
     sim_write_fn do_write;
{
  asection *s;
  /* Record separately as we don't want to close PROG_BFD if it was passed.  */
  bfd *result_bfd;
  time_t start_time = 0;	/* Start and end times of download */
  time_t end_time = 0;
  unsigned long data_count = 0;	/* Number of bytes transferred to memory */
  int found_loadable_section;

  if (prog_bfd != NULL)
    result_bfd = prog_bfd;
  else
    {
      result_bfd = bfd_openr (prog, 0);
      if (result_bfd == NULL)
	{
	  eprintf (callback, "%s: can't open \"%s\": %s\n",
		   myname, prog, bfd_errmsg (bfd_get_error ()));
	  return NULL;
	}
    }

  if (!bfd_check_format (result_bfd, bfd_object))
    {
      eprintf (callback, "%s: \"%s\" is not an object file: %s\n",
	       myname, prog, bfd_errmsg (bfd_get_error ()));
      /* Only close if we opened it.  */
      if (prog_bfd == NULL)
	bfd_close (result_bfd);
      return NULL;
    }

  if (verbose_p)
    start_time = time (NULL);

  found_loadable_section = 0;
  for (s = result_bfd->sections; s; s = s->next)
    {
      if (s->flags & SEC_LOAD)
	{
	  bfd_size_type size;

	  size = bfd_get_section_size (s);
	  if (size > 0)
	    {
	      unsigned char *buffer;
	      bfd_vma lma;

	      buffer = malloc (size);
	      if (buffer == NULL)
		{
		  eprintf (callback,
			   "%s: insufficient memory to load \"%s\"\n",
			   myname, prog);
		  /* Only close if we opened it.  */
		  if (prog_bfd == NULL)
		    bfd_close (result_bfd);
		  return NULL;
		}
	      if (lma_p)
		lma = bfd_section_lma (result_bfd, s);
	      else
		lma = bfd_section_vma (result_bfd, s);
	      if (verbose_p)
		{
		  xprintf (callback, "Loading section %s, size 0x%lx %s ",
			   bfd_get_section_name (result_bfd, s),
			   (unsigned long) size,
			   (lma_p ? "lma" : "vma"));
		  xprintf_bfd_vma (callback, lma);
		  xprintf (callback, "\n");
		}
	      data_count += size;
	      bfd_get_section_contents (result_bfd, s, buffer, 0, size);
	      do_write (sd, lma, buffer, size);
	      found_loadable_section = 1;
	      free (buffer);
	    }
	}
    }

  if (!found_loadable_section)
    {
      eprintf (callback,
	       "%s: no loadable sections \"%s\"\n",
	       myname, prog);
      return NULL;
    }

  if (verbose_p)
    {
      end_time = time (NULL);
      xprintf (callback, "Start address ");
      xprintf_bfd_vma (callback, bfd_get_start_address (result_bfd));
      xprintf (callback, "\n");
      report_transfer_performance (callback, data_count, start_time, end_time);
    }

  bfd_cache_close (result_bfd);

  return result_bfd;
}

static void
xprintf VPARAMS ((host_callback *callback, const char *fmt, ...))
{
  va_list ap;

  VA_START (ap, fmt);

  (*callback->vprintf_filtered) (callback, fmt, ap);

  va_end (ap);
}

static void
eprintf VPARAMS ((host_callback *callback, const char *fmt, ...))
{
  va_list ap;

  VA_START (ap, fmt);

  (*callback->evprintf_filtered) (callback, fmt, ap);

  va_end (ap);
}

/* Report how fast the transfer went. */

static void
report_transfer_performance (callback, data_count, start_time, end_time)
     host_callback *callback;
     unsigned long data_count;
     time_t start_time, end_time;
{
  xprintf (callback, "Transfer rate: ");
  if (end_time != start_time)
    xprintf (callback, "%ld bits/sec",
	     (data_count * 8) / (end_time - start_time));
  else
    xprintf (callback, "%ld bits in <1 sec", (data_count * 8));
  xprintf (callback, ".\n");
}

/* Print a bfd_vma.
   This is intended to handle the vagaries of 32 vs 64 bits, etc.  */

static void
xprintf_bfd_vma (callback, vma)
     host_callback *callback;
     bfd_vma vma;
{
  /* FIXME: for now */
  xprintf (callback, "0x%lx", (unsigned long) vma);
}
Commit	Line	Data
c906108c	1	/* Utility to load a file into the simulator.
8acc9f48	2	Copyright (C) 1997-2013 Free Software Foundation, Inc.
c906108c SS	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
4744ac1b JB	6	the Free Software Foundation; either version 3 of the License, or
4744ac1b JB	7	(at your option) any later version.
c906108c SS	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
4744ac1b	15	along with this program. If not, see <http://www.gnu.org/licenses/>. */
c906108c SS	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
41ee5402 DJ	21	#ifdef HAVE_CONFIG_H
	22	#include "cconfig.h"
	23	#endif
c906108c SS	24	#include "ansidecl.h"
c906108c SS	25	#include <stdio.h> /* for NULL */
c906108c	26	#include <stdarg.h>
c906108c SS	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
3c25f8c7 AC	36	#include "gdb/callback.h"
3c25f8c7 AC	37	#include "gdb/remote-sim.h"
c906108c SS	38
	39	static void eprintf PARAMS ((host_callback , const char , ...));
	40	static void xprintf PARAMS ((host_callback , const char , ...));
	41	static void report_transfer_performance
	42	PARAMS ((host_callback *, unsigned long, time_t, time_t));
	43	static void xprintf_bfd_vma PARAMS ((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 (sd, myname, callback, prog, prog_bfd, verbose_p, lma_p, do_write)
	60	SIM_DESC sd;
	61	const char *myname;
	62	host_callback *callback;
	63	char *prog;
	64	bfd *prog_bfd;
	65	int verbose_p;
	66	int lma_p;
	67	sim_write_fn do_write;
	68	{
	69	asection *s;
	70	/* Record separately as we don't want to close PROG_BFD if it was passed. */
	71	bfd *result_bfd;
	72	time_t start_time = 0; /* Start and end times of download */
	73	time_t end_time = 0;
	74	unsigned long data_count = 0; /* Number of bytes transferred to memory */
	75	int found_loadable_section;
	76
	77	if (prog_bfd != NULL)
	78	result_bfd = prog_bfd;
	79	else
	80	{
	81	result_bfd = bfd_openr (prog, 0);
	82	if (result_bfd == NULL)
	83	{
028f6515	84	eprintf (callback, "%s: can't open \"%s\": %s\n",
c906108c SS	85	myname, prog, bfd_errmsg (bfd_get_error ()));
	86	return NULL;
	87	}
	88	}
	89
028f6515	90	if (!bfd_check_format (result_bfd, bfd_object))
c906108c SS	91	{
	92	eprintf (callback, "%s: \"%s\" is not an object file: %s\n",
	93	myname, prog, bfd_errmsg (bfd_get_error ()));
	94	/* Only close if we opened it. */
	95	if (prog_bfd == NULL)
	96	bfd_close (result_bfd);
	97	return NULL;
	98	}
	99
	100	if (verbose_p)
	101	start_time = time (NULL);
	102
	103	found_loadable_section = 0;
028f6515	104	for (s = result_bfd->sections; s; s = s->next)
c906108c	105	{
028f6515	106	if (s->flags & SEC_LOAD)
c906108c SS	107	{
	108	bfd_size_type size;
	109
5f510f9c	110	size = bfd_get_section_size (s);
c906108c SS	111	if (size > 0)
c906108c SS	112	{
cc25892b	113	unsigned char *buffer;
c906108c SS	114	bfd_vma lma;
	115
	116	buffer = malloc (size);
	117	if (buffer == NULL)
	118	{
	119	eprintf (callback,
	120	"%s: insufficient memory to load \"%s\"\n",
	121	myname, prog);
	122	/* Only close if we opened it. */
	123	if (prog_bfd == NULL)
	124	bfd_close (result_bfd);
	125	return NULL;
	126	}
	127	if (lma_p)
	128	lma = bfd_section_lma (result_bfd, s);
	129	else
	130	lma = bfd_section_vma (result_bfd, s);
	131	if (verbose_p)
	132	{
	133	xprintf (callback, "Loading section %s, size 0x%lx %s ",
	134	bfd_get_section_name (result_bfd, s),
	135	(unsigned long) size,
	136	(lma_p ? "lma" : "vma"));
	137	xprintf_bfd_vma (callback, lma);
	138	xprintf (callback, "\n");
	139	}
	140	data_count += size;
	141	bfd_get_section_contents (result_bfd, s, buffer, 0, size);
	142	do_write (sd, lma, buffer, size);
	143	found_loadable_section = 1;
	144	free (buffer);
	145	}
	146	}
	147	}
	148
	149	if (!found_loadable_section)
	150	{
	151	eprintf (callback,
	152	"%s: no loadable sections \"%s\"\n",
	153	myname, prog);
	154	return NULL;
	155	}
	156
	157	if (verbose_p)
	158	{
	159	end_time = time (NULL);
	160	xprintf (callback, "Start address ");
	161	xprintf_bfd_vma (callback, bfd_get_start_address (result_bfd));
	162	xprintf (callback, "\n");
	163	report_transfer_performance (callback, data_count, start_time, end_time);
	164	}
	165
2836ee25 FCE	166	bfd_cache_close (result_bfd);
2836ee25 FCE	167
c906108c SS	168	return result_bfd;
	169	}
	170
	171	static void
	172	xprintf VPARAMS ((host_callback callback, const char fmt, ...))
	173	{
c906108c SS	174	va_list ap;
	175
	176	VA_START (ap, fmt);
c906108c SS	177
	178	(*callback->vprintf_filtered) (callback, fmt, ap);
	179
	180	va_end (ap);
	181	}
	182
	183	static void
	184	eprintf VPARAMS ((host_callback callback, const char fmt, ...))
	185	{
c906108c SS	186	va_list ap;
	187
	188	VA_START (ap, fmt);
c906108c SS	189
	190	(*callback->evprintf_filtered) (callback, fmt, ap);
	191
	192	va_end (ap);
	193	}
	194
	195	/* Report how fast the transfer went. */
	196
	197	static void
	198	report_transfer_performance (callback, data_count, start_time, end_time)
	199	host_callback *callback;
	200	unsigned long data_count;
	201	time_t start_time, end_time;
	202	{
	203	xprintf (callback, "Transfer rate: ");
	204	if (end_time != start_time)
	205	xprintf (callback, "%ld bits/sec",
	206	(data_count * 8) / (end_time - start_time));
	207	else
	208	xprintf (callback, "%ld bits in <1 sec", (data_count * 8));
	209	xprintf (callback, ".\n");
	210	}
	211
	212	/* Print a bfd_vma.
	213	This is intended to handle the vagaries of 32 vs 64 bits, etc. */
	214
	215	static void
	216	xprintf_bfd_vma (callback, vma)
	217	host_callback *callback;
	218	bfd_vma vma;
	219	{
	220	/* FIXME: for now */
	221	xprintf (callback, "0x%lx", (unsigned long) vma);
	222	}