__P()!=wanted, clean up the vm subsystem
[dragonfly.git] / sys / vfs / procfs / procfs.h
CommitLineData
984263bc
MD
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: src/sys/miscfs/procfs/procfs.h,v 1.32.2.3 2002/01/22 17:22:59 nectar Exp $
dadab5e9 41 * $DragonFly: src/sys/vfs/procfs/procfs.h,v 1.4 2003/06/25 03:56:00 dillon Exp $
984263bc
MD
42 */
43
44/*
45 * The different types of node in a procfs filesystem
46 */
47typedef enum {
48 Proot, /* the filesystem root */
49 Pcurproc, /* symbolic link for curproc */
50 Pproc, /* a process-specific sub-directory */
51 Pfile, /* the executable file */
52 Pmem, /* the process's memory image */
53 Pregs, /* the process's register set */
54 Pfpregs, /* the process's FP register set */
55 Pdbregs, /* the process's debug register set */
56 Pctl, /* process control */
57 Pstatus, /* process status */
58 Pnote, /* process notifier */
59 Pnotepg, /* process group notifier */
60 Pmap, /* memory map */
61 Ptype, /* executable type */
62 Pcmdline, /* command line */
63 Prlimit /* resource limits */
64} pfstype;
65
66/*
67 * control data for the proc file system.
68 */
69struct pfsnode {
70 struct pfsnode *pfs_next; /* next on list */
71 struct vnode *pfs_vnode; /* vnode associated with this pfsnode */
72 pfstype pfs_type; /* type of procfs node */
73 pid_t pfs_pid; /* associated process */
74 u_short pfs_mode; /* mode bits for stat() */
75 u_long pfs_flags; /* open flags */
76 u_long pfs_fileno; /* unique file id */
77 pid_t pfs_lockowner; /* pfs lock owner */
78};
79
80#define PROCFS_NOTELEN 64 /* max length of a note (/proc/$pid/note) */
81#define PROCFS_CTLLEN 8 /* max length of a ctl msg (/proc/$pid/ctl */
82#define PROCFS_NAMELEN 8 /* max length of a filename component */
83
84/*
85 * Kernel stuff follows
86 */
87#ifdef _KERNEL
88#define CNEQ(cnp, s, len) \
89 ((cnp)->cn_namelen == (len) && \
90 (bcmp((s), (cnp)->cn_nameptr, (len)) == 0))
91
92#define PROCFS_FILENO(pid, type) \
93 (((type) < Pproc) ? \
94 ((type) + 2) : \
95 ((((pid)+1) << 4) + ((int) (type))))
96
97#define CHECKIO(p1, p2) \
41c20dac
MD
98 ((((p1)->p_ucred->cr_uid == (p2)->p_ucred->cr_ruid) && \
99 ((p1)->p_ucred->cr_ruid == (p2)->p_ucred->cr_ruid) && \
100 ((p1)->p_ucred->cr_svuid == (p2)->p_ucred->cr_ruid) && \
984263bc 101 ((p2)->p_flag & (P_SUGID|P_INEXEC)) == 0) || \
dadab5e9 102 (suser_cred((p1)->p_ucred, PRISON_ROOT) == 0))
984263bc
MD
103
104/*
105 * Convert between pfsnode vnode
106 */
107#define VTOPFS(vp) ((struct pfsnode *)(vp)->v_data)
108#define PFSTOV(pfs) ((pfs)->pfs_vnode)
109
110typedef struct vfs_namemap vfs_namemap_t;
111struct vfs_namemap {
112 const char *nm_name;
113 int nm_val;
114};
115
116int vfs_getuserstr __P((struct uio *, char *, int *));
117vfs_namemap_t *vfs_findname __P((vfs_namemap_t *, char *, int));
118
119/* <machine/reg.h> */
120struct reg;
121struct fpreg;
122struct dbreg;
123
124#define PFIND(pid) ((pid) ? pfind(pid) : &proc0)
125
dadab5e9 126void procfs_exit __P((struct thread *));
984263bc
MD
127int procfs_freevp __P((struct vnode *));
128int procfs_allocvp __P((struct mount *, struct vnode **, long, pfstype));
129struct vnode *procfs_findtextvp __P((struct proc *));
130int procfs_sstep __P((struct proc *));
131void procfs_fix_sstep __P((struct proc *));
132int procfs_read_regs __P((struct proc *, struct reg *));
133int procfs_write_regs __P((struct proc *, struct reg *));
134int procfs_read_fpregs __P((struct proc *, struct fpreg *));
135int procfs_write_fpregs __P((struct proc *, struct fpreg *));
136int procfs_read_dbregs __P((struct proc *, struct dbreg *));
137int procfs_write_dbregs __P((struct proc *, struct dbreg *));
138int procfs_donote __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
139int procfs_doregs __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
140int procfs_dofpregs __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
141int procfs_dodbregs __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
142int procfs_domem __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
143int procfs_doctl __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
144int procfs_dostatus __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
145int procfs_domap __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
146int procfs_dotype __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
147int procfs_docmdline __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
148int procfs_dorlimit __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
149
150/* functions to check whether or not files should be displayed */
151int procfs_validfile __P((struct proc *));
152int procfs_validfpregs __P((struct proc *));
153int procfs_validregs __P((struct proc *));
154int procfs_validdbregs __P((struct proc *));
155int procfs_validmap __P((struct proc *));
156int procfs_validtype __P((struct proc *));
157
158#define PROCFS_LOCKED 0x01
159#define PROCFS_WANT 0x02
160
161extern vop_t **procfs_vnodeop_p;
162
163int procfs_root __P((struct mount *, struct vnode **));
164int procfs_rw __P((struct vop_read_args *));
165#endif /* _KERNEL */