sys/miscfs/procfs/procfs.h

   1 /*      $NetBSD: procfs.h,v 1.64 2007/05/24 00:37:40 agc Exp $  */
   2
   3 /*
   4  * Copyright (c) 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * This code is derived from software contributed to Berkeley by
   8  * Jan-Simon Pendry.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  *      @(#)procfs.h    8.9 (Berkeley) 5/14/95
  35  */
  36
  37 /*
  38  * Copyright (c) 1993 Jan-Simon Pendry
  39  *
  40  * This code is derived from software contributed to Berkeley by
  41  * Jan-Simon Pendry.
  42  *
  43  * Redistribution and use in source and binary forms, with or without
  44  * modification, are permitted provided that the following conditions
  45  * are met:
  46  * 1. Redistributions of source code must retain the above copyright
  47  *    notice, this list of conditions and the following disclaimer.
  48  * 2. Redistributions in binary form must reproduce the above copyright
  49  *    notice, this list of conditions and the following disclaimer in the
  50  *    documentation and/or other materials provided with the distribution.
  51  * 3. All advertising materials mentioning features or use of this software
  52  *    must display the following acknowledgement:
  53  *      This product includes software developed by the University of
  54  *      California, Berkeley and its contributors.
  55  * 4. Neither the name of the University nor the names of its contributors
  56  *    may be used to endorse or promote products derived from this software
  57  *    without specific prior written permission.
  58  *
  59  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  60  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  61  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  62  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  63  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  64  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  65  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  66  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  67  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  68  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  69  * SUCH DAMAGE.
  70  *
  71  *      @(#)procfs.h    8.9 (Berkeley) 5/14/95
  72  */
  73
  74 /* This also pulls in __HAVE_PROCFS_MACHDEP */
  75 #include <sys/ptrace.h>
  76
  77 #ifdef _KERNEL
  78 /*
  79  * The different types of node in a procfs filesystem
  80  */
  81 typedef enum {
  82         PFSroot,        /* the filesystem root */
  83         PFScurproc,     /* symbolic link for curproc */
  84         PFSself,        /* like curproc, but this is the Linux name */
  85         PFSproc,        /* a process-specific sub-directory */
  86         PFSfile,        /* the executable file */
  87         PFSexe,         /* symlink to the executable file */
  88         PFSmem,         /* the process's memory image */
  89         PFSregs,        /* the process's register set */
  90         PFSfpregs,      /* the process's FP register set */
  91         PFSctl,         /* process control */
  92         PFSstat,        /* process status (if -o linux) */
  93         PFSstatus,      /* process status */
  94         PFSnote,        /* process notifier */
  95         PFSnotepg,      /* process group notifier */
  96         PFSmap,         /* memory map */
  97         PFScmdline,     /* process command line args */
  98         PFSmeminfo,     /* system memory info (if -o linux) */
  99         PFScpuinfo,     /* CPU info (if -o linux) */
 100         PFSmaps,        /* memory map, Linux style (if -o linux) */
 101         PFSfd,          /* a directory containing the processes open fd's */
 102         PFSuptime,      /* elapsed time since (if -o linux) */
 103         PFSmounts,      /* mounted filesystems (if -o linux) */
 104         PFScwd,         /* the process's current working directory */
 105         PFSchroot,      /* the process's current root directory */
 106         PFSemul,        /* the process's emulation */
 107         PFSdevices,     /* major/device name mappings (if -o linux) */
 108         PFScpustat,     /* status info (if -o linux) */
 109         PFSloadavg,     /* load average (if -o linux) */
 110         PFSstatm,       /* process memory info (if -o linux) */
 111 #ifdef __HAVE_PROCFS_MACHDEP
 112         PROCFS_MACHDEP_NODE_TYPES
 113 #endif
 114 } pfstype;
 115
 116 /*
 117  * control data for the proc file system.
 118  */
 119 struct pfsnode {
 120         LIST_ENTRY(pfsnode) pfs_hash;   /* hash chain */
 121         struct vnode    *pfs_vnode;     /* vnode associated with this pfsnode */
 122         pfstype         pfs_type;       /* type of procfs node */
 123         pid_t           pfs_pid;        /* associated process */
 124         int             pfs_fd;         /* associated fd if not -1 */
 125         mode_t          pfs_mode;       /* mode bits for stat() */
 126         u_long          pfs_flags;      /* open flags */
 127         u_long          pfs_fileno;     /* unique file id */
 128 };
 129
 130 #define PROCFS_NOTELEN  64      /* max length of a note (/proc/$pid/note) */
 131 #define PROCFS_CTLLEN   8       /* max length of a ctl msg (/proc/$pid/ctl */
 132
 133 #endif /* _KERNEL */
 134
 135 struct procfs_args {
 136         int version;
 137         int flags;
 138 };
 139
 140 #define PROCFS_ARGSVERSION      1
 141
 142 #define PROCFSMNT_LINUXCOMPAT   0x01
 143
 144 #define PROCFSMNT_BITS "\177\20" \
 145     "b\00linuxcompat\0"
 146
 147 /*
 148  * Kernel stuff follows
 149  */
 150 #ifdef _KERNEL
 151 #define CNEQ(cnp, s, len) \
 152          ((cnp)->cn_namelen == (len) && \
 153           (memcmp((s), (cnp)->cn_nameptr, (len)) == 0))
 154
 155 #define UIO_MX 32
 156
 157 #define PROCFS_FILENO(pid, type, fd) \
 158     (((type) < PFSproc) ? ((type) + 2) : \
 159         (((fd) == -1) ? ((((pid)+1) << 5) + ((int) (type))) : \
 160         ((((pid)+1) << 16) | ((fd) << 5) | ((int) (type)))))
 161 #define PROCFS_TYPE(type)       ((type) & 0x1f)
 162
 163 struct procfsmount {
 164         void *pmnt_exechook;
 165         int pmnt_flags;
 166 };
 167
 168 #define VFSTOPROC(mp)   ((struct procfsmount *)(mp)->mnt_data)
 169
 170 /*
 171  * Convert between pfsnode vnode
 172  */
 173 #define VTOPFS(vp)      ((struct pfsnode *)(vp)->v_data)
 174 #define PFSTOV(pfs)     ((pfs)->pfs_vnode)
 175
 176 typedef struct vfs_namemap vfs_namemap_t;
 177 struct vfs_namemap {
 178         const char *nm_name;
 179         int nm_val;
 180 };
 181
 182 int vfs_getuserstr(struct uio *, char *, int *);
 183 const vfs_namemap_t *vfs_findname(const vfs_namemap_t *, const char *, int);
 184
 185 int procfs_proc_lock(int, struct proc **, int);
 186 void procfs_proc_unlock(struct proc *);
 187 int procfs_freevp(struct vnode *);
 188 int procfs_allocvp(struct mount *, struct vnode **, pid_t, pfstype, int,
 189     struct proc *);
 190 int procfs_donote(struct lwp *, struct proc *, struct pfsnode *,
 191     struct uio *);
 192 int procfs_doregs(struct lwp *, struct lwp *, struct pfsnode *,
 193     struct uio *);
 194 int procfs_dofpregs(struct lwp *, struct lwp *, struct pfsnode *,
 195     struct uio *);
 196 int procfs_domem(struct lwp *, struct lwp *, struct pfsnode *,
 197     struct uio *);
 198 int procfs_doctl(struct lwp *, struct lwp *, struct pfsnode *,
 199     struct uio *);
 200 int procfs_do_pid_stat(struct lwp *, struct lwp *, struct pfsnode *,
 201     struct uio *);
 202 int procfs_dostatus(struct lwp *, struct lwp *, struct pfsnode *,
 203     struct uio *);
 204 int procfs_domap(struct lwp *, struct proc *, struct pfsnode *,
 205     struct uio *, int);
 206 int procfs_docmdline(struct lwp *, struct proc *, struct pfsnode *,
 207     struct uio *);
 208 int procfs_domeminfo(struct lwp *, struct proc *, struct pfsnode *,
 209     struct uio *);
 210 int procfs_dodevices(struct lwp *, struct proc *, struct pfsnode *,
 211     struct uio *);
 212 int procfs_docpuinfo(struct lwp *, struct proc *, struct pfsnode *,
 213     struct uio *);
 214 int procfs_docpustat(struct lwp *, struct proc *, struct pfsnode *,
 215     struct uio *);
 216 int procfs_doloadavg(struct lwp *, struct proc *, struct pfsnode *,
 217     struct uio *);
 218 int procfs_do_pid_statm(struct lwp *, struct lwp *, struct pfsnode *,
 219     struct uio *);
 220 int procfs_dofd(struct lwp *, struct proc *, struct pfsnode *,
 221     struct uio *);
 222 int procfs_douptime(struct lwp *, struct proc *, struct pfsnode *,
 223     struct uio *);
 224 int procfs_domounts(struct lwp *, struct proc *, struct pfsnode *,
 225     struct uio *);
 226 int procfs_doemul(struct lwp *, struct proc *, struct pfsnode *,
 227     struct uio *);
 228
 229 void procfs_revoke_vnodes(struct proc *, void *);
 230 void procfs_hashinit(void);
 231 void procfs_hashreinit(void);
 232 void procfs_hashdone(void);
 233 int procfs_getfp(struct pfsnode *, struct proc *, struct file **);
 234
 235 /* functions to check whether or not files should be displayed */
 236 int procfs_validfile(struct lwp *, struct mount *);
 237 int procfs_validfpregs(struct lwp *, struct mount *);
 238 int procfs_validregs(struct lwp *, struct mount *);
 239 int procfs_validmap(struct lwp *, struct mount *);
 240
 241 int procfs_rw(void *);
 242
 243 int procfs_getcpuinfstr(char *, int *);
 244
 245 #define PROCFS_LOCKED   0x01
 246 #define PROCFS_WANT     0x02
 247
 248 extern int (**procfs_vnodeop_p)(void *);
 249 extern struct vfsops procfs_vfsops;
 250
 251 int     procfs_root(struct mount *, struct vnode **);
 252
 253 #ifdef __HAVE_PROCFS_MACHDEP
 254 struct vattr;
 255
 256 void    procfs_machdep_allocvp(struct vnode *);
 257 int     procfs_machdep_rw(struct lwp *, struct lwp *, struct pfsnode *,
 258             struct uio *);
 259 int     procfs_machdep_getattr(struct vnode *, struct vattr *, struct proc *);
 260 #endif
 261
 262 #endif /* _KERNEL */