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"
37 #include "readline/readline.h"
38 #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 exec_close (int);
58 static void file_command (char *, int);
60 static void set_section_command (char *, int);
62 static void exec_files_info (struct target_ops *);
64 static int ignore (CORE_ADDR, char *);
66 static void init_exec_ops (void);
68 void _initialize_exec (void);
70 /* The target vector for executable files. */
72 struct target_ops exec_ops;
74 /* The Binary File Descriptor handle for the executable file. */
78 /* Whether to open exec and core files read-only or read-write. */
85 exec_open (char *args, int from_tty)
87 target_preopen (from_tty);
88 exec_file_attach (args, from_tty);
92 exec_close (int quitting)
94 int need_symtab_cleanup = 0;
95 struct vmap *vp, *nxt;
97 for (nxt = vmap; nxt != NULL;)
102 /* if there is an objfile associated with this bfd,
103 free_objfile() will do proper cleanup of objfile *and* bfd. */
107 free_objfile (vp->objfile);
108 need_symtab_cleanup = 1;
110 else if (vp->bfd != exec_bfd)
111 /* FIXME-leak: We should be freeing vp->name too, I think. */
112 if (!bfd_close (vp->bfd))
113 warning (_("cannot close \"%s\": %s"),
114 vp->name, bfd_errmsg (bfd_get_error ()));
116 /* FIXME: This routine is #if 0'd in symfile.c. What should we
117 be doing here? Should we just free everything in
118 vp->objfile->symtabs? Should free_objfile do that?
119 FIXME-as-well: free_objfile already free'd vp->name, so it isn't
121 free_named_symtabs (vp->name);
129 char *name = bfd_get_filename (exec_bfd);
131 if (!bfd_close (exec_bfd))
132 warning (_("cannot close \"%s\": %s"),
133 name, bfd_errmsg (bfd_get_error ()));
138 if (exec_ops.to_sections)
140 xfree (exec_ops.to_sections);
141 exec_ops.to_sections = NULL;
142 exec_ops.to_sections_end = NULL;
147 exec_file_clear (int from_tty)
149 /* Remove exec file. */
150 unpush_target (&exec_ops);
153 printf_unfiltered (_("No executable file now.\n"));
156 /* Process the first arg in ARGS as the new exec file.
158 This function is intended to be behave essentially the same
159 as exec_file_command, except that the latter will detect when
160 a target is being debugged, and will ask the user whether it
161 should be shut down first. (If the answer is "no", then the
162 new file is ignored.)
164 This file is used by exec_file_command, to do the work of opening
165 and processing the exec file after any prompting has happened.
167 And, it is used by child_attach, when the attach command was
168 given a pid but not a exec pathname, and the attach command could
169 figure out the pathname from the pid. (In this case, we shouldn't
170 ask the user whether the current target should be shut down --
171 we're supplying the exec pathname late for good reason.)
173 ARGS is assumed to be the filename. */
176 exec_file_attach (char *filename, int from_tty)
178 /* Remove any previous exec file. */
179 unpush_target (&exec_ops);
181 /* Now open and digest the file the user requested, if any. */
186 printf_unfiltered (_("No executable file now.\n"));
190 char *scratch_pathname;
193 scratch_chan = openp (getenv ("PATH"), OPF_TRY_CWD_FIRST, filename,
194 write_files ? O_RDWR | O_BINARY : O_RDONLY | O_BINARY, 0,
196 #if defined(__GO32__) || defined(_WIN32) || defined(__CYGWIN__)
197 if (scratch_chan < 0)
199 char *exename = alloca (strlen (filename) + 5);
200 strcat (strcpy (exename, filename), ".exe");
201 scratch_chan = openp (getenv ("PATH"), OPF_TRY_CWD_FIRST, exename,
202 write_files ? O_RDWR | O_BINARY : O_RDONLY | O_BINARY, 0,
206 if (scratch_chan < 0)
207 perror_with_name (filename);
208 exec_bfd = bfd_fdopenr (scratch_pathname, gnutarget, scratch_chan);
211 error (_("\"%s\": could not open as an executable file: %s"),
212 scratch_pathname, bfd_errmsg (bfd_get_error ()));
214 /* At this point, scratch_pathname and exec_bfd->name both point to the
215 same malloc'd string. However exec_close() will attempt to free it
216 via the exec_bfd->name pointer, so we need to make another copy and
217 leave exec_bfd as the new owner of the original copy. */
218 scratch_pathname = xstrdup (scratch_pathname);
219 make_cleanup (xfree, scratch_pathname);
221 if (!bfd_check_format (exec_bfd, bfd_object))
223 /* Make sure to close exec_bfd, or else "run" might try to use
226 error (_("\"%s\": not in executable format: %s"),
227 scratch_pathname, bfd_errmsg (bfd_get_error ()));
230 /* FIXME - This should only be run for RS6000, but the ifdef is a poor
231 way to accomplish. */
232 #ifdef DEPRECATED_IBM6000_TARGET
233 /* Setup initial vmap. */
235 map_vmap (exec_bfd, 0);
238 /* Make sure to close exec_bfd, or else "run" might try to use
241 error (_("\"%s\": can't find the file sections: %s"),
242 scratch_pathname, bfd_errmsg (bfd_get_error ()));
244 #endif /* DEPRECATED_IBM6000_TARGET */
246 if (build_section_table (exec_bfd, &exec_ops.to_sections,
247 &exec_ops.to_sections_end))
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 ()));
256 #ifdef DEPRECATED_HPUX_TEXT_END
257 DEPRECATED_HPUX_TEXT_END (&exec_ops);
262 set_gdbarch_from_file (exec_bfd);
264 push_target (&exec_ops);
266 /* Tell display code (if any) about the changed file name. */
267 if (deprecated_exec_file_display_hook)
268 (*deprecated_exec_file_display_hook) (filename);
270 bfd_cache_close_all ();
273 /* Process the first arg in ARGS as the new exec file.
275 Note that we have to explicitly ignore additional args, since we can
276 be called from file_command(), which also calls symbol_file_command()
277 which can take multiple args.
279 If ARGS is NULL, we just want to close the exec file. */
282 exec_file_command (char *args, int from_tty)
287 target_preopen (from_tty);
291 /* Scan through the args and pick up the first non option arg
294 argv = buildargv (args);
298 make_cleanup_freeargv (argv);
300 for (; (*argv != NULL) && (**argv == '-'); argv++)
304 error (_("No executable file name was specified"));
306 filename = tilde_expand (*argv);
307 make_cleanup (xfree, filename);
308 exec_file_attach (filename, from_tty);
311 exec_file_attach (NULL, from_tty);
314 /* Set both the exec file and the symbol file, in one command.
315 What a novelty. Why did GDB go through four major releases before this
316 command was added? */
319 file_command (char *arg, int from_tty)
321 /* FIXME, if we lose on reading the symbol file, we should revert
322 the exec file, but that's rough. */
323 exec_file_command (arg, from_tty);
324 symbol_file_command (arg, from_tty);
325 if (deprecated_file_changed_hook)
326 deprecated_file_changed_hook (arg);
330 /* Locate all mappable sections of a BFD file.
331 table_pp_char is a char * to get it through bfd_map_over_sections;
332 we cast it back to its proper type. */
335 add_to_section_table (bfd *abfd, struct bfd_section *asect,
338 struct section_table **table_pp = (struct section_table **) table_pp_char;
341 aflag = bfd_get_section_flags (abfd, asect);
342 if (!(aflag & SEC_ALLOC))
344 if (0 == bfd_section_size (abfd, asect))
346 (*table_pp)->bfd = abfd;
347 (*table_pp)->the_bfd_section = asect;
348 (*table_pp)->addr = bfd_section_vma (abfd, asect);
349 (*table_pp)->endaddr = (*table_pp)->addr + bfd_section_size (abfd, asect);
353 /* Builds a section table, given args BFD, SECTABLE_PTR, SECEND_PTR.
354 Returns 0 if OK, 1 on error. */
357 build_section_table (struct bfd *some_bfd, struct section_table **start,
358 struct section_table **end)
362 count = bfd_count_sections (some_bfd);
365 *start = (struct section_table *) xmalloc (count * sizeof (**start));
367 bfd_map_over_sections (some_bfd, add_to_section_table, (char *) end);
368 if (*end > *start + count)
369 internal_error (__FILE__, __LINE__, _("failed internal consistency check"));
370 /* We could realloc the table, but it probably loses for most files. */
375 bfdsec_to_vmap (struct bfd *abfd, struct bfd_section *sect, void *arg3)
377 struct vmap_and_bfd *vmap_bfd = (struct vmap_and_bfd *) arg3;
380 vp = vmap_bfd->pvmap;
382 if ((bfd_get_section_flags (abfd, sect) & SEC_LOAD) == 0)
385 if (DEPRECATED_STREQ (bfd_section_name (abfd, sect), ".text"))
387 vp->tstart = bfd_section_vma (abfd, sect);
388 vp->tend = vp->tstart + bfd_section_size (abfd, sect);
389 vp->tvma = bfd_section_vma (abfd, sect);
390 vp->toffs = sect->filepos;
392 else if (DEPRECATED_STREQ (bfd_section_name (abfd, sect), ".data"))
394 vp->dstart = bfd_section_vma (abfd, sect);
395 vp->dend = vp->dstart + bfd_section_size (abfd, sect);
396 vp->dvma = bfd_section_vma (abfd, sect);
398 /* Silently ignore other types of sections. (FIXME?) */
401 /* Make a vmap for ABFD which might be a member of the archive ARCH.
402 Return the new vmap. */
405 map_vmap (bfd *abfd, bfd *arch)
407 struct vmap_and_bfd vmap_bfd;
408 struct vmap *vp, **vpp;
410 vp = (struct vmap *) xmalloc (sizeof (*vp));
411 memset ((char *) vp, '\0', sizeof (*vp));
414 vp->name = bfd_get_filename (arch ? arch : abfd);
415 vp->member = arch ? bfd_get_filename (abfd) : "";
417 vmap_bfd.pbfd = arch;
419 bfd_map_over_sections (abfd, bfdsec_to_vmap, &vmap_bfd);
421 /* Find the end of the list and append. */
422 for (vpp = &vmap; *vpp; vpp = &(*vpp)->nxt)
429 /* Read or write the exec file.
431 Args are address within a BFD file, address within gdb address-space,
432 length, and a flag indicating whether to read or write.
436 0: We cannot handle this address and length.
437 > 0: We have handled N bytes starting at this address.
438 (If N == length, we did it all.) We might be able
439 to handle more bytes beyond this length, but no
441 < 0: We cannot handle this address, but if somebody
442 else handles (-N) bytes, we can start from there.
444 The same routine is used to handle both core and exec files;
445 we just tail-call it with more arguments to select between them. */
448 xfer_memory (CORE_ADDR memaddr, char *myaddr, int len, int write,
449 struct mem_attrib *attrib,
450 struct target_ops *target)
453 struct section_table *p;
454 CORE_ADDR nextsectaddr, memend;
455 asection *section = NULL;
458 internal_error (__FILE__, __LINE__, _("failed internal consistency check"));
460 if (overlay_debugging)
462 section = find_pc_overlay (memaddr);
463 if (pc_in_unmapped_range (memaddr, section))
464 memaddr = overlay_mapped_address (memaddr, section);
467 memend = memaddr + len;
468 nextsectaddr = memend;
470 for (p = target->to_sections; p < target->to_sections_end; p++)
472 if (overlay_debugging && section && p->the_bfd_section &&
473 strcmp (section->name, p->the_bfd_section->name) != 0)
474 continue; /* not the section we need */
475 if (memaddr >= p->addr)
477 if (memend <= p->endaddr)
479 /* Entire transfer is within this section. */
481 res = bfd_set_section_contents (p->bfd, p->the_bfd_section,
482 myaddr, memaddr - p->addr,
485 res = bfd_get_section_contents (p->bfd, p->the_bfd_section,
486 myaddr, memaddr - p->addr,
488 return (res != 0) ? len : 0;
490 else if (memaddr >= p->endaddr)
492 /* This section ends before the transfer starts. */
497 /* This section overlaps the transfer. Just do half. */
498 len = p->endaddr - memaddr;
500 res = bfd_set_section_contents (p->bfd, p->the_bfd_section,
501 myaddr, memaddr - p->addr,
504 res = bfd_get_section_contents (p->bfd, p->the_bfd_section,
505 myaddr, memaddr - p->addr,
507 return (res != 0) ? len : 0;
511 nextsectaddr = min (nextsectaddr, p->addr);
514 if (nextsectaddr >= memend)
515 return 0; /* We can't help */
517 return -(nextsectaddr - memaddr); /* Next boundary where we can help */
522 print_section_info (struct target_ops *t, bfd *abfd)
524 struct section_table *p;
525 /* FIXME: 16 is not wide enough when TARGET_ADDR_BIT > 64. */
526 int wid = TARGET_ADDR_BIT <= 32 ? 8 : 16;
528 printf_filtered ("\t`%s', ", bfd_get_filename (abfd));
530 printf_filtered (_("file type %s.\n"), bfd_get_target (abfd));
531 if (abfd == exec_bfd)
533 printf_filtered (_("\tEntry point: "));
534 print_address_numeric (bfd_get_start_address (abfd), 1, gdb_stdout);
535 printf_filtered ("\n");
537 for (p = t->to_sections; p < t->to_sections_end; p++)
539 printf_filtered ("\t%s", hex_string_custom (p->addr, wid));
540 printf_filtered (" - %s", hex_string_custom (p->endaddr, wid));
542 /* FIXME: A format of "08l" is not wide enough for file offsets
543 larger than 4GB. OTOH, making it "016l" isn't desirable either
544 since most output will then be much wider than necessary. It
545 may make sense to test the size of the file and choose the
546 format string accordingly. */
547 /* FIXME: i18n: Need to rewrite this sentence. */
549 printf_filtered (" @ %s",
550 hex_string_custom (p->the_bfd_section->filepos, 8));
551 printf_filtered (" is %s", bfd_section_name (p->bfd, p->the_bfd_section));
553 printf_filtered (" in %s", bfd_get_filename (p->bfd));
554 printf_filtered ("\n");
559 exec_files_info (struct target_ops *t)
561 print_section_info (t, exec_bfd);
567 printf_unfiltered (_("\tMapping info for file `%s'.\n"), vmap->name);
568 printf_unfiltered ("\t %*s %*s %*s %*s %8.8s %s\n",
569 strlen_paddr (), "tstart",
570 strlen_paddr (), "tend",
571 strlen_paddr (), "dstart",
572 strlen_paddr (), "dend",
576 for (vp = vmap; vp; vp = vp->nxt)
577 printf_unfiltered ("\t0x%s 0x%s 0x%s 0x%s %s%s%s%s\n",
583 *vp->member ? "(" : "", vp->member,
584 *vp->member ? ")" : "");
589 exec_set_section_offsets sets the offsets of all the sections
590 in the exec objfile. */
593 exec_set_section_offsets (bfd_signed_vma text_off, bfd_signed_vma data_off,
594 bfd_signed_vma bss_off)
596 struct section_table *sect;
598 for (sect = exec_ops.to_sections;
599 sect < exec_ops.to_sections_end;
604 flags = bfd_get_section_flags (exec_bfd, sect->the_bfd_section);
606 if (flags & SEC_CODE)
608 sect->addr += text_off;
609 sect->endaddr += text_off;
611 else if (flags & (SEC_DATA | SEC_LOAD))
613 sect->addr += data_off;
614 sect->endaddr += data_off;
616 else if (flags & SEC_ALLOC)
618 sect->addr += bss_off;
619 sect->endaddr += bss_off;
625 set_section_command (char *args, int from_tty)
627 struct section_table *p;
630 unsigned long secaddr;
635 error (_("Must specify section name and its virtual address"));
637 /* Parse out section name */
638 for (secname = args; !isspace (*args); args++);
639 seclen = args - secname;
641 /* Parse out new virtual address */
642 secaddr = parse_and_eval_address (args);
644 for (p = exec_ops.to_sections; p < exec_ops.to_sections_end; p++)
646 if (!strncmp (secname, bfd_section_name (exec_bfd, p->the_bfd_section), seclen)
647 && bfd_section_name (exec_bfd, p->the_bfd_section)[seclen] == '\0')
649 offset = secaddr - p->addr;
651 p->endaddr += offset;
653 exec_files_info (&exec_ops);
657 if (seclen >= sizeof (secprint))
658 seclen = sizeof (secprint) - 1;
659 strncpy (secprint, secname, seclen);
660 secprint[seclen] = '\0';
661 error (_("Section %s not found"), secprint);
664 /* If mourn is being called in all the right places, this could be say
665 `gdb internal error' (since generic_mourn calls
666 breakpoint_init_inferior). */
669 ignore (CORE_ADDR addr, char *contents)
674 /* Find mapped memory. */
677 exec_set_find_memory_regions (int (*func) (int (*) (CORE_ADDR,
683 exec_ops.to_find_memory_regions = func;
686 static char *exec_make_note_section (bfd *, int *);
688 /* Fill in the exec file target vector. Very few entries need to be
694 exec_ops.to_shortname = "exec";
695 exec_ops.to_longname = "Local exec file";
696 exec_ops.to_doc = "Use an executable file as a target.\n\
697 Specify the filename of the executable file.";
698 exec_ops.to_open = exec_open;
699 exec_ops.to_close = exec_close;
700 exec_ops.to_attach = find_default_attach;
701 exec_ops.deprecated_xfer_memory = xfer_memory;
702 exec_ops.to_files_info = exec_files_info;
703 exec_ops.to_insert_breakpoint = ignore;
704 exec_ops.to_remove_breakpoint = ignore;
705 exec_ops.to_create_inferior = find_default_create_inferior;
706 exec_ops.to_stratum = file_stratum;
707 exec_ops.to_has_memory = 1;
708 exec_ops.to_make_corefile_notes = exec_make_note_section;
709 exec_ops.to_magic = OPS_MAGIC;
713 _initialize_exec (void)
715 struct cmd_list_element *c;
721 c = add_cmd ("file", class_files, file_command,
722 "Use FILE as program to be debugged.\n\
723 It is read for its symbols, for getting the contents of pure memory,\n\
724 and it is the program executed when you use the `run' command.\n\
725 If FILE cannot be found as specified, your execution directory path\n\
726 ($PATH) is searched for a command of that name.\n\
727 No arg means to have no executable file and no symbols.", &cmdlist);
728 set_cmd_completer (c, filename_completer);
731 c = add_cmd ("exec-file", class_files, exec_file_command,
732 "Use FILE as program for getting contents of pure memory.\n\
733 If FILE cannot be found as specified, your execution directory path\n\
734 is searched for a command of that name.\n\
735 No arg means have no executable file.", &cmdlist);
736 set_cmd_completer (c, filename_completer);
738 add_com ("section", class_files, set_section_command,
739 "Change the base address of section SECTION of the exec file to ADDR.\n\
740 This can be used if the exec file does not contain section addresses,\n\
741 (such as in the a.out format), or when the addresses specified in the\n\
742 file itself are wrong. Each section must be changed separately. The\n\
743 ``info files'' command lists all the sections and their addresses.");
745 deprecated_add_show_from_set
746 (add_set_cmd ("write", class_support, var_boolean, (char *) &write_files,
747 "Set writing into executable and core files.",
751 add_target (&exec_ops);
755 exec_make_note_section (bfd *obfd, int *note_size)
757 error (_("Can't create a corefile"));