xnu-2782.1.97.tar.gz

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

diff --git a/osfmk/kern/ast.h b/osfmk/kern/ast.h
index b6f42e4ec36da25ff3e2d4df830d0a133a3dd1a4..28886bb2e97a09e56165bae851ab69c413704f36 100644 (file)
--- a/osfmk/kern/ast.h
+++ b/osfmk/kern/ast.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2012 Apple Computer, Inc. All rights reserved.
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 
@@ -63,11 +63,9 @@
 #ifndef _KERN_AST_H_
 #define _KERN_AST_H_
 
-#include <platforms.h>
 
 #include <kern/assert.h>
 #include <kern/macro_help.h>
-#include <kern/lock.h>
 #include <kern/spl.h>
 #include <machine/ast.h>
 
@@ -80,6 +78,29 @@
  */
 typedef uint32_t               ast_t;
 
+/*
+ * When returning from interrupt/trap context to kernel mode,
+ * the pending ASTs are masked with AST_URGENT to determine if
+ * ast_taken(AST_PREEMPTION) should be called, for instance to
+ * effect preemption of a kernel thread by a realtime thread.
+ * This is also done when re-enabling preemption or re-enabling
+ * interrupts, since an AST may have been set while preemption
+ * was disabled, and it should take effect as soon as possible.
+ *
+ * When returning from interrupt/trap/syscall context to user
+ * mode, any and all ASTs that are pending should be handled.
+ *
+ * If a thread context switches, only ASTs not in AST_PER_THREAD
+ * remain active. The per-thread ASTs are stored in the thread_t
+ * and re-enabled when the thread context switches back.
+ *
+ * Typically the preemption ASTs are set as a result of threads
+ * becoming runnable, threads changing priority, or quantum
+ * expiration. If a thread becomes runnable and is chosen
+ * to run on another processor, cause_ast_check() may be called
+ * to IPI that processor and request csw_check() be run there.
+ */
+
 /*
  *      Bits for reasons
  */
@@ -89,12 +110,24 @@ typedef uint32_t           ast_t;
 #define AST_HANDOFF            0x08
 #define AST_YIELD              0x10
 #define AST_APC                        0x20    /* migration APC hook */
+#define AST_LEDGER             0x40
+
 /*
  * JMM - This is here temporarily. AST_BSD is used to simulate a
  * general purpose mechanism for setting asynchronous procedure calls
  * from the outside.
  */
 #define AST_BSD                        0x80
+#define AST_KPERF              0x100   /* kernel profiling */
+#define        AST_MACF                0x200   /* MACF user ret pending */
+#define AST_CHUD               0x400 
+#define AST_CHUD_URGENT                0x800
+#define AST_GUARD              0x1000
+#define AST_TELEMETRY_USER     0x2000  /* telemetry sample requested on interrupt from userspace */
+#define AST_TELEMETRY_KERNEL   0x4000  /* telemetry sample requested on interrupt from kernel */
+#define AST_TELEMETRY_WINDOWED 0x8000  /* telemetry sample meant for the window buffer */
+
+#define AST_SFI                        0x10000 /* Evaluate if SFI wait is needed before return to userspace */
 
 #define AST_NONE               0x00
 #define AST_ALL                        (~AST_NONE)
@@ -102,6 +135,9 @@ typedef uint32_t            ast_t;
 #define AST_SCHEDULING (AST_PREEMPTION | AST_YIELD | AST_HANDOFF)
 #define AST_PREEMPTION (AST_PREEMPT | AST_QUANTUM | AST_URGENT)
 
+#define AST_CHUD_ALL   (AST_CHUD_URGENT|AST_CHUD)
+#define AST_TELEMETRY_ALL      (AST_TELEMETRY_USER | AST_TELEMETRY_KERNEL | AST_TELEMETRY_WINDOWED)
+
 #ifdef  MACHINE_AST
 /*
  *      machine/ast.h is responsible for defining aston and astoff.
@@ -113,11 +149,6 @@ typedef uint32_t           ast_t;
 
 #endif  /* MACHINE_AST */
 
-#define AST_CHUD_URGENT     0x800
-#define AST_CHUD            0x400
-
-#define AST_CHUD_ALL        (AST_CHUD_URGENT|AST_CHUD)
-
 /* Initialize module */
 extern void            ast_init(void);
 
@@ -140,7 +171,7 @@ extern ast_t        *ast_pending(void);
 #define MACHINE_AST_PER_THREAD  0
 #endif
 
-#define AST_PER_THREAD (AST_APC | AST_BSD | MACHINE_AST_PER_THREAD)
+#define AST_PER_THREAD (AST_APC | AST_BSD | AST_MACF | MACHINE_AST_PER_THREAD | AST_LEDGER | AST_GUARD | AST_TELEMETRY_USER | AST_TELEMETRY_KERNEL | AST_TELEMETRY_WINDOWED)
 /*
  *     ast_pending(), ast_on(), ast_off(), ast_context(), and ast_propagate()
  *     assume splsched.
@@ -148,18 +179,18 @@ extern ast_t      *ast_pending(void);
 
 #define ast_on_fast(reasons)                                   \
 MACRO_BEGIN                                                                            \
-       ast_t   *myast = ast_pending();                         \
+       ast_t   *_ast_myast = ast_pending();            \
                                                                                                \
-       if ((*myast |= (reasons)) != AST_NONE)          \
-               { aston(myast); }                                               \
+       if ((*_ast_myast |= (reasons)) != AST_NONE)     \
+               { aston(_ast_myast); }                                  \
 MACRO_END
 
 #define ast_off_fast(reasons)                                  \
 MACRO_BEGIN                                                                            \
-       ast_t   *myast = ast_pending();                         \
+       ast_t   *_ast_myast = ast_pending();            \
                                                                                                \
-       if ((*myast &= ~(reasons)) == AST_NONE)         \
-               { astoff(myast); }                                              \
+       if ((*_ast_myast &= ~(reasons)) == AST_NONE) \
+               { astoff(_ast_myast); }                                 \
 MACRO_END
 
 #define ast_propagate(reasons)         ast_on(reasons)