xref: /netbsd-src/sys/miscfs/procfs/procfs.h (revision 2a399c6883d870daece976daec6ffa7bb7f934ce)
1 /*	$NetBSD: procfs.h,v 1.20 1997/08/27 08:52:51 thorpej 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.7 (Berkeley) 6/15/94
40  */
41 
42 /*
43  * The different types of node in a procfs filesystem
44  */
45 typedef enum {
46 	Proot,		/* the filesystem root */
47 	Pcurproc,	/* symbolic link for curproc */
48 	Pproc,		/* a process-specific sub-directory */
49 	Pfile,		/* the executable file */
50 	Pmem,		/* the process's memory image */
51 	Pregs,		/* the process's register set */
52 	Pfpregs,	/* the process's FP register set */
53 	Pctl,		/* process control */
54 	Pstatus,	/* process status */
55 	Pnote,		/* process notifier */
56 	Pnotepg		/* process group notifier */
57 } pfstype;
58 
59 /*
60  * control data for the proc file system.
61  */
62 struct pfsnode {
63 	struct pfsnode	*pfs_next;	/* next on list */
64 	struct vnode	*pfs_vnode;	/* vnode associated with this pfsnode */
65 	pfstype		pfs_type;	/* type of procfs node */
66 	pid_t		pfs_pid;	/* associated process */
67 	mode_t		pfs_mode;	/* mode bits for stat() */
68 	u_long		pfs_flags;	/* open flags */
69 	u_long		pfs_fileno;	/* unique file id */
70 };
71 
72 #define PROCFS_NOTELEN	64	/* max length of a note (/proc/$pid/note) */
73 #define PROCFS_CTLLEN 	8	/* max length of a ctl msg (/proc/$pid/ctl */
74 
75 /*
76  * Kernel stuff follows
77  */
78 #ifdef _KERNEL
79 #define CNEQ(cnp, s, len) \
80 	 ((cnp)->cn_namelen == (len) && \
81 	  (bcmp((s), (cnp)->cn_nameptr, (len)) == 0))
82 
83 #define UIO_MX 32
84 
85 #define PROCFS_FILENO(pid, type) \
86 	(((type) < Pproc) ? \
87 			((type) + 2) : \
88 			((((pid)+1) << 4) + ((int) (type))))
89 
90 /*
91  * Convert between pfsnode vnode
92  */
93 #define VTOPFS(vp)	((struct pfsnode *)(vp)->v_data)
94 #define PFSTOV(pfs)	((pfs)->pfs_vnode)
95 
96 typedef struct vfs_namemap vfs_namemap_t;
97 struct vfs_namemap {
98 	const char *nm_name;
99 	int nm_val;
100 };
101 
102 int vfs_getuserstr __P((struct uio *, char *, int *));
103 vfs_namemap_t *vfs_findname __P((vfs_namemap_t *, char *, int));
104 
105 #define PFIND(pid) ((pid) ? pfind(pid) : &proc0)
106 int procfs_freevp __P((struct vnode *));
107 int procfs_allocvp __P((struct mount *, struct vnode **, long, pfstype));
108 struct vnode *procfs_findtextvp __P((struct proc *));
109 int procfs_donote __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
110 int procfs_doregs __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
111 int procfs_dofpregs __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
112 int procfs_domem __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
113 int procfs_doctl __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
114 int procfs_dostatus __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
115 
116 int procfs_checkioperm __P((struct proc *p, struct proc *t));
117 
118 /* functions to check whether or not files should be displayed */
119 int procfs_validfile __P((struct proc *));
120 int procfs_validfpregs __P((struct proc *));
121 int procfs_validregs __P((struct proc *));
122 
123 int procfs_rw __P((void *));
124 
125 #define PROCFS_LOCKED	0x01
126 #define PROCFS_WANT	0x02
127 
128 extern int (**procfs_vnodeop_p) __P((void *));
129 extern struct vfsops procfs_vfsops;
130 
131 void	procfs_init __P((void));
132 int	procfs_root __P((struct mount *, struct vnode **));
133 
134 #endif /* _KERNEL */
135