xref: /freebsd/sys/fs/procfs/procfs.h (revision 48991a368427cadb9cdac39581d1676c29619c52)
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.6 (Berkeley) 2/3/94
38  *
39  *	$Id: procfs.h,v 1.7 1995/11/09 08:16:01 bde Exp $
40  */
41 
42 /*
43  * The different types of node in a procfs filesystem
44  */
45 typedef enum {
46 	Proot,		/* the filesystem root */
47 	Pproc,		/* a process-specific sub-directory */
48 	Pfile,		/* the executable file */
49 	Pmem,		/* the process's memory image */
50 	Pregs,		/* the process's register set */
51 	Pfpregs,	/* the process's FP register set */
52 	Pctl,		/* process control */
53 	Pstatus,	/* process status */
54 	Pnote,		/* process notifier */
55 	Pnotepg		/* process group notifier */
56 } pfstype;
57 
58 /*
59  * control data for the proc file system.
60  */
61 struct pfsnode {
62 	struct pfsnode	*pfs_next;	/* next on list */
63 	struct vnode	*pfs_vnode;	/* vnode associated with this pfsnode */
64 	pfstype		pfs_type;	/* type of procfs node */
65 	pid_t		pfs_pid;	/* associated process */
66 	u_short		pfs_mode;	/* mode bits for stat() */
67 	u_long		pfs_flags;	/* open flags */
68 	u_long		pfs_fileno;	/* unique file id */
69 };
70 
71 #define PROCFS_NOTELEN	64	/* max length of a note (/proc/$pid/note) */
72 #define PROCFS_CTLLEN 	8	/* max length of a ctl msg (/proc/$pid/ctl */
73 
74 /*
75  * Kernel stuff follows
76  */
77 #ifdef KERNEL
78 #define CNEQ(cnp, s, len) \
79 	 ((cnp)->cn_namelen == (len) && \
80 	  (bcmp((s), (cnp)->cn_nameptr, (len)) == 0))
81 
82 #define KMEM_GROUP 2
83 /*
84  * Format of a directory entry in /proc, ...
85  * This must map onto struct dirent (see <dirent.h>)
86  */
87 #define PROCFS_NAMELEN 8
88 struct pfsdent {
89 	u_long	d_fileno;
90 	u_short	d_reclen;
91 	u_char	d_type;
92 	u_char	d_namlen;
93 	char	d_name[PROCFS_NAMELEN];
94 };
95 #define UIO_MX sizeof(struct pfsdent)
96 #define PROCFS_FILENO(pid, type) \
97 	(((type) == Proot) ? \
98 			2 : \
99 			((((pid)+1) << 3) + ((int) (type))))
100 
101 /*
102  * Convert between pfsnode vnode
103  */
104 #define VTOPFS(vp)	((struct pfsnode *)(vp)->v_data)
105 #define PFSTOV(pfs)	((pfs)->pfs_vnode)
106 
107 typedef struct vfs_namemap vfs_namemap_t;
108 struct vfs_namemap {
109 	const char *nm_name;
110 	int nm_val;
111 };
112 
113 extern int vfs_getuserstr __P((struct uio *, char *, int *));
114 extern vfs_namemap_t *vfs_findname __P((vfs_namemap_t *, char *, int));
115 
116 /* <machine/reg.h> */
117 struct reg;
118 struct fpreg;
119 
120 #define PFIND(pid) ((pid) ? pfind(pid) : &proc0)
121 extern int procfs_freevp __P((struct vnode *));
122 extern int procfs_allocvp __P((struct mount *, struct vnode **, long, pfstype));
123 extern struct vnode *procfs_findtextvp __P((struct proc *));
124 extern int procfs_sstep __P((struct proc *));
125 extern void procfs_fix_sstep __P((struct proc *));
126 extern int procfs_read_regs __P((struct proc *, struct reg *));
127 extern int procfs_write_regs __P((struct proc *, struct reg *));
128 extern int procfs_read_fpregs __P((struct proc *, struct fpreg *));
129 extern int procfs_write_fpregs __P((struct proc *, struct fpreg *));
130 extern int procfs_donote __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
131 extern int procfs_doregs __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
132 extern int procfs_dofpregs __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
133 extern int procfs_domem __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
134 extern int procfs_doctl __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
135 extern int procfs_dostatus __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
136 
137 #define PROCFS_LOCKED	0x01
138 #define PROCFS_WANT	0x02
139 
140 extern vop_t **procfs_vnodeop_p;
141 extern struct vfsops procfs_vfsops;
142 
143 int	procfs_root __P((struct mount *, struct vnode **));
144 int	procfs_rw __P((struct vop_read_args *));
145 #endif /* KERNEL */
146