X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/c910b4d9d2451126ae3917b931cd4390c11e1d52..c7d2c2c6ee645e10cbccdd01c6191873ec77239d:/osfmk/kern/timer_call.h

diff --git a/osfmk/kern/timer_call.h b/osfmk/kern/timer_call.h
index 061e3d96c..03c062ed6 100644
--- a/osfmk/kern/timer_call.h
+++ b/osfmk/kern/timer_call.h
@@ -33,38 +33,136 @@
 #define _KERN_TIMER_CALL_H_
 
 #include <mach/mach_types.h>
+#include <kern/kern_types.h>
+
+#ifdef XNU_KERNEL_PRIVATE
+
+#include <kern/call_entry.h>
+#include <kern/simple_lock.h>
 
 #ifdef MACH_KERNEL_PRIVATE
+#include <kern/queue.h>
+
+extern boolean_t mach_timer_coalescing_enabled;
+extern void timer_call_queue_init(mpqueue_head_t *);
+#endif
+
+/*
+ * NOTE: for now, bsd/dev/dtrace/dtrace_glue.c has its own definition
+ * of this data structure, and the two had better match.
+ */
+typedef struct timer_call {
+	struct call_entry 	call_entry;
+	decl_simple_lock_data( ,lock);		/* protects call_entry queue */
+	uint64_t		soft_deadline;
+	uint32_t		flags;
+	boolean_t		async_dequeue;	/* this field is protected by
+						   call_entry queue's lock */
+	uint64_t		ttd; /* Time to deadline at creation */
+} timer_call_data_t, *timer_call_t;
+
+#define EndOfAllTime		0xFFFFFFFFFFFFFFFFULL
+
+typedef void		*timer_call_param_t;
+typedef void		(*timer_call_func_t)(
+				timer_call_param_t	param0,
+				timer_call_param_t	param1);
+
+/*
+ * Flags to alter the default timer/timeout coalescing behavior
+ * on a per-timer_call basis.
+ *
+ * The SYS urgency classes indicate that the timer_call is not
+ * directly related to the current thread at the time the timer_call
+ * is entered, so it is ignored in the calculation entirely (only
+ * the subclass specified is used).
+ *
+ * The USER flags indicate that both the current thread scheduling and QoS
+ * attributes, in addition to the per-timer_call urgency specification,
+ * are used to establish coalescing behavior.
+ */
+#define TIMER_CALL_SYS_NORMAL		TIMEOUT_URGENCY_SYS_NORMAL
+#define TIMER_CALL_SYS_CRITICAL		TIMEOUT_URGENCY_SYS_CRITICAL
+#define TIMER_CALL_SYS_BACKGROUND	TIMEOUT_URGENCY_SYS_BACKGROUND
 
-typedef struct call_entry	*timer_call_t;
-typedef void				*timer_call_param_t;
-typedef void				(*timer_call_func_t)(
-									timer_call_param_t		param0,
-									timer_call_param_t		param1);
+#define TIMER_CALL_USER_MASK		TIMEOUT_URGENCY_USER_MASK
+#define TIMER_CALL_USER_NORMAL		TIMEOUT_URGENCY_USER_NORMAL
+#define TIMER_CALL_USER_CRITICAL	TIMEOUT_URGENCY_USER_CRITICAL
+#define TIMER_CALL_USER_BACKGROUND	TIMEOUT_URGENCY_USER_BACKGROUND
 
+#define TIMER_CALL_URGENCY_MASK		TIMEOUT_URGENCY_MASK
+
+/*
+ * Indicate that a specific leeway value is being provided (otherwise
+ * the leeway parameter is ignored).  This supplied value can currently
+ * only be used to extend the leeway calculated internally from the
+ * urgency class provided.
+ */
+#define TIMER_CALL_LEEWAY		TIMEOUT_URGENCY_LEEWAY
+
+/*
+ * Non-migratable timer_call
+ */
+#define TIMER_CALL_LOCAL		TIMEOUT_URGENCY_FIRST_AVAIL
+#define TIMER_CALL_RATELIMITED		TIMEOUT_URGENCY_RATELIMITED
 extern boolean_t	timer_call_enter(
-						timer_call_t	call,
-						uint64_t		deadline);
+				timer_call_t	call,
+				uint64_t	deadline,
+				uint32_t	flags);
 
 extern boolean_t	timer_call_enter1(
+				timer_call_t		call,
+				timer_call_param_t	param1,
+				uint64_t		deadline,
+				uint32_t 		flags);
+
+extern boolean_t	timer_call_enter_with_leeway(
 						timer_call_t		call,
 						timer_call_param_t	param1,
-						uint64_t			deadline);
+						uint64_t		deadline,
+						uint64_t		leeway,
+						uint32_t 		flags,
+						boolean_t		ratelimited);
 
 extern boolean_t	timer_call_cancel(
-						timer_call_t	call);
+				timer_call_t	call);
 
-#include <kern/call_entry.h>
+extern void		timer_call_init(void);
+
+extern void		timer_call_setup(
+				timer_call_t		call,
+				timer_call_func_t	func,
+				timer_call_param_t	param0);
 
-typedef struct call_entry	timer_call_data_t;
+extern int timer_get_user_idle_level(void);
+extern kern_return_t timer_set_user_idle_level(int ilevel);
 
-extern void		timer_call_initialize(void);
+#define NUM_LATENCY_QOS_TIERS (6)
+typedef struct {
+	uint32_t powergate_latency_abstime;
 
-extern void		timer_call_setup(
-					timer_call_t		call,
-					timer_call_func_t	func,
-					timer_call_param_t	param0);
+	uint32_t idle_entry_timer_processing_hdeadline_threshold_abstime;
+	uint32_t interrupt_timer_coalescing_ilat_threshold_abstime;
+	uint32_t timer_resort_threshold_abstime;
+
+	int32_t timer_coalesce_rt_shift;
+	int32_t timer_coalesce_bg_shift;
+	int32_t timer_coalesce_kt_shift;
+	int32_t timer_coalesce_fp_shift;
+	int32_t timer_coalesce_ts_shift;
+
+	uint64_t timer_coalesce_rt_abstime_max;
+	uint64_t timer_coalesce_bg_abstime_max;
+	uint64_t timer_coalesce_kt_abstime_max;
+	uint64_t timer_coalesce_fp_abstime_max;
+	uint64_t timer_coalesce_ts_abstime_max;
+
+	uint32_t latency_qos_scale[NUM_LATENCY_QOS_TIERS];
+	uint64_t latency_qos_abstime_max[NUM_LATENCY_QOS_TIERS];
+	boolean_t latency_tier_rate_limited[NUM_LATENCY_QOS_TIERS];
+} timer_coalescing_priority_params_t;
+extern timer_coalescing_priority_params_t tcoal_prio_params;
 
-#endif /* MACH_KERNEL_PRIVATE */
+#endif /* XNU_KERNEL_PRIVATE */
 
 #endif /* _KERN_TIMER_CALL_H_ */