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

/*
 * Copyright (c) 2000-2003 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@
 */

#ifndef _SYS_PTHREAD_INTERNAL_H_
#define _SYS_PTHREAD_INTERNAL_H_

#undef pthread_mutexattr_t;

#include <kern/thread_call.h>

#define WORKITEM_SIZE 64
#define WORKQUEUE_NUMPRIOS 3

#define WORKQUEUE_OVERCOMMIT	0x10000

struct threadlist {
	TAILQ_ENTRY(threadlist) th_entry;
	thread_t th_thread;
	int	 th_flags;
	uint32_t th_suspended;
	uint16_t th_affinity_tag;
	uint8_t	 th_priority;
	uint8_t  th_policy;
	struct workqueue *th_workq;
	mach_vm_size_t th_stacksize;
	mach_vm_size_t th_allocsize;
	mach_vm_offset_t th_stackaddr;
	mach_port_name_t th_thport;
};
#define TH_LIST_INITED 		0x01
#define TH_LIST_RUNNING 	0x02
#define TH_LIST_BLOCKED 	0x04
#define TH_LIST_SUSPENDED 	0x08
#define TH_LIST_BUSY		0x10

struct workitem {
	TAILQ_ENTRY(workitem) wi_entry;
	user_addr_t wi_item;
	uint32_t wi_affinity;
};

struct workitemlist {
	TAILQ_HEAD(, workitem) wl_itemlist;
	TAILQ_HEAD(, workitem) wl_freelist;
};

struct workqueue {
	struct workitem wq_array[WORKITEM_SIZE * WORKQUEUE_NUMPRIOS];
        proc_t		wq_proc;
        vm_map_t	wq_map;
        task_t		wq_task;
        thread_call_t	wq_atimer_call;
	int 		wq_flags;
	int		wq_lflags;
        int		wq_itemcount;
	uint64_t 	wq_thread_yielded_timestamp;
	uint32_t	wq_thread_yielded_count;
	uint32_t	wq_timer_interval;
        uint32_t	wq_affinity_max;
        uint32_t	wq_threads_scheduled;
	uint32_t	wq_nthreads;
        uint32_t      	wq_thidlecount;
	uint32_t	wq_reqconc[WORKQUEUE_NUMPRIOS];	  /* requested concurrency for each priority level */
	struct workitemlist  wq_list[WORKQUEUE_NUMPRIOS]; /* priority based item list */
	uint32_t	wq_list_bitmap;
	TAILQ_HEAD(, threadlist) wq_thrunlist;
	TAILQ_HEAD(, threadlist) wq_thidlelist;
        uint32_t	*wq_thactive_count[WORKQUEUE_NUMPRIOS];
        uint32_t	*wq_thscheduled_count[WORKQUEUE_NUMPRIOS];
        uint64_t	*wq_lastblocked_ts[WORKQUEUE_NUMPRIOS];
};
#define WQ_LIST_INITED		0x01
#define WQ_ATIMER_RUNNING	0x02
#define WQ_EXITING		0x04

#define WQL_ATIMER_BUSY		0x01
#define WQL_ATIMER_WAITING	0x02


#define WQ_VECT_SET_BIT(vector, bit)	\
	vector[(bit) / 32] |= (1 << ((bit) % 32))

#define WQ_VECT_CLEAR_BIT(vector, bit)	\
	vector[(bit) / 32] &= ~(1 << ((bit) % 32))

#define WQ_VECT_TEST_BIT(vector, bit)	\
	vector[(bit) / 32] & (1 << ((bit) % 32))


#define WORKQUEUE_MAXTHREADS		512
#define WQ_YIELDED_THRESHOLD		2000
#define WQ_YIELDED_WINDOW_USECS		30000
#define WQ_STALLED_WINDOW_USECS		200
#define WQ_REDUCE_POOL_WINDOW_USECS	5000000
#define	WQ_MAX_TIMER_INTERVAL_USECS	50000

/* workq_kernreturn commands */
#define WQOPS_QUEUE_ADD 1
#define WQOPS_QUEUE_REMOVE 2
#define WQOPS_THREAD_RETURN 4
#define WQOPS_THREAD_SETCONC  8

#define PTH_DEFAULT_STACKSIZE 512*1024
#define PTH_DEFAULT_GUARDSIZE 4*1024
#define MAX_PTHREAD_SIZE 64*1024

void workqueue_exit(struct proc *);

void pthread_init(void);
extern lck_grp_attr_t   *pthread_lck_grp_attr;
extern lck_grp_t    *pthread_lck_grp;
extern lck_attr_t   *pthread_lck_attr;

#endif /* _SYS_PTHREAD_INTERNAL_H_ */
Commit	Line	Data
2d21ac55 A	1	/*
	2	* Copyright (c) 2000-2003 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
	5	*
	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
	24	* limitations under the License.
	25	*
	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
	27	*/
	28
	29	#ifndef _SYS_PTHREAD_INTERNAL_H_
	30	#define _SYS_PTHREAD_INTERNAL_H_
	31
	32	#undef pthread_mutexattr_t;
	33
	34	#include <kern/thread_call.h>
	35
2d21ac55	36	#define WORKITEM_SIZE 64
b0d623f7 A	37	#define WORKQUEUE_NUMPRIOS 3
	38
	39	#define WORKQUEUE_OVERCOMMIT 0x10000
