[apple/xnu.git] / osfmk / kern / call_entry.h

/*
 * Copyright (c) 1993-1995, 1999-2008 Apple 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@
 */
/*
 * Declarations for generic call outs.
 */

#ifndef _KERN_CALL_ENTRY_H_
#define _KERN_CALL_ENTRY_H_

#ifdef XNU_KERNEL_PRIVATE
#include <kern/queue.h>

#define TIMER_TRACE	1

typedef void		*call_entry_param_t;
typedef void		(*call_entry_func_t)(
				call_entry_param_t	param0,
				call_entry_param_t	param1);

typedef struct call_entry {
    queue_chain_t	q_link;
    queue_head_t	*queue;
    call_entry_func_t	func;
    call_entry_param_t	param0;
    call_entry_param_t	param1;
    uint64_t		deadline;
#if TIMER_TRACE
    uint64_t		entry_time;
#endif
} call_entry_data_t;

typedef struct call_entry	*call_entry_t;

#ifdef MACH_KERNEL_PRIVATE

#define	call_entry_setup(entry, pfun, p0)			\
MACRO_BEGIN							\
	(entry)->func		= (call_entry_func_t)(pfun);	\
	(entry)->param0		= (call_entry_param_t)(p0);	\
	(entry)->queue		= NULL;				\
	(entry)->deadline	= 0;				\
MACRO_END

#define qe(x)		((queue_entry_t)(x))
#define CE(x)		((call_entry_t)(x))

static __inline__ queue_head_t *
call_entry_enqueue_tail(
        call_entry_t            entry,
        queue_t                 queue)
{
        queue_t                 old_queue = entry->queue;

        if (old_queue != NULL)
                (void)remque(qe(entry));

        enqueue_tail(queue, qe(entry));

        entry->queue = queue;

        return (old_queue);
}

static __inline__ queue_head_t *
call_entry_dequeue(
	call_entry_t		entry)
{
        queue_t                 old_queue = entry->queue;

	if (old_queue != NULL) {
		(void)remque(qe(entry));

		entry->queue = NULL;
	}
	return (old_queue);
}

static __inline__ queue_head_t *
call_entry_enqueue_deadline(
	call_entry_t			entry,
	queue_head_t			*queue,
	uint64_t			deadline)
{
	queue_t		old_queue = entry->queue;
	call_entry_t	current;

	if (old_queue != queue || entry->deadline < deadline) {
		if (old_queue == NULL) {
			current = CE(queue_first(queue));
		} else if (old_queue != queue) {
			(void)remque(qe(entry));
			current = CE(queue_first(queue));
		} else {
			current = CE(queue_next(qe(entry)));
			(void)remque(qe(entry));
		}

		while (TRUE) {
			if (queue_end(queue, qe(current)) ||
			    deadline < current->deadline) {
				current = CE(queue_prev(qe(current)));
				break;
			}

			current = CE(queue_next(qe(current)));
		}
		insque(qe(entry), qe(current));
	}
	else if (deadline < entry->deadline) {
		current = CE(queue_prev(qe(entry)));

		(void)remque(qe(entry));

		while (TRUE) {
			if (queue_end(queue, qe(current)) ||
			    current->deadline <= deadline) {
				break;
			}

			current = CE(queue_prev(qe(current)));
		}
		insque(qe(entry), qe(current));
	}
	entry->queue = queue;
	entry->deadline = deadline;

	return (old_queue);
}
#endif /* MACH_KERNEL_PRIVATE */

#endif /* XNU_KERNEL_PRIVATE */

#endif /* _KERN_CALL_ENTRY_H_ */
Commit	Line	Data
1c79356b	1	/*
c910b4d9	2	* Copyright (c) 1993-1995, 1999-2008 Apple Inc. All rights reserved.
1c79356b	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
1c79356b A	28	/*
c910b4d9	29	* Declarations for generic call outs.
1c79356b A	30	*/
	31
	32	#ifndef _KERN_CALL_ENTRY_H_
	33	#define _KERN_CALL_ENTRY_H_
	34
39236c6e	35	#ifdef XNU_KERNEL_PRIVATE
1c79356b A	36	#include <kern/queue.h>
1c79356b A	37
39236c6e A	38	#define TIMER_TRACE 1
39236c6e A	39
6d2010ae A	40	typedef void *call_entry_param_t;
	41	typedef void (*call_entry_func_t)(
	42	call_entry_param_t param0,
	43	call_entry_param_t param1);
