1 /* Work with executable files, for GDB.
2 Copyright 1988, 1989, 1991, 1992, 1993, 1994, 1997, 1998
3 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
31 #include <sys/types.h>
35 #include "gdb_string.h"
45 #include "xcoffsolib.h"
47 struct vmap *map_vmap PARAMS ((bfd *, bfd *));
49 void (*file_changed_hook) PARAMS ((char *));
51 /* Prototypes for local functions */
53 static void add_to_section_table PARAMS ((bfd *, sec_ptr, PTR));
55 static void exec_close PARAMS ((int));
57 static void file_command PARAMS ((char *, int));
59 static void set_section_command PARAMS ((char *, int));
61 static void exec_files_info PARAMS ((struct target_ops *));
63 static void bfdsec_to_vmap PARAMS ((bfd *, sec_ptr, PTR));
65 static int ignore PARAMS ((CORE_ADDR, char *));
67 static void init_exec_ops PARAMS ((void));
69 void _initialize_exec PARAMS ((void));
71 extern int info_verbose;
73 /* The target vector for executable files. */
75 struct target_ops exec_ops;
77 /* The Binary File Descriptor handle for the executable file. */
81 /* Whether to open exec and core files read-only or read-write. */
85 /* Text start and end addresses (KLUDGE) if needed */
87 #ifndef NEED_TEXT_START_END
88 #define NEED_TEXT_START_END (0)
90 CORE_ADDR text_start = 0;
91 CORE_ADDR text_end = 0;
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 free ((PTR)exec_ops.to_sections);
147 exec_ops.to_sections = NULL;
148 exec_ops.to_sections_end = NULL;
152 /* Process the first arg in ARGS as the new exec file.
154 This function is intended to be behave essentially the same
155 as exec_file_command, except that the latter will detect when
156 a target is being debugged, and will ask the user whether it
157 should be shut down first. (If the answer is "no", then the
158 new file is ignored.)
160 This file is used by exec_file_command, to do the work of opening
161 and processing the exec file after any prompting has happened.
163 And, it is used by child_attach, when the attach command was
164 given a pid but not a exec pathname, and the attach command could
165 figure out the pathname from the pid. (In this case, we shouldn't
166 ask the user whether the current target should be shut down --
167 we're supplying the exec pathname late for good reason.) */
170 exec_file_attach (args, from_tty)
177 /* Remove any previous exec file. */
178 unpush_target (&exec_ops);
180 /* Now open and digest the file the user requested, if any. */
184 char *scratch_pathname;
187 /* Scan through the args and pick up the first non option arg
190 argv = buildargv (args);
194 make_cleanup_freeargv (argv);
196 for (; (*argv != NULL) && (**argv == '-'); argv++) {;}
198 error ("no exec file name was specified");
200 filename = tilde_expand (*argv);
201 make_cleanup (free, filename);
203 scratch_chan = openp (getenv ("PATH"), 1, filename,
204 write_files? O_RDWR|O_BINARY: O_RDONLY|O_BINARY, 0,
206 #if defined(__GO32__) || defined(_WIN32)
207 if (scratch_chan < 0)
209 char *exename = alloca (strlen (filename) + 5);
210 strcat (strcpy (exename, filename), ".exe");
211 scratch_chan = openp (getenv ("PATH"), 1, exename, write_files ?
212 O_RDWR|O_BINARY : O_RDONLY|O_BINARY, 0, &scratch_pathname);
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 = strdup (scratch_pathname);
228 make_cleanup (free, 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 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 /* 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 /* text_end is sometimes used for where to put call dummies. A
266 few ports use these for other purposes too. */
267 if (NEED_TEXT_START_END)
269 struct section_table *p;
271 /* Set text_start to the lowest address of the start of any
272 readonly code section and set text_end to the highest
273 address of the end of any readonly code section. */
274 /* FIXME: The comment above does not match the code. The
275 code checks for sections with are either code *or*
277 text_start = ~(CORE_ADDR)0;
278 text_end = (CORE_ADDR)0;
279 for (p = exec_ops.to_sections; p < exec_ops.to_sections_end; p++)
280 if (bfd_get_section_flags (p->bfd, p->the_bfd_section)
281 & (SEC_CODE | SEC_READONLY))
283 if (text_start > p->addr)
284 text_start = p->addr;
285 if (text_end < p->endaddr)
286 text_end = p->endaddr;
292 set_gdbarch_from_file (exec_bfd);
294 push_target (&exec_ops);
296 /* Tell display code (if any) about the changed file name. */
297 if (exec_file_display_hook)
298 (*exec_file_display_hook) (filename);
301 printf_unfiltered ("No executable file now.\n");
304 /* Process the first arg in ARGS as the new exec file.
306 Note that we have to explicitly ignore additional args, since we can
307 be called from file_command(), which also calls symbol_file_command()
308 which can take multiple args. */
311 exec_file_command (args, from_tty)
318 target_preopen (from_tty);
320 exec_file_attach (args, from_tty);
323 /* Set both the exec file and the symbol file, in one command.
324 What a novelty. Why did GDB go through four major releases before this
325 command was added? */
328 file_command (arg, from_tty)
332 /* FIXME, if we lose on reading the symbol file, we should revert
333 the exec file, but that's rough. */
334 exec_file_command (arg, from_tty);
335 symbol_file_command (arg, from_tty);
336 if (file_changed_hook)
337 file_changed_hook (arg);
341 /* Locate all mappable sections of a BFD file.
342 table_pp_char is a char * to get it through bfd_map_over_sections;
343 we cast it back to its proper type. */
346 add_to_section_table (abfd, asect, table_pp_char)
351 struct section_table **table_pp = (struct section_table **)table_pp_char;
354 aflag = bfd_get_section_flags (abfd, asect);
355 if (!(aflag & SEC_ALLOC))
357 if (0 == bfd_section_size (abfd, asect))
359 (*table_pp)->bfd = abfd;
360 (*table_pp)->the_bfd_section = asect;
361 (*table_pp)->addr = bfd_section_vma (abfd, asect);
362 (*table_pp)->endaddr = (*table_pp)->addr + bfd_section_size (abfd, asect);
366 /* Builds a section table, given args BFD, SECTABLE_PTR, SECEND_PTR.
367 Returns 0 if OK, 1 on error. */
370 build_section_table (some_bfd, start, end)
372 struct section_table **start, **end;
376 count = bfd_count_sections (some_bfd);
379 *start = (struct section_table *) xmalloc (count * sizeof (**start));
381 bfd_map_over_sections (some_bfd, add_to_section_table, (char *)end);
382 if (*end > *start + count)
384 /* We could realloc the table, but it probably loses for most files. */
389 bfdsec_to_vmap(abfd, sect, arg3)
394 struct vmap_and_bfd *vmap_bfd = (struct vmap_and_bfd *) arg3;
397 vp = vmap_bfd->pvmap;
399 if ((bfd_get_section_flags (abfd, sect) & SEC_LOAD) == 0)
402 if (STREQ (bfd_section_name (abfd, sect), ".text"))
404 vp->tstart = bfd_section_vma (abfd, sect);
405 vp->tend = vp->tstart + bfd_section_size (abfd, sect);
406 vp->tvma = bfd_section_vma (abfd, sect);
407 vp->toffs = sect->filepos;
409 else if (STREQ (bfd_section_name (abfd, sect), ".data"))
411 vp->dstart = bfd_section_vma (abfd, sect);
412 vp->dend = vp->dstart + bfd_section_size (abfd, sect);
413 vp->dvma = bfd_section_vma (abfd, sect);
415 /* Silently ignore other types of sections. (FIXME?) */
418 /* Make a vmap for ABFD which might be a member of the archive ARCH.
419 Return the new vmap. */
422 map_vmap (abfd, arch)
426 struct vmap_and_bfd vmap_bfd;
427 struct vmap *vp, **vpp;
429 vp = (struct vmap *) xmalloc (sizeof (*vp));
430 memset ((char *) vp, '\0', sizeof (*vp));
433 vp->name = bfd_get_filename (arch ? arch : abfd);
434 vp->member = arch ? bfd_get_filename (abfd) : "";
436 vmap_bfd.pbfd = arch;
438 bfd_map_over_sections (abfd, bfdsec_to_vmap, &vmap_bfd);
440 /* Find the end of the list and append. */
441 for (vpp = &vmap; *vpp; vpp = &(*vpp)->nxt)
448 /* Read or write the exec file.
450 Args are address within a BFD file, address within gdb address-space,
451 length, and a flag indicating whether to read or write.
455 0: We cannot handle this address and length.
456 > 0: We have handled N bytes starting at this address.
457 (If N == length, we did it all.) We might be able
458 to handle more bytes beyond this length, but no
460 < 0: We cannot handle this address, but if somebody
461 else handles (-N) bytes, we can start from there.
463 The same routine is used to handle both core and exec files;
464 we just tail-call it with more arguments to select between them. */
467 xfer_memory (memaddr, myaddr, len, write, target)
472 struct target_ops *target;
475 struct section_table *p;
476 CORE_ADDR nextsectaddr, memend;
477 boolean (*xfer_fn) PARAMS ((bfd *, sec_ptr, PTR, file_ptr, bfd_size_type));
483 if (overlay_debugging)
485 section = find_pc_overlay (memaddr);
486 if (pc_in_unmapped_range (memaddr, section))
487 memaddr = overlay_mapped_address (memaddr, section);
490 memend = memaddr + len;
491 xfer_fn = write ? bfd_set_section_contents : bfd_get_section_contents;
492 nextsectaddr = memend;
494 #if 0 /* Stu's implementation */
495 /* If a section has been specified, try to use it. Note that we cannot use the
496 specified section directly. This is because it usually comes from the
497 symbol file, which may be different from the exec or core file. Instead, we
498 have to lookup the specified section by name in the bfd associated with
501 if (target_memory_bfd_section)
505 asection *target_section;
508 s = target_memory_bfd_section;
511 target_bfd = target->to_sections->bfd;
512 target_section = bfd_get_section_by_name (target_bfd, bfd_section_name (abfd, s));
517 bfd_size_type sec_size;
519 sec_addr = bfd_section_vma (target_bfd, target_section);
520 sec_size = target_section->_raw_size;
522 /* Make sure the requested memory starts inside the section. */
524 if (memaddr >= sec_addr
525 && memaddr < sec_addr + sec_size)
527 /* Cut back length in case request overflows the end of the section. */
528 len = min (len, sec_addr + sec_size - memaddr);
530 res = xfer_fn (target_bfd, target_section, myaddr, memaddr - sec_addr, len);
532 return res ? len : 0;
536 #endif /* 0, Stu's implementation */
537 for (p = target->to_sections; p < target->to_sections_end; p++)
539 if (overlay_debugging && section && p->the_bfd_section &&
540 strcmp (section->name, p->the_bfd_section->name) != 0)
541 continue; /* not the section we need */
542 if (memaddr >= p->addr)
543 if (memend <= p->endaddr)
545 /* Entire transfer is within this section. */
546 res = xfer_fn (p->bfd, p->the_bfd_section, myaddr,
547 memaddr - p->addr, len);
548 return (res != 0) ? len : 0;
550 else if (memaddr >= p->endaddr)
552 /* This section ends before the transfer starts. */
557 /* This section overlaps the transfer. Just do half. */
558 len = p->endaddr - memaddr;
559 res = xfer_fn (p->bfd, p->the_bfd_section, myaddr,
560 memaddr - p->addr, len);
561 return (res != 0) ? len : 0;
564 nextsectaddr = min (nextsectaddr, p->addr);
567 if (nextsectaddr >= memend)
568 return 0; /* We can't help */
570 return - (nextsectaddr - memaddr); /* Next boundary where we can help */
575 print_section_info (t, abfd)
576 struct target_ops *t;
579 struct section_table *p;
581 printf_filtered ("\t`%s', ", bfd_get_filename(abfd));
583 printf_filtered ("file type %s.\n", bfd_get_target(abfd));
584 if (abfd == exec_bfd)
586 printf_filtered ("\tEntry point: ");
587 print_address_numeric (bfd_get_start_address (abfd), 1, gdb_stdout);
588 printf_filtered ("\n");
590 for (p = t->to_sections; p < t->to_sections_end; p++)
592 /* FIXME-32x64 need a print_address_numeric with field width */
593 printf_filtered ("\t%s", local_hex_string_custom ((unsigned long) p->addr, "08l"));
594 printf_filtered (" - %s", local_hex_string_custom ((unsigned long) p->endaddr, "08l"));
596 printf_filtered (" @ %s",
597 local_hex_string_custom ((unsigned long) p->the_bfd_section->filepos, "08l"));
598 printf_filtered (" is %s", bfd_section_name (p->bfd, p->the_bfd_section));
601 printf_filtered (" in %s", bfd_get_filename (p->bfd));
603 printf_filtered ("\n");
609 struct target_ops *t;
611 print_section_info (t, exec_bfd);
617 printf_unfiltered ("\tMapping info for file `%s'.\n", vmap->name);
618 printf_unfiltered ("\t %8.8s %8.8s %8.8s %8.8s %8.8s %s\n",
619 "tstart", "tend", "dstart", "dend", "section",
622 for (vp = vmap; vp; vp = vp->nxt)
623 printf_unfiltered ("\t0x%8.8x 0x%8.8x 0x%8.8x 0x%8.8x %s%s%s%s\n",
624 vp->tstart, vp->tend, vp->dstart, vp->dend, vp->name,
625 *vp->member ? "(" : "", vp->member,
626 *vp->member ? ")" : "");
631 exec_set_section_offsets sets the offsets of all the sections
632 in the exec objfile. */
635 exec_set_section_offsets (text_off, data_off, bss_off)
636 bfd_signed_vma text_off;
637 bfd_signed_vma data_off;
638 bfd_signed_vma bss_off;
640 struct section_table *sect;
642 for (sect = exec_ops.to_sections;
643 sect < exec_ops.to_sections_end;
648 flags = bfd_get_section_flags (exec_bfd, sect->the_bfd_section);
650 if (flags & SEC_CODE)
652 sect->addr += text_off;
653 sect->endaddr += text_off;
655 else if (flags & (SEC_DATA | SEC_LOAD))
657 sect->addr += data_off;
658 sect->endaddr += data_off;
660 else if (flags & SEC_ALLOC)
662 sect->addr += bss_off;
663 sect->endaddr += bss_off;
669 set_section_command (args, from_tty)
673 struct section_table *p;
676 unsigned long secaddr;
681 error ("Must specify section name and its virtual address");
683 /* Parse out section name */
684 for (secname = args; !isspace(*args); args++) ;
685 seclen = args - secname;
687 /* Parse out new virtual address */
688 secaddr = parse_and_eval_address (args);
690 for (p = exec_ops.to_sections; p < exec_ops.to_sections_end; p++) {
691 if (!strncmp (secname, bfd_section_name (exec_bfd, p->the_bfd_section), seclen)
692 && bfd_section_name (exec_bfd, p->the_bfd_section)[seclen] == '\0') {
693 offset = secaddr - p->addr;
695 p->endaddr += offset;
697 exec_files_info(&exec_ops);
701 if (seclen >= sizeof (secprint))
702 seclen = sizeof (secprint) - 1;
703 strncpy (secprint, secname, seclen);
704 secprint[seclen] = '\0';
705 error ("Section %s not found", secprint);
708 /* If mourn is being called in all the right places, this could be say
709 `gdb internal error' (since generic_mourn calls
710 breakpoint_init_inferior). */
713 ignore (addr, contents)
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_file_command;
731 exec_ops.to_close = exec_close;
732 exec_ops.to_attach = find_default_attach;
733 exec_ops.to_require_attach = find_default_require_attach;
734 exec_ops.to_require_detach = find_default_require_detach;
735 exec_ops.to_xfer_memory = xfer_memory;
736 exec_ops.to_files_info = exec_files_info;
737 exec_ops.to_insert_breakpoint = ignore;
738 exec_ops.to_remove_breakpoint = ignore;
739 exec_ops.to_create_inferior = find_default_create_inferior;
740 exec_ops.to_clone_and_follow_inferior = find_default_clone_and_follow_inferior;
741 exec_ops.to_stratum = file_stratum;
742 exec_ops.to_has_memory = 1;
743 exec_ops.to_magic = OPS_MAGIC;
749 struct cmd_list_element *c;
755 c = add_cmd ("file", class_files, file_command,
756 "Use FILE as program to be debugged.\n\
757 It is read for its symbols, for getting the contents of pure memory,\n\
758 and it is the program executed when you use the `run' command.\n\
759 If FILE cannot be found as specified, your execution directory path\n\
760 ($PATH) is searched for a command of that name.\n\
761 No arg means to have no executable file and no symbols.", &cmdlist);
762 c->completer = filename_completer;
765 c = add_cmd ("exec-file", class_files, exec_file_command,
766 "Use FILE as program for getting contents of pure memory.\n\
767 If FILE cannot be found as specified, your execution directory path\n\
768 is searched for a command of that name.\n\
769 No arg means have no executable file.", &cmdlist);
770 c->completer = filename_completer;
772 add_com ("section", class_files, set_section_command,
773 "Change the base address of section SECTION of the exec file to ADDR.\n\
774 This can be used if the exec file does not contain section addresses,\n\
775 (such as in the a.out format), or when the addresses specified in the\n\
776 file itself are wrong. Each section must be changed separately. The\n\
777 ``info files'' command lists all the sections and their addresses.");
780 (add_set_cmd ("write", class_support, var_boolean, (char *)&write_files,
781 "Set writing into executable and core files.",
785 add_target (&exec_ops);