gnu/usr.bin/gdb/core.c

/*-
 * This code is derived from software copyrighted by the Free Software
 * Foundation.
 *
 * Modified 1991 by Donn Seeley at UUNET Technologies, Inc.
 * Modified 1990 by Van Jacobson at Lawrence Berkeley Laboratory.
 */

#ifndef lint
static char sccsid[] = "@(#)core.c      6.3 (Berkeley) 5/8/91";
#endif /* not lint */

/* Work with core dump and executable files, for GDB.
   Copyright (C) 1986, 1987, 1989 Free Software Foundation, Inc.

This file is part of GDB.

GDB is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 1, or (at your option)
any later version.

GDB is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GDB; see the file COPYING.  If not, write to
the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */

#include <stdio.h>
#include "defs.h"
#include "param.h"
#include "frame.h"  /* required by inferior.h */
#include "inferior.h"

#ifdef USG
#include <sys/types.h>
#include <fcntl.h>
#endif

#ifdef COFF_ENCAPSULATE
#include "a.out.encap.h"
#else
#include <a.out.h>
#endif
#ifndef N_MAGIC
#ifdef COFF_FORMAT
#define N_MAGIC(exec) ((exec).magic)
#else
#define N_MAGIC(exec) ((exec).a_magic)
#endif
#endif
#include <signal.h>
#include <sys/param.h>
#include <sys/dir.h>
#include <sys/file.h>
#include <sys/stat.h>

#ifdef UMAX_CORE
#include <sys/ptrace.h>
#else
#include <sys/user.h>
#endif

#ifndef N_TXTADDR
#define N_TXTADDR(hdr) 0
#endif /* no N_TXTADDR */

#ifndef N_DATADDR
#define N_DATADDR(hdr) hdr.a_text
#endif /* no N_DATADDR */

#ifndef COFF_FORMAT
#ifndef AOUTHDR
#define AOUTHDR         struct exec
#endif
#endif

extern char *sys_siglist[];

extern core_file_command (), exec_file_command ();

/* Hook for `exec_file_command' command to call.  */

void (*exec_file_display_hook) ();

/* File names of core file and executable file.  */

char *corefile;
char *execfile;

/* Descriptors on which core file and executable file are open.
   Note that the execchan is closed when an inferior is created
   and reopened if the inferior dies or is killed.  */

int corechan;
int execchan;

/* Last modification time of executable file.
   Also used in source.c to compare against mtime of a source file.  */

int exec_mtime;

/* Virtual addresses of bounds of the two areas of memory in the core file.  */

CORE_ADDR data_start;
CORE_ADDR data_end;
CORE_ADDR stack_start;
CORE_ADDR stack_end;

#if defined (REG_STACK_SEGMENT)
/* Start and end of the register stack segment.  */
CORE_ADDR reg_stack_start;
CORE_ADDR reg_stack_end;
#endif /* REG_STACK_SEGMENT */

/* Virtual addresses of bounds of two areas of memory in the exec file.
   Note that the data area in the exec file is used only when there is no core file.  */

CORE_ADDR text_start;
CORE_ADDR text_end;

CORE_ADDR exec_data_start;
CORE_ADDR exec_data_end;

/* Offset within executable file of start of text area data.  */

int text_offset;

/* Offset within executable file of start of data area data.  */

int exec_data_offset;

/* Offset within core file of start of data area data.  */

int data_offset;

/* Offset within core file of start of stack area data.  */

int stack_offset;

#ifdef COFF_FORMAT
/* various coff data structures */

FILHDR file_hdr;
SCNHDR text_hdr;
SCNHDR data_hdr;

#endif /* not COFF_FORMAT */

/* a.out header saved in core file.  */

AOUTHDR core_aouthdr;

/* a.out header of exec file.  */

AOUTHDR exec_aouthdr;

void validate_files ();
unsigned int register_addr ();
\f
/* Call this to specify the hook for exec_file_command to call back.
   This is called from the x-window display code.  */

void
specify_exec_file_hook (hook)
     void (*hook) ();
{
  exec_file_display_hook = hook;
}

/* The exec file must be closed before running an inferior.
   If it is needed again after the inferior dies, it must
   be reopened.  */

void
close_exec_file ()
{
  if (execchan >= 0)
    close (execchan);
  execchan = -1;
}

void
reopen_exec_file ()
{
  if (execchan < 0 && execfile != 0)
    {
      char *filename = concat (execfile, "", "");
      exec_file_command (filename, 0);
      free (filename);
    }
}
\f
/* If we have both a core file and an exec file,
   print a warning if they don't go together.
   This should really check that the core file came
   from that exec file, but I don't know how to do it.  */

