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 ((make_cleanup_func) freeargv, (char *) 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 fcntl (scratch_chan, F_SETFD, 1);
218 exec_bfd = bfd_fdopenr (scratch_pathname, gnutarget, scratch_chan);
221 error ("\"%s\": could not open as an executable file: %s",
222 scratch_pathname, bfd_errmsg (bfd_get_error ()));
224 /* At this point, scratch_pathname and exec_bfd->name both point to the
225 same malloc'd string. However exec_close() will attempt to free it
226 via the exec_bfd->name pointer, so we need to make another copy and
227 leave exec_bfd as the new owner of the original copy. */
228 scratch_pathname = strdup (scratch_pathname);
229 make_cleanup (free, scratch_pathname);
231 if (!bfd_check_format (exec_bfd, bfd_object))
233 /* Make sure to close exec_bfd, or else "run" might try to use
236 error ("\"%s\": not in executable format: %s",
237 scratch_pathname, bfd_errmsg (bfd_get_error ()));
240 /* FIXME - This should only be run for RS6000, but the ifdef is a poor
241 way to accomplish. */
242 #ifdef IBM6000_TARGET
243 /* Setup initial vmap. */
245 map_vmap (exec_bfd, 0);
248 /* Make sure to close exec_bfd, or else "run" might try to use
251 error ("\"%s\": can't find the file sections: %s",
252 scratch_pathname, bfd_errmsg (bfd_get_error ()));
254 #endif /* IBM6000_TARGET */
256 if (build_section_table (exec_bfd, &exec_ops.to_sections,
257 &exec_ops.to_sections_end))
259 /* Make sure to close exec_bfd, or else "run" might try to use
262 error ("\"%s\": can't find the file sections: %s",
263 scratch_pathname, bfd_errmsg (bfd_get_error ()));
266 /* text_end is sometimes used for where to put call dummies. A
267 few ports use these for other purposes too. */
268 if (NEED_TEXT_START_END)
270 struct section_table *p;
272 /* Set text_start to the lowest address of the start of any
273 readonly code section and set text_end to the highest
274 address of the end of any readonly code section. */
275 /* FIXME: The comment above does not match the code. The
276 code checks for sections with are either code *or*
278 text_start = ~(CORE_ADDR)0;
279 text_end = (CORE_ADDR)0;
280 for (p = exec_ops.to_sections; p < exec_ops.to_sections_end; p++)
281 if (bfd_get_section_flags (p->bfd, p->the_bfd_section)
282 & (SEC_CODE | SEC_READONLY))
284 if (text_start > p->addr)
285 text_start = p->addr;
286 if (text_end < p->endaddr)
287 text_end = p->endaddr;
293 set_gdbarch_from_file (exec_bfd);
295 push_target (&exec_ops);
297 /* Tell display code (if any) about the changed file name. */
298 if (exec_file_display_hook)
299 (*exec_file_display_hook) (filename);
302 printf_unfiltered ("No executable file now.\n");
305 /* Process the first arg in ARGS as the new exec file.
307 Note that we have to explicitly ignore additional args, since we can
308 be called from file_command(), which also calls symbol_file_command()
309 which can take multiple args. */
312 exec_file_command (args, from_tty)
319 target_preopen (from_tty);
321 exec_file_attach (args, 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 (arg, from_tty)
333 /* FIXME, if we lose on reading the symbol file, we should revert
334 the exec file, but that's rough. */
335 exec_file_command (arg, from_tty);
336 symbol_file_command (arg, from_tty);
337 if (file_changed_hook)
338 file_changed_hook (arg);
342 /* Locate all mappable sections of a BFD file.
343 table_pp_char is a char * to get it through bfd_map_over_sections;
344 we cast it back to its proper type. */
347 add_to_section_table (abfd, asect, table_pp_char)
352 struct section_table **table_pp = (struct section_table **)table_pp_char;
355 aflag = bfd_get_section_flags (abfd, asect);
356 if (!(aflag & SEC_ALLOC))
358 if (0 == bfd_section_size (abfd, asect))
360 (*table_pp)->bfd = abfd;
361 (*table_pp)->the_bfd_section = asect;
362 (*table_pp)->addr = bfd_section_vma (abfd, asect);
363 (*table_pp)->endaddr = (*table_pp)->addr + bfd_section_size (abfd, asect);
367 /* Builds a section table, given args BFD, SECTABLE_PTR, SECEND_PTR.
368 Returns 0 if OK, 1 on error. */
371 build_section_table (some_bfd, start, end)
373 struct section_table **start, **end;
377 count = bfd_count_sections (some_bfd);
380 *start = (struct section_table *) xmalloc (count * sizeof (**start));
382 bfd_map_over_sections (some_bfd, add_to_section_table, (char *)end);
383 if (*end > *start + count)
385 /* We could realloc the table, but it probably loses for most files. */
390 bfdsec_to_vmap(abfd, sect, arg3)
395 struct vmap_and_bfd *vmap_bfd = (struct vmap_and_bfd *) arg3;
398 vp = vmap_bfd->pvmap;
400 if ((bfd_get_section_flags (abfd, sect) & SEC_LOAD) == 0)
403 if (STREQ (bfd_section_name (abfd, sect), ".text"))
405 vp->tstart = bfd_section_vma (abfd, sect);
406 vp->tend = vp->tstart + bfd_section_size (abfd, sect);
407 vp->tvma = bfd_section_vma (abfd, sect);
408 vp->toffs = sect->filepos;
410 else if (STREQ (bfd_section_name (abfd, sect), ".data"))
412 vp->dstart = bfd_section_vma (abfd, sect);
413 vp->dend = vp->dstart + bfd_section_size (abfd, sect);
414 vp->dvma = bfd_section_vma (abfd, sect);
416 /* Silently ignore other types of sections. (FIXME?) */
419 /* Make a vmap for ABFD which might be a member of the archive ARCH.
420 Return the new vmap. */
423 map_vmap (abfd, arch)
427 struct vmap_and_bfd vmap_bfd;
428 struct vmap *vp, **vpp;
430 vp = (struct vmap *) xmalloc (sizeof (*vp));
431 memset ((char *) vp, '\0', sizeof (*vp));
434 vp->name = bfd_get_filename (arch ? arch : abfd);
435 vp->member = arch ? bfd_get_filename (abfd) : "";
437 vmap_bfd.pbfd = arch;
439 bfd_map_over_sections (abfd, bfdsec_to_vmap, &vmap_bfd);
441 /* Find the end of the list and append. */
442 for (vpp = &vmap; *vpp; vpp = &(*vpp)->nxt)
449 /* Read or write the exec file.
451 Args are address within a BFD file, address within gdb address-space,
452 length, and a flag indicating whether to read or write.
456 0: We cannot handle this address and length.
457 > 0: We have handled N bytes starting at this address.
458 (If N == length, we did it all.) We might be able
459 to handle more bytes beyond this length, but no
461 < 0: We cannot handle this address, but if somebody
462 else handles (-N) bytes, we can start from there.
464 The same routine is used to handle both core and exec files;
465 we just tail-call it with more arguments to select between them. */
468 xfer_memory (memaddr, myaddr, len, write, target)
473 struct target_ops *target;
476 struct section_table *p;
477 CORE_ADDR nextsectaddr, memend;
478 boolean (*xfer_fn) PARAMS ((bfd *, sec_ptr, PTR, file_ptr, bfd_size_type));
484 if (overlay_debugging)
486 section = find_pc_overlay (memaddr);
487 if (pc_in_unmapped_range (memaddr, section))
488 memaddr = overlay_mapped_address (memaddr, section);
491 memend = memaddr + len;
492 xfer_fn = write ? bfd_set_section_contents : bfd_get_section_contents;
493 nextsectaddr = memend;
495 #if 0 /* Stu's implementation */
496 /* If a section has been specified, try to use it. Note that we cannot use the
497 specified section directly. This is because it usually comes from the
498 symbol file, which may be different from the exec or core file. Instead, we
499 have to lookup the specified section by name in the bfd associated with
502 if (target_memory_bfd_section)
506 asection *target_section;
509 s = target_memory_bfd_section;
512 target_bfd = target->to_sections->bfd;
513 target_section = bfd_get_section_by_name (target_bfd, bfd_section_name (abfd, s));
518 bfd_size_type sec_size;
520 sec_addr = bfd_section_vma (target_bfd, target_section);
521 sec_size = target_section->_raw_size;
523 /* Make sure the requested memory starts inside the section. */
525 if (memaddr >= sec_addr
526 && memaddr < sec_addr + sec_size)
528 /* Cut back length in case request overflows the end of the section. */
529 len = min (len, sec_addr + sec_size - memaddr);
531 res = xfer_fn (target_bfd, target_section, myaddr, memaddr - sec_addr, len);
533 return res ? len : 0;
537 #endif /* 0, Stu's implementation */
538 for (p = target->to_sections; p < target->to_sections_end; p++)
540 if (overlay_debugging && section && p->the_bfd_section &&
541 strcmp (section->name, p->the_bfd_section->name) != 0)
542 continue; /* not the section we need */
543 if (memaddr >= p->addr)
544 if (memend <= p->endaddr)
546 /* Entire transfer is within this section. */
547 res = xfer_fn (p->bfd, p->the_bfd_section, myaddr,
548 memaddr - p->addr, len);
549 return (res != 0) ? len : 0;
551 else if (memaddr >= p->endaddr)
553 /* This section ends before the transfer starts. */
558 /* This section overlaps the transfer. Just do half. */
559 len = p->endaddr - memaddr;
560 res = xfer_fn (p->bfd, p->the_bfd_section, myaddr,
561 memaddr - p->addr, len);
562 return (res != 0) ? len : 0;
565 nextsectaddr = min (nextsectaddr, p->addr);
568 if (nextsectaddr >= memend)
569 return 0; /* We can't help */
571 return - (nextsectaddr - memaddr); /* Next boundary where we can help */
575 #ifdef REG_STACK_SEGMENT
577 /* Pyramids and AM29000s have an extra segment in the virtual address space
578 for the (control) stack of register-window frames. The AM29000 folk
579 call it the "register stack" rather than the "memory stack". */
580 else if (memaddr >= reg_stack_start && memaddr < reg_stack_end)
582 i = min (len, reg_stack_end - memaddr);
583 fileptr = memaddr - reg_stack_start + reg_stack_offset;
584 wanna_xfer = coredata;
586 #endif /* REG_STACK_SEGMENT */
590 print_section_info (t, abfd)
591 struct target_ops *t;
594 struct section_table *p;
596 printf_filtered ("\t`%s', ", bfd_get_filename(abfd));
598 printf_filtered ("file type %s.\n", bfd_get_target(abfd));
599 if (abfd == exec_bfd)
601 printf_filtered ("\tEntry point: ");
602 print_address_numeric (bfd_get_start_address (abfd), 1, gdb_stdout);
603 printf_filtered ("\n");
605 for (p = t->to_sections; p < t->to_sections_end; p++)
607 /* FIXME-32x64 need a print_address_numeric with field width */
608 printf_filtered ("\t%s", local_hex_string_custom ((unsigned long) p->addr, "08l"));
609 printf_filtered (" - %s", local_hex_string_custom ((unsigned long) p->endaddr, "08l"));
611 printf_filtered (" @ %s",
612 local_hex_string_custom ((unsigned long) p->the_bfd_section->filepos, "08l"));
613 printf_filtered (" is %s", bfd_section_name (p->bfd, p->the_bfd_section));
616 printf_filtered (" in %s", bfd_get_filename (p->bfd));
618 printf_filtered ("\n");
624 struct target_ops *t;
626 print_section_info (t, exec_bfd);
632 printf_unfiltered ("\tMapping info for file `%s'.\n", vmap->name);
633 printf_unfiltered ("\t %8.8s %8.8s %8.8s %8.8s %8.8s %s\n",
634 "tstart", "tend", "dstart", "dend", "section",
637 for (vp = vmap; vp; vp = vp->nxt)
638 printf_unfiltered ("\t0x%8.8x 0x%8.8x 0x%8.8x 0x%8.8x %s%s%s%s\n",
639 vp->tstart, vp->tend, vp->dstart, vp->dend, vp->name,
640 *vp->member ? "(" : "", vp->member,
641 *vp->member ? ")" : "");
646 set_section_command (args, from_tty)
650 struct section_table *p;
653 unsigned long secaddr;
658 error ("Must specify section name and its virtual address");
660 /* Parse out section name */
661 for (secname = args; !isspace(*args); args++) ;
662 seclen = args - secname;
664 /* Parse out new virtual address */
665 secaddr = parse_and_eval_address (args);
667 for (p = exec_ops.to_sections; p < exec_ops.to_sections_end; p++) {
668 if (!strncmp (secname, bfd_section_name (exec_bfd, p->the_bfd_section), seclen)
669 && bfd_section_name (exec_bfd, p->the_bfd_section)[seclen] == '\0') {
670 offset = secaddr - p->addr;
672 p->endaddr += offset;
674 exec_files_info(&exec_ops);
678 if (seclen >= sizeof (secprint))
679 seclen = sizeof (secprint) - 1;
680 strncpy (secprint, secname, seclen);
681 secprint[seclen] = '\0';
682 error ("Section %s not found", secprint);
685 /* If mourn is being called in all the right places, this could be say
686 `gdb internal error' (since generic_mourn calls
687 breakpoint_init_inferior). */
690 ignore (addr, contents)
697 /* Fill in the exec file target vector. Very few entries need to be
703 exec_ops.to_shortname = "exec";
704 exec_ops.to_longname = "Local exec file";
705 exec_ops.to_doc = "Use an executable file as a target.\n\
706 Specify the filename of the executable file.";
707 exec_ops.to_open = exec_file_command;
708 exec_ops.to_close = exec_close;
709 exec_ops.to_attach = find_default_attach;
710 exec_ops.to_require_attach = find_default_require_attach;
711 exec_ops.to_require_detach = find_default_require_detach;
712 exec_ops.to_xfer_memory = xfer_memory;
713 exec_ops.to_files_info = exec_files_info;
714 exec_ops.to_insert_breakpoint = ignore;
715 exec_ops.to_remove_breakpoint = ignore;
716 exec_ops.to_create_inferior = find_default_create_inferior;
717 exec_ops.to_clone_and_follow_inferior = find_default_clone_and_follow_inferior;
718 exec_ops.to_stratum = file_stratum;
719 exec_ops.to_has_memory = 1;
720 exec_ops.to_magic = OPS_MAGIC;
726 struct cmd_list_element *c;
732 c = add_cmd ("file", class_files, file_command,
733 "Use FILE as program to be debugged.\n\
734 It is read for its symbols, for getting the contents of pure memory,\n\
735 and it is the program executed when you use the `run' command.\n\
736 If FILE cannot be found as specified, your execution directory path\n\
737 ($PATH) is searched for a command of that name.\n\
738 No arg means to have no executable file and no symbols.", &cmdlist);
739 c->completer = filename_completer;
742 c = add_cmd ("exec-file", class_files, exec_file_command,
743 "Use FILE as program for getting contents of pure memory.\n\
744 If FILE cannot be found as specified, your execution directory path\n\
745 is searched for a command of that name.\n\
746 No arg means have no executable file.", &cmdlist);
747 c->completer = filename_completer;
749 add_com ("section", class_files, set_section_command,
750 "Change the base address of section SECTION of the exec file to ADDR.\n\
751 This can be used if the exec file does not contain section addresses,\n\
752 (such as in the a.out format), or when the addresses specified in the\n\
753 file itself are wrong. Each section must be changed separately. The\n\
754 ``info files'' command lists all the sections and their addresses.");
757 (add_set_cmd ("write", class_support, var_boolean, (char *)&write_files,
758 "Set writing into executable and core files.",
762 add_target (&exec_ops);