Home | History | Annotate | Line # | Download | only in procfs
procfs.h revision 1.39
      1 /*	$NetBSD: procfs.h,v 1.39 2003/01/03 13:21:18 christos Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 1993 Jan-Simon Pendry
      5  * Copyright (c) 1993
      6  *	The Regents of the University of California.  All rights reserved.
      7  *
      8  * This code is derived from software contributed to Berkeley by
      9  * Jan-Simon Pendry.
     10  *
     11  * Redistribution and use in source and binary forms, with or without
     12  * modification, are permitted provided that the following conditions
     13  * are met:
     14  * 1. Redistributions of source code must retain the above copyright
     15  *    notice, this list of conditions and the following disclaimer.
     16  * 2. Redistributions in binary form must reproduce the above copyright
     17  *    notice, this list of conditions and the following disclaimer in the
     18  *    documentation and/or other materials provided with the distribution.
     19  * 3. All advertising materials mentioning features or use of this software
     20  *    must display the following acknowledgement:
     21  *	This product includes software developed by the University of
     22  *	California, Berkeley and its contributors.
     23  * 4. Neither the name of the University nor the names of its contributors
     24  *    may be used to endorse or promote products derived from this software
     25  *    without specific prior written permission.
     26  *
     27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     37  * SUCH DAMAGE.
     38  *
     39  *	@(#)procfs.h	8.9 (Berkeley) 5/14/95
     40  */
     41 
     42 /* This also pulls in __HAVE_PROCFS_MACHDEP */
     43 #include <sys/ptrace.h>
     44 
     45 /*
     46  * The different types of node in a procfs filesystem
     47  */
     48 typedef enum {
     49 	Proot,		/* the filesystem root */
     50 	Pcurproc,	/* symbolic link for curproc */
     51 	Pself,		/* like curproc, but this is the Linux name */
     52 	Pproc,		/* a process-specific sub-directory */
     53 	Pfile,		/* the executable file */
     54 	Pmem,		/* the process's memory image */
     55 	Pregs,		/* the process's register set */
     56 	Pfpregs,	/* the process's FP register set */
     57 	Pctl,		/* process control */
     58 	Pstatus,	/* process status */
     59 	Pnote,		/* process notifier */
     60 	Pnotepg,	/* process group notifier */
     61 	Pmap,		/* memory map */
     62 	Pcmdline,	/* process command line args */
     63 	Pmeminfo,	/* system memory info (if -o linux) */
     64 	Pcpuinfo,	/* CPU info (if -o linux) */
     65 	Pmaps,		/* memory map, Linux style (if -o linux) */
     66 	Pfd,		/* a directory containing the processes open fd's */
     67 #ifdef __HAVE_PROCFS_MACHDEP
     68 	PROCFS_MACHDEP_NODE_TYPES
     69 #endif
     70 } pfstype;
     71 
     72 /*
     73  * control data for the proc file system.
     74  */
     75 struct pfsnode {
     76 	LIST_ENTRY(pfsnode) pfs_hash;	/* hash chain */
     77 	struct vnode	*pfs_vnode;	/* vnode associated with this pfsnode */
     78 	pfstype		pfs_type;	/* type of procfs node */
     79 	pid_t		pfs_pid;	/* associated process */
     80 	int		pfs_fd;		/* associated fd if not -1 */
     81 	mode_t		pfs_mode;	/* mode bits for stat() */
     82 	u_long		pfs_flags;	/* open flags */
     83 	u_long		pfs_fileno;	/* unique file id */
     84 };
     85 
     86 #define PROCFS_NOTELEN	64	/* max length of a note (/proc/$pid/note) */
     87 #define PROCFS_CTLLEN 	8	/* max length of a ctl msg (/proc/$pid/ctl */
     88 
     89 struct procfs_args {
     90 	int version;
     91 	int flags;
     92 };
     93 
     94 #define PROCFS_ARGSVERSION	1
     95 
     96 #define PROCFSMNT_LINUXCOMPAT	0x01
     97 
     98 #define PROCFSMNT_BITS "\177\20" \
     99     "b\00linuxcompat"
    100 
    101 /*
    102  * Kernel stuff follows
    103  */
    104 #ifdef _KERNEL
    105 #define CNEQ(cnp, s, len) \
    106 	 ((cnp)->cn_namelen == (len) && \
    107 	  (memcmp((s), (cnp)->cn_nameptr, (len)) == 0))
    108 
    109 #define UIO_MX 32
    110 
    111 #define PROCFS_FILENO(pid, type, fd) \
    112     (((type) < Pproc) ? ((type) + 2) : \
    113 	(((fd) == -1) ? ((((pid)+1) << 4) + ((int) (type))) : \
    114 	((((pid)+1) << 16) | ((fd) << 4) | ((int) (type)))))
    115 
    116 struct procfsmount {
    117 	void *pmnt_exechook;
    118 	int pmnt_flags;
    119 };
    120 
    121 #define VFSTOPROC(mp)	((struct procfsmount *)(mp)->mnt_data)
    122 
    123 /*
    124  * Convert between pfsnode vnode
    125  */
    126 #define VTOPFS(vp)	((struct pfsnode *)(vp)->v_data)
    127 #define PFSTOV(pfs)	((pfs)->pfs_vnode)
    128 
    129 typedef struct vfs_namemap vfs_namemap_t;
    130 struct vfs_namemap {
    131 	const char *nm_name;
    132 	int nm_val;
    133 };
    134 
    135 int vfs_getuserstr __P((struct uio *, char *, int *));
    136 const vfs_namemap_t *vfs_findname __P((const vfs_namemap_t *, const char *, int));
    137 
    138 #define PFIND(pid) ((pid) ? pfind(pid) : &proc0)
    139 int procfs_freevp __P((struct vnode *));
    140 int procfs_allocvp __P((struct mount *, struct vnode **, pid_t, pfstype, int));
    141 int procfs_donote __P((struct proc *, struct proc *, struct pfsnode *,
    142     struct uio *));
    143 int procfs_doregs __P((struct proc *, struct proc *, struct pfsnode *,
    144     struct uio *));
    145 int procfs_dofpregs __P((struct proc *, struct proc *, struct pfsnode *,
    146     struct uio *));
    147 int procfs_domem __P((struct proc *, struct proc *, struct pfsnode *,
    148     struct uio *));
    149 int procfs_doctl __P((struct proc *, struct proc *, struct pfsnode *,
    150     struct uio *));
    151 int procfs_dostatus __P((struct proc *, struct proc *, struct pfsnode *,
    152     struct uio *));
    153 int procfs_domap __P((struct proc *, struct proc *, struct pfsnode *,
    154     struct uio *, int));
    155 int procfs_docmdline __P((struct proc *, struct proc *, struct pfsnode *,
    156     struct uio *));
    157 int procfs_domeminfo __P((struct proc *, struct proc *, struct pfsnode *,
    158     struct uio *));
    159 int procfs_docpuinfo __P((struct proc *, struct proc *, struct pfsnode *,
    160     struct uio *));
    161 int procfs_dofd __P((struct proc *, struct proc *, struct pfsnode *,
    162     struct uio *));
    163 
    164 void procfs_revoke_vnodes __P((struct proc *, void *));
    165 void procfs_hashinit __P((void));
    166 void procfs_hashreinit __P((void));
    167 void procfs_hashdone __P((void));
    168 int procfs_getfp __P((struct pfsnode *, struct file **));
    169 
    170 /* functions to check whether or not files should be displayed */
    171 int procfs_validfile __P((struct proc *, struct mount *));
    172 int procfs_validfpregs __P((struct proc *, struct mount *));
    173 int procfs_validregs __P((struct proc *, struct mount *));
    174 int procfs_validmap __P((struct proc *, struct mount *));
    175 
    176 int procfs_rw __P((void *));
    177 
    178 int procfs_getcpuinfstr __P((char *, int *));
    179 
    180 #define PROCFS_LOCKED	0x01
    181 #define PROCFS_WANT	0x02
    182 
    183 extern int (**procfs_vnodeop_p) __P((void *));
    184 extern struct vfsops procfs_vfsops;
    185 
    186 int	procfs_root __P((struct mount *, struct vnode **));
    187 
    188 #ifdef __HAVE_PROCFS_MACHDEP
    189 struct vattr;
    190 
    191 void	procfs_machdep_allocvp(struct vnode *);
    192 int	procfs_machdep_rw(struct proc *, struct proc *, struct pfsnode *,
    193 	    struct uio *);
    194 int	procfs_machdep_getattr(struct vnode *, struct vattr *, struct proc *);
    195 #endif
    196 
    197 #endif /* _KERNEL */
    198