1 /* Work with executable files, for GDB.
2 Copyright 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997,
3 1998, 1999, 2000, 2001, 2002
4 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 2 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, write to the Free Software
20 Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
31 #include "completer.h"
35 #include <sys/types.h>
39 #include <readline/readline.h>
40 #include "gdb_string.h"
50 #include "xcoffsolib.h"
52 struct vmap
*map_vmap (bfd
*, bfd
*);
54 void (*file_changed_hook
) (char *);
56 /* Prototypes for local functions */
58 static void add_to_section_table (bfd
*, sec_ptr
, void *);
60 static void exec_close (int);
62 static void file_command (char *, int);
64 static void set_section_command (char *, int);
66 static void exec_files_info (struct target_ops
*);
68 static void bfdsec_to_vmap (bfd
*, sec_ptr
, void *);
70 static int ignore (CORE_ADDR
, char *);
72 static void init_exec_ops (void);
74 void _initialize_exec (void);
76 /* The target vector for executable files. */
78 struct target_ops exec_ops
;
80 /* The Binary File Descriptor handle for the executable file. */
84 /* Whether to open exec and core files read-only or read-write. */
91 exec_open (char *args
, int from_tty
)
93 target_preopen (from_tty
);
94 exec_file_attach (args
, from_tty
);
98 exec_close (int quitting
)
100 int need_symtab_cleanup
= 0;
101 struct vmap
*vp
, *nxt
;
103 for (nxt
= vmap
; nxt
!= NULL
;)
108 /* if there is an objfile associated with this bfd,
109 free_objfile() will do proper cleanup of objfile *and* bfd. */
113 free_objfile (vp
->objfile
);
114 need_symtab_cleanup
= 1;
116 else if (vp
->bfd
!= exec_bfd
)
117 /* FIXME-leak: We should be freeing vp->name too, I think. */
118 if (!bfd_close (vp
->bfd
))
119 warning ("cannot close \"%s\": %s",
120 vp
->name
, bfd_errmsg (bfd_get_error ()));
122 /* FIXME: This routine is #if 0'd in symfile.c. What should we
123 be doing here? Should we just free everything in
124 vp->objfile->symtabs? Should free_objfile do that?
125 FIXME-as-well: free_objfile already free'd vp->name, so it isn't
127 free_named_symtabs (vp
->name
);
135 char *name
= bfd_get_filename (exec_bfd
);
137 if (!bfd_close (exec_bfd
))
138 warning ("cannot close \"%s\": %s",
139 name
, bfd_errmsg (bfd_get_error ()));
144 if (exec_ops
.to_sections
)
146 xfree (exec_ops
.to_sections
);
147 exec_ops
.to_sections
= NULL
;
148 exec_ops
.to_sections_end
= NULL
;
153 exec_file_clear (int from_tty
)
155 /* Remove exec file. */
156 unpush_target (&exec_ops
);
159 printf_unfiltered ("No executable file now.\n");
162 /* Process the first arg in ARGS as the new exec file.
164 This function is intended to be behave essentially the same
165 as exec_file_command, except that the latter will detect when
166 a target is being debugged, and will ask the user whether it
167 should be shut down first. (If the answer is "no", then the
168 new file is ignored.)
170 This file is used by exec_file_command, to do the work of opening
171 and processing the exec file after any prompting has happened.
173 And, it is used by child_attach, when the attach command was
174 given a pid but not a exec pathname, and the attach command could
175 figure out the pathname from the pid. (In this case, we shouldn't
176 ask the user whether the current target should be shut down --
177 we're supplying the exec pathname late for good reason.)
179 ARGS is assumed to be the filename. */
182 exec_file_attach (char *filename
, int from_tty
)
184 /* Remove any previous exec file. */
185 unpush_target (&exec_ops
);
187 /* Now open and digest the file the user requested, if any. */
192 printf_unfiltered ("No executable file now.\n");
196 char *scratch_pathname
;
199 scratch_chan
= openp (getenv ("PATH"), 1, 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"), 1, exename
, write_files
?
208 O_RDWR
| O_BINARY
: O_RDONLY
| O_BINARY
, 0, &scratch_pathname
);
211 if (scratch_chan
< 0)
212 perror_with_name (filename
);
213 exec_bfd
= bfd_fdopenr (scratch_pathname
, gnutarget
, scratch_chan
);
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 ()));
261 #ifdef DEPRECATED_HPUX_TEXT_END
262 DEPRECATED_HPUX_TEXT_END (&exec_ops
);
267 set_gdbarch_from_file (exec_bfd
);
269 push_target (&exec_ops
);
271 /* Tell display code (if any) about the changed file name. */
272 if (exec_file_display_hook
)
273 (*exec_file_display_hook
) (filename
);
277 /* Process the first arg in ARGS as the new exec file.
279 Note that we have to explicitly ignore additional args, since we can
280 be called from file_command(), which also calls symbol_file_command()
281 which can take multiple args.
283 If ARGS is NULL, we just want to close the exec file. */
286 exec_file_command (char *args
, int from_tty
)
291 target_preopen (from_tty
);
295 /* Scan through the args and pick up the first non option arg
298 argv
= buildargv (args
);
302 make_cleanup_freeargv (argv
);
304 for (; (*argv
!= NULL
) && (**argv
== '-'); argv
++)
308 error ("No executable file name was specified");
310 filename
= tilde_expand (*argv
);
311 make_cleanup (xfree
, filename
);
312 exec_file_attach (filename
, from_tty
);
315 exec_file_attach (NULL
, from_tty
);
318 /* Set both the exec file and the symbol file, in one command.
319 What a novelty. Why did GDB go through four major releases before this
320 command was added? */
323 file_command (char *arg
, int from_tty
)
325 /* FIXME, if we lose on reading the symbol file, we should revert
326 the exec file, but that's rough. */
327 exec_file_command (arg
, from_tty
);
328 symbol_file_command (arg
, from_tty
);
329 if (file_changed_hook
)
330 file_changed_hook (arg
);
334 /* Locate all mappable sections of a BFD file.
335 table_pp_char is a char * to get it through bfd_map_over_sections;
336 we cast it back to its proper type. */
339 add_to_section_table (bfd
*abfd
, sec_ptr asect
, void *table_pp_char
)
341 struct section_table
**table_pp
= (struct section_table
**) table_pp_char
;
344 aflag
= bfd_get_section_flags (abfd
, asect
);
345 if (!(aflag
& SEC_ALLOC
))
347 if (0 == bfd_section_size (abfd
, asect
))
349 (*table_pp
)->bfd
= abfd
;
350 (*table_pp
)->the_bfd_section
= asect
;
351 (*table_pp
)->addr
= bfd_section_vma (abfd
, asect
);
352 (*table_pp
)->endaddr
= (*table_pp
)->addr
+ bfd_section_size (abfd
, asect
);
356 /* Builds a section table, given args BFD, SECTABLE_PTR, SECEND_PTR.
357 Returns 0 if OK, 1 on error. */
360 build_section_table (bfd
*some_bfd
, struct section_table
**start
,
361 struct section_table
**end
)
365 count
= bfd_count_sections (some_bfd
);
368 *start
= (struct section_table
*) xmalloc (count
* sizeof (**start
));
370 bfd_map_over_sections (some_bfd
, add_to_section_table
, (char *) end
);
371 if (*end
> *start
+ count
)
372 internal_error (__FILE__
, __LINE__
, "failed internal consistency check");
373 /* We could realloc the table, but it probably loses for most files. */
378 bfdsec_to_vmap (bfd
*abfd
, sec_ptr sect
, void *arg3
)
380 struct vmap_and_bfd
*vmap_bfd
= (struct vmap_and_bfd
*) arg3
;
383 vp
= vmap_bfd
->pvmap
;
385 if ((bfd_get_section_flags (abfd
, sect
) & SEC_LOAD
) == 0)
388 if (STREQ (bfd_section_name (abfd
, sect
), ".text"))
390 vp
->tstart
= bfd_section_vma (abfd
, sect
);
391 vp
->tend
= vp
->tstart
+ bfd_section_size (abfd
, sect
);
392 vp
->tvma
= bfd_section_vma (abfd
, sect
);
393 vp
->toffs
= sect
->filepos
;
395 else if (STREQ (bfd_section_name (abfd
, sect
), ".data"))
397 vp
->dstart
= bfd_section_vma (abfd
, sect
);
398 vp
->dend
= vp
->dstart
+ bfd_section_size (abfd
, sect
);
399 vp
->dvma
= bfd_section_vma (abfd
, sect
);
401 /* Silently ignore other types of sections. (FIXME?) */
404 /* Make a vmap for ABFD which might be a member of the archive ARCH.
405 Return the new vmap. */
408 map_vmap (bfd
*abfd
, bfd
*arch
)
410 struct vmap_and_bfd vmap_bfd
;
411 struct vmap
*vp
, **vpp
;
413 vp
= (struct vmap
*) xmalloc (sizeof (*vp
));
414 memset ((char *) vp
, '\0', sizeof (*vp
));
417 vp
->name
= bfd_get_filename (arch
? arch
: abfd
);
418 vp
->member
= arch
? bfd_get_filename (abfd
) : "";
420 vmap_bfd
.pbfd
= arch
;
422 bfd_map_over_sections (abfd
, bfdsec_to_vmap
, &vmap_bfd
);
424 /* Find the end of the list and append. */
425 for (vpp
= &vmap
; *vpp
; vpp
= &(*vpp
)->nxt
)
432 /* Read or write the exec file.
434 Args are address within a BFD file, address within gdb address-space,
435 length, and a flag indicating whether to read or write.
439 0: We cannot handle this address and length.
440 > 0: We have handled N bytes starting at this address.
441 (If N == length, we did it all.) We might be able
442 to handle more bytes beyond this length, but no
444 < 0: We cannot handle this address, but if somebody
445 else handles (-N) bytes, we can start from there.
447 The same routine is used to handle both core and exec files;
448 we just tail-call it with more arguments to select between them. */
451 xfer_memory (CORE_ADDR memaddr
, char *myaddr
, int len
, int write
,
452 struct mem_attrib
*attrib
,
453 struct target_ops
*target
)
456 struct section_table
*p
;
457 CORE_ADDR nextsectaddr
, memend
;
458 int (*xfer_fn
) (bfd
*, sec_ptr
, void *, file_ptr
, bfd_size_type
);
459 asection
*section
= NULL
;
462 internal_error (__FILE__
, __LINE__
, "failed internal consistency check");
464 if (overlay_debugging
)
466 section
= find_pc_overlay (memaddr
);
467 if (pc_in_unmapped_range (memaddr
, section
))
468 memaddr
= overlay_mapped_address (memaddr
, section
);
471 memend
= memaddr
+ len
;
472 xfer_fn
= write
? bfd_set_section_contents
: bfd_get_section_contents
;
473 nextsectaddr
= memend
;
475 for (p
= target
->to_sections
; p
< target
->to_sections_end
; p
++)
477 if (overlay_debugging
&& section
&& p
->the_bfd_section
&&
478 strcmp (section
->name
, p
->the_bfd_section
->name
) != 0)
479 continue; /* not the section we need */
480 if (memaddr
>= p
->addr
)
482 if (memend
<= p
->endaddr
)
484 /* Entire transfer is within this section. */
485 res
= xfer_fn (p
->bfd
, p
->the_bfd_section
, myaddr
,
486 memaddr
- p
->addr
, len
);
487 return (res
!= 0) ? len
: 0;
489 else if (memaddr
>= p
->endaddr
)
491 /* This section ends before the transfer starts. */
496 /* This section overlaps the transfer. Just do half. */
497 len
= p
->endaddr
- memaddr
;
498 res
= xfer_fn (p
->bfd
, p
->the_bfd_section
, myaddr
,
499 memaddr
- p
->addr
, len
);
500 return (res
!= 0) ? len
: 0;
504 nextsectaddr
= min (nextsectaddr
, p
->addr
);
507 if (nextsectaddr
>= memend
)
508 return 0; /* We can't help */
510 return -(nextsectaddr
- memaddr
); /* Next boundary where we can help */
515 print_section_info (struct target_ops
*t
, bfd
*abfd
)
517 struct section_table
*p
;
518 /* FIXME: "016l" is not wide enough when TARGET_ADDR_BIT > 64. */
519 char *fmt
= TARGET_ADDR_BIT
<= 32 ? "08l" : "016l";
521 printf_filtered ("\t`%s', ", bfd_get_filename (abfd
));
523 printf_filtered ("file type %s.\n", bfd_get_target (abfd
));
524 if (abfd
== exec_bfd
)
526 printf_filtered ("\tEntry point: ");
527 print_address_numeric (bfd_get_start_address (abfd
), 1, gdb_stdout
);
528 printf_filtered ("\n");
530 for (p
= t
->to_sections
; p
< t
->to_sections_end
; p
++)
532 printf_filtered ("\t%s", local_hex_string_custom (p
->addr
, fmt
));
533 printf_filtered (" - %s", local_hex_string_custom (p
->endaddr
, fmt
));
535 /* FIXME: A format of "08l" is not wide enough for file offsets
536 larger than 4GB. OTOH, making it "016l" isn't desirable either
537 since most output will then be much wider than necessary. It
538 may make sense to test the size of the file and choose the
539 format string accordingly. */
541 printf_filtered (" @ %s",
542 local_hex_string_custom (p
->the_bfd_section
->filepos
, "08l"));
543 printf_filtered (" is %s", bfd_section_name (p
->bfd
, p
->the_bfd_section
));
546 printf_filtered (" in %s", bfd_get_filename (p
->bfd
));
548 printf_filtered ("\n");
553 exec_files_info (struct target_ops
*t
)
555 print_section_info (t
, exec_bfd
);
561 printf_unfiltered ("\tMapping info for file `%s'.\n", vmap
->name
);
562 printf_unfiltered ("\t %*s %*s %*s %*s %8.8s %s\n",
563 strlen_paddr (), "tstart",
564 strlen_paddr (), "tend",
565 strlen_paddr (), "dstart",
566 strlen_paddr (), "dend",
570 for (vp
= vmap
; vp
; vp
= vp
->nxt
)
571 printf_unfiltered ("\t0x%s 0x%s 0x%s 0x%s %s%s%s%s\n",
577 *vp
->member
? "(" : "", vp
->member
,
578 *vp
->member
? ")" : "");
583 exec_set_section_offsets sets the offsets of all the sections
584 in the exec objfile. */
587 exec_set_section_offsets (bfd_signed_vma text_off
, bfd_signed_vma data_off
,
588 bfd_signed_vma bss_off
)
590 struct section_table
*sect
;
592 for (sect
= exec_ops
.to_sections
;
593 sect
< exec_ops
.to_sections_end
;
598 flags
= bfd_get_section_flags (exec_bfd
, sect
->the_bfd_section
);
600 if (flags
& SEC_CODE
)
602 sect
->addr
+= text_off
;
603 sect
->endaddr
+= text_off
;
605 else if (flags
& (SEC_DATA
| SEC_LOAD
))
607 sect
->addr
+= data_off
;
608 sect
->endaddr
+= data_off
;
610 else if (flags
& SEC_ALLOC
)
612 sect
->addr
+= bss_off
;
613 sect
->endaddr
+= bss_off
;
619 set_section_command (char *args
, int from_tty
)
621 struct section_table
*p
;
624 unsigned long secaddr
;
629 error ("Must specify section name and its virtual address");
631 /* Parse out section name */
632 for (secname
= args
; !isspace (*args
); args
++);
633 seclen
= args
- secname
;
635 /* Parse out new virtual address */
636 secaddr
= parse_and_eval_address (args
);
638 for (p
= exec_ops
.to_sections
; p
< exec_ops
.to_sections_end
; p
++)
640 if (!strncmp (secname
, bfd_section_name (exec_bfd
, p
->the_bfd_section
), seclen
)
641 && bfd_section_name (exec_bfd
, p
->the_bfd_section
)[seclen
] == '\0')
643 offset
= secaddr
- p
->addr
;
645 p
->endaddr
+= offset
;
647 exec_files_info (&exec_ops
);
651 if (seclen
>= sizeof (secprint
))
652 seclen
= sizeof (secprint
) - 1;
653 strncpy (secprint
, secname
, seclen
);
654 secprint
[seclen
] = '\0';
655 error ("Section %s not found", secprint
);
658 /* If mourn is being called in all the right places, this could be say
659 `gdb internal error' (since generic_mourn calls
660 breakpoint_init_inferior). */
663 ignore (CORE_ADDR addr
, char *contents
)
668 /* Find mapped memory. */
671 exec_set_find_memory_regions (int (*func
) (int (*) (CORE_ADDR
,
677 exec_ops
.to_find_memory_regions
= func
;
680 static char *exec_make_note_section (bfd
*, int *);
682 /* Fill in the exec file target vector. Very few entries need to be
688 exec_ops
.to_shortname
= "exec";
689 exec_ops
.to_longname
= "Local exec file";
690 exec_ops
.to_doc
= "Use an executable file as a target.\n\
691 Specify the filename of the executable file.";
692 exec_ops
.to_open
= exec_open
;
693 exec_ops
.to_close
= exec_close
;
694 exec_ops
.to_attach
= find_default_attach
;
695 exec_ops
.to_xfer_memory
= xfer_memory
;
696 exec_ops
.to_files_info
= exec_files_info
;
697 exec_ops
.to_insert_breakpoint
= ignore
;
698 exec_ops
.to_remove_breakpoint
= ignore
;
699 exec_ops
.to_create_inferior
= find_default_create_inferior
;
700 exec_ops
.to_stratum
= file_stratum
;
701 exec_ops
.to_has_memory
= 1;
702 exec_ops
.to_make_corefile_notes
= exec_make_note_section
;
703 exec_ops
.to_magic
= OPS_MAGIC
;
707 _initialize_exec (void)
709 struct cmd_list_element
*c
;
715 c
= add_cmd ("file", class_files
, file_command
,
716 "Use FILE as program to be debugged.\n\
717 It is read for its symbols, for getting the contents of pure memory,\n\
718 and it is the program executed when you use the `run' command.\n\
719 If FILE cannot be found as specified, your execution directory path\n\
720 ($PATH) is searched for a command of that name.\n\
721 No arg means to have no executable file and no symbols.", &cmdlist
);
722 set_cmd_completer (c
, filename_completer
);
725 c
= add_cmd ("exec-file", class_files
, exec_file_command
,
726 "Use FILE as program for getting contents of pure memory.\n\
727 If FILE cannot be found as specified, your execution directory path\n\
728 is searched for a command of that name.\n\
729 No arg means have no executable file.", &cmdlist
);
730 set_cmd_completer (c
, filename_completer
);
732 add_com ("section", class_files
, set_section_command
,
733 "Change the base address of section SECTION of the exec file to ADDR.\n\
734 This can be used if the exec file does not contain section addresses,\n\
735 (such as in the a.out format), or when the addresses specified in the\n\
736 file itself are wrong. Each section must be changed separately. The\n\
737 ``info files'' command lists all the sections and their addresses.");
740 (add_set_cmd ("write", class_support
, var_boolean
, (char *) &write_files
,
741 "Set writing into executable and core files.",
745 add_target (&exec_ops
);
749 exec_make_note_section (bfd
*obfd
, int *note_size
)
751 error ("Can't create a corefile");