gdb/gcore.c

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