[BACK]Return to procfs.h CVS log [TXT][DIR] Up to [cvs.NetBSD.org] / src / sys / miscfs / procfs

File: [cvs.NetBSD.org] / src / sys / miscfs / procfs / procfs.h (download)

Revision 1.58, Sat Oct 1 03:17:37 2005 UTC (16 years, 10 months ago) by atatat
Branch: MAIN
CVS Tags: yamt-vop-base3, yamt-vop-base2, yamt-vop-base, yamt-vop, yamt-readahead-pervnode, yamt-readahead-perfile, yamt-readahead-base3, yamt-readahead-base2, yamt-readahead-base, yamt-readahead, thorpej-vnode-attr-base, thorpej-vnode-attr, ktrace-lwp-base
Changes since 1.57: +3 -1 lines

Add "cwd" and "root" symlinks to each process's directory.  The cwd
link points to the process's current working directory, and the root
link points to the process's root directory.  What else would you
expect?

For directories that are out of reach (caller is in a chroot, target
process is in a different chroot, etc), the links point to "/"
instead.

/*	$NetBSD: procfs.h,v 1.58 2005/10/01 03:17:37 atatat Exp $	*/

/*
 * 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. 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
 */

/*
 * Copyright (c) 1993 Jan-Simon Pendry
 *
 * 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
 */

/* This also pulls in __HAVE_PROCFS_MACHDEP */
#include <sys/ptrace.h>

#ifdef _KERNEL
/*
 * The different types of node in a procfs filesystem
 */
typedef enum {
	PFSroot,	/* the filesystem root */
	PFScurproc,	/* symbolic link for curproc */
	PFSself,	/* like curproc, but this is the Linux name */
	PFSproc,	/* a process-specific sub-directory */
	PFSfile,	/* the executable file */
	PFSmem,		/* the process's memory image */
	PFSregs,	/* the process's register set */
	PFSfpregs,	/* the process's FP register set */
	PFSctl,		/* process control */
	PFSstat,	/* process status (if -o linux) */
	PFSstatus,	/* process status */
	PFSnote,	/* process notifier */
	PFSnotepg,	/* process group notifier */
	PFSmap,		/* memory map */
	PFScmdline,	/* process command line args */
	PFSmeminfo,	/* system memory info (if -o linux) */
	PFScpuinfo,	/* CPU info (if -o linux) */
	PFSmaps,	/* memory map, Linux style (if -o linux) */
	PFSfd,		/* a directory containing the processes open fd's */
	PFSuptime,	/* elapsed time since (if -o linux) */
	PFSmounts,	/* mounted filesystems (if -o linux) */
	PFScwd,		/* the process's current working directory */
	PFSchroot,	/* the process's current root directory */
#ifdef __HAVE_PROCFS_MACHDEP
	PROCFS_MACHDEP_NODE_TYPES
#endif
} pfstype;

/*
 * control data for the proc file system.
 */
struct pfsnode {
	LIST_ENTRY(pfsnode) pfs_hash;	/* hash chain */
	struct vnode	*pfs_vnode;	/* vnode associated with this pfsnode */
	pfstype		pfs_type;	/* type of procfs node */
	pid_t		pfs_pid;	/* associated process */
	int		pfs_fd;		/* associated fd if not -1 */
	mode_t		pfs_mode;	/* mode bits for stat() */
	u_long		pfs_flags;	/* open flags */
	u_long		pfs_fileno;	/* unique file id */
};

#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 */

#endif /* _KERNEL */

struct procfs_args {
	int version;
	int flags;
};

#define PROCFS_ARGSVERSION	1

#define PROCFSMNT_LINUXCOMPAT	0x01

#define PROCFSMNT_BITS "\177\20" \
    "b\00linuxcompat\0"

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

#define UIO_MX 32

#define PROCFS_FILENO(pid, type, fd) \
    (((type) < PFSproc) ? ((type) + 2) : \
	(((fd) == -1) ? ((((pid)+1) << 5) + ((int) (type))) : \
	((((pid)+1) << 16) | ((fd) << 5) | ((int) (type)))))

struct procfsmount {
	void *pmnt_exechook;
	int pmnt_flags;
};

#define VFSTOPROC(mp)	((struct procfsmount *)(mp)->mnt_data)

/*
 * 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 *);
const vfs_namemap_t *vfs_findname(const vfs_namemap_t *, const char *, int);

#define PFIND(pid) ((pid) ? pfind(pid) : &proc0)
int procfs_freevp(struct vnode *);
int procfs_allocvp(struct mount *, struct vnode **, pid_t, pfstype, int);
int procfs_donote(struct proc *, struct proc *, struct pfsnode *,
    struct uio *);
int procfs_doregs(struct proc *, struct lwp *, struct pfsnode *,
    struct uio *);
int procfs_dofpregs(struct proc *, struct lwp *, struct pfsnode *,
    struct uio *);
int procfs_domem(struct proc *, struct proc *, struct pfsnode *,
    struct uio *);
int procfs_doctl(struct proc *, struct lwp *, struct pfsnode *,
    struct uio *);
int procfs_do_pid_stat(struct proc *, struct lwp *, struct pfsnode *,
    struct uio *);
int procfs_dostatus(struct proc *, struct lwp *, struct pfsnode *,
    struct uio *);
int procfs_domap(struct proc *, struct proc *, struct pfsnode *,
    struct uio *, int);
int procfs_docmdline(struct proc *, struct proc *, struct pfsnode *,
    struct uio *);
int procfs_domeminfo(struct proc *, struct proc *, struct pfsnode *,
    struct uio *);
int procfs_docpuinfo(struct proc *, struct proc *, struct pfsnode *,
    struct uio *);
int procfs_dofd(struct proc *, struct proc *, struct pfsnode *,
    struct uio *);
int procfs_douptime(struct proc *, struct proc *, struct pfsnode *,
    struct uio *);
int procfs_domounts(struct proc *, struct proc *, struct pfsnode *,
    struct uio *);

void procfs_revoke_vnodes(struct proc *, void *);
void procfs_hashinit(void);
void procfs_hashreinit(void);
void procfs_hashdone(void);
int procfs_getfp(struct pfsnode *, struct proc **, struct file **);

/* functions to check whether or not files should be displayed */
int procfs_validfile(struct proc *, struct mount *);
int procfs_validfpregs(struct proc *, struct mount *);
int procfs_validregs(struct proc *, struct mount *);
int procfs_validmap(struct proc *, struct mount *);

int procfs_rw(void *);

int procfs_getcpuinfstr(char *, int *);

#define PROCFS_LOCKED	0x01
#define PROCFS_WANT	0x02

extern int (**procfs_vnodeop_p)(void *);
extern struct vfsops procfs_vfsops;

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

#ifdef __HAVE_PROCFS_MACHDEP
struct vattr;

void	procfs_machdep_allocvp(struct vnode *);
int	procfs_machdep_rw(struct proc *, struct lwp *, struct pfsnode *,
	    struct uio *);
int	procfs_machdep_getattr(struct vnode *, struct vattr *, struct proc *);
#endif

#ifdef SYSCTL_SETUP_PROTO
SYSCTL_SETUP_PROTO(sysctl_vfs_procfs_setup);
#endif /* SYSCTL_SETUP_PROTO */
#endif /* _KERNEL */