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__, _("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_xfer_memory_partial (gdb_byte *readbuf, const gdb_byte *writebuf,
576 ULONGEST offset, LONGEST len,
577 struct target_section *sections,
578 struct target_section *sections_end,
579 const char *section_name)
582 struct target_section *p;
583 ULONGEST memaddr = offset;
584 ULONGEST memend = memaddr + len;
587 internal_error (__FILE__, __LINE__, _("failed internal consistency check"));
589 for (p = sections; p < sections_end; p++)
591 if (section_name && strcmp (section_name, p->the_bfd_section->name) != 0)
592 continue; /* not the section we need */
593 if (memaddr >= p->addr)
595 if (memend <= p->endaddr)
597 /* Entire transfer is within this section. */
599 res = bfd_set_section_contents (p->bfd, p->the_bfd_section,
600 writebuf, memaddr - p->addr,
603 res = bfd_get_section_contents (p->bfd, p->the_bfd_section,
604 readbuf, memaddr - p->addr,
606 return (res != 0) ? len : 0;
608 else if (memaddr >= p->endaddr)
610 /* This section ends before the transfer starts. */
615 /* This section overlaps the transfer. Just do half. */
616 len = p->endaddr - memaddr;
618 res = bfd_set_section_contents (p->bfd, p->the_bfd_section,
619 writebuf, memaddr - p->addr,
622 res = bfd_get_section_contents (p->bfd, p->the_bfd_section,
623 readbuf, memaddr - p->addr,
625 return (res != 0) ? len : 0;
630 return 0; /* We can't help */
633 struct target_section_table *
634 exec_get_section_table (struct target_ops *ops)
636 return current_target_sections;
640 exec_xfer_partial (struct target_ops *ops, enum target_object object,
641 const char *annex, gdb_byte *readbuf,
642 const gdb_byte *writebuf,
643 ULONGEST offset, LONGEST len)
645 struct target_section_table *table = target_get_section_table (ops);
647 if (object == TARGET_OBJECT_MEMORY)
648 return section_table_xfer_memory_partial (readbuf, writebuf,
659 print_section_info (struct target_section_table *t, bfd *abfd)
661 struct gdbarch *gdbarch = gdbarch_from_bfd (abfd);
662 struct target_section *p;
663 /* FIXME: 16 is not wide enough when gdbarch_addr_bit > 64. */
664 int wid = gdbarch_addr_bit (gdbarch) <= 32 ? 8 : 16;
666 printf_filtered ("\t`%s', ", bfd_get_filename (abfd));
668 printf_filtered (_("file type %s.\n"), bfd_get_target (abfd));
669 if (abfd == exec_bfd)
671 /* gcc-3.4 does not like the initialization in <p == t->sections_end>. */
672 bfd_vma displacement = 0;
675 for (p = t->sections; p < t->sections_end; p++)
677 asection *asect = p->the_bfd_section;
679 if ((bfd_get_section_flags (abfd, asect) & (SEC_ALLOC | SEC_LOAD))
680 != (SEC_ALLOC | SEC_LOAD))
683 if (bfd_get_section_vma (abfd, asect) <= abfd->start_address
684 && abfd->start_address < (bfd_get_section_vma (abfd, asect)
685 + bfd_get_section_size (asect)))
687 displacement = p->addr - bfd_get_section_vma (abfd, asect);
691 if (p == t->sections_end)
692 warning (_("Cannot find section for the entry point of %s.\n"),
693 bfd_get_filename (abfd));
695 entry_point = gdbarch_addr_bits_remove (gdbarch,
696 bfd_get_start_address (abfd)
698 printf_filtered (_("\tEntry point: %s\n"),
699 paddress (gdbarch, entry_point));
701 for (p = t->sections; p < t->sections_end; p++)
703 printf_filtered ("\t%s", hex_string_custom (p->addr, wid));
704 printf_filtered (" - %s", hex_string_custom (p->endaddr, wid));
706 /* FIXME: A format of "08l" is not wide enough for file offsets
707 larger than 4GB. OTOH, making it "016l" isn't desirable either
708 since most output will then be much wider than necessary. It
709 may make sense to test the size of the file and choose the
710 format string accordingly. */
711 /* FIXME: i18n: Need to rewrite this sentence. */
713 printf_filtered (" @ %s",
714 hex_string_custom (p->the_bfd_section->filepos, 8));
715 printf_filtered (" is %s", bfd_section_name (p->bfd, p->the_bfd_section));
717 printf_filtered (" in %s", bfd_get_filename (p->bfd));
718 printf_filtered ("\n");
723 exec_files_info (struct target_ops *t)
725 print_section_info (current_target_sections, exec_bfd);
729 int addr_size = gdbarch_addr_bit (target_gdbarch) / 8;
732 printf_unfiltered (_("\tMapping info for file `%s'.\n"), vmap->name);
733 printf_unfiltered ("\t %*s %*s %*s %*s %8.8s %s\n",
734 addr_size * 2, "tstart",
735 addr_size * 2, "tend",
736 addr_size * 2, "dstart",
737 addr_size * 2, "dend",
741 for (vp = vmap; vp; vp = vp->nxt)
742 printf_unfiltered ("\t0x%s 0x%s 0x%s 0x%s %s%s%s%s\n",
743 phex (vp->tstart, addr_size),
744 phex (vp->tend, addr_size),
745 phex (vp->dstart, addr_size),
746 phex (vp->dend, addr_size),
748 *vp->member ? "(" : "", vp->member,
749 *vp->member ? ")" : "");
754 set_section_command (char *args, int from_tty)
756 struct target_section *p;
759 unsigned long secaddr;
762 struct target_section_table *table;
765 error (_("Must specify section name and its virtual address"));
767 /* Parse out section name */
768 for (secname = args; !isspace (*args); args++);
769 seclen = args - secname;
771 /* Parse out new virtual address */
772 secaddr = parse_and_eval_address (args);
774 table = current_target_sections;
775 for (p = table->sections; p < table->sections_end; p++)
777 if (!strncmp (secname, bfd_section_name (exec_bfd, p->the_bfd_section), seclen)
778 && bfd_section_name (exec_bfd, p->the_bfd_section)[seclen] == '\0')
780 offset = secaddr - p->addr;
782 p->endaddr += offset;
784 exec_files_info (&exec_ops);
788 if (seclen >= sizeof (secprint))
789 seclen = sizeof (secprint) - 1;
790 strncpy (secprint, secname, seclen);
791 secprint[seclen] = '\0';
792 error (_("Section %s not found"), secprint);
795 /* If we can find a section in FILENAME with BFD index INDEX, adjust
799 exec_set_section_address (const char *filename, int index, CORE_ADDR address)
801 struct target_section *p;
802 struct target_section_table *table;
804 table = current_target_sections;
805 for (p = table->sections; p < table->sections_end; p++)
807 if (strcmp (filename, p->bfd->filename) == 0
808 && index == p->the_bfd_section->index)
810 p->endaddr += address - p->addr;
816 /* If mourn is being called in all the right places, this could be say
817 `gdb internal error' (since generic_mourn calls
818 breakpoint_init_inferior). */
821 ignore (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt)
827 exec_has_memory (struct target_ops *ops)
829 /* We can provide memory if we have any file/target sections to read
831 return (current_target_sections->sections
832 != current_target_sections->sections_end);
835 /* Find mapped memory. */
838 exec_set_find_memory_regions (int (*func) (find_memory_region_ftype, void *))
840 exec_ops.to_find_memory_regions = func;
843 static char *exec_make_note_section (bfd *, int *);
845 /* Fill in the exec file target vector. Very few entries need to be
851 exec_ops.to_shortname = "exec";
852 exec_ops.to_longname = "Local exec file";
853 exec_ops.to_doc = "Use an executable file as a target.\n\
854 Specify the filename of the executable file.";
855 exec_ops.to_open = exec_open;
856 exec_ops.to_close = exec_close_1;
857 exec_ops.to_attach = find_default_attach;
858 exec_ops.to_xfer_partial = exec_xfer_partial;
859 exec_ops.to_get_section_table = exec_get_section_table;
860 exec_ops.to_files_info = exec_files_info;
861 exec_ops.to_insert_breakpoint = ignore;
862 exec_ops.to_remove_breakpoint = ignore;
863 exec_ops.to_create_inferior = find_default_create_inferior;
864 exec_ops.to_stratum = file_stratum;
865 exec_ops.to_has_memory = exec_has_memory;
866 exec_ops.to_make_corefile_notes = exec_make_note_section;
867 exec_ops.to_magic = OPS_MAGIC;
871 _initialize_exec (void)
873 struct cmd_list_element *c;
879 c = add_cmd ("file", class_files, file_command, _("\
880 Use FILE as program to be debugged.\n\
881 It is read for its symbols, for getting the contents of pure memory,\n\
882 and it is the program executed when you use the `run' command.\n\
883 If FILE cannot be found as specified, your execution directory path\n\
884 ($PATH) is searched for a command of that name.\n\
885 No arg means to have no executable file and no symbols."), &cmdlist);
886 set_cmd_completer (c, filename_completer);
889 c = add_cmd ("exec-file", class_files, exec_file_command, _("\
890 Use FILE as program for getting contents of pure memory.\n\
891 If FILE cannot be found as specified, your execution directory path\n\
892 is searched for a command of that name.\n\
893 No arg means have no executable file."), &cmdlist);
894 set_cmd_completer (c, filename_completer);
896 add_com ("section", class_files, set_section_command, _("\
897 Change the base address of section SECTION of the exec file to ADDR.\n\
898 This can be used if the exec file does not contain section addresses,\n\
899 (such as in the a.out format), or when the addresses specified in the\n\
900 file itself are wrong. Each section must be changed separately. The\n\
901 ``info files'' command lists all the sections and their addresses."));
903 add_setshow_boolean_cmd ("write", class_support, &write_files, _("\
904 Set writing into executable and core files."), _("\
905 Show writing into executable and core files."), NULL,
908 &setlist, &showlist);
910 add_target (&exec_ops);
914 exec_make_note_section (bfd *obfd, int *note_size)
916 error (_("Can't create a corefile"));