gdb/gcore.c

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