1 /* Work with executable files, for GDB.
3 Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997,
4 1998, 1999, 2000, 2001, 2002, 2003, 2007, 2008, 2009, 2010
5 Free Software Foundation, Inc.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
30 #include "completer.h"
34 #include "arch-utils.h"
35 #include "gdbthread.h"
36 #include "progspace.h"
39 #include "readline/readline.h"
40 #include "gdb_string.h"
47 #include "xcoffsolib.h"
49 struct vmap *map_vmap (bfd *, bfd *);
51 void (*deprecated_file_changed_hook) (char *);
53 /* Prototypes for local functions */
55 static void file_command (char *, int);
57 static void set_section_command (char *, int);
59 static void exec_files_info (struct target_ops *);
61 static void init_exec_ops (void);
63 void _initialize_exec (void);
65 /* The target vector for executable files. */
67 struct target_ops exec_ops;
69 /* True if the exec target is pushed on the stack. */
70 static int using_exec_ops;
72 /* Whether to open exec and core files read-only or read-write. */
76 show_write_files (struct ui_file *file, int from_tty,
77 struct cmd_list_element *c, const char *value)
79 fprintf_filtered (file, _("Writing into executable and core files is %s.\n"),
87 exec_open (char *args, int from_tty)
89 target_preopen (from_tty);
90 exec_file_attach (args, from_tty);
93 /* Close and clear exec_bfd. If we end up with no target sections to
94 read memory from, this unpushes the exec_ops target. */
101 bfd *abfd = exec_bfd;
102 char *name = bfd_get_filename (abfd);
104 gdb_bfd_close_or_warn (abfd);
107 /* Removing target sections may close the exec_ops target.
108 Clear exec_bfd before doing so to prevent recursion. */
112 remove_target_sections (abfd);
116 /* This is the target_close implementation. Clears all target
117 sections and closes all executable bfds from all program spaces. */
120 exec_close_1 (int quitting)
122 int need_symtab_cleanup = 0;
123 struct vmap *vp, *nxt;
127 for (nxt = vmap; nxt != NULL;)
132 /* if there is an objfile associated with this bfd,
133 free_objfile() will do proper cleanup of objfile *and* bfd. */
137 free_objfile (vp->objfile);
138 need_symtab_cleanup = 1;
140 else if (vp->bfd != exec_bfd)
141 /* FIXME-leak: We should be freeing vp->name too, I think. */
142 gdb_bfd_close_or_warn (vp->bfd);
150 struct program_space *ss;
151 struct cleanup *old_chain;
153 old_chain = save_current_program_space ();
156 set_current_program_space (ss);
158 /* Delete all target sections. */
160 (current_target_sections,
161 -resize_section_table (current_target_sections, 0));
166 do_cleanups (old_chain);
171 exec_file_clear (int from_tty)
173 /* Remove exec file. */
177 printf_unfiltered (_("No executable file now.\n"));
180 /* Set FILENAME as the new exec file.
182 This function is intended to be behave essentially the same
183 as exec_file_command, except that the latter will detect when
184 a target is being debugged, and will ask the user whether it
185 should be shut down first. (If the answer is "no", then the
186 new file is ignored.)
188 This file is used by exec_file_command, to do the work of opening
189 and processing the exec file after any prompting has happened.
191 And, it is used by child_attach, when the attach command was
192 given a pid but not a exec pathname, and the attach command could
193 figure out the pathname from the pid. (In this case, we shouldn't
194 ask the user whether the current target should be shut down --
195 we're supplying the exec pathname late for good reason.) */
198 exec_file_attach (char *filename, int from_tty)
200 /* Remove any previous exec file. */
203 /* Now open and digest the file the user requested, if any. */
208 printf_unfiltered (_("No executable file now.\n"));
210 set_gdbarch_from_file (NULL);
214 struct cleanup *cleanups;
215 char *scratch_pathname;
217 struct target_section *sections = NULL, *sections_end = NULL;
220 scratch_chan = openp (getenv ("PATH"), OPF_TRY_CWD_FIRST, filename,
221 write_files ? O_RDWR | O_BINARY : O_RDONLY | O_BINARY,
223 #if defined(__GO32__) || defined(_WIN32) || defined(__CYGWIN__)
224 if (scratch_chan < 0)
226 char *exename = alloca (strlen (filename) + 5);
227 strcat (strcpy (exename, filename), ".exe");
228 scratch_chan = openp (getenv ("PATH"), OPF_TRY_CWD_FIRST, exename,
229 write_files ? O_RDWR | O_BINARY : O_RDONLY | O_BINARY,
233 if (scratch_chan < 0)
234 perror_with_name (filename);
235 exec_bfd = bfd_fopen (scratch_pathname, gnutarget,
236 write_files ? FOPEN_RUB : FOPEN_RB,
241 close (scratch_chan);
242 error (_("\"%s\": could not open as an executable file: %s"),
243 scratch_pathname, bfd_errmsg (bfd_get_error ()));
246 /* At this point, scratch_pathname and exec_bfd->name both point to the
247 same malloc'd string. However exec_close() will attempt to free it
248 via the exec_bfd->name pointer, so we need to make another copy and
249 leave exec_bfd as the new owner of the original copy. */
250 scratch_pathname = xstrdup (scratch_pathname);
251 cleanups = make_cleanup (xfree, scratch_pathname);
253 if (!bfd_check_format_matches (exec_bfd, bfd_object, &matching))
255 /* Make sure to close exec_bfd, or else "run" might try to use
258 error (_("\"%s\": not in executable format: %s"),
260 gdb_bfd_errmsg (bfd_get_error (), matching));
263 /* FIXME - This should only be run for RS6000, but the ifdef is a poor
264 way to accomplish. */
265 #ifdef DEPRECATED_IBM6000_TARGET
266 /* Setup initial vmap. */
268 map_vmap (exec_bfd, 0);
271 /* Make sure to close exec_bfd, or else "run" might try to use
274 error (_("\"%s\": can't find the file sections: %s"),
275 scratch_pathname, bfd_errmsg (bfd_get_error ()));
277 #endif /* DEPRECATED_IBM6000_TARGET */
279 if (build_section_table (exec_bfd, §ions, §ions_end))
281 /* Make sure to close exec_bfd, or else "run" might try to use
284 error (_("\"%s\": can't find the file sections: %s"),
285 scratch_pathname, bfd_errmsg (bfd_get_error ()));
288 exec_bfd_mtime = bfd_get_mtime (exec_bfd);
292 set_gdbarch_from_file (exec_bfd);
294 /* Add the executable's sections to the current address spaces'
295 list of sections. This possibly pushes the exec_ops
297 add_target_sections (sections, sections_end);
300 /* Tell display code (if any) about the changed file name. */
301 if (deprecated_exec_file_display_hook)
302 (*deprecated_exec_file_display_hook) (filename);
304 do_cleanups (cleanups);
306 bfd_cache_close_all ();
307 observer_notify_executable_changed ();
310 /* Process the first arg in ARGS as the new exec file.
312 Note that we have to explicitly ignore additional args, since we can
313 be called from file_command(), which also calls symbol_file_command()
314 which can take multiple args.
316 If ARGS is NULL, we just want to close the exec file. */
319 exec_file_command (char *args, int from_tty)
324 if (from_tty && target_has_execution
325 && !query (_("A program is being debugged already.\n"
326 "Are you sure you want to change the file? ")))
327 error (_("File not changed."));
331 struct cleanup *cleanups;
333 /* Scan through the args and pick up the first non option arg
336 argv = gdb_buildargv (args);
337 cleanups = make_cleanup_freeargv (argv);
339 for (; (*argv != NULL) && (**argv == '-'); argv++)
343 error (_("No executable file name was specified"));
345 filename = tilde_expand (*argv);
346 make_cleanup (xfree, filename);
347 exec_file_attach (filename, from_tty);
349 do_cleanups (cleanups);
352 exec_file_attach (NULL, from_tty);
355 /* Set both the exec file and the symbol file, in one command.
356 What a novelty. Why did GDB go through four major releases before this
357 command was added? */
360 file_command (char *arg, int from_tty)
362 /* FIXME, if we lose on reading the symbol file, we should revert
363 the exec file, but that's rough. */
364 exec_file_command (arg, from_tty);
365 symbol_file_command (arg, from_tty);
366 if (deprecated_file_changed_hook)
367 deprecated_file_changed_hook (arg);
371 /* Locate all mappable sections of a BFD file.
372 table_pp_char is a char * to get it through bfd_map_over_sections;
373 we cast it back to its proper type. */
376 add_to_section_table (bfd *abfd, struct bfd_section *asect,
379 struct target_section **table_pp = (struct target_section **) table_pp_char;
382 /* Check the section flags, but do not discard zero-length sections, since
383 some symbols may still be attached to this section. For instance, we
384 encountered on sparc-solaris 2.10 a shared library with an empty .bss
385 section to which a symbol named "_end" was attached. The address
386 of this symbol still needs to be relocated. */
387 aflag = bfd_get_section_flags (abfd, asect);
388 if (!(aflag & SEC_ALLOC))
391 (*table_pp)->bfd = abfd;
392 (*table_pp)->the_bfd_section = asect;
393 (*table_pp)->addr = bfd_section_vma (abfd, asect);
394 (*table_pp)->endaddr = (*table_pp)->addr + bfd_section_size (abfd, asect);
399 resize_section_table (struct target_section_table *table, int num_added)
401 struct target_section *old_value;
405 old_value = table->sections;
406 old_count = table->sections_end - table->sections;
408 new_count = num_added + old_count;
412 table->sections = xrealloc (table->sections,
413 sizeof (struct target_section) * new_count);
414 table->sections_end = table->sections + new_count;
418 xfree (table->sections);
419 table->sections = table->sections_end = NULL;
425 /* Builds a section table, given args BFD, SECTABLE_PTR, SECEND_PTR.
426 Returns 0 if OK, 1 on error. */
429 build_section_table (struct bfd *some_bfd, struct target_section **start,
430 struct target_section **end)
434 count = bfd_count_sections (some_bfd);
437 *start = (struct target_section *) xmalloc (count * sizeof (**start));
439 bfd_map_over_sections (some_bfd, add_to_section_table, (char *) end);
440 if (*end > *start + count)
441 internal_error (__FILE__, __LINE__, _("failed internal consistency check"));
442 /* We could realloc the table, but it probably loses for most files. */
446 /* Add the sections array defined by [SECTIONS..SECTIONS_END[ to the
447 current set of target sections. */
450 add_target_sections (struct target_section *sections,
451 struct target_section *sections_end)
454 struct target_section_table *table = current_target_sections;
456 count = sections_end - sections;
460 int space = resize_section_table (table, count);
461 memcpy (table->sections + space,
462 sections, count * sizeof (sections[0]));
464 /* If these are the first file sections we can provide memory
465 from, push the file_stratum target. */
469 push_target (&exec_ops);
474 /* Remove all target sections taken from ABFD. */
477 remove_target_sections (bfd *abfd)
479 struct target_section *src, *dest;
481 struct target_section_table *table = current_target_sections;
483 dest = table->sections;
484 for (src = table->sections; src < table->sections_end; src++)
485 if (src->bfd != abfd)
487 /* Keep this section. */
493 /* If we've dropped any sections, resize the section table. */
498 old_count = resize_section_table (table, dest - src);
500 /* If we don't have any more sections to read memory from,
501 remove the file_stratum target from the stack. */
502 if (old_count + (dest - src) == 0)
504 struct program_space *pspace;
507 if (pspace->target_sections.sections
508 != pspace->target_sections.sections_end)
511 unpush_target (&exec_ops);
518 bfdsec_to_vmap (struct bfd *abfd, struct bfd_section *sect, void *arg3)
520 struct vmap_and_bfd *vmap_bfd = (struct vmap_and_bfd *) arg3;
523 vp = vmap_bfd->pvmap;
525 if ((bfd_get_section_flags (abfd, sect) & SEC_LOAD) == 0)
528 if (strcmp (bfd_section_name (abfd, sect), ".text") == 0)
530 vp->tstart = bfd_section_vma (abfd, sect);
531 vp->tend = vp->tstart + bfd_section_size (abfd, sect);
532 vp->tvma = bfd_section_vma (abfd, sect);
533 vp->toffs = sect->filepos;
535 else if (strcmp (bfd_section_name (abfd, sect), ".data") == 0)
537 vp->dstart = bfd_section_vma (abfd, sect);
538 vp->dend = vp->dstart + bfd_section_size (abfd, sect);
539 vp->dvma = bfd_section_vma (abfd, sect);
541 /* Silently ignore other types of sections. (FIXME?) */
544 /* Make a vmap for ABFD which might be a member of the archive ARCH.
545 Return the new vmap. */
548 map_vmap (bfd *abfd, bfd *arch)
550 struct vmap_and_bfd vmap_bfd;
551 struct vmap *vp, **vpp;
553 vp = (struct vmap *) xmalloc (sizeof (*vp));
554 memset ((char *) vp, '\0', sizeof (*vp));
557 vp->name = bfd_get_filename (arch ? arch : abfd);
558 vp->member = arch ? bfd_get_filename (abfd) : "";
560 vmap_bfd.pbfd = arch;
562 bfd_map_over_sections (abfd, bfdsec_to_vmap, &vmap_bfd);
564 /* Find the end of the list and append. */
565 for (vpp = &vmap; *vpp; vpp = &(*vpp)->nxt)
574 section_table_xfer_memory_partial (gdb_byte *readbuf, const gdb_byte *writebuf,
575 ULONGEST offset, LONGEST len,
576 struct target_section *sections,
577 struct target_section *sections_end,
578 const char *section_name)
581 struct target_section *p;
582 ULONGEST memaddr = offset;
583 ULONGEST memend = memaddr + len;
586 internal_error (__FILE__, __LINE__, _("failed internal consistency check"));
588 for (p = sections; p < sections_end; p++)
590 if (section_name && strcmp (section_name, p->the_bfd_section->name) != 0)
591 continue; /* not the section we need */
592 if (memaddr >= p->addr)
594 if (memend <= p->endaddr)
596 /* Entire transfer is within this section. */
598 res = bfd_set_section_contents (p->bfd, p->the_bfd_section,
599 writebuf, memaddr - p->addr,
602 res = bfd_get_section_contents (p->bfd, p->the_bfd_section,
603 readbuf, memaddr - p->addr,
605 return (res != 0) ? len : 0;
607 else if (memaddr >= p->endaddr)
609 /* This section ends before the transfer starts. */
614 /* This section overlaps the transfer. Just do half. */
615 len = p->endaddr - memaddr;
617 res = bfd_set_section_contents (p->bfd, p->the_bfd_section,
618 writebuf, memaddr - p->addr,
621 res = bfd_get_section_contents (p->bfd, p->the_bfd_section,
622 readbuf, memaddr - p->addr,
624 return (res != 0) ? len : 0;
629 return 0; /* We can't help */
632 struct target_section_table *
633 exec_get_section_table (struct target_ops *ops)
635 return current_target_sections;
639 exec_xfer_partial (struct target_ops *ops, enum target_object object,
640 const char *annex, gdb_byte *readbuf,
641 const gdb_byte *writebuf,
642 ULONGEST offset, LONGEST len)
644 struct target_section_table *table = target_get_section_table (ops);
646 if (object == TARGET_OBJECT_MEMORY)
647 return section_table_xfer_memory_partial (readbuf, writebuf,
658 print_section_info (struct target_section_table *t, bfd *abfd)
660 struct gdbarch *gdbarch = gdbarch_from_bfd (abfd);
661 struct target_section *p;
662 /* FIXME: 16 is not wide enough when gdbarch_addr_bit > 64. */
663 int wid = gdbarch_addr_bit (gdbarch) <= 32 ? 8 : 16;
665 printf_filtered ("\t`%s', ", bfd_get_filename (abfd));
667 printf_filtered (_("file type %s.\n"), bfd_get_target (abfd));
668 if (abfd == exec_bfd)
670 /* gcc-3.4 does not like the initialization in <p == t->sections_end>. */
671 bfd_vma displacement = 0;
674 for (p = t->sections; p < t->sections_end; p++)
676 asection *asect = p->the_bfd_section;
678 if ((bfd_get_section_flags (abfd, asect) & (SEC_ALLOC | SEC_LOAD))
679 != (SEC_ALLOC | SEC_LOAD))
682 if (bfd_get_section_vma (abfd, asect) <= abfd->start_address
683 && abfd->start_address < (bfd_get_section_vma (abfd, asect)
684 + bfd_get_section_size (asect)))
686 displacement = p->addr - bfd_get_section_vma (abfd, asect);
690 if (p == t->sections_end)
691 warning (_("Cannot find section for the entry point of %s.\n"),
692 bfd_get_filename (abfd));
694 entry_point = gdbarch_addr_bits_remove (gdbarch,
695 bfd_get_start_address (abfd)
697 printf_filtered (_("\tEntry point: %s\n"),
698 paddress (gdbarch, entry_point));
700 for (p = t->sections; p < t->sections_end; p++)
702 printf_filtered ("\t%s", hex_string_custom (p->addr, wid));
703 printf_filtered (" - %s", hex_string_custom (p->endaddr, wid));
705 /* FIXME: A format of "08l" is not wide enough for file offsets
706 larger than 4GB. OTOH, making it "016l" isn't desirable either
707 since most output will then be much wider than necessary. It
708 may make sense to test the size of the file and choose the
709 format string accordingly. */
710 /* FIXME: i18n: Need to rewrite this sentence. */
712 printf_filtered (" @ %s",
713 hex_string_custom (p->the_bfd_section->filepos, 8));
714 printf_filtered (" is %s", bfd_section_name (p->bfd, p->the_bfd_section));
716 printf_filtered (" in %s", bfd_get_filename (p->bfd));
717 printf_filtered ("\n");
722 exec_files_info (struct target_ops *t)
724 print_section_info (current_target_sections, exec_bfd);
728 int addr_size = gdbarch_addr_bit (target_gdbarch) / 8;
731 printf_unfiltered (_("\tMapping info for file `%s'.\n"), vmap->name);
732 printf_unfiltered ("\t %*s %*s %*s %*s %8.8s %s\n",
733 addr_size * 2, "tstart",
734 addr_size * 2, "tend",
735 addr_size * 2, "dstart",
736 addr_size * 2, "dend",
740 for (vp = vmap; vp; vp = vp->nxt)
741 printf_unfiltered ("\t0x%s 0x%s 0x%s 0x%s %s%s%s%s\n",
742 phex (vp->tstart, addr_size),
743 phex (vp->tend, addr_size),
744 phex (vp->dstart, addr_size),
745 phex (vp->dend, addr_size),
747 *vp->member ? "(" : "", vp->member,
748 *vp->member ? ")" : "");
753 set_section_command (char *args, int from_tty)
755 struct target_section *p;
758 unsigned long secaddr;
761 struct target_section_table *table;
764 error (_("Must specify section name and its virtual address"));
766 /* Parse out section name */
767 for (secname = args; !isspace (*args); args++);
768 seclen = args - secname;
770 /* Parse out new virtual address */
771 secaddr = parse_and_eval_address (args);
773 table = current_target_sections;
774 for (p = table->sections; p < table->sections_end; p++)
776 if (!strncmp (secname, bfd_section_name (exec_bfd, p->the_bfd_section), seclen)
777 && bfd_section_name (exec_bfd, p->the_bfd_section)[seclen] == '\0')
779 offset = secaddr - p->addr;
781 p->endaddr += offset;
783 exec_files_info (&exec_ops);
787 if (seclen >= sizeof (secprint))
788 seclen = sizeof (secprint) - 1;
789 strncpy (secprint, secname, seclen);
790 secprint[seclen] = '\0';
791 error (_("Section %s not found"), secprint);
794 /* If we can find a section in FILENAME with BFD index INDEX, adjust
798 exec_set_section_address (const char *filename, int index, CORE_ADDR address)
800 struct target_section *p;
801 struct target_section_table *table;
803 table = current_target_sections;
804 for (p = table->sections; p < table->sections_end; p++)
806 if (strcmp (filename, p->bfd->filename) == 0
807 && index == p->the_bfd_section->index)
809 p->endaddr += address - p->addr;
815 /* If mourn is being called in all the right places, this could be say
816 `gdb internal error' (since generic_mourn calls
817 breakpoint_init_inferior). */
820 ignore (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt)
826 exec_has_memory (struct target_ops *ops)
828 /* We can provide memory if we have any file/target sections to read
830 return (current_target_sections->sections
831 != current_target_sections->sections_end);
834 /* Find mapped memory. */
837 exec_set_find_memory_regions (int (*func) (int (*) (CORE_ADDR,
843 exec_ops.to_find_memory_regions = func;
846 static char *exec_make_note_section (bfd *, int *);
848 /* Fill in the exec file target vector. Very few entries need to be
854 exec_ops.to_shortname = "exec";
855 exec_ops.to_longname = "Local exec file";
856 exec_ops.to_doc = "Use an executable file as a target.\n\
857 Specify the filename of the executable file.";
858 exec_ops.to_open = exec_open;
859 exec_ops.to_close = exec_close_1;
860 exec_ops.to_attach = find_default_attach;
861 exec_ops.to_xfer_partial = exec_xfer_partial;
862 exec_ops.to_get_section_table = exec_get_section_table;
863 exec_ops.to_files_info = exec_files_info;
864 exec_ops.to_insert_breakpoint = ignore;
865 exec_ops.to_remove_breakpoint = ignore;
866 exec_ops.to_create_inferior = find_default_create_inferior;
867 exec_ops.to_stratum = file_stratum;
868 exec_ops.to_has_memory = exec_has_memory;
869 exec_ops.to_make_corefile_notes = exec_make_note_section;
870 exec_ops.to_magic = OPS_MAGIC;
874 _initialize_exec (void)
876 struct cmd_list_element *c;
882 c = add_cmd ("file", class_files, file_command, _("\
883 Use FILE as program to be debugged.\n\
884 It is read for its symbols, for getting the contents of pure memory,\n\
885 and it is the program executed when you use the `run' command.\n\
886 If FILE cannot be found as specified, your execution directory path\n\
887 ($PATH) is searched for a command of that name.\n\
888 No arg means to have no executable file and no symbols."), &cmdlist);
889 set_cmd_completer (c, filename_completer);
892 c = add_cmd ("exec-file", class_files, exec_file_command, _("\
893 Use FILE as program for getting contents of pure memory.\n\
894 If FILE cannot be found as specified, your execution directory path\n\
895 is searched for a command of that name.\n\
896 No arg means have no executable file."), &cmdlist);
897 set_cmd_completer (c, filename_completer);
899 add_com ("section", class_files, set_section_command, _("\
900 Change the base address of section SECTION of the exec file to ADDR.\n\
901 This can be used if the exec file does not contain section addresses,\n\
902 (such as in the a.out format), or when the addresses specified in the\n\
903 file itself are wrong. Each section must be changed separately. The\n\
904 ``info files'' command lists all the sections and their addresses."));
906 add_setshow_boolean_cmd ("write", class_support, &write_files, _("\
907 Set writing into executable and core files."), _("\
908 Show writing into executable and core files."), NULL,
911 &setlist, &showlist);
913 add_target (&exec_ops);
917 exec_make_note_section (bfd *obfd, int *note_size)
919 error (_("Can't create a corefile"));