void
validate_files ()
{
  if (execfile != 0 && corefile != 0)
    {
      struct stat st_core;

      if (fstat (corechan, &st_core) < 0)
        /* It might be a good idea to print an error message.
           On the other hand, if the user tries to *do* anything with
           the core file, (s)he'll find out soon enough.  */
        return;

      if (N_MAGIC (core_aouthdr) != 0
          && bcmp (&core_aouthdr, &exec_aouthdr, sizeof core_aouthdr))
        printf ("Warning: core file does not match specified executable file.\n");
      else if (exec_mtime > st_core.st_mtime) {
#ifdef KERNELDEBUG
        extern int kernel_debugging;
        if (!kernel_debugging)
#endif
        printf ("Warning: exec file is newer than core file.\n");
      }
    }
}

/* Return the name of the executable file as a string.
   ERR nonzero means get error if there is none specified;
   otherwise return 0 in that case.  */

char *
get_exec_file (err)
     int err;
{
  if (err && execfile == 0)
    error ("No executable file specified.\n\
Use the \"exec-file\" and \"symbol-file\" commands.");
  return execfile;
}

int
have_core_file_p ()
{
  return corefile != 0;
}

static void
files_info ()
{
  char *symfile;
  extern char *get_sym_file ();

  if (execfile)
    printf ("Executable file \"%s\".\n", execfile);
  else
    printf ("No executable file\n");
  if (corefile == 0)
    printf ("No core dump file\n");
  else
    printf ("Core dump file \"%s\".\n", corefile);

  if (have_inferior_p ())
    printf ("Using the running image of the program, rather than these files.\n");

  symfile = get_sym_file ();
  if (symfile != 0)
    printf ("Symbols from \"%s\".\n", symfile);

#ifdef FILES_INFO_HOOK
  if (FILES_INFO_HOOK ())
    return;
#endif

  if (! have_inferior_p ())
    {
      if (execfile)
        {
          printf ("Text segment in executable from 0x%x to 0x%x.\n",
                  text_start, text_end);
          printf ("Data segment in executable from 0x%x to 0x%x.\n",
                  exec_data_start, exec_data_end);
          if (corefile)
            printf ("(But since we have a core file, we're using...)\n");
        }
      if (corefile)
        {
          printf ("Data segment in core file from 0x%x to 0x%x.\n",
                  data_start, data_end);
          printf ("Stack segment in core file from 0x%x to 0x%x.\n",
                  stack_start, stack_end);
        }
    }
}
\f
/* Read "memory data" from core file and/or executable file.
   Returns zero if successful, 1 if xfer_core_file failed, errno value if
   ptrace failed. */

int
read_memory (memaddr, myaddr, len)
     CORE_ADDR memaddr;
     char *myaddr;
     int len;
{
  if (len == 0)
    return 0;

  if (have_inferior_p ())
    {
      if (remote_debugging)
        return remote_read_inferior_memory (memaddr, myaddr, len);
      else
        return read_inferior_memory (memaddr, myaddr, len);
    }
  else
      return xfer_core_file (memaddr, myaddr, len);
}

/* Write LEN bytes of data starting at address MYADDR
   into debugged program memory at address MEMADDR.
   Returns zero if successful, or an errno value if ptrace failed.  */

int
write_memory (memaddr, myaddr, len)
     CORE_ADDR memaddr;
     char *myaddr;
     int len;
{
  if (have_inferior_p ())
    {
      if (remote_debugging)
        return remote_write_inferior_memory (memaddr, myaddr, len);
      else
        return write_inferior_memory (memaddr, myaddr, len);
    }
  else
    error ("Can write memory only when program being debugged is running.");
}

#ifndef XFER_CORE_FILE
int (*core_file_hook)();      /* hook to handle special core files like
                                 like /dev/mem and crash dumps */

/* Read from the program's memory (except for inferior processes).
   This function is misnamed, since it only reads, never writes; and
   since it will use the core file and/or executable file as necessary.

   It should be extended to write as well as read, FIXME, for patching files.

   Return 0 if address could be read, 1 if not. */

