use bound_minsym as result for lookup_minimal_symbol et al
[external/binutils.git] / gdb / gcore.c
1 /* Generate a core file for the inferior process.
2
3    Copyright (C) 2001-2014 Free Software Foundation, Inc.
4
5    This file is part of GDB.
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
19
20 #include "defs.h"
21 #include "elf-bfd.h"
22 #include "infcall.h"
23 #include "inferior.h"
24 #include "gdbcore.h"
25 #include "objfiles.h"
26 #include "solib.h"
27 #include "symfile.h"
28 #include "arch-utils.h"
29 #include "completer.h"
30 #include "gcore.h"
31 #include "cli/cli-decode.h"
32 #include "gdb_assert.h"
33 #include <fcntl.h>
34 #include "regcache.h"
35 #include "regset.h"
36 #include "gdb_bfd.h"
37 #include "readline/tilde.h"
38
39 /* The largest amount of memory to read from the target at once.  We
40    must throttle it to limit the amount of memory used by GDB during
41    generate-core-file for programs with large resident data.  */
42 #define MAX_COPY_BYTES (1024 * 1024)
43
44 static const char *default_gcore_target (void);
45 static enum bfd_architecture default_gcore_arch (void);
46 static unsigned long default_gcore_mach (void);
47 static int gcore_memory_sections (bfd *);
48
49 /* create_gcore_bfd -- helper for gcore_command (exported).
50    Open a new bfd core file for output, and return the handle.  */
51
52 bfd *
53 create_gcore_bfd (const char *filename)
54 {
55   bfd *obfd = gdb_bfd_openw (filename, default_gcore_target ());
56
57   if (!obfd)
58     error (_("Failed to open '%s' for output."), filename);
59   bfd_set_format (obfd, bfd_core);
60   bfd_set_arch_mach (obfd, default_gcore_arch (), default_gcore_mach ());
61   return obfd;
62 }
63
64 /* write_gcore_file -- helper for gcore_command (exported).
65    Compose and write the corefile data to the core file.  */
66
67
68 void
69 write_gcore_file (bfd *obfd)
70 {
71   void *note_data = NULL;
72   int note_size = 0;
73   asection *note_sec = NULL;
74
75   /* An external target method must build the notes section.  */
76   /* FIXME: uweigand/2011-10-06: All architectures that support core file
77      generation should be converted to gdbarch_make_corefile_notes; at that
78      point, the target vector method can be removed.  */
79   if (!gdbarch_make_corefile_notes_p (target_gdbarch ()))
80     note_data = target_make_corefile_notes (obfd, &note_size);
81   else
82     note_data = gdbarch_make_corefile_notes (target_gdbarch (), obfd, &note_size);
83
84   if (note_data == NULL || note_size == 0)
85     error (_("Target does not support core file generation."));
86
87   /* Create the note section.  */
88   note_sec = bfd_make_section_anyway_with_flags (obfd, "note0",
89                                                  SEC_HAS_CONTENTS
90                                                  | SEC_READONLY
91                                                  | SEC_ALLOC);
92   if (note_sec == NULL)
93     error (_("Failed to create 'note' section for corefile: %s"),
94            bfd_errmsg (bfd_get_error ()));
95
96   bfd_set_section_vma (obfd, note_sec, 0);
97   bfd_set_section_alignment (obfd, note_sec, 0);
98   bfd_set_section_size (obfd, note_sec, note_size);
99
100   /* Now create the memory/load sections.  */
101   if (gcore_memory_sections (obfd) == 0)
102     error (_("gcore: failed to get corefile memory sections from target."));
103
104   /* Write out the contents of the note section.  */
105   if (!bfd_set_section_contents (obfd, note_sec, note_data, 0, note_size))
106     warning (_("writing note section (%s)"), bfd_errmsg (bfd_get_error ()));
107 }
108
109 static void
110 do_bfd_delete_cleanup (void *arg)
111 {
112   bfd *obfd = arg;
113   const char *filename = obfd->filename;
114
115   gdb_bfd_unref (arg);
116   unlink (filename);
117 }
118
119 /* gcore_command -- implements the 'gcore' command.
120    Generate a core file from the inferior process.  */
121
122 static void
123 gcore_command (char *args, int from_tty)
124 {
125   struct cleanup *filename_chain;
126   struct cleanup *bfd_chain;
127   char *corefilename;
128   bfd *obfd;
129
130   /* No use generating a corefile without a target process.  */
131   if (!target_has_execution)
132     noprocess ();
133
134   if (args && *args)
135     corefilename = tilde_expand (args);
136   else
137     {
138       /* Default corefile name is "core.PID".  */
139       corefilename = xstrprintf ("core.%d", ptid_get_pid (inferior_ptid));
140     }
141   filename_chain = make_cleanup (xfree, corefilename);
142
143   if (info_verbose)
144     fprintf_filtered (gdb_stdout,
145                       "Opening corefile '%s' for output.\n", corefilename);
146
147   /* Open the output file.  */
148   obfd = create_gcore_bfd (corefilename);
149
150   /* Need a cleanup that will close and delete the file.  */
151   bfd_chain = make_cleanup (do_bfd_delete_cleanup, obfd);
152
153   /* Call worker function.  */
154   write_gcore_file (obfd);
155
156   /* Succeeded.  */
157   discard_cleanups (bfd_chain);
158   gdb_bfd_unref (obfd);
159
160   fprintf_filtered (gdb_stdout, "Saved corefile %s\n", corefilename);
161   do_cleanups (filename_chain);
162 }
163
164 static unsigned long
165 default_gcore_mach (void)
166 {
167 #if 1   /* See if this even matters...  */
168   return 0;
169 #else
170
171   const struct bfd_arch_info *bfdarch = gdbarch_bfd_arch_info (target_gdbarch ());
172
173   if (bfdarch != NULL)
174     return bfdarch->mach;
175   if (exec_bfd == NULL)
176     error (_("Can't find default bfd machine type (need execfile)."));
177
178   return bfd_get_mach (exec_bfd);
179 #endif /* 1 */
180 }
181
182 static enum bfd_architecture
183 default_gcore_arch (void)
184 {
185   const struct bfd_arch_info *bfdarch = gdbarch_bfd_arch_info (target_gdbarch ());
186
187   if (bfdarch != NULL)
188     return bfdarch->arch;
189   if (exec_bfd == NULL)
190     error (_("Can't find bfd architecture for corefile (need execfile)."));
191
192   return bfd_get_arch (exec_bfd);
193 }
194
195 static const char *
196 default_gcore_target (void)
197 {
198   /* The gdbarch may define a target to use for core files.  */
199   if (gdbarch_gcore_bfd_target_p (target_gdbarch ()))
200     return gdbarch_gcore_bfd_target (target_gdbarch ());
201
202   /* Otherwise, try to fall back to the exec_bfd target.  This will probably
203      not work for non-ELF targets.  */
204   if (exec_bfd == NULL)
205     return NULL;
206   else
207     return bfd_get_target (exec_bfd);
208 }
209
210 /* Derive a reasonable stack segment by unwinding the target stack,
211    and store its limits in *BOTTOM and *TOP.  Return non-zero if
212    successful.  */
213
214 static int
215 derive_stack_segment (bfd_vma *bottom, bfd_vma *top)
216 {
217   struct frame_info *fi, *tmp_fi;
218
219   gdb_assert (bottom);
220   gdb_assert (top);
221
222   /* Can't succeed without stack and registers.  */
223   if (!target_has_stack || !target_has_registers)
224     return 0;
225
226   /* Can't succeed without current frame.  */
227   fi = get_current_frame ();
228   if (fi == NULL)
229     return 0;
230
231   /* Save frame pointer of TOS frame.  */
232   *top = get_frame_base (fi);
233   /* If current stack pointer is more "inner", use that instead.  */
234   if (gdbarch_inner_than (get_frame_arch (fi), get_frame_sp (fi), *top))
235     *top = get_frame_sp (fi);
236
237   /* Find prev-most frame.  */
238   while ((tmp_fi = get_prev_frame (fi)) != NULL)
239     fi = tmp_fi;
240
241   /* Save frame pointer of prev-most frame.  */
242   *bottom = get_frame_base (fi);
243
244   /* Now canonicalize their order, so that BOTTOM is a lower address
245      (as opposed to a lower stack frame).  */
246   if (*bottom > *top)
247     {
248       bfd_vma tmp_vma;
249
250       tmp_vma = *top;
251       *top = *bottom;
252       *bottom = tmp_vma;
253     }
254
255   return 1;
256 }
257
258 /* call_target_sbrk --
259    helper function for derive_heap_segment.  */
260
261 static bfd_vma
262 call_target_sbrk (int sbrk_arg)
263 {
264   struct objfile *sbrk_objf;
265   struct gdbarch *gdbarch;
266   bfd_vma top_of_heap;
267   struct value *target_sbrk_arg;
268   struct value *sbrk_fn, *ret;
269   bfd_vma tmp;
270
271   if (lookup_minimal_symbol ("sbrk", NULL, NULL).minsym != NULL)
272     {
273       sbrk_fn = find_function_in_inferior ("sbrk", &sbrk_objf);
274       if (sbrk_fn == NULL)
275         return (bfd_vma) 0;
276     }
277   else if (lookup_minimal_symbol ("_sbrk", NULL, NULL).minsym != NULL)
278     {
279       sbrk_fn = find_function_in_inferior ("_sbrk", &sbrk_objf);
280       if (sbrk_fn == NULL)
281         return (bfd_vma) 0;
282     }
283   else
284     return (bfd_vma) 0;
285
286   gdbarch = get_objfile_arch (sbrk_objf);
287   target_sbrk_arg = value_from_longest (builtin_type (gdbarch)->builtin_int, 
288                                         sbrk_arg);
289   gdb_assert (target_sbrk_arg);
290   ret = call_function_by_hand (sbrk_fn, 1, &target_sbrk_arg);
291   if (ret == NULL)
292     return (bfd_vma) 0;
293
294   tmp = value_as_long (ret);
295   if ((LONGEST) tmp <= 0 || (LONGEST) tmp == 0xffffffff)
296     return (bfd_vma) 0;
297
298   top_of_heap = tmp;
299   return top_of_heap;
300 }
301
302 /* Derive a reasonable heap segment for ABFD by looking at sbrk and
303    the static data sections.  Store its limits in *BOTTOM and *TOP.
304    Return non-zero if successful.  */
305
306 static int
307 derive_heap_segment (bfd *abfd, bfd_vma *bottom, bfd_vma *top)
308 {
309   bfd_vma top_of_data_memory = 0;
310   bfd_vma top_of_heap = 0;
311   bfd_size_type sec_size;
312   bfd_vma sec_vaddr;
313   asection *sec;
314
315   gdb_assert (bottom);
316   gdb_assert (top);
317
318   /* This function depends on being able to call a function in the
319      inferior.  */
320   if (!target_has_execution)
321     return 0;
322
323   /* The following code assumes that the link map is arranged as
324      follows (low to high addresses):
325
326      ---------------------------------
327      | text sections                 |
328      ---------------------------------
329      | data sections (including bss) |
330      ---------------------------------
331      | heap                          |
332      --------------------------------- */
333
334   for (sec = abfd->sections; sec; sec = sec->next)
335     {
336       if (bfd_get_section_flags (abfd, sec) & SEC_DATA
337           || strcmp (".bss", bfd_section_name (abfd, sec)) == 0)
338         {
339           sec_vaddr = bfd_get_section_vma (abfd, sec);
340           sec_size = bfd_get_section_size (sec);
341           if (sec_vaddr + sec_size > top_of_data_memory)
342             top_of_data_memory = sec_vaddr + sec_size;
343         }
344     }
345
346   top_of_heap = call_target_sbrk (0);
347   if (top_of_heap == (bfd_vma) 0)
348     return 0;
349
350   /* Return results.  */
351   if (top_of_heap > top_of_data_memory)
352     {
353       *bottom = top_of_data_memory;
354       *top = top_of_heap;
355       return 1;
356     }
357
358   /* No additional heap space needs to be saved.  */
359   return 0;
360 }
361
362 static void
363 make_output_phdrs (bfd *obfd, asection *osec, void *ignored)
364 {
365   int p_flags = 0;
366   int p_type = 0;
367
368   /* FIXME: these constants may only be applicable for ELF.  */
369   if (strncmp (bfd_section_name (obfd, osec), "load", 4) == 0)
370     p_type = PT_LOAD;
371   else if (strncmp (bfd_section_name (obfd, osec), "note", 4) == 0)
372     p_type = PT_NOTE;
373   else
374     p_type = PT_NULL;
375
376   p_flags |= PF_R;      /* Segment is readable.  */
377   if (!(bfd_get_section_flags (obfd, osec) & SEC_READONLY))
378     p_flags |= PF_W;    /* Segment is writable.  */
379   if (bfd_get_section_flags (obfd, osec) & SEC_CODE)
380     p_flags |= PF_X;    /* Segment is executable.  */
381
382   bfd_record_phdr (obfd, p_type, 1, p_flags, 0, 0, 0, 0, 1, &osec);
383 }
384
385 /* find_memory_region_ftype implementation.  DATA is 'bfd *' for the core file
386    GDB is creating.  */
387
388 static int
389 gcore_create_callback (CORE_ADDR vaddr, unsigned long size, int read,
390                        int write, int exec, int modified, void *data)
391 {
392   bfd *obfd = data;
393   asection *osec;
394   flagword flags = SEC_ALLOC | SEC_HAS_CONTENTS | SEC_LOAD;
395
396   /* If the memory segment has no permissions set, ignore it, otherwise
397      when we later try to access it for read/write, we'll get an error
398      or jam the kernel.  */
399   if (read == 0 && write == 0 && exec == 0 && modified == 0)
400     {
401       if (info_verbose)
402         {
403           fprintf_filtered (gdb_stdout, "Ignore segment, %s bytes at %s\n",
404                             plongest (size), paddress (target_gdbarch (), vaddr));
405         }
406
407       return 0;
408     }
409
410   if (write == 0 && modified == 0 && !solib_keep_data_in_core (vaddr, size))
411     {
412       /* See if this region of memory lies inside a known file on disk.
413          If so, we can avoid copying its contents by clearing SEC_LOAD.  */
414       struct objfile *objfile;
415       struct obj_section *objsec;
416
417       ALL_OBJSECTIONS (objfile, objsec)
418         {
419           bfd *abfd = objfile->obfd;
420           asection *asec = objsec->the_bfd_section;
421           bfd_vma align = (bfd_vma) 1 << bfd_get_section_alignment (abfd,
422                                                                     asec);
423           bfd_vma start = obj_section_addr (objsec) & -align;
424           bfd_vma end = (obj_section_endaddr (objsec) + align - 1) & -align;
425
426           /* Match if either the entire memory region lies inside the
427              section (i.e. a mapping covering some pages of a large
428              segment) or the entire section lies inside the memory region
429              (i.e. a mapping covering multiple small sections).
430
431              This BFD was synthesized from reading target memory,
432              we don't want to omit that.  */
433           if (objfile->separate_debug_objfile_backlink == NULL
434               && ((vaddr >= start && vaddr + size <= end)
435                   || (start >= vaddr && end <= vaddr + size))
436               && !(bfd_get_file_flags (abfd) & BFD_IN_MEMORY))
437             {
438               flags &= ~(SEC_LOAD | SEC_HAS_CONTENTS);
439               goto keep;        /* Break out of two nested for loops.  */
440             }
441         }
442
443     keep:;
444     }
445
446   if (write == 0)
447     flags |= SEC_READONLY;
448
449   if (exec)
450     flags |= SEC_CODE;
451   else
452     flags |= SEC_DATA;
453
454   osec = bfd_make_section_anyway_with_flags (obfd, "load", flags);
455   if (osec == NULL)
456     {
457       warning (_("Couldn't make gcore segment: %s"),
458                bfd_errmsg (bfd_get_error ()));
459       return 1;
460     }
461
462   if (info_verbose)
463     {
464       fprintf_filtered (gdb_stdout, "Save segment, %s bytes at %s\n",
465                         plongest (size), paddress (target_gdbarch (), vaddr));
466     }
467
468   bfd_set_section_size (obfd, osec, size);
469   bfd_set_section_vma (obfd, osec, vaddr);
470   bfd_section_lma (obfd, osec) = 0; /* ??? bfd_set_section_lma?  */
471   return 0;
472 }
473
474 int
475 objfile_find_memory_regions (struct target_ops *self,
476                              find_memory_region_ftype func, void *obfd)
477 {
478   /* Use objfile data to create memory sections.  */
479   struct objfile *objfile;
480   struct obj_section *objsec;
481   bfd_vma temp_bottom, temp_top;
482
483   /* Call callback function for each objfile section.  */
484   ALL_OBJSECTIONS (objfile, objsec)
485     {
486       bfd *ibfd = objfile->obfd;
487       asection *isec = objsec->the_bfd_section;
488       flagword flags = bfd_get_section_flags (ibfd, isec);
489
490       /* Separate debug info files are irrelevant for gcore.  */
491       if (objfile->separate_debug_objfile_backlink != NULL)
492         continue;
493
494       if ((flags & SEC_ALLOC) || (flags & SEC_LOAD))
495         {
496           int size = bfd_section_size (ibfd, isec);
497           int ret;
498
499           ret = (*func) (obj_section_addr (objsec), size, 
500                          1, /* All sections will be readable.  */
501                          (flags & SEC_READONLY) == 0, /* Writable.  */
502                          (flags & SEC_CODE) != 0, /* Executable.  */
503                          1, /* MODIFIED is unknown, pass it as true.  */
504                          obfd);
505           if (ret != 0)
506             return ret;
507         }
508     }
509
510   /* Make a stack segment.  */
511   if (derive_stack_segment (&temp_bottom, &temp_top))
512     (*func) (temp_bottom, temp_top - temp_bottom,
513              1, /* Stack section will be readable.  */
514              1, /* Stack section will be writable.  */
515              0, /* Stack section will not be executable.  */
516              1, /* Stack section will be modified.  */
517              obfd);
518
519   /* Make a heap segment.  */
520   if (derive_heap_segment (exec_bfd, &temp_bottom, &temp_top))
521     (*func) (temp_bottom, temp_top - temp_bottom,
522              1, /* Heap section will be readable.  */
523              1, /* Heap section will be writable.  */
524              0, /* Heap section will not be executable.  */
525              1, /* Heap section will be modified.  */
526              obfd);
527
528   return 0;
529 }
530
531 static void
532 gcore_copy_callback (bfd *obfd, asection *osec, void *ignored)
533 {
534   bfd_size_type size, total_size = bfd_section_size (obfd, osec);
535   file_ptr offset = 0;
536   struct cleanup *old_chain = NULL;
537   void *memhunk;
538
539   /* Read-only sections are marked; we don't have to copy their contents.  */
540   if ((bfd_get_section_flags (obfd, osec) & SEC_LOAD) == 0)
541     return;
542
543   /* Only interested in "load" sections.  */
544   if (strncmp ("load", bfd_section_name (obfd, osec), 4) != 0)
545     return;
546
547   size = min (total_size, MAX_COPY_BYTES);
548   memhunk = xmalloc (size);
549   old_chain = make_cleanup (xfree, memhunk);
550
551   while (total_size > 0)
552     {
553       if (size > total_size)
554         size = total_size;
555
556       if (target_read_memory (bfd_section_vma (obfd, osec) + offset,
557                               memhunk, size) != 0)
558         {
559           warning (_("Memory read failed for corefile "
560                      "section, %s bytes at %s."),
561                    plongest (size),
562                    paddress (target_gdbarch (), bfd_section_vma (obfd, osec)));
563           break;
564         }
565       if (!bfd_set_section_contents (obfd, osec, memhunk, offset, size))
566         {
567           warning (_("Failed to write corefile contents (%s)."),
568                    bfd_errmsg (bfd_get_error ()));
569           break;
570         }
571
572       total_size -= size;
573       offset += size;
574     }
575
576   do_cleanups (old_chain);      /* Frees MEMHUNK.  */
577 }
578
579 static int
580 gcore_memory_sections (bfd *obfd)
581 {
582   /* Try gdbarch method first, then fall back to target method.  */
583   if (!gdbarch_find_memory_regions_p (target_gdbarch ())
584       || gdbarch_find_memory_regions (target_gdbarch (),
585                                       gcore_create_callback, obfd) != 0)
586     {
587       if (target_find_memory_regions (gcore_create_callback, obfd) != 0)
588         return 0;                       /* FIXME: error return/msg?  */
589     }
590
591   /* Record phdrs for section-to-segment mapping.  */
592   bfd_map_over_sections (obfd, make_output_phdrs, NULL);
593
594   /* Copy memory region contents.  */
595   bfd_map_over_sections (obfd, gcore_copy_callback, NULL);
596
597   return 1;
598 }
599
600 /* Provide a prototype to silence -Wmissing-prototypes.  */
601 extern initialize_file_ftype _initialize_gcore;
602
603 void
604 _initialize_gcore (void)
605 {
606   add_com ("generate-core-file", class_files, gcore_command, _("\
607 Save a core file with the current state of the debugged process.\n\
608 Argument is optional filename.  Default filename is 'core.<process_id>'."));
609
610   add_com_alias ("gcore", "generate-core-file", class_files, 1);
611 }