1 /* Work with executable files, for GDB.
3 Copyright (C) 1988-2013 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/>. */
26 #include "filenames.h"
29 #include "completer.h"
33 #include "arch-utils.h"
34 #include "gdbthread.h"
35 #include "progspace.h"
39 #include "readline/readline.h"
40 #include "gdb_string.h"
47 void (*deprecated_file_changed_hook) (char *);
49 /* Prototypes for local functions */
51 static void file_command (char *, int);
53 static void set_section_command (char *, int);
55 static void exec_files_info (struct target_ops *);
57 static void init_exec_ops (void);
59 void _initialize_exec (void);
61 /* The target vector for executable files. */
63 struct target_ops exec_ops;
65 /* True if the exec target is pushed on the stack. */
66 static int using_exec_ops;
68 /* Whether to open exec and core files read-only or read-write. */
72 show_write_files (struct ui_file *file, int from_tty,
73 struct cmd_list_element *c, const char *value)
75 fprintf_filtered (file, _("Writing into executable and core files is %s.\n"),
81 exec_open (char *args, int from_tty)
83 target_preopen (from_tty);
84 exec_file_attach (args, from_tty);
87 /* Close and clear exec_bfd. If we end up with no target sections to
88 read memory from, this unpushes the exec_ops target. */
99 /* Removing target sections may close the exec_ops target.
100 Clear exec_bfd before doing so to prevent recursion. */
104 remove_target_sections (&exec_bfd);
106 xfree (exec_filename);
107 exec_filename = NULL;
111 /* This is the target_close implementation. Clears all target
112 sections and closes all executable bfds from all program spaces. */
120 struct program_space *ss;
121 struct cleanup *old_chain;
123 old_chain = save_current_program_space ();
126 set_current_program_space (ss);
128 /* Delete all target sections. */
130 (current_target_sections,
131 -resize_section_table (current_target_sections, 0));
136 do_cleanups (old_chain);
141 exec_file_clear (int from_tty)
143 /* Remove exec file. */
147 printf_unfiltered (_("No executable file now.\n"));
150 /* Set FILENAME as the new exec file.
152 This function is intended to be behave essentially the same
153 as exec_file_command, except that the latter will detect when
154 a target is being debugged, and will ask the user whether it
155 should be shut down first. (If the answer is "no", then the
156 new file is ignored.)
158 This file is used by exec_file_command, to do the work of opening
159 and processing the exec file after any prompting has happened.
161 And, it is used by child_attach, when the attach command was
162 given a pid but not a exec pathname, and the attach command could
163 figure out the pathname from the pid. (In this case, we shouldn't
164 ask the user whether the current target should be shut down --
165 we're supplying the exec pathname late for good reason.) */
168 exec_file_attach (char *filename, int from_tty)
170 /* Remove any previous exec file. */
173 /* Now open and digest the file the user requested, if any. */
178 printf_unfiltered (_("No executable file now.\n"));
180 set_gdbarch_from_file (NULL);
184 struct cleanup *cleanups;
185 char *scratch_pathname, *canonical_pathname;
187 struct target_section *sections = NULL, *sections_end = NULL;
190 scratch_chan = openp (getenv ("PATH"), OPF_TRY_CWD_FIRST, filename,
191 write_files ? O_RDWR | O_BINARY : O_RDONLY | O_BINARY,
193 #if defined(__GO32__) || defined(_WIN32) || defined(__CYGWIN__)
194 if (scratch_chan < 0)
196 char *exename = alloca (strlen (filename) + 5);
198 strcat (strcpy (exename, filename), ".exe");
199 scratch_chan = openp (getenv ("PATH"), OPF_TRY_CWD_FIRST, exename,
200 write_files ? O_RDWR | O_BINARY : O_RDONLY | O_BINARY,
204 if (scratch_chan < 0)
205 perror_with_name (filename);
207 cleanups = make_cleanup (xfree, scratch_pathname);
209 /* gdb_bfd_open (and its variants) prefers canonicalized pathname for
210 better BFD caching. */
211 canonical_pathname = gdb_realpath (scratch_pathname);
212 make_cleanup (xfree, canonical_pathname);
215 exec_bfd = gdb_bfd_fopen (canonical_pathname, gnutarget,
216 FOPEN_RUB, scratch_chan);
218 exec_bfd = gdb_bfd_open (canonical_pathname, gnutarget, scratch_chan);
222 error (_("\"%s\": could not open as an executable file: %s"),
223 scratch_pathname, bfd_errmsg (bfd_get_error ()));
226 gdb_assert (exec_filename == NULL);
227 exec_filename = xstrdup (scratch_pathname);
229 if (!bfd_check_format_matches (exec_bfd, bfd_object, &matching))
231 /* Make sure to close exec_bfd, or else "run" might try to use
234 error (_("\"%s\": not in executable format: %s"),
236 gdb_bfd_errmsg (bfd_get_error (), matching));
239 if (build_section_table (exec_bfd, §ions, §ions_end))
241 /* Make sure to close exec_bfd, or else "run" might try to use
244 error (_("\"%s\": can't find the file sections: %s"),
245 scratch_pathname, bfd_errmsg (bfd_get_error ()));
248 exec_bfd_mtime = bfd_get_mtime (exec_bfd);
252 set_gdbarch_from_file (exec_bfd);
254 /* Add the executable's sections to the current address spaces'
255 list of sections. This possibly pushes the exec_ops
257 add_target_sections (&exec_bfd, sections, sections_end);
260 /* Tell display code (if any) about the changed file name. */
261 if (deprecated_exec_file_display_hook)
262 (*deprecated_exec_file_display_hook) (filename);
264 do_cleanups (cleanups);
266 bfd_cache_close_all ();
267 observer_notify_executable_changed ();
270 /* Process the first arg in ARGS as the new exec file.
272 Note that we have to explicitly ignore additional args, since we can
273 be called from file_command(), which also calls symbol_file_command()
274 which can take multiple args.
276 If ARGS is NULL, we just want to close the exec file. */
279 exec_file_command (char *args, int from_tty)
284 if (from_tty && target_has_execution
285 && !query (_("A program is being debugged already.\n"
286 "Are you sure you want to change the file? ")))
287 error (_("File not changed."));
291 struct cleanup *cleanups;
293 /* Scan through the args and pick up the first non option arg
296 argv = gdb_buildargv (args);
297 cleanups = make_cleanup_freeargv (argv);
299 for (; (*argv != NULL) && (**argv == '-'); argv++)
303 error (_("No executable file name was specified"));
305 filename = tilde_expand (*argv);
306 make_cleanup (xfree, filename);
307 exec_file_attach (filename, from_tty);
309 do_cleanups (cleanups);
312 exec_file_attach (NULL, from_tty);
315 /* Set both the exec file and the symbol file, in one command.
316 What a novelty. Why did GDB go through four major releases before this
317 command was added? */
320 file_command (char *arg, int from_tty)
322 /* FIXME, if we lose on reading the symbol file, we should revert
323 the exec file, but that's rough. */
324 exec_file_command (arg, from_tty);
325 symbol_file_command (arg, from_tty);
326 if (deprecated_file_changed_hook)
327 deprecated_file_changed_hook (arg);
331 /* Locate all mappable sections of a BFD file.
332 table_pp_char is a char * to get it through bfd_map_over_sections;
333 we cast it back to its proper type. */
336 add_to_section_table (bfd *abfd, struct bfd_section *asect,
339 struct target_section **table_pp = (struct target_section **) table_pp_char;
342 gdb_assert (abfd == asect->owner);
344 /* Check the section flags, but do not discard zero-length sections, since
345 some symbols may still be attached to this section. For instance, we
346 encountered on sparc-solaris 2.10 a shared library with an empty .bss
347 section to which a symbol named "_end" was attached. The address
348 of this symbol still needs to be relocated. */
349 aflag = bfd_get_section_flags (abfd, asect);
350 if (!(aflag & SEC_ALLOC))
353 (*table_pp)->owner = NULL;
354 (*table_pp)->the_bfd_section = asect;
355 (*table_pp)->addr = bfd_section_vma (abfd, asect);
356 (*table_pp)->endaddr = (*table_pp)->addr + bfd_section_size (abfd, asect);
361 resize_section_table (struct target_section_table *table, int num_added)
366 old_count = table->sections_end - table->sections;
368 new_count = num_added + old_count;
372 table->sections = xrealloc (table->sections,
373 sizeof (struct target_section) * new_count);
374 table->sections_end = table->sections + new_count;
378 xfree (table->sections);
379 table->sections = table->sections_end = NULL;
385 /* Builds a section table, given args BFD, SECTABLE_PTR, SECEND_PTR.
386 Returns 0 if OK, 1 on error. */
389 build_section_table (struct bfd *some_bfd, struct target_section **start,
390 struct target_section **end)
394 count = bfd_count_sections (some_bfd);
397 *start = (struct target_section *) xmalloc (count * sizeof (**start));
399 bfd_map_over_sections (some_bfd, add_to_section_table, (char *) end);
400 if (*end > *start + count)
401 internal_error (__FILE__, __LINE__,
402 _("failed internal consistency check"));
403 /* We could realloc the table, but it probably loses for most files. */
407 /* Add the sections array defined by [SECTIONS..SECTIONS_END[ to the
408 current set of target sections. */
411 add_target_sections (void *owner,
412 struct target_section *sections,
413 struct target_section *sections_end)
416 struct target_section_table *table = current_target_sections;
418 count = sections_end - sections;
422 int space = resize_section_table (table, count);
425 for (i = 0; i < count; ++i)
427 table->sections[space + i] = sections[i];
428 table->sections[space + i].owner = owner;
431 /* If these are the first file sections we can provide memory
432 from, push the file_stratum target. */
436 push_target (&exec_ops);
441 /* Remove all target sections owned by OWNER.
442 OWNER must be the same value passed to add_target_sections. */
445 remove_target_sections (void *owner)
447 struct target_section *src, *dest;
448 struct target_section_table *table = current_target_sections;
450 gdb_assert (owner != NULL);
452 dest = table->sections;
453 for (src = table->sections; src < table->sections_end; src++)
454 if (src->owner != owner)
456 /* Keep this section. */
462 /* If we've dropped any sections, resize the section table. */
467 old_count = resize_section_table (table, dest - src);
469 /* If we don't have any more sections to read memory from,
470 remove the file_stratum target from the stack. */
471 if (old_count + (dest - src) == 0)
473 struct program_space *pspace;
476 if (pspace->target_sections.sections
477 != pspace->target_sections.sections_end)
480 unpush_target (&exec_ops);
488 section_table_available_memory (VEC(mem_range_s) *memory,
489 CORE_ADDR memaddr, ULONGEST len,
490 struct target_section *sections,
491 struct target_section *sections_end)
493 struct target_section *p;
495 for (p = sections; p < sections_end; p++)
497 if ((bfd_get_section_flags (p->the_bfd_section->owner,
499 & SEC_READONLY) == 0)
502 /* Copy the meta-data, adjusted. */
503 if (mem_ranges_overlap (p->addr, p->endaddr - p->addr, memaddr, len))
505 ULONGEST lo1, hi1, lo2, hi2;
514 r = VEC_safe_push (mem_range_s, memory, NULL);
516 r->start = max (lo1, lo2);
517 r->length = min (hi1, hi2) - r->start;
525 section_table_xfer_memory_partial (gdb_byte *readbuf, const gdb_byte *writebuf,
526 ULONGEST offset, LONGEST len,
527 struct target_section *sections,
528 struct target_section *sections_end,
529 const char *section_name)
532 struct target_section *p;
533 ULONGEST memaddr = offset;
534 ULONGEST memend = memaddr + len;
537 internal_error (__FILE__, __LINE__,
538 _("failed internal consistency check"));
540 for (p = sections; p < sections_end; p++)
542 struct bfd_section *asect = p->the_bfd_section;
543 bfd *abfd = asect->owner;
545 if (section_name && strcmp (section_name, asect->name) != 0)
546 continue; /* not the section we need. */
547 if (memaddr >= p->addr)
549 if (memend <= p->endaddr)
551 /* Entire transfer is within this section. */
553 res = bfd_set_section_contents (abfd, asect,
554 writebuf, memaddr - p->addr,
557 res = bfd_get_section_contents (abfd, asect,
558 readbuf, memaddr - p->addr,
560 return (res != 0) ? len : 0;
562 else if (memaddr >= p->endaddr)
564 /* This section ends before the transfer starts. */
569 /* This section overlaps the transfer. Just do half. */
570 len = p->endaddr - memaddr;
572 res = bfd_set_section_contents (abfd, asect,
573 writebuf, memaddr - p->addr,
576 res = bfd_get_section_contents (abfd, asect,
577 readbuf, memaddr - p->addr,
579 return (res != 0) ? len : 0;
584 return 0; /* We can't help. */
587 static struct target_section_table *
588 exec_get_section_table (struct target_ops *ops)
590 return current_target_sections;
594 exec_xfer_partial (struct target_ops *ops, enum target_object object,
595 const char *annex, gdb_byte *readbuf,
596 const gdb_byte *writebuf,
597 ULONGEST offset, LONGEST len)
599 struct target_section_table *table = target_get_section_table (ops);
601 if (object == TARGET_OBJECT_MEMORY)
602 return section_table_xfer_memory_partial (readbuf, writebuf,
613 print_section_info (struct target_section_table *t, bfd *abfd)
615 struct gdbarch *gdbarch = gdbarch_from_bfd (abfd);
616 struct target_section *p;
617 /* FIXME: 16 is not wide enough when gdbarch_addr_bit > 64. */
618 int wid = gdbarch_addr_bit (gdbarch) <= 32 ? 8 : 16;
620 printf_filtered ("\t`%s', ", bfd_get_filename (abfd));
622 printf_filtered (_("file type %s.\n"), bfd_get_target (abfd));
623 if (abfd == exec_bfd)
625 /* gcc-3.4 does not like the initialization in
626 <p == t->sections_end>. */
627 bfd_vma displacement = 0;
630 for (p = t->sections; p < t->sections_end; p++)
632 struct bfd_section *psect = p->the_bfd_section;
633 bfd *pbfd = psect->owner;
635 if ((bfd_get_section_flags (pbfd, psect) & (SEC_ALLOC | SEC_LOAD))
636 != (SEC_ALLOC | SEC_LOAD))
639 if (bfd_get_section_vma (pbfd, psect) <= abfd->start_address
640 && abfd->start_address < (bfd_get_section_vma (pbfd, psect)
641 + bfd_get_section_size (psect)))
643 displacement = p->addr - bfd_get_section_vma (pbfd, psect);
647 if (p == t->sections_end)
648 warning (_("Cannot find section for the entry point of %s."),
649 bfd_get_filename (abfd));
651 entry_point = gdbarch_addr_bits_remove (gdbarch,
652 bfd_get_start_address (abfd)
654 printf_filtered (_("\tEntry point: %s\n"),
655 paddress (gdbarch, entry_point));
657 for (p = t->sections; p < t->sections_end; p++)
659 struct bfd_section *psect = p->the_bfd_section;
660 bfd *pbfd = psect->owner;
662 printf_filtered ("\t%s", hex_string_custom (p->addr, wid));
663 printf_filtered (" - %s", hex_string_custom (p->endaddr, wid));
665 /* FIXME: A format of "08l" is not wide enough for file offsets
666 larger than 4GB. OTOH, making it "016l" isn't desirable either
667 since most output will then be much wider than necessary. It
668 may make sense to test the size of the file and choose the
669 format string accordingly. */
670 /* FIXME: i18n: Need to rewrite this sentence. */
672 printf_filtered (" @ %s",
673 hex_string_custom (psect->filepos, 8));
674 printf_filtered (" is %s", bfd_section_name (pbfd, psect));
676 printf_filtered (" in %s", bfd_get_filename (pbfd));
677 printf_filtered ("\n");
682 exec_files_info (struct target_ops *t)
685 print_section_info (current_target_sections, exec_bfd);
687 puts_filtered (_("\t<no file loaded>\n"));
691 set_section_command (char *args, int from_tty)
693 struct target_section *p;
696 unsigned long secaddr;
699 struct target_section_table *table;
702 error (_("Must specify section name and its virtual address"));
704 /* Parse out section name. */
705 for (secname = args; !isspace (*args); args++);
706 seclen = args - secname;
708 /* Parse out new virtual address. */
709 secaddr = parse_and_eval_address (args);
711 table = current_target_sections;
712 for (p = table->sections; p < table->sections_end; p++)
714 if (!strncmp (secname, bfd_section_name (p->bfd,
715 p->the_bfd_section), seclen)
716 && bfd_section_name (p->bfd, p->the_bfd_section)[seclen] == '\0')
718 offset = secaddr - p->addr;
720 p->endaddr += offset;
722 exec_files_info (&exec_ops);
726 if (seclen >= sizeof (secprint))
727 seclen = sizeof (secprint) - 1;
728 strncpy (secprint, secname, seclen);
729 secprint[seclen] = '\0';
730 error (_("Section %s not found"), secprint);
733 /* If we can find a section in FILENAME with BFD index INDEX, adjust
737 exec_set_section_address (const char *filename, int index, CORE_ADDR address)
739 struct target_section *p;
740 struct target_section_table *table;
742 table = current_target_sections;
743 for (p = table->sections; p < table->sections_end; p++)
745 if (filename_cmp (filename, p->the_bfd_section->owner->filename) == 0
746 && index == p->the_bfd_section->index)
748 p->endaddr += address - p->addr;
754 /* If mourn is being called in all the right places, this could be say
755 `gdb internal error' (since generic_mourn calls
756 breakpoint_init_inferior). */
759 ignore (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt)
765 exec_has_memory (struct target_ops *ops)
767 /* We can provide memory if we have any file/target sections to read
769 return (current_target_sections->sections
770 != current_target_sections->sections_end);
773 /* Find mapped memory. */
776 exec_set_find_memory_regions (int (*func) (find_memory_region_ftype, void *))
778 exec_ops.to_find_memory_regions = func;
781 static char *exec_make_note_section (bfd *, int *);
783 /* Fill in the exec file target vector. Very few entries need to be
789 exec_ops.to_shortname = "exec";
790 exec_ops.to_longname = "Local exec file";
791 exec_ops.to_doc = "Use an executable file as a target.\n\
792 Specify the filename of the executable file.";
793 exec_ops.to_open = exec_open;
794 exec_ops.to_close = exec_close_1;
795 exec_ops.to_attach = find_default_attach;
796 exec_ops.to_xfer_partial = exec_xfer_partial;
797 exec_ops.to_get_section_table = exec_get_section_table;
798 exec_ops.to_files_info = exec_files_info;
799 exec_ops.to_insert_breakpoint = ignore;
800 exec_ops.to_remove_breakpoint = ignore;
801 exec_ops.to_create_inferior = find_default_create_inferior;
802 exec_ops.to_stratum = file_stratum;
803 exec_ops.to_has_memory = exec_has_memory;
804 exec_ops.to_make_corefile_notes = exec_make_note_section;
805 exec_ops.to_magic = OPS_MAGIC;
809 _initialize_exec (void)
811 struct cmd_list_element *c;
817 c = add_cmd ("file", class_files, file_command, _("\
818 Use FILE as program to be debugged.\n\
819 It is read for its symbols, for getting the contents of pure memory,\n\
820 and it is the program executed when you use the `run' command.\n\
821 If FILE cannot be found as specified, your execution directory path\n\
822 ($PATH) is searched for a command of that name.\n\
823 No arg means to have no executable file and no symbols."), &cmdlist);
824 set_cmd_completer (c, filename_completer);
827 c = add_cmd ("exec-file", class_files, exec_file_command, _("\
828 Use FILE as program for getting contents of pure memory.\n\
829 If FILE cannot be found as specified, your execution directory path\n\
830 is searched for a command of that name.\n\
831 No arg means have no executable file."), &cmdlist);
832 set_cmd_completer (c, filename_completer);
834 add_com ("section", class_files, set_section_command, _("\
835 Change the base address of section SECTION of the exec file to ADDR.\n\
836 This can be used if the exec file does not contain section addresses,\n\
837 (such as in the a.out format), or when the addresses specified in the\n\
838 file itself are wrong. Each section must be changed separately. The\n\
839 ``info files'' command lists all the sections and their addresses."));
841 add_setshow_boolean_cmd ("write", class_support, &write_files, _("\
842 Set writing into executable and core files."), _("\
843 Show writing into executable and core files."), NULL,
846 &setlist, &showlist);
848 add_target_with_completer (&exec_ops, filename_completer);
852 exec_make_note_section (bfd *obfd, int *note_size)
854 error (_("Can't create a corefile"));