[apple/xnu.git] / bsd / sys / user.h

/*
 * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */
/*
 * Copyright (c) 1982, 1986, 1989, 1991, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * 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.
 *
 *	@(#)user.h	8.2 (Berkeley) 9/23/93
 */

#ifndef	_SYS_USER_H_
#define	_SYS_USER_H_

#include <sys/appleapiopts.h>
#ifndef KERNEL
/* stuff that *used* to be included by user.h, or is now needed */
#include <errno.h>
#include <sys/time.h>
#include <sys/resource.h>
#include <sys/ucred.h>
#include <sys/uio.h>
#endif
#include <sys/resourcevar.h>
#ifdef KERNEL_PRIVATE
#include <sys/signalvar.h>
#endif
#include <sys/vm.h>		/* XXX */
#include <sys/sysctl.h>
 
#ifdef KERNEL
#ifdef __APPLE_API_PRIVATE
#include <sys/eventvar.h>

/*
 *	Per-thread U area.
 */
struct uthread {
	/* syscall parameters, results and catches */
	u_int64_t uu_arg[8]; /* arguments to current system call */
	int	*uu_ap;			/* pointer to arglist */
        int uu_rval[2];

	/* thread exception handling */
	int	uu_exception;
	int	uu_code;			/* ``code'' to trap */
	int	uu_subcode;
	char uu_cursig;			/* p_cursig for exc. */
	/* support for select - across system calls */
	struct _select {
		u_int32_t	*ibits, *obits; /* bits to select on */
		uint	nbytes;	/* number of bytes in ibits and obits */
		wait_queue_set_t wqset;	 /* cached across select calls */
		size_t allocsize;		 /* ...size of select cache */
		u_int64_t abstime;
		int poll;
		int error;
		int count;
		char * wql;
	} uu_select;			/* saved state for select() */
	/* to support continuations */
	union {
		int uu_nfs_myiod;    /* saved state for nfsd */
		struct _kevent_scan {
			kevent_callback_t call; /* per-event callback */
			kevent_continue_t cont; /* whole call continuation */
			uint64_t deadline;	/* computed deadline for operation */
			void *data;		/* caller's private data */
		} ss_kevent_scan;		/* saved state for kevent_scan() */
		struct _kevent {
			struct _kevent_scan scan;/* space for the generic data */
			struct fileproc *fp;	 /* fileproc we hold iocount on */
			int fd;			 /* filedescriptor for kq */
			register_t *retval;	 /* place to store return val */
			user_addr_t eventlist;	 /* user-level event list address */
			int eventcount;	 	/* user-level event count */
			int eventout;		 /* number of events output */
		} ss_kevent;			 /* saved state for kevent() */
	} uu_state;
  /* internal support for continuation framework */
    int (*uu_continuation)(int);
    int uu_pri;
    int uu_timo;
	int uu_flag;
	struct proc * uu_proc;
	void * uu_userstate;
	sigset_t uu_siglist;				/* signals pending for the thread */
	sigset_t  uu_sigwait;				/*  sigwait on this thread*/
	sigset_t  uu_sigmask;				/* signal mask for the thread */
	sigset_t  uu_oldmask;				/* signal mask saved before sigpause */
	thread_t uu_act;
	sigset_t  uu_vforkmask;				/* saved signal mask during vfork */

	TAILQ_ENTRY(uthread) uu_list;		/* List of uthreads in proc */

	struct kaudit_record 		*uu_ar;		/* audit record */
	struct task*	uu_aio_task;			/* target task for async io */

  /* network support for dlil layer locking */
	u_int32_t	dlil_incremented_read;
	lck_mtx_t	*uu_mtx;

        int		uu_lowpri_delay;

	struct ucred	*uu_ucred;		/* per thread credential */
        int		uu_defer_reclaims;
        vnode_t		uu_vreclaims;
		struct user_sigaltstack uu_sigstk;
#ifdef JOE_DEBUG
        int		uu_iocount;
        int		uu_vpindex;
        void 	*	uu_vps[32];
#endif
};

typedef struct uthread * uthread_t;

/* Definition of uu_flag */
#define	UT_SAS_OLDMASK	0x00000001	/* need to restore mask before pause */
#define	UT_NO_SIGMASK	0x00000002	/* exited thread; invalid sigmask */
#define UT_NOTCANCELPT	0x00000004             /* not a cancelation point */
#define UT_CANCEL	0x00000008             /* thread marked for cancel */
#define UT_CANCELED	0x00000010            /* thread cancelled */
#define UT_CANCELDISABLE 0x00000020            /* thread cancel disabled */
#define UT_ALTSTACK 0x00000040  /* this thread has alt stack for signals */

