1 /* Work with executable files, for GDB.
3 Copyright (C) 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., 51 Franklin Street, Fifth Floor,
22 Boston, MA 02110-1301, USA. */
32 #include "completer.h"
38 #include "readline/readline.h"
39 #include "gdb_string.h"
46 #include "xcoffsolib.h"
48 struct vmap
*map_vmap (bfd
*, bfd
*);
50 void (*deprecated_file_changed_hook
) (char *);
52 /* Prototypes for local functions */
54 static void exec_close (int);
56 static void file_command (char *, int);
58 static void set_section_command (char *, int);
60 static void exec_files_info (struct target_ops
*);
62 static void init_exec_ops (void);
64 void _initialize_exec (void);
66 /* The target vector for executable files. */
68 struct target_ops exec_ops
;
70 /* The Binary File Descriptor handle for the executable file. */
74 /* Whether to open exec and core files read-only or read-write. */
78 show_write_files (struct ui_file
*file
, int from_tty
,
79 struct cmd_list_element
*c
, const char *value
)
81 fprintf_filtered (file
, _("Writing into executable and core files is %s.\n"),
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"));
192 set_gdbarch_from_file (NULL
);
196 char *scratch_pathname
;
199 scratch_chan
= openp (getenv ("PATH"), OPF_TRY_CWD_FIRST
, filename
,
200 write_files
? O_RDWR
| O_BINARY
: O_RDONLY
| O_BINARY
, 0,
202 #if defined(__GO32__) || defined(_WIN32) || defined(__CYGWIN__)
203 if (scratch_chan
< 0)
205 char *exename
= alloca (strlen (filename
) + 5);
206 strcat (strcpy (exename
, filename
), ".exe");
207 scratch_chan
= openp (getenv ("PATH"), OPF_TRY_CWD_FIRST
, exename
,
208 write_files
? O_RDWR
| O_BINARY
: O_RDONLY
| O_BINARY
, 0,
212 if (scratch_chan
< 0)
213 perror_with_name (filename
);
214 exec_bfd
= bfd_fopen (scratch_pathname
, gnutarget
,
215 write_files
? FOPEN_RUB
: FOPEN_RB
,
219 error (_("\"%s\": could not open as an executable file: %s"),
220 scratch_pathname
, bfd_errmsg (bfd_get_error ()));
222 /* At this point, scratch_pathname and exec_bfd->name both point to the
223 same malloc'd string. However exec_close() will attempt to free it
224 via the exec_bfd->name pointer, so we need to make another copy and
225 leave exec_bfd as the new owner of the original copy. */
226 scratch_pathname
= xstrdup (scratch_pathname
);
227 make_cleanup (xfree
, scratch_pathname
);
229 if (!bfd_check_format (exec_bfd
, bfd_object
))
231 /* Make sure to close exec_bfd, or else "run" might try to use
234 error (_("\"%s\": not in executable format: %s"),
235 scratch_pathname
, bfd_errmsg (bfd_get_error ()));
238 /* FIXME - This should only be run for RS6000, but the ifdef is a poor
239 way to accomplish. */
240 #ifdef DEPRECATED_IBM6000_TARGET
241 /* Setup initial vmap. */
243 map_vmap (exec_bfd
, 0);
246 /* Make sure to close exec_bfd, or else "run" might try to use
249 error (_("\"%s\": can't find the file sections: %s"),
250 scratch_pathname
, bfd_errmsg (bfd_get_error ()));
252 #endif /* DEPRECATED_IBM6000_TARGET */
254 if (build_section_table (exec_bfd
, &exec_ops
.to_sections
,
255 &exec_ops
.to_sections_end
))
257 /* Make sure to close exec_bfd, or else "run" might try to use
260 error (_("\"%s\": can't find the file sections: %s"),
261 scratch_pathname
, bfd_errmsg (bfd_get_error ()));
266 set_gdbarch_from_file (exec_bfd
);
268 push_target (&exec_ops
);
270 /* Tell display code (if any) about the changed file name. */
271 if (deprecated_exec_file_display_hook
)
272 (*deprecated_exec_file_display_hook
) (filename
);
274 bfd_cache_close_all ();
275 observer_notify_executable_changed (NULL
);
278 /* Process the first arg in ARGS as the new exec file.
280 Note that we have to explicitly ignore additional args, since we can
281 be called from file_command(), which also calls symbol_file_command()
282 which can take multiple args.
284 If ARGS is NULL, we just want to close the exec file. */
287 exec_file_command (char *args
, int from_tty
)
292 if (from_tty
&& target_has_execution
293 && !query (_("A program is being debugged already.\n"
294 "Are you sure you want to change the file? ")))
295 error (_("File not changed."));
299 /* Scan through the args and pick up the first non option arg
302 argv
= buildargv (args
);
306 make_cleanup_freeargv (argv
);
308 for (; (*argv
!= NULL
) && (**argv
== '-'); argv
++)
312 error (_("No executable file name was specified"));
314 filename
= tilde_expand (*argv
);
315 make_cleanup (xfree
, filename
);
316 exec_file_attach (filename
, from_tty
);
319 exec_file_attach (NULL
, from_tty
);
322 /* Set both the exec file and the symbol file, in one command.
323 What a novelty. Why did GDB go through four major releases before this
324 command was added? */
327 file_command (char *arg
, int from_tty
)
329 /* FIXME, if we lose on reading the symbol file, we should revert
330 the exec file, but that's rough. */
331 exec_file_command (arg
, from_tty
);
332 symbol_file_command (arg
, from_tty
);
333 if (deprecated_file_changed_hook
)
334 deprecated_file_changed_hook (arg
);
338 /* Locate all mappable sections of a BFD file.
339 table_pp_char is a char * to get it through bfd_map_over_sections;
340 we cast it back to its proper type. */
343 add_to_section_table (bfd
*abfd
, struct bfd_section
*asect
,
346 struct section_table
**table_pp
= (struct section_table
**) table_pp_char
;
349 aflag
= bfd_get_section_flags (abfd
, asect
);
350 if (!(aflag
& SEC_ALLOC
))
352 if (0 == bfd_section_size (abfd
, asect
))
354 (*table_pp
)->bfd
= abfd
;
355 (*table_pp
)->the_bfd_section
= asect
;
356 (*table_pp
)->addr
= bfd_section_vma (abfd
, asect
);
357 (*table_pp
)->endaddr
= (*table_pp
)->addr
+ bfd_section_size (abfd
, asect
);
361 /* Builds a section table, given args BFD, SECTABLE_PTR, SECEND_PTR.
362 Returns 0 if OK, 1 on error. */
365 build_section_table (struct bfd
*some_bfd
, struct section_table
**start
,
366 struct section_table
**end
)
370 count
= bfd_count_sections (some_bfd
);
373 *start
= (struct section_table
*) xmalloc (count
* sizeof (**start
));
375 bfd_map_over_sections (some_bfd
, add_to_section_table
, (char *) end
);
376 if (*end
> *start
+ count
)
377 internal_error (__FILE__
, __LINE__
, _("failed internal consistency check"));
378 /* We could realloc the table, but it probably loses for most files. */
383 bfdsec_to_vmap (struct bfd
*abfd
, struct bfd_section
*sect
, void *arg3
)
385 struct vmap_and_bfd
*vmap_bfd
= (struct vmap_and_bfd
*) arg3
;
388 vp
= vmap_bfd
->pvmap
;
390 if ((bfd_get_section_flags (abfd
, sect
) & SEC_LOAD
) == 0)
393 if (strcmp (bfd_section_name (abfd
, sect
), ".text") == 0)
395 vp
->tstart
= bfd_section_vma (abfd
, sect
);
396 vp
->tend
= vp
->tstart
+ bfd_section_size (abfd
, sect
);
397 vp
->tvma
= bfd_section_vma (abfd
, sect
);
398 vp
->toffs
= sect
->filepos
;
400 else if (strcmp (bfd_section_name (abfd
, sect
), ".data") == 0)
402 vp
->dstart
= bfd_section_vma (abfd
, sect
);
403 vp
->dend
= vp
->dstart
+ bfd_section_size (abfd
, sect
);
404 vp
->dvma
= bfd_section_vma (abfd
, sect
);
406 /* Silently ignore other types of sections. (FIXME?) */
409 /* Make a vmap for ABFD which might be a member of the archive ARCH.
410 Return the new vmap. */
413 map_vmap (bfd
*abfd
, bfd
*arch
)
415 struct vmap_and_bfd vmap_bfd
;
416 struct vmap
*vp
, **vpp
;
418 vp
= (struct vmap
*) xmalloc (sizeof (*vp
));
419 memset ((char *) vp
, '\0', sizeof (*vp
));
422 vp
->name
= bfd_get_filename (arch
? arch
: abfd
);
423 vp
->member
= arch
? bfd_get_filename (abfd
) : "";
425 vmap_bfd
.pbfd
= arch
;
427 bfd_map_over_sections (abfd
, bfdsec_to_vmap
, &vmap_bfd
);
429 /* Find the end of the list and append. */
430 for (vpp
= &vmap
; *vpp
; vpp
= &(*vpp
)->nxt
)
437 /* Read or write the exec file.
439 Args are address within a BFD file, address within gdb address-space,
440 length, and a flag indicating whether to read or write.
444 0: We cannot handle this address and length.
445 > 0: We have handled N bytes starting at this address.
446 (If N == length, we did it all.) We might be able
447 to handle more bytes beyond this length, but no
449 < 0: We cannot handle this address, but if somebody
450 else handles (-N) bytes, we can start from there.
452 The same routine is used to handle both core and exec files;
453 we just tail-call it with more arguments to select between them. */
456 xfer_memory (CORE_ADDR memaddr
, gdb_byte
*myaddr
, int len
, int write
,
457 struct mem_attrib
*attrib
, struct target_ops
*target
)
460 struct section_table
*p
;
461 CORE_ADDR nextsectaddr
, memend
;
462 asection
*section
= NULL
;
465 internal_error (__FILE__
, __LINE__
, _("failed internal consistency check"));
467 if (overlay_debugging
)
469 section
= find_pc_overlay (memaddr
);
470 if (pc_in_unmapped_range (memaddr
, section
))
471 memaddr
= overlay_mapped_address (memaddr
, section
);
474 memend
= memaddr
+ len
;
475 nextsectaddr
= memend
;
477 for (p
= target
->to_sections
; p
< target
->to_sections_end
; p
++)
479 if (overlay_debugging
&& section
&& p
->the_bfd_section
&&
480 strcmp (section
->name
, p
->the_bfd_section
->name
) != 0)
481 continue; /* not the section we need */
482 if (memaddr
>= p
->addr
)
484 if (memend
<= p
->endaddr
)
486 /* Entire transfer is within this section. */
488 res
= bfd_set_section_contents (p
->bfd
, p
->the_bfd_section
,
489 myaddr
, memaddr
- p
->addr
,
492 res
= bfd_get_section_contents (p
->bfd
, p
->the_bfd_section
,
493 myaddr
, memaddr
- p
->addr
,
495 return (res
!= 0) ? len
: 0;
497 else if (memaddr
>= p
->endaddr
)
499 /* This section ends before the transfer starts. */
504 /* This section overlaps the transfer. Just do half. */
505 len
= p
->endaddr
- memaddr
;
507 res
= bfd_set_section_contents (p
->bfd
, p
->the_bfd_section
,
508 myaddr
, memaddr
- p
->addr
,
511 res
= bfd_get_section_contents (p
->bfd
, p
->the_bfd_section
,
512 myaddr
, memaddr
- p
->addr
,
514 return (res
!= 0) ? len
: 0;
518 nextsectaddr
= min (nextsectaddr
, p
->addr
);
521 if (nextsectaddr
>= memend
)
522 return 0; /* We can't help */
524 return -(nextsectaddr
- memaddr
); /* Next boundary where we can help */
529 print_section_info (struct target_ops
*t
, bfd
*abfd
)
531 struct section_table
*p
;
532 /* FIXME: 16 is not wide enough when TARGET_ADDR_BIT > 64. */
533 int wid
= TARGET_ADDR_BIT
<= 32 ? 8 : 16;
535 printf_filtered ("\t`%s', ", bfd_get_filename (abfd
));
537 printf_filtered (_("file type %s.\n"), bfd_get_target (abfd
));
538 if (abfd
== exec_bfd
)
540 printf_filtered (_("\tEntry point: "));
541 deprecated_print_address_numeric (bfd_get_start_address (abfd
), 1, gdb_stdout
);
542 printf_filtered ("\n");
544 for (p
= t
->to_sections
; p
< t
->to_sections_end
; p
++)
546 printf_filtered ("\t%s", hex_string_custom (p
->addr
, wid
));
547 printf_filtered (" - %s", hex_string_custom (p
->endaddr
, wid
));
549 /* FIXME: A format of "08l" is not wide enough for file offsets
550 larger than 4GB. OTOH, making it "016l" isn't desirable either
551 since most output will then be much wider than necessary. It
552 may make sense to test the size of the file and choose the
553 format string accordingly. */
554 /* FIXME: i18n: Need to rewrite this sentence. */
556 printf_filtered (" @ %s",
557 hex_string_custom (p
->the_bfd_section
->filepos
, 8));
558 printf_filtered (" is %s", bfd_section_name (p
->bfd
, p
->the_bfd_section
));
560 printf_filtered (" in %s", bfd_get_filename (p
->bfd
));
561 printf_filtered ("\n");
566 exec_files_info (struct target_ops
*t
)
568 print_section_info (t
, exec_bfd
);
574 printf_unfiltered (_("\tMapping info for file `%s'.\n"), vmap
->name
);
575 printf_unfiltered ("\t %*s %*s %*s %*s %8.8s %s\n",
576 strlen_paddr (), "tstart",
577 strlen_paddr (), "tend",
578 strlen_paddr (), "dstart",
579 strlen_paddr (), "dend",
583 for (vp
= vmap
; vp
; vp
= vp
->nxt
)
584 printf_unfiltered ("\t0x%s 0x%s 0x%s 0x%s %s%s%s%s\n",
590 *vp
->member
? "(" : "", vp
->member
,
591 *vp
->member
? ")" : "");
596 exec_set_section_offsets sets the offsets of all the sections
597 in the exec objfile. */
600 exec_set_section_offsets (bfd_signed_vma text_off
, bfd_signed_vma data_off
,
601 bfd_signed_vma bss_off
)
603 struct section_table
*sect
;
605 for (sect
= exec_ops
.to_sections
;
606 sect
< exec_ops
.to_sections_end
;
611 flags
= bfd_get_section_flags (exec_bfd
, sect
->the_bfd_section
);
613 if (flags
& SEC_CODE
)
615 sect
->addr
+= text_off
;
616 sect
->endaddr
+= text_off
;
618 else if (flags
& (SEC_DATA
| SEC_LOAD
))
620 sect
->addr
+= data_off
;
621 sect
->endaddr
+= data_off
;
623 else if (flags
& SEC_ALLOC
)
625 sect
->addr
+= bss_off
;
626 sect
->endaddr
+= bss_off
;
632 set_section_command (char *args
, int from_tty
)
634 struct section_table
*p
;
637 unsigned long secaddr
;
642 error (_("Must specify section name and its virtual address"));
644 /* Parse out section name */
645 for (secname
= args
; !isspace (*args
); args
++);
646 seclen
= args
- secname
;
648 /* Parse out new virtual address */
649 secaddr
= parse_and_eval_address (args
);
651 for (p
= exec_ops
.to_sections
; p
< exec_ops
.to_sections_end
; p
++)
653 if (!strncmp (secname
, bfd_section_name (exec_bfd
, p
->the_bfd_section
), seclen
)
654 && bfd_section_name (exec_bfd
, p
->the_bfd_section
)[seclen
] == '\0')
656 offset
= secaddr
- p
->addr
;
658 p
->endaddr
+= offset
;
660 exec_files_info (&exec_ops
);
664 if (seclen
>= sizeof (secprint
))
665 seclen
= sizeof (secprint
) - 1;
666 strncpy (secprint
, secname
, seclen
);
667 secprint
[seclen
] = '\0';
668 error (_("Section %s not found"), secprint
);
671 /* If we can find a section in FILENAME with BFD index INDEX, and the
672 user has not assigned an address to it yet (via "set section"), adjust it
676 exec_set_section_address (const char *filename
, int index
, CORE_ADDR address
)
678 struct section_table
*p
;
680 for (p
= exec_ops
.to_sections
; p
< exec_ops
.to_sections_end
; p
++)
682 if (strcmp (filename
, p
->bfd
->filename
) == 0
683 && index
== p
->the_bfd_section
->index
687 p
->endaddr
+= address
;
692 /* If mourn is being called in all the right places, this could be say
693 `gdb internal error' (since generic_mourn calls
694 breakpoint_init_inferior). */
697 ignore (struct bp_target_info
*bp_tgt
)
702 /* Find mapped memory. */
705 exec_set_find_memory_regions (int (*func
) (int (*) (CORE_ADDR
,
711 exec_ops
.to_find_memory_regions
= func
;
714 static char *exec_make_note_section (bfd
*, int *);
716 /* Fill in the exec file target vector. Very few entries need to be
722 exec_ops
.to_shortname
= "exec";
723 exec_ops
.to_longname
= "Local exec file";
724 exec_ops
.to_doc
= "Use an executable file as a target.\n\
725 Specify the filename of the executable file.";
726 exec_ops
.to_open
= exec_open
;
727 exec_ops
.to_close
= exec_close
;
728 exec_ops
.to_attach
= find_default_attach
;
729 exec_ops
.deprecated_xfer_memory
= xfer_memory
;
730 exec_ops
.to_files_info
= exec_files_info
;
731 exec_ops
.to_insert_breakpoint
= ignore
;
732 exec_ops
.to_remove_breakpoint
= ignore
;
733 exec_ops
.to_create_inferior
= find_default_create_inferior
;
734 exec_ops
.to_stratum
= file_stratum
;
735 exec_ops
.to_has_memory
= 1;
736 exec_ops
.to_make_corefile_notes
= exec_make_note_section
;
737 exec_ops
.to_magic
= OPS_MAGIC
;
741 _initialize_exec (void)
743 struct cmd_list_element
*c
;
749 c
= add_cmd ("file", class_files
, file_command
, _("\
750 Use FILE as program to be debugged.\n\
751 It is read for its symbols, for getting the contents of pure memory,\n\
752 and it is the program executed when you use the `run' command.\n\
753 If FILE cannot be found as specified, your execution directory path\n\
754 ($PATH) is searched for a command of that name.\n\
755 No arg means to have no executable file and no symbols."), &cmdlist
);
756 set_cmd_completer (c
, filename_completer
);
759 c
= add_cmd ("exec-file", class_files
, exec_file_command
, _("\
760 Use FILE as program for getting contents of pure memory.\n\
761 If FILE cannot be found as specified, your execution directory path\n\
762 is searched for a command of that name.\n\
763 No arg means have no executable file."), &cmdlist
);
764 set_cmd_completer (c
, filename_completer
);
766 add_com ("section", class_files
, set_section_command
, _("\
767 Change the base address of section SECTION of the exec file to ADDR.\n\
768 This can be used if the exec file does not contain section addresses,\n\
769 (such as in the a.out format), or when the addresses specified in the\n\
770 file itself are wrong. Each section must be changed separately. The\n\
771 ``info files'' command lists all the sections and their addresses."));
773 add_setshow_boolean_cmd ("write", class_support
, &write_files
, _("\
774 Set writing into executable and core files."), _("\
775 Show writing into executable and core files."), NULL
,
778 &setlist
, &showlist
);
780 add_target (&exec_ops
);
784 exec_make_note_section (bfd
*obfd
, int *note_size
)
786 error (_("Can't create a corefile"));