Home | History | Annotate | Line # | Download | only in procfs
procfs.h revision 1.1.1.2
      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  *	$Id: procfs.h,v 1.1.1.2 1998/03/01 02:13:17 fvdl Exp $
     41  */
     42 
     43 /*
     44  * The different types of node in a procfs filesystem
     45  */
     46 typedef enum {
     47 	Proot,		/* the filesystem root */
     48 	Pcurproc,	/* symbolic link for curproc */
     49 	Pproc,		/* a process-specific sub-directory */
     50 	Pfile,		/* the executable file */
     51 	Pmem,		/* the process's memory image */
     52 	Pregs,		/* the process's register set */
     53 	Pfpregs,	/* the process's FP register set */
     54 	Pctl,		/* process control */
     55 	Pstatus,	/* process status */
     56 	Pnote,		/* process notifier */
     57 	Pnotepg		/* process group notifier */
     58 } pfstype;
     59 
     60 /*
     61  * control data for the proc file system.
     62  */
     63 struct pfsnode {
     64 	struct pfsnode	*pfs_next;	/* next on list */
     65 	struct vnode	*pfs_vnode;	/* vnode associated with this pfsnode */
     66 	pfstype		pfs_type;	/* type of procfs node */
     67 	pid_t		pfs_pid;	/* associated process */
     68 	u_short		pfs_mode;	/* mode bits for stat() */
     69 	u_long		pfs_flags;	/* open flags */
     70 	u_long		pfs_fileno;	/* unique file id */
     71 };
     72 
     73 #define PROCFS_NOTELEN	64	/* max length of a note (/proc/$pid/note) */
     74 #define PROCFS_CTLLEN 	8	/* max length of a ctl msg (/proc/$pid/ctl */
     75 
     76 /*
     77  * Kernel stuff follows
     78  */
     79 #ifdef KERNEL
     80 #define CNEQ(cnp, s, len) \
     81 	 ((cnp)->cn_namelen == (len) && \
     82 	  (bcmp((s), (cnp)->cn_nameptr, (len)) == 0))
     83 
     84 /*
     85  * Format of a directory entry in /proc, ...
     86  * This must map onto struct dirent (see <dirent.h>)
     87  */
     88 #define PROCFS_NAMELEN 8
     89 struct pfsdent {
     90 	u_long	d_fileno;
     91 	u_short	d_reclen;
     92 	u_char	d_type;
     93 	u_char	d_namlen;
     94 	char	d_name[PROCFS_NAMELEN];
     95 };
     96 #define UIO_MX sizeof(struct pfsdent)
     97 #define PROCFS_FILENO(pid, type) \
     98 	(((type) < Pproc) ? \
     99 			((type) + 2) : \
    100 			((((pid)+1) << 4) + ((int) (type))))
    101 
    102 /*
    103  * Convert between pfsnode vnode
    104  */
    105 #define VTOPFS(vp)	((struct pfsnode *)(vp)->v_data)
    106 #define PFSTOV(pfs)	((pfs)->pfs_vnode)
    107 
    108 typedef struct vfs_namemap vfs_namemap_t;
    109 struct vfs_namemap {
    110 	const char *nm_name;
    111 	int nm_val;
    112 };
    113 
    114 int vfs_getuserstr __P((struct uio *, char *, int *));
    115 vfs_namemap_t *vfs_findname __P((vfs_namemap_t *, char *, int));
    116 
    117 /* <machine/reg.h> */
    118 struct reg;
    119 struct fpreg;
    120 
    121 #define PFIND(pid) ((pid) ? pfind(pid) : &proc0)
    122 int procfs_freevp __P((struct vnode *));
    123 int procfs_allocvp __P((struct mount *, struct vnode **, long, pfstype));
    124 struct vnode *procfs_findtextvp __P((struct proc *));
    125 int procfs_sstep __P((struct proc *, int));
    126 void procfs_fix_sstep __P((struct proc *));
    127 int procfs_read_regs __P((struct proc *, struct reg *));
    128 int procfs_write_regs __P((struct proc *, struct reg *));
    129 int procfs_read_fpregs __P((struct proc *, struct fpreg *));
    130 int procfs_write_fpregs __P((struct proc *, struct fpreg *));
    131 int procfs_donote __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
    132 int procfs_doregs __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
    133 int procfs_dofpregs __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
    134 int procfs_domem __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
    135 int procfs_doctl __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
    136 int procfs_dostatus __P((struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio));
    137 
    138 /* functions to check whether or not files should be displayed */
    139 int procfs_validfile __P((struct proc *));
    140 int procfs_validfpregs __P((struct proc *));
    141 int procfs_validregs __P((struct proc *));
    142 
    143 #define PROCFS_LOCKED	0x01
    144 #define PROCFS_WANT	0x02
    145 
    146 extern int (**procfs_vnodeop_p)();
    147 extern struct vfsops procfs_vfsops;
    148 
    149 /*
    150  * Prototypes for procfs vnode ops
    151  */
    152 int	procfs_badop();	/* varargs */
    153 int	procfs_rw __P((struct vop_read_args *));
    154 int	procfs_lookup __P((struct vop_lookup_args *));
    155 #define procfs_create ((int (*) __P((struct vop_create_args *))) procfs_badop)
    156 #define procfs_mknod ((int (*) __P((struct vop_mknod_args *))) procfs_badop)
    157 int	procfs_open __P((struct vop_open_args *));
    158 int	procfs_close __P((struct vop_close_args *));
    159 int	procfs_access __P((struct vop_access_args *));
    160 int	procfs_getattr __P((struct vop_getattr_args *));
    161 int	procfs_setattr __P((struct vop_setattr_args *));
    162 #define	procfs_read procfs_rw
    163 #define	procfs_write procfs_rw
    164 int	procfs_ioctl __P((struct vop_ioctl_args *));
    165 #define procfs_select ((int (*) __P((struct vop_select_args *))) procfs_badop)
    166 #define procfs_mmap ((int (*) __P((struct vop_mmap_args *))) procfs_badop)
    167 #define	procfs_revoke vop_revoke
    168 #define procfs_fsync ((int (*) __P((struct vop_fsync_args *))) procfs_badop)
    169 #define procfs_seek ((int (*) __P((struct vop_seek_args *))) procfs_badop)
    170 #define procfs_remove ((int (*) __P((struct vop_remove_args *))) procfs_badop)
    171 #define procfs_link ((int (*) __P((struct vop_link_args *))) procfs_badop)
    172 #define procfs_rename ((int (*) __P((struct vop_rename_args *))) procfs_badop)
    173 #define procfs_mkdir ((int (*) __P((struct vop_mkdir_args *))) procfs_badop)
    174 #define procfs_rmdir ((int (*) __P((struct vop_rmdir_args *))) procfs_badop)
    175 #define procfs_symlink ((int (*) __P((struct vop_symlink_args *))) procfs_badop)
    176 int	procfs_readdir __P((struct vop_readdir_args *));
    177 int	procfs_readlink __P((struct vop_readlink_args *));
    178 int	procfs_abortop __P((struct vop_abortop_args *));
    179 int	procfs_inactive __P((struct vop_inactive_args *));
    180 int	procfs_reclaim __P((struct vop_reclaim_args *));
    181 #define procfs_lock ((int (*) __P((struct  vop_lock_args *)))vop_nolock)
    182 #define procfs_unlock ((int (*) __P((struct  vop_unlock_args *)))vop_nounlock)
    183 int	procfs_bmap __P((struct vop_bmap_args *));
    184 #define	procfs_strategy ((int (*) __P((struct vop_strategy_args *))) procfs_badop)
    185 int	procfs_print __P((struct vop_print_args *));
    186 #define procfs_islocked \
    187 	((int (*) __P((struct vop_islocked_args *)))vop_noislocked)
    188 #define procfs_advlock ((int (*) __P((struct vop_advlock_args *))) procfs_badop)
    189 #define procfs_blkatoff ((int (*) __P((struct vop_blkatoff_args *))) procfs_badop)
    190 #define procfs_valloc ((int (*) __P((struct vop_valloc_args *))) procfs_badop)
    191 #define procfs_vfree ((int (*) __P((struct vop_vfree_args *))) nullop)
    192 #define procfs_truncate ((int (*) __P((struct vop_truncate_args *))) procfs_badop)
    193 #define procfs_update ((int (*) __P((struct vop_update_args *))) nullop)
    194 #endif /* KERNEL */
    195