1 /* Work with executable files, for GDB.
3 Copyright 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., 59 Temple Place - Suite 330,
22 Boston, MA 02111-1307, USA. */
32 #include "completer.h"
37 #include "readline/readline.h"
38 #include "gdb_string.h"
48 #include "xcoffsolib.h"
50 struct vmap
*map_vmap (bfd
*, bfd
*);
52 void (*deprecated_file_changed_hook
) (char *);
54 /* Prototypes for local functions */
56 static void exec_close (int);
58 static void file_command (char *, int);
60 static void set_section_command (char *, int);
62 static void exec_files_info (struct target_ops
*);
64 static int ignore (CORE_ADDR
, char *);
66 static void init_exec_ops (void);
68 void _initialize_exec (void);
70 /* The target vector for executable files. */
72 struct target_ops exec_ops
;
74 /* The Binary File Descriptor handle for the executable file. */
78 /* Whether to open exec and core files read-only or read-write. */
82 show_write_files (struct ui_file
*file
, int from_tty
,
83 struct cmd_list_element
*c
, const char *value
)
85 fprintf_filtered (file
, _("Writing into executable and core files is %s.\n"),
93 exec_open (char *args
, int from_tty
)
95 target_preopen (from_tty
);
96 exec_file_attach (args
, from_tty
);
100 exec_close (int quitting
)
102 int need_symtab_cleanup
= 0;
103 struct vmap
*vp
, *nxt
;
105 for (nxt
= vmap
; nxt
!= NULL
;)
110 /* if there is an objfile associated with this bfd,
111 free_objfile() will do proper cleanup of objfile *and* bfd. */
115 free_objfile (vp
->objfile
);
116 need_symtab_cleanup
= 1;
118 else if (vp
->bfd
!= exec_bfd
)
119 /* FIXME-leak: We should be freeing vp->name too, I think. */
120 if (!bfd_close (vp
->bfd
))
121 warning (_("cannot close \"%s\": %s"),
122 vp
->name
, bfd_errmsg (bfd_get_error ()));
124 /* FIXME: This routine is #if 0'd in symfile.c. What should we
125 be doing here? Should we just free everything in
126 vp->objfile->symtabs? Should free_objfile do that?
127 FIXME-as-well: free_objfile already free'd vp->name, so it isn't
129 free_named_symtabs (vp
->name
);
137 char *name
= bfd_get_filename (exec_bfd
);
139 if (!bfd_close (exec_bfd
))
140 warning (_("cannot close \"%s\": %s"),
141 name
, bfd_errmsg (bfd_get_error ()));
146 if (exec_ops
.to_sections
)
148 xfree (exec_ops
.to_sections
);
149 exec_ops
.to_sections
= NULL
;
150 exec_ops
.to_sections_end
= NULL
;
155 exec_file_clear (int from_tty
)
157 /* Remove exec file. */
158 unpush_target (&exec_ops
);
161 printf_unfiltered (_("No executable file now.\n"));
164 /* Process the first arg in ARGS as the new exec file.
166 This function is intended to be behave essentially the same
167 as exec_file_command, except that the latter will detect when
168 a target is being debugged, and will ask the user whether it
169 should be shut down first. (If the answer is "no", then the
170 new file is ignored.)
172 This file is used by exec_file_command, to do the work of opening
173 and processing the exec file after any prompting has happened.
175 And, it is used by child_attach, when the attach command was
176 given a pid but not a exec pathname, and the attach command could
177 figure out the pathname from the pid. (In this case, we shouldn't
178 ask the user whether the current target should be shut down --
179 we're supplying the exec pathname late for good reason.)
181 ARGS is assumed to be the filename. */
184 exec_file_attach (char *filename
, int from_tty
)
186 /* Remove any previous exec file. */
187 unpush_target (&exec_ops
);
189 /* Now open and digest the file the user requested, if any. */
194 printf_unfiltered (_("No executable file now.\n"));
198 char *scratch_pathname
;
201 scratch_chan
= openp (getenv ("PATH"), OPF_TRY_CWD_FIRST
, filename
,
202 write_files
? O_RDWR
| O_BINARY
: O_RDONLY
| O_BINARY
, 0,
204 #if defined(__GO32__) || defined(_WIN32) || defined(__CYGWIN__)
205 if (scratch_chan
< 0)
207 char *exename
= alloca (strlen (filename
) + 5);
208 strcat (strcpy (exename
, filename
), ".exe");
209 scratch_chan
= openp (getenv ("PATH"), OPF_TRY_CWD_FIRST
, exename
,
210 write_files
? O_RDWR
| O_BINARY
: O_RDONLY
| O_BINARY
, 0,
214 if (scratch_chan
< 0)
215 perror_with_name (filename
);
216 exec_bfd
= bfd_fdopenr (scratch_pathname
, gnutarget
, scratch_chan
);
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 ()));
264 #ifdef DEPRECATED_HPUX_TEXT_END
265 DEPRECATED_HPUX_TEXT_END (&exec_ops
);
270 set_gdbarch_from_file (exec_bfd
);
272 push_target (&exec_ops
);
274 /* Tell display code (if any) about the changed file name. */
275 if (deprecated_exec_file_display_hook
)
276 (*deprecated_exec_file_display_hook
) (filename
);
278 bfd_cache_close_all ();
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 target_preopen (from_tty
);
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 (DEPRECATED_STREQ (bfd_section_name (abfd
, sect
), ".text"))
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 (DEPRECATED_STREQ (bfd_section_name (abfd
, sect
), ".data"))
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
, char *myaddr
, int len
, int write
,
457 struct mem_attrib
*attrib
,
458 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
&& p
->the_bfd_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 TARGET_ADDR_BIT > 64. */
534 int wid
= TARGET_ADDR_BIT
<= 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 mourn is being called in all the right places, this could be say
673 `gdb internal error' (since generic_mourn calls
674 breakpoint_init_inferior). */
677 ignore (CORE_ADDR addr
, char *contents
)
682 /* Find mapped memory. */
685 exec_set_find_memory_regions (int (*func
) (int (*) (CORE_ADDR
,
691 exec_ops
.to_find_memory_regions
= func
;
694 static char *exec_make_note_section (bfd
*, int *);
696 /* Fill in the exec file target vector. Very few entries need to be
702 exec_ops
.to_shortname
= "exec";
703 exec_ops
.to_longname
= "Local exec file";
704 exec_ops
.to_doc
= "Use an executable file as a target.\n\
705 Specify the filename of the executable file.";
706 exec_ops
.to_open
= exec_open
;
707 exec_ops
.to_close
= exec_close
;
708 exec_ops
.to_attach
= find_default_attach
;
709 exec_ops
.deprecated_xfer_memory
= xfer_memory
;
710 exec_ops
.to_files_info
= exec_files_info
;
711 exec_ops
.to_insert_breakpoint
= ignore
;
712 exec_ops
.to_remove_breakpoint
= ignore
;
713 exec_ops
.to_create_inferior
= find_default_create_inferior
;
714 exec_ops
.to_stratum
= file_stratum
;
715 exec_ops
.to_has_memory
= 1;
716 exec_ops
.to_make_corefile_notes
= exec_make_note_section
;
717 exec_ops
.to_magic
= OPS_MAGIC
;
721 _initialize_exec (void)
723 struct cmd_list_element
*c
;
729 c
= add_cmd ("file", class_files
, file_command
, _("\
730 Use FILE as program to be debugged.\n\
731 It is read for its symbols, for getting the contents of pure memory,\n\
732 and it is the program executed when you use the `run' command.\n\
733 If FILE cannot be found as specified, your execution directory path\n\
734 ($PATH) is searched for a command of that name.\n\
735 No arg means to have no executable file and no symbols."), &cmdlist
);
736 set_cmd_completer (c
, filename_completer
);
739 c
= add_cmd ("exec-file", class_files
, exec_file_command
, _("\
740 Use FILE as program for getting contents of pure memory.\n\
741 If FILE cannot be found as specified, your execution directory path\n\
742 is searched for a command of that name.\n\
743 No arg means have no executable file."), &cmdlist
);
744 set_cmd_completer (c
, filename_completer
);
746 add_com ("section", class_files
, set_section_command
, _("\
747 Change the base address of section SECTION of the exec file to ADDR.\n\
748 This can be used if the exec file does not contain section addresses,\n\
749 (such as in the a.out format), or when the addresses specified in the\n\
750 file itself are wrong. Each section must be changed separately. The\n\
751 ``info files'' command lists all the sections and their addresses."));
753 add_setshow_boolean_cmd ("write", class_support
, &write_files
, _("\
754 Set writing into executable and core files."), _("\
755 Show writing into executable and core files."), NULL
,
758 &setlist
, &showlist
);
760 add_target (&exec_ops
);
764 exec_make_note_section (bfd
*obfd
, int *note_size
)
766 error (_("Can't create a corefile"));