1 /* Work with executable files, for GDB.
3 Copyright (C) 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., 51 Franklin Street, Fifth Floor,
22 Boston, MA 02110-1301, USA. */
32 #include "completer.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 exec_close (int);
56 static void file_command (char *, int);
58 static void set_section_command (char *, int);
60 static void exec_files_info (struct target_ops *);
62 static int ignore (CORE_ADDR, bfd_byte *);
64 static void init_exec_ops (void);
66 void _initialize_exec (void);
68 /* The target vector for executable files. */
70 struct target_ops exec_ops;
72 /* The Binary File Descriptor handle for the executable file. */
76 /* Whether to open exec and core files read-only or read-write. */
80 show_write_files (struct ui_file *file, int from_tty,
81 struct cmd_list_element *c, const char *value)
83 fprintf_filtered (file, _("Writing into executable and core files is %s.\n"),
91 exec_open (char *args, int from_tty)
93 target_preopen (from_tty);
94 exec_file_attach (args, from_tty);
98 exec_close (int quitting)
100 int need_symtab_cleanup = 0;
101 struct vmap *vp, *nxt;
103 for (nxt = vmap; nxt != NULL;)
108 /* if there is an objfile associated with this bfd,
109 free_objfile() will do proper cleanup of objfile *and* bfd. */
113 free_objfile (vp->objfile);
114 need_symtab_cleanup = 1;
116 else if (vp->bfd != exec_bfd)
117 /* FIXME-leak: We should be freeing vp->name too, I think. */
118 if (!bfd_close (vp->bfd))
119 warning (_("cannot close \"%s\": %s"),
120 vp->name, bfd_errmsg (bfd_get_error ()));
122 /* FIXME: This routine is #if 0'd in symfile.c. What should we
123 be doing here? Should we just free everything in
124 vp->objfile->symtabs? Should free_objfile do that?
125 FIXME-as-well: free_objfile already free'd vp->name, so it isn't
127 free_named_symtabs (vp->name);
135 char *name = bfd_get_filename (exec_bfd);
137 if (!bfd_close (exec_bfd))
138 warning (_("cannot close \"%s\": %s"),
139 name, bfd_errmsg (bfd_get_error ()));
144 if (exec_ops.to_sections)
146 xfree (exec_ops.to_sections);
147 exec_ops.to_sections = NULL;
148 exec_ops.to_sections_end = NULL;
153 exec_file_clear (int from_tty)
155 /* Remove exec file. */
156 unpush_target (&exec_ops);
159 printf_unfiltered (_("No executable file now.\n"));
162 /* Process the first arg in ARGS as the new exec file.
164 This function is intended to be behave essentially the same
165 as exec_file_command, except that the latter will detect when
166 a target is being debugged, and will ask the user whether it
167 should be shut down first. (If the answer is "no", then the
168 new file is ignored.)
170 This file is used by exec_file_command, to do the work of opening
171 and processing the exec file after any prompting has happened.
173 And, it is used by child_attach, when the attach command was
174 given a pid but not a exec pathname, and the attach command could
175 figure out the pathname from the pid. (In this case, we shouldn't
176 ask the user whether the current target should be shut down --
177 we're supplying the exec pathname late for good reason.)
179 ARGS is assumed to be the filename. */
182 exec_file_attach (char *filename, int from_tty)
184 /* Remove any previous exec file. */
185 unpush_target (&exec_ops);
187 /* Now open and digest the file the user requested, if any. */
192 printf_unfiltered (_("No executable file now.\n"));
196 char *scratch_pathname;
199 scratch_chan = openp (getenv ("PATH"), OPF_TRY_CWD_FIRST, filename,
200 write_files ? O_RDWR | O_BINARY : O_RDONLY | O_BINARY, 0,
202 #if defined(__GO32__) || defined(_WIN32) || defined(__CYGWIN__)
203 if (scratch_chan < 0)
205 char *exename = alloca (strlen (filename) + 5);
206 strcat (strcpy (exename, filename), ".exe");
207 scratch_chan = openp (getenv ("PATH"), OPF_TRY_CWD_FIRST, exename,
208 write_files ? O_RDWR | O_BINARY : O_RDONLY | O_BINARY, 0,
212 if (scratch_chan < 0)
213 perror_with_name (filename);
214 exec_bfd = bfd_fopen (scratch_pathname, gnutarget,
215 write_files ? FOPEN_RUB : FOPEN_RB,
219 error (_("\"%s\": could not open as an executable file: %s"),
220 scratch_pathname, bfd_errmsg (bfd_get_error ()));
222 /* At this point, scratch_pathname and exec_bfd->name both point to the
223 same malloc'd string. However exec_close() will attempt to free it
224 via the exec_bfd->name pointer, so we need to make another copy and
225 leave exec_bfd as the new owner of the original copy. */
226 scratch_pathname = xstrdup (scratch_pathname);
227 make_cleanup (xfree, scratch_pathname);
229 if (!bfd_check_format (exec_bfd, bfd_object))
231 /* Make sure to close exec_bfd, or else "run" might try to use
234 error (_("\"%s\": not in executable format: %s"),
235 scratch_pathname, bfd_errmsg (bfd_get_error ()));
238 /* FIXME - This should only be run for RS6000, but the ifdef is a poor
239 way to accomplish. */
240 #ifdef DEPRECATED_IBM6000_TARGET
241 /* Setup initial vmap. */
243 map_vmap (exec_bfd, 0);
246 /* Make sure to close exec_bfd, or else "run" might try to use
249 error (_("\"%s\": can't find the file sections: %s"),
250 scratch_pathname, bfd_errmsg (bfd_get_error ()));
252 #endif /* DEPRECATED_IBM6000_TARGET */
254 if (build_section_table (exec_bfd, &exec_ops.to_sections,
255 &exec_ops.to_sections_end))
257 /* Make sure to close exec_bfd, or else "run" might try to use
260 error (_("\"%s\": can't find the file sections: %s"),
261 scratch_pathname, bfd_errmsg (bfd_get_error ()));
266 set_gdbarch_from_file (exec_bfd);
268 push_target (&exec_ops);
270 /* Tell display code (if any) about the changed file name. */
271 if (deprecated_exec_file_display_hook)
272 (*deprecated_exec_file_display_hook) (filename);
274 bfd_cache_close_all ();
275 observer_notify_executable_changed (NULL);
278 /* Process the first arg in ARGS as the new exec file.
280 Note that we have to explicitly ignore additional args, since we can
281 be called from file_command(), which also calls symbol_file_command()
282 which can take multiple args.
284 If ARGS is NULL, we just want to close the exec file. */
287 exec_file_command (char *args, int from_tty)
292 target_preopen (from_tty);
296 /* Scan through the args and pick up the first non option arg
299 argv = buildargv (args);
303 make_cleanup_freeargv (argv);
305 for (; (*argv != NULL) && (**argv == '-'); argv++)
309 error (_("No executable file name was specified"));
311 filename = tilde_expand (*argv);
312 make_cleanup (xfree, filename);
313 exec_file_attach (filename, from_tty);
316 exec_file_attach (NULL, from_tty);
319 /* Set both the exec file and the symbol file, in one command.
320 What a novelty. Why did GDB go through four major releases before this
321 command was added? */
324 file_command (char *arg, int from_tty)
326 /* FIXME, if we lose on reading the symbol file, we should revert
327 the exec file, but that's rough. */
328 exec_file_command (arg, from_tty);
329 symbol_file_command (arg, from_tty);
330 if (deprecated_file_changed_hook)
331 deprecated_file_changed_hook (arg);
335 /* Locate all mappable sections of a BFD file.
336 table_pp_char is a char * to get it through bfd_map_over_sections;
337 we cast it back to its proper type. */
340 add_to_section_table (bfd *abfd, struct bfd_section *asect,
343 struct section_table **table_pp = (struct section_table **) table_pp_char;
346 aflag = bfd_get_section_flags (abfd, asect);
347 if (!(aflag & SEC_ALLOC))
349 if (0 == bfd_section_size (abfd, asect))
351 (*table_pp)->bfd = abfd;
352 (*table_pp)->the_bfd_section = asect;
353 (*table_pp)->addr = bfd_section_vma (abfd, asect);
354 (*table_pp)->endaddr = (*table_pp)->addr + bfd_section_size (abfd, asect);
358 /* Builds a section table, given args BFD, SECTABLE_PTR, SECEND_PTR.
359 Returns 0 if OK, 1 on error. */
362 build_section_table (struct bfd *some_bfd, struct section_table **start,
363 struct section_table **end)
367 count = bfd_count_sections (some_bfd);
370 *start = (struct section_table *) xmalloc (count * sizeof (**start));
372 bfd_map_over_sections (some_bfd, add_to_section_table, (char *) end);
373 if (*end > *start + count)
374 internal_error (__FILE__, __LINE__, _("failed internal consistency check"));
375 /* We could realloc the table, but it probably loses for most files. */
380 bfdsec_to_vmap (struct bfd *abfd, struct bfd_section *sect, void *arg3)
382 struct vmap_and_bfd *vmap_bfd = (struct vmap_and_bfd *) arg3;
385 vp = vmap_bfd->pvmap;
387 if ((bfd_get_section_flags (abfd, sect) & SEC_LOAD) == 0)
390 if (strcmp (bfd_section_name (abfd, sect), ".text") == 0)
392 vp->tstart = bfd_section_vma (abfd, sect);
393 vp->tend = vp->tstart + bfd_section_size (abfd, sect);
394 vp->tvma = bfd_section_vma (abfd, sect);
395 vp->toffs = sect->filepos;
397 else if (strcmp (bfd_section_name (abfd, sect), ".data") == 0)
399 vp->dstart = bfd_section_vma (abfd, sect);
400 vp->dend = vp->dstart + bfd_section_size (abfd, sect);
401 vp->dvma = bfd_section_vma (abfd, sect);
403 /* Silently ignore other types of sections. (FIXME?) */
406 /* Make a vmap for ABFD which might be a member of the archive ARCH.
407 Return the new vmap. */
410 map_vmap (bfd *abfd, bfd *arch)
412 struct vmap_and_bfd vmap_bfd;
413 struct vmap *vp, **vpp;
415 vp = (struct vmap *) xmalloc (sizeof (*vp));
416 memset ((char *) vp, '\0', sizeof (*vp));
419 vp->name = bfd_get_filename (arch ? arch : abfd);
420 vp->member = arch ? bfd_get_filename (abfd) : "";
422 vmap_bfd.pbfd = arch;
424 bfd_map_over_sections (abfd, bfdsec_to_vmap, &vmap_bfd);
426 /* Find the end of the list and append. */
427 for (vpp = &vmap; *vpp; vpp = &(*vpp)->nxt)
434 /* Read or write the exec file.
436 Args are address within a BFD file, address within gdb address-space,
437 length, and a flag indicating whether to read or write.
441 0: We cannot handle this address and length.
442 > 0: We have handled N bytes starting at this address.
443 (If N == length, we did it all.) We might be able
444 to handle more bytes beyond this length, but no
446 < 0: We cannot handle this address, but if somebody
447 else handles (-N) bytes, we can start from there.
449 The same routine is used to handle both core and exec files;
450 we just tail-call it with more arguments to select between them. */
453 xfer_memory (CORE_ADDR memaddr, gdb_byte *myaddr, int len, int write,
454 struct mem_attrib *attrib, struct target_ops *target)
457 struct section_table *p;
458 CORE_ADDR nextsectaddr, memend;
459 asection *section = NULL;
462 internal_error (__FILE__, __LINE__, _("failed internal consistency check"));
464 if (overlay_debugging)
466 section = find_pc_overlay (memaddr);
467 if (pc_in_unmapped_range (memaddr, section))
468 memaddr = overlay_mapped_address (memaddr, section);
471 memend = memaddr + len;
472 nextsectaddr = memend;
474 for (p = target->to_sections; p < target->to_sections_end; p++)
476 if (overlay_debugging && section && p->the_bfd_section &&
477 strcmp (section->name, p->the_bfd_section->name) != 0)
478 continue; /* not the section we need */
479 if (memaddr >= p->addr)
481 if (memend <= p->endaddr)
483 /* Entire transfer is within this section. */
485 res = bfd_set_section_contents (p->bfd, p->the_bfd_section,
486 myaddr, memaddr - p->addr,
489 res = bfd_get_section_contents (p->bfd, p->the_bfd_section,
490 myaddr, memaddr - p->addr,
492 return (res != 0) ? len : 0;
494 else if (memaddr >= p->endaddr)
496 /* This section ends before the transfer starts. */
501 /* This section overlaps the transfer. Just do half. */
502 len = p->endaddr - memaddr;
504 res = bfd_set_section_contents (p->bfd, p->the_bfd_section,
505 myaddr, memaddr - p->addr,
508 res = bfd_get_section_contents (p->bfd, p->the_bfd_section,
509 myaddr, memaddr - p->addr,
511 return (res != 0) ? len : 0;
515 nextsectaddr = min (nextsectaddr, p->addr);
518 if (nextsectaddr >= memend)
519 return 0; /* We can't help */
521 return -(nextsectaddr - memaddr); /* Next boundary where we can help */
526 print_section_info (struct target_ops *t, bfd *abfd)
528 struct section_table *p;
529 /* FIXME: 16 is not wide enough when TARGET_ADDR_BIT > 64. */
530 int wid = TARGET_ADDR_BIT <= 32 ? 8 : 16;
532 printf_filtered ("\t`%s', ", bfd_get_filename (abfd));
534 printf_filtered (_("file type %s.\n"), bfd_get_target (abfd));
535 if (abfd == exec_bfd)
537 printf_filtered (_("\tEntry point: "));
538 deprecated_print_address_numeric (bfd_get_start_address (abfd), 1, gdb_stdout);
539 printf_filtered ("\n");
541 for (p = t->to_sections; p < t->to_sections_end; p++)
543 printf_filtered ("\t%s", hex_string_custom (p->addr, wid));
544 printf_filtered (" - %s", hex_string_custom (p->endaddr, wid));
546 /* FIXME: A format of "08l" is not wide enough for file offsets
547 larger than 4GB. OTOH, making it "016l" isn't desirable either
548 since most output will then be much wider than necessary. It
549 may make sense to test the size of the file and choose the
550 format string accordingly. */
551 /* FIXME: i18n: Need to rewrite this sentence. */
553 printf_filtered (" @ %s",
554 hex_string_custom (p->the_bfd_section->filepos, 8));
555 printf_filtered (" is %s", bfd_section_name (p->bfd, p->the_bfd_section));
557 printf_filtered (" in %s", bfd_get_filename (p->bfd));
558 printf_filtered ("\n");
563 exec_files_info (struct target_ops *t)
565 print_section_info (t, exec_bfd);
571 printf_unfiltered (_("\tMapping info for file `%s'.\n"), vmap->name);
572 printf_unfiltered ("\t %*s %*s %*s %*s %8.8s %s\n",
573 strlen_paddr (), "tstart",
574 strlen_paddr (), "tend",
575 strlen_paddr (), "dstart",
576 strlen_paddr (), "dend",
580 for (vp = vmap; vp; vp = vp->nxt)
581 printf_unfiltered ("\t0x%s 0x%s 0x%s 0x%s %s%s%s%s\n",
587 *vp->member ? "(" : "", vp->member,
588 *vp->member ? ")" : "");
593 exec_set_section_offsets sets the offsets of all the sections
594 in the exec objfile. */
597 exec_set_section_offsets (bfd_signed_vma text_off, bfd_signed_vma data_off,
598 bfd_signed_vma bss_off)
600 struct section_table *sect;
602 for (sect = exec_ops.to_sections;
603 sect < exec_ops.to_sections_end;
608 flags = bfd_get_section_flags (exec_bfd, sect->the_bfd_section);
610 if (flags & SEC_CODE)
612 sect->addr += text_off;
613 sect->endaddr += text_off;
615 else if (flags & (SEC_DATA | SEC_LOAD))
617 sect->addr += data_off;
618 sect->endaddr += data_off;
620 else if (flags & SEC_ALLOC)
622 sect->addr += bss_off;
623 sect->endaddr += bss_off;
629 set_section_command (char *args, int from_tty)
631 struct section_table *p;
634 unsigned long secaddr;
639 error (_("Must specify section name and its virtual address"));
641 /* Parse out section name */
642 for (secname = args; !isspace (*args); args++);
643 seclen = args - secname;
645 /* Parse out new virtual address */
646 secaddr = parse_and_eval_address (args);
648 for (p = exec_ops.to_sections; p < exec_ops.to_sections_end; p++)
650 if (!strncmp (secname, bfd_section_name (exec_bfd, p->the_bfd_section), seclen)
651 && bfd_section_name (exec_bfd, p->the_bfd_section)[seclen] == '\0')
653 offset = secaddr - p->addr;
655 p->endaddr += offset;
657 exec_files_info (&exec_ops);
661 if (seclen >= sizeof (secprint))
662 seclen = sizeof (secprint) - 1;
663 strncpy (secprint, secname, seclen);
664 secprint[seclen] = '\0';
665 error (_("Section %s not found"), secprint);
668 /* If we can find a section in FILENAME with BFD index INDEX, and the
669 user has not assigned an address to it yet (via "set section"), adjust it
673 exec_set_section_address (const char *filename, int index, CORE_ADDR address)
675 struct section_table *p;
677 for (p = exec_ops.to_sections; p < exec_ops.to_sections_end; p++)
679 if (strcmp (filename, p->bfd->filename) == 0
680 && index == p->the_bfd_section->index
684 p->endaddr += address;
689 /* If mourn is being called in all the right places, this could be say
690 `gdb internal error' (since generic_mourn calls
691 breakpoint_init_inferior). */
694 ignore (CORE_ADDR addr, bfd_byte *contents)
699 /* Find mapped memory. */
702 exec_set_find_memory_regions (int (*func) (int (*) (CORE_ADDR,
708 exec_ops.to_find_memory_regions = func;
711 static char *exec_make_note_section (bfd *, int *);
713 /* Fill in the exec file target vector. Very few entries need to be
719 exec_ops.to_shortname = "exec";
720 exec_ops.to_longname = "Local exec file";
721 exec_ops.to_doc = "Use an executable file as a target.\n\
722 Specify the filename of the executable file.";
723 exec_ops.to_open = exec_open;
724 exec_ops.to_close = exec_close;
725 exec_ops.to_attach = find_default_attach;
726 exec_ops.deprecated_xfer_memory = xfer_memory;
727 exec_ops.to_files_info = exec_files_info;
728 exec_ops.to_insert_breakpoint = ignore;
729 exec_ops.to_remove_breakpoint = ignore;
730 exec_ops.to_create_inferior = find_default_create_inferior;
731 exec_ops.to_stratum = file_stratum;
732 exec_ops.to_has_memory = 1;
733 exec_ops.to_make_corefile_notes = exec_make_note_section;
734 exec_ops.to_magic = OPS_MAGIC;
738 _initialize_exec (void)
740 struct cmd_list_element *c;
746 c = add_cmd ("file", class_files, file_command, _("\
747 Use FILE as program to be debugged.\n\
748 It is read for its symbols, for getting the contents of pure memory,\n\
749 and it is the program executed when you use the `run' command.\n\
750 If FILE cannot be found as specified, your execution directory path\n\
751 ($PATH) is searched for a command of that name.\n\
752 No arg means to have no executable file and no symbols."), &cmdlist);
753 set_cmd_completer (c, filename_completer);
756 c = add_cmd ("exec-file", class_files, exec_file_command, _("\
757 Use FILE as program for getting contents of pure memory.\n\
758 If FILE cannot be found as specified, your execution directory path\n\
759 is searched for a command of that name.\n\
760 No arg means have no executable file."), &cmdlist);
761 set_cmd_completer (c, filename_completer);
763 add_com ("section", class_files, set_section_command, _("\
764 Change the base address of section SECTION of the exec file to ADDR.\n\
765 This can be used if the exec file does not contain section addresses,\n\
766 (such as in the a.out format), or when the addresses specified in the\n\
767 file itself are wrong. Each section must be changed separately. The\n\
768 ``info files'' command lists all the sections and their addresses."));
770 add_setshow_boolean_cmd ("write", class_support, &write_files, _("\
771 Set writing into executable and core files."), _("\
772 Show writing into executable and core files."), NULL,
775 &setlist, &showlist);
777 add_target (&exec_ops);
781 exec_make_note_section (bfd *obfd, int *note_size)
783 error (_("Can't create a corefile"));