gdb/gcore.c

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