1*43a90889SApple OSS Distributions /* 2*43a90889SApple OSS Distributions * Copyright (c) 2013 Apple Inc. All rights reserved. 3*43a90889SApple OSS Distributions * 4*43a90889SApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5*43a90889SApple OSS Distributions * 6*43a90889SApple OSS Distributions * This file contains Original Code and/or Modifications of Original Code 7*43a90889SApple OSS Distributions * as defined in and that are subject to the Apple Public Source License 8*43a90889SApple OSS Distributions * Version 2.0 (the 'License'). You may not use this file except in 9*43a90889SApple OSS Distributions * compliance with the License. The rights granted to you under the License 10*43a90889SApple OSS Distributions * may not be used to create, or enable the creation or redistribution of, 11*43a90889SApple OSS Distributions * unlawful or unlicensed copies of an Apple operating system, or to 12*43a90889SApple OSS Distributions * circumvent, violate, or enable the circumvention or violation of, any 13*43a90889SApple OSS Distributions * terms of an Apple operating system software license agreement. 14*43a90889SApple OSS Distributions * 15*43a90889SApple OSS Distributions * Please obtain a copy of the License at 16*43a90889SApple OSS Distributions * http://www.opensource.apple.com/apsl/ and read it before using this file. 17*43a90889SApple OSS Distributions * 18*43a90889SApple OSS Distributions * The Original Code and all software distributed under the License are 19*43a90889SApple OSS Distributions * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20*43a90889SApple OSS Distributions * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21*43a90889SApple OSS Distributions * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22*43a90889SApple OSS Distributions * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23*43a90889SApple OSS Distributions * Please see the License for the specific language governing rights and 24*43a90889SApple OSS Distributions * limitations under the License. 25*43a90889SApple OSS Distributions * 26*43a90889SApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27*43a90889SApple OSS Distributions */ 28*43a90889SApple OSS Distributions 29*43a90889SApple OSS Distributions #ifndef _SYS_SFI_H_ 30*43a90889SApple OSS Distributions #define _SYS_SFI_H_ 31*43a90889SApple OSS Distributions 32*43a90889SApple OSS Distributions #include <stdint.h> 33*43a90889SApple OSS Distributions #include <sys/types.h> 34*43a90889SApple OSS Distributions #include <mach/sfi_class.h> 35*43a90889SApple OSS Distributions /* 36*43a90889SApple OSS Distributions * Selective Forced Idle (SFI) is a mechanism for doing 37*43a90889SApple OSS Distributions * phase-aligned modulation of runnable tasks 38*43a90889SApple OSS Distributions */ 39*43a90889SApple OSS Distributions 40*43a90889SApple OSS Distributions /* Flags for use with sfi_process_set_flags() */ 41*43a90889SApple OSS Distributions #define SFI_PROCESS_SET_MANAGED 0x00000001 42*43a90889SApple OSS Distributions #define SFI_PROCESS_SET_UNMANAGED 0x00000002 43*43a90889SApple OSS Distributions 44*43a90889SApple OSS Distributions #define SFI_PROCESS_SET_MANAGED_MASK 0x00000003 45*43a90889SApple OSS Distributions 46*43a90889SApple OSS Distributions #ifndef KERNEL 47*43a90889SApple OSS Distributions /* 48*43a90889SApple OSS Distributions * The system_set_sfi_window() call can be used to set "Selective 49*43a90889SApple OSS Distributions * Forced Idle" window for the system. sfi_window_usec is the 50*43a90889SApple OSS Distributions * interval in microseconds and when the "Selective Forced Idle" is 51*43a90889SApple OSS Distributions * active its "off phase" starts every sfi_window_usec. A nonzero 52*43a90889SApple OSS Distributions * value lower than MIN_SFI_WINDOW_USEC will be automatically changed 53*43a90889SApple OSS Distributions * to MIN_SFI_WINDOW_USEC. The actual window size used is 54*43a90889SApple OSS Distributions * implementation dependent and may be longer. 55*43a90889SApple OSS Distributions * 56*43a90889SApple OSS Distributions * system_get_sfi_window() can be used to determine the actual value. 57*43a90889SApple OSS Distributions * 58*43a90889SApple OSS Distributions * A value of 0 for sfi_window_usec can be used to disable "Selective 59*43a90889SApple OSS Distributions * Forced Idle". 60*43a90889SApple OSS Distributions */ 61*43a90889SApple OSS Distributions int system_set_sfi_window(uint64_t sfi_window_usec); 62*43a90889SApple OSS Distributions 63*43a90889SApple OSS Distributions int system_get_sfi_window(uint64_t *sfi_window_usec); 64*43a90889SApple OSS Distributions 65*43a90889SApple OSS Distributions /* 66*43a90889SApple OSS Distributions * sfi_set_class_offtime() can be used to set the "off time" interval 67*43a90889SApple OSS Distributions * for all threads placed in a "Selective Forced Idle" class class_id. 68*43a90889SApple OSS Distributions * A thread placed in class_id will not execute for offtime_usec 69*43a90889SApple OSS Distributions * microseconds at the beginning of each "Selective Forced Idle" 70*43a90889SApple OSS Distributions * window. A nonzero value lower than MIN_OFFTIME_USEC will be 71*43a90889SApple OSS Distributions * automatically changed to MIN_OFFTIME_USEC. The actual "off time" 72*43a90889SApple OSS Distributions * used is implementation dependent and may be 73*43a90889SApple OSS Distributions * longer. sfi_get_class_offtime() can be used to determine the actual 74*43a90889SApple OSS Distributions * value. 75*43a90889SApple OSS Distributions * 76*43a90889SApple OSS Distributions * A value of 0 for offtime_usec can be used to disable "Selective 77*43a90889SApple OSS Distributions * Forced Idle" for all the threads placed in class_id. 78*43a90889SApple OSS Distributions * 79*43a90889SApple OSS Distributions * A value of offtime_usec greater than the value of system wide 80*43a90889SApple OSS Distributions * "Selective Forced Idle" window will cause failure. 81*43a90889SApple OSS Distributions */ 82*43a90889SApple OSS Distributions int sfi_set_class_offtime(sfi_class_id_t class_id, uint64_t offtime_usec); 83*43a90889SApple OSS Distributions 84*43a90889SApple OSS Distributions int sfi_get_class_offtime(sfi_class_id_t class_id, uint64_t *offtime_usec); 85*43a90889SApple OSS Distributions 86*43a90889SApple OSS Distributions /* 87*43a90889SApple OSS Distributions * The sfi_process_set_class() can be used to place all the threads in 88*43a90889SApple OSS Distributions * a process ID pid in the "Selective Forced Idle" managed class, or clear 89*43a90889SApple OSS Distributions * the managed state. 90*43a90889SApple OSS Distributions */ 91*43a90889SApple OSS Distributions 92*43a90889SApple OSS Distributions int sfi_process_set_flags(pid_t pid, uint32_t flags); 93*43a90889SApple OSS Distributions 94*43a90889SApple OSS Distributions int sfi_process_get_flags(pid_t pid, uint32_t *flags); 95*43a90889SApple OSS Distributions 96*43a90889SApple OSS Distributions #endif /* !KERNEL */ 97*43a90889SApple OSS Distributions 98*43a90889SApple OSS Distributions #if PRIVATE 99*43a90889SApple OSS Distributions 100*43a90889SApple OSS Distributions /* This is the private system call interface between Libsyscall and xnu */ 101*43a90889SApple OSS Distributions #define SFI_CTL_OPERATION_SFI_SET_WINDOW 0x00000001 102*43a90889SApple OSS Distributions #define SFI_CTL_OPERATION_SFI_GET_WINDOW 0x00000002 103*43a90889SApple OSS Distributions #define SFI_CTL_OPERATION_SET_CLASS_OFFTIME 0x00000003 104*43a90889SApple OSS Distributions #define SFI_CTL_OPERATION_GET_CLASS_OFFTIME 0x00000004 105*43a90889SApple OSS Distributions 106*43a90889SApple OSS Distributions #define SFI_PIDCTL_OPERATION_PID_SET_FLAGS 0x00000001 107*43a90889SApple OSS Distributions #define SFI_PIDCTL_OPERATION_PID_GET_FLAGS 0x00000002 108*43a90889SApple OSS Distributions 109*43a90889SApple OSS Distributions int __sfi_ctl(uint32_t operation, uint32_t sfi_class, uint64_t time, uint64_t *out_time); 110*43a90889SApple OSS Distributions int __sfi_pidctl(uint32_t operation, pid_t pid, uint32_t sfi_flags, uint32_t *out_sfi_flags); 111*43a90889SApple OSS Distributions 112*43a90889SApple OSS Distributions #endif /* PRIVATE */ 113*43a90889SApple OSS Distributions 114*43a90889SApple OSS Distributions #endif /* _SYS_SFI_H_ */ 115