1/* 2 * Copyright (c) 2000-2012 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 * @OSF_COPYRIGHT@ 30 */ 31/* 32 * Mach Operating System 33 * Copyright (c) 1991,1990,1989 Carnegie Mellon University 34 * All Rights Reserved. 35 * 36 * Permission to use, copy, modify and distribute this software and its 37 * documentation is hereby granted, provided that both the copyright 38 * notice and this permission notice appear in all copies of the 39 * software, derivative works or modified versions, and any portions 40 * thereof, and that both notices appear in supporting documentation. 41 * 42 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" 43 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR 44 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE. 45 * 46 * Carnegie Mellon requests users of this software to return to 47 * 48 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU 49 * School of Computer Science 50 * Carnegie Mellon University 51 * Pittsburgh PA 15213-3890 52 * 53 * any improvements or extensions that they make and grant Carnegie Mellon 54 * the rights to redistribute these changes. 55 */ 56/* 57 */ 58 59/* 60 * kern/ast.h: Definitions for Asynchronous System Traps. 61 */ 62 63#ifndef _KERN_AST_H_ 64#define _KERN_AST_H_ 65 66#include <platforms.h> 67 68#include <kern/assert.h> 69#include <kern/macro_help.h> 70#include <kern/lock.h> 71#include <kern/spl.h> 72#include <machine/ast.h> 73 74/* 75 * A processor takes an AST when it is about to return from an 76 * interrupt context, and calls ast_taken. 77 * 78 * Machine-dependent code is responsible for maintaining 79 * a set of reasons for an AST, and passing this set to ast_taken. 80 */ 81typedef uint32_t ast_t; 82 83/* 84 * Bits for reasons 85 */ 86#define AST_PREEMPT 0x01 87#define AST_QUANTUM 0x02 88#define AST_URGENT 0x04 89#define AST_HANDOFF 0x08 90#define AST_YIELD 0x10 91#define AST_APC 0x20 /* migration APC hook */ 92#define AST_LEDGER 0x40 93 94/* 95 * JMM - This is here temporarily. AST_BSD is used to simulate a 96 * general purpose mechanism for setting asynchronous procedure calls 97 * from the outside. 98 */ 99#define AST_BSD 0x80 100#define AST_KPERF 0x100 /* kernel profiling */ 101#define AST_MACF 0x200 /* MACF user ret pending */ 102#define AST_CHUD 0x400 103#define AST_CHUD_URGENT 0x800 104#define AST_GUARD 0x1000 105#define AST_TELEMETRY_USER 0x2000 106#define AST_TELEMETRY_KERNEL 0x4000 107 108#define AST_NONE 0x00 109#define AST_ALL (~AST_NONE) 110 111#define AST_SCHEDULING (AST_PREEMPTION | AST_YIELD | AST_HANDOFF) 112#define AST_PREEMPTION (AST_PREEMPT | AST_QUANTUM | AST_URGENT) 113 114#define AST_CHUD_ALL (AST_CHUD_URGENT|AST_CHUD) 115#define AST_TELEMETRY_ALL (AST_TELEMETRY_USER | AST_TELEMETRY_KERNEL) 116 117#ifdef MACHINE_AST 118/* 119 * machine/ast.h is responsible for defining aston and astoff. 120 */ 121#else /* MACHINE_AST */ 122 123#define aston(mycpu) 124#define astoff(mycpu) 125 126#endif /* MACHINE_AST */ 127 128/* Initialize module */ 129extern void ast_init(void); 130 131/* Handle ASTs */ 132extern void ast_taken( 133 ast_t mask, 134 boolean_t enable); 135 136/* Check for pending ASTs */ 137extern void ast_check( 138 processor_t processor); 139 140/* Pending ast mask for the current processor */ 141extern ast_t *ast_pending(void); 142 143/* 144 * Per-thread ASTs are reset at context-switch time. 145 */ 146#ifndef MACHINE_AST_PER_THREAD 147#define MACHINE_AST_PER_THREAD 0 148#endif 149 150#define AST_PER_THREAD (AST_APC | AST_BSD | AST_MACF | MACHINE_AST_PER_THREAD | AST_LEDGER | AST_GUARD | AST_TELEMETRY_USER | AST_TELEMETRY_KERNEL) 151/* 152 * ast_pending(), ast_on(), ast_off(), ast_context(), and ast_propagate() 153 * assume splsched. 154 */ 155 156#define ast_on_fast(reasons) \ 157MACRO_BEGIN \ 158 ast_t *_ast_myast = ast_pending(); \ 159 \ 160 if ((*_ast_myast |= (reasons)) != AST_NONE) \ 161 { aston(_ast_myast); } \ 162MACRO_END 163 164#define ast_off_fast(reasons) \ 165MACRO_BEGIN \ 166 ast_t *_ast_myast = ast_pending(); \ 167 \ 168 if ((*_ast_myast &= ~(reasons)) == AST_NONE) \ 169 { astoff(_ast_myast); } \ 170MACRO_END 171 172#define ast_propagate(reasons) ast_on(reasons) 173 174#define ast_context(act) \ 175MACRO_BEGIN \ 176 ast_t *myast = ast_pending(); \ 177 \ 178 if ((*myast = ((*myast &~ AST_PER_THREAD) | (act)->ast)) != AST_NONE) \ 179 { aston(myast); } \ 180 else \ 181 { astoff(myast); } \ 182MACRO_END 183 184#define ast_on(reason) ast_on_fast(reason) 185#define ast_off(reason) ast_off_fast(reason) 186 187/* 188 * NOTE: if thread is the current thread, thread_ast_set() should 189 * be followed by ast_propagate(). 190 */ 191#define thread_ast_set(act, reason) \ 192 (hw_atomic_or_noret(&(act)->ast, (reason))) 193#define thread_ast_clear(act, reason) \ 194 (hw_atomic_and_noret(&(act)->ast, ~(reason))) 195#define thread_ast_clear_all(act) \ 196 (hw_atomic_and_noret(&(act)->ast, AST_NONE)) 197 198#ifdef MACH_BSD 199 200extern void astbsd_on(void); 201extern void act_set_astbsd(thread_t); 202extern void bsd_ast(thread_t); 203 204#endif /* MACH_BSD */ 205 206#endif /* _KERN_AST_H_ */ 207