sys/sys/procfs.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 1998 John D. Polstra.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 #ifndef _SYS_PROCFS_H_
  32 #define _SYS_PROCFS_H_
  33
  34 #include <sys/param.h>
  35 #include <machine/reg.h>
  36
  37 typedef struct reg gregset_t;
  38 typedef struct fpreg fpregset_t;
  39
  40 /*
  41  * These structures define an interface between core files and the debugger.
  42  * Never change or delete any elements.  If you add elements, add them to
  43  * the end of the structure, and increment the value of its version field.
  44  * This will help to ensure that today's core dump will still be usable
  45  * with next year's debugger.
  46  *
  47  * A lot more things should be added to these structures.  At present,
  48  * they contain the absolute bare minimum required to allow GDB to work
  49  * with ELF core dumps.
  50  */
  51
  52 /*
  53  * The parenthsized numbers like (1) indicate the minimum version number
  54  * for which each element exists in the structure.  The version number is
  55  * not bumped when adding new fields to the end, only if the meaning of
  56  * an existing field changes.  Additional fields are annotated as (1a),
  57  * (1b), etc. to indicate the groupings of additions.
  58  */
  59
  60 #define PRSTATUS_VERSION        1       /* Current version of prstatus_t */
  61
  62 typedef struct prstatus {
  63     int         pr_version;     /* Version number of struct (1) */
  64     size_t      pr_statussz;    /* sizeof(prstatus_t) (1) */
  65     size_t      pr_gregsetsz;   /* sizeof(gregset_t) (1) */
  66     size_t      pr_fpregsetsz;  /* sizeof(fpregset_t) (1) */
  67     int         pr_osreldate;   /* Kernel version (1) */
  68     int         pr_cursig;      /* Current signal (1) */
  69     pid_t       pr_pid;         /* LWP (Thread) ID (1) */
  70     gregset_t   pr_reg;         /* General purpose registers (1) */
  71 } prstatus_t;
  72
  73 typedef gregset_t prgregset_t[1];
  74 typedef fpregset_t prfpregset_t;
  75
  76 #define PRFNAMESZ       16      /* Maximum command length saved */
  77 #define PRARGSZ         80      /* Maximum argument bytes saved */
  78
  79 #define PRPSINFO_VERSION        1       /* Current version of prpsinfo_t */
  80
  81 typedef struct prpsinfo {
  82     int         pr_version;     /* Version number of struct (1) */
  83     size_t      pr_psinfosz;    /* sizeof(prpsinfo_t) (1) */
  84     char        pr_fname[PRFNAMESZ+1];  /* Command name, null terminated (1) */
  85     char        pr_psargs[PRARGSZ+1];   /* Arguments, null terminated (1) */
  86     pid_t       pr_pid;         /* Process ID (1a) */
  87 } prpsinfo_t;
  88
  89 typedef struct thrmisc {
  90     char        pr_tname[MAXCOMLEN+1];  /* Thread name, null terminated (1) */
  91     u_int       _pad;                   /* Convenience pad, 0-filled (1) */
  92 } thrmisc_t;
  93
  94 typedef uint64_t psaddr_t;      /* An address in the target process. */
  95
  96 #ifdef __HAVE_REG32
  97 typedef struct prstatus32 {
  98         int32_t pr_version;
  99         uint32_t pr_statussz;
 100         uint32_t pr_gregsetsz;
 101         uint32_t pr_fpregsetsz;
 102         int32_t pr_osreldate;
 103         int32_t pr_cursig;
 104         int32_t pr_pid;
 105         struct reg32 pr_reg;
 106 } prstatus32_t;
 107
 108 typedef struct prpsinfo32 {
 109         int32_t pr_version;
 110         uint32_t pr_psinfosz;
 111         char    pr_fname[PRFNAMESZ+1];
 112         char    pr_psargs[PRARGSZ+1];
 113         int32_t pr_pid;
 114 } prpsinfo32_t;
 115
 116 struct thrmisc32 {
 117         char    pr_tname[MAXCOMLEN+1];
 118         uint32_t _pad;
 119 };
 120 #endif /* __HAVE_REG32 */
 121
 122 #endif /* _SYS_PROCFS_H_ */