[apple/libc.git] / pthreads / pthread_workqueue.h

/*
 * Copyright (c) 2007 Apple, Inc. All rights reserved.
 *
 * @APPLE_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. 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_LICENSE_HEADER_END@
 */
/* pthread workqueue defns */

#ifndef _POSIX_PTHREAD_WORKQUEUE_H
#define _POSIX_PTHREAD_WORKQUEUE_H

#include <sys/cdefs.h>
#include <pthread.h>


#define __PTHREAD_WORKQ_SIZE__ 128
#define __PTHREAD_WORKQ_ATTR_SIZE__ 60

#define PTHREAD_WORKQUEUE_SIG 0xBEBEBEBE
#define PTHREAD_WORKQUEUE_ATTR_SIG 0xBEBEBEBE

#ifndef __POSIX_LIB__
typedef struct { unsigned int  sig; char opaque[__PTHREAD_WORKQ_SIZE__];} *pthread_workqueue_t;
typedef struct { unsigned int  sig; char opaque[__PTHREAD_WORKQ_ATTR_SIZE__]; } pthread_workqueue_attr_t;
#endif
typedef void * pthread_workitem_handle_t;
/* Kernel expected target concurrency of the workqueue clients for the three priority queues */

#define WORKQ_HIGH_PRIOQUEUE	0
#define WORKQ_DEFAULT_PRIOQUEUE	1
#define WORKQ_LOW_PRIOQUEUE	2

#define WORKQ_NUM_PRIOQUEUE	3

extern __int32_t workq_targetconc[WORKQ_NUM_PRIOQUEUE];

__BEGIN_DECLS
int pthread_workqueue_init_np(void);
int pthread_workqueue_attr_init_np(pthread_workqueue_attr_t * attr);
int pthread_workqueue_attr_destroy_np(pthread_workqueue_attr_t * attr);
int pthread_workqueue_attr_getqueuepriority_np(const pthread_workqueue_attr_t * attr, int * qprio);
/* WORKQ_HIGH/DEFAULT/LOW_PRIOQUEUE are the only valid values */
int pthread_workqueue_attr_setqueuepriority_np(pthread_workqueue_attr_t * attr, int qprio);
int pthread_workqueue_attr_getovercommit_np(const pthread_workqueue_attr_t * attr, int * ocommp);
int pthread_workqueue_attr_setovercommit_np(pthread_workqueue_attr_t * attr, int ocomm);


int pthread_workqueue_create_np(pthread_workqueue_t * workqp, const pthread_workqueue_attr_t * attr);
int pthread_workqueue_additem_np(pthread_workqueue_t workq, void ( *workitem_func)(void *), void * workitem_arg, pthread_workitem_handle_t * itemhandlep, unsigned int *gencountp);
/* If the queue value is WORKQ_NUM_PRIOQUEUE, the request for concurrency is for all queues */
int pthread_workqueue_requestconcurrency_np(int queue, int concurrency);
int pthread_workqueue_getovercommit_np(pthread_workqueue_t workq,  unsigned int *ocommp);
/* 
 * If the arg is non zero, it enables kill on current thread.
 * If the arg of zero, it disables kill on current thread.
 */
int __pthread_workqueue_setkill(int);
__END_DECLS

#endif /* _POSIX_PTHREAD_WORKQUEUE_H */
Commit	Line	Data
224c7076 A	1	/*
	2	* Copyright (c) 2007 Apple, Inc. All rights reserved.
	3	*
	4	* @APPLE_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. Please obtain a copy of the License at
	10	* http://www.opensource.apple.com/apsl/ and read it before using this
	11	* file.
	12	*
	13	* The Original Code and all software distributed under the License are
	14	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	15	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	16	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	17	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	18	* Please see the License for the specific language governing rights and
	19	* limitations under the License.
	20	*
	21	* @APPLE_LICENSE_HEADER_END@
	22	*/
	23	/* pthread workqueue defns */
	24
	25	#ifndef _POSIX_PTHREAD_WORKQUEUE_H
	26	#define _POSIX_PTHREAD_WORKQUEUE_H
	27
	28	#include <sys/cdefs.h>
	29	#include <pthread.h>
	30
	31
	32	#define __PTHREAD_WORKQ_SIZE__ 128
	33	#define __PTHREAD_WORKQ_ATTR_SIZE__ 60
	34
34e8f829 A	35	#define PTHREAD_WORKQUEUE_SIG 0xBEBEBEBE
34e8f829 A	36	#define PTHREAD_WORKQUEUE_ATTR_SIG 0xBEBEBEBE
224c7076 A	37
	38	#ifndef __POSIX_LIB__
	39	typedef struct { unsigned int sig; char opaque[__PTHREAD_WORKQ_SIZE__];} *pthread_workqueue_t;
	40	typedef struct { unsigned int sig; char opaque[__PTHREAD_WORKQ_ATTR_SIZE__]; } pthread_workqueue_attr_t;
	41	#endif
	42	typedef void * pthread_workitem_handle_t;
34e8f829 A	43	/* Kernel expected target concurrency of the workqueue clients for the three priority queues */
	44
	45	#define WORKQ_HIGH_PRIOQUEUE 0
	46	#define WORKQ_DEFAULT_PRIOQUEUE 1
	47	#define WORKQ_LOW_PRIOQUEUE 2
	48
	49	#define WORKQ_NUM_PRIOQUEUE 3
	50
	51	extern __int32_t workq_targetconc[WORKQ_NUM_PRIOQUEUE];
224c7076 A	52
	53	__BEGIN_DECLS
	54	int pthread_workqueue_init_np(void);
	55	int pthread_workqueue_attr_init_np(pthread_workqueue_attr_t * attr);
	56	int pthread_workqueue_attr_destroy_np(pthread_workqueue_attr_t * attr);
	57	int pthread_workqueue_attr_getqueuepriority_np(const pthread_workqueue_attr_t * attr, int * qprio);
34e8f829	58	/* WORKQ_HIGH/DEFAULT/LOW_PRIOQUEUE are the only valid values */
224c7076	59	int pthread_workqueue_attr_setqueuepriority_np(pthread_workqueue_attr_t * attr, int qprio);
34e8f829 A	60	int pthread_workqueue_attr_getovercommit_np(const pthread_workqueue_attr_t * attr, int * ocommp);
34e8f829 A	61	int pthread_workqueue_attr_setovercommit_np(pthread_workqueue_attr_t * attr, int ocomm);
224c7076	62
224c7076 A	63
224c7076 A	64	int pthread_workqueue_create_np(pthread_workqueue_t * workqp, const pthread_workqueue_attr_t * attr);
34e8f829 A	65	int pthread_workqueue_additem_np(pthread_workqueue_t workq, void ( workitem_func)(void ), void * workitem_arg, pthread_workitem_handle_t * itemhandlep, unsigned int *gencountp);
	66	/* If the queue value is WORKQ_NUM_PRIOQUEUE, the request for concurrency is for all queues */
	67	int pthread_workqueue_requestconcurrency_np(int queue, int concurrency);
	68	int pthread_workqueue_getovercommit_np(pthread_workqueue_t workq, unsigned int *ocommp);
	69	/*
	70	* If the arg is non zero, it enables kill on current thread.
	71	* If the arg of zero, it disables kill on current thread.
	72	*/
	73	int __pthread_workqueue_setkill(int);
224c7076 A	74	__END_DECLS
	75
	76	#endif /* _POSIX_PTHREAD_WORKQUEUE_H */
	77