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_fdopenr (scratch_pathname, gnutarget, scratch_chan);
220 error (_("\"%s\": could not open as an executable file: %s"),
221 scratch_pathname, bfd_errmsg (bfd_get_error ()));
223 /* At this point, scratch_pathname and exec_bfd->name both point to the
224 same malloc'd string. However exec_close() will attempt to free it
225 via the exec_bfd->name pointer, so we need to make another copy and
226 leave exec_bfd as the new owner of the original copy. */
227 scratch_pathname = xstrdup (scratch_pathname);
228 make_cleanup (xfree, scratch_pathname);
230 if (!bfd_check_format (exec_bfd, bfd_object))
232 /* Make sure to close exec_bfd, or else "run" might try to use
235 error (_("\"%s\": not in executable format: %s"),
236 scratch_pathname, bfd_errmsg (bfd_get_error ()));
239 /* FIXME - This should only be run for RS6000, but the ifdef is a poor
240 way to accomplish. */
241 #ifdef DEPRECATED_IBM6000_TARGET
242 /* Setup initial vmap. */
244 map_vmap (exec_bfd, 0);
247 /* Make sure to close exec_bfd, or else "run" might try to use
250 error (_("\"%s\": can't find the file sections: %s"),
251 scratch_pathname, bfd_errmsg (bfd_get_error ()));
253 #endif /* DEPRECATED_IBM6000_TARGET */
255 if (build_section_table (exec_bfd, &exec_ops.to_sections,
256 &exec_ops.to_sections_end))
258 /* Make sure to close exec_bfd, or else "run" might try to use
261 error (_("\"%s\": can't find the file sections: %s"),
262 scratch_pathname, bfd_errmsg (bfd_get_error ()));
265 #ifdef DEPRECATED_HPUX_TEXT_END
266 DEPRECATED_HPUX_TEXT_END (&exec_ops);
271 set_gdbarch_from_file (exec_bfd);
273 push_target (&exec_ops);
275 /* Tell display code (if any) about the changed file name. */
276 if (deprecated_exec_file_display_hook)
277 (*deprecated_exec_file_display_hook) (filename);
279 bfd_cache_close_all ();
280 observer_notify_executable_changed (NULL);
283 /* Process the first arg in ARGS as the new exec file.
285 Note that we have to explicitly ignore additional args, since we can
286 be called from file_command(), which also calls symbol_file_command()
287 which can take multiple args.
289 If ARGS is NULL, we just want to close the exec file. */
292 exec_file_command (char *args, int from_tty)
297 target_preopen (from_tty);
301 /* Scan through the args and pick up the first non option arg
304 argv = buildargv (args);
308 make_cleanup_freeargv (argv);
310 for (; (*argv != NULL) && (**argv == '-'); argv++)
314 error (_("No executable file name was specified"));
316 filename = tilde_expand (*argv);
317 make_cleanup (xfree, filename);
318 exec_file_attach (filename, from_tty);
321 exec_file_attach (NULL, from_tty);
324 /* Set both the exec file and the symbol file, in one command.
325 What a novelty. Why did GDB go through four major releases before this
326 command was added? */
329 file_command (char *arg, int from_tty)
331 /* FIXME, if we lose on reading the symbol file, we should revert
332 the exec file, but that's rough. */
333 exec_file_command (arg, from_tty);
334 symbol_file_command (arg, from_tty);
335 if (deprecated_file_changed_hook)
336 deprecated_file_changed_hook (arg);
340 /* Locate all mappable sections of a BFD file.
341 table_pp_char is a char * to get it through bfd_map_over_sections;
342 we cast it back to its proper type. */
345 add_to_section_table (bfd *abfd, struct bfd_section *asect,
348 struct section_table **table_pp = (struct section_table **) table_pp_char;
351 aflag = bfd_get_section_flags (abfd, asect);
352 if (!(aflag & SEC_ALLOC))
354 if (0 == bfd_section_size (abfd, asect))
356 (*table_pp)->bfd = abfd;
357 (*table_pp)->the_bfd_section = asect;
358 (*table_pp)->addr = bfd_section_vma (abfd, asect);
359 (*table_pp)->endaddr = (*table_pp)->addr + bfd_section_size (abfd, asect);
363 /* Builds a section table, given args BFD, SECTABLE_PTR, SECEND_PTR.
364 Returns 0 if OK, 1 on error. */
367 build_section_table (struct bfd *some_bfd, struct section_table **start,
368 struct section_table **end)
372 count = bfd_count_sections (some_bfd);
375 *start = (struct section_table *) xmalloc (count * sizeof (**start));
377 bfd_map_over_sections (some_bfd, add_to_section_table, (char *) end);
378 if (*end > *start + count)
379 internal_error (__FILE__, __LINE__, _("failed internal consistency check"));
380 /* We could realloc the table, but it probably loses for most files. */
385 bfdsec_to_vmap (struct bfd *abfd, struct bfd_section *sect, void *arg3)
387 struct vmap_and_bfd *vmap_bfd = (struct vmap_and_bfd *) arg3;
390 vp = vmap_bfd->pvmap;
392 if ((bfd_get_section_flags (abfd, sect) & SEC_LOAD) == 0)
395 if (strcmp (bfd_section_name (abfd, sect), ".text") == 0)
397 vp->tstart = bfd_section_vma (abfd, sect);
398 vp->tend = vp->tstart + bfd_section_size (abfd, sect);
399 vp->tvma = bfd_section_vma (abfd, sect);
400 vp->toffs = sect->filepos;
402 else if (strcmp (bfd_section_name (abfd, sect), ".data") == 0)
404 vp->dstart = bfd_section_vma (abfd, sect);
405 vp->dend = vp->dstart + bfd_section_size (abfd, sect);
406 vp->dvma = bfd_section_vma (abfd, sect);
408 /* Silently ignore other types of sections. (FIXME?) */
411 /* Make a vmap for ABFD which might be a member of the archive ARCH.
412 Return the new vmap. */
415 map_vmap (bfd *abfd, bfd *arch)
417 struct vmap_and_bfd vmap_bfd;
418 struct vmap *vp, **vpp;
420 vp = (struct vmap *) xmalloc (sizeof (*vp));
421 memset ((char *) vp, '\0', sizeof (*vp));
424 vp->name = bfd_get_filename (arch ? arch : abfd);
425 vp->member = arch ? bfd_get_filename (abfd) : "";
427 vmap_bfd.pbfd = arch;
429 bfd_map_over_sections (abfd, bfdsec_to_vmap, &vmap_bfd);
431 /* Find the end of the list and append. */
432 for (vpp = &vmap; *vpp; vpp = &(*vpp)->nxt)
439 /* Read or write the exec file.
441 Args are address within a BFD file, address within gdb address-space,
442 length, and a flag indicating whether to read or write.
446 0: We cannot handle this address and length.
447 > 0: We have handled N bytes starting at this address.
448 (If N == length, we did it all.) We might be able
449 to handle more bytes beyond this length, but no
451 < 0: We cannot handle this address, but if somebody
452 else handles (-N) bytes, we can start from there.
454 The same routine is used to handle both core and exec files;
455 we just tail-call it with more arguments to select between them. */
458 xfer_memory (CORE_ADDR memaddr, gdb_byte *myaddr, int len, int write,
459 struct mem_attrib *attrib, struct target_ops *target)
462 struct section_table *p;
463 CORE_ADDR nextsectaddr, memend;
464 asection *section = NULL;
467 internal_error (__FILE__, __LINE__, _("failed internal consistency check"));
469 if (overlay_debugging)
471 section = find_pc_overlay (memaddr);
472 if (pc_in_unmapped_range (memaddr, section))
473 memaddr = overlay_mapped_address (memaddr, section);
476 memend = memaddr + len;
477 nextsectaddr = memend;
479 for (p = target->to_sections; p < target->to_sections_end; p++)
481 if (overlay_debugging && section && p->the_bfd_section &&
482 strcmp (section->name, p->the_bfd_section->name) != 0)
483 continue; /* not the section we need */
484 if (memaddr >= p->addr)
486 if (memend <= p->endaddr)
488 /* Entire transfer is within this section. */
490 res = bfd_set_section_contents (p->bfd, p->the_bfd_section,
491 myaddr, memaddr - p->addr,
494 res = bfd_get_section_contents (p->bfd, p->the_bfd_section,
495 myaddr, memaddr - p->addr,
497 return (res != 0) ? len : 0;
499 else if (memaddr >= p->endaddr)
501 /* This section ends before the transfer starts. */
506 /* This section overlaps the transfer. Just do half. */
507 len = p->endaddr - memaddr;
509 res = bfd_set_section_contents (p->bfd, p->the_bfd_section,
510 myaddr, memaddr - p->addr,
513 res = bfd_get_section_contents (p->bfd, p->the_bfd_section,
514 myaddr, memaddr - p->addr,
516 return (res != 0) ? len : 0;
520 nextsectaddr = min (nextsectaddr, p->addr);
523 if (nextsectaddr >= memend)
524 return 0; /* We can't help */
526 return -(nextsectaddr - memaddr); /* Next boundary where we can help */
531 print_section_info (struct target_ops *t, bfd *abfd)
533 struct section_table *p;
534 /* FIXME: 16 is not wide enough when TARGET_ADDR_BIT > 64. */
535 int wid = TARGET_ADDR_BIT <= 32 ? 8 : 16;
537 printf_filtered ("\t`%s', ", bfd_get_filename (abfd));
539 printf_filtered (_("file type %s.\n"), bfd_get_target (abfd));
540 if (abfd == exec_bfd)
542 printf_filtered (_("\tEntry point: "));
543 deprecated_print_address_numeric (bfd_get_start_address (abfd), 1, gdb_stdout);
544 printf_filtered ("\n");
546 for (p = t->to_sections; p < t->to_sections_end; p++)
548 printf_filtered ("\t%s", hex_string_custom (p->addr, wid));
549 printf_filtered (" - %s", hex_string_custom (p->endaddr, wid));
551 /* FIXME: A format of "08l" is not wide enough for file offsets
552 larger than 4GB. OTOH, making it "016l" isn't desirable either
553 since most output will then be much wider than necessary. It
554 may make sense to test the size of the file and choose the
555 format string accordingly. */
556 /* FIXME: i18n: Need to rewrite this sentence. */
558 printf_filtered (" @ %s",
559 hex_string_custom (p->the_bfd_section->filepos, 8));
560 printf_filtered (" is %s", bfd_section_name (p->bfd, p->the_bfd_section));
562 printf_filtered (" in %s", bfd_get_filename (p->bfd));
563 printf_filtered ("\n");
568 exec_files_info (struct target_ops *t)
570 print_section_info (t, exec_bfd);
576 printf_unfiltered (_("\tMapping info for file `%s'.\n"), vmap->name);
577 printf_unfiltered ("\t %*s %*s %*s %*s %8.8s %s\n",
578 strlen_paddr (), "tstart",
579 strlen_paddr (), "tend",
580 strlen_paddr (), "dstart",
581 strlen_paddr (), "dend",
585 for (vp = vmap; vp; vp = vp->nxt)
586 printf_unfiltered ("\t0x%s 0x%s 0x%s 0x%s %s%s%s%s\n",
592 *vp->member ? "(" : "", vp->member,
593 *vp->member ? ")" : "");
598 exec_set_section_offsets sets the offsets of all the sections
599 in the exec objfile. */
602 exec_set_section_offsets (bfd_signed_vma text_off, bfd_signed_vma data_off,
603 bfd_signed_vma bss_off)
605 struct section_table *sect;
607 for (sect = exec_ops.to_sections;
608 sect < exec_ops.to_sections_end;
613 flags = bfd_get_section_flags (exec_bfd, sect->the_bfd_section);
615 if (flags & SEC_CODE)
617 sect->addr += text_off;
618 sect->endaddr += text_off;
620 else if (flags & (SEC_DATA | SEC_LOAD))
622 sect->addr += data_off;
623 sect->endaddr += data_off;
625 else if (flags & SEC_ALLOC)
627 sect->addr += bss_off;
628 sect->endaddr += bss_off;
634 set_section_command (char *args, int from_tty)
636 struct section_table *p;
639 unsigned long secaddr;
644 error (_("Must specify section name and its virtual address"));
646 /* Parse out section name */
647 for (secname = args; !isspace (*args); args++);
648 seclen = args - secname;
650 /* Parse out new virtual address */
651 secaddr = parse_and_eval_address (args);
653 for (p = exec_ops.to_sections; p < exec_ops.to_sections_end; p++)
655 if (!strncmp (secname, bfd_section_name (exec_bfd, p->the_bfd_section), seclen)
656 && bfd_section_name (exec_bfd, p->the_bfd_section)[seclen] == '\0')
658 offset = secaddr - p->addr;
660 p->endaddr += offset;
662 exec_files_info (&exec_ops);
666 if (seclen >= sizeof (secprint))
667 seclen = sizeof (secprint) - 1;
668 strncpy (secprint, secname, seclen);
669 secprint[seclen] = '\0';
670 error (_("Section %s not found"), secprint);
673 /* If we can find a section in FILENAME with BFD index INDEX, and the
674 user has not assigned an address to it yet (via "set section"), adjust it
678 exec_set_section_address (const char *filename, int index, CORE_ADDR address)
680 struct section_table *p;
682 for (p = exec_ops.to_sections; p < exec_ops.to_sections_end; p++)
684 if (strcmp (filename, p->bfd->filename) == 0
685 && index == p->the_bfd_section->index
689 p->endaddr += address;
694 /* If mourn is being called in all the right places, this could be say
695 `gdb internal error' (since generic_mourn calls
696 breakpoint_init_inferior). */
699 ignore (CORE_ADDR addr, bfd_byte *contents)
704 /* Find mapped memory. */
707 exec_set_find_memory_regions (int (*func) (int (*) (CORE_ADDR,
713 exec_ops.to_find_memory_regions = func;
716 static char *exec_make_note_section (bfd *, int *);
718 /* Fill in the exec file target vector. Very few entries need to be
724 exec_ops.to_shortname = "exec";
725 exec_ops.to_longname = "Local exec file";
726 exec_ops.to_doc = "Use an executable file as a target.\n\
727 Specify the filename of the executable file.";
728 exec_ops.to_open = exec_open;
729 exec_ops.to_close = exec_close;
730 exec_ops.to_attach = find_default_attach;
731 exec_ops.deprecated_xfer_memory = xfer_memory;
732 exec_ops.to_files_info = exec_files_info;
733 exec_ops.to_insert_breakpoint = ignore;
734 exec_ops.to_remove_breakpoint = ignore;
735 exec_ops.to_create_inferior = find_default_create_inferior;
736 exec_ops.to_stratum = file_stratum;
737 exec_ops.to_has_memory = 1;
738 exec_ops.to_make_corefile_notes = exec_make_note_section;
739 exec_ops.to_magic = OPS_MAGIC;
743 _initialize_exec (void)
745 struct cmd_list_element *c;
751 c = add_cmd ("file", class_files, file_command, _("\
752 Use FILE as program to be debugged.\n\
753 It is read for its symbols, for getting the contents of pure memory,\n\
754 and it is the program executed when you use the `run' command.\n\
755 If FILE cannot be found as specified, your execution directory path\n\
756 ($PATH) is searched for a command of that name.\n\
757 No arg means to have no executable file and no symbols."), &cmdlist);
758 set_cmd_completer (c, filename_completer);
761 c = add_cmd ("exec-file", class_files, exec_file_command, _("\
762 Use FILE as program for getting contents of pure memory.\n\
763 If FILE cannot be found as specified, your execution directory path\n\
764 is searched for a command of that name.\n\
765 No arg means have no executable file."), &cmdlist);
766 set_cmd_completer (c, filename_completer);
768 add_com ("section", class_files, set_section_command, _("\
769 Change the base address of section SECTION of the exec file to ADDR.\n\
770 This can be used if the exec file does not contain section addresses,\n\
771 (such as in the a.out format), or when the addresses specified in the\n\
772 file itself are wrong. Each section must be changed separately. The\n\
773 ``info files'' command lists all the sections and their addresses."));
775 add_setshow_boolean_cmd ("write", class_support, &write_files, _("\
776 Set writing into executable and core files."), _("\
777 Show writing into executable and core files."), NULL,
780 &setlist, &showlist);
782 add_target (&exec_ops);
786 exec_make_note_section (bfd *obfd, int *note_size)
788 error (_("Can't create a corefile"));