xref: /freebsd/sys/fs/procfs/procfs.h (revision 6e8394b8baa7d5d9153ab90de6824bcd19b3b4e1)
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  *	$Id: procfs.h,v 1.25 1999/05/04 08:00:10 phk Exp $
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 	Pctl,		/* process control */
55 	Pstatus,	/* process status */
56 	Pnote,		/* process notifier */
57 	Pnotepg,	/* process group notifier */
58 	Pmap,		/* memory map */
59 	Ptype,		/* executable type */
60 	Pcmdline,	/* command line */
61 	Prlimit		/* resource limits */
62 } pfstype;
63 
64 /*
65  * control data for the proc file system.
66  */
67 struct pfsnode {
68 	struct pfsnode	*pfs_next;	/* next on list */
69 	struct vnode	*pfs_vnode;	/* vnode associated with this pfsnode */
70 	pfstype		pfs_type;	/* type of procfs node */
71 	pid_t		pfs_pid;	/* associated process */
72 	u_short		pfs_mode;	/* mode bits for stat() */
73 	u_long		pfs_flags;	/* open flags */
74 	u_long		pfs_fileno;	/* unique file id */
75 	pid_t		pfs_lockowner;	/* pfs lock owner */
76 };
77 
78 #define PROCFS_NOTELEN	64	/* max length of a note (/proc/$pid/note) */
79 #define PROCFS_CTLLEN 	8	/* max length of a ctl msg (/proc/$pid/ctl */
80 #define PROCFS_NAMELEN 	8	/* max length of a filename component */
81 
82 /*
83  * Kernel stuff follows
84  */
85 #ifdef KERNEL
86 #define CNEQ(cnp, s, len) \
87 	 ((cnp)->cn_namelen == (len) && \
88 	  (bcmp((s), (cnp)->cn_nameptr, (len)) == 0))
89 
90 #define KMEM_GROUP 2
91 
92 /*
93  * Check to see whether access to target process is allowed
94  * Evaluates to 1 if access is allowed.
95  */
96 #define CHECKIO(p1, p2) \
97      (PRISON_CHECK(p1, p2) && \
98        ((((p1)->p_cred->pc_ucred->cr_uid == (p2)->p_cred->p_ruid) && \
99        ((p1)->p_cred->p_ruid == (p2)->p_cred->p_ruid) && \
100        ((p1)->p_cred->p_svuid == (p2)->p_cred->p_ruid) && \
101        ((p2)->p_flag & P_SUGID) == 0) || \
102        (suser_xxx(0, (p1), PRISON_ROOT) == 0)))
103 
104 #define PROCFS_FILENO(pid, type) \
105 	(((type) < Pproc) ? \
106 			((type) + 2) : \
107 			((((pid)+1) << 4) + ((int) (type))))
108 
109 /*
110  * Convert between pfsnode vnode
111  */
112 #define VTOPFS(vp)	((struct pfsnode *)(vp)->v_data)
113 #define PFSTOV(pfs)	((pfs)->pfs_vnode)
114 
115 typedef struct vfs_namemap vfs_namemap_t;
116 struct vfs_namemap {
117 	const char *nm_name;
118 	int nm_val;
119 };
120 
121 int vfs_getuserstr __P((struct uio *, char *, int *));
122 vfs_namemap_t *vfs_findname __P((vfs_namemap_t *, char *, int));
123 
124 /* <machine/reg.h> */
125 struct reg;
126 struct fpreg;
127 
128 #define PFIND(pid) ((pid) ? pfind(pid) : &proc0)
129 
130 void procfs_exit __P((struct proc *));
131 int procfs_freevp __P((struct vnode *));
132 int procfs_allocvp __P((struct mount *, struct vnode **, long, pfstype));
133 struct vnode *procfs_findtextvp __P((struct proc *));
134 int procfs_sstep __P((struct proc *));
135 void procfs_fix_sstep __P((struct proc *));
136 int procfs_read_regs __P((struct proc *, struct reg *));
137 int procfs_write_regs __P((struct proc *, struct reg *));
138 int procfs_read_fpregs __P((struct proc *, struct fpreg *));
139 int procfs_write_fpregs __P((struct proc *, struct fpreg *));
140 int procfs_donote __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
141 int procfs_doregs __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
142 int procfs_dofpregs __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
143 int procfs_domem __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
144 int procfs_doctl __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
145 int procfs_dostatus __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
146 int procfs_domap __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
147 int procfs_dotype __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
148 int procfs_docmdline __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
149 int procfs_dorlimit __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
150 
151 /* Return 1 if process has special kernel digging privileges */
152 int procfs_kmemaccess __P((struct proc *));
153 
154 /* functions to check whether or not files should be displayed */
155 int procfs_validfile __P((struct proc *));
156 int procfs_validfpregs __P((struct proc *));
157 int procfs_validregs __P((struct proc *));
158 int procfs_validmap __P((struct proc *));
159 int procfs_validtype __P((struct proc *));
160 
161 #define PROCFS_LOCKED	0x01
162 #define PROCFS_WANT	0x02
163 
164 extern vop_t **procfs_vnodeop_p;
165 
166 int	procfs_root __P((struct mount *, struct vnode **));
167 int	procfs_rw __P((struct vop_read_args *));
168 #endif /* KERNEL */
169