sys/vfs/procfs/procfs.h

   1 /*
   2  * Copyright (c) 1993 Jan-Simon Pendry
   3  * Copyright (c) 1993
   4  *      The Regents of the University of California.  All rights reserved.
   5  *
   6  * This code is derived from software contributed to Berkeley by
   7  * Jan-Simon Pendry.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  * 3. All advertising materials mentioning features or use of this software
  18  *    must display the following acknowledgement:
  19  *      This product includes software developed by the University of
  20  *      California, Berkeley and its contributors.
  21  * 4. Neither the name of the University nor the names of its contributors
  22  *    may be used to endorse or promote products derived from this software
  23  *    without specific prior written permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  35  * SUCH DAMAGE.
  36  *
  37  *      @(#)procfs.h    8.9 (Berkeley) 5/14/95
  38  *
  39  * From:
  40  * $FreeBSD: src/sys/miscfs/procfs/procfs.h,v 1.32.2.3 2002/01/22 17:22:59 nectar Exp $
  41  */
  42
  43 /*
  44  * The different types of node in a procfs filesystem
  45  */
  46 typedef enum {
  47         Proot,          /* the filesystem root */
  48         Pcurproc,       /* symbolic link for curproc */
  49         Pproc,          /* a process-specific sub-directory */
  50         Pfile,          /* the executable file */
  51         Pmem,           /* the process's memory image */
  52         Pregs,          /* the process's register set */
  53         Pfpregs,        /* the process's FP register set */
  54         Pdbregs,        /* the process's debug register set */
  55         Pctl,           /* process control */
  56         Pstatus,        /* process status */
  57         Pnote,          /* process notifier */
  58         Pnotepg,        /* process group notifier */
  59         Pmap,           /* memory map */
  60         Ptype,          /* executable type */
  61         Pcmdline,       /* command line */
  62         Prlimit         /* resource limits */
  63 } pfstype;
  64
  65 /*
  66  * control data for the proc file system.
  67  */
  68 struct pfsnode {
  69         struct pfsnode  *pfs_next;      /* next on list */
  70         struct vnode    *pfs_vnode;     /* vnode associated with this pfsnode */
  71         pfstype         pfs_type;       /* type of procfs node */
  72         pid_t           pfs_pid;        /* associated process */
  73         u_short         pfs_mode;       /* mode bits for stat() */
  74         u_long          pfs_flags;      /* open flags */
  75         u_long          pfs_fileno;     /* unique file id */
  76         pid_t           pfs_lockowner;  /* pfs lock owner */
  77 };
  78
  79 #define PROCFS_NOTELEN  64      /* max length of a note (/proc/$pid/note) */
  80 #define PROCFS_CTLLEN   8       /* max length of a ctl msg (/proc/$pid/ctl */
  81 #define PROCFS_NAMELEN  8       /* max length of a filename component */
  82
  83 /*
  84  * Kernel stuff follows
  85  */
  86 #ifdef _KERNEL
  87 #define CNEQ(cnp, s, len) \
  88          ((cnp)->cn_namelen == (len) && \
  89           (bcmp((s), (cnp)->cn_nameptr, (len)) == 0))
  90
  91 #define PROCFS_FILENO(pid, type) \
  92         (((type) < Pproc) ? \
  93                         ((type) + 2) : \
  94                         ((((pid)+1) << 4) + ((int) (type))))
  95
  96 #define CHECKIO(p1, p2) \
  97      ((((p1)->p_cred->pc_ucred->cr_uid == (p2)->p_cred->p_ruid) && \
  98        ((p1)->p_cred->p_ruid == (p2)->p_cred->p_ruid) && \
  99        ((p1)->p_cred->p_svuid == (p2)->p_cred->p_ruid) && \
 100        ((p2)->p_flag & (P_SUGID|P_INEXEC)) == 0) || \
 101       (suser_xxx((p1)->p_cred->pc_ucred, (p1), PRISON_ROOT) == 0))
 102
 103 /*
 104  * Convert between pfsnode vnode
 105  */
 106 #define VTOPFS(vp)      ((struct pfsnode *)(vp)->v_data)
 107 #define PFSTOV(pfs)     ((pfs)->pfs_vnode)
 108
 109 typedef struct vfs_namemap vfs_namemap_t;
 110 struct vfs_namemap {
 111         const char *nm_name;
 112         int nm_val;
 113 };
 114
 115 int vfs_getuserstr __P((struct uio *, char *, int *));
 116 vfs_namemap_t *vfs_findname __P((vfs_namemap_t *, char *, int));
 117
 118 /* <machine/reg.h> */
 119 struct reg;
 120 struct fpreg;
 121 struct dbreg;
 122
 123 #define PFIND(pid) ((pid) ? pfind(pid) : &proc0)
 124
 125 void procfs_exit __P((struct proc *));
 126 int procfs_freevp __P((struct vnode *));
 127 int procfs_allocvp __P((struct mount *, struct vnode **, long, pfstype));
 128 struct vnode *procfs_findtextvp __P((struct proc *));
 129 int procfs_sstep __P((struct proc *));
 130 void procfs_fix_sstep __P((struct proc *));
 131 int procfs_read_regs __P((struct proc *, struct reg *));
 132 int procfs_write_regs __P((struct proc *, struct reg *));
 133 int procfs_read_fpregs __P((struct proc *, struct fpreg *));
 134 int procfs_write_fpregs __P((struct proc *, struct fpreg *));
 135 int procfs_read_dbregs __P((struct proc *, struct dbreg *));
 136 int procfs_write_dbregs __P((struct proc *, struct dbreg *));
 137 int procfs_donote __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
 138 int procfs_doregs __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
 139 int procfs_dofpregs __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
 140 int procfs_dodbregs __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
 141 int procfs_domem __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
 142 int procfs_doctl __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
 143 int procfs_dostatus __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
 144 int procfs_domap __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
 145 int procfs_dotype __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
 146 int procfs_docmdline __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
 147 int procfs_dorlimit __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
 148
 149 /* functions to check whether or not files should be displayed */
 150 int procfs_validfile __P((struct proc *));
 151 int procfs_validfpregs __P((struct proc *));
 152 int procfs_validregs __P((struct proc *));
 153 int procfs_validdbregs __P((struct proc *));
 154 int procfs_validmap __P((struct proc *));
 155 int procfs_validtype __P((struct proc *));
 156
 157 #define PROCFS_LOCKED   0x01
 158 #define PROCFS_WANT     0x02
 159
 160 extern vop_t **procfs_vnodeop_p;
 161
 162 int     procfs_root __P((struct mount *, struct vnode **));
 163 int     procfs_rw __P((struct vop_read_args *));
 164 #endif /* _KERNEL */