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, 2009
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 /* GDB currently only supports a single symbol/address space for the
75 whole debug session. When that limitation is lifted, this global
77 static struct target_section_table current_target_sections_1
;
79 /* The set of target sections matching the sections mapped into the
80 current inferior's address space. */
81 static struct target_section_table
*current_target_sections
82 = ¤t_target_sections_1
;
84 /* Whether to open exec and core files read-only or read-write. */
88 show_write_files (struct ui_file
*file
, int from_tty
,
89 struct cmd_list_element
*c
, const char *value
)
91 fprintf_filtered (file
, _("Writing into executable and core files is %s.\n"),
99 exec_open (char *args
, int from_tty
)
101 target_preopen (from_tty
);
102 exec_file_attach (args
, from_tty
);
105 /* Close and clear exec_bfd. If we end up with no target sections to
106 read memory from, this unpushes the exec_ops target. */
113 bfd
*abfd
= exec_bfd
;
114 char *name
= bfd_get_filename (abfd
);
116 if (!bfd_close (abfd
))
117 warning (_("cannot close \"%s\": %s"),
118 name
, bfd_errmsg (bfd_get_error ()));
121 /* Removing target sections may close the exec_ops target.
122 Clear exec_bfd before doing so to prevent recursion. */
126 remove_target_sections (abfd
);
131 exec_close (int quitting
)
133 int need_symtab_cleanup
= 0;
134 struct vmap
*vp
, *nxt
;
136 for (nxt
= vmap
; nxt
!= NULL
;)
141 /* if there is an objfile associated with this bfd,
142 free_objfile() will do proper cleanup of objfile *and* bfd. */
146 free_objfile (vp
->objfile
);
147 need_symtab_cleanup
= 1;
149 else if (vp
->bfd
!= exec_bfd
)
150 /* FIXME-leak: We should be freeing vp->name too, I think. */
151 if (!bfd_close (vp
->bfd
))
152 warning (_("cannot close \"%s\": %s"),
153 vp
->name
, bfd_errmsg (bfd_get_error ()));
155 /* FIXME: This routine is #if 0'd in symfile.c. What should we
156 be doing here? Should we just free everything in
157 vp->objfile->symtabs? Should free_objfile do that?
158 FIXME-as-well: free_objfile already free'd vp->name, so it isn't
160 free_named_symtabs (vp
->name
);
166 /* Delete all target sections. */
168 (current_target_sections
,
169 -resize_section_table (current_target_sections
, 0));
171 /* Remove exec file. */
176 exec_file_clear (int from_tty
)
178 /* Remove exec file. */
182 printf_unfiltered (_("No executable file now.\n"));
185 /* Set FILENAME as the new exec file.
187 This function is intended to be behave essentially the same
188 as exec_file_command, except that the latter will detect when
189 a target is being debugged, and will ask the user whether it
190 should be shut down first. (If the answer is "no", then the
191 new file is ignored.)
193 This file is used by exec_file_command, to do the work of opening
194 and processing the exec file after any prompting has happened.
196 And, it is used by child_attach, when the attach command was
197 given a pid but not a exec pathname, and the attach command could
198 figure out the pathname from the pid. (In this case, we shouldn't
199 ask the user whether the current target should be shut down --
200 we're supplying the exec pathname late for good reason.) */
203 exec_file_attach (char *filename
, int from_tty
)
205 /* Remove any previous exec file. */
208 /* Now open and digest the file the user requested, if any. */
213 printf_unfiltered (_("No executable file now.\n"));
215 set_gdbarch_from_file (NULL
);
219 struct cleanup
*cleanups
;
220 char *scratch_pathname
;
222 struct target_section
*sections
= NULL
, *sections_end
= NULL
;
224 scratch_chan
= openp (getenv ("PATH"), OPF_TRY_CWD_FIRST
, filename
,
225 write_files
? O_RDWR
| O_BINARY
: O_RDONLY
| O_BINARY
,
227 #if defined(__GO32__) || defined(_WIN32) || defined(__CYGWIN__)
228 if (scratch_chan
< 0)
230 char *exename
= alloca (strlen (filename
) + 5);
231 strcat (strcpy (exename
, filename
), ".exe");
232 scratch_chan
= openp (getenv ("PATH"), OPF_TRY_CWD_FIRST
, exename
,
233 write_files
? O_RDWR
| O_BINARY
: O_RDONLY
| O_BINARY
,
237 if (scratch_chan
< 0)
238 perror_with_name (filename
);
239 exec_bfd
= bfd_fopen (scratch_pathname
, gnutarget
,
240 write_files
? FOPEN_RUB
: FOPEN_RB
,
245 close (scratch_chan
);
246 error (_("\"%s\": could not open as an executable file: %s"),
247 scratch_pathname
, bfd_errmsg (bfd_get_error ()));
250 /* At this point, scratch_pathname and exec_bfd->name both point to the
251 same malloc'd string. However exec_close() will attempt to free it
252 via the exec_bfd->name pointer, so we need to make another copy and
253 leave exec_bfd as the new owner of the original copy. */
254 scratch_pathname
= xstrdup (scratch_pathname
);
255 cleanups
= make_cleanup (xfree
, scratch_pathname
);
257 if (!bfd_check_format (exec_bfd
, bfd_object
))
259 /* Make sure to close exec_bfd, or else "run" might try to use
262 error (_("\"%s\": not in executable format: %s"),
263 scratch_pathname
, bfd_errmsg (bfd_get_error ()));
266 /* FIXME - This should only be run for RS6000, but the ifdef is a poor
267 way to accomplish. */
268 #ifdef DEPRECATED_IBM6000_TARGET
269 /* Setup initial vmap. */
271 map_vmap (exec_bfd
, 0);
274 /* Make sure to close exec_bfd, or else "run" might try to use
277 error (_("\"%s\": can't find the file sections: %s"),
278 scratch_pathname
, bfd_errmsg (bfd_get_error ()));
280 #endif /* DEPRECATED_IBM6000_TARGET */
282 if (build_section_table (exec_bfd
, §ions
, §ions_end
))
284 /* Make sure to close exec_bfd, or else "run" might try to use
287 error (_("\"%s\": can't find the file sections: %s"),
288 scratch_pathname
, bfd_errmsg (bfd_get_error ()));
291 exec_bfd_mtime
= bfd_get_mtime (exec_bfd
);
295 set_gdbarch_from_file (exec_bfd
);
297 /* Add the executable's sections to the current address spaces'
299 add_target_sections (sections
, sections_end
);
302 /* Tell display code (if any) about the changed file name. */
303 if (deprecated_exec_file_display_hook
)
304 (*deprecated_exec_file_display_hook
) (filename
);
306 do_cleanups (cleanups
);
308 bfd_cache_close_all ();
309 observer_notify_executable_changed ();
312 /* Process the first arg in ARGS as the new exec file.
314 Note that we have to explicitly ignore additional args, since we can
315 be called from file_command(), which also calls symbol_file_command()
316 which can take multiple args.
318 If ARGS is NULL, we just want to close the exec file. */
321 exec_file_command (char *args
, int from_tty
)
326 if (from_tty
&& target_has_execution
327 && !query (_("A program is being debugged already.\n"
328 "Are you sure you want to change the file? ")))
329 error (_("File not changed."));
333 struct cleanup
*cleanups
;
335 /* Scan through the args and pick up the first non option arg
338 argv
= gdb_buildargv (args
);
339 cleanups
= make_cleanup_freeargv (argv
);
341 for (; (*argv
!= NULL
) && (**argv
== '-'); argv
++)
345 error (_("No executable file name was specified"));
347 filename
= tilde_expand (*argv
);
348 make_cleanup (xfree
, filename
);
349 exec_file_attach (filename
, from_tty
);
351 do_cleanups (cleanups
);
354 exec_file_attach (NULL
, from_tty
);
357 /* Set both the exec file and the symbol file, in one command.
358 What a novelty. Why did GDB go through four major releases before this
359 command was added? */
362 file_command (char *arg
, int from_tty
)
364 /* FIXME, if we lose on reading the symbol file, we should revert
365 the exec file, but that's rough. */
366 exec_file_command (arg
, from_tty
);
367 symbol_file_command (arg
, from_tty
);
368 if (deprecated_file_changed_hook
)
369 deprecated_file_changed_hook (arg
);
373 /* Locate all mappable sections of a BFD file.
374 table_pp_char is a char * to get it through bfd_map_over_sections;
375 we cast it back to its proper type. */
378 add_to_section_table (bfd
*abfd
, struct bfd_section
*asect
,
381 struct target_section
**table_pp
= (struct target_section
**) table_pp_char
;
384 /* Check the section flags, but do not discard zero-length sections, since
385 some symbols may still be attached to this section. For instance, we
386 encountered on sparc-solaris 2.10 a shared library with an empty .bss
387 section to which a symbol named "_end" was attached. The address
388 of this symbol still needs to be relocated. */
389 aflag
= bfd_get_section_flags (abfd
, asect
);
390 if (!(aflag
& SEC_ALLOC
))
393 (*table_pp
)->bfd
= abfd
;
394 (*table_pp
)->the_bfd_section
= asect
;
395 (*table_pp
)->addr
= bfd_section_vma (abfd
, asect
);
396 (*table_pp
)->endaddr
= (*table_pp
)->addr
+ bfd_section_size (abfd
, asect
);
401 resize_section_table (struct target_section_table
*table
, int num_added
)
403 struct target_section
*old_value
;
407 old_value
= table
->sections
;
408 old_count
= table
->sections_end
- table
->sections
;
410 new_count
= num_added
+ old_count
;
414 table
->sections
= xrealloc (table
->sections
,
415 sizeof (struct target_section
) * new_count
);
416 table
->sections_end
= table
->sections
+ new_count
;
420 xfree (table
->sections
);
421 table
->sections
= table
->sections_end
= NULL
;
427 /* Builds a section table, given args BFD, SECTABLE_PTR, SECEND_PTR.
428 Returns 0 if OK, 1 on error. */
431 build_section_table (struct bfd
*some_bfd
, struct target_section
**start
,
432 struct target_section
**end
)
436 count
= bfd_count_sections (some_bfd
);
439 *start
= (struct target_section
*) xmalloc (count
* sizeof (**start
));
441 bfd_map_over_sections (some_bfd
, add_to_section_table
, (char *) end
);
442 if (*end
> *start
+ count
)
443 internal_error (__FILE__
, __LINE__
, _("failed internal consistency check"));
444 /* We could realloc the table, but it probably loses for most files. */
448 /* Add the sections array defined by [SECTIONS..SECTIONS_END[ to the
449 current set of target sections. */
452 add_target_sections (struct target_section
*sections
,
453 struct target_section
*sections_end
)
456 struct target_section_table
*table
= current_target_sections
;
458 count
= sections_end
- sections
;
462 int space
= resize_section_table (table
, count
);
463 memcpy (table
->sections
+ space
,
464 sections
, count
* sizeof (sections
[0]));
466 /* If these are the first file sections we can provide memory
467 from, push the file_stratum target. */
469 push_target (&exec_ops
);
473 /* Remove all target sections taken from ABFD. */
476 remove_target_sections (bfd
*abfd
)
478 struct target_section
*src
, *dest
;
480 struct target_section_table
*table
= current_target_sections
;
482 dest
= table
->sections
;
483 for (src
= table
->sections
; src
< table
->sections_end
; src
++)
484 if (src
->bfd
!= abfd
)
486 /* Keep this section. */
492 /* If we've dropped any sections, resize the section table. */
497 old_count
= resize_section_table (table
, dest
- src
);
499 /* If we don't have any more sections to read memory from,
500 remove the file_stratum target from the stack. */
501 if (old_count
+ (dest
- src
) == 0)
502 unpush_target (&exec_ops
);
508 bfdsec_to_vmap (struct bfd
*abfd
, struct bfd_section
*sect
, void *arg3
)
510 struct vmap_and_bfd
*vmap_bfd
= (struct vmap_and_bfd
*) arg3
;
513 vp
= vmap_bfd
->pvmap
;
515 if ((bfd_get_section_flags (abfd
, sect
) & SEC_LOAD
) == 0)
518 if (strcmp (bfd_section_name (abfd
, sect
), ".text") == 0)
520 vp
->tstart
= bfd_section_vma (abfd
, sect
);
521 vp
->tend
= vp
->tstart
+ bfd_section_size (abfd
, sect
);
522 vp
->tvma
= bfd_section_vma (abfd
, sect
);
523 vp
->toffs
= sect
->filepos
;
525 else if (strcmp (bfd_section_name (abfd
, sect
), ".data") == 0)
527 vp
->dstart
= bfd_section_vma (abfd
, sect
);
528 vp
->dend
= vp
->dstart
+ bfd_section_size (abfd
, sect
);
529 vp
->dvma
= bfd_section_vma (abfd
, sect
);
531 /* Silently ignore other types of sections. (FIXME?) */
534 /* Make a vmap for ABFD which might be a member of the archive ARCH.
535 Return the new vmap. */
538 map_vmap (bfd
*abfd
, bfd
*arch
)
540 struct vmap_and_bfd vmap_bfd
;
541 struct vmap
*vp
, **vpp
;
543 vp
= (struct vmap
*) xmalloc (sizeof (*vp
));
544 memset ((char *) vp
, '\0', sizeof (*vp
));
547 vp
->name
= bfd_get_filename (arch
? arch
: abfd
);
548 vp
->member
= arch
? bfd_get_filename (abfd
) : "";
550 vmap_bfd
.pbfd
= arch
;
552 bfd_map_over_sections (abfd
, bfdsec_to_vmap
, &vmap_bfd
);
554 /* Find the end of the list and append. */
555 for (vpp
= &vmap
; *vpp
; vpp
= &(*vpp
)->nxt
)
564 section_table_xfer_memory_partial (gdb_byte
*readbuf
, const gdb_byte
*writebuf
,
565 ULONGEST offset
, LONGEST len
,
566 struct target_section
*sections
,
567 struct target_section
*sections_end
,
568 const char *section_name
)
571 struct target_section
*p
;
572 ULONGEST memaddr
= offset
;
573 ULONGEST memend
= memaddr
+ len
;
576 internal_error (__FILE__
, __LINE__
, _("failed internal consistency check"));
578 for (p
= sections
; p
< sections_end
; p
++)
580 if (section_name
&& strcmp (section_name
, p
->the_bfd_section
->name
) != 0)
581 continue; /* not the section we need */
582 if (memaddr
>= p
->addr
)
584 if (memend
<= p
->endaddr
)
586 /* Entire transfer is within this section. */
588 res
= bfd_set_section_contents (p
->bfd
, p
->the_bfd_section
,
589 writebuf
, memaddr
- p
->addr
,
592 res
= bfd_get_section_contents (p
->bfd
, p
->the_bfd_section
,
593 readbuf
, memaddr
- p
->addr
,
595 return (res
!= 0) ? len
: 0;
597 else if (memaddr
>= p
->endaddr
)
599 /* This section ends before the transfer starts. */
604 /* This section overlaps the transfer. Just do half. */
605 len
= p
->endaddr
- memaddr
;
607 res
= bfd_set_section_contents (p
->bfd
, p
->the_bfd_section
,
608 writebuf
, memaddr
- p
->addr
,
611 res
= bfd_get_section_contents (p
->bfd
, p
->the_bfd_section
,
612 readbuf
, memaddr
- p
->addr
,
614 return (res
!= 0) ? len
: 0;
619 return 0; /* We can't help */
622 struct target_section_table
*
623 exec_get_section_table (struct target_ops
*ops
)
625 return current_target_sections
;
629 exec_xfer_partial (struct target_ops
*ops
, enum target_object object
,
630 const char *annex
, gdb_byte
*readbuf
,
631 const gdb_byte
*writebuf
,
632 ULONGEST offset
, LONGEST len
)
634 struct target_section_table
*table
= target_get_section_table (ops
);
636 if (object
== TARGET_OBJECT_MEMORY
)
637 return section_table_xfer_memory_partial (readbuf
, writebuf
,
648 print_section_info (struct target_section_table
*t
, bfd
*abfd
)
650 struct target_section
*p
;
651 /* FIXME: 16 is not wide enough when gdbarch_addr_bit > 64. */
652 int wid
= gdbarch_addr_bit (gdbarch_from_bfd (abfd
)) <= 32 ? 8 : 16;
654 printf_filtered ("\t`%s', ", bfd_get_filename (abfd
));
656 printf_filtered (_("file type %s.\n"), bfd_get_target (abfd
));
657 if (abfd
== exec_bfd
)
658 printf_filtered (_("\tEntry point: %s\n"),
659 paddress (bfd_get_start_address (abfd
)));
660 for (p
= t
->sections
; p
< t
->sections_end
; p
++)
662 printf_filtered ("\t%s", hex_string_custom (p
->addr
, wid
));
663 printf_filtered (" - %s", hex_string_custom (p
->endaddr
, wid
));
665 /* FIXME: A format of "08l" is not wide enough for file offsets
666 larger than 4GB. OTOH, making it "016l" isn't desirable either
667 since most output will then be much wider than necessary. It
668 may make sense to test the size of the file and choose the
669 format string accordingly. */
670 /* FIXME: i18n: Need to rewrite this sentence. */
672 printf_filtered (" @ %s",
673 hex_string_custom (p
->the_bfd_section
->filepos
, 8));
674 printf_filtered (" is %s", bfd_section_name (p
->bfd
, p
->the_bfd_section
));
676 printf_filtered (" in %s", bfd_get_filename (p
->bfd
));
677 printf_filtered ("\n");
682 exec_files_info (struct target_ops
*t
)
684 print_section_info (current_target_sections
, exec_bfd
);
690 printf_unfiltered (_("\tMapping info for file `%s'.\n"), vmap
->name
);
691 printf_unfiltered ("\t %*s %*s %*s %*s %8.8s %s\n",
692 strlen_paddr (), "tstart",
693 strlen_paddr (), "tend",
694 strlen_paddr (), "dstart",
695 strlen_paddr (), "dend",
699 for (vp
= vmap
; vp
; vp
= vp
->nxt
)
700 printf_unfiltered ("\t0x%s 0x%s 0x%s 0x%s %s%s%s%s\n",
706 *vp
->member
? "(" : "", vp
->member
,
707 *vp
->member
? ")" : "");
712 set_section_command (char *args
, int from_tty
)
714 struct target_section
*p
;
717 unsigned long secaddr
;
720 struct target_section_table
*table
;
723 error (_("Must specify section name and its virtual address"));
725 /* Parse out section name */
726 for (secname
= args
; !isspace (*args
); args
++);
727 seclen
= args
- secname
;
729 /* Parse out new virtual address */
730 secaddr
= parse_and_eval_address (args
);
732 table
= current_target_sections
;
733 for (p
= table
->sections
; p
< table
->sections_end
; p
++)
735 if (!strncmp (secname
, bfd_section_name (exec_bfd
, p
->the_bfd_section
), seclen
)
736 && bfd_section_name (exec_bfd
, p
->the_bfd_section
)[seclen
] == '\0')
738 offset
= secaddr
- p
->addr
;
740 p
->endaddr
+= offset
;
742 exec_files_info (&exec_ops
);
746 if (seclen
>= sizeof (secprint
))
747 seclen
= sizeof (secprint
) - 1;
748 strncpy (secprint
, secname
, seclen
);
749 secprint
[seclen
] = '\0';
750 error (_("Section %s not found"), secprint
);
753 /* If we can find a section in FILENAME with BFD index INDEX, adjust
757 exec_set_section_address (const char *filename
, int index
, CORE_ADDR address
)
759 struct target_section
*p
;
760 struct target_section_table
*table
;
762 table
= current_target_sections
;
763 for (p
= table
->sections
; p
< table
->sections_end
; p
++)
765 if (strcmp (filename
, p
->bfd
->filename
) == 0
766 && index
== p
->the_bfd_section
->index
)
768 p
->endaddr
+= address
- p
->addr
;
774 /* If mourn is being called in all the right places, this could be say
775 `gdb internal error' (since generic_mourn calls
776 breakpoint_init_inferior). */
779 ignore (struct bp_target_info
*bp_tgt
)
785 exec_has_memory (struct target_ops
*ops
)
787 /* We can provide memory if we have any file/target sections to read
789 return (current_target_sections
->sections
790 != current_target_sections
->sections_end
);
793 /* Find mapped memory. */
796 exec_set_find_memory_regions (int (*func
) (int (*) (CORE_ADDR
,
802 exec_ops
.to_find_memory_regions
= func
;
805 static char *exec_make_note_section (bfd
*, int *);
807 /* Fill in the exec file target vector. Very few entries need to be
813 exec_ops
.to_shortname
= "exec";
814 exec_ops
.to_longname
= "Local exec file";
815 exec_ops
.to_doc
= "Use an executable file as a target.\n\
816 Specify the filename of the executable file.";
817 exec_ops
.to_open
= exec_open
;
818 exec_ops
.to_close
= exec_close
;
819 exec_ops
.to_attach
= find_default_attach
;
820 exec_ops
.to_xfer_partial
= exec_xfer_partial
;
821 exec_ops
.to_get_section_table
= exec_get_section_table
;
822 exec_ops
.to_files_info
= exec_files_info
;
823 exec_ops
.to_insert_breakpoint
= ignore
;
824 exec_ops
.to_remove_breakpoint
= ignore
;
825 exec_ops
.to_create_inferior
= find_default_create_inferior
;
826 exec_ops
.to_stratum
= file_stratum
;
827 exec_ops
.to_has_memory
= exec_has_memory
;
828 exec_ops
.to_make_corefile_notes
= exec_make_note_section
;
829 exec_ops
.to_magic
= OPS_MAGIC
;
833 _initialize_exec (void)
835 struct cmd_list_element
*c
;
841 c
= add_cmd ("file", class_files
, file_command
, _("\
842 Use FILE as program to be debugged.\n\
843 It is read for its symbols, for getting the contents of pure memory,\n\
844 and it is the program executed when you use the `run' command.\n\
845 If FILE cannot be found as specified, your execution directory path\n\
846 ($PATH) is searched for a command of that name.\n\
847 No arg means to have no executable file and no symbols."), &cmdlist
);
848 set_cmd_completer (c
, filename_completer
);
851 c
= add_cmd ("exec-file", class_files
, exec_file_command
, _("\
852 Use FILE as program for getting contents of pure memory.\n\
853 If FILE cannot be found as specified, your execution directory path\n\
854 is searched for a command of that name.\n\
855 No arg means have no executable file."), &cmdlist
);
856 set_cmd_completer (c
, filename_completer
);
858 add_com ("section", class_files
, set_section_command
, _("\
859 Change the base address of section SECTION of the exec file to ADDR.\n\
860 This can be used if the exec file does not contain section addresses,\n\
861 (such as in the a.out format), or when the addresses specified in the\n\
862 file itself are wrong. Each section must be changed separately. The\n\
863 ``info files'' command lists all the sections and their addresses."));
865 add_setshow_boolean_cmd ("write", class_support
, &write_files
, _("\
866 Set writing into executable and core files."), _("\
867 Show writing into executable and core files."), NULL
,
870 &setlist
, &showlist
);
872 add_target (&exec_ops
);
876 exec_make_note_section (bfd
*obfd
, int *note_size
)
878 error (_("Can't create a corefile"));