#define	UT_VFORK	0x02000000	/* thread has vfork children */
#define	UT_SETUID	0x04000000	/* thread is settugid() */
#define UT_WASSETUID	0x08000000	/* thread was settugid() (in vfork) */

#endif /* __APPLE_API_PRIVATE */

#endif	/* KERNEL */

/*
 * Per process structure containing data that isn't needed in core
 * when the process isn't running (esp. when swapped out).
 * This structure may or may not be at the same kernel address
 * in all processes.
 */
 
struct	user {
  /* NOT USED ANYMORE */
};

#endif	/* !_SYS_USER_H_ */
Commit	Line	Data
1c79356b	1	/*
5d5c5d0d A	2	* Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
5d5c5d0d A	3	*
8f6c56a5	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
8f6c56a5 A	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. The rights granted to you under the License
	10	* may not be used to create, or enable the creation or redistribution of,
	11	* unlawful or unlicensed copies of an Apple operating system, or to
	12	* circumvent, violate, or enable the circumvention or violation of, any
	13	* terms of an Apple operating system software license agreement.
	14	*
	15	* Please obtain a copy of the License at
	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
	17	*
	18	* The Original Code and all software distributed under the License are
	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
8ad349bb	24	* limitations under the License.
8f6c56a5 A	25	*
8f6c56a5 A	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */
	29	/*
	30	* Copyright (c) 1982, 1986, 1989, 1991, 1993
	31	* The Regents of the University of California. All rights reserved.
	32	*
	33	* Redistribution and use in source and binary forms, with or without
	34	* modification, are permitted provided that the following conditions
	35	* are met:
	36	* 1. Redistributions of source code must retain the above copyright
	37	* notice, this list of conditions and the following disclaimer.
	38	* 2. Redistributions in binary form must reproduce the above copyright
	39	* notice, this list of conditions and the following disclaimer in the
	40	* documentation and/or other materials provided with the distribution.
	41	* 3. All advertising materials mentioning features or use of this software
	42	* must display the following acknowledgement:
	43	* This product includes software developed by the University of
	44	* California, Berkeley and its contributors.
	45	* 4. Neither the name of the University nor the names of its contributors
	46	* may be used to endorse or promote products derived from this software
	47	* without specific prior written permission.
	48	*
	49	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	50	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	51	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	52	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	53	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	54	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	55	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	56	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	57	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	58	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	59	* SUCH DAMAGE.
	60	*
	61	* @(#)user.h 8.2 (Berkeley) 9/23/93
	62	*/
	63
	64	#ifndef _SYS_USER_H_
	65	#define _SYS_USER_H_
	66
9bccf70c	67	#include <sys/appleapiopts.h>
1c79356b A	68	#ifndef KERNEL
	69	/* stuff that used to be included by user.h, or is now needed */
	70	#include <errno.h>
	71	#include <sys/time.h>
	72	#include <sys/resource.h>
	73	#include <sys/ucred.h>
	74	#include <sys/uio.h>
	75	#endif
	76	#include <sys/resourcevar.h>
91447636	77	#ifdef KERNEL_PRIVATE
1c79356b	78	#include <sys/signalvar.h>
91447636	79	#endif
1c79356b A	80	#include <sys/vm.h> /* XXX */
	81	#include <sys/sysctl.h>
	82
	83	#ifdef KERNEL
