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 <sys/types.h>
41 #include "readline/readline.h"
42 #include "gdb_string.h"
52 #include "xcoffsolib.h"
54 struct vmap *map_vmap (bfd *, bfd *);
56 void (*file_changed_hook) (char *);
58 /* Prototypes for local functions */
60 static void exec_close (int);
62 static void file_command (char *, int);
64 static void set_section_command (char *, int);
66 static void exec_files_info (struct target_ops *);
68 static int ignore (CORE_ADDR, char *);
70 static void init_exec_ops (void);
72 void _initialize_exec (void);
74 /* The target vector for executable files. */
76 struct target_ops exec_ops;
78 /* The Binary File Descriptor handle for the executable file. */
82 /* Whether to open exec and core files read-only or read-write. */
89 exec_open (char *args, int from_tty)
91 target_preopen (from_tty);
92 exec_file_attach (args, from_tty);
96 exec_close (int quitting)
98 int need_symtab_cleanup = 0;
99 struct vmap *vp, *nxt;
101 for (nxt = vmap; nxt != NULL;)
106 /* if there is an objfile associated with this bfd,
107 free_objfile() will do proper cleanup of objfile *and* bfd. */
111 free_objfile (vp->objfile);
112 need_symtab_cleanup = 1;
114 else if (vp->bfd != exec_bfd)
115 /* FIXME-leak: We should be freeing vp->name too, I think. */
116 if (!bfd_close (vp->bfd))
117 warning ("cannot close \"%s\": %s",
118 vp->name, bfd_errmsg (bfd_get_error ()));
120 /* FIXME: This routine is #if 0'd in symfile.c. What should we
121 be doing here? Should we just free everything in
122 vp->objfile->symtabs? Should free_objfile do that?
123 FIXME-as-well: free_objfile already free'd vp->name, so it isn't
125 free_named_symtabs (vp->name);
133 char *name = bfd_get_filename (exec_bfd);
135 if (!bfd_close (exec_bfd))
136 warning ("cannot close \"%s\": %s",
137 name, bfd_errmsg (bfd_get_error ()));
142 if (exec_ops.to_sections)
144 xfree (exec_ops.to_sections);
145 exec_ops.to_sections = NULL;
146 exec_ops.to_sections_end = NULL;
151 exec_file_clear (int from_tty)
153 /* Remove exec file. */
154 unpush_target (&exec_ops);
157 printf_unfiltered ("No executable file now.\n");
160 /* Process the first arg in ARGS as the new exec file.
162 This function is intended to be behave essentially the same
163 as exec_file_command, except that the latter will detect when
164 a target is being debugged, and will ask the user whether it
165 should be shut down first. (If the answer is "no", then the
166 new file is ignored.)
168 This file is used by exec_file_command, to do the work of opening
169 and processing the exec file after any prompting has happened.
171 And, it is used by child_attach, when the attach command was
172 given a pid but not a exec pathname, and the attach command could
173 figure out the pathname from the pid. (In this case, we shouldn't
174 ask the user whether the current target should be shut down --
175 we're supplying the exec pathname late for good reason.)
177 ARGS is assumed to be the filename. */
180 exec_file_attach (char *filename, int from_tty)
182 /* Remove any previous exec file. */
183 unpush_target (&exec_ops);
185 /* Now open and digest the file the user requested, if any. */
190 printf_unfiltered ("No executable file now.\n");
194 char *scratch_pathname;
197 scratch_chan = openp (getenv ("PATH"), 1, filename,
198 write_files ? O_RDWR | O_BINARY : O_RDONLY | O_BINARY, 0,
200 #if defined(__GO32__) || defined(_WIN32) || defined(__CYGWIN__)
201 if (scratch_chan < 0)
203 char *exename = alloca (strlen (filename) + 5);
204 strcat (strcpy (exename, filename), ".exe");
205 scratch_chan = openp (getenv ("PATH"), 1, exename, write_files ?
206 O_RDWR | O_BINARY : O_RDONLY | O_BINARY, 0, &scratch_pathname);
209 if (scratch_chan < 0)
210 perror_with_name (filename);
211 exec_bfd = bfd_fdopenr (scratch_pathname, gnutarget, scratch_chan);
214 error ("\"%s\": could not open as an executable file: %s",
215 scratch_pathname, bfd_errmsg (bfd_get_error ()));
217 /* At this point, scratch_pathname and exec_bfd->name both point to the
218 same malloc'd string. However exec_close() will attempt to free it
219 via the exec_bfd->name pointer, so we need to make another copy and
220 leave exec_bfd as the new owner of the original copy. */
221 scratch_pathname = xstrdup (scratch_pathname);
222 make_cleanup (xfree, scratch_pathname);
224 if (!bfd_check_format (exec_bfd, bfd_object))
226 /* Make sure to close exec_bfd, or else "run" might try to use
229 error ("\"%s\": not in executable format: %s",
230 scratch_pathname, bfd_errmsg (bfd_get_error ()));
233 /* FIXME - This should only be run for RS6000, but the ifdef is a poor
234 way to accomplish. */
235 #ifdef DEPRECATED_IBM6000_TARGET
236 /* Setup initial vmap. */
238 map_vmap (exec_bfd, 0);
241 /* Make sure to close exec_bfd, or else "run" might try to use
244 error ("\"%s\": can't find the file sections: %s",
245 scratch_pathname, bfd_errmsg (bfd_get_error ()));
247 #endif /* DEPRECATED_IBM6000_TARGET */
249 if (build_section_table (exec_bfd, &exec_ops.to_sections,
250 &exec_ops.to_sections_end))
252 /* Make sure to close exec_bfd, or else "run" might try to use
255 error ("\"%s\": can't find the file sections: %s",
256 scratch_pathname, bfd_errmsg (bfd_get_error ()));
259 #ifdef DEPRECATED_HPUX_TEXT_END
260 DEPRECATED_HPUX_TEXT_END (&exec_ops);
265 set_gdbarch_from_file (exec_bfd);
267 push_target (&exec_ops);
269 /* Tell display code (if any) about the changed file name. */
270 if (exec_file_display_hook)
271 (*exec_file_display_hook) (filename);
275 /* Process the first arg in ARGS as the new exec file.
277 Note that we have to explicitly ignore additional args, since we can
278 be called from file_command(), which also calls symbol_file_command()
279 which can take multiple args.
281 If ARGS is NULL, we just want to close the exec file. */
284 exec_file_command (char *args, int from_tty)
289 target_preopen (from_tty);
293 /* Scan through the args and pick up the first non option arg
296 argv = buildargv (args);
300 make_cleanup_freeargv (argv);
302 for (; (*argv != NULL) && (**argv == '-'); argv++)
306 error ("No executable file name was specified");
308 filename = tilde_expand (*argv);
309 make_cleanup (xfree, filename);
310 exec_file_attach (filename, from_tty);
313 exec_file_attach (NULL, from_tty);
316 /* Set both the exec file and the symbol file, in one command.
317 What a novelty. Why did GDB go through four major releases before this
318 command was added? */
321 file_command (char *arg, int from_tty)
323 /* FIXME, if we lose on reading the symbol file, we should revert
324 the exec file, but that's rough. */
325 exec_file_command (arg, from_tty);
326 symbol_file_command (arg, from_tty);
327 if (file_changed_hook)
328 file_changed_hook (arg);
332 /* Locate all mappable sections of a BFD file.
333 table_pp_char is a char * to get it through bfd_map_over_sections;
334 we cast it back to its proper type. */
337 add_to_section_table (bfd *abfd, struct bfd_section *asect,
340 struct section_table **table_pp = (struct section_table **) table_pp_char;
343 aflag = bfd_get_section_flags (abfd, asect);
344 if (!(aflag & SEC_ALLOC))
346 if (0 == bfd_section_size (abfd, asect))
348 (*table_pp)->bfd = abfd;
349 (*table_pp)->the_bfd_section = asect;
350 (*table_pp)->addr = bfd_section_vma (abfd, asect);
351 (*table_pp)->endaddr = (*table_pp)->addr + bfd_section_size (abfd, asect);
355 /* Builds a section table, given args BFD, SECTABLE_PTR, SECEND_PTR.
356 Returns 0 if OK, 1 on error. */
359 build_section_table (struct bfd *some_bfd, struct section_table **start,
360 struct section_table **end)
364 count = bfd_count_sections (some_bfd);
367 *start = (struct section_table *) xmalloc (count * sizeof (**start));
369 bfd_map_over_sections (some_bfd, add_to_section_table, (char *) end);
370 if (*end > *start + count)
371 internal_error (__FILE__, __LINE__, "failed internal consistency check");
372 /* We could realloc the table, but it probably loses for most files. */
377 bfdsec_to_vmap (struct bfd *abfd, struct bfd_section *sect, void *arg3)
379 struct vmap_and_bfd *vmap_bfd = (struct vmap_and_bfd *) arg3;
382 vp = vmap_bfd->pvmap;
384 if ((bfd_get_section_flags (abfd, sect) & SEC_LOAD) == 0)
387 if (DEPRECATED_STREQ (bfd_section_name (abfd, sect), ".text"))
389 vp->tstart = bfd_section_vma (abfd, sect);
390 vp->tend = vp->tstart + bfd_section_size (abfd, sect);
391 vp->tvma = bfd_section_vma (abfd, sect);
392 vp->toffs = sect->filepos;
394 else if (DEPRECATED_STREQ (bfd_section_name (abfd, sect), ".data"))
396 vp->dstart = bfd_section_vma (abfd, sect);
397 vp->dend = vp->dstart + bfd_section_size (abfd, sect);
398 vp->dvma = bfd_section_vma (abfd, sect);
400 /* Silently ignore other types of sections. (FIXME?) */
403 /* Make a vmap for ABFD which might be a member of the archive ARCH.
404 Return the new vmap. */
407 map_vmap (bfd *abfd, bfd *arch)
409 struct vmap_and_bfd vmap_bfd;
410 struct vmap *vp, **vpp;
412 vp = (struct vmap *) xmalloc (sizeof (*vp));
413 memset ((char *) vp, '\0', sizeof (*vp));
416 vp->name = bfd_get_filename (arch ? arch : abfd);
417 vp->member = arch ? bfd_get_filename (abfd) : "";
419 vmap_bfd.pbfd = arch;
421 bfd_map_over_sections (abfd, bfdsec_to_vmap, &vmap_bfd);
423 /* Find the end of the list and append. */
424 for (vpp = &vmap; *vpp; vpp = &(*vpp)->nxt)
431 /* Read or write the exec file.
433 Args are address within a BFD file, address within gdb address-space,
434 length, and a flag indicating whether to read or write.
438 0: We cannot handle this address and length.
439 > 0: We have handled N bytes starting at this address.
440 (If N == length, we did it all.) We might be able
441 to handle more bytes beyond this length, but no
443 < 0: We cannot handle this address, but if somebody
444 else handles (-N) bytes, we can start from there.
446 The same routine is used to handle both core and exec files;
447 we just tail-call it with more arguments to select between them. */
450 xfer_memory (CORE_ADDR memaddr, char *myaddr, int len, int write,
451 struct mem_attrib *attrib,
452 struct target_ops *target)
455 struct section_table *p;
456 CORE_ADDR nextsectaddr, memend;
457 asection *section = NULL;
460 internal_error (__FILE__, __LINE__, "failed internal consistency check");
462 if (overlay_debugging)
464 section = find_pc_overlay (memaddr);
465 if (pc_in_unmapped_range (memaddr, section))
466 memaddr = overlay_mapped_address (memaddr, section);
469 memend = memaddr + len;
470 nextsectaddr = memend;
472 for (p = target->to_sections; p < target->to_sections_end; p++)
474 if (overlay_debugging && section && p->the_bfd_section &&
475 strcmp (section->name, p->the_bfd_section->name) != 0)
476 continue; /* not the section we need */
477 if (memaddr >= p->addr)
479 if (memend <= p->endaddr)
481 /* Entire transfer is within this section. */
483 res = bfd_set_section_contents (p->bfd, p->the_bfd_section,
484 myaddr, memaddr - p->addr,
487 res = bfd_get_section_contents (p->bfd, p->the_bfd_section,
488 myaddr, memaddr - p->addr,
490 return (res != 0) ? len : 0;
492 else if (memaddr >= p->endaddr)
494 /* This section ends before the transfer starts. */
499 /* This section overlaps the transfer. Just do half. */
500 len = p->endaddr - memaddr;
502 res = bfd_set_section_contents (p->bfd, p->the_bfd_section,
503 myaddr, memaddr - p->addr,
506 res = bfd_get_section_contents (p->bfd, p->the_bfd_section,
507 myaddr, memaddr - p->addr,
509 return (res != 0) ? len : 0;
513 nextsectaddr = min (nextsectaddr, p->addr);
516 if (nextsectaddr >= memend)
517 return 0; /* We can't help */
519 return -(nextsectaddr - memaddr); /* Next boundary where we can help */
524 print_section_info (struct target_ops *t, bfd *abfd)
526 struct section_table *p;
527 /* FIXME: "016l" is not wide enough when TARGET_ADDR_BIT > 64. */
528 char *fmt = TARGET_ADDR_BIT <= 32 ? "08l" : "016l";
530 printf_filtered ("\t`%s', ", bfd_get_filename (abfd));
532 printf_filtered ("file type %s.\n", bfd_get_target (abfd));
533 if (abfd == exec_bfd)
535 printf_filtered ("\tEntry point: ");
536 print_address_numeric (bfd_get_start_address (abfd), 1, gdb_stdout);
537 printf_filtered ("\n");
539 for (p = t->to_sections; p < t->to_sections_end; p++)
541 printf_filtered ("\t%s", local_hex_string_custom (p->addr, fmt));
542 printf_filtered (" - %s", local_hex_string_custom (p->endaddr, fmt));
544 /* FIXME: A format of "08l" is not wide enough for file offsets
545 larger than 4GB. OTOH, making it "016l" isn't desirable either
546 since most output will then be much wider than necessary. It
547 may make sense to test the size of the file and choose the
548 format string accordingly. */
550 printf_filtered (" @ %s",
551 local_hex_string_custom (p->the_bfd_section->filepos, "08l"));
552 printf_filtered (" is %s", bfd_section_name (p->bfd, p->the_bfd_section));
555 printf_filtered (" in %s", bfd_get_filename (p->bfd));
557 printf_filtered ("\n");
562 exec_files_info (struct target_ops *t)
564 print_section_info (t, exec_bfd);
570 printf_unfiltered ("\tMapping info for file `%s'.\n", vmap->name);
571 printf_unfiltered ("\t %*s %*s %*s %*s %8.8s %s\n",
572 strlen_paddr (), "tstart",
573 strlen_paddr (), "tend",
574 strlen_paddr (), "dstart",
575 strlen_paddr (), "dend",
579 for (vp = vmap; vp; vp = vp->nxt)
580 printf_unfiltered ("\t0x%s 0x%s 0x%s 0x%s %s%s%s%s\n",
586 *vp->member ? "(" : "", vp->member,
587 *vp->member ? ")" : "");
592 exec_set_section_offsets sets the offsets of all the sections
593 in the exec objfile. */
596 exec_set_section_offsets (bfd_signed_vma text_off, bfd_signed_vma data_off,
597 bfd_signed_vma bss_off)
599 struct section_table *sect;
601 for (sect = exec_ops.to_sections;
602 sect < exec_ops.to_sections_end;
607 flags = bfd_get_section_flags (exec_bfd, sect->the_bfd_section);
609 if (flags & SEC_CODE)
611 sect->addr += text_off;
612 sect->endaddr += text_off;
614 else if (flags & (SEC_DATA | SEC_LOAD))
616 sect->addr += data_off;
617 sect->endaddr += data_off;
619 else if (flags & SEC_ALLOC)
621 sect->addr += bss_off;
622 sect->endaddr += bss_off;
628 set_section_command (char *args, int from_tty)
630 struct section_table *p;
633 unsigned long secaddr;
638 error ("Must specify section name and its virtual address");
640 /* Parse out section name */
641 for (secname = args; !isspace (*args); args++);
642 seclen = args - secname;
644 /* Parse out new virtual address */
645 secaddr = parse_and_eval_address (args);
647 for (p = exec_ops.to_sections; p < exec_ops.to_sections_end; p++)
649 if (!strncmp (secname, bfd_section_name (exec_bfd, p->the_bfd_section), seclen)
650 && bfd_section_name (exec_bfd, p->the_bfd_section)[seclen] == '\0')
652 offset = secaddr - p->addr;
654 p->endaddr += offset;
656 exec_files_info (&exec_ops);
660 if (seclen >= sizeof (secprint))
661 seclen = sizeof (secprint) - 1;
662 strncpy (secprint, secname, seclen);
663 secprint[seclen] = '\0';
664 error ("Section %s not found", secprint);
667 /* If mourn is being called in all the right places, this could be say
668 `gdb internal error' (since generic_mourn calls
669 breakpoint_init_inferior). */
672 ignore (CORE_ADDR addr, char *contents)
677 /* Find mapped memory. */
680 exec_set_find_memory_regions (int (*func) (int (*) (CORE_ADDR,
686 exec_ops.to_find_memory_regions = func;
689 static char *exec_make_note_section (bfd *, int *);
691 /* Fill in the exec file target vector. Very few entries need to be
697 exec_ops.to_shortname = "exec";
698 exec_ops.to_longname = "Local exec file";
699 exec_ops.to_doc = "Use an executable file as a target.\n\
700 Specify the filename of the executable file.";
701 exec_ops.to_open = exec_open;
702 exec_ops.to_close = exec_close;
703 exec_ops.to_attach = find_default_attach;
704 exec_ops.to_xfer_memory = xfer_memory;
705 exec_ops.to_files_info = exec_files_info;
706 exec_ops.to_insert_breakpoint = ignore;
707 exec_ops.to_remove_breakpoint = ignore;
708 exec_ops.to_create_inferior = find_default_create_inferior;
709 exec_ops.to_stratum = file_stratum;
710 exec_ops.to_has_memory = 1;
711 exec_ops.to_make_corefile_notes = exec_make_note_section;
712 exec_ops.to_magic = OPS_MAGIC;
716 _initialize_exec (void)
718 struct cmd_list_element *c;
724 c = add_cmd ("file", class_files, file_command,
725 "Use FILE as program to be debugged.\n\
726 It is read for its symbols, for getting the contents of pure memory,\n\
727 and it is the program executed when you use the `run' command.\n\
728 If FILE cannot be found as specified, your execution directory path\n\
729 ($PATH) is searched for a command of that name.\n\
730 No arg means to have no executable file and no symbols.", &cmdlist);
731 set_cmd_completer (c, filename_completer);
734 c = add_cmd ("exec-file", class_files, exec_file_command,
735 "Use FILE as program for getting contents of pure memory.\n\
736 If FILE cannot be found as specified, your execution directory path\n\
737 is searched for a command of that name.\n\
738 No arg means have no executable file.", &cmdlist);
739 set_cmd_completer (c, filename_completer);
741 add_com ("section", class_files, set_section_command,
742 "Change the base address of section SECTION of the exec file to ADDR.\n\
743 This can be used if the exec file does not contain section addresses,\n\
744 (such as in the a.out format), or when the addresses specified in the\n\
745 file itself are wrong. Each section must be changed separately. The\n\
746 ``info files'' command lists all the sections and their addresses.");
749 (add_set_cmd ("write", class_support, var_boolean, (char *) &write_files,
750 "Set writing into executable and core files.",
754 add_target (&exec_ops);
758 exec_make_note_section (bfd *obfd, int *note_size)
760 error ("Can't create a corefile");