xref: /freebsd/sys/fs/procfs/procfs.h (revision 4cf49a43559ed9fdad601bdcccd2c55963008675)
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$
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 KMEM_GROUP 2
92 
93 /*
94  * Check to see whether access to target process is allowed
95  * Evaluates to 1 if access is allowed.
96  */
97 #define CHECKIO(p1, p2) \
98      (PRISON_CHECK(p1, p2) && \
99        ((((p1)->p_cred->pc_ucred->cr_uid == (p2)->p_cred->p_ruid) && \
100        ((p1)->p_cred->p_ruid == (p2)->p_cred->p_ruid) && \
101        ((p1)->p_cred->p_svuid == (p2)->p_cred->p_ruid) && \
102        ((p2)->p_flag & P_SUGID) == 0) || \
103        (suser_xxx(0, (p1), PRISON_ROOT) == 0)))
104 
105 #define PROCFS_FILENO(pid, type) \
106 	(((type) < Pproc) ? \
107 			((type) + 2) : \
108 			((((pid)+1) << 4) + ((int) (type))))
109 
110 /*
111  * Convert between pfsnode vnode
112  */
113 #define VTOPFS(vp)	((struct pfsnode *)(vp)->v_data)
114 #define PFSTOV(pfs)	((pfs)->pfs_vnode)
115 
116 typedef struct vfs_namemap vfs_namemap_t;
117 struct vfs_namemap {
118 	const char *nm_name;
119 	int nm_val;
120 };
121 
122 int vfs_getuserstr __P((struct uio *, char *, int *));
123 vfs_namemap_t *vfs_findname __P((vfs_namemap_t *, char *, int));
124 
125 /* <machine/reg.h> */
126 struct reg;
127 struct fpreg;
128 struct dbreg;
129 
130 #define PFIND(pid) ((pid) ? pfind(pid) : &proc0)
131 
132 void procfs_exit __P((struct proc *));
133 int procfs_freevp __P((struct vnode *));
134 int procfs_allocvp __P((struct mount *, struct vnode **, long, pfstype));
135 struct vnode *procfs_findtextvp __P((struct proc *));
136 int procfs_sstep __P((struct proc *));
137 void procfs_fix_sstep __P((struct proc *));
138 int procfs_read_regs __P((struct proc *, struct reg *));
139 int procfs_write_regs __P((struct proc *, struct reg *));
140 int procfs_read_fpregs __P((struct proc *, struct fpreg *));
141 int procfs_write_fpregs __P((struct proc *, struct fpreg *));
142 int procfs_read_dbregs __P((struct proc *, struct dbreg *));
143 int procfs_write_dbregs __P((struct proc *, struct dbreg *));
144 int procfs_donote __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
145 int procfs_doregs __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
146 int procfs_dofpregs __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
147 int procfs_dodbregs __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
148 int procfs_domem __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
149 int procfs_doctl __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
150 int procfs_dostatus __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
151 int procfs_domap __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
152 int procfs_dotype __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
153 int procfs_docmdline __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
154 int procfs_dorlimit __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
155 
156 /* Return 1 if process has special kernel digging privileges */
157 int procfs_kmemaccess __P((struct proc *));
158 
159 /* functions to check whether or not files should be displayed */
160 int procfs_validfile __P((struct proc *));
161 int procfs_validfpregs __P((struct proc *));
162 int procfs_validregs __P((struct proc *));
163 int procfs_validdbregs __P((struct proc *));
164 int procfs_validmap __P((struct proc *));
165 int procfs_validtype __P((struct proc *));
166 
167 #define PROCFS_LOCKED	0x01
168 #define PROCFS_WANT	0x02
169 
170 extern vop_t **procfs_vnodeop_p;
171 
172 int	procfs_root __P((struct mount *, struct vnode **));
173 int	procfs_rw __P((struct vop_read_args *));
174 #endif /* KERNEL */
175