488c5c2f04e0642b033e6e0db45cfc5cbf412135
[dragonfly.git] / sys / emulation / linux / i386 / linprocfs / linprocfs.h
1 /*
2  * Copyright (c) 2000 Dag-Erling Coïdan Smørgrav
3  * Copyright (c) 1999 Pierre Beyssac
4  * Copyright (c) 1993 Jan-Simon Pendry
5  * Copyright (c) 1993
6  *      The Regents of the University of California.  All rights reserved.
7  *
8  * This code is derived from software contributed to Berkeley by
9  * Jan-Simon Pendry.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *      This product includes software developed by the University of
22  *      California, Berkeley and its contributors.
23  * 4. Neither the name of the University nor the names of its contributors
24  *    may be used to endorse or promote products derived from this software
25  *    without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37  * SUCH DAMAGE.
38  *
39  *      @(#)procfs.h    8.9 (Berkeley) 5/14/95
40  *
41  * $FreeBSD: src/sys/i386/linux/linprocfs/linprocfs.h,v 1.2.2.4 2001/06/25 19:46:47 pirzyk Exp $
42  * $DragonFly: src/sys/emulation/linux/i386/linprocfs/linprocfs.h,v 1.10 2007/02/03 09:50:49 y0netan1 Exp $
43  */
44
45 /*
46  * The different types of node in a procfs filesystem
47  */
48 typedef enum {
49         Proot,          /* the filesystem root */
50         Pself,          /* symbolic link for curproc */
51         Pproc,          /* a process-specific sub-directory */
52         Pexe,           /* the executable file */
53         Pmem,           /* the process's memory image */
54         Pprocstat,      /* the process's status */
55         Pprocstatus,    /* the process's status (again) */
56         Pmeminfo,       /* memory system statistics */
57         Pcpuinfo,       /* CPU model, speed and features */
58         Pstat,          /* kernel/system statistics */
59         Puptime,        /* system uptime */
60         Pversion,       /* system version */
61         Ploadavg,       /* system load average */
62         Pnet,           /* the net sub-directory */
63         Pnetdev,        /* net devices */
64         Psys,           /* the sys sub-directory */
65         Psyskernel,     /* the sys/kernel sub-directory */
66         Pdevices,       /* devices */
67         Posrelease,     /* osrelease */
68         Postype,        /* ostype */
69         Ppidmax,        /* pid_max */
70         Pcwd,
71         Pprocroot,
72         Pfd,
73         Pcmdline,
74         Penviron,
75         Pmaps,
76         Pstatm,
77         Pmounts,
78 } pfstype;
79
80 /*
81  * control data for the proc file system.
82  */
83 struct pfsnode {
84         struct pfsnode  *pfs_next;      /* next on list */
85         struct vnode    *pfs_vnode;     /* vnode associated with this pfsnode */
86         pfstype         pfs_type;       /* type of procfs node */
87         pid_t           pfs_pid;        /* associated process */
88         u_short         pfs_mode;       /* mode bits for stat() */
89         u_long          pfs_flags;      /* open flags */
90         u_long          pfs_fileno;     /* unique file id */
91         struct thread   *pfs_lockowner; /* pfs lock owner */
92 };
93
94 #define PROCFS_NAMELEN  8       /* max length of a filename component */
95
96 /*
97  * Kernel stuff follows
98  */
99 #ifdef _KERNEL
100 #define CNEQ(cnp, s, len) \
101          ((cnp)->cn_namelen == (len) && \
102           (bcmp((s), (cnp)->cn_nameptr, (len)) == 0))
103
104 #define KMEM_GROUP 2
105
106 #define PROCFS_FILENO(pid, type) \
107         (((type) < Pproc) ? \
108                         ((type) + 2) : \
109                         ((((pid)+1) << 4) + ((int) (type))))
110
111 /*
112  * Convert between pfsnode vnode
113  */
114 #define VTOPFS(vp)      ((struct pfsnode *)(vp)->v_data)
115 #define PFSTOV(pfs)     ((pfs)->pfs_vnode)
116
117 typedef struct vfs_namemap vfs_namemap_t;
118 struct vfs_namemap {
119         const char *nm_name;
120         int nm_val;
121 };
122
123 int vfs_getuserstr (struct uio *, char *, int *);
124 vfs_namemap_t *vfs_findname (vfs_namemap_t *, char *, int);
125
126 /* <sys/reg.h> */
127 struct reg;
128 struct fpreg;
129 struct dbreg;
130
131 #define PFIND(pid) ((pid) ? pfindn(pid) : &proc0) /* pfindn() not MPSAFE XXX */
132
133 void linprocfs_init (void);
134 void linprocfs_exit (struct thread *);
135 int linprocfs_freevp (struct vnode *);
136 int linprocfs_allocvp (struct mount *, struct vnode **, long, pfstype);
137 int linprocfs_sstep (struct proc *);
138 void linprocfs_fix_sstep (struct proc *);
139 #if 0
140 int linprocfs_read_regs (struct proc *, struct reg *);
141 int linprocfs_write_regs (struct proc *, struct reg *);
142 int linprocfs_read_fpregs (struct proc *, struct fpreg *);
143 int linprocfs_write_fpregs (struct proc *, struct fpreg *);
144 int linprocfs_read_dbregs (struct proc *, struct dbreg *);
145 int linprocfs_write_dbregs (struct proc *, struct dbreg *);
146 #endif
147 int linprocfs_domeminfo (struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio);
148 int linprocfs_docpuinfo (struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio);
149 int linprocfs_domounts (struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio);
150 int linprocfs_dostat (struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio);
151 int linprocfs_douptime (struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio);
152 int linprocfs_doversion (struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio);
153 int linprocfs_doprocstat (struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio);
154 int linprocfs_doprocstatus (struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio);
155 int linprocfs_doloadavg (struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio);
156 int linprocfs_donetdev (struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio);
157 int linprocfs_dodevices (struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio);
158 int linprocfs_doosrelease (struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio);
159 int linprocfs_doostype (struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio);
160 int linprocfs_dopidmax (struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio);
161 int linprocfs_domaps(struct proc *curp, struct proc *p, struct pfsnode *pfs, struct uio *uio);
162 int linprocfs_dostatm(struct proc *curp, struct proc *p, struct pfsnode *pfs, struct uio *uio);
163 /* functions to check whether or not files should be displayed */
164 int linprocfs_validfile (struct proc *);
165
166 #define PROCFS_LOCKED   0x01
167 #define PROCFS_WANT     0x02
168
169 int     linprocfs_root (struct mount *, struct vnode **);
170 int     linprocfs_rw (struct vop_read_args *);
171 #endif /* _KERNEL */