1 /* Work with executable files, for GDB.
2 Copyright 1988, 1989, 1991, 1992, 1993, 1994, 1997, 1998, 2001
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,
20 Boston, MA 02111-1307, USA. */
30 #include "completer.h"
33 #include <sys/types.h>
37 #include "gdb_string.h"
47 #include "xcoffsolib.h"
49 struct vmap *map_vmap (bfd *, bfd *);
51 void (*file_changed_hook) (char *);
53 /* Prototypes for local functions */
55 static void add_to_section_table (bfd *, sec_ptr, PTR);
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 void bfdsec_to_vmap (bfd *, sec_ptr, PTR);
67 static int ignore (CORE_ADDR, char *);
69 static void init_exec_ops (void);
71 void _initialize_exec (void);
73 extern int info_verbose;
75 /* The target vector for executable files. */
77 struct target_ops exec_ops;
79 /* The Binary File Descriptor handle for the executable file. */
83 /* Whether to open exec and core files read-only or read-write. */
87 /* Text start and end addresses (KLUDGE) if needed */
89 #ifndef NEED_TEXT_START_END
90 #define NEED_TEXT_START_END (0)
92 CORE_ADDR text_start = 0;
93 CORE_ADDR text_end = 0;
98 exec_open (char *args, int from_tty)
100 target_preopen (from_tty);
101 exec_file_attach (args, from_tty);
106 exec_close (int quitting)
108 int need_symtab_cleanup = 0;
109 struct vmap *vp, *nxt;
111 for (nxt = vmap; nxt != NULL;)
116 /* if there is an objfile associated with this bfd,
117 free_objfile() will do proper cleanup of objfile *and* bfd. */
121 free_objfile (vp->objfile);
122 need_symtab_cleanup = 1;
124 else if (vp->bfd != exec_bfd)
125 /* FIXME-leak: We should be freeing vp->name too, I think. */
126 if (!bfd_close (vp->bfd))
127 warning ("cannot close \"%s\": %s",
128 vp->name, bfd_errmsg (bfd_get_error ()));
130 /* FIXME: This routine is #if 0'd in symfile.c. What should we
131 be doing here? Should we just free everything in
132 vp->objfile->symtabs? Should free_objfile do that?
133 FIXME-as-well: free_objfile already free'd vp->name, so it isn't
135 free_named_symtabs (vp->name);
143 char *name = bfd_get_filename (exec_bfd);
145 if (!bfd_close (exec_bfd))
146 warning ("cannot close \"%s\": %s",
147 name, bfd_errmsg (bfd_get_error ()));
152 if (exec_ops.to_sections)
154 xfree (exec_ops.to_sections);
155 exec_ops.to_sections = NULL;
156 exec_ops.to_sections_end = NULL;
161 exec_file_clear (int from_tty)
163 /* Remove exec file. */
164 unpush_target (&exec_ops);
167 printf_unfiltered ("No executable file now.\n");
170 /* Process the first arg in ARGS as the new exec file.
172 This function is intended to be behave essentially the same
173 as exec_file_command, except that the latter will detect when
174 a target is being debugged, and will ask the user whether it
175 should be shut down first. (If the answer is "no", then the
176 new file is ignored.)
178 This file is used by exec_file_command, to do the work of opening
179 and processing the exec file after any prompting has happened.
181 And, it is used by child_attach, when the attach command was
182 given a pid but not a exec pathname, and the attach command could
183 figure out the pathname from the pid. (In this case, we shouldn't
184 ask the user whether the current target should be shut down --
185 we're supplying the exec pathname late for good reason.)
187 ARGS is assumed to be the filename. */
190 exec_file_attach (char *filename, int from_tty)
192 /* Remove any previous exec file. */
193 unpush_target (&exec_ops);
195 /* Now open and digest the file the user requested, if any. */
200 printf_unfiltered ("No executable file now.\n");
204 char *scratch_pathname;
207 scratch_chan = openp (getenv ("PATH"), 1, filename,
208 write_files ? O_RDWR | O_BINARY : O_RDONLY | O_BINARY, 0,
210 #if defined(__GO32__) || defined(_WIN32) || defined(__CYGWIN__)
211 if (scratch_chan < 0)
213 char *exename = alloca (strlen (filename) + 5);
214 strcat (strcpy (exename, filename), ".exe");
215 scratch_chan = openp (getenv ("PATH"), 1, exename, write_files ?
216 O_RDWR | O_BINARY : O_RDONLY | O_BINARY, 0, &scratch_pathname);
219 if (scratch_chan < 0)
220 perror_with_name (filename);
221 exec_bfd = bfd_fdopenr (scratch_pathname, gnutarget, scratch_chan);
224 error ("\"%s\": could not open as an executable file: %s",
225 scratch_pathname, bfd_errmsg (bfd_get_error ()));
227 /* At this point, scratch_pathname and exec_bfd->name both point to the
228 same malloc'd string. However exec_close() will attempt to free it
229 via the exec_bfd->name pointer, so we need to make another copy and
230 leave exec_bfd as the new owner of the original copy. */
231 scratch_pathname = xstrdup (scratch_pathname);
232 make_cleanup (xfree, scratch_pathname);
234 if (!bfd_check_format (exec_bfd, bfd_object))
236 /* Make sure to close exec_bfd, or else "run" might try to use
239 error ("\"%s\": not in executable format: %s",
240 scratch_pathname, bfd_errmsg (bfd_get_error ()));
243 /* FIXME - This should only be run for RS6000, but the ifdef is a poor
244 way to accomplish. */
245 #ifdef IBM6000_TARGET
246 /* Setup initial vmap. */
248 map_vmap (exec_bfd, 0);
251 /* Make sure to close exec_bfd, or else "run" might try to use
254 error ("\"%s\": can't find the file sections: %s",
255 scratch_pathname, bfd_errmsg (bfd_get_error ()));
257 #endif /* IBM6000_TARGET */
259 if (build_section_table (exec_bfd, &exec_ops.to_sections,
260 &exec_ops.to_sections_end))
262 /* Make sure to close exec_bfd, or else "run" might try to use
265 error ("\"%s\": can't find the file sections: %s",
266 scratch_pathname, bfd_errmsg (bfd_get_error ()));
269 /* text_end is sometimes used for where to put call dummies. A
270 few ports use these for other purposes too. */
271 if (NEED_TEXT_START_END)
273 struct section_table *p;
275 /* Set text_start to the lowest address of the start of any
276 readonly code section and set text_end to the highest
277 address of the end of any readonly code section. */
278 /* FIXME: The comment above does not match the code. The
279 code checks for sections with are either code *or*
281 text_start = ~(CORE_ADDR) 0;
282 text_end = (CORE_ADDR) 0;
283 for (p = exec_ops.to_sections; p < exec_ops.to_sections_end; p++)
284 if (bfd_get_section_flags (p->bfd, p->the_bfd_section)
285 & (SEC_CODE | SEC_READONLY))
287 if (text_start > p->addr)
288 text_start = p->addr;
289 if (text_end < p->endaddr)
290 text_end = p->endaddr;
296 set_gdbarch_from_file (exec_bfd);
298 push_target (&exec_ops);
300 /* Tell display code (if any) about the changed file name. */
301 if (exec_file_display_hook)
302 (*exec_file_display_hook) (filename);
306 /* Process the first arg in ARGS as the new exec file.
308 Note that we have to explicitly ignore additional args, since we can
309 be called from file_command(), which also calls symbol_file_command()
310 which can take multiple args.
312 If ARGS is NULL, we just want to close the exec file. */
315 exec_file_command (char *args, int from_tty)
320 target_preopen (from_tty);
324 /* Scan through the args and pick up the first non option arg
327 argv = buildargv (args);
331 make_cleanup_freeargv (argv);
333 for (; (*argv != NULL) && (**argv == '-'); argv++)
337 error ("No executable file name was specified");
339 filename = tilde_expand (*argv);
340 make_cleanup (xfree, filename);
341 exec_file_attach (filename, from_tty);
344 exec_file_attach (NULL, from_tty);
347 /* Set both the exec file and the symbol file, in one command.
348 What a novelty. Why did GDB go through four major releases before this
349 command was added? */
352 file_command (char *arg, int from_tty)
354 /* FIXME, if we lose on reading the symbol file, we should revert
355 the exec file, but that's rough. */
356 exec_file_command (arg, from_tty);
357 symbol_file_command (arg, from_tty);
358 if (file_changed_hook)
359 file_changed_hook (arg);
363 /* Locate all mappable sections of a BFD file.
364 table_pp_char is a char * to get it through bfd_map_over_sections;
365 we cast it back to its proper type. */
368 add_to_section_table (bfd *abfd, sec_ptr asect, PTR table_pp_char)
370 struct section_table **table_pp = (struct section_table **) table_pp_char;
373 aflag = bfd_get_section_flags (abfd, asect);
374 if (!(aflag & SEC_ALLOC))
376 if (0 == bfd_section_size (abfd, asect))
378 (*table_pp)->bfd = abfd;
379 (*table_pp)->the_bfd_section = asect;
380 (*table_pp)->addr = bfd_section_vma (abfd, asect);
381 (*table_pp)->endaddr = (*table_pp)->addr + bfd_section_size (abfd, asect);
385 /* Builds a section table, given args BFD, SECTABLE_PTR, SECEND_PTR.
386 Returns 0 if OK, 1 on error. */
389 build_section_table (bfd *some_bfd, struct section_table **start,
390 struct section_table **end)
394 count = bfd_count_sections (some_bfd);
397 *start = (struct section_table *) xmalloc (count * sizeof (**start));
399 bfd_map_over_sections (some_bfd, add_to_section_table, (char *) end);
400 if (*end > *start + count)
401 internal_error (__FILE__, __LINE__, "failed internal consistency check");
402 /* We could realloc the table, but it probably loses for most files. */
407 bfdsec_to_vmap (bfd *abfd, sec_ptr sect, PTR arg3)
409 struct vmap_and_bfd *vmap_bfd = (struct vmap_and_bfd *) arg3;
412 vp = vmap_bfd->pvmap;
414 if ((bfd_get_section_flags (abfd, sect) & SEC_LOAD) == 0)
417 if (STREQ (bfd_section_name (abfd, sect), ".text"))
419 vp->tstart = bfd_section_vma (abfd, sect);
420 vp->tend = vp->tstart + bfd_section_size (abfd, sect);
421 vp->tvma = bfd_section_vma (abfd, sect);
422 vp->toffs = sect->filepos;
424 else if (STREQ (bfd_section_name (abfd, sect), ".data"))
426 vp->dstart = bfd_section_vma (abfd, sect);
427 vp->dend = vp->dstart + bfd_section_size (abfd, sect);
428 vp->dvma = bfd_section_vma (abfd, sect);
430 /* Silently ignore other types of sections. (FIXME?) */
433 /* Make a vmap for ABFD which might be a member of the archive ARCH.
434 Return the new vmap. */
437 map_vmap (bfd *abfd, bfd *arch)
439 struct vmap_and_bfd vmap_bfd;
440 struct vmap *vp, **vpp;
442 vp = (struct vmap *) xmalloc (sizeof (*vp));
443 memset ((char *) vp, '\0', sizeof (*vp));
446 vp->name = bfd_get_filename (arch ? arch : abfd);
447 vp->member = arch ? bfd_get_filename (abfd) : "";
449 vmap_bfd.pbfd = arch;
451 bfd_map_over_sections (abfd, bfdsec_to_vmap, &vmap_bfd);
453 /* Find the end of the list and append. */
454 for (vpp = &vmap; *vpp; vpp = &(*vpp)->nxt)
461 /* Read or write the exec file.
463 Args are address within a BFD file, address within gdb address-space,
464 length, and a flag indicating whether to read or write.
468 0: We cannot handle this address and length.
469 > 0: We have handled N bytes starting at this address.
470 (If N == length, we did it all.) We might be able
471 to handle more bytes beyond this length, but no
473 < 0: We cannot handle this address, but if somebody
474 else handles (-N) bytes, we can start from there.
476 The same routine is used to handle both core and exec files;
477 we just tail-call it with more arguments to select between them. */
480 xfer_memory (CORE_ADDR memaddr, char *myaddr, int len, int write,
481 struct mem_attrib *attrib,
482 struct target_ops *target)
485 struct section_table *p;
486 CORE_ADDR nextsectaddr, memend;
487 boolean (*xfer_fn) (bfd *, sec_ptr, PTR, file_ptr, bfd_size_type);
491 internal_error (__FILE__, __LINE__, "failed internal consistency check");
493 if (overlay_debugging)
495 section = find_pc_overlay (memaddr);
496 if (pc_in_unmapped_range (memaddr, section))
497 memaddr = overlay_mapped_address (memaddr, section);
500 memend = memaddr + len;
501 xfer_fn = write ? bfd_set_section_contents : bfd_get_section_contents;
502 nextsectaddr = memend;
504 for (p = target->to_sections; p < target->to_sections_end; p++)
506 if (overlay_debugging && section && p->the_bfd_section &&
507 strcmp (section->name, p->the_bfd_section->name) != 0)
508 continue; /* not the section we need */
509 if (memaddr >= p->addr)
510 if (memend <= p->endaddr)
512 /* Entire transfer is within this section. */
513 res = xfer_fn (p->bfd, p->the_bfd_section, myaddr,
514 memaddr - p->addr, len);
515 return (res != 0) ? len : 0;
517 else if (memaddr >= p->endaddr)
519 /* This section ends before the transfer starts. */
524 /* This section overlaps the transfer. Just do half. */
525 len = p->endaddr - memaddr;
526 res = xfer_fn (p->bfd, p->the_bfd_section, myaddr,
527 memaddr - p->addr, len);
528 return (res != 0) ? len : 0;
531 nextsectaddr = min (nextsectaddr, p->addr);
534 if (nextsectaddr >= memend)
535 return 0; /* We can't help */
537 return -(nextsectaddr - memaddr); /* Next boundary where we can help */
542 print_section_info (struct target_ops *t, bfd *abfd)
544 struct section_table *p;
546 printf_filtered ("\t`%s', ", bfd_get_filename (abfd));
548 printf_filtered ("file type %s.\n", bfd_get_target (abfd));
549 if (abfd == exec_bfd)
551 printf_filtered ("\tEntry point: ");
552 print_address_numeric (bfd_get_start_address (abfd), 1, gdb_stdout);
553 printf_filtered ("\n");
555 for (p = t->to_sections; p < t->to_sections_end; p++)
557 /* FIXME-32x64 need a print_address_numeric with field width */
558 printf_filtered ("\t%s", local_hex_string_custom ((unsigned long) p->addr, "08l"));
559 printf_filtered (" - %s", local_hex_string_custom ((unsigned long) p->endaddr, "08l"));
561 printf_filtered (" @ %s",
562 local_hex_string_custom ((unsigned long) p->the_bfd_section->filepos, "08l"));
563 printf_filtered (" is %s", bfd_section_name (p->bfd, p->the_bfd_section));
566 printf_filtered (" in %s", bfd_get_filename (p->bfd));
568 printf_filtered ("\n");
573 exec_files_info (struct target_ops *t)
575 print_section_info (t, exec_bfd);
581 printf_unfiltered ("\tMapping info for file `%s'.\n", vmap->name);
582 printf_unfiltered ("\t %*s %*s %*s %*s %8.8s %s\n",
583 strlen_paddr (), "tstart",
584 strlen_paddr (), "tend",
585 strlen_paddr (), "dstart",
586 strlen_paddr (), "dend",
590 for (vp = vmap; vp; vp = vp->nxt)
591 printf_unfiltered ("\t0x%s 0x%s 0x%s 0x%s %s%s%s%s\n",
597 *vp->member ? "(" : "", vp->member,
598 *vp->member ? ")" : "");
603 exec_set_section_offsets sets the offsets of all the sections
604 in the exec objfile. */
607 exec_set_section_offsets (bfd_signed_vma text_off, bfd_signed_vma data_off,
608 bfd_signed_vma bss_off)
610 struct section_table *sect;
612 for (sect = exec_ops.to_sections;
613 sect < exec_ops.to_sections_end;
618 flags = bfd_get_section_flags (exec_bfd, sect->the_bfd_section);
620 if (flags & SEC_CODE)
622 sect->addr += text_off;
623 sect->endaddr += text_off;
625 else if (flags & (SEC_DATA | SEC_LOAD))
627 sect->addr += data_off;
628 sect->endaddr += data_off;
630 else if (flags & SEC_ALLOC)
632 sect->addr += bss_off;
633 sect->endaddr += bss_off;
639 set_section_command (char *args, int from_tty)
641 struct section_table *p;
644 unsigned long secaddr;
649 error ("Must specify section name and its virtual address");
651 /* Parse out section name */
652 for (secname = args; !isspace (*args); args++);
653 seclen = args - secname;
655 /* Parse out new virtual address */
656 secaddr = parse_and_eval_address (args);
658 for (p = exec_ops.to_sections; p < exec_ops.to_sections_end; p++)
660 if (!strncmp (secname, bfd_section_name (exec_bfd, p->the_bfd_section), seclen)
661 && bfd_section_name (exec_bfd, p->the_bfd_section)[seclen] == '\0')
663 offset = secaddr - p->addr;
665 p->endaddr += offset;
667 exec_files_info (&exec_ops);
671 if (seclen >= sizeof (secprint))
672 seclen = sizeof (secprint) - 1;
673 strncpy (secprint, secname, seclen);
674 secprint[seclen] = '\0';
675 error ("Section %s not found", secprint);
678 /* If mourn is being called in all the right places, this could be say
679 `gdb internal error' (since generic_mourn calls
680 breakpoint_init_inferior). */
683 ignore (CORE_ADDR addr, char *contents)
688 /* Fill in the exec file target vector. Very few entries need to be
694 exec_ops.to_shortname = "exec";
695 exec_ops.to_longname = "Local exec file";
696 exec_ops.to_doc = "Use an executable file as a target.\n\
697 Specify the filename of the executable file.";
698 exec_ops.to_open = exec_open;
699 exec_ops.to_close = exec_close;
700 exec_ops.to_attach = find_default_attach;
701 exec_ops.to_require_attach = find_default_require_attach;
702 exec_ops.to_require_detach = find_default_require_detach;
703 exec_ops.to_xfer_memory = xfer_memory;
704 exec_ops.to_files_info = exec_files_info;
705 exec_ops.to_insert_breakpoint = ignore;
706 exec_ops.to_remove_breakpoint = ignore;
707 exec_ops.to_create_inferior = find_default_create_inferior;
708 exec_ops.to_clone_and_follow_inferior = find_default_clone_and_follow_inferior;
709 exec_ops.to_stratum = file_stratum;
710 exec_ops.to_has_memory = 1;
711 exec_ops.to_magic = OPS_MAGIC;
715 _initialize_exec (void)
717 struct cmd_list_element *c;
723 c = add_cmd ("file", class_files, file_command,
724 "Use FILE as program to be debugged.\n\
725 It is read for its symbols, for getting the contents of pure memory,\n\
726 and it is the program executed when you use the `run' command.\n\
727 If FILE cannot be found as specified, your execution directory path\n\
728 ($PATH) is searched for a command of that name.\n\
729 No arg means to have no executable file and no symbols.", &cmdlist);
730 c->completer = filename_completer;
733 c = add_cmd ("exec-file", class_files, exec_file_command,
734 "Use FILE as program for getting contents of pure memory.\n\
735 If FILE cannot be found as specified, your execution directory path\n\
736 is searched for a command of that name.\n\
737 No arg means have no executable file.", &cmdlist);
738 c->completer = filename_completer;
740 add_com ("section", class_files, set_section_command,
741 "Change the base address of section SECTION of the exec file to ADDR.\n\
742 This can be used if the exec file does not contain section addresses,\n\
743 (such as in the a.out format), or when the addresses specified in the\n\
744 file itself are wrong. Each section must be changed separately. The\n\
745 ``info files'' command lists all the sections and their addresses.");
748 (add_set_cmd ("write", class_support, var_boolean, (char *) &write_files,
749 "Set writing into executable and core files.",
753 add_target (&exec_ops);