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 <sys/types.h>
41 #include <readline/readline.h>
42 #include "gdb_string.h"
52 #include "xcoffsolib.h"
54 struct vmap
*map_vmap (bfd
*, bfd
*);
56 void (*file_changed_hook
) (char *);
58 /* Prototypes for local functions */
60 static void add_to_section_table (bfd
*, sec_ptr
, void *);
62 static void exec_close (int);
64 static void file_command (char *, int);
66 static void set_section_command (char *, int);
68 static void exec_files_info (struct target_ops
*);
70 static void bfdsec_to_vmap (bfd
*, sec_ptr
, void *);
72 static int ignore (CORE_ADDR
, char *);
74 static void init_exec_ops (void);
76 void _initialize_exec (void);
78 /* The target vector for executable files. */
80 struct target_ops exec_ops
;
82 /* The Binary File Descriptor handle for the executable file. */
86 /* Whether to open exec and core files read-only or read-write. */
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"), 1, 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"), 1, exename
, write_files
?
210 O_RDWR
| O_BINARY
: O_RDONLY
| O_BINARY
, 0, &scratch_pathname
);
213 if (scratch_chan
< 0)
214 perror_with_name (filename
);
215 exec_bfd
= bfd_fdopenr (scratch_pathname
, gnutarget
, scratch_chan
);
218 error ("\"%s\": could not open as an executable file: %s",
219 scratch_pathname
, bfd_errmsg (bfd_get_error ()));
221 /* At this point, scratch_pathname and exec_bfd->name both point to the
222 same malloc'd string. However exec_close() will attempt to free it
223 via the exec_bfd->name pointer, so we need to make another copy and
224 leave exec_bfd as the new owner of the original copy. */
225 scratch_pathname
= xstrdup (scratch_pathname
);
226 make_cleanup (xfree
, scratch_pathname
);
228 if (!bfd_check_format (exec_bfd
, bfd_object
))
230 /* Make sure to close exec_bfd, or else "run" might try to use
233 error ("\"%s\": not in executable format: %s",
234 scratch_pathname
, bfd_errmsg (bfd_get_error ()));
237 /* FIXME - This should only be run for RS6000, but the ifdef is a poor
238 way to accomplish. */
239 #ifdef DEPRECATED_IBM6000_TARGET
240 /* Setup initial vmap. */
242 map_vmap (exec_bfd
, 0);
245 /* Make sure to close exec_bfd, or else "run" might try to use
248 error ("\"%s\": can't find the file sections: %s",
249 scratch_pathname
, bfd_errmsg (bfd_get_error ()));
251 #endif /* DEPRECATED_IBM6000_TARGET */
253 if (build_section_table (exec_bfd
, &exec_ops
.to_sections
,
254 &exec_ops
.to_sections_end
))
256 /* Make sure to close exec_bfd, or else "run" might try to use
259 error ("\"%s\": can't find the file sections: %s",
260 scratch_pathname
, bfd_errmsg (bfd_get_error ()));
263 #ifdef DEPRECATED_HPUX_TEXT_END
264 DEPRECATED_HPUX_TEXT_END (&exec_ops
);
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 (exec_file_display_hook
)
275 (*exec_file_display_hook
) (filename
);
279 /* Process the first arg in ARGS as the new exec file.
281 Note that we have to explicitly ignore additional args, since we can
282 be called from file_command(), which also calls symbol_file_command()
283 which can take multiple args.
285 If ARGS is NULL, we just want to close the exec file. */
288 exec_file_command (char *args
, int from_tty
)
293 target_preopen (from_tty
);
297 /* Scan through the args and pick up the first non option arg
300 argv
= buildargv (args
);
304 make_cleanup_freeargv (argv
);
306 for (; (*argv
!= NULL
) && (**argv
== '-'); argv
++)
310 error ("No executable file name was specified");
312 filename
= tilde_expand (*argv
);
313 make_cleanup (xfree
, filename
);
314 exec_file_attach (filename
, from_tty
);
317 exec_file_attach (NULL
, from_tty
);
320 /* Set both the exec file and the symbol file, in one command.
321 What a novelty. Why did GDB go through four major releases before this
322 command was added? */
325 file_command (char *arg
, int from_tty
)
327 /* FIXME, if we lose on reading the symbol file, we should revert
328 the exec file, but that's rough. */
329 exec_file_command (arg
, from_tty
);
330 symbol_file_command (arg
, from_tty
);
331 if (file_changed_hook
)
332 file_changed_hook (arg
);
336 /* Locate all mappable sections of a BFD file.
337 table_pp_char is a char * to get it through bfd_map_over_sections;
338 we cast it back to its proper type. */
341 add_to_section_table (bfd
*abfd
, sec_ptr asect
, void *table_pp_char
)
343 struct section_table
**table_pp
= (struct section_table
**) table_pp_char
;
346 aflag
= bfd_get_section_flags (abfd
, asect
);
347 if (!(aflag
& SEC_ALLOC
))
349 if (0 == bfd_section_size (abfd
, asect
))
351 (*table_pp
)->bfd
= abfd
;
352 (*table_pp
)->the_bfd_section
= asect
;
353 (*table_pp
)->addr
= bfd_section_vma (abfd
, asect
);
354 (*table_pp
)->endaddr
= (*table_pp
)->addr
+ bfd_section_size (abfd
, asect
);
358 /* Builds a section table, given args BFD, SECTABLE_PTR, SECEND_PTR.
359 Returns 0 if OK, 1 on error. */
362 build_section_table (bfd
*some_bfd
, struct section_table
**start
,
363 struct section_table
**end
)
367 count
= bfd_count_sections (some_bfd
);
370 *start
= (struct section_table
*) xmalloc (count
* sizeof (**start
));
372 bfd_map_over_sections (some_bfd
, add_to_section_table
, (char *) end
);
373 if (*end
> *start
+ count
)
374 internal_error (__FILE__
, __LINE__
, "failed internal consistency check");
375 /* We could realloc the table, but it probably loses for most files. */
380 bfdsec_to_vmap (bfd
*abfd
, sec_ptr sect
, void *arg3
)
382 struct vmap_and_bfd
*vmap_bfd
= (struct vmap_and_bfd
*) arg3
;
385 vp
= vmap_bfd
->pvmap
;
387 if ((bfd_get_section_flags (abfd
, sect
) & SEC_LOAD
) == 0)
390 if (STREQ (bfd_section_name (abfd
, sect
), ".text"))
392 vp
->tstart
= bfd_section_vma (abfd
, sect
);
393 vp
->tend
= vp
->tstart
+ bfd_section_size (abfd
, sect
);
394 vp
->tvma
= bfd_section_vma (abfd
, sect
);
395 vp
->toffs
= sect
->filepos
;
397 else if (STREQ (bfd_section_name (abfd
, sect
), ".data"))
399 vp
->dstart
= bfd_section_vma (abfd
, sect
);
400 vp
->dend
= vp
->dstart
+ bfd_section_size (abfd
, sect
);
401 vp
->dvma
= bfd_section_vma (abfd
, sect
);
403 /* Silently ignore other types of sections. (FIXME?) */
406 /* Make a vmap for ABFD which might be a member of the archive ARCH.
407 Return the new vmap. */
410 map_vmap (bfd
*abfd
, bfd
*arch
)
412 struct vmap_and_bfd vmap_bfd
;
413 struct vmap
*vp
, **vpp
;
415 vp
= (struct vmap
*) xmalloc (sizeof (*vp
));
416 memset ((char *) vp
, '\0', sizeof (*vp
));
419 vp
->name
= bfd_get_filename (arch
? arch
: abfd
);
420 vp
->member
= arch
? bfd_get_filename (abfd
) : "";
422 vmap_bfd
.pbfd
= arch
;
424 bfd_map_over_sections (abfd
, bfdsec_to_vmap
, &vmap_bfd
);
426 /* Find the end of the list and append. */
427 for (vpp
= &vmap
; *vpp
; vpp
= &(*vpp
)->nxt
)
434 /* Read or write the exec file.
436 Args are address within a BFD file, address within gdb address-space,
437 length, and a flag indicating whether to read or write.
441 0: We cannot handle this address and length.
442 > 0: We have handled N bytes starting at this address.
443 (If N == length, we did it all.) We might be able
444 to handle more bytes beyond this length, but no
446 < 0: We cannot handle this address, but if somebody
447 else handles (-N) bytes, we can start from there.
449 The same routine is used to handle both core and exec files;
450 we just tail-call it with more arguments to select between them. */
453 xfer_memory (CORE_ADDR memaddr
, char *myaddr
, int len
, int write
,
454 struct mem_attrib
*attrib
,
455 struct target_ops
*target
)
458 struct section_table
*p
;
459 CORE_ADDR nextsectaddr
, memend
;
460 int (*xfer_fn
) (bfd
*, sec_ptr
, void *, file_ptr
, bfd_size_type
);
461 asection
*section
= NULL
;
464 internal_error (__FILE__
, __LINE__
, "failed internal consistency check");
466 if (overlay_debugging
)
468 section
= find_pc_overlay (memaddr
);
469 if (pc_in_unmapped_range (memaddr
, section
))
470 memaddr
= overlay_mapped_address (memaddr
, section
);
473 memend
= memaddr
+ len
;
474 xfer_fn
= write
? bfd_set_section_contents
: bfd_get_section_contents
;
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. */
487 res
= xfer_fn (p
->bfd
, p
->the_bfd_section
, myaddr
,
488 memaddr
- p
->addr
, len
);
489 return (res
!= 0) ? len
: 0;
491 else if (memaddr
>= p
->endaddr
)
493 /* This section ends before the transfer starts. */
498 /* This section overlaps the transfer. Just do half. */
499 len
= p
->endaddr
- memaddr
;
500 res
= xfer_fn (p
->bfd
, p
->the_bfd_section
, myaddr
,
501 memaddr
- p
->addr
, len
);
502 return (res
!= 0) ? len
: 0;
506 nextsectaddr
= min (nextsectaddr
, p
->addr
);
509 if (nextsectaddr
>= memend
)
510 return 0; /* We can't help */
512 return -(nextsectaddr
- memaddr
); /* Next boundary where we can help */
517 print_section_info (struct target_ops
*t
, bfd
*abfd
)
519 struct section_table
*p
;
520 /* FIXME: "016l" is not wide enough when TARGET_ADDR_BIT > 64. */
521 char *fmt
= TARGET_ADDR_BIT
<= 32 ? "08l" : "016l";
523 printf_filtered ("\t`%s', ", bfd_get_filename (abfd
));
525 printf_filtered ("file type %s.\n", bfd_get_target (abfd
));
526 if (abfd
== exec_bfd
)
528 printf_filtered ("\tEntry point: ");
529 print_address_numeric (bfd_get_start_address (abfd
), 1, gdb_stdout
);
530 printf_filtered ("\n");
532 for (p
= t
->to_sections
; p
< t
->to_sections_end
; p
++)
534 printf_filtered ("\t%s", local_hex_string_custom (p
->addr
, fmt
));
535 printf_filtered (" - %s", local_hex_string_custom (p
->endaddr
, fmt
));
537 /* FIXME: A format of "08l" is not wide enough for file offsets
538 larger than 4GB. OTOH, making it "016l" isn't desirable either
539 since most output will then be much wider than necessary. It
540 may make sense to test the size of the file and choose the
541 format string accordingly. */
543 printf_filtered (" @ %s",
544 local_hex_string_custom (p
->the_bfd_section
->filepos
, "08l"));
545 printf_filtered (" is %s", bfd_section_name (p
->bfd
, p
->the_bfd_section
));
548 printf_filtered (" in %s", bfd_get_filename (p
->bfd
));
550 printf_filtered ("\n");
555 exec_files_info (struct target_ops
*t
)
557 print_section_info (t
, exec_bfd
);
563 printf_unfiltered ("\tMapping info for file `%s'.\n", vmap
->name
);
564 printf_unfiltered ("\t %*s %*s %*s %*s %8.8s %s\n",
565 strlen_paddr (), "tstart",
566 strlen_paddr (), "tend",
567 strlen_paddr (), "dstart",
568 strlen_paddr (), "dend",
572 for (vp
= vmap
; vp
; vp
= vp
->nxt
)
573 printf_unfiltered ("\t0x%s 0x%s 0x%s 0x%s %s%s%s%s\n",
579 *vp
->member
? "(" : "", vp
->member
,
580 *vp
->member
? ")" : "");
585 exec_set_section_offsets sets the offsets of all the sections
586 in the exec objfile. */
589 exec_set_section_offsets (bfd_signed_vma text_off
, bfd_signed_vma data_off
,
590 bfd_signed_vma bss_off
)
592 struct section_table
*sect
;
594 for (sect
= exec_ops
.to_sections
;
595 sect
< exec_ops
.to_sections_end
;
600 flags
= bfd_get_section_flags (exec_bfd
, sect
->the_bfd_section
);
602 if (flags
& SEC_CODE
)
604 sect
->addr
+= text_off
;
605 sect
->endaddr
+= text_off
;
607 else if (flags
& (SEC_DATA
| SEC_LOAD
))
609 sect
->addr
+= data_off
;
610 sect
->endaddr
+= data_off
;
612 else if (flags
& SEC_ALLOC
)
614 sect
->addr
+= bss_off
;
615 sect
->endaddr
+= bss_off
;
621 set_section_command (char *args
, int from_tty
)
623 struct section_table
*p
;
626 unsigned long secaddr
;
631 error ("Must specify section name and its virtual address");
633 /* Parse out section name */
634 for (secname
= args
; !isspace (*args
); args
++);
635 seclen
= args
- secname
;
637 /* Parse out new virtual address */
638 secaddr
= parse_and_eval_address (args
);
640 for (p
= exec_ops
.to_sections
; p
< exec_ops
.to_sections_end
; p
++)
642 if (!strncmp (secname
, bfd_section_name (exec_bfd
, p
->the_bfd_section
), seclen
)
643 && bfd_section_name (exec_bfd
, p
->the_bfd_section
)[seclen
] == '\0')
645 offset
= secaddr
- p
->addr
;
647 p
->endaddr
+= offset
;
649 exec_files_info (&exec_ops
);
653 if (seclen
>= sizeof (secprint
))
654 seclen
= sizeof (secprint
) - 1;
655 strncpy (secprint
, secname
, seclen
);
656 secprint
[seclen
] = '\0';
657 error ("Section %s not found", secprint
);
660 /* If mourn is being called in all the right places, this could be say
661 `gdb internal error' (since generic_mourn calls
662 breakpoint_init_inferior). */
665 ignore (CORE_ADDR addr
, char *contents
)
670 /* Find mapped memory. */
673 exec_set_find_memory_regions (int (*func
) (int (*) (CORE_ADDR
,
679 exec_ops
.to_find_memory_regions
= func
;
682 static char *exec_make_note_section (bfd
*, int *);
684 /* Fill in the exec file target vector. Very few entries need to be
690 exec_ops
.to_shortname
= "exec";
691 exec_ops
.to_longname
= "Local exec file";
692 exec_ops
.to_doc
= "Use an executable file as a target.\n\
693 Specify the filename of the executable file.";
694 exec_ops
.to_open
= exec_open
;
695 exec_ops
.to_close
= exec_close
;
696 exec_ops
.to_attach
= find_default_attach
;
697 exec_ops
.to_xfer_memory
= xfer_memory
;
698 exec_ops
.to_files_info
= exec_files_info
;
699 exec_ops
.to_insert_breakpoint
= ignore
;
700 exec_ops
.to_remove_breakpoint
= ignore
;
701 exec_ops
.to_create_inferior
= find_default_create_inferior
;
702 exec_ops
.to_stratum
= file_stratum
;
703 exec_ops
.to_has_memory
= 1;
704 exec_ops
.to_make_corefile_notes
= exec_make_note_section
;
705 exec_ops
.to_magic
= OPS_MAGIC
;
709 _initialize_exec (void)
711 struct cmd_list_element
*c
;
717 c
= add_cmd ("file", class_files
, file_command
,
718 "Use FILE as program to be debugged.\n\
719 It is read for its symbols, for getting the contents of pure memory,\n\
720 and it is the program executed when you use the `run' command.\n\
721 If FILE cannot be found as specified, your execution directory path\n\
722 ($PATH) is searched for a command of that name.\n\
723 No arg means to have no executable file and no symbols.", &cmdlist
);
724 set_cmd_completer (c
, filename_completer
);
727 c
= add_cmd ("exec-file", class_files
, exec_file_command
,
728 "Use FILE as program for getting contents of pure memory.\n\
729 If FILE cannot be found as specified, your execution directory path\n\
730 is searched for a command of that name.\n\
731 No arg means have no executable file.", &cmdlist
);
732 set_cmd_completer (c
, filename_completer
);
734 add_com ("section", class_files
, set_section_command
,
735 "Change the base address of section SECTION of the exec file to ADDR.\n\
736 This can be used if the exec file does not contain section addresses,\n\
737 (such as in the a.out format), or when the addresses specified in the\n\
738 file itself are wrong. Each section must be changed separately. The\n\
739 ``info files'' command lists all the sections and their addresses.");
742 (add_set_cmd ("write", class_support
, var_boolean
, (char *) &write_files
,
743 "Set writing into executable and core files.",
747 add_target (&exec_ops
);
751 exec_make_note_section (bfd
*obfd
, int *note_size
)
753 error ("Can't create a corefile");