int
xfer_core_file (memaddr, myaddr, len)
     CORE_ADDR memaddr;
     char *myaddr;
     int len;
{
  register int i;
  register int val;
  int xferchan;
  char **xferfile;
  int fileptr;
  int returnval = 0;

  if (core_file_hook)
      return ((*core_file_hook)(memaddr, myaddr, len));

  while (len > 0)
    {
      xferfile = 0;
      xferchan = 0;

      /* Determine which file the next bunch of addresses reside in,
         and where in the file.  Set the file's read/write pointer
         to point at the proper place for the desired address
         and set xferfile and xferchan for the correct file.

         If desired address is nonexistent, leave them zero.

         i is set to the number of bytes that can be handled
         along with the next address.

         We put the most likely tests first for efficiency.  */

      /* Note that if there is no core file
         data_start and data_end are equal.  */
      if (memaddr >= data_start && memaddr < data_end)
        {
          i = min (len, data_end - memaddr);
          fileptr = memaddr - data_start + data_offset;
          xferfile = &corefile;
          xferchan = corechan;
        }
      /* Note that if there is no core file
         stack_start and stack_end are equal.  */
      else if (memaddr >= stack_start && memaddr < stack_end)
        {
          i = min (len, stack_end - memaddr);
          fileptr = memaddr - stack_start + stack_offset;
          xferfile = &corefile;
          xferchan = corechan;
        }
#ifdef REG_STACK_SEGMENT
      /* Pyramids have an extra segment in the virtual address space
         for the (control) stack of register-window frames */
      else if (memaddr >= reg_stack_start && memaddr < reg_stack_end)
        {
          i = min (len, reg_stack_end - memaddr);
          fileptr = memaddr - reg_stack_start + reg_stack_offset;
          xferfile = &corefile;
          xferchan = corechan;
        }
#endif /* REG_STACK_SEGMENT */

      else if (corechan < 0
               && memaddr >= exec_data_start && memaddr < exec_data_end)
        {
          i = min (len, exec_data_end - memaddr);
          fileptr = memaddr - exec_data_start + exec_data_offset;
          xferfile = &execfile;
          xferchan = execchan;
        }
      else if (memaddr >= text_start && memaddr < text_end)
        {
          i = min (len, text_end - memaddr);
          fileptr = memaddr - text_start + text_offset;
          xferfile = &execfile;
          xferchan = execchan;
        }
      else if (memaddr < text_start)
        {
          i = min (len, text_start - memaddr);
        }
      else if (memaddr >= text_end
               && memaddr < (corechan >= 0? data_start : exec_data_start))
        {
          i = min (len, data_start - memaddr);
        }
      else if (corechan >= 0
               && memaddr >= data_end && memaddr < stack_start)
        {
          i = min (len, stack_start - memaddr);
        }
      else if (corechan < 0 && memaddr >= exec_data_end)
        {
          /* Since there is nothing at higher addresses than data
             (without a core file or an inferior, there is no
             stack, set i to do the rest of the operation now.  */
          i = len;
        }
#ifdef REG_STACK_SEGMENT
      else if (memaddr >= reg_stack_end && reg_stack_end != 0)
        {
          i = min (len, reg_stack_start - memaddr);
        }
      else if (memaddr >= stack_end && memaddr < reg_stack_start)
#else /* no REG_STACK_SEGMENT.  */
      else if (memaddr >= stack_end && stack_end != 0)
#endif /* no REG_STACK_SEGMENT.  */
        {
          /* Since there is nothing at higher addresses than
             the stack, set i to do the rest of the operation now.  */
          i = len;
        }
      else
        {
          /* Address did not classify into one of the known ranges.
             This shouldn't happen; we catch the endpoints.  */
          fatal ("Internal: Bad case logic in xfer_core_file.");
        }

      /* Now we know which file to use.
         Set up its pointer and transfer the data.  */
      if (xferfile)
        {
          if (*xferfile == 0)
            if (xferfile == &execfile)
              error ("No program file to examine.");
            else
              error ("No core dump file or running program to examine.");
          val = lseek (xferchan, fileptr, 0);
          if (val == -1)
            perror_with_name (*xferfile);
          val = myread (xferchan, myaddr, i);
          if (val < 0)
            perror_with_name (*xferfile);
        }
      /* If this address is for nonexistent memory,
         read zeros if reading, or do nothing if writing.
         Actually, we never right.  */
      else
        {
          bzero (myaddr, i);
          returnval = 1;
        }

      memaddr += i;
      myaddr += i;
      len -= i;
    }
  return returnval;
}
#endif /* XFER_CORE_FILE */
\f
/* My replacement for the read system call.
   Used like `read' but keeps going if `read' returns too soon.  */

int
myread (desc, addr, len)
     int desc;
     char *addr;
     int len;
{
  register int val;
  int orglen = len;

  while (len > 0)
    {
      val = read (desc, addr, len);
      if (val < 0)
        return val;
      if (val == 0)
        return orglen - len;
      len -= val;
      addr += val;
    }
  return orglen;
}
\f
#ifdef REGISTER_U_ADDR

/* Return the address in the core dump or inferior of register REGNO.
   BLOCKEND is the address of the end of the user structure.  */

unsigned int
register_addr (regno, blockend)
     int regno;
     int blockend;
{
  int addr;

  if (regno < 0 || regno >= NUM_REGS)
    error ("Invalid register number %d.", regno);

  REGISTER_U_ADDR (addr, blockend, regno);

  return addr;
}

#endif /* REGISTER_U_ADDR */
\f
void
_initialize_core()
{
  corechan = -1;
  execchan = -1;
  corefile = 0;
  execfile = 0;
  exec_file_display_hook = 0;

  text_start = 0;
  text_end = 0;
  data_start = 0;
  data_end = 0;
  exec_data_start = 0;
  exec_data_end = 0;
  stack_start = STACK_END_ADDR;
  stack_end = STACK_END_ADDR;

  add_com ("core-file", class_files, core_file_command,
           "Use FILE as core dump for examining memory and registers.\n\
No arg means have no core file.");
  add_com ("exec-file", class_files, exec_file_command,
           "Use FILE as program for getting contents of pure memory.\n\
If FILE cannot be found as specified, your execution directory path\n\
is searched for a command of that name.\n\
No arg means have no executable file.");
  add_info ("files", files_info, "Names of files being debugged.");
}