[dragonfly.git] / sys / vfs / procfs / procfs.h

/*
 * Copyright (c) 1993 Jan-Simon Pendry
 * Copyright (c) 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * Jan-Simon Pendry.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)procfs.h	8.9 (Berkeley) 5/14/95
 *
 * From:
 * $FreeBSD: src/sys/miscfs/procfs/procfs.h,v 1.32.2.3 2002/01/22 17:22:59 nectar Exp $
 * $DragonFly: src/sys/vfs/procfs/procfs.h,v 1.8 2007/02/19 01:14:24 corecode Exp $
 */

/*
 * The different types of node in a procfs filesystem
 */
typedef enum {
	Proot,		/* the filesystem root */
	Pcurproc,	/* symbolic link for curproc */
	Pproc,		/* a process-specific sub-directory */
	Pfile,		/* the executable file */
	Pmem,		/* the process's memory image */
	Pregs,		/* the process's register set */
	Pfpregs,	/* the process's FP register set */
	Pdbregs,	/* the process's debug register set */
	Pctl,		/* process control */
	Pstatus,	/* process status */
	Pnote,		/* process notifier */
	Pnotepg,	/* process group notifier */
	Pmap,		/* memory map */
	Ptype,		/* executable type */
	Pcmdline,	/* command line */
	Prlimit		/* resource limits */
} pfstype;

/*
 * control data for the proc file system.
 */
struct pfsnode {
	struct pfsnode	*pfs_next;	/* next on list */
	struct vnode	*pfs_vnode;	/* vnode associated with this pfsnode */
	pfstype		pfs_type;	/* type of procfs node */
	pid_t		pfs_pid;	/* associated process */
	u_short		pfs_mode;	/* mode bits for stat() */
	u_long		pfs_flags;	/* open flags */
	u_long		pfs_fileno;	/* unique file id */
	pid_t		pfs_lockowner;	/* pfs lock owner */
};

#define PROCFS_NOTELEN	64	/* max length of a note (/proc/$pid/note) */
#define PROCFS_CTLLEN 	8	/* max length of a ctl msg (/proc/$pid/ctl */
#define PROCFS_NAMELEN 	8	/* max length of a filename component */

/*
 * Kernel stuff follows
 */
#ifdef _KERNEL
#define CNEQ(cnp, s, len) \
	 ((cnp)->cn_namelen == (len) && \
	  (bcmp((s), (cnp)->cn_nameptr, (len)) == 0))

#define PROCFS_FILENO(pid, type) \
	(((type) < Pproc) ? \
			((type) + 2) : \
			((((pid)+1) << 4) + ((int) (type))))

/* XXX: Is PRIV_DEBUG_UNPRIV correct? */
#define CHECKIO(p1, p2) \
     ((((p1)->p_ucred->cr_uid == (p2)->p_ucred->cr_ruid) && \
       ((p1)->p_ucred->cr_ruid == (p2)->p_ucred->cr_ruid) && \
       ((p1)->p_ucred->cr_svuid == (p2)->p_ucred->cr_ruid) && \
       ((p2)->p_flags & (P_SUGID|P_INEXEC)) == 0) || \
      (priv_check_cred((p1)->p_ucred, PRIV_DEBUG_UNPRIV, 0) == 0))

/*
 * Convert between pfsnode vnode
 */
#define VTOPFS(vp)	((struct pfsnode *)(vp)->v_data)
#define PFSTOV(pfs)	((pfs)->pfs_vnode)

typedef struct vfs_namemap vfs_namemap_t;
struct vfs_namemap {
	const char *nm_name;
	int nm_val;
};

int vfs_getuserstr (struct uio *, char *, int *);
vfs_namemap_t *vfs_findname (vfs_namemap_t *, char *, int);

/* <machine/reg.h> */
struct reg;
struct fpreg;
struct dbreg;

void procfs_exit (struct thread *);
int procfs_freevp (struct vnode *);
int procfs_allocvp (struct mount *, struct vnode **, long, pfstype);
struct vnode *procfs_findtextvp (struct proc *);
int procfs_sstep (struct lwp *);
int procfs_read_regs (struct lwp *, struct reg *);
int procfs_write_regs (struct lwp *, struct reg *);
int procfs_read_fpregs (struct lwp *, struct fpreg *);
int procfs_write_fpregs (struct lwp *, struct fpreg *);
int procfs_read_dbregs (struct lwp *, struct dbreg *);
int procfs_write_dbregs (struct lwp *, struct dbreg *);
int procfs_donote (struct proc *, struct lwp *, struct pfsnode *pfsp, struct uio *uio);
int procfs_doregs (struct proc *, struct lwp *, struct pfsnode *pfsp, struct uio *uio);
int procfs_dofpregs (struct proc *, struct lwp *, struct pfsnode *pfsp, struct uio *uio);
int procfs_dodbregs (struct proc *, struct lwp *, struct pfsnode *pfsp, struct uio *uio);
int procfs_domem (struct proc *, struct lwp *, struct pfsnode *pfsp, struct uio *uio);
int procfs_doctl (struct proc *, struct lwp *, struct pfsnode *pfsp, struct uio *uio);
int procfs_dostatus (struct proc *, struct lwp *, struct pfsnode *pfsp, struct uio *uio);
int procfs_domap (struct proc *, struct lwp *, struct pfsnode *pfsp, struct uio *uio);
int procfs_dotype (struct proc *, struct lwp *, struct pfsnode *pfsp, struct uio *uio);
int procfs_docmdline (struct proc *, struct lwp *, struct pfsnode *pfsp, struct uio *uio);
int procfs_dorlimit (struct proc *, struct lwp *, struct pfsnode *pfsp, struct uio *uio);

