gdb/gcore.c

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