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/>. */
34 #include "completer.h"
35 #include "exceptions.h"
37 #include "cli/cli-utils.h"
39 /* Local function declarations. */
41 extern void _initialize_core (void);
42 static void call_extra_exec_file_hooks (char *filename
);
44 /* You can have any number of hooks for `exec_file_command' command to
45 call. If there's only one hook, it is set in exec_file_display
46 hook. If there are two or more hooks, they are set in
47 exec_file_extra_hooks[], and deprecated_exec_file_display_hook is
48 set to a function that calls all of them. This extra complexity is
49 needed to preserve compatibility with old code that assumed that
50 only one hook could be set, and which called
51 deprecated_exec_file_display_hook directly. */
53 typedef void (*hook_type
) (char *);
55 hook_type deprecated_exec_file_display_hook
; /* The original hook. */
56 static hook_type
*exec_file_extra_hooks
; /* Array of additional
58 static int exec_file_hook_count
= 0; /* Size of array. */
60 /* Binary file diddling handle for the core file. */
64 /* corelow.c target. It is never NULL after GDB initialization. */
66 struct target_ops
*core_target
;
69 /* Backward compatability with old way of specifying core files. */
72 core_file_command (char *filename
, int from_tty
)
74 dont_repeat (); /* Either way, seems bogus. */
76 gdb_assert (core_target
!= NULL
);
79 (core_target
->to_detach
) (core_target
, filename
, from_tty
);
81 (core_target
->to_open
) (filename
, from_tty
);
85 /* If there are two or more functions that wish to hook into
86 exec_file_command, this function will call all of the hook
90 call_extra_exec_file_hooks (char *filename
)
94 for (i
= 0; i
< exec_file_hook_count
; i
++)
95 (*exec_file_extra_hooks
[i
]) (filename
);
98 /* Call this to specify the hook for exec_file_command to call back.
99 This is called from the x-window display code. */
102 specify_exec_file_hook (void (*hook
) (char *))
104 hook_type
*new_array
;
106 if (deprecated_exec_file_display_hook
!= NULL
)
108 /* There's already a hook installed. Arrange to have both it
109 and the subsequent hooks called. */
110 if (exec_file_hook_count
== 0)
112 /* If this is the first extra hook, initialize the hook
114 exec_file_extra_hooks
= (hook_type
*)
115 xmalloc (sizeof (hook_type
));
116 exec_file_extra_hooks
[0] = deprecated_exec_file_display_hook
;
117 deprecated_exec_file_display_hook
= call_extra_exec_file_hooks
;
118 exec_file_hook_count
= 1;
121 /* Grow the hook array by one and add the new hook to the end.
122 Yes, it's inefficient to grow it by one each time but since
123 this is hardly ever called it's not a big deal. */
124 exec_file_hook_count
++;
125 new_array
= (hook_type
*)
126 xrealloc (exec_file_extra_hooks
,
127 exec_file_hook_count
* sizeof (hook_type
));
128 exec_file_extra_hooks
= new_array
;
129 exec_file_extra_hooks
[exec_file_hook_count
- 1] = hook
;
132 deprecated_exec_file_display_hook
= hook
;
136 reopen_exec_file (void)
141 struct cleanup
*cleanups
;
143 /* Don't do anything if there isn't an exec file. */
144 if (exec_bfd
== NULL
)
147 /* If the timestamp of the exec file has changed, reopen it. */
148 filename
= xstrdup (bfd_get_filename (exec_bfd
));
149 cleanups
= make_cleanup (xfree
, filename
);
150 res
= stat (filename
, &st
);
152 if (exec_bfd_mtime
&& exec_bfd_mtime
!= st
.st_mtime
)
153 exec_file_attach (filename
, 0);
155 /* If we accessed the file since last opening it, close it now;
156 this stops GDB from holding the executable open after it
158 bfd_cache_close_all ();
160 do_cleanups (cleanups
);
163 /* If we have both a core file and an exec file,
164 print a warning if they don't go together. */
167 validate_files (void)
169 if (exec_bfd
&& core_bfd
)
171 if (!core_file_matches_executable_p (core_bfd
, exec_bfd
))
172 warning (_("core file may not match specified executable file."));
173 else if (bfd_get_mtime (exec_bfd
) > bfd_get_mtime (core_bfd
))
174 warning (_("exec file is newer than core file."));
178 /* Return the name of the executable file as a string.
179 ERR nonzero means get error if there is none specified;
180 otherwise return 0 in that case. */
183 get_exec_file (int err
)
186 return exec_filename
;
190 error (_("No executable file specified.\n\
191 Use the \"file\" or \"exec-file\" command."));
197 memory_error_message (enum target_xfer_error err
,
198 struct gdbarch
*gdbarch
, CORE_ADDR memaddr
)
202 case TARGET_XFER_E_IO
:
203 /* Actually, address between memaddr and memaddr + len was out of
205 return xstrprintf (_("Cannot access memory at address %s"),
206 paddress (gdbarch
, memaddr
));
207 case TARGET_XFER_E_UNAVAILABLE
:
208 return xstrprintf (_("Memory at address %s unavailable."),
209 paddress (gdbarch
, memaddr
));
211 internal_error (__FILE__
, __LINE__
,
212 "unhandled target_xfer_error: %s (%s)",
213 target_xfer_error_to_string (err
),
218 /* Report a memory error by throwing a suitable exception. */
221 memory_error (enum target_xfer_error err
, CORE_ADDR memaddr
)
224 enum errors exception
= GDB_NO_ERROR
;
226 /* Build error string. */
227 str
= memory_error_message (err
, target_gdbarch (), memaddr
);
228 make_cleanup (xfree
, str
);
230 /* Choose the right error to throw. */
233 case TARGET_XFER_E_IO
:
234 exception
= MEMORY_ERROR
;
236 case TARGET_XFER_E_UNAVAILABLE
:
237 exception
= NOT_AVAILABLE_ERROR
;
242 throw_error (exception
, ("%s"), str
);
245 /* Same as target_read_memory, but report an error if can't read. */
248 read_memory (CORE_ADDR memaddr
, gdb_byte
*myaddr
, ssize_t len
)
254 LONGEST xfer
= target_xfer_partial (current_target
.beneath
,
255 TARGET_OBJECT_MEMORY
, NULL
,
256 myaddr
+ xfered
, NULL
,
257 memaddr
+ xfered
, len
- xfered
);
260 memory_error (TARGET_XFER_E_IO
, memaddr
+ xfered
);
262 memory_error (xfer
, memaddr
+ xfered
);
268 /* Same as target_read_stack, but report an error if can't read. */
271 read_stack (CORE_ADDR memaddr
, gdb_byte
*myaddr
, ssize_t len
)
275 status
= target_read_stack (memaddr
, myaddr
, len
);
277 memory_error (status
, memaddr
);
280 /* Same as target_read_code, but report an error if can't read. */
283 read_code (CORE_ADDR memaddr
, gdb_byte
*myaddr
, ssize_t len
)
287 status
= target_read_code (memaddr
, myaddr
, len
);
289 memory_error (status
, memaddr
);
292 /* Argument / return result struct for use with
293 do_captured_read_memory_integer(). MEMADDR and LEN are filled in
294 by gdb_read_memory_integer(). RESULT is the contents that were
295 successfully read from MEMADDR of length LEN. */
297 struct captured_read_memory_integer_arguments
301 enum bfd_endian byte_order
;
305 /* Helper function for gdb_read_memory_integer(). DATA must be a
306 pointer to a captured_read_memory_integer_arguments struct.
307 Return 1 if successful. Note that the catch_errors() interface
308 will return 0 if an error occurred while reading memory. This
309 choice of return code is so that we can distinguish between
310 success and failure. */
313 do_captured_read_memory_integer (void *data
)
315 struct captured_read_memory_integer_arguments
*args
316 = (struct captured_read_memory_integer_arguments
*) data
;
317 CORE_ADDR memaddr
= args
->memaddr
;
319 enum bfd_endian byte_order
= args
->byte_order
;
321 args
->result
= read_memory_integer (memaddr
, len
, byte_order
);
326 /* Read memory at MEMADDR of length LEN and put the contents in
327 RETURN_VALUE. Return 0 if MEMADDR couldn't be read and non-zero
331 safe_read_memory_integer (CORE_ADDR memaddr
, int len
,
332 enum bfd_endian byte_order
,
333 LONGEST
*return_value
)
336 struct captured_read_memory_integer_arguments args
;
338 args
.memaddr
= memaddr
;
340 args
.byte_order
= byte_order
;
342 status
= catch_errors (do_captured_read_memory_integer
, &args
,
343 "", RETURN_MASK_ALL
);
345 *return_value
= args
.result
;
351 read_memory_integer (CORE_ADDR memaddr
, int len
,
352 enum bfd_endian byte_order
)
354 gdb_byte buf
[sizeof (LONGEST
)];
356 read_memory (memaddr
, buf
, len
);
357 return extract_signed_integer (buf
, len
, byte_order
);
361 read_memory_unsigned_integer (CORE_ADDR memaddr
, int len
,
362 enum bfd_endian byte_order
)
364 gdb_byte buf
[sizeof (ULONGEST
)];
366 read_memory (memaddr
, buf
, len
);
367 return extract_unsigned_integer (buf
, len
, byte_order
);
371 read_code_integer (CORE_ADDR memaddr
, int len
,
372 enum bfd_endian byte_order
)
374 gdb_byte buf
[sizeof (LONGEST
)];
376 read_code (memaddr
, buf
, len
);
377 return extract_signed_integer (buf
, len
, byte_order
);
381 read_code_unsigned_integer (CORE_ADDR memaddr
, int len
,
382 enum bfd_endian byte_order
)
384 gdb_byte buf
[sizeof (ULONGEST
)];
386 read_code (memaddr
, buf
, len
);
387 return extract_unsigned_integer (buf
, len
, byte_order
);
391 read_memory_string (CORE_ADDR memaddr
, char *buffer
, int max_len
)
400 if (cp
- buffer
>= max_len
)
402 buffer
[max_len
- 1] = '\0';
405 cnt
= max_len
- (cp
- buffer
);
408 read_memory (memaddr
+ (int) (cp
- buffer
), (gdb_byte
*) cp
, cnt
);
409 for (i
= 0; i
< cnt
&& *cp
; i
++, cp
++)
418 read_memory_typed_address (CORE_ADDR addr
, struct type
*type
)
420 gdb_byte
*buf
= alloca (TYPE_LENGTH (type
));
422 read_memory (addr
, buf
, TYPE_LENGTH (type
));
423 return extract_typed_address (buf
, type
);
426 /* Same as target_write_memory, but report an error if can't
429 write_memory (CORE_ADDR memaddr
,
430 const bfd_byte
*myaddr
, ssize_t len
)
434 status
= target_write_memory (memaddr
, myaddr
, len
);
436 memory_error (status
, memaddr
);
439 /* Same as write_memory, but notify 'memory_changed' observers. */
442 write_memory_with_notification (CORE_ADDR memaddr
, const bfd_byte
*myaddr
,
445 write_memory (memaddr
, myaddr
, len
);
446 observer_notify_memory_changed (current_inferior (), memaddr
, len
, myaddr
);
449 /* Store VALUE at ADDR in the inferior as a LEN-byte unsigned
452 write_memory_unsigned_integer (CORE_ADDR addr
, int len
,
453 enum bfd_endian byte_order
,
456 gdb_byte
*buf
= alloca (len
);
458 store_unsigned_integer (buf
, len
, byte_order
, value
);
459 write_memory (addr
, buf
, len
);
462 /* Store VALUE at ADDR in the inferior as a LEN-byte signed
465 write_memory_signed_integer (CORE_ADDR addr
, int len
,
466 enum bfd_endian byte_order
,
469 gdb_byte
*buf
= alloca (len
);
471 store_signed_integer (buf
, len
, byte_order
, value
);
472 write_memory (addr
, buf
, len
);
475 /* The current default bfd target. Points to storage allocated for
479 /* Same thing, except it is "auto" not NULL for the default case. */
480 static char *gnutarget_string
;
482 show_gnutarget_string (struct ui_file
*file
, int from_tty
,
483 struct cmd_list_element
*c
,
486 fprintf_filtered (file
,
487 _("The current BFD target is \"%s\".\n"), value
);
490 static void set_gnutarget_command (char *, int,
491 struct cmd_list_element
*);
494 set_gnutarget_command (char *ignore
, int from_tty
,
495 struct cmd_list_element
*c
)
497 char *gend
= gnutarget_string
+ strlen (gnutarget_string
);
499 gend
= remove_trailing_whitespace (gnutarget_string
, gend
);
502 if (strcmp (gnutarget_string
, "auto") == 0)
505 gnutarget
= gnutarget_string
;
508 /* A completion function for "set gnutarget". */
510 static VEC (char_ptr
) *
511 complete_set_gnutarget (struct cmd_list_element
*cmd
,
512 const char *text
, const char *word
)
514 static const char **bfd_targets
;
516 if (bfd_targets
== NULL
)
520 bfd_targets
= bfd_target_list ();
521 for (last
= 0; bfd_targets
[last
] != NULL
; ++last
)
524 bfd_targets
= xrealloc (bfd_targets
, (last
+ 2) * sizeof (const char **));
525 bfd_targets
[last
] = "auto";
526 bfd_targets
[last
+ 1] = NULL
;
529 return complete_on_enum (bfd_targets
, text
, word
);
532 /* Set the gnutarget. */
534 set_gnutarget (char *newtarget
)
536 if (gnutarget_string
!= NULL
)
537 xfree (gnutarget_string
);
538 gnutarget_string
= xstrdup (newtarget
);
539 set_gnutarget_command (NULL
, 0, NULL
);
543 _initialize_core (void)
545 struct cmd_list_element
*c
;
547 c
= add_cmd ("core-file", class_files
, core_file_command
, _("\
548 Use FILE as core dump for examining memory and registers.\n\
549 No arg means have no core file. This command has been superseded by the\n\
550 `target core' and `detach' commands."), &cmdlist
);
551 set_cmd_completer (c
, filename_completer
);
554 c
= add_setshow_string_noescape_cmd ("gnutarget", class_files
,
555 &gnutarget_string
, _("\
556 Set the current BFD target."), _("\
557 Show the current BFD target."), _("\
558 Use `set gnutarget auto' to specify automatic detection."),
559 set_gnutarget_command
,
560 show_gnutarget_string
,
561 &setlist
, &showlist
);
562 set_cmd_completer (c
, complete_set_gnutarget
);
564 add_alias_cmd ("g", "gnutarget", class_files
, 1, &setlist
);
566 if (getenv ("GNUTARGET"))
567 set_gnutarget (getenv ("GNUTARGET"));
569 set_gnutarget ("auto");