2d21ac55 A	40
	41	struct threadlist {
	42	TAILQ_ENTRY(threadlist) th_entry;
	43	thread_t th_thread;
	44	int th_flags;
b0d623f7 A	45	uint32_t th_suspended;
	46	uint16_t th_affinity_tag;
	47	uint8_t th_priority;
	48	uint8_t th_policy;
2d21ac55 A	49	struct workqueue *th_workq;
	50	mach_vm_size_t th_stacksize;
	51	mach_vm_size_t th_allocsize;
	52	mach_vm_offset_t th_stackaddr;
b0d623f7	53	mach_port_name_t th_thport;
2d21ac55 A	54	};
	55	#define TH_LIST_INITED 0x01
	56	#define TH_LIST_RUNNING 0x02
	57	#define TH_LIST_BLOCKED 0x04
	58	#define TH_LIST_SUSPENDED 0x08
b0d623f7	59	#define TH_LIST_BUSY 0x10
2d21ac55 A	60
	61	struct workitem {
	62	TAILQ_ENTRY(workitem) wi_entry;
	63	user_addr_t wi_item;
b0d623f7	64	uint32_t wi_affinity;
2d21ac55 A	65	};
	66
	67	struct workitemlist {
	68	TAILQ_HEAD(, workitem) wl_itemlist;
	69	TAILQ_HEAD(, workitem) wl_freelist;
	70	};
	71
2d21ac55 A	72	struct workqueue {
	73	struct workitem wq_array[WORKITEM_SIZE * WORKQUEUE_NUMPRIOS];
	74	proc_t wq_proc;
	75	vm_map_t wq_map;
	76	task_t wq_task;
b0d623f7	77	thread_call_t wq_atimer_call;
2d21ac55	78	int wq_flags;
b0d623f7	79	int wq_lflags;
2d21ac55	80	int wq_itemcount;
b0d623f7 A	81	uint64_t wq_thread_yielded_timestamp;
	82	uint32_t wq_thread_yielded_count;
	83	uint32_t wq_timer_interval;
2d21ac55 A	84	uint32_t wq_affinity_max;
	85	uint32_t wq_threads_scheduled;
	86	uint32_t wq_nthreads;
b0d623f7 A	87	uint32_t wq_thidlecount;
	88	uint32_t wq_reqconc[WORKQUEUE_NUMPRIOS]; /* requested concurrency for each priority level */
	89	struct workitemlist wq_list[WORKQUEUE_NUMPRIOS]; /* priority based item list */
	90	uint32_t wq_list_bitmap;
2d21ac55	91	TAILQ_HEAD(, threadlist) wq_thrunlist;
b0d623f7 A	92	TAILQ_HEAD(, threadlist) wq_thidlelist;
	93	uint32_t *wq_thactive_count[WORKQUEUE_NUMPRIOS];
	94	uint32_t *wq_thscheduled_count[WORKQUEUE_NUMPRIOS];
	95	uint64_t *wq_lastblocked_ts[WORKQUEUE_NUMPRIOS];
2d21ac55 A	96	};
2d21ac55 A	97	#define WQ_LIST_INITED 0x01
b0d623f7 A	98	#define WQ_ATIMER_RUNNING 0x02
	99	#define WQ_EXITING 0x04
	100
	101	#define WQL_ATIMER_BUSY 0x01
	102	#define WQL_ATIMER_WAITING 0x02
	103
	104
	105	#define WQ_VECT_SET_BIT(vector, bit) \
	106	vector[(bit) / 32] \|= (1 << ((bit) % 32))
	107
	108	#define WQ_VECT_CLEAR_BIT(vector, bit) \
	109	vector[(bit) / 32] &= ~(1 << ((bit) % 32))
	110
	111	#define WQ_VECT_TEST_BIT(vector, bit) \
	112	vector[(bit) / 32] & (1 << ((bit) % 32))
	113
2d21ac55	114
b0d623f7 A	115	#define WORKQUEUE_MAXTHREADS 512
	116	#define WQ_YIELDED_THRESHOLD 2000
	117	#define WQ_YIELDED_WINDOW_USECS 30000
	118	#define WQ_STALLED_WINDOW_USECS 200
	119	#define WQ_REDUCE_POOL_WINDOW_USECS 5000000
	120	#define WQ_MAX_TIMER_INTERVAL_USECS 50000
2d21ac55	121
b0d623f7	122	/* workq_kernreturn commands */
2d21ac55 A	123	#define WQOPS_QUEUE_ADD 1
	124	#define WQOPS_QUEUE_REMOVE 2
	125	#define WQOPS_THREAD_RETURN 4
b0d623f7	126	#define WQOPS_THREAD_SETCONC 8
2d21ac55 A	127
	128	#define PTH_DEFAULT_STACKSIZE 512*1024
	129	#define PTH_DEFAULT_GUARDSIZE 4*1024
	130	#define MAX_PTHREAD_SIZE 64*1024
	131
	132	void workqueue_exit(struct proc *);
	133
b0d623f7 A	134	void pthread_init(void);
	135	extern lck_grp_attr_t *pthread_lck_grp_attr;
	136	extern lck_grp_t *pthread_lck_grp;
	137	extern lck_attr_t *pthread_lck_attr;
2d21ac55 A	138
	139	#endif /* _SYS_PTHREAD_INTERNAL_H_ */
	140