1 /* Work with executable files, for GDB.
3 Copyright (C) 1988-2003, 2007-2012 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"
38 #include "readline/readline.h"
39 #include "gdb_string.h"
46 #include "xcoffsolib.h"
48 struct vmap *map_vmap (bfd *, bfd *);
50 void (*deprecated_file_changed_hook) (char *);
52 /* Prototypes for local functions */
54 static void file_command (char *, int);
56 static void set_section_command (char *, int);
58 static void exec_files_info (struct target_ops *);
60 static void init_exec_ops (void);
62 void _initialize_exec (void);
64 /* The target vector for executable files. */
66 struct target_ops exec_ops;
68 /* True if the exec target is pushed on the stack. */
69 static int using_exec_ops;
71 /* Whether to open exec and core files read-only or read-write. */
75 show_write_files (struct ui_file *file, int from_tty,
76 struct cmd_list_element *c, const char *value)
78 fprintf_filtered (file, _("Writing into executable and core files is %s.\n"),
86 exec_open (char *args, int from_tty)
88 target_preopen (from_tty);
89 exec_file_attach (args, from_tty);
92 /* Close and clear exec_bfd. If we end up with no target sections to
93 read memory from, this unpushes the exec_ops target. */
100 bfd *abfd = exec_bfd;
101 char *name = bfd_get_filename (abfd);
103 gdb_bfd_close_or_warn (abfd);
106 /* Removing target sections may close the exec_ops target.
107 Clear exec_bfd before doing so to prevent recursion. */
111 remove_target_sections (abfd);
115 /* This is the target_close implementation. Clears all target
116 sections and closes all executable bfds from all program spaces. */
119 exec_close_1 (int quitting)
121 int need_symtab_cleanup = 0;
122 struct vmap *vp, *nxt;
126 for (nxt = vmap; nxt != NULL;)
131 /* if there is an objfile associated with this bfd,
132 free_objfile() will do proper cleanup of objfile *and* bfd. */
136 free_objfile (vp->objfile);
137 need_symtab_cleanup = 1;
139 else if (vp->bfd != exec_bfd)
140 /* FIXME-leak: We should be freeing vp->name too, I think. */
141 gdb_bfd_close_or_warn (vp->bfd);
149 struct program_space *ss;
150 struct cleanup *old_chain;
152 old_chain = save_current_program_space ();
155 set_current_program_space (ss);
157 /* Delete all target sections. */
159 (current_target_sections,
160 -resize_section_table (current_target_sections, 0));
165 do_cleanups (old_chain);
170 exec_file_clear (int from_tty)
172 /* Remove exec file. */
176 printf_unfiltered (_("No executable file now.\n"));
179 /* Set FILENAME as the new exec file.
181 This function is intended to be behave essentially the same
182 as exec_file_command, except that the latter will detect when
183 a target is being debugged, and will ask the user whether it
184 should be shut down first. (If the answer is "no", then the
185 new file is ignored.)
187 This file is used by exec_file_command, to do the work of opening
188 and processing the exec file after any prompting has happened.
190 And, it is used by child_attach, when the attach command was
191 given a pid but not a exec pathname, and the attach command could
192 figure out the pathname from the pid. (In this case, we shouldn't
193 ask the user whether the current target should be shut down --
194 we're supplying the exec pathname late for good reason.) */
197 exec_file_attach (char *filename, int from_tty)
199 /* Remove any previous exec file. */
202 /* Now open and digest the file the user requested, if any. */
207 printf_unfiltered (_("No executable file now.\n"));
209 set_gdbarch_from_file (NULL);
213 struct cleanup *cleanups;
214 char *scratch_pathname;
216 struct target_section *sections = NULL, *sections_end = NULL;
219 scratch_chan = openp (getenv ("PATH"), OPF_TRY_CWD_FIRST, filename,
220 write_files ? O_RDWR | O_BINARY : O_RDONLY | O_BINARY,
222 #if defined(__GO32__) || defined(_WIN32) || defined(__CYGWIN__)
223 if (scratch_chan < 0)
225 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__,
442 _("failed internal consistency check"));
443 /* We could realloc the table, but it probably loses for most files. */
447 /* Add the sections array defined by [SECTIONS..SECTIONS_END[ to the
448 current set of target sections. */
451 add_target_sections (struct target_section *sections,
452 struct target_section *sections_end)
455 struct target_section_table *table = current_target_sections;
457 count = sections_end - sections;
461 int space = resize_section_table (table, count);
463 memcpy (table->sections + space,
464 sections, count * sizeof (sections[0]));
466 /* If these are the first file sections we can provide memory
467 from, push the file_stratum target. */
471 push_target (&exec_ops);
476 /* Remove all target sections taken from ABFD. */
479 remove_target_sections (bfd *abfd)
481 struct target_section *src, *dest;
482 struct target_section_table *table = current_target_sections;
484 dest = table->sections;
485 for (src = table->sections; src < table->sections_end; src++)
486 if (src->bfd != abfd)
488 /* Keep this section. */
494 /* If we've dropped any sections, resize the section table. */
499 old_count = resize_section_table (table, dest - src);
501 /* If we don't have any more sections to read memory from,
502 remove the file_stratum target from the stack. */
503 if (old_count + (dest - src) == 0)
505 struct program_space *pspace;
508 if (pspace->target_sections.sections
509 != pspace->target_sections.sections_end)
512 unpush_target (&exec_ops);
519 bfdsec_to_vmap (struct bfd *abfd, struct bfd_section *sect, void *arg3)
521 struct vmap_and_bfd *vmap_bfd = (struct vmap_and_bfd *) arg3;
524 vp = vmap_bfd->pvmap;
526 if ((bfd_get_section_flags (abfd, sect) & SEC_LOAD) == 0)
529 if (strcmp (bfd_section_name (abfd, sect), ".text") == 0)
531 vp->tstart = bfd_section_vma (abfd, sect);
532 vp->tend = vp->tstart + bfd_section_size (abfd, sect);
533 vp->tvma = bfd_section_vma (abfd, sect);
534 vp->toffs = sect->filepos;
536 else if (strcmp (bfd_section_name (abfd, sect), ".data") == 0)
538 vp->dstart = bfd_section_vma (abfd, sect);
539 vp->dend = vp->dstart + bfd_section_size (abfd, sect);
540 vp->dvma = bfd_section_vma (abfd, sect);
542 /* Silently ignore other types of sections. (FIXME?) */
545 /* Make a vmap for ABFD which might be a member of the archive ARCH.
546 Return the new vmap. */
549 map_vmap (bfd *abfd, bfd *arch)
551 struct vmap_and_bfd vmap_bfd;
552 struct vmap *vp, **vpp;
554 vp = (struct vmap *) xmalloc (sizeof (*vp));
555 memset ((char *) vp, '\0', sizeof (*vp));
558 vp->name = bfd_get_filename (arch ? arch : abfd);
559 vp->member = arch ? bfd_get_filename (abfd) : "";
561 vmap_bfd.pbfd = arch;
563 bfd_map_over_sections (abfd, bfdsec_to_vmap, &vmap_bfd);
565 /* Find the end of the list and append. */
566 for (vpp = &vmap; *vpp; vpp = &(*vpp)->nxt)
575 section_table_available_memory (VEC(mem_range_s) *memory,
576 CORE_ADDR memaddr, ULONGEST len,
577 struct target_section *sections,
578 struct target_section *sections_end)
580 struct target_section *p;
582 for (p = sections; p < sections_end; p++)
584 if ((bfd_get_section_flags (p->bfd, p->the_bfd_section)
585 & SEC_READONLY) == 0)
588 /* Copy the meta-data, adjusted. */
589 if (mem_ranges_overlap (p->addr, p->endaddr - p->addr, memaddr, len))
591 ULONGEST lo1, hi1, lo2, hi2;
600 r = VEC_safe_push (mem_range_s, memory, NULL);
602 r->start = max (lo1, lo2);
603 r->length = min (hi1, hi2) - r->start;
611 section_table_xfer_memory_partial (gdb_byte *readbuf, const gdb_byte *writebuf,
612 ULONGEST offset, LONGEST len,
613 struct target_section *sections,
614 struct target_section *sections_end,
615 const char *section_name)
618 struct target_section *p;
619 ULONGEST memaddr = offset;
620 ULONGEST memend = memaddr + len;
623 internal_error (__FILE__, __LINE__,
624 _("failed internal consistency check"));
626 for (p = sections; p < sections_end; p++)
628 if (section_name && strcmp (section_name, p->the_bfd_section->name) != 0)
629 continue; /* not the section we need. */
630 if (memaddr >= p->addr)
632 if (memend <= p->endaddr)
634 /* Entire transfer is within this section. */
636 res = bfd_set_section_contents (p->bfd, p->the_bfd_section,
637 writebuf, memaddr - p->addr,
640 res = bfd_get_section_contents (p->bfd, p->the_bfd_section,
641 readbuf, memaddr - p->addr,
643 return (res != 0) ? len : 0;
645 else if (memaddr >= p->endaddr)
647 /* This section ends before the transfer starts. */
652 /* This section overlaps the transfer. Just do half. */
653 len = p->endaddr - memaddr;
655 res = bfd_set_section_contents (p->bfd, p->the_bfd_section,
656 writebuf, memaddr - p->addr,
659 res = bfd_get_section_contents (p->bfd, p->the_bfd_section,
660 readbuf, memaddr - p->addr,
662 return (res != 0) ? len : 0;
667 return 0; /* We can't help. */
670 static struct target_section_table *
671 exec_get_section_table (struct target_ops *ops)
673 return current_target_sections;
677 exec_xfer_partial (struct target_ops *ops, enum target_object object,
678 const char *annex, gdb_byte *readbuf,
679 const gdb_byte *writebuf,
680 ULONGEST offset, LONGEST len)
682 struct target_section_table *table = target_get_section_table (ops);
684 if (object == TARGET_OBJECT_MEMORY)
685 return section_table_xfer_memory_partial (readbuf, writebuf,
696 print_section_info (struct target_section_table *t, bfd *abfd)
698 struct gdbarch *gdbarch = gdbarch_from_bfd (abfd);
699 struct target_section *p;
700 /* FIXME: 16 is not wide enough when gdbarch_addr_bit > 64. */
701 int wid = gdbarch_addr_bit (gdbarch) <= 32 ? 8 : 16;
703 printf_filtered ("\t`%s', ", bfd_get_filename (abfd));
705 printf_filtered (_("file type %s.\n"), bfd_get_target (abfd));
706 if (abfd == exec_bfd)
708 /* gcc-3.4 does not like the initialization in
709 <p == t->sections_end>. */
710 bfd_vma displacement = 0;
713 for (p = t->sections; p < t->sections_end; p++)
715 asection *asect = p->the_bfd_section;
717 if ((bfd_get_section_flags (abfd, asect) & (SEC_ALLOC | SEC_LOAD))
718 != (SEC_ALLOC | SEC_LOAD))
721 if (bfd_get_section_vma (abfd, asect) <= abfd->start_address
722 && abfd->start_address < (bfd_get_section_vma (abfd, asect)
723 + bfd_get_section_size (asect)))
725 displacement = p->addr - bfd_get_section_vma (abfd, asect);
729 if (p == t->sections_end)
730 warning (_("Cannot find section for the entry point of %s."),
731 bfd_get_filename (abfd));
733 entry_point = gdbarch_addr_bits_remove (gdbarch,
734 bfd_get_start_address (abfd)
736 printf_filtered (_("\tEntry point: %s\n"),
737 paddress (gdbarch, entry_point));
739 for (p = t->sections; p < t->sections_end; p++)
741 printf_filtered ("\t%s", hex_string_custom (p->addr, wid));
742 printf_filtered (" - %s", hex_string_custom (p->endaddr, wid));
744 /* FIXME: A format of "08l" is not wide enough for file offsets
745 larger than 4GB. OTOH, making it "016l" isn't desirable either
746 since most output will then be much wider than necessary. It
747 may make sense to test the size of the file and choose the
748 format string accordingly. */
749 /* FIXME: i18n: Need to rewrite this sentence. */
751 printf_filtered (" @ %s",
752 hex_string_custom (p->the_bfd_section->filepos, 8));
753 printf_filtered (" is %s", bfd_section_name (p->bfd,
754 p->the_bfd_section));
756 printf_filtered (" in %s", bfd_get_filename (p->bfd));
757 printf_filtered ("\n");
762 exec_files_info (struct target_ops *t)
765 print_section_info (current_target_sections, exec_bfd);
767 puts_filtered (_("\t<no file loaded>\n"));
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 (p->bfd,
820 p->the_bfd_section), seclen)
821 && bfd_section_name (p->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"));