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, 2008
5 Free Software Foundation, Inc.
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 3 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, see <http://www.gnu.org/licenses/>. */
30 #include "completer.h"
34 #include "arch-utils.h"
37 #include "readline/readline.h"
38 #include "gdb_string.h"
45 #include "xcoffsolib.h"
47 struct vmap
*map_vmap (bfd
*, bfd
*);
49 void (*deprecated_file_changed_hook
) (char *);
51 /* Prototypes for local functions */
53 static void exec_close (int);
55 static void file_command (char *, int);
57 static void set_section_command (char *, int);
59 static void exec_files_info (struct target_ops
*);
61 static void init_exec_ops (void);
63 void _initialize_exec (void);
65 /* The target vector for executable files. */
67 struct target_ops exec_ops
;
69 /* The Binary File Descriptor handle for the executable file. */
72 long exec_bfd_mtime
= 0;
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 ()));
143 if (exec_ops
.to_sections
)
145 xfree (exec_ops
.to_sections
);
146 exec_ops
.to_sections
= NULL
;
147 exec_ops
.to_sections_end
= NULL
;
152 exec_file_clear (int from_tty
)
154 /* Remove exec file. */
155 unpush_target (&exec_ops
);
158 printf_unfiltered (_("No executable file now.\n"));
161 /* Process the first arg in ARGS as the new exec file.
163 This function is intended to be behave essentially the same
164 as exec_file_command, except that the latter will detect when
165 a target is being debugged, and will ask the user whether it
166 should be shut down first. (If the answer is "no", then the
167 new file is ignored.)
169 This file is used by exec_file_command, to do the work of opening
170 and processing the exec file after any prompting has happened.
172 And, it is used by child_attach, when the attach command was
173 given a pid but not a exec pathname, and the attach command could
174 figure out the pathname from the pid. (In this case, we shouldn't
175 ask the user whether the current target should be shut down --
176 we're supplying the exec pathname late for good reason.)
178 ARGS is assumed to be the filename. */
181 exec_file_attach (char *filename
, int from_tty
)
183 /* Remove any previous exec file. */
184 unpush_target (&exec_ops
);
186 /* Now open and digest the file the user requested, if any. */
191 printf_unfiltered (_("No executable file now.\n"));
193 set_gdbarch_from_file (NULL
);
197 char *scratch_pathname
;
200 scratch_chan
= openp (getenv ("PATH"), OPF_TRY_CWD_FIRST
, filename
,
201 write_files
? O_RDWR
| O_BINARY
: O_RDONLY
| O_BINARY
, 0,
203 #if defined(__GO32__) || defined(_WIN32) || defined(__CYGWIN__)
204 if (scratch_chan
< 0)
206 char *exename
= alloca (strlen (filename
) + 5);
207 strcat (strcpy (exename
, filename
), ".exe");
208 scratch_chan
= openp (getenv ("PATH"), OPF_TRY_CWD_FIRST
, exename
,
209 write_files
? O_RDWR
| O_BINARY
: O_RDONLY
| O_BINARY
, 0,
213 if (scratch_chan
< 0)
214 perror_with_name (filename
);
215 exec_bfd
= bfd_fopen (scratch_pathname
, gnutarget
,
216 write_files
? FOPEN_RUB
: FOPEN_RB
,
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
= xstrdup (scratch_pathname
);
228 make_cleanup (xfree
, 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 DEPRECATED_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 /* DEPRECATED_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 exec_bfd_mtime
= bfd_get_mtime (exec_bfd
);
269 set_gdbarch_from_file (exec_bfd
);
271 push_target (&exec_ops
);
273 /* Tell display code (if any) about the changed file name. */
274 if (deprecated_exec_file_display_hook
)
275 (*deprecated_exec_file_display_hook
) (filename
);
277 bfd_cache_close_all ();
278 observer_notify_executable_changed ();
281 /* Process the first arg in ARGS as the new exec file.
283 Note that we have to explicitly ignore additional args, since we can
284 be called from file_command(), which also calls symbol_file_command()
285 which can take multiple args.
287 If ARGS is NULL, we just want to close the exec file. */
290 exec_file_command (char *args
, int from_tty
)
295 if (from_tty
&& target_has_execution
296 && !query (_("A program is being debugged already.\n"
297 "Are you sure you want to change the file? ")))
298 error (_("File not changed."));
302 /* Scan through the args and pick up the first non option arg
305 argv
= gdb_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 /* Check the section flags, but do not discard zero-length sections, since
350 some symbols may still be attached to this section. For instance, we
351 encountered on sparc-solaris 2.10 a shared library with an empty .bss
352 section to which a symbol named "_end" was attached. The address
353 of this symbol still needs to be relocated. */
354 aflag
= bfd_get_section_flags (abfd
, asect
);
355 if (!(aflag
& SEC_ALLOC
))
358 (*table_pp
)->bfd
= abfd
;
359 (*table_pp
)->the_bfd_section
= asect
;
360 (*table_pp
)->addr
= bfd_section_vma (abfd
, asect
);
361 (*table_pp
)->endaddr
= (*table_pp
)->addr
+ bfd_section_size (abfd
, asect
);
365 /* Builds a section table, given args BFD, SECTABLE_PTR, SECEND_PTR.
366 Returns 0 if OK, 1 on error. */
369 build_section_table (struct bfd
*some_bfd
, struct section_table
**start
,
370 struct section_table
**end
)
374 count
= bfd_count_sections (some_bfd
);
377 *start
= (struct section_table
*) xmalloc (count
* sizeof (**start
));
379 bfd_map_over_sections (some_bfd
, add_to_section_table
, (char *) end
);
380 if (*end
> *start
+ count
)
381 internal_error (__FILE__
, __LINE__
, _("failed internal consistency check"));
382 /* We could realloc the table, but it probably loses for most files. */
387 bfdsec_to_vmap (struct bfd
*abfd
, struct bfd_section
*sect
, void *arg3
)
389 struct vmap_and_bfd
*vmap_bfd
= (struct vmap_and_bfd
*) arg3
;
392 vp
= vmap_bfd
->pvmap
;
394 if ((bfd_get_section_flags (abfd
, sect
) & SEC_LOAD
) == 0)
397 if (strcmp (bfd_section_name (abfd
, sect
), ".text") == 0)
399 vp
->tstart
= bfd_section_vma (abfd
, sect
);
400 vp
->tend
= vp
->tstart
+ bfd_section_size (abfd
, sect
);
401 vp
->tvma
= bfd_section_vma (abfd
, sect
);
402 vp
->toffs
= sect
->filepos
;
404 else if (strcmp (bfd_section_name (abfd
, sect
), ".data") == 0)
406 vp
->dstart
= bfd_section_vma (abfd
, sect
);
407 vp
->dend
= vp
->dstart
+ bfd_section_size (abfd
, sect
);
408 vp
->dvma
= bfd_section_vma (abfd
, sect
);
410 /* Silently ignore other types of sections. (FIXME?) */
413 /* Make a vmap for ABFD which might be a member of the archive ARCH.
414 Return the new vmap. */
417 map_vmap (bfd
*abfd
, bfd
*arch
)
419 struct vmap_and_bfd vmap_bfd
;
420 struct vmap
*vp
, **vpp
;
422 vp
= (struct vmap
*) xmalloc (sizeof (*vp
));
423 memset ((char *) vp
, '\0', sizeof (*vp
));
426 vp
->name
= bfd_get_filename (arch
? arch
: abfd
);
427 vp
->member
= arch
? bfd_get_filename (abfd
) : "";
429 vmap_bfd
.pbfd
= arch
;
431 bfd_map_over_sections (abfd
, bfdsec_to_vmap
, &vmap_bfd
);
433 /* Find the end of the list and append. */
434 for (vpp
= &vmap
; *vpp
; vpp
= &(*vpp
)->nxt
)
441 /* Read or write the exec file.
443 Args are address within a BFD file, address within gdb address-space,
444 length, and a flag indicating whether to read or write.
448 0: We cannot handle this address and length.
449 > 0: We have handled N bytes starting at this address.
450 (If N == length, we did it all.) We might be able
451 to handle more bytes beyond this length, but no
453 < 0: We cannot handle this address, but if somebody
454 else handles (-N) bytes, we can start from there.
456 The same routine is used to handle both core and exec files;
457 we just tail-call it with more arguments to select between them. */
460 xfer_memory (CORE_ADDR memaddr
, gdb_byte
*myaddr
, int len
, int write
,
461 struct mem_attrib
*attrib
, struct target_ops
*target
)
464 struct section_table
*p
;
465 CORE_ADDR nextsectaddr
, memend
;
466 struct obj_section
*section
= NULL
;
469 internal_error (__FILE__
, __LINE__
, _("failed internal consistency check"));
471 if (overlay_debugging
)
473 section
= find_pc_overlay (memaddr
);
474 if (pc_in_unmapped_range (memaddr
, section
))
475 memaddr
= overlay_mapped_address (memaddr
, section
);
478 memend
= memaddr
+ len
;
479 nextsectaddr
= memend
;
481 for (p
= target
->to_sections
; p
< target
->to_sections_end
; p
++)
483 if (overlay_debugging
&& section
484 && strcmp (section
->the_bfd_section
->name
,
485 p
->the_bfd_section
->name
) != 0)
486 continue; /* not the section we need */
487 if (memaddr
>= p
->addr
)
489 if (memend
<= p
->endaddr
)
491 /* Entire transfer is within this section. */
493 res
= bfd_set_section_contents (p
->bfd
, p
->the_bfd_section
,
494 myaddr
, memaddr
- p
->addr
,
497 res
= bfd_get_section_contents (p
->bfd
, p
->the_bfd_section
,
498 myaddr
, memaddr
- p
->addr
,
500 return (res
!= 0) ? len
: 0;
502 else if (memaddr
>= p
->endaddr
)
504 /* This section ends before the transfer starts. */
509 /* This section overlaps the transfer. Just do half. */
510 len
= p
->endaddr
- memaddr
;
512 res
= bfd_set_section_contents (p
->bfd
, p
->the_bfd_section
,
513 myaddr
, memaddr
- p
->addr
,
516 res
= bfd_get_section_contents (p
->bfd
, p
->the_bfd_section
,
517 myaddr
, memaddr
- p
->addr
,
519 return (res
!= 0) ? len
: 0;
523 nextsectaddr
= min (nextsectaddr
, p
->addr
);
526 if (nextsectaddr
>= memend
)
527 return 0; /* We can't help */
529 return -(nextsectaddr
- memaddr
); /* Next boundary where we can help */
534 print_section_info (struct target_ops
*t
, bfd
*abfd
)
536 struct section_table
*p
;
537 /* FIXME: 16 is not wide enough when gdbarch_addr_bit > 64. */
538 int wid
= gdbarch_addr_bit (gdbarch_from_bfd (abfd
)) <= 32 ? 8 : 16;
540 printf_filtered ("\t`%s', ", bfd_get_filename (abfd
));
542 printf_filtered (_("file type %s.\n"), bfd_get_target (abfd
));
543 if (abfd
== exec_bfd
)
544 printf_filtered (_("\tEntry point: %s\n"),
545 paddress (bfd_get_start_address (abfd
)));
546 for (p
= t
->to_sections
; p
< t
->to_sections_end
; p
++)
548 printf_filtered ("\t%s", hex_string_custom (p
->addr
, wid
));
549 printf_filtered (" - %s", hex_string_custom (p
->endaddr
, wid
));
551 /* FIXME: A format of "08l" is not wide enough for file offsets
552 larger than 4GB. OTOH, making it "016l" isn't desirable either
553 since most output will then be much wider than necessary. It
554 may make sense to test the size of the file and choose the
555 format string accordingly. */
556 /* FIXME: i18n: Need to rewrite this sentence. */
558 printf_filtered (" @ %s",
559 hex_string_custom (p
->the_bfd_section
->filepos
, 8));
560 printf_filtered (" is %s", bfd_section_name (p
->bfd
, p
->the_bfd_section
));
562 printf_filtered (" in %s", bfd_get_filename (p
->bfd
));
563 printf_filtered ("\n");
568 exec_files_info (struct target_ops
*t
)
570 print_section_info (t
, exec_bfd
);
576 printf_unfiltered (_("\tMapping info for file `%s'.\n"), vmap
->name
);
577 printf_unfiltered ("\t %*s %*s %*s %*s %8.8s %s\n",
578 strlen_paddr (), "tstart",
579 strlen_paddr (), "tend",
580 strlen_paddr (), "dstart",
581 strlen_paddr (), "dend",
585 for (vp
= vmap
; vp
; vp
= vp
->nxt
)
586 printf_unfiltered ("\t0x%s 0x%s 0x%s 0x%s %s%s%s%s\n",
592 *vp
->member
? "(" : "", vp
->member
,
593 *vp
->member
? ")" : "");
598 set_section_command (char *args
, int from_tty
)
600 struct section_table
*p
;
603 unsigned long secaddr
;
608 error (_("Must specify section name and its virtual address"));
610 /* Parse out section name */
611 for (secname
= args
; !isspace (*args
); args
++);
612 seclen
= args
- secname
;
614 /* Parse out new virtual address */
615 secaddr
= parse_and_eval_address (args
);
617 for (p
= exec_ops
.to_sections
; p
< exec_ops
.to_sections_end
; p
++)
619 if (!strncmp (secname
, bfd_section_name (exec_bfd
, p
->the_bfd_section
), seclen
)
620 && bfd_section_name (exec_bfd
, p
->the_bfd_section
)[seclen
] == '\0')
622 offset
= secaddr
- p
->addr
;
624 p
->endaddr
+= offset
;
626 exec_files_info (&exec_ops
);
630 if (seclen
>= sizeof (secprint
))
631 seclen
= sizeof (secprint
) - 1;
632 strncpy (secprint
, secname
, seclen
);
633 secprint
[seclen
] = '\0';
634 error (_("Section %s not found"), secprint
);
637 /* If we can find a section in FILENAME with BFD index INDEX, adjust
641 exec_set_section_address (const char *filename
, int index
, CORE_ADDR address
)
643 struct section_table
*p
;
645 for (p
= exec_ops
.to_sections
; p
< exec_ops
.to_sections_end
; p
++)
647 if (strcmp (filename
, p
->bfd
->filename
) == 0
648 && index
== p
->the_bfd_section
->index
)
650 p
->endaddr
+= address
- p
->addr
;
656 /* If mourn is being called in all the right places, this could be say
657 `gdb internal error' (since generic_mourn calls
658 breakpoint_init_inferior). */
661 ignore (struct bp_target_info
*bp_tgt
)
666 /* Find mapped memory. */
669 exec_set_find_memory_regions (int (*func
) (int (*) (CORE_ADDR
,
675 exec_ops
.to_find_memory_regions
= func
;
678 static char *exec_make_note_section (bfd
*, int *);
680 /* Fill in the exec file target vector. Very few entries need to be
686 exec_ops
.to_shortname
= "exec";
687 exec_ops
.to_longname
= "Local exec file";
688 exec_ops
.to_doc
= "Use an executable file as a target.\n\
689 Specify the filename of the executable file.";
690 exec_ops
.to_open
= exec_open
;
691 exec_ops
.to_close
= exec_close
;
692 exec_ops
.to_attach
= find_default_attach
;
693 exec_ops
.deprecated_xfer_memory
= xfer_memory
;
694 exec_ops
.to_files_info
= exec_files_info
;
695 exec_ops
.to_insert_breakpoint
= ignore
;
696 exec_ops
.to_remove_breakpoint
= ignore
;
697 exec_ops
.to_create_inferior
= find_default_create_inferior
;
698 exec_ops
.to_stratum
= file_stratum
;
699 exec_ops
.to_has_memory
= 1;
700 exec_ops
.to_make_corefile_notes
= exec_make_note_section
;
701 exec_ops
.to_magic
= OPS_MAGIC
;
705 _initialize_exec (void)
707 struct cmd_list_element
*c
;
713 c
= add_cmd ("file", class_files
, file_command
, _("\
714 Use FILE as program to be debugged.\n\
715 It is read for its symbols, for getting the contents of pure memory,\n\
716 and it is the program executed when you use the `run' command.\n\
717 If FILE cannot be found as specified, your execution directory path\n\
718 ($PATH) is searched for a command of that name.\n\
719 No arg means to have no executable file and no symbols."), &cmdlist
);
720 set_cmd_completer (c
, filename_completer
);
723 c
= add_cmd ("exec-file", class_files
, exec_file_command
, _("\
724 Use FILE as program for getting contents of pure memory.\n\
725 If FILE cannot be found as specified, your execution directory path\n\
726 is searched for a command of that name.\n\
727 No arg means have no executable file."), &cmdlist
);
728 set_cmd_completer (c
, filename_completer
);
730 add_com ("section", class_files
, set_section_command
, _("\
731 Change the base address of section SECTION of the exec file to ADDR.\n\
732 This can be used if the exec file does not contain section addresses,\n\
733 (such as in the a.out format), or when the addresses specified in the\n\
734 file itself are wrong. Each section must be changed separately. The\n\
735 ``info files'' command lists all the sections and their addresses."));
737 add_setshow_boolean_cmd ("write", class_support
, &write_files
, _("\
738 Set writing into executable and core files."), _("\
739 Show writing into executable and core files."), NULL
,
742 &setlist
, &showlist
);
744 add_target (&exec_ops
);
748 exec_make_note_section (bfd
*obfd
, int *note_size
)
750 error (_("Can't create a corefile"));