/* functions to check whether or not files should be displayed */
int procfs_validfile (struct lwp *);
int procfs_validfpregs (struct lwp *);
int procfs_validregs (struct lwp *);
int procfs_validdbregs (struct lwp *);
int procfs_validmap (struct lwp *);
int procfs_validtype (struct lwp *);

struct proc *pfs_pfind(pid_t);
struct proc *pfs_zpfind(pid_t);
void pfs_pdone(struct proc *);

#define PROCFS_LOCKED	0x01
#define PROCFS_WANT	0x02

#define PFS_DEAD        0x80000000	/* or'd with pid */

int	procfs_root (struct mount *, struct vnode **);
int	procfs_rw (struct vop_read_args *);

#endif /* _KERNEL */
Commit	Line	Data
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 $
c7e98b2f	41	* $DragonFly: src/sys/vfs/procfs/procfs.h,v 1.8 2007/02/19 01:14:24 corecode Exp $
984263bc MD	42	*/
	43
	44	/*
	45	* The different types of node in a procfs filesystem
	46	*/
	47	typedef 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	*/
	69	struct 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
0620bd26	97	/* XXX: Is PRIV_DEBUG_UNPRIV correct? */
984263bc	98	#define CHECKIO(p1, p2) \
41c20dac MD	99	((((p1)->p_ucred->cr_uid == (p2)->p_ucred->cr_ruid) && \
	100	((p1)->p_ucred->cr_ruid == (p2)->p_ucred->cr_ruid) && \
	101	((p1)->p_ucred->cr_svuid == (p2)->p_ucred->cr_ruid) && \
4643740a	102	((p2)->p_flags & (P_SUGID\|P_INEXEC)) == 0) \|\| \
0620bd26	103	(priv_check_cred((p1)->p_ucred, PRIV_DEBUG_UNPRIV, 0) == 0))
984263bc MD	104
	105	/*
	106	* Convert between pfsnode vnode
	107	*/
	108	#define VTOPFS(vp) ((struct pfsnode *)(vp)->v_data)
	109	#define PFSTOV(pfs) ((pfs)->pfs_vnode)
	110
	111	typedef struct vfs_namemap vfs_namemap_t;
	112	struct vfs_namemap {
	113	const char *nm_name;
	114	int nm_val;
	115	};
	116
a6ee311a RG	117	int vfs_getuserstr (struct uio , char , int *);
a6ee311a RG	118	vfs_namemap_t vfs_findname (vfs_namemap_t , char *, int);
984263bc MD	119
	120	/* <machine/reg.h> */
	121	struct reg;
	122	struct fpreg;
	123	struct dbreg;
	124
a6ee311a RG	125	void procfs_exit (struct thread *);
	126	int procfs_freevp (struct vnode *);
	127	int procfs_allocvp (struct mount , struct vnode *, long, pfstype);
	128	struct vnode procfs_findtextvp (struct proc );
c7e98b2f SS	129	int procfs_sstep (struct lwp *);
	130	int procfs_read_regs (struct lwp , struct reg );
	131	int procfs_write_regs (struct lwp , struct reg );
	132	int procfs_read_fpregs (struct lwp , struct fpreg );
	133	int procfs_write_fpregs (struct lwp , struct fpreg );
	134	int procfs_read_dbregs (struct lwp , struct dbreg );
	135	int procfs_write_dbregs (struct lwp , struct dbreg );
	136	int procfs_donote (struct proc , struct lwp , struct pfsnode pfsp, struct uio uio);
	137	int procfs_doregs (struct proc , struct lwp , struct pfsnode pfsp, struct uio uio);
	138	int procfs_dofpregs (struct proc , struct lwp , struct pfsnode pfsp, struct uio uio);
	139	int procfs_dodbregs (struct proc , struct lwp , struct pfsnode pfsp, struct uio uio);
	140	int procfs_domem (struct proc , struct lwp , struct pfsnode pfsp, struct uio uio);
	141	int procfs_doctl (struct proc , struct lwp , struct pfsnode pfsp, struct uio uio);
	142	int procfs_dostatus (struct proc , struct lwp , struct pfsnode pfsp, struct uio uio);
	143	int procfs_domap (struct proc , struct lwp , struct pfsnode pfsp, struct uio uio);
	144	int procfs_dotype (struct proc , struct lwp , struct pfsnode pfsp, struct uio uio);
	145	int procfs_docmdline (struct proc , struct lwp , struct pfsnode pfsp, struct uio uio);
	146	int procfs_dorlimit (struct proc , struct lwp , struct pfsnode pfsp, struct uio uio);
984263bc MD	147
984263bc MD	148	/* functions to check whether or not files should be displayed */
c7e98b2f SS	149	int procfs_validfile (struct lwp *);
	150	int procfs_validfpregs (struct lwp *);
	151	int procfs_validregs (struct lwp *);
	152	int procfs_validdbregs (struct lwp *);
	153	int procfs_validmap (struct lwp *);
	154	int procfs_validtype (struct lwp *);
984263bc	155
198c0ff2	156	struct proc *pfs_pfind(pid_t);
7c37ea07	157	struct proc *pfs_zpfind(pid_t);
f44c73be	158	void pfs_pdone(struct proc *);
198c0ff2	159
984263bc MD	160	#define PROCFS_LOCKED 0x01
	161	#define PROCFS_WANT 0x02
	162
e193508c MD	163	#define PFS_DEAD 0x80000000 /* or'd with pid */
e193508c MD	164
a6ee311a RG	165	int procfs_root (struct mount , struct vnode *);
a6ee311a RG	166	int procfs_rw (struct vop_read_args *);
0961aa92	167
984263bc	168	#endif /* _KERNEL */