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