1 /* Work with executable files, for GDB.
3 Copyright 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
4 1997, 1998, 1999, 2000, 2001, 2002, 2003 Free Software Foundation,
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 2 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, write to the Free Software
21 Foundation, Inc., 59 Temple Place - Suite 330,
22 Boston, MA 02111-1307, USA. */
32 #include "completer.h"
38 #include "readline/readline.h"
39 #include "gdb_string.h"
49 #include "xcoffsolib.h"
51 struct vmap *map_vmap (bfd *, bfd *);
53 void (*deprecated_file_changed_hook) (char *);
55 /* Prototypes for local functions */
57 static void exec_close (int);
59 static void file_command (char *, int);
61 static void set_section_command (char *, int);
63 static void exec_files_info (struct target_ops *);
65 static int ignore (CORE_ADDR, bfd_byte *);
67 static void init_exec_ops (void);
69 void _initialize_exec (void);
71 /* The target vector for executable files. */
73 struct target_ops exec_ops;
75 /* The Binary File Descriptor handle for the executable file. */
79 /* Whether to open exec and core files read-only or read-write. */
83 show_write_files (struct ui_file *file, int from_tty,
84 struct cmd_list_element *c, const char *value)
86 fprintf_filtered (file, _("Writing into executable and core files is %s.\n"),
94 exec_open (char *args, int from_tty)
96 target_preopen (from_tty);
97 exec_file_attach (args, from_tty);
101 exec_close (int quitting)
103 int need_symtab_cleanup = 0;
104 struct vmap *vp, *nxt;
106 for (nxt = vmap; nxt != NULL;)
111 /* if there is an objfile associated with this bfd,
112 free_objfile() will do proper cleanup of objfile *and* bfd. */
116 free_objfile (vp->objfile);
117 need_symtab_cleanup = 1;
119 else if (vp->bfd != exec_bfd)
120 /* FIXME-leak: We should be freeing vp->name too, I think. */
121 if (!bfd_close (vp->bfd))
122 warning (_("cannot close \"%s\": %s"),
123 vp->name, bfd_errmsg (bfd_get_error ()));
125 /* FIXME: This routine is #if 0'd in symfile.c. What should we
126 be doing here? Should we just free everything in
127 vp->objfile->symtabs? Should free_objfile do that?
128 FIXME-as-well: free_objfile already free'd vp->name, so it isn't
130 free_named_symtabs (vp->name);
138 char *name = bfd_get_filename (exec_bfd);
140 if (!bfd_close (exec_bfd))
141 warning (_("cannot close \"%s\": %s"),
142 name, bfd_errmsg (bfd_get_error ()));
147 if (exec_ops.to_sections)
149 xfree (exec_ops.to_sections);
150 exec_ops.to_sections = NULL;
151 exec_ops.to_sections_end = NULL;
156 exec_file_clear (int from_tty)
158 /* Remove exec file. */
159 unpush_target (&exec_ops);
162 printf_unfiltered (_("No executable file now.\n"));
165 /* Process the first arg in ARGS as the new exec file.
167 This function is intended to be behave essentially the same
168 as exec_file_command, except that the latter will detect when
169 a target is being debugged, and will ask the user whether it
170 should be shut down first. (If the answer is "no", then the
171 new file is ignored.)
173 This file is used by exec_file_command, to do the work of opening
174 and processing the exec file after any prompting has happened.
176 And, it is used by child_attach, when the attach command was
177 given a pid but not a exec pathname, and the attach command could
178 figure out the pathname from the pid. (In this case, we shouldn't
179 ask the user whether the current target should be shut down --
180 we're supplying the exec pathname late for good reason.)
182 ARGS is assumed to be the filename. */
185 exec_file_attach (char *filename, int from_tty)
187 /* Remove any previous exec file. */
188 unpush_target (&exec_ops);
190 /* Now open and digest the file the user requested, if any. */
195 printf_unfiltered (_("No executable file now.\n"));
199 char *scratch_pathname;
202 scratch_chan = openp (getenv ("PATH"), OPF_TRY_CWD_FIRST, filename,
203 write_files ? O_RDWR | O_BINARY : O_RDONLY | O_BINARY, 0,
205 #if defined(__GO32__) || defined(_WIN32) || defined(__CYGWIN__)
206 if (scratch_chan < 0)
208 char *exename = alloca (strlen (filename) + 5);
209 strcat (strcpy (exename, filename), ".exe");
210 scratch_chan = openp (getenv ("PATH"), OPF_TRY_CWD_FIRST, exename,
211 write_files ? O_RDWR | O_BINARY : O_RDONLY | O_BINARY, 0,
215 if (scratch_chan < 0)
216 perror_with_name (filename);
217 exec_bfd = bfd_fopen (scratch_pathname, gnutarget,
218 write_files ? FOPEN_RUB : FOPEN_RB,
222 error (_("\"%s\": could not open as an executable file: %s"),
223 scratch_pathname, bfd_errmsg (bfd_get_error ()));
225 /* At this point, scratch_pathname and exec_bfd->name both point to the
226 same malloc'd string. However exec_close() will attempt to free it
227 via the exec_bfd->name pointer, so we need to make another copy and
228 leave exec_bfd as the new owner of the original copy. */
229 scratch_pathname = xstrdup (scratch_pathname);
230 make_cleanup (xfree, scratch_pathname);
232 if (!bfd_check_format (exec_bfd, bfd_object))
234 /* Make sure to close exec_bfd, or else "run" might try to use
237 error (_("\"%s\": not in executable format: %s"),
238 scratch_pathname, bfd_errmsg (bfd_get_error ()));
241 /* FIXME - This should only be run for RS6000, but the ifdef is a poor
242 way to accomplish. */
243 #ifdef DEPRECATED_IBM6000_TARGET
244 /* Setup initial vmap. */
246 map_vmap (exec_bfd, 0);
249 /* Make sure to close exec_bfd, or else "run" might try to use
252 error (_("\"%s\": can't find the file sections: %s"),
253 scratch_pathname, bfd_errmsg (bfd_get_error ()));
255 #endif /* DEPRECATED_IBM6000_TARGET */
257 if (build_section_table (exec_bfd, &exec_ops.to_sections,
258 &exec_ops.to_sections_end))
260 /* Make sure to close exec_bfd, or else "run" might try to use
263 error (_("\"%s\": can't find the file sections: %s"),
264 scratch_pathname, bfd_errmsg (bfd_get_error ()));
267 #ifdef DEPRECATED_HPUX_TEXT_END
268 DEPRECATED_HPUX_TEXT_END (&exec_ops);
273 set_gdbarch_from_file (exec_bfd);
275 push_target (&exec_ops);
277 /* Tell display code (if any) about the changed file name. */
278 if (deprecated_exec_file_display_hook)
279 (*deprecated_exec_file_display_hook) (filename);
281 bfd_cache_close_all ();
282 observer_notify_executable_changed (NULL);
285 /* Process the first arg in ARGS as the new exec file.
287 Note that we have to explicitly ignore additional args, since we can
288 be called from file_command(), which also calls symbol_file_command()
289 which can take multiple args.
291 If ARGS is NULL, we just want to close the exec file. */
294 exec_file_command (char *args, int from_tty)
299 target_preopen (from_tty);
303 /* Scan through the args and pick up the first non option arg
306 argv = buildargv (args);
310 make_cleanup_freeargv (argv);
312 for (; (*argv != NULL) && (**argv == '-'); argv++)
316 error (_("No executable file name was specified"));
318 filename = tilde_expand (*argv);
319 make_cleanup (xfree, filename);
320 exec_file_attach (filename, from_tty);
323 exec_file_attach (NULL, from_tty);
326 /* Set both the exec file and the symbol file, in one command.
327 What a novelty. Why did GDB go through four major releases before this
328 command was added? */
331 file_command (char *arg, int from_tty)
333 /* FIXME, if we lose on reading the symbol file, we should revert
334 the exec file, but that's rough. */
335 exec_file_command (arg, from_tty);
336 symbol_file_command (arg, from_tty);
337 if (deprecated_file_changed_hook)
338 deprecated_file_changed_hook (arg);
342 /* Locate all mappable sections of a BFD file.
343 table_pp_char is a char * to get it through bfd_map_over_sections;
344 we cast it back to its proper type. */
347 add_to_section_table (bfd *abfd, struct bfd_section *asect,
350 struct section_table **table_pp = (struct section_table **) table_pp_char;
353 aflag = bfd_get_section_flags (abfd, asect);
354 if (!(aflag & SEC_ALLOC))
356 if (0 == bfd_section_size (abfd, asect))
358 (*table_pp)->bfd = abfd;
359 (*table_pp)->the_bfd_section = asect;
360 (*table_pp)->addr = bfd_section_vma (abfd, asect);
361 (*table_pp)->endaddr = (*table_pp)->addr + bfd_section_size (abfd, asect);
365 /* Builds a section table, given args BFD, SECTABLE_PTR, SECEND_PTR.
366 Returns 0 if OK, 1 on error. */
369 build_section_table (struct bfd *some_bfd, struct section_table **start,
370 struct section_table **end)
374 count = bfd_count_sections (some_bfd);
377 *start = (struct section_table *) xmalloc (count * sizeof (**start));
379 bfd_map_over_sections (some_bfd, add_to_section_table, (char *) end);
380 if (*end > *start + count)
381 internal_error (__FILE__, __LINE__, _("failed internal consistency check"));
382 /* We could realloc the table, but it probably loses for most files. */
387 bfdsec_to_vmap (struct bfd *abfd, struct bfd_section *sect, void *arg3)
389 struct vmap_and_bfd *vmap_bfd = (struct vmap_and_bfd *) arg3;
392 vp = vmap_bfd->pvmap;
394 if ((bfd_get_section_flags (abfd, sect) & SEC_LOAD) == 0)
397 if (strcmp (bfd_section_name (abfd, sect), ".text") == 0)
399 vp->tstart = bfd_section_vma (abfd, sect);
400 vp->tend = vp->tstart + bfd_section_size (abfd, sect);
401 vp->tvma = bfd_section_vma (abfd, sect);
402 vp->toffs = sect->filepos;
404 else if (strcmp (bfd_section_name (abfd, sect), ".data") == 0)
406 vp->dstart = bfd_section_vma (abfd, sect);
407 vp->dend = vp->dstart + bfd_section_size (abfd, sect);
408 vp->dvma = bfd_section_vma (abfd, sect);
410 /* Silently ignore other types of sections. (FIXME?) */
413 /* Make a vmap for ABFD which might be a member of the archive ARCH.
414 Return the new vmap. */
417 map_vmap (bfd *abfd, bfd *arch)
419 struct vmap_and_bfd vmap_bfd;
420 struct vmap *vp, **vpp;
422 vp = (struct vmap *) xmalloc (sizeof (*vp));
423 memset ((char *) vp, '\0', sizeof (*vp));
426 vp->name = bfd_get_filename (arch ? arch : abfd);
427 vp->member = arch ? bfd_get_filename (abfd) : "";
429 vmap_bfd.pbfd = arch;
431 bfd_map_over_sections (abfd, bfdsec_to_vmap, &vmap_bfd);
433 /* Find the end of the list and append. */
434 for (vpp = &vmap; *vpp; vpp = &(*vpp)->nxt)
441 /* Read or write the exec file.
443 Args are address within a BFD file, address within gdb address-space,
444 length, and a flag indicating whether to read or write.
448 0: We cannot handle this address and length.
449 > 0: We have handled N bytes starting at this address.
450 (If N == length, we did it all.) We might be able
451 to handle more bytes beyond this length, but no
453 < 0: We cannot handle this address, but if somebody
454 else handles (-N) bytes, we can start from there.
456 The same routine is used to handle both core and exec files;
457 we just tail-call it with more arguments to select between them. */
460 xfer_memory (CORE_ADDR memaddr, gdb_byte *myaddr, int len, int write,
461 struct mem_attrib *attrib, struct target_ops *target)
464 struct section_table *p;
465 CORE_ADDR nextsectaddr, memend;
466 asection *section = NULL;
469 internal_error (__FILE__, __LINE__, _("failed internal consistency check"));
471 if (overlay_debugging)
473 section = find_pc_overlay (memaddr);
474 if (pc_in_unmapped_range (memaddr, section))
475 memaddr = overlay_mapped_address (memaddr, section);
478 memend = memaddr + len;
479 nextsectaddr = memend;
481 for (p = target->to_sections; p < target->to_sections_end; p++)
483 if (overlay_debugging && section && p->the_bfd_section &&
484 strcmp (section->name, p->the_bfd_section->name) != 0)
485 continue; /* not the section we need */
486 if (memaddr >= p->addr)
488 if (memend <= p->endaddr)
490 /* Entire transfer is within this section. */
492 res = bfd_set_section_contents (p->bfd, p->the_bfd_section,
493 myaddr, memaddr - p->addr,
496 res = bfd_get_section_contents (p->bfd, p->the_bfd_section,
497 myaddr, memaddr - p->addr,
499 return (res != 0) ? len : 0;
501 else if (memaddr >= p->endaddr)
503 /* This section ends before the transfer starts. */
508 /* This section overlaps the transfer. Just do half. */
509 len = p->endaddr - memaddr;
511 res = bfd_set_section_contents (p->bfd, p->the_bfd_section,
512 myaddr, memaddr - p->addr,
515 res = bfd_get_section_contents (p->bfd, p->the_bfd_section,
516 myaddr, memaddr - p->addr,
518 return (res != 0) ? len : 0;
522 nextsectaddr = min (nextsectaddr, p->addr);
525 if (nextsectaddr >= memend)
526 return 0; /* We can't help */
528 return -(nextsectaddr - memaddr); /* Next boundary where we can help */
533 print_section_info (struct target_ops *t, bfd *abfd)
535 struct section_table *p;
536 /* FIXME: 16 is not wide enough when TARGET_ADDR_BIT > 64. */
537 int wid = TARGET_ADDR_BIT <= 32 ? 8 : 16;
539 printf_filtered ("\t`%s', ", bfd_get_filename (abfd));
541 printf_filtered (_("file type %s.\n"), bfd_get_target (abfd));
542 if (abfd == exec_bfd)
544 printf_filtered (_("\tEntry point: "));
545 deprecated_print_address_numeric (bfd_get_start_address (abfd), 1, gdb_stdout);
546 printf_filtered ("\n");
548 for (p = t->to_sections; p < t->to_sections_end; p++)
550 printf_filtered ("\t%s", hex_string_custom (p->addr, wid));
551 printf_filtered (" - %s", hex_string_custom (p->endaddr, wid));
553 /* FIXME: A format of "08l" is not wide enough for file offsets
554 larger than 4GB. OTOH, making it "016l" isn't desirable either
555 since most output will then be much wider than necessary. It
556 may make sense to test the size of the file and choose the
557 format string accordingly. */
558 /* FIXME: i18n: Need to rewrite this sentence. */
560 printf_filtered (" @ %s",
561 hex_string_custom (p->the_bfd_section->filepos, 8));
562 printf_filtered (" is %s", bfd_section_name (p->bfd, p->the_bfd_section));
564 printf_filtered (" in %s", bfd_get_filename (p->bfd));
565 printf_filtered ("\n");
570 exec_files_info (struct target_ops *t)
572 print_section_info (t, exec_bfd);
578 printf_unfiltered (_("\tMapping info for file `%s'.\n"), vmap->name);
579 printf_unfiltered ("\t %*s %*s %*s %*s %8.8s %s\n",
580 strlen_paddr (), "tstart",
581 strlen_paddr (), "tend",
582 strlen_paddr (), "dstart",
583 strlen_paddr (), "dend",
587 for (vp = vmap; vp; vp = vp->nxt)
588 printf_unfiltered ("\t0x%s 0x%s 0x%s 0x%s %s%s%s%s\n",
594 *vp->member ? "(" : "", vp->member,
595 *vp->member ? ")" : "");
600 exec_set_section_offsets sets the offsets of all the sections
601 in the exec objfile. */
604 exec_set_section_offsets (bfd_signed_vma text_off, bfd_signed_vma data_off,
605 bfd_signed_vma bss_off)
607 struct section_table *sect;
609 for (sect = exec_ops.to_sections;
610 sect < exec_ops.to_sections_end;
615 flags = bfd_get_section_flags (exec_bfd, sect->the_bfd_section);
617 if (flags & SEC_CODE)
619 sect->addr += text_off;
620 sect->endaddr += text_off;
622 else if (flags & (SEC_DATA | SEC_LOAD))
624 sect->addr += data_off;
625 sect->endaddr += data_off;
627 else if (flags & SEC_ALLOC)
629 sect->addr += bss_off;
630 sect->endaddr += bss_off;
636 set_section_command (char *args, int from_tty)
638 struct section_table *p;
641 unsigned long secaddr;
646 error (_("Must specify section name and its virtual address"));
648 /* Parse out section name */
649 for (secname = args; !isspace (*args); args++);
650 seclen = args - secname;
652 /* Parse out new virtual address */
653 secaddr = parse_and_eval_address (args);
655 for (p = exec_ops.to_sections; p < exec_ops.to_sections_end; p++)
657 if (!strncmp (secname, bfd_section_name (exec_bfd, p->the_bfd_section), seclen)
658 && bfd_section_name (exec_bfd, p->the_bfd_section)[seclen] == '\0')
660 offset = secaddr - p->addr;
662 p->endaddr += offset;
664 exec_files_info (&exec_ops);
668 if (seclen >= sizeof (secprint))
669 seclen = sizeof (secprint) - 1;
670 strncpy (secprint, secname, seclen);
671 secprint[seclen] = '\0';
672 error (_("Section %s not found"), secprint);
675 /* If we can find a section in FILENAME with BFD index INDEX, and the
676 user has not assigned an address to it yet (via "set section"), adjust it
680 exec_set_section_address (const char *filename, int index, CORE_ADDR address)
682 struct section_table *p;
684 for (p = exec_ops.to_sections; p < exec_ops.to_sections_end; p++)
686 if (strcmp (filename, p->bfd->filename) == 0
687 && index == p->the_bfd_section->index
691 p->endaddr += address;
696 /* If mourn is being called in all the right places, this could be say
697 `gdb internal error' (since generic_mourn calls
698 breakpoint_init_inferior). */
701 ignore (CORE_ADDR addr, bfd_byte *contents)
706 /* Find mapped memory. */
709 exec_set_find_memory_regions (int (*func) (int (*) (CORE_ADDR,
715 exec_ops.to_find_memory_regions = func;
718 static char *exec_make_note_section (bfd *, int *);
720 /* Fill in the exec file target vector. Very few entries need to be
726 exec_ops.to_shortname = "exec";
727 exec_ops.to_longname = "Local exec file";
728 exec_ops.to_doc = "Use an executable file as a target.\n\
729 Specify the filename of the executable file.";
730 exec_ops.to_open = exec_open;
731 exec_ops.to_close = exec_close;
732 exec_ops.to_attach = find_default_attach;
733 exec_ops.deprecated_xfer_memory = xfer_memory;
734 exec_ops.to_files_info = exec_files_info;
735 exec_ops.to_insert_breakpoint = ignore;
736 exec_ops.to_remove_breakpoint = ignore;
737 exec_ops.to_create_inferior = find_default_create_inferior;
738 exec_ops.to_stratum = file_stratum;
739 exec_ops.to_has_memory = 1;
740 exec_ops.to_make_corefile_notes = exec_make_note_section;
741 exec_ops.to_magic = OPS_MAGIC;
745 _initialize_exec (void)
747 struct cmd_list_element *c;
753 c = add_cmd ("file", class_files, file_command, _("\
754 Use FILE as program to be debugged.\n\
755 It is read for its symbols, for getting the contents of pure memory,\n\
756 and it is the program executed when you use the `run' command.\n\
757 If FILE cannot be found as specified, your execution directory path\n\
758 ($PATH) is searched for a command of that name.\n\
759 No arg means to have no executable file and no symbols."), &cmdlist);
760 set_cmd_completer (c, filename_completer);
763 c = add_cmd ("exec-file", class_files, exec_file_command, _("\
764 Use FILE as program for getting contents of pure memory.\n\
765 If FILE cannot be found as specified, your execution directory path\n\
766 is searched for a command of that name.\n\
767 No arg means have no executable file."), &cmdlist);
768 set_cmd_completer (c, filename_completer);
770 add_com ("section", class_files, set_section_command, _("\
771 Change the base address of section SECTION of the exec file to ADDR.\n\
772 This can be used if the exec file does not contain section addresses,\n\
773 (such as in the a.out format), or when the addresses specified in the\n\
774 file itself are wrong. Each section must be changed separately. The\n\
775 ``info files'' command lists all the sections and their addresses."));
777 add_setshow_boolean_cmd ("write", class_support, &write_files, _("\
778 Set writing into executable and core files."), _("\
779 Show writing into executable and core files."), NULL,
782 &setlist, &showlist);
784 add_target (&exec_ops);
788 exec_make_note_section (bfd *obfd, int *note_size)
790 error (_("Can't create a corefile"));