9bccf70c	84	#ifdef __APPLE_API_PRIVATE
91447636 A	85	#include <sys/eventvar.h>
91447636 A	86
1c79356b A	87	/*
1c79356b A	88	* Per-thread U area.
1c79356b A	89	*/
1c79356b A	90	struct uthread {
1c79356b	91	/* syscall parameters, results and catches */
91447636	92	u_int64_t uu_arg[8]; /* arguments to current system call */
1c79356b	93	int uu_ap; / pointer to arglist */
89b3af67	94	int uu_rval[2];
1c79356b A	95
1c79356b A	96	/* thread exception handling */
89b3af67	97	int uu_exception;
1c79356b	98	int uu_code; /* ``code'' to trap */
89b3af67	99	int uu_subcode;
91447636 A	100	char uu_cursig; /* p_cursig for exc. */
	101	/* support for select - across system calls */
	102	struct _select {
	103	u_int32_t ibits, obits; /* bits to select on */
	104	uint nbytes; /* number of bytes in ibits and obits */
	105	wait_queue_set_t wqset; /* cached across select calls */
	106	size_t allocsize; /* ...size of select cache */
	107	u_int64_t abstime;
	108	int poll;
	109	int error;
	110	int count;
	111	char * wql;
	112	} uu_select; /* saved state for select() */
	113	/* to support continuations */
1c79356b	114	union {
91447636 A	115	int uu_nfs_myiod; /* saved state for nfsd */
	116	struct _kevent_scan {
	117	kevent_callback_t call; /* per-event callback */
	118	kevent_continue_t cont; /* whole call continuation */
	119	uint64_t deadline; /* computed deadline for operation */
	120	void data; / caller's private data */
	121	} ss_kevent_scan; /* saved state for kevent_scan() */
	122	struct _kevent {
	123	struct _kevent_scan scan;/* space for the generic data */
	124	struct fileproc fp; / fileproc we hold iocount on */
	125	int fd; /* filedescriptor for kq */
	126	register_t retval; / place to store return val */
	127	user_addr_t eventlist; /* user-level event list address */
	128	int eventcount; /* user-level event count */
	129	int eventout; /* number of events output */
	130	} ss_kevent; /* saved state for kevent() */
1c79356b	131	} uu_state;
1c79356b A	132	/* internal support for continuation framework */
	133	int (*uu_continuation)(int);
	134	int uu_pri;
	135	int uu_timo;
0b4e3aa0 A	136	int uu_flag;
	137	struct proc * uu_proc;
	138	void * uu_userstate;
9bccf70c A	139	sigset_t uu_siglist; /* signals pending for the thread */
	140	sigset_t uu_sigwait; /* sigwait on this thread*/
	141	sigset_t uu_sigmask; /* signal mask for the thread */
	142	sigset_t uu_oldmask; /* signal mask saved before sigpause */
91447636	143	thread_t uu_act;
9bccf70c A	144	sigset_t uu_vforkmask; /* saved signal mask during vfork */
	145
	146	TAILQ_ENTRY(uthread) uu_list; /* List of uthreads in proc */
55e303ae A	147
	148	struct kaudit_record uu_ar; / audit record */
	149	struct task* uu_aio_task; /* target task for async io */
91447636 A	150
	151	/* network support for dlil layer locking */
	152	u_int32_t dlil_incremented_read;
	153	lck_mtx_t *uu_mtx;
	154
	155	int uu_lowpri_delay;
	156
	157	struct ucred uu_ucred; / per thread credential */
	158	int uu_defer_reclaims;
	159	vnode_t uu_vreclaims;
89b3af67	160	struct user_sigaltstack uu_sigstk;
91447636 A	161	#ifdef JOE_DEBUG
	162	int uu_iocount;
	163	int uu_vpindex;
	164	void * uu_vps[32];
	165	#endif
1c79356b	166	};
0b4e3aa0	167
1c79356b	168	typedef struct uthread * uthread_t;
9bccf70c A	169
9bccf70c A	170	/* Definition of uu_flag */
91447636 A	171	#define UT_SAS_OLDMASK 0x00000001 /* need to restore mask before pause */
	172	#define UT_NO_SIGMASK 0x00000002 /* exited thread; invalid sigmask */
	173	#define UT_NOTCANCELPT 0x00000004 /* not a cancelation point */
	174	#define UT_CANCEL 0x00000008 /* thread marked for cancel */
	175	#define UT_CANCELED 0x00000010 /* thread cancelled */
	176	#define UT_CANCELDISABLE 0x00000020 /* thread cancel disabled */
89b3af67	177	#define UT_ALTSTACK 0x00000040 /* this thread has alt stack for signals */
91447636 A	178
	179	#define UT_VFORK 0x02000000 /* thread has vfork children */
	180	#define UT_SETUID 0x04000000 /* thread is settugid() */
	181	#define UT_WASSETUID 0x08000000 /* thread was settugid() (in vfork) */
9bccf70c A	182
	183	#endif /* __APPLE_API_PRIVATE */
	184
1c79356b A	185	#endif /* KERNEL */
	186
	187	/*
	188	* Per process structure containing data that isn't needed in core
	189	* when the process isn't running (esp. when swapped out).
	190	* This structure may or may not be at the same kernel address
	191	* in all processes.
	192	*/
	193
	194	struct user {
	195	/* NOT USED ANYMORE */
	196	};
	197
	198	#endif /* !_SYS_USER_H_ */