1c79356b A	44
1c79356b A	45	typedef struct call_entry {
6d2010ae A	46	queue_chain_t q_link;
6d2010ae A	47	queue_head_t *queue;
1c79356b A	48	call_entry_func_t func;
	49	call_entry_param_t param0;
	50	call_entry_param_t param1;
6d2010ae	51	uint64_t deadline;
39236c6e A	52	#if TIMER_TRACE
	53	uint64_t entry_time;
	54	#endif
1c79356b A	55	} call_entry_data_t;
1c79356b A	56
6d2010ae	57	typedef struct call_entry *call_entry_t;
c910b4d9	58
39236c6e	59	#ifdef MACH_KERNEL_PRIVATE
c910b4d9	60
6d2010ae A	61	#define call_entry_setup(entry, pfun, p0) \
6d2010ae A	62	MACRO_BEGIN \
1c79356b	63	(entry)->func = (call_entry_func_t)(pfun); \
6d2010ae A	64	(entry)->param0 = (call_entry_param_t)(p0); \
6d2010ae A	65	(entry)->queue = NULL; \
39236c6e	66	(entry)->deadline = 0; \
1c79356b A	67	MACRO_END
1c79356b A	68
6d2010ae A	69	#define qe(x) ((queue_entry_t)(x))
	70	#define CE(x) ((call_entry_t)(x))
	71
	72	static __inline__ queue_head_t *
	73	call_entry_enqueue_tail(
	74	call_entry_t entry,
	75	queue_t queue)
	76	{
	77	queue_t old_queue = entry->queue;
	78
	79	if (old_queue != NULL)
	80	(void)remque(qe(entry));
	81
	82	enqueue_tail(queue, qe(entry));
	83
	84	entry->queue = queue;
	85
	86	return (old_queue);
	87	}
	88
	89	static __inline__ queue_head_t *
	90	call_entry_dequeue(
	91	call_entry_t entry)
	92	{
	93	queue_t old_queue = entry->queue;
	94
	95	if (old_queue != NULL) {
	96	(void)remque(qe(entry));
	97
	98	entry->queue = NULL;
	99	}
	100	return (old_queue);
	101	}
	102
	103	static __inline__ queue_head_t *
	104	call_entry_enqueue_deadline(
	105	call_entry_t entry,
	106	queue_head_t *queue,
	107	uint64_t deadline)
	108	{
	109	queue_t old_queue = entry->queue;
	110	call_entry_t current;
	111
	112	if (old_queue != queue \|\| entry->deadline < deadline) {
	113	if (old_queue == NULL) {
	114	current = CE(queue_first(queue));
	115	} else if (old_queue != queue) {
	116	(void)remque(qe(entry));
	117	current = CE(queue_first(queue));
	118	} else {
	119	current = CE(queue_next(qe(entry)));
	120	(void)remque(qe(entry));
	121	}
	122
	123	while (TRUE) {
	124	if (queue_end(queue, qe(current)) \|\|
	125	deadline < current->deadline) {
	126	current = CE(queue_prev(qe(current)));
	127	break;
	128	}
	129
	130	current = CE(queue_next(qe(current)));
	131	}
	132	insque(qe(entry), qe(current));
133	}
39236c6e	134	else if (deadline < entry->deadline) {
6d2010ae A	135	current = CE(queue_prev(qe(entry)));
	136
	137	(void)remque(qe(entry));
	138
	139	while (TRUE) {
	140	if (queue_end(queue, qe(current)) \|\|
	141	current->deadline <= deadline) {
	142	break;
	143	}
	144
	145	current = CE(queue_prev(qe(current)));
	146	}
	147	insque(qe(entry), qe(current));
	148	}
	149	entry->queue = queue;
	150	entry->deadline = deadline;
	151
	152	return (old_queue);
	153	}
1c79356b A	154	#endif /* MACH_KERNEL_PRIVATE */
1c79356b A	155
39236c6e A	156	#endif /* XNU_KERNEL_PRIVATE */
39236c6e A	157
1c79356b	158	#endif /* _KERN_CALL_ENTRY_H_ */