xref: /netbsd-src/sys/miscfs/procfs/procfs.h (revision 001c68bd94f75ce9270b69227c4199fbf34ee396)
1 /*	$NetBSD: procfs.h,v 1.47 2003/06/29 22:31:44 fvdl 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 	Pstat,		/* process status (if -o linux) */
59 	Pstatus,	/* process status */
60 	Pnote,		/* process notifier */
61 	Pnotepg,	/* process group notifier */
62 	Pmap,		/* memory map */
63 	Pcmdline,	/* process command line args */
64 	Pmeminfo,	/* system memory info (if -o linux) */
65 	Pcpuinfo,	/* CPU info (if -o linux) */
66 	Pmaps,		/* memory map, Linux style (if -o linux) */
67 	Pfd,		/* a directory containing the processes open fd's */
68 	Puptime,	/* elapsed time since (if -o linux) */
69 #ifdef __HAVE_PROCFS_MACHDEP
70 	PROCFS_MACHDEP_NODE_TYPES
71 #endif
72 } pfstype;
73 
74 /*
75  * control data for the proc file system.
76  */
77 struct pfsnode {
78 	LIST_ENTRY(pfsnode) pfs_hash;	/* hash chain */
79 	struct vnode	*pfs_vnode;	/* vnode associated with this pfsnode */
80 	pfstype		pfs_type;	/* type of procfs node */
81 	pid_t		pfs_pid;	/* associated process */
82 	int		pfs_fd;		/* associated fd if not -1 */
83 	mode_t		pfs_mode;	/* mode bits for stat() */
84 	u_long		pfs_flags;	/* open flags */
85 	u_long		pfs_fileno;	/* unique file id */
86 };
87 
88 #define PROCFS_NOTELEN	64	/* max length of a note (/proc/$pid/note) */
89 #define PROCFS_CTLLEN 	8	/* max length of a ctl msg (/proc/$pid/ctl */
90 
91 struct procfs_args {
92 	int version;
93 	int flags;
94 };
95 
96 #define PROCFS_ARGSVERSION	1
97 
98 #define PROCFSMNT_LINUXCOMPAT	0x01
99 
100 #define PROCFSMNT_BITS "\177\20" \
101     "b\00linuxcompat"
102 
103 /*
104  * Kernel stuff follows
105  */
106 #ifdef _KERNEL
107 #define CNEQ(cnp, s, len) \
108 	 ((cnp)->cn_namelen == (len) && \
109 	  (memcmp((s), (cnp)->cn_nameptr, (len)) == 0))
110 
111 #define UIO_MX 32
112 
113 #define PROCFS_FILENO(pid, type, fd) \
114     (((type) < Pproc) ? ((type) + 2) : \
115 	(((fd) == -1) ? ((((pid)+1) << 5) + ((int) (type))) : \
116 	((((pid)+1) << 16) | ((fd) << 5) | ((int) (type)))))
117 
118 struct procfsmount {
119 	void *pmnt_exechook;
120 	int pmnt_flags;
121 };
122 
123 #define VFSTOPROC(mp)	((struct procfsmount *)(mp)->mnt_data)
124 
125 /*
126  * Convert between pfsnode vnode
127  */
128 #define VTOPFS(vp)	((struct pfsnode *)(vp)->v_data)
129 #define PFSTOV(pfs)	((pfs)->pfs_vnode)
130 
131 typedef struct vfs_namemap vfs_namemap_t;
132 struct vfs_namemap {
133 	const char *nm_name;
134 	int nm_val;
135 };
136 
137 int vfs_getuserstr __P((struct uio *, char *, int *));
138 const vfs_namemap_t *vfs_findname __P((const vfs_namemap_t *, const char *, int));
139 
140 #define PFIND(pid) ((pid) ? pfind(pid) : &proc0)
141 int procfs_freevp __P((struct vnode *));
142 int procfs_allocvp __P((struct mount *, struct vnode **, pid_t, pfstype, int));
143 int procfs_donote __P((struct proc *, struct proc *, struct pfsnode *,
144     struct uio *));
145 int procfs_doregs __P((struct proc *, struct lwp *, struct pfsnode *,
146     struct uio *));
147 int procfs_dofpregs __P((struct proc *, struct lwp *, struct pfsnode *,
148     struct uio *));
149 int procfs_domem __P((struct proc *, struct proc *, struct pfsnode *,
150     struct uio *));
151 int procfs_doctl __P((struct proc *, struct lwp *, struct pfsnode *,
152     struct uio *));
153 int procfs_do_pid_stat __P((struct proc *, struct lwp *, struct pfsnode *,
154     struct uio *));
155 int procfs_dostatus __P((struct proc *, struct lwp *, struct pfsnode *,
156     struct uio *));
157 int procfs_domap __P((struct proc *, struct proc *, struct pfsnode *,
158     struct uio *, int));
159 int procfs_docmdline __P((struct proc *, struct proc *, struct pfsnode *,
160     struct uio *));
161 int procfs_domeminfo __P((struct proc *, struct proc *, struct pfsnode *,
162     struct uio *));
163 int procfs_docpuinfo __P((struct proc *, struct proc *, struct pfsnode *,
164     struct uio *));
165 int procfs_dofd __P((struct proc *, struct proc *, struct pfsnode *,
166     struct uio *));
167 int procfs_douptime __P((struct proc *, struct proc *, struct pfsnode *,
168     struct uio *));
169 
170 void procfs_revoke_vnodes __P((struct proc *, void *));
171 void procfs_hashinit __P((void));
172 void procfs_hashreinit __P((void));
173 void procfs_hashdone __P((void));
174 int procfs_getfp __P((struct pfsnode *, struct proc **, struct file **));
175 
176 /* functions to check whether or not files should be displayed */
177 int procfs_validfile __P((struct proc *, struct mount *));
178 int procfs_validfpregs __P((struct proc *, struct mount *));
179 int procfs_validregs __P((struct proc *, struct mount *));
180 int procfs_validmap __P((struct proc *, struct mount *));
181 
182 int procfs_rw __P((void *));
183 
184 int procfs_getcpuinfstr __P((char *, int *));
185 
186 #define PROCFS_LOCKED	0x01
187 #define PROCFS_WANT	0x02
188 
189 extern int (**procfs_vnodeop_p) __P((void *));
190 extern struct vfsops procfs_vfsops;
191 
192 int	procfs_root __P((struct mount *, struct vnode **));
193 
194 #ifdef __HAVE_PROCFS_MACHDEP
195 struct vattr;
196 
197 void	procfs_machdep_allocvp(struct vnode *);
198 int	procfs_machdep_rw(struct proc *, struct lwp *, struct pfsnode *,
199 	    struct uio *);
200 int	procfs_machdep_getattr(struct vnode *, struct vattr *, struct proc *);
201 #endif
202 
203 #endif /* _KERNEL */
204