xref: /freebsd/sys/fs/procfs/procfs.h (revision 4a0f765fbf09711e612e86fce8bb09ec43f482d9)
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$
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 } pfstype;
61 
62 /*
63  * control data for the proc file system.
64  */
65 struct pfsnode {
66 	struct pfsnode	*pfs_next;	/* next on list */
67 	struct vnode	*pfs_vnode;	/* vnode associated with this pfsnode */
68 	pfstype		pfs_type;	/* type of procfs node */
69 	pid_t		pfs_pid;	/* associated process */
70 	u_short		pfs_mode;	/* mode bits for stat() */
71 	u_long		pfs_flags;	/* open flags */
72 	u_long		pfs_fileno;	/* unique file id */
73 	pid_t		pfs_lockowner;	/* pfs lock owner */
74 };
75 
76 #define PROCFS_NOTELEN	64	/* max length of a note (/proc/$pid/note) */
77 #define PROCFS_CTLLEN 	8	/* max length of a ctl msg (/proc/$pid/ctl */
78 
79 /*
80  * Kernel stuff follows
81  */
82 #ifdef KERNEL
83 #define CNEQ(cnp, s, len) \
84 	 ((cnp)->cn_namelen == (len) && \
85 	  (bcmp((s), (cnp)->cn_nameptr, (len)) == 0))
86 
87 #define KMEM_GROUP 2
88 /*
89  * Format of a directory entry in /proc, ...
90  * This must map onto struct dirent (see <dirent.h>)
91  */
92 #define PROCFS_NAMELEN 8
93 struct pfsdent {
94 	u_long	d_fileno;
95 	u_short	d_reclen;
96 	u_char	d_type;
97 	u_char	d_namlen;
98 	char	d_name[PROCFS_NAMELEN];
99 };
100 #define UIO_MX sizeof(struct pfsdent)
101 #define PROCFS_FILENO(pid, type) \
102 	(((type) < Pproc) ? \
103 			((type) + 2) : \
104 			((((pid)+1) << 4) + ((int) (type))))
105 
106 /*
107  * Convert between pfsnode vnode
108  */
109 #define VTOPFS(vp)	((struct pfsnode *)(vp)->v_data)
110 #define PFSTOV(pfs)	((pfs)->pfs_vnode)
111 
112 typedef struct vfs_namemap vfs_namemap_t;
113 struct vfs_namemap {
114 	const char *nm_name;
115 	int nm_val;
116 };
117 
118 int vfs_getuserstr __P((struct uio *, char *, int *));
119 vfs_namemap_t *vfs_findname __P((vfs_namemap_t *, char *, int));
120 
121 /* <machine/reg.h> */
122 struct reg;
123 struct fpreg;
124 
125 #define PFIND(pid) ((pid) ? pfind(pid) : &proc0)
126 int procfs_freevp __P((struct vnode *));
127 int procfs_allocvp __P((struct mount *, struct vnode **, long, pfstype));
128 struct vnode *procfs_findtextvp __P((struct proc *));
129 int procfs_sstep __P((struct proc *));
130 void procfs_fix_sstep __P((struct proc *));
131 int procfs_read_regs __P((struct proc *, struct reg *));
132 int procfs_write_regs __P((struct proc *, struct reg *));
133 int procfs_read_fpregs __P((struct proc *, struct fpreg *));
134 int procfs_write_fpregs __P((struct proc *, struct fpreg *));
135 int procfs_donote __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
136 int procfs_doregs __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
137 int procfs_dofpregs __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
138 int procfs_domem __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
139 int procfs_doctl __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
140 int procfs_dostatus __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
141 int procfs_domap __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
142 int procfs_dotype __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
143 
144 /* functions to check whether or not files should be displayed */
145 int procfs_validfile __P((struct proc *));
146 int procfs_validfpregs __P((struct proc *));
147 int procfs_validregs __P((struct proc *));
148 int procfs_validmap __P((struct proc *));
149 int procfs_validtype __P((struct proc *));
150 
151 #define PROCFS_LOCKED	0x01
152 #define PROCFS_WANT	0x02
153 
154 extern vop_t **procfs_vnodeop_p;
155 extern struct vfsops procfs_vfsops;
156 
157 int	procfs_root __P((struct mount *, struct vnode **));
158 int	procfs_rw __P((struct vop_read_args *));
159 #endif /* KERNEL */
160