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, 2011
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);
228 strcat (strcpy (exename, filename), ".exe");
229 scratch_chan = openp (getenv ("PATH"), OPF_TRY_CWD_FIRST, exename,
230 write_files ? O_RDWR | O_BINARY : O_RDONLY | O_BINARY,
234 if (scratch_chan < 0)
235 perror_with_name (filename);
236 exec_bfd = bfd_fopen (scratch_pathname, gnutarget,
237 write_files ? FOPEN_RUB : FOPEN_RB,
242 close (scratch_chan);
243 error (_("\"%s\": could not open as an executable file: %s"),
244 scratch_pathname, bfd_errmsg (bfd_get_error ()));
247 /* At this point, scratch_pathname and exec_bfd->name both point to the
248 same malloc'd string. However exec_close() will attempt to free it
249 via the exec_bfd->name pointer, so we need to make another copy and
250 leave exec_bfd as the new owner of the original copy. */
251 scratch_pathname = xstrdup (scratch_pathname);
252 cleanups = make_cleanup (xfree, scratch_pathname);
254 if (!bfd_check_format_matches (exec_bfd, bfd_object, &matching))
256 /* Make sure to close exec_bfd, or else "run" might try to use
259 error (_("\"%s\": not in executable format: %s"),
261 gdb_bfd_errmsg (bfd_get_error (), matching));
264 /* FIXME - This should only be run for RS6000, but the ifdef is a poor
265 way to accomplish. */
266 #ifdef DEPRECATED_IBM6000_TARGET
267 /* Setup initial vmap. */
269 map_vmap (exec_bfd, 0);
272 /* Make sure to close exec_bfd, or else "run" might try to use
275 error (_("\"%s\": can't find the file sections: %s"),
276 scratch_pathname, bfd_errmsg (bfd_get_error ()));
278 #endif /* DEPRECATED_IBM6000_TARGET */
280 if (build_section_table (exec_bfd, §ions, §ions_end))
282 /* Make sure to close exec_bfd, or else "run" might try to use
285 error (_("\"%s\": can't find the file sections: %s"),
286 scratch_pathname, bfd_errmsg (bfd_get_error ()));
289 exec_bfd_mtime = bfd_get_mtime (exec_bfd);
293 set_gdbarch_from_file (exec_bfd);
295 /* Add the executable's sections to the current address spaces'
296 list of sections. This possibly pushes the exec_ops
298 add_target_sections (sections, sections_end);
301 /* Tell display code (if any) about the changed file name. */
302 if (deprecated_exec_file_display_hook)
303 (*deprecated_exec_file_display_hook) (filename);
305 do_cleanups (cleanups);
307 bfd_cache_close_all ();
308 observer_notify_executable_changed ();
311 /* Process the first arg in ARGS as the new exec file.
313 Note that we have to explicitly ignore additional args, since we can
314 be called from file_command(), which also calls symbol_file_command()
315 which can take multiple args.
317 If ARGS is NULL, we just want to close the exec file. */
320 exec_file_command (char *args, int from_tty)
325 if (from_tty && target_has_execution
326 && !query (_("A program is being debugged already.\n"
327 "Are you sure you want to change the file? ")))
328 error (_("File not changed."));
332 struct cleanup *cleanups;
334 /* Scan through the args and pick up the first non option arg
337 argv = gdb_buildargv (args);
338 cleanups = make_cleanup_freeargv (argv);
340 for (; (*argv != NULL) && (**argv == '-'); argv++)
344 error (_("No executable file name was specified"));
346 filename = tilde_expand (*argv);
347 make_cleanup (xfree, filename);
348 exec_file_attach (filename, from_tty);
350 do_cleanups (cleanups);
353 exec_file_attach (NULL, from_tty);
356 /* Set both the exec file and the symbol file, in one command.
357 What a novelty. Why did GDB go through four major releases before this
358 command was added? */
361 file_command (char *arg, int from_tty)
363 /* FIXME, if we lose on reading the symbol file, we should revert
364 the exec file, but that's rough. */
365 exec_file_command (arg, from_tty);
366 symbol_file_command (arg, from_tty);
367 if (deprecated_file_changed_hook)
368 deprecated_file_changed_hook (arg);
372 /* Locate all mappable sections of a BFD file.
373 table_pp_char is a char * to get it through bfd_map_over_sections;
374 we cast it back to its proper type. */
377 add_to_section_table (bfd *abfd, struct bfd_section *asect,
380 struct target_section **table_pp = (struct target_section **) table_pp_char;
383 /* Check the section flags, but do not discard zero-length sections, since
384 some symbols may still be attached to this section. For instance, we
385 encountered on sparc-solaris 2.10 a shared library with an empty .bss
386 section to which a symbol named "_end" was attached. The address
387 of this symbol still needs to be relocated. */
388 aflag = bfd_get_section_flags (abfd, asect);
389 if (!(aflag & SEC_ALLOC))
392 (*table_pp)->bfd = abfd;
393 (*table_pp)->the_bfd_section = asect;
394 (*table_pp)->addr = bfd_section_vma (abfd, asect);
395 (*table_pp)->endaddr = (*table_pp)->addr + bfd_section_size (abfd, asect);
400 resize_section_table (struct target_section_table *table, int num_added)
402 struct target_section *old_value;
406 old_value = table->sections;
407 old_count = table->sections_end - table->sections;
409 new_count = num_added + old_count;
413 table->sections = xrealloc (table->sections,
414 sizeof (struct target_section) * new_count);
415 table->sections_end = table->sections + new_count;
419 xfree (table->sections);
420 table->sections = table->sections_end = NULL;
426 /* Builds a section table, given args BFD, SECTABLE_PTR, SECEND_PTR.
427 Returns 0 if OK, 1 on error. */
430 build_section_table (struct bfd *some_bfd, struct target_section **start,
431 struct target_section **end)
435 count = bfd_count_sections (some_bfd);
438 *start = (struct target_section *) xmalloc (count * sizeof (**start));
440 bfd_map_over_sections (some_bfd, add_to_section_table, (char *) end);
441 if (*end > *start + count)
442 internal_error (__FILE__, __LINE__,
443 _("failed internal consistency check"));
444 /* We could realloc the table, but it probably loses for most files. */
448 /* Add the sections array defined by [SECTIONS..SECTIONS_END[ to the
449 current set of target sections. */
452 add_target_sections (struct target_section *sections,
453 struct target_section *sections_end)
456 struct target_section_table *table = current_target_sections;
458 count = sections_end - sections;
462 int space = resize_section_table (table, count);
464 memcpy (table->sections + space,
465 sections, count * sizeof (sections[0]));
467 /* If these are the first file sections we can provide memory
468 from, push the file_stratum target. */
472 push_target (&exec_ops);
477 /* Remove all target sections taken from ABFD. */
480 remove_target_sections (bfd *abfd)
482 struct target_section *src, *dest;
483 struct target_section_table *table = current_target_sections;
485 dest = table->sections;
486 for (src = table->sections; src < table->sections_end; src++)
487 if (src->bfd != abfd)
489 /* Keep this section. */
495 /* If we've dropped any sections, resize the section table. */
500 old_count = resize_section_table (table, dest - src);
502 /* If we don't have any more sections to read memory from,
503 remove the file_stratum target from the stack. */
504 if (old_count + (dest - src) == 0)
506 struct program_space *pspace;
509 if (pspace->target_sections.sections
510 != pspace->target_sections.sections_end)
513 unpush_target (&exec_ops);
520 bfdsec_to_vmap (struct bfd *abfd, struct bfd_section *sect, void *arg3)
522 struct vmap_and_bfd *vmap_bfd = (struct vmap_and_bfd *) arg3;
525 vp = vmap_bfd->pvmap;
527 if ((bfd_get_section_flags (abfd, sect) & SEC_LOAD) == 0)
530 if (strcmp (bfd_section_name (abfd, sect), ".text") == 0)
532 vp->tstart = bfd_section_vma (abfd, sect);
533 vp->tend = vp->tstart + bfd_section_size (abfd, sect);
534 vp->tvma = bfd_section_vma (abfd, sect);
535 vp->toffs = sect->filepos;
537 else if (strcmp (bfd_section_name (abfd, sect), ".data") == 0)
539 vp->dstart = bfd_section_vma (abfd, sect);
540 vp->dend = vp->dstart + bfd_section_size (abfd, sect);
541 vp->dvma = bfd_section_vma (abfd, sect);
543 /* Silently ignore other types of sections. (FIXME?) */
546 /* Make a vmap for ABFD which might be a member of the archive ARCH.
547 Return the new vmap. */
550 map_vmap (bfd *abfd, bfd *arch)
552 struct vmap_and_bfd vmap_bfd;
553 struct vmap *vp, **vpp;
555 vp = (struct vmap *) xmalloc (sizeof (*vp));
556 memset ((char *) vp, '\0', sizeof (*vp));
559 vp->name = bfd_get_filename (arch ? arch : abfd);
560 vp->member = arch ? bfd_get_filename (abfd) : "";
562 vmap_bfd.pbfd = arch;
564 bfd_map_over_sections (abfd, bfdsec_to_vmap, &vmap_bfd);
566 /* Find the end of the list and append. */
567 for (vpp = &vmap; *vpp; vpp = &(*vpp)->nxt)
576 section_table_available_memory (VEC(mem_range_s) *memory,
577 CORE_ADDR memaddr, ULONGEST len,
578 struct target_section *sections,
579 struct target_section *sections_end)
581 struct target_section *p;
583 for (p = sections; p < sections_end; p++)
585 if ((bfd_get_section_flags (p->bfd, p->the_bfd_section)
586 & SEC_READONLY) == 0)
589 /* Copy the meta-data, adjusted. */
590 if (mem_ranges_overlap (p->addr, p->endaddr - p->addr, memaddr, len))
592 ULONGEST lo1, hi1, lo2, hi2;
601 r = VEC_safe_push (mem_range_s, memory, NULL);
603 r->start = max (lo1, lo2);
604 r->length = min (hi1, hi2) - r->start;
612 section_table_xfer_memory_partial (gdb_byte *readbuf, const gdb_byte *writebuf,
613 ULONGEST offset, LONGEST len,
614 struct target_section *sections,
615 struct target_section *sections_end,
616 const char *section_name)
619 struct target_section *p;
620 ULONGEST memaddr = offset;
621 ULONGEST memend = memaddr + len;
624 internal_error (__FILE__, __LINE__,
625 _("failed internal consistency check"));
627 for (p = sections; p < sections_end; p++)
629 if (section_name && strcmp (section_name, p->the_bfd_section->name) != 0)
630 continue; /* not the section we need. */
631 if (memaddr >= p->addr)
633 if (memend <= p->endaddr)
635 /* Entire transfer is within this section. */
637 res = bfd_set_section_contents (p->bfd, p->the_bfd_section,
638 writebuf, memaddr - p->addr,
641 res = bfd_get_section_contents (p->bfd, p->the_bfd_section,
642 readbuf, memaddr - p->addr,
644 return (res != 0) ? len : 0;
646 else if (memaddr >= p->endaddr)
648 /* This section ends before the transfer starts. */
653 /* This section overlaps the transfer. Just do half. */
654 len = p->endaddr - memaddr;
656 res = bfd_set_section_contents (p->bfd, p->the_bfd_section,
657 writebuf, memaddr - p->addr,
660 res = bfd_get_section_contents (p->bfd, p->the_bfd_section,
661 readbuf, memaddr - p->addr,
663 return (res != 0) ? len : 0;
668 return 0; /* We can't help. */
671 struct target_section_table *
672 exec_get_section_table (struct target_ops *ops)
674 return current_target_sections;
678 exec_xfer_partial (struct target_ops *ops, enum target_object object,
679 const char *annex, gdb_byte *readbuf,
680 const gdb_byte *writebuf,
681 ULONGEST offset, LONGEST len)
683 struct target_section_table *table = target_get_section_table (ops);
685 if (object == TARGET_OBJECT_MEMORY)
686 return section_table_xfer_memory_partial (readbuf, writebuf,
697 print_section_info (struct target_section_table *t, bfd *abfd)
699 struct gdbarch *gdbarch = gdbarch_from_bfd (abfd);
700 struct target_section *p;
701 /* FIXME: 16 is not wide enough when gdbarch_addr_bit > 64. */
702 int wid = gdbarch_addr_bit (gdbarch) <= 32 ? 8 : 16;
704 printf_filtered ("\t`%s', ", bfd_get_filename (abfd));
706 printf_filtered (_("file type %s.\n"), bfd_get_target (abfd));
707 if (abfd == exec_bfd)
709 /* gcc-3.4 does not like the initialization in
710 <p == t->sections_end>. */
711 bfd_vma displacement = 0;
714 for (p = t->sections; p < t->sections_end; p++)
716 asection *asect = p->the_bfd_section;
718 if ((bfd_get_section_flags (abfd, asect) & (SEC_ALLOC | SEC_LOAD))
719 != (SEC_ALLOC | SEC_LOAD))
722 if (bfd_get_section_vma (abfd, asect) <= abfd->start_address
723 && abfd->start_address < (bfd_get_section_vma (abfd, asect)
724 + bfd_get_section_size (asect)))
726 displacement = p->addr - bfd_get_section_vma (abfd, asect);
730 if (p == t->sections_end)
731 warning (_("Cannot find section for the entry point of %s.\n"),
732 bfd_get_filename (abfd));
734 entry_point = gdbarch_addr_bits_remove (gdbarch,
735 bfd_get_start_address (abfd)
737 printf_filtered (_("\tEntry point: %s\n"),
738 paddress (gdbarch, entry_point));
740 for (p = t->sections; p < t->sections_end; p++)
742 printf_filtered ("\t%s", hex_string_custom (p->addr, wid));
743 printf_filtered (" - %s", hex_string_custom (p->endaddr, wid));
745 /* FIXME: A format of "08l" is not wide enough for file offsets
746 larger than 4GB. OTOH, making it "016l" isn't desirable either
747 since most output will then be much wider than necessary. It
748 may make sense to test the size of the file and choose the
749 format string accordingly. */
750 /* FIXME: i18n: Need to rewrite this sentence. */
752 printf_filtered (" @ %s",
753 hex_string_custom (p->the_bfd_section->filepos, 8));
754 printf_filtered (" is %s", bfd_section_name (p->bfd,
755 p->the_bfd_section));
757 printf_filtered (" in %s", bfd_get_filename (p->bfd));
758 printf_filtered ("\n");
763 exec_files_info (struct target_ops *t)
765 print_section_info (current_target_sections, exec_bfd);
769 int addr_size = gdbarch_addr_bit (target_gdbarch) / 8;
772 printf_unfiltered (_("\tMapping info for file `%s'.\n"), vmap->name);
773 printf_unfiltered ("\t %*s %*s %*s %*s %8.8s %s\n",
774 addr_size * 2, "tstart",
775 addr_size * 2, "tend",
776 addr_size * 2, "dstart",
777 addr_size * 2, "dend",
781 for (vp = vmap; vp; vp = vp->nxt)
782 printf_unfiltered ("\t0x%s 0x%s 0x%s 0x%s %s%s%s%s\n",
783 phex (vp->tstart, addr_size),
784 phex (vp->tend, addr_size),
785 phex (vp->dstart, addr_size),
786 phex (vp->dend, addr_size),
788 *vp->member ? "(" : "", vp->member,
789 *vp->member ? ")" : "");
794 set_section_command (char *args, int from_tty)
796 struct target_section *p;
799 unsigned long secaddr;
802 struct target_section_table *table;
805 error (_("Must specify section name and its virtual address"));
807 /* Parse out section name. */
808 for (secname = args; !isspace (*args); args++);
809 seclen = args - secname;
811 /* Parse out new virtual address. */
812 secaddr = parse_and_eval_address (args);
814 table = current_target_sections;
815 for (p = table->sections; p < table->sections_end; p++)
817 if (!strncmp (secname, bfd_section_name (exec_bfd,
818 p->the_bfd_section), seclen)
819 && bfd_section_name (exec_bfd, p->the_bfd_section)[seclen] == '\0')
821 offset = secaddr - p->addr;
823 p->endaddr += offset;
825 exec_files_info (&exec_ops);
829 if (seclen >= sizeof (secprint))
830 seclen = sizeof (secprint) - 1;
831 strncpy (secprint, secname, seclen);
832 secprint[seclen] = '\0';
833 error (_("Section %s not found"), secprint);
836 /* If we can find a section in FILENAME with BFD index INDEX, adjust
840 exec_set_section_address (const char *filename, int index, CORE_ADDR address)
842 struct target_section *p;
843 struct target_section_table *table;
845 table = current_target_sections;
846 for (p = table->sections; p < table->sections_end; p++)
848 if (strcmp (filename, p->bfd->filename) == 0
849 && index == p->the_bfd_section->index)
851 p->endaddr += address - p->addr;
857 /* If mourn is being called in all the right places, this could be say
858 `gdb internal error' (since generic_mourn calls
859 breakpoint_init_inferior). */
862 ignore (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt)
868 exec_has_memory (struct target_ops *ops)
870 /* We can provide memory if we have any file/target sections to read
872 return (current_target_sections->sections
873 != current_target_sections->sections_end);
876 /* Find mapped memory. */
879 exec_set_find_memory_regions (int (*func) (find_memory_region_ftype, void *))
881 exec_ops.to_find_memory_regions = func;
884 static char *exec_make_note_section (bfd *, int *);
886 /* Fill in the exec file target vector. Very few entries need to be
892 exec_ops.to_shortname = "exec";
893 exec_ops.to_longname = "Local exec file";
894 exec_ops.to_doc = "Use an executable file as a target.\n\
895 Specify the filename of the executable file.";
896 exec_ops.to_open = exec_open;
897 exec_ops.to_close = exec_close_1;
898 exec_ops.to_attach = find_default_attach;
899 exec_ops.to_xfer_partial = exec_xfer_partial;
900 exec_ops.to_get_section_table = exec_get_section_table;
901 exec_ops.to_files_info = exec_files_info;
902 exec_ops.to_insert_breakpoint = ignore;
903 exec_ops.to_remove_breakpoint = ignore;
904 exec_ops.to_create_inferior = find_default_create_inferior;
905 exec_ops.to_stratum = file_stratum;
906 exec_ops.to_has_memory = exec_has_memory;
907 exec_ops.to_make_corefile_notes = exec_make_note_section;
908 exec_ops.to_magic = OPS_MAGIC;
912 _initialize_exec (void)
914 struct cmd_list_element *c;
920 c = add_cmd ("file", class_files, file_command, _("\
921 Use FILE as program to be debugged.\n\
922 It is read for its symbols, for getting the contents of pure memory,\n\
923 and it is the program executed when you use the `run' command.\n\
924 If FILE cannot be found as specified, your execution directory path\n\
925 ($PATH) is searched for a command of that name.\n\
926 No arg means to have no executable file and no symbols."), &cmdlist);
927 set_cmd_completer (c, filename_completer);
930 c = add_cmd ("exec-file", class_files, exec_file_command, _("\
931 Use FILE as program for getting contents of pure memory.\n\
932 If FILE cannot be found as specified, your execution directory path\n\
933 is searched for a command of that name.\n\
934 No arg means have no executable file."), &cmdlist);
935 set_cmd_completer (c, filename_completer);
937 add_com ("section", class_files, set_section_command, _("\
938 Change the base address of section SECTION of the exec file to ADDR.\n\
939 This can be used if the exec file does not contain section addresses,\n\
940 (such as in the a.out format), or when the addresses specified in the\n\
941 file itself are wrong. Each section must be changed separately. The\n\
942 ``info files'' command lists all the sections and their addresses."));
944 add_setshow_boolean_cmd ("write", class_support, &write_files, _("\
945 Set writing into executable and core files."), _("\
946 Show writing into executable and core files."), NULL,
949 &setlist, &showlist);
951 add_target (&exec_ops);
955 exec_make_note_section (bfd *obfd, int *note_size)
957 error (_("Can't create a corefile"));