1 /* Work with executable files, for GDB.
3 Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997,
4 1998, 1999, 2000, 2001, 2002, 2003, 2007 Free Software Foundation, Inc.
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
29 #include "completer.h"
35 #include "readline/readline.h"
36 #include "gdb_string.h"
43 #include "xcoffsolib.h"
45 struct vmap
*map_vmap (bfd
*, bfd
*);
47 void (*deprecated_file_changed_hook
) (char *);
49 /* Prototypes for local functions */
51 static void exec_close (int);
53 static void file_command (char *, int);
55 static void set_section_command (char *, int);
57 static void exec_files_info (struct target_ops
*);
59 static void init_exec_ops (void);
61 void _initialize_exec (void);
63 /* The target vector for executable files. */
65 struct target_ops exec_ops
;
67 /* The Binary File Descriptor handle for the executable file. */
71 /* Whether to open exec and core files read-only or read-write. */
75 show_write_files (struct ui_file
*file
, int from_tty
,
76 struct cmd_list_element
*c
, const char *value
)
78 fprintf_filtered (file
, _("Writing into executable and core files is %s.\n"),
86 exec_open (char *args
, int from_tty
)
88 target_preopen (from_tty
);
89 exec_file_attach (args
, from_tty
);
93 exec_close (int quitting
)
95 int need_symtab_cleanup
= 0;
96 struct vmap
*vp
, *nxt
;
98 for (nxt
= vmap
; nxt
!= NULL
;)
103 /* if there is an objfile associated with this bfd,
104 free_objfile() will do proper cleanup of objfile *and* bfd. */
108 free_objfile (vp
->objfile
);
109 need_symtab_cleanup
= 1;
111 else if (vp
->bfd
!= exec_bfd
)
112 /* FIXME-leak: We should be freeing vp->name too, I think. */
113 if (!bfd_close (vp
->bfd
))
114 warning (_("cannot close \"%s\": %s"),
115 vp
->name
, bfd_errmsg (bfd_get_error ()));
117 /* FIXME: This routine is #if 0'd in symfile.c. What should we
118 be doing here? Should we just free everything in
119 vp->objfile->symtabs? Should free_objfile do that?
120 FIXME-as-well: free_objfile already free'd vp->name, so it isn't
122 free_named_symtabs (vp
->name
);
130 char *name
= bfd_get_filename (exec_bfd
);
132 if (!bfd_close (exec_bfd
))
133 warning (_("cannot close \"%s\": %s"),
134 name
, bfd_errmsg (bfd_get_error ()));
139 if (exec_ops
.to_sections
)
141 xfree (exec_ops
.to_sections
);
142 exec_ops
.to_sections
= NULL
;
143 exec_ops
.to_sections_end
= NULL
;
148 exec_file_clear (int from_tty
)
150 /* Remove exec file. */
151 unpush_target (&exec_ops
);
154 printf_unfiltered (_("No executable file now.\n"));
157 /* Process the first arg in ARGS as the new exec file.
159 This function is intended to be behave essentially the same
160 as exec_file_command, except that the latter will detect when
161 a target is being debugged, and will ask the user whether it
162 should be shut down first. (If the answer is "no", then the
163 new file is ignored.)
165 This file is used by exec_file_command, to do the work of opening
166 and processing the exec file after any prompting has happened.
168 And, it is used by child_attach, when the attach command was
169 given a pid but not a exec pathname, and the attach command could
170 figure out the pathname from the pid. (In this case, we shouldn't
171 ask the user whether the current target should be shut down --
172 we're supplying the exec pathname late for good reason.)
174 ARGS is assumed to be the filename. */
177 exec_file_attach (char *filename
, int from_tty
)
179 /* Remove any previous exec file. */
180 unpush_target (&exec_ops
);
182 /* Now open and digest the file the user requested, if any. */
187 printf_unfiltered (_("No executable file now.\n"));
189 set_gdbarch_from_file (NULL
);
193 char *scratch_pathname
;
196 scratch_chan
= openp (getenv ("PATH"), OPF_TRY_CWD_FIRST
, filename
,
197 write_files
? O_RDWR
| O_BINARY
: O_RDONLY
| O_BINARY
, 0,
199 #if defined(__GO32__) || defined(_WIN32) || defined(__CYGWIN__)
200 if (scratch_chan
< 0)
202 char *exename
= alloca (strlen (filename
) + 5);
203 strcat (strcpy (exename
, filename
), ".exe");
204 scratch_chan
= openp (getenv ("PATH"), OPF_TRY_CWD_FIRST
, exename
,
205 write_files
? O_RDWR
| O_BINARY
: O_RDONLY
| O_BINARY
, 0,
209 if (scratch_chan
< 0)
210 perror_with_name (filename
);
211 exec_bfd
= bfd_fopen (scratch_pathname
, gnutarget
,
212 write_files
? FOPEN_RUB
: FOPEN_RB
,
216 error (_("\"%s\": could not open as an executable file: %s"),
217 scratch_pathname
, bfd_errmsg (bfd_get_error ()));
219 /* At this point, scratch_pathname and exec_bfd->name both point to the
220 same malloc'd string. However exec_close() will attempt to free it
221 via the exec_bfd->name pointer, so we need to make another copy and
222 leave exec_bfd as the new owner of the original copy. */
223 scratch_pathname
= xstrdup (scratch_pathname
);
224 make_cleanup (xfree
, scratch_pathname
);
226 if (!bfd_check_format (exec_bfd
, bfd_object
))
228 /* Make sure to close exec_bfd, or else "run" might try to use
231 error (_("\"%s\": not in executable format: %s"),
232 scratch_pathname
, bfd_errmsg (bfd_get_error ()));
235 /* FIXME - This should only be run for RS6000, but the ifdef is a poor
236 way to accomplish. */
237 #ifdef DEPRECATED_IBM6000_TARGET
238 /* Setup initial vmap. */
240 map_vmap (exec_bfd
, 0);
243 /* Make sure to close exec_bfd, or else "run" might try to use
246 error (_("\"%s\": can't find the file sections: %s"),
247 scratch_pathname
, bfd_errmsg (bfd_get_error ()));
249 #endif /* DEPRECATED_IBM6000_TARGET */
251 if (build_section_table (exec_bfd
, &exec_ops
.to_sections
,
252 &exec_ops
.to_sections_end
))
254 /* Make sure to close exec_bfd, or else "run" might try to use
257 error (_("\"%s\": can't find the file sections: %s"),
258 scratch_pathname
, bfd_errmsg (bfd_get_error ()));
263 set_gdbarch_from_file (exec_bfd
);
265 push_target (&exec_ops
);
267 /* Tell display code (if any) about the changed file name. */
268 if (deprecated_exec_file_display_hook
)
269 (*deprecated_exec_file_display_hook
) (filename
);
271 bfd_cache_close_all ();
272 observer_notify_executable_changed (NULL
);
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 if (from_tty
&& target_has_execution
290 && !query (_("A program is being debugged already.\n"
291 "Are you sure you want to change the file? ")))
292 error (_("File not changed."));
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 /* Check the section flags, but do not discard zero-length sections, since
347 some symbols may still be attached to this section. For instance, we
348 encountered on sparc-solaris 2.10 a shared library with an empty .bss
349 section to which a symbol named "_end" was attached. The address
350 of this symbol still needs to be relocated. */
351 aflag
= bfd_get_section_flags (abfd
, asect
);
352 if (!(aflag
& SEC_ALLOC
))
355 (*table_pp
)->bfd
= abfd
;
356 (*table_pp
)->the_bfd_section
= asect
;
357 (*table_pp
)->addr
= bfd_section_vma (abfd
, asect
);
358 (*table_pp
)->endaddr
= (*table_pp
)->addr
+ bfd_section_size (abfd
, asect
);
362 /* Builds a section table, given args BFD, SECTABLE_PTR, SECEND_PTR.
363 Returns 0 if OK, 1 on error. */
366 build_section_table (struct bfd
*some_bfd
, struct section_table
**start
,
367 struct section_table
**end
)
371 count
= bfd_count_sections (some_bfd
);
374 *start
= (struct section_table
*) xmalloc (count
* sizeof (**start
));
376 bfd_map_over_sections (some_bfd
, add_to_section_table
, (char *) end
);
377 if (*end
> *start
+ count
)
378 internal_error (__FILE__
, __LINE__
, _("failed internal consistency check"));
379 /* We could realloc the table, but it probably loses for most files. */
384 bfdsec_to_vmap (struct bfd
*abfd
, struct bfd_section
*sect
, void *arg3
)
386 struct vmap_and_bfd
*vmap_bfd
= (struct vmap_and_bfd
*) arg3
;
389 vp
= vmap_bfd
->pvmap
;
391 if ((bfd_get_section_flags (abfd
, sect
) & SEC_LOAD
) == 0)
394 if (strcmp (bfd_section_name (abfd
, sect
), ".text") == 0)
396 vp
->tstart
= bfd_section_vma (abfd
, sect
);
397 vp
->tend
= vp
->tstart
+ bfd_section_size (abfd
, sect
);
398 vp
->tvma
= bfd_section_vma (abfd
, sect
);
399 vp
->toffs
= sect
->filepos
;
401 else if (strcmp (bfd_section_name (abfd
, sect
), ".data") == 0)
403 vp
->dstart
= bfd_section_vma (abfd
, sect
);
404 vp
->dend
= vp
->dstart
+ bfd_section_size (abfd
, sect
);
405 vp
->dvma
= bfd_section_vma (abfd
, sect
);
407 /* Silently ignore other types of sections. (FIXME?) */
410 /* Make a vmap for ABFD which might be a member of the archive ARCH.
411 Return the new vmap. */
414 map_vmap (bfd
*abfd
, bfd
*arch
)
416 struct vmap_and_bfd vmap_bfd
;
417 struct vmap
*vp
, **vpp
;
419 vp
= (struct vmap
*) xmalloc (sizeof (*vp
));
420 memset ((char *) vp
, '\0', sizeof (*vp
));
423 vp
->name
= bfd_get_filename (arch
? arch
: abfd
);
424 vp
->member
= arch
? bfd_get_filename (abfd
) : "";
426 vmap_bfd
.pbfd
= arch
;
428 bfd_map_over_sections (abfd
, bfdsec_to_vmap
, &vmap_bfd
);
430 /* Find the end of the list and append. */
431 for (vpp
= &vmap
; *vpp
; vpp
= &(*vpp
)->nxt
)
438 /* Read or write the exec file.
440 Args are address within a BFD file, address within gdb address-space,
441 length, and a flag indicating whether to read or write.
445 0: We cannot handle this address and length.
446 > 0: We have handled N bytes starting at this address.
447 (If N == length, we did it all.) We might be able
448 to handle more bytes beyond this length, but no
450 < 0: We cannot handle this address, but if somebody
451 else handles (-N) bytes, we can start from there.
453 The same routine is used to handle both core and exec files;
454 we just tail-call it with more arguments to select between them. */
457 xfer_memory (CORE_ADDR memaddr
, gdb_byte
*myaddr
, int len
, int write
,
458 struct mem_attrib
*attrib
, struct target_ops
*target
)
461 struct section_table
*p
;
462 CORE_ADDR nextsectaddr
, memend
;
463 asection
*section
= NULL
;
466 internal_error (__FILE__
, __LINE__
, _("failed internal consistency check"));
468 if (overlay_debugging
)
470 section
= find_pc_overlay (memaddr
);
471 if (pc_in_unmapped_range (memaddr
, section
))
472 memaddr
= overlay_mapped_address (memaddr
, section
);
475 memend
= memaddr
+ len
;
476 nextsectaddr
= memend
;
478 for (p
= target
->to_sections
; p
< target
->to_sections_end
; p
++)
480 if (overlay_debugging
&& section
&&
481 strcmp (section
->name
, p
->the_bfd_section
->name
) != 0)
482 continue; /* not the section we need */
483 if (memaddr
>= p
->addr
)
485 if (memend
<= p
->endaddr
)
487 /* Entire transfer is within this section. */
489 res
= bfd_set_section_contents (p
->bfd
, p
->the_bfd_section
,
490 myaddr
, memaddr
- p
->addr
,
493 res
= bfd_get_section_contents (p
->bfd
, p
->the_bfd_section
,
494 myaddr
, memaddr
- p
->addr
,
496 return (res
!= 0) ? len
: 0;
498 else if (memaddr
>= p
->endaddr
)
500 /* This section ends before the transfer starts. */
505 /* This section overlaps the transfer. Just do half. */
506 len
= p
->endaddr
- memaddr
;
508 res
= bfd_set_section_contents (p
->bfd
, p
->the_bfd_section
,
509 myaddr
, memaddr
- p
->addr
,
512 res
= bfd_get_section_contents (p
->bfd
, p
->the_bfd_section
,
513 myaddr
, memaddr
- p
->addr
,
515 return (res
!= 0) ? len
: 0;
519 nextsectaddr
= min (nextsectaddr
, p
->addr
);
522 if (nextsectaddr
>= memend
)
523 return 0; /* We can't help */
525 return -(nextsectaddr
- memaddr
); /* Next boundary where we can help */
530 print_section_info (struct target_ops
*t
, bfd
*abfd
)
532 struct section_table
*p
;
533 /* FIXME: 16 is not wide enough when gdbarch_addr_bit > 64. */
534 int wid
= gdbarch_addr_bit (current_gdbarch
) <= 32 ? 8 : 16;
536 printf_filtered ("\t`%s', ", bfd_get_filename (abfd
));
538 printf_filtered (_("file type %s.\n"), bfd_get_target (abfd
));
539 if (abfd
== exec_bfd
)
541 printf_filtered (_("\tEntry point: "));
542 deprecated_print_address_numeric (bfd_get_start_address (abfd
), 1, gdb_stdout
);
543 printf_filtered ("\n");
545 for (p
= t
->to_sections
; p
< t
->to_sections_end
; p
++)
547 printf_filtered ("\t%s", hex_string_custom (p
->addr
, wid
));
548 printf_filtered (" - %s", hex_string_custom (p
->endaddr
, wid
));
550 /* FIXME: A format of "08l" is not wide enough for file offsets
551 larger than 4GB. OTOH, making it "016l" isn't desirable either
552 since most output will then be much wider than necessary. It
553 may make sense to test the size of the file and choose the
554 format string accordingly. */
555 /* FIXME: i18n: Need to rewrite this sentence. */
557 printf_filtered (" @ %s",
558 hex_string_custom (p
->the_bfd_section
->filepos
, 8));
559 printf_filtered (" is %s", bfd_section_name (p
->bfd
, p
->the_bfd_section
));
561 printf_filtered (" in %s", bfd_get_filename (p
->bfd
));
562 printf_filtered ("\n");
567 exec_files_info (struct target_ops
*t
)
569 print_section_info (t
, exec_bfd
);
575 printf_unfiltered (_("\tMapping info for file `%s'.\n"), vmap
->name
);
576 printf_unfiltered ("\t %*s %*s %*s %*s %8.8s %s\n",
577 strlen_paddr (), "tstart",
578 strlen_paddr (), "tend",
579 strlen_paddr (), "dstart",
580 strlen_paddr (), "dend",
584 for (vp
= vmap
; vp
; vp
= vp
->nxt
)
585 printf_unfiltered ("\t0x%s 0x%s 0x%s 0x%s %s%s%s%s\n",
591 *vp
->member
? "(" : "", vp
->member
,
592 *vp
->member
? ")" : "");
597 exec_set_section_offsets sets the offsets of all the sections
598 in the exec objfile. */
601 exec_set_section_offsets (bfd_signed_vma text_off
, bfd_signed_vma data_off
,
602 bfd_signed_vma bss_off
)
604 struct section_table
*sect
;
606 for (sect
= exec_ops
.to_sections
;
607 sect
< exec_ops
.to_sections_end
;
612 flags
= bfd_get_section_flags (exec_bfd
, sect
->the_bfd_section
);
614 if (flags
& SEC_CODE
)
616 sect
->addr
+= text_off
;
617 sect
->endaddr
+= text_off
;
619 else if (flags
& (SEC_DATA
| SEC_LOAD
))
621 sect
->addr
+= data_off
;
622 sect
->endaddr
+= data_off
;
624 else if (flags
& SEC_ALLOC
)
626 sect
->addr
+= bss_off
;
627 sect
->endaddr
+= bss_off
;
633 set_section_command (char *args
, int from_tty
)
635 struct section_table
*p
;
638 unsigned long secaddr
;
643 error (_("Must specify section name and its virtual address"));
645 /* Parse out section name */
646 for (secname
= args
; !isspace (*args
); args
++);
647 seclen
= args
- secname
;
649 /* Parse out new virtual address */
650 secaddr
= parse_and_eval_address (args
);
652 for (p
= exec_ops
.to_sections
; p
< exec_ops
.to_sections_end
; p
++)
654 if (!strncmp (secname
, bfd_section_name (exec_bfd
, p
->the_bfd_section
), seclen
)
655 && bfd_section_name (exec_bfd
, p
->the_bfd_section
)[seclen
] == '\0')
657 offset
= secaddr
- p
->addr
;
659 p
->endaddr
+= offset
;
661 exec_files_info (&exec_ops
);
665 if (seclen
>= sizeof (secprint
))
666 seclen
= sizeof (secprint
) - 1;
667 strncpy (secprint
, secname
, seclen
);
668 secprint
[seclen
] = '\0';
669 error (_("Section %s not found"), secprint
);
672 /* If we can find a section in FILENAME with BFD index INDEX, and the
673 user has not assigned an address to it yet (via "set section"), adjust it
677 exec_set_section_address (const char *filename
, int index
, CORE_ADDR address
)
679 struct section_table
*p
;
681 for (p
= exec_ops
.to_sections
; p
< exec_ops
.to_sections_end
; p
++)
683 if (strcmp (filename
, p
->bfd
->filename
) == 0
684 && index
== p
->the_bfd_section
->index
688 p
->endaddr
+= address
;
693 /* If mourn is being called in all the right places, this could be say
694 `gdb internal error' (since generic_mourn calls
695 breakpoint_init_inferior). */
698 ignore (struct bp_target_info
*bp_tgt
)
703 /* Find mapped memory. */
706 exec_set_find_memory_regions (int (*func
) (int (*) (CORE_ADDR
,
712 exec_ops
.to_find_memory_regions
= func
;
715 static char *exec_make_note_section (bfd
*, int *);
717 /* Fill in the exec file target vector. Very few entries need to be
723 exec_ops
.to_shortname
= "exec";
724 exec_ops
.to_longname
= "Local exec file";
725 exec_ops
.to_doc
= "Use an executable file as a target.\n\
726 Specify the filename of the executable file.";
727 exec_ops
.to_open
= exec_open
;
728 exec_ops
.to_close
= exec_close
;
729 exec_ops
.to_attach
= find_default_attach
;
730 exec_ops
.deprecated_xfer_memory
= xfer_memory
;
731 exec_ops
.to_files_info
= exec_files_info
;
732 exec_ops
.to_insert_breakpoint
= ignore
;
733 exec_ops
.to_remove_breakpoint
= ignore
;
734 exec_ops
.to_create_inferior
= find_default_create_inferior
;
735 exec_ops
.to_stratum
= file_stratum
;
736 exec_ops
.to_has_memory
= 1;
737 exec_ops
.to_make_corefile_notes
= exec_make_note_section
;
738 exec_ops
.to_magic
= OPS_MAGIC
;
742 _initialize_exec (void)
744 struct cmd_list_element
*c
;
750 c
= add_cmd ("file", class_files
, file_command
, _("\
751 Use FILE as program to be debugged.\n\
752 It is read for its symbols, for getting the contents of pure memory,\n\
753 and it is the program executed when you use the `run' command.\n\
754 If FILE cannot be found as specified, your execution directory path\n\
755 ($PATH) is searched for a command of that name.\n\
756 No arg means to have no executable file and no symbols."), &cmdlist
);
757 set_cmd_completer (c
, filename_completer
);
760 c
= add_cmd ("exec-file", class_files
, exec_file_command
, _("\
761 Use FILE as program for getting contents of pure memory.\n\
762 If FILE cannot be found as specified, your execution directory path\n\
763 is searched for a command of that name.\n\
764 No arg means have no executable file."), &cmdlist
);
765 set_cmd_completer (c
, filename_completer
);
767 add_com ("section", class_files
, set_section_command
, _("\
768 Change the base address of section SECTION of the exec file to ADDR.\n\
769 This can be used if the exec file does not contain section addresses,\n\
770 (such as in the a.out format), or when the addresses specified in the\n\
771 file itself are wrong. Each section must be changed separately. The\n\
772 ``info files'' command lists all the sections and their addresses."));
774 add_setshow_boolean_cmd ("write", class_support
, &write_files
, _("\
775 Set writing into executable and core files."), _("\
776 Show writing into executable and core files."), NULL
,
779 &setlist
, &showlist
);
781 add_target (&exec_ops
);
785 exec_make_note_section (bfd
*obfd
, int *note_size
)
787 error (_("Can't create a corefile"));