1 /* Core dump and executable file functions above target vector, for GDB.
3 Copyright (C) 1986-2014 Free Software Foundation, Inc.
5 This file is part of GDB.
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/>. */
32 #include "completer.h"
33 #include "exceptions.h"
35 #include "cli/cli-utils.h"
37 /* Local function declarations. */
39 extern void _initialize_core (void);
41 /* You can have any number of hooks for `exec_file_command' command to
42 call. If there's only one hook, it is set in exec_file_display
43 hook. If there are two or more hooks, they are set in
44 exec_file_extra_hooks[], and deprecated_exec_file_display_hook is
45 set to a function that calls all of them. This extra complexity is
46 needed to preserve compatibility with old code that assumed that
47 only one hook could be set, and which called
48 deprecated_exec_file_display_hook directly. */
50 typedef void (*hook_type) (const char *);
52 hook_type deprecated_exec_file_display_hook; /* The original hook. */
53 static hook_type *exec_file_extra_hooks; /* Array of additional
55 static int exec_file_hook_count = 0; /* Size of array. */
57 /* Binary file diddling handle for the core file. */
61 /* corelow.c target. It is never NULL after GDB initialization. */
63 struct target_ops *core_target;
66 /* Backward compatability with old way of specifying core files. */
69 core_file_command (char *filename, int from_tty)
71 dont_repeat (); /* Either way, seems bogus. */
73 gdb_assert (core_target != NULL);
76 (core_target->to_detach) (core_target, filename, from_tty);
78 (core_target->to_open) (filename, from_tty);
82 /* If there are two or more functions that wish to hook into
83 exec_file_command, this function will call all of the hook
87 call_extra_exec_file_hooks (const char *filename)
91 for (i = 0; i < exec_file_hook_count; i++)
92 (*exec_file_extra_hooks[i]) (filename);
95 /* Call this to specify the hook for exec_file_command to call back.
96 This is called from the x-window display code. */
99 specify_exec_file_hook (void (*hook) (const char *))
101 hook_type *new_array;
103 if (deprecated_exec_file_display_hook != NULL)
105 /* There's already a hook installed. Arrange to have both it
106 and the subsequent hooks called. */
107 if (exec_file_hook_count == 0)
109 /* If this is the first extra hook, initialize the hook
111 exec_file_extra_hooks = (hook_type *)
112 xmalloc (sizeof (hook_type));
113 exec_file_extra_hooks[0] = deprecated_exec_file_display_hook;
114 deprecated_exec_file_display_hook = call_extra_exec_file_hooks;
115 exec_file_hook_count = 1;
118 /* Grow the hook array by one and add the new hook to the end.
119 Yes, it's inefficient to grow it by one each time but since
120 this is hardly ever called it's not a big deal. */
121 exec_file_hook_count++;
122 new_array = (hook_type *)
123 xrealloc (exec_file_extra_hooks,
124 exec_file_hook_count * sizeof (hook_type));
125 exec_file_extra_hooks = new_array;
126 exec_file_extra_hooks[exec_file_hook_count - 1] = hook;
129 deprecated_exec_file_display_hook = hook;
133 reopen_exec_file (void)
138 struct cleanup *cleanups;
140 /* Don't do anything if there isn't an exec file. */
141 if (exec_bfd == NULL)
144 /* If the timestamp of the exec file has changed, reopen it. */
145 filename = xstrdup (bfd_get_filename (exec_bfd));
146 cleanups = make_cleanup (xfree, filename);
147 res = stat (filename, &st);
149 if (exec_bfd_mtime && exec_bfd_mtime != st.st_mtime)
150 exec_file_attach (filename, 0);
152 /* If we accessed the file since last opening it, close it now;
153 this stops GDB from holding the executable open after it
155 bfd_cache_close_all ();
157 do_cleanups (cleanups);
160 /* If we have both a core file and an exec file,
161 print a warning if they don't go together. */
164 validate_files (void)
166 if (exec_bfd && core_bfd)
168 if (!core_file_matches_executable_p (core_bfd, exec_bfd))
169 warning (_("core file may not match specified executable file."));
170 else if (bfd_get_mtime (exec_bfd) > bfd_get_mtime (core_bfd))
171 warning (_("exec file is newer than core file."));
175 /* Return the name of the executable file as a string.
176 ERR nonzero means get error if there is none specified;
177 otherwise return 0 in that case. */
180 get_exec_file (int err)
183 return exec_filename;
187 error (_("No executable file specified.\n\
188 Use the \"file\" or \"exec-file\" command."));
194 memory_error_message (enum target_xfer_status err,
195 struct gdbarch *gdbarch, CORE_ADDR memaddr)
199 case TARGET_XFER_E_IO:
200 /* Actually, address between memaddr and memaddr + len was out of
202 return xstrprintf (_("Cannot access memory at address %s"),
203 paddress (gdbarch, memaddr));
204 case TARGET_XFER_UNAVAILABLE:
205 return xstrprintf (_("Memory at address %s unavailable."),
206 paddress (gdbarch, memaddr));
208 internal_error (__FILE__, __LINE__,
209 "unhandled target_xfer_status: %s (%s)",
210 target_xfer_status_to_string (err),
215 /* Report a memory error by throwing a suitable exception. */
218 memory_error (enum target_xfer_status err, CORE_ADDR memaddr)
221 enum errors exception = GDB_NO_ERROR;
223 /* Build error string. */
224 str = memory_error_message (err, target_gdbarch (), memaddr);
225 make_cleanup (xfree, str);
227 /* Choose the right error to throw. */
230 case TARGET_XFER_E_IO:
231 exception = MEMORY_ERROR;
233 case TARGET_XFER_UNAVAILABLE:
234 exception = NOT_AVAILABLE_ERROR;
239 throw_error (exception, ("%s"), str);
242 /* Same as target_read_memory, but report an error if can't read. */
245 read_memory (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len)
251 enum target_xfer_status status;
254 status = target_xfer_partial (current_target.beneath,
255 TARGET_OBJECT_MEMORY, NULL,
256 myaddr + xfered, NULL,
257 memaddr + xfered, len - xfered,
260 if (status != TARGET_XFER_OK)
261 memory_error (status == TARGET_XFER_EOF ? TARGET_XFER_E_IO : status,
264 xfered += xfered_len;
269 /* Same as target_read_stack, but report an error if can't read. */
272 read_stack (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len)
276 status = target_read_stack (memaddr, myaddr, len);
278 memory_error (status, memaddr);
281 /* Same as target_read_code, but report an error if can't read. */
284 read_code (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len)
288 status = target_read_code (memaddr, myaddr, len);
290 memory_error (status, memaddr);
293 /* Argument / return result struct for use with
294 do_captured_read_memory_integer(). MEMADDR and LEN are filled in
295 by gdb_read_memory_integer(). RESULT is the contents that were
296 successfully read from MEMADDR of length LEN. */
298 struct captured_read_memory_integer_arguments
302 enum bfd_endian byte_order;
306 /* Helper function for gdb_read_memory_integer(). DATA must be a
307 pointer to a captured_read_memory_integer_arguments struct.
308 Return 1 if successful. Note that the catch_errors() interface
309 will return 0 if an error occurred while reading memory. This
310 choice of return code is so that we can distinguish between
311 success and failure. */
314 do_captured_read_memory_integer (void *data)
316 struct captured_read_memory_integer_arguments *args
317 = (struct captured_read_memory_integer_arguments*) data;
318 CORE_ADDR memaddr = args->memaddr;
320 enum bfd_endian byte_order = args->byte_order;
322 args->result = read_memory_integer (memaddr, len, byte_order);
327 /* Read memory at MEMADDR of length LEN and put the contents in
328 RETURN_VALUE. Return 0 if MEMADDR couldn't be read and non-zero
332 safe_read_memory_integer (CORE_ADDR memaddr, int len,
333 enum bfd_endian byte_order,
334 LONGEST *return_value)
337 struct captured_read_memory_integer_arguments args;
339 args.memaddr = memaddr;
341 args.byte_order = byte_order;
343 status = catch_errors (do_captured_read_memory_integer, &args,
344 "", RETURN_MASK_ALL);
346 *return_value = args.result;
352 read_memory_integer (CORE_ADDR memaddr, int len,
353 enum bfd_endian byte_order)
355 gdb_byte buf[sizeof (LONGEST)];
357 read_memory (memaddr, buf, len);
358 return extract_signed_integer (buf, len, byte_order);
362 read_memory_unsigned_integer (CORE_ADDR memaddr, int len,
363 enum bfd_endian byte_order)
365 gdb_byte buf[sizeof (ULONGEST)];
367 read_memory (memaddr, buf, len);
368 return extract_unsigned_integer (buf, len, byte_order);
372 read_code_integer (CORE_ADDR memaddr, int len,
373 enum bfd_endian byte_order)
375 gdb_byte buf[sizeof (LONGEST)];
377 read_code (memaddr, buf, len);
378 return extract_signed_integer (buf, len, byte_order);
382 read_code_unsigned_integer (CORE_ADDR memaddr, int len,
383 enum bfd_endian byte_order)
385 gdb_byte buf[sizeof (ULONGEST)];
387 read_code (memaddr, buf, len);
388 return extract_unsigned_integer (buf, len, byte_order);
392 read_memory_string (CORE_ADDR memaddr, char *buffer, int max_len)
401 if (cp - buffer >= max_len)
403 buffer[max_len - 1] = '\0';
406 cnt = max_len - (cp - buffer);
409 read_memory (memaddr + (int) (cp - buffer), (gdb_byte *) cp, cnt);
410 for (i = 0; i < cnt && *cp; i++, cp++)
419 read_memory_typed_address (CORE_ADDR addr, struct type *type)
421 gdb_byte *buf = alloca (TYPE_LENGTH (type));
423 read_memory (addr, buf, TYPE_LENGTH (type));
424 return extract_typed_address (buf, type);
427 /* Same as target_write_memory, but report an error if can't
430 write_memory (CORE_ADDR memaddr,
431 const bfd_byte *myaddr, ssize_t len)
435 status = target_write_memory (memaddr, myaddr, len);
437 memory_error (status, memaddr);
440 /* Same as write_memory, but notify 'memory_changed' observers. */
443 write_memory_with_notification (CORE_ADDR memaddr, const bfd_byte *myaddr,
446 write_memory (memaddr, myaddr, len);
447 observer_notify_memory_changed (current_inferior (), memaddr, len, myaddr);
450 /* Store VALUE at ADDR in the inferior as a LEN-byte unsigned
453 write_memory_unsigned_integer (CORE_ADDR addr, int len,
454 enum bfd_endian byte_order,
457 gdb_byte *buf = alloca (len);
459 store_unsigned_integer (buf, len, byte_order, value);
460 write_memory (addr, buf, len);
463 /* Store VALUE at ADDR in the inferior as a LEN-byte signed
466 write_memory_signed_integer (CORE_ADDR addr, int len,
467 enum bfd_endian byte_order,
470 gdb_byte *buf = alloca (len);
472 store_signed_integer (buf, len, byte_order, value);
473 write_memory (addr, buf, len);
476 /* The current default bfd target. Points to storage allocated for
480 /* Same thing, except it is "auto" not NULL for the default case. */
481 static char *gnutarget_string;
483 show_gnutarget_string (struct ui_file *file, int from_tty,
484 struct cmd_list_element *c,
487 fprintf_filtered (file,
488 _("The current BFD target is \"%s\".\n"), value);
491 static void set_gnutarget_command (char *, int,
492 struct cmd_list_element *);
495 set_gnutarget_command (char *ignore, int from_tty,
496 struct cmd_list_element *c)
498 char *gend = gnutarget_string + strlen (gnutarget_string);
500 gend = remove_trailing_whitespace (gnutarget_string, gend);
503 if (strcmp (gnutarget_string, "auto") == 0)
506 gnutarget = gnutarget_string;
509 /* A completion function for "set gnutarget". */
511 static VEC (char_ptr) *
512 complete_set_gnutarget (struct cmd_list_element *cmd,
513 const char *text, const char *word)
515 static const char **bfd_targets;
517 if (bfd_targets == NULL)
521 bfd_targets = bfd_target_list ();
522 for (last = 0; bfd_targets[last] != NULL; ++last)
525 bfd_targets = xrealloc (bfd_targets, (last + 2) * sizeof (const char **));
526 bfd_targets[last] = "auto";
527 bfd_targets[last + 1] = NULL;
530 return complete_on_enum (bfd_targets, text, word);
533 /* Set the gnutarget. */
535 set_gnutarget (char *newtarget)
537 if (gnutarget_string != NULL)
538 xfree (gnutarget_string);
539 gnutarget_string = xstrdup (newtarget);
540 set_gnutarget_command (NULL, 0, NULL);
544 _initialize_core (void)
546 struct cmd_list_element *c;
548 c = add_cmd ("core-file", class_files, core_file_command, _("\
549 Use FILE as core dump for examining memory and registers.\n\
550 No arg means have no core file. This command has been superseded by the\n\
551 `target core' and `detach' commands."), &cmdlist);
552 set_cmd_completer (c, filename_completer);
555 c = add_setshow_string_noescape_cmd ("gnutarget", class_files,
556 &gnutarget_string, _("\
557 Set the current BFD target."), _("\
558 Show the current BFD target."), _("\
559 Use `set gnutarget auto' to specify automatic detection."),
560 set_gnutarget_command,
561 show_gnutarget_string,
562 &setlist, &showlist);
563 set_cmd_completer (c, complete_set_gnutarget);
565 add_alias_cmd ("g", "gnutarget", class_files, 1, &setlist);
567 if (getenv ("GNUTARGET"))
568 set_gnutarget (getenv ("GNUTARGET"));
570 set_gnutarget ("auto");