| 1 | /* Miscellaneous simulator utilities. |
| 2 | Copyright (C) 1997-2014 Free Software Foundation, Inc. |
| 3 | Contributed by Cygnus Support. |
| 4 | |
| 5 | This file is part of GDB, the GNU debugger. |
| 6 | |
| 7 | This program is free software; you can redistribute it and/or modify |
| 8 | it under the terms of the GNU General Public License as published by |
| 9 | the Free Software Foundation; either version 3 of the License, or |
| 10 | (at your option) any later version. |
| 11 | |
| 12 | This program is distributed in the hope that it will be useful, |
| 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 15 | GNU General Public License for more details. |
| 16 | |
| 17 | You should have received a copy of the GNU General Public License |
| 18 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
| 19 | |
| 20 | #ifndef SIM_UTILS_H |
| 21 | #define SIM_UTILS_H |
| 22 | |
| 23 | /* Memory management with an allocator that clears memory before use. */ |
| 24 | |
| 25 | void *zalloc (unsigned long size); |
| 26 | |
| 27 | #define ZALLOC(TYPE) (TYPE*)zalloc(sizeof (TYPE)) |
| 28 | #define NZALLOC(TYPE,N) (TYPE*)zalloc(sizeof (TYPE) * (N)) |
| 29 | |
| 30 | /* Turn VALUE into a string with commas. */ |
| 31 | char *sim_add_commas (char *, int, unsigned long); |
| 32 | |
| 33 | /* Utilities for elapsed time reporting. */ |
| 34 | |
| 35 | /* Opaque type, known only inside sim_elapsed_time_foo fns. Externally |
| 36 | it is known to never have the value zero. */ |
| 37 | typedef unsigned long SIM_ELAPSED_TIME; |
| 38 | |
| 39 | |
| 40 | /* Get reference point for future call to sim_time_elapsed. */ |
| 41 | SIM_ELAPSED_TIME sim_elapsed_time_get (void); |
| 42 | |
| 43 | /* Elapsed time in milliseconds since START. */ |
| 44 | unsigned long sim_elapsed_time_since (SIM_ELAPSED_TIME start); |
| 45 | |
| 46 | /* Utilities for manipulating the load image. */ |
| 47 | |
| 48 | SIM_RC sim_analyze_program (SIM_DESC sd, char *prog_name, |
| 49 | struct bfd *prog_bfd); |
| 50 | |
| 51 | /* Load program PROG into the simulator using the function DO_LOAD. |
| 52 | If PROG_BFD is non-NULL, the file has already been opened. |
| 53 | If VERBOSE_P is non-zero statistics are printed of each loaded section |
| 54 | and the transfer rate (for consistency with gdb). |
| 55 | If LMA_P is non-zero the program sections are loaded at the LMA |
| 56 | rather than the VMA |
| 57 | If this fails an error message is printed and NULL is returned. |
| 58 | If it succeeds the bfd is returned. |
| 59 | NOTE: For historical reasons, older hardware simulators incorrectly |
| 60 | write the program sections at LMA interpreted as a virtual address. |
| 61 | This is still accommodated for backward compatibility reasons. */ |
| 62 | |
| 63 | typedef int sim_write_fn (SIM_DESC sd, SIM_ADDR mem, |
| 64 | const unsigned char *buf, int length); |
| 65 | struct bfd *sim_load_file (SIM_DESC sd, const char *myname, |
| 66 | host_callback *callback, char *prog, |
| 67 | struct bfd *prog_bfd, int verbose_p, |
| 68 | int lma_p, sim_write_fn do_load); |
| 69 | |
| 70 | /* Internal version of sim_do_command, include formatting */ |
| 71 | void sim_do_commandf (SIM_DESC sd, const char *fmt, ...); |
| 72 | |
| 73 | |
| 74 | /* These are defined in callback.c as cover functions to the vprintf |
| 75 | callbacks. */ |
| 76 | |
| 77 | void sim_cb_printf (host_callback *, const char *, ...); |
| 78 | void sim_cb_eprintf (host_callback *, const char *, ...); |
| 79 | |
| 80 | |
| 81 | /* sim-basics.h defines a number of enumerations, convert each of them |
| 82 | to a string representation */ |
| 83 | const char *map_to_str (unsigned map); |
| 84 | const char *access_to_str (unsigned access); |
| 85 | const char *transfer_to_str (unsigned transfer); |
| 86 | |
| 87 | #endif |