1 /* Miscellaneous simulator utilities.
2 Copyright (C) 1997-2021 Free Software Foundation, Inc.
3 Contributed by Cygnus Support.
5 This file is part of GDB, the GNU debugger.
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.
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.
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/>. */
20 /* This must come before any other includes. */
24 #include "sim-assert.h"
28 #include <sys/time.h> /* needed by sys/resource.h */
30 #ifdef HAVE_SYS_RESOURCE_H
31 #include <sys/resource.h>
35 #include "libiberty.h"
37 #include "sim-utils.h"
39 /* Allocate zero filled memory with xcalloc - xcalloc aborts if the
43 zalloc (unsigned long size
)
45 return xcalloc (1, size
);
48 /* Allocate a sim_state struct. */
51 sim_state_alloc_extra (SIM_OPEN_KIND kind
, host_callback
*callback
,
54 SIM_DESC sd
= ZALLOC (struct sim_state
);
56 STATE_MAGIC (sd
) = SIM_MAGIC_NUMBER
;
57 STATE_CALLBACK (sd
) = callback
;
58 STATE_OPEN_KIND (sd
) = kind
;
61 STATE_ARCH_DATA (sd
) = zalloc (extra_bytes
);
67 /* Initialize the back link from the cpu struct to the state struct. */
68 /* ??? I can envision a design where the state struct contains an array
69 of pointers to cpu structs, rather than an array of structs themselves.
70 Implementing this is trickier as one may not know what to allocate until
71 one has parsed the args. Parsing the args twice wouldn't be unreasonable,
72 IMHO. If the state struct ever does contain an array of pointers then we
74 ??? See also sim_post_argv_init*/
75 for (cpu_nr
= 0; cpu_nr
< MAX_NR_PROCESSORS
; cpu_nr
++)
77 CPU_STATE (STATE_CPU (sd
, cpu_nr
)) = sd
;
78 CPU_INDEX (STATE_CPU (sd
, cpu_nr
)) = cpu_nr
;
90 /* Free a sim_state struct. */
93 sim_state_free (SIM_DESC sd
)
95 ASSERT (STATE_MAGIC (sd
) == SIM_MAGIC_NUMBER
);
104 /* Return a pointer to the cpu data for CPU_NAME, or NULL if not found. */
107 sim_cpu_lookup (SIM_DESC sd
, const char *cpu_name
)
111 for (i
= 0; i
< MAX_NR_PROCESSORS
; ++i
)
112 if (strcmp (cpu_name
, CPU_NAME (STATE_CPU (sd
, i
))) == 0)
113 return STATE_CPU (sd
, i
);
117 /* Return the prefix to use for a CPU specific message (typically an
121 sim_cpu_msg_prefix (sim_cpu
*cpu
)
123 #if MAX_NR_PROCESSORS == 1
131 for (i
= 0; i
< MAX_NR_PROCESSORS
; ++i
)
133 int len
= strlen (CPU_NAME (STATE_CPU (sd
, i
)));
137 prefix
= (char *) xmalloc (maxlen
+ 5);
139 sprintf (prefix
, "%s: ", CPU_NAME (cpu
));
144 /* Cover fn to sim_io_eprintf. */
147 sim_io_eprintf_cpu (sim_cpu
*cpu
, const char *fmt
, ...)
149 SIM_DESC sd
= CPU_STATE (cpu
);
153 sim_io_eprintf (sd
, "%s", sim_cpu_msg_prefix (cpu
));
154 sim_io_evprintf (sd
, fmt
, ap
);
158 /* Turn VALUE into a string with commas. */
161 sim_add_commas (char *buf
, int sizeof_buf
, unsigned long value
)
164 char *endbuf
= buf
+ sizeof_buf
- 1;
174 *--endbuf
= (value
% 10) + '0';
175 } while ((value
/= 10) != 0);
180 /* Analyze PROG_NAME/PROG_BFD and set these fields in the state struct:
181 STATE_ARCHITECTURE, if not set already and can be determined from the bfd
188 PROG_NAME is the file name of the executable or NULL.
189 PROG_BFD is its bfd or NULL.
191 If both PROG_NAME and PROG_BFD are NULL, this function returns immediately.
192 If PROG_BFD is not NULL, PROG_NAME is ignored.
194 Implicit inputs: STATE_MY_NAME(sd), STATE_TARGET(sd),
195 STATE_ARCHITECTURE(sd).
197 A new bfd is created so the app isn't required to keep its copy of the
201 sim_analyze_program (SIM_DESC sd
, const char *prog_name
, bfd
*prog_bfd
)
204 SIM_ASSERT (STATE_MAGIC (sd
) == SIM_MAGIC_NUMBER
);
206 if (prog_bfd
!= NULL
)
208 if (prog_bfd
== STATE_PROG_BFD (sd
))
209 /* already analyzed */
212 /* duplicate needed, save the name of the file to be re-opened */
213 prog_name
= bfd_get_filename (prog_bfd
);
216 /* do we need to duplicate anything? */
217 if (prog_name
== NULL
)
220 /* open a new copy of the prog_bfd */
221 prog_bfd
= bfd_openr (prog_name
, STATE_TARGET (sd
));
222 if (prog_bfd
== NULL
)
224 sim_io_eprintf (sd
, "%s: can't open \"%s\": %s\n",
227 bfd_errmsg (bfd_get_error ()));
230 if (!bfd_check_format (prog_bfd
, bfd_object
))
232 sim_io_eprintf (sd
, "%s: \"%s\" is not an object file: %s\n",
235 bfd_errmsg (bfd_get_error ()));
236 bfd_close (prog_bfd
);
239 if (STATE_ARCHITECTURE (sd
) != NULL
)
240 bfd_set_arch_info (prog_bfd
, STATE_ARCHITECTURE (sd
));
243 if (bfd_get_arch (prog_bfd
) != bfd_arch_unknown
244 && bfd_get_arch (prog_bfd
) != bfd_arch_obscure
)
246 STATE_ARCHITECTURE (sd
) = bfd_get_arch_info (prog_bfd
);
250 /* update the sim structure */
251 if (STATE_PROG_BFD (sd
) != NULL
)
252 bfd_close (STATE_PROG_BFD (sd
));
253 STATE_PROG_BFD (sd
) = prog_bfd
;
254 STATE_START_ADDR (sd
) = bfd_get_start_address (prog_bfd
);
256 for (s
= prog_bfd
->sections
; s
; s
= s
->next
)
257 if (strcmp (bfd_section_name (s
), ".text") == 0)
259 STATE_TEXT_SECTION (sd
) = s
;
260 STATE_TEXT_START (sd
) = bfd_section_vma (s
);
261 STATE_TEXT_END (sd
) = STATE_TEXT_START (sd
) + bfd_section_size (s
);
265 bfd_cache_close (prog_bfd
);
270 /* Simulator timing support. */
272 /* Called before sim_elapsed_time_since to get a reference point. */
275 sim_elapsed_time_get (void)
277 #ifdef HAVE_GETRUSAGE
278 struct rusage mytime
;
279 if (getrusage (RUSAGE_SELF
, &mytime
) == 0)
280 return 1 + (SIM_ELAPSED_TIME
) (((double) mytime
.ru_utime
.tv_sec
* 1000) + (((double) mytime
.ru_utime
.tv_usec
+ 500) / 1000));
284 return 1 + (SIM_ELAPSED_TIME
) time ((time_t) 0);
291 /* Return the elapsed time in milliseconds since START.
292 The actual time may be cpu usage (preferred) or wall clock. */
295 sim_elapsed_time_since (SIM_ELAPSED_TIME start
)
297 #ifdef HAVE_GETRUSAGE
298 return sim_elapsed_time_get () - start
;
301 return (sim_elapsed_time_get () - start
) * 1000;
310 /* do_command but with printf style formatting of the arguments */
312 sim_do_commandf (SIM_DESC sd
,
321 ret
= vasprintf (&buf
, fmt
, ap
);
326 sim_io_eprintf (sd
, "%s: asprintf failed for `%s'\n",
327 STATE_MY_NAME (sd
), fmt
);
331 sim_do_command (sd
, buf
);
336 /* sim-basics.h defines a number of enumerations, convert each of them
337 to a string representation */
339 map_to_str (unsigned map
)
343 case read_map
: return "read";
344 case write_map
: return "write";
345 case exec_map
: return "exec";
346 case io_map
: return "io";
350 snprintf (str
, sizeof(str
), "(%ld)", (long) map
);
357 access_to_str (unsigned access
)
361 case access_invalid
: return "invalid";
362 case access_read
: return "read";
363 case access_write
: return "write";
364 case access_exec
: return "exec";
365 case access_io
: return "io";
366 case access_read_write
: return "read_write";
367 case access_read_exec
: return "read_exec";
368 case access_write_exec
: return "write_exec";
369 case access_read_write_exec
: return "read_write_exec";
370 case access_read_io
: return "read_io";
371 case access_write_io
: return "write_io";
372 case access_read_write_io
: return "read_write_io";
373 case access_exec_io
: return "exec_io";
374 case access_read_exec_io
: return "read_exec_io";
375 case access_write_exec_io
: return "write_exec_io";
376 case access_read_write_exec_io
: return "read_write_exec_io";
380 snprintf (str
, sizeof(str
), "(%ld)", (long) access
);
387 transfer_to_str (unsigned transfer
)
391 case read_transfer
: return "read";
392 case write_transfer
: return "write";
393 default: return "(error)";