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/>. */
28 #include "filenames.h"
31 #include "completer.h"
35 #include "arch-utils.h"
36 #include "gdbthread.h"
37 #include "progspace.h"
40 #include "readline/readline.h"
41 #include "gdb_string.h"
48 #include "xcoffsolib.h"
50 struct vmap *map_vmap (bfd *, bfd *);
52 void (*deprecated_file_changed_hook) (char *);
54 /* Prototypes for local functions */
56 static void file_command (char *, int);
58 static void set_section_command (char *, int);
60 static void exec_files_info (struct target_ops *);
62 static void init_exec_ops (void);
64 void _initialize_exec (void);
66 /* The target vector for executable files. */
68 struct target_ops exec_ops;
70 /* True if the exec target is pushed on the stack. */
71 static int using_exec_ops;
73 /* Whether to open exec and core files read-only or read-write. */
77 show_write_files (struct ui_file *file, int from_tty,
78 struct cmd_list_element *c, const char *value)
80 fprintf_filtered (file, _("Writing into executable and core files is %s.\n"),
88 exec_open (char *args, int from_tty)
90 target_preopen (from_tty);
91 exec_file_attach (args, from_tty);
94 /* Close and clear exec_bfd. If we end up with no target sections to
95 read memory from, this unpushes the exec_ops target. */
102 bfd *abfd = exec_bfd;
103 char *name = bfd_get_filename (abfd);
105 gdb_bfd_close_or_warn (abfd);
108 /* Removing target sections may close the exec_ops target.
109 Clear exec_bfd before doing so to prevent recursion. */
113 remove_target_sections (abfd);
117 /* This is the target_close implementation. Clears all target
118 sections and closes all executable bfds from all program spaces. */
121 exec_close_1 (int quitting)
123 int need_symtab_cleanup = 0;
124 struct vmap *vp, *nxt;
128 for (nxt = vmap; nxt != NULL;)
133 /* if there is an objfile associated with this bfd,
134 free_objfile() will do proper cleanup of objfile *and* bfd. */
138 free_objfile (vp->objfile);
139 need_symtab_cleanup = 1;
141 else if (vp->bfd != exec_bfd)
142 /* FIXME-leak: We should be freeing vp->name too, I think. */
143 gdb_bfd_close_or_warn (vp->bfd);
151 struct program_space *ss;
152 struct cleanup *old_chain;
154 old_chain = save_current_program_space ();
157 set_current_program_space (ss);
159 /* Delete all target sections. */
161 (current_target_sections,
162 -resize_section_table (current_target_sections, 0));
167 do_cleanups (old_chain);
172 exec_file_clear (int from_tty)
174 /* Remove exec file. */
178 printf_unfiltered (_("No executable file now.\n"));
181 /* Set FILENAME as the new exec file.
183 This function is intended to be behave essentially the same
184 as exec_file_command, except that the latter will detect when
185 a target is being debugged, and will ask the user whether it
186 should be shut down first. (If the answer is "no", then the
187 new file is ignored.)
189 This file is used by exec_file_command, to do the work of opening
190 and processing the exec file after any prompting has happened.
192 And, it is used by child_attach, when the attach command was
193 given a pid but not a exec pathname, and the attach command could
194 figure out the pathname from the pid. (In this case, we shouldn't
195 ask the user whether the current target should be shut down --
196 we're supplying the exec pathname late for good reason.) */
199 exec_file_attach (char *filename, int from_tty)
201 /* Remove any previous exec file. */
204 /* Now open and digest the file the user requested, if any. */
209 printf_unfiltered (_("No executable file now.\n"));
211 set_gdbarch_from_file (NULL);
215 struct cleanup *cleanups;
216 char *scratch_pathname;
218 struct target_section *sections = NULL, *sections_end = NULL;
221 scratch_chan = openp (getenv ("PATH"), OPF_TRY_CWD_FIRST, filename,
222 write_files ? O_RDWR | O_BINARY : O_RDONLY | O_BINARY,
224 #if defined(__GO32__) || defined(_WIN32) || defined(__CYGWIN__)
225 if (scratch_chan < 0)
227 char *exename = alloca (strlen (filename) + 5);
229 strcat (strcpy (exename, filename), ".exe");
230 scratch_chan = openp (getenv ("PATH"), OPF_TRY_CWD_FIRST, exename,
231 write_files ? O_RDWR | O_BINARY : O_RDONLY | O_BINARY,
235 if (scratch_chan < 0)
236 perror_with_name (filename);
237 exec_bfd = bfd_fopen (scratch_pathname, gnutarget,
238 write_files ? FOPEN_RUB : FOPEN_RB,
243 close (scratch_chan);
244 error (_("\"%s\": could not open as an executable file: %s"),
245 scratch_pathname, bfd_errmsg (bfd_get_error ()));
248 /* At this point, scratch_pathname and exec_bfd->name both point to the
249 same malloc'd string. However exec_close() will attempt to free it
250 via the exec_bfd->name pointer, so we need to make another copy and
251 leave exec_bfd as the new owner of the original copy. */
252 scratch_pathname = xstrdup (scratch_pathname);
253 cleanups = make_cleanup (xfree, scratch_pathname);
255 if (!bfd_check_format_matches (exec_bfd, bfd_object, &matching))
257 /* Make sure to close exec_bfd, or else "run" might try to use
260 error (_("\"%s\": not in executable format: %s"),
262 gdb_bfd_errmsg (bfd_get_error (), matching));
265 /* FIXME - This should only be run for RS6000, but the ifdef is a poor
266 way to accomplish. */
267 #ifdef DEPRECATED_IBM6000_TARGET
268 /* Setup initial vmap. */
270 map_vmap (exec_bfd, 0);
273 /* Make sure to close exec_bfd, or else "run" might try to use
276 error (_("\"%s\": can't find the file sections: %s"),
277 scratch_pathname, bfd_errmsg (bfd_get_error ()));
279 #endif /* DEPRECATED_IBM6000_TARGET */
281 if (build_section_table (exec_bfd, §ions, §ions_end))
283 /* Make sure to close exec_bfd, or else "run" might try to use
286 error (_("\"%s\": can't find the file sections: %s"),
287 scratch_pathname, bfd_errmsg (bfd_get_error ()));
290 exec_bfd_mtime = bfd_get_mtime (exec_bfd);
294 set_gdbarch_from_file (exec_bfd);
296 /* Add the executable's sections to the current address spaces'
297 list of sections. This possibly pushes the exec_ops
299 add_target_sections (sections, sections_end);
302 /* Tell display code (if any) about the changed file name. */
303 if (deprecated_exec_file_display_hook)
304 (*deprecated_exec_file_display_hook) (filename);
306 do_cleanups (cleanups);
308 bfd_cache_close_all ();
309 observer_notify_executable_changed ();
312 /* Process the first arg in ARGS as the new exec file.
314 Note that we have to explicitly ignore additional args, since we can
315 be called from file_command(), which also calls symbol_file_command()
316 which can take multiple args.
318 If ARGS is NULL, we just want to close the exec file. */
321 exec_file_command (char *args, int from_tty)
326 if (from_tty && target_has_execution
327 && !query (_("A program is being debugged already.\n"
328 "Are you sure you want to change the file? ")))
329 error (_("File not changed."));
333 struct cleanup *cleanups;
335 /* Scan through the args and pick up the first non option arg
338 argv = gdb_buildargv (args);
339 cleanups = make_cleanup_freeargv (argv);
341 for (; (*argv != NULL) && (**argv == '-'); argv++)
345 error (_("No executable file name was specified"));
347 filename = tilde_expand (*argv);
348 make_cleanup (xfree, filename);
349 exec_file_attach (filename, from_tty);
351 do_cleanups (cleanups);
354 exec_file_attach (NULL, from_tty);
357 /* Set both the exec file and the symbol file, in one command.
358 What a novelty. Why did GDB go through four major releases before this
359 command was added? */
362 file_command (char *arg, int from_tty)
364 /* FIXME, if we lose on reading the symbol file, we should revert
365 the exec file, but that's rough. */
366 exec_file_command (arg, from_tty);
367 symbol_file_command (arg, from_tty);
368 if (deprecated_file_changed_hook)
369 deprecated_file_changed_hook (arg);
373 /* Locate all mappable sections of a BFD file.
374 table_pp_char is a char * to get it through bfd_map_over_sections;
375 we cast it back to its proper type. */
378 add_to_section_table (bfd *abfd, struct bfd_section *asect,
381 struct target_section **table_pp = (struct target_section **) table_pp_char;
384 /* Check the section flags, but do not discard zero-length sections, since
385 some symbols may still be attached to this section. For instance, we
386 encountered on sparc-solaris 2.10 a shared library with an empty .bss
387 section to which a symbol named "_end" was attached. The address
388 of this symbol still needs to be relocated. */
389 aflag = bfd_get_section_flags (abfd, asect);
390 if (!(aflag & SEC_ALLOC))
393 (*table_pp)->bfd = abfd;
394 (*table_pp)->the_bfd_section = asect;
395 (*table_pp)->addr = bfd_section_vma (abfd, asect);
396 (*table_pp)->endaddr = (*table_pp)->addr + bfd_section_size (abfd, asect);
401 resize_section_table (struct target_section_table *table, int num_added)
406 old_count = table->sections_end - table->sections;
411 new_count = num_added + old_count;
415 table->sections = xrealloc (table->sections,
416 sizeof (struct target_section) * new_count);
417 table->sections_end = table->sections + new_count;
421 xfree (table->sections);
422 table->sections = table->sections_end = NULL;
428 /* Builds a section table, given args BFD, SECTABLE_PTR, SECEND_PTR.
429 Returns 0 if OK, 1 on error. */
432 build_section_table (struct bfd *some_bfd, struct target_section **start,
433 struct target_section **end)
437 count = bfd_count_sections (some_bfd);
440 *start = (struct target_section *) xmalloc (count * sizeof (**start));
442 bfd_map_over_sections (some_bfd, add_to_section_table, (char *) end);
443 if (*end > *start + count)
444 internal_error (__FILE__, __LINE__,
445 _("failed internal consistency check"));
446 /* We could realloc the table, but it probably loses for most files. */
450 /* Add the sections array defined by [SECTIONS..SECTIONS_END[ to the
451 current set of target sections. */
454 add_target_sections (struct target_section *sections,
455 struct target_section *sections_end)
458 struct target_section_table *table = current_target_sections;
460 count = sections_end - sections;
464 int space = resize_section_table (table, count);
466 memcpy (table->sections + space,
467 sections, count * sizeof (sections[0]));
469 /* If these are the first file sections we can provide memory
470 from, push the file_stratum target. */
474 push_target (&exec_ops);
479 /* Remove all target sections taken from ABFD. */
482 remove_target_sections (bfd *abfd)
484 struct target_section *src, *dest;
485 struct target_section_table *table = current_target_sections;
487 dest = table->sections;
488 for (src = table->sections; src < table->sections_end; src++)
489 if (src->bfd != abfd)
491 /* Keep this section. */
497 /* If we've dropped any sections, resize the section table. */
502 old_count = resize_section_table (table, dest - src);
504 /* If we don't have any more sections to read memory from,
505 remove the file_stratum target from the stack. */
506 if (old_count + (dest - src) == 0)
508 struct program_space *pspace;
511 if (pspace->target_sections.sections
512 != pspace->target_sections.sections_end)
515 unpush_target (&exec_ops);
522 bfdsec_to_vmap (struct bfd *abfd, struct bfd_section *sect, void *arg3)
524 struct vmap_and_bfd *vmap_bfd = (struct vmap_and_bfd *) arg3;
527 vp = vmap_bfd->pvmap;
529 if ((bfd_get_section_flags (abfd, sect) & SEC_LOAD) == 0)
532 if (strcmp (bfd_section_name (abfd, sect), ".text") == 0)
534 vp->tstart = bfd_section_vma (abfd, sect);
535 vp->tend = vp->tstart + bfd_section_size (abfd, sect);
536 vp->tvma = bfd_section_vma (abfd, sect);
537 vp->toffs = sect->filepos;
539 else if (strcmp (bfd_section_name (abfd, sect), ".data") == 0)
541 vp->dstart = bfd_section_vma (abfd, sect);
542 vp->dend = vp->dstart + bfd_section_size (abfd, sect);
543 vp->dvma = bfd_section_vma (abfd, sect);
545 /* Silently ignore other types of sections. (FIXME?) */
548 /* Make a vmap for ABFD which might be a member of the archive ARCH.
549 Return the new vmap. */
552 map_vmap (bfd *abfd, bfd *arch)
554 struct vmap_and_bfd vmap_bfd;
555 struct vmap *vp, **vpp;
557 vp = (struct vmap *) xmalloc (sizeof (*vp));
558 memset ((char *) vp, '\0', sizeof (*vp));
561 vp->name = bfd_get_filename (arch ? arch : abfd);
562 vp->member = arch ? bfd_get_filename (abfd) : "";
564 vmap_bfd.pbfd = arch;
566 bfd_map_over_sections (abfd, bfdsec_to_vmap, &vmap_bfd);
568 /* Find the end of the list and append. */
569 for (vpp = &vmap; *vpp; vpp = &(*vpp)->nxt)
578 section_table_available_memory (VEC(mem_range_s) *memory,
579 CORE_ADDR memaddr, ULONGEST len,
580 struct target_section *sections,
581 struct target_section *sections_end)
583 struct target_section *p;
585 for (p = sections; p < sections_end; p++)
587 if ((bfd_get_section_flags (p->bfd, p->the_bfd_section)
588 & SEC_READONLY) == 0)
591 /* Copy the meta-data, adjusted. */
592 if (mem_ranges_overlap (p->addr, p->endaddr - p->addr, memaddr, len))
594 ULONGEST lo1, hi1, lo2, hi2;
603 r = VEC_safe_push (mem_range_s, memory, NULL);
605 r->start = max (lo1, lo2);
606 r->length = min (hi1, hi2) - r->start;
614 section_table_xfer_memory_partial (gdb_byte *readbuf, const gdb_byte *writebuf,
615 ULONGEST offset, LONGEST len,
616 struct target_section *sections,
617 struct target_section *sections_end,
618 const char *section_name)
621 struct target_section *p;
622 ULONGEST memaddr = offset;
623 ULONGEST memend = memaddr + len;
626 internal_error (__FILE__, __LINE__,
627 _("failed internal consistency check"));
629 for (p = sections; p < sections_end; p++)
631 if (section_name && strcmp (section_name, p->the_bfd_section->name) != 0)
632 continue; /* not the section we need. */
633 if (memaddr >= p->addr)
635 if (memend <= p->endaddr)
637 /* Entire transfer is within this section. */
639 res = bfd_set_section_contents (p->bfd, p->the_bfd_section,
640 writebuf, memaddr - p->addr,
643 res = bfd_get_section_contents (p->bfd, p->the_bfd_section,
644 readbuf, memaddr - p->addr,
646 return (res != 0) ? len : 0;
648 else if (memaddr >= p->endaddr)
650 /* This section ends before the transfer starts. */
655 /* This section overlaps the transfer. Just do half. */
656 len = p->endaddr - memaddr;
658 res = bfd_set_section_contents (p->bfd, p->the_bfd_section,
659 writebuf, memaddr - p->addr,
662 res = bfd_get_section_contents (p->bfd, p->the_bfd_section,
663 readbuf, memaddr - p->addr,
665 return (res != 0) ? len : 0;
670 return 0; /* We can't help. */
673 struct target_section_table *
674 exec_get_section_table (struct target_ops *ops)
676 return current_target_sections;
680 exec_xfer_partial (struct target_ops *ops, enum target_object object,
681 const char *annex, gdb_byte *readbuf,
682 const gdb_byte *writebuf,
683 ULONGEST offset, LONGEST len)
685 struct target_section_table *table = target_get_section_table (ops);
687 if (object == TARGET_OBJECT_MEMORY)
688 return section_table_xfer_memory_partial (readbuf, writebuf,
699 print_section_info (struct target_section_table *t, bfd *abfd)
701 struct gdbarch *gdbarch = gdbarch_from_bfd (abfd);
702 struct target_section *p;
703 /* FIXME: 16 is not wide enough when gdbarch_addr_bit > 64. */
704 int wid = gdbarch_addr_bit (gdbarch) <= 32 ? 8 : 16;
706 printf_filtered ("\t`%s', ", bfd_get_filename (abfd));
708 printf_filtered (_("file type %s.\n"), bfd_get_target (abfd));
709 if (abfd == exec_bfd)
711 /* gcc-3.4 does not like the initialization in
712 <p == t->sections_end>. */
713 bfd_vma displacement = 0;
716 for (p = t->sections; p < t->sections_end; p++)
718 asection *asect = p->the_bfd_section;
720 if ((bfd_get_section_flags (abfd, asect) & (SEC_ALLOC | SEC_LOAD))
721 != (SEC_ALLOC | SEC_LOAD))
724 if (bfd_get_section_vma (abfd, asect) <= abfd->start_address
725 && abfd->start_address < (bfd_get_section_vma (abfd, asect)
726 + bfd_get_section_size (asect)))
728 displacement = p->addr - bfd_get_section_vma (abfd, asect);
732 if (p == t->sections_end)
733 warning (_("Cannot find section for the entry point of %s."),
734 bfd_get_filename (abfd));
736 entry_point = gdbarch_addr_bits_remove (gdbarch,
737 bfd_get_start_address (abfd)
739 printf_filtered (_("\tEntry point: %s\n"),
740 paddress (gdbarch, entry_point));
742 for (p = t->sections; p < t->sections_end; p++)
744 printf_filtered ("\t%s", hex_string_custom (p->addr, wid));
745 printf_filtered (" - %s", hex_string_custom (p->endaddr, wid));
747 /* FIXME: A format of "08l" is not wide enough for file offsets
748 larger than 4GB. OTOH, making it "016l" isn't desirable either
749 since most output will then be much wider than necessary. It
750 may make sense to test the size of the file and choose the
751 format string accordingly. */
752 /* FIXME: i18n: Need to rewrite this sentence. */
754 printf_filtered (" @ %s",
755 hex_string_custom (p->the_bfd_section->filepos, 8));
756 printf_filtered (" is %s", bfd_section_name (p->bfd,
757 p->the_bfd_section));
759 printf_filtered (" in %s", bfd_get_filename (p->bfd));
760 printf_filtered ("\n");
765 exec_files_info (struct target_ops *t)
767 print_section_info (current_target_sections, exec_bfd);
771 int addr_size = gdbarch_addr_bit (target_gdbarch) / 8;
774 printf_unfiltered (_("\tMapping info for file `%s'.\n"), vmap->name);
775 printf_unfiltered ("\t %*s %*s %*s %*s %8.8s %s\n",
776 addr_size * 2, "tstart",
777 addr_size * 2, "tend",
778 addr_size * 2, "dstart",
779 addr_size * 2, "dend",
783 for (vp = vmap; vp; vp = vp->nxt)
784 printf_unfiltered ("\t0x%s 0x%s 0x%s 0x%s %s%s%s%s\n",
785 phex (vp->tstart, addr_size),
786 phex (vp->tend, addr_size),
787 phex (vp->dstart, addr_size),
788 phex (vp->dend, addr_size),
790 *vp->member ? "(" : "", vp->member,
791 *vp->member ? ")" : "");
796 set_section_command (char *args, int from_tty)
798 struct target_section *p;
801 unsigned long secaddr;
804 struct target_section_table *table;
807 error (_("Must specify section name and its virtual address"));
809 /* Parse out section name. */
810 for (secname = args; !isspace (*args); args++);
811 seclen = args - secname;
813 /* Parse out new virtual address. */
814 secaddr = parse_and_eval_address (args);
816 table = current_target_sections;
817 for (p = table->sections; p < table->sections_end; p++)
819 if (!strncmp (secname, bfd_section_name (exec_bfd,
820 p->the_bfd_section), seclen)
821 && bfd_section_name (exec_bfd, p->the_bfd_section)[seclen] == '\0')
823 offset = secaddr - p->addr;
825 p->endaddr += offset;
827 exec_files_info (&exec_ops);
831 if (seclen >= sizeof (secprint))
832 seclen = sizeof (secprint) - 1;
833 strncpy (secprint, secname, seclen);
834 secprint[seclen] = '\0';
835 error (_("Section %s not found"), secprint);
838 /* If we can find a section in FILENAME with BFD index INDEX, adjust
842 exec_set_section_address (const char *filename, int index, CORE_ADDR address)
844 struct target_section *p;
845 struct target_section_table *table;
847 table = current_target_sections;
848 for (p = table->sections; p < table->sections_end; p++)
850 if (filename_cmp (filename, p->bfd->filename) == 0
851 && index == p->the_bfd_section->index)
853 p->endaddr += address - p->addr;
859 /* If mourn is being called in all the right places, this could be say
860 `gdb internal error' (since generic_mourn calls
861 breakpoint_init_inferior). */
864 ignore (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt)
870 exec_has_memory (struct target_ops *ops)
872 /* We can provide memory if we have any file/target sections to read
874 return (current_target_sections->sections
875 != current_target_sections->sections_end);
878 /* Find mapped memory. */
881 exec_set_find_memory_regions (int (*func) (find_memory_region_ftype, void *))
883 exec_ops.to_find_memory_regions = func;
886 static char *exec_make_note_section (bfd *, int *);
888 /* Fill in the exec file target vector. Very few entries need to be
894 exec_ops.to_shortname = "exec";
895 exec_ops.to_longname = "Local exec file";
896 exec_ops.to_doc = "Use an executable file as a target.\n\
897 Specify the filename of the executable file.";
898 exec_ops.to_open = exec_open;
899 exec_ops.to_close = exec_close_1;
900 exec_ops.to_attach = find_default_attach;
901 exec_ops.to_xfer_partial = exec_xfer_partial;
902 exec_ops.to_get_section_table = exec_get_section_table;
903 exec_ops.to_files_info = exec_files_info;
904 exec_ops.to_insert_breakpoint = ignore;
905 exec_ops.to_remove_breakpoint = ignore;
906 exec_ops.to_create_inferior = find_default_create_inferior;
907 exec_ops.to_stratum = file_stratum;
908 exec_ops.to_has_memory = exec_has_memory;
909 exec_ops.to_make_corefile_notes = exec_make_note_section;
910 exec_ops.to_magic = OPS_MAGIC;
914 _initialize_exec (void)
916 struct cmd_list_element *c;
922 c = add_cmd ("file", class_files, file_command, _("\
923 Use FILE as program to be debugged.\n\
924 It is read for its symbols, for getting the contents of pure memory,\n\
925 and it is the program executed when you use the `run' command.\n\
926 If FILE cannot be found as specified, your execution directory path\n\
927 ($PATH) is searched for a command of that name.\n\
928 No arg means to have no executable file and no symbols."), &cmdlist);
929 set_cmd_completer (c, filename_completer);
932 c = add_cmd ("exec-file", class_files, exec_file_command, _("\
933 Use FILE as program for getting contents of pure memory.\n\
934 If FILE cannot be found as specified, your execution directory path\n\
935 is searched for a command of that name.\n\
936 No arg means have no executable file."), &cmdlist);
937 set_cmd_completer (c, filename_completer);
939 add_com ("section", class_files, set_section_command, _("\
940 Change the base address of section SECTION of the exec file to ADDR.\n\
941 This can be used if the exec file does not contain section addresses,\n\
942 (such as in the a.out format), or when the addresses specified in the\n\
943 file itself are wrong. Each section must be changed separately. The\n\
944 ``info files'' command lists all the sections and their addresses."));
946 add_setshow_boolean_cmd ("write", class_support, &write_files, _("\
947 Set writing into executable and core files."), _("\
948 Show writing into executable and core files."), NULL,
951 &setlist, &showlist);
953 add_target (&exec_ops);
957 exec_make_note_section (bfd *obfd, int *note_size)
959 error (_("Can't create a corefile"));