1*fdd8201dSApple OSS Distributions #ifndef MEMORYSTATUS_ASSERTION_HELPERS_H 2*fdd8201dSApple OSS Distributions #define MEMORYSTATUS_ASSERTION_HELPERS_H 3*fdd8201dSApple OSS Distributions 4*fdd8201dSApple OSS Distributions #include <stdlib.h> 5*fdd8201dSApple OSS Distributions #include <stdint.h> 6*fdd8201dSApple OSS Distributions 7*fdd8201dSApple OSS Distributions #define ASSERTION_STATE_IS_SET true 8*fdd8201dSApple OSS Distributions #define ASSERTION_STATE_IS_RELINQUISHED false 9*fdd8201dSApple OSS Distributions 10*fdd8201dSApple OSS Distributions /* Helper functions for setting and checking memorystatus assertions 11*fdd8201dSApple OSS Distributions * on processes. 12*fdd8201dSApple OSS Distributions */ 13*fdd8201dSApple OSS Distributions 14*fdd8201dSApple OSS Distributions /* 15*fdd8201dSApple OSS Distributions * Set the jetsam priority and user data for a process. 16*fdd8201dSApple OSS Distributions * 17*fdd8201dSApple OSS Distributions * If this request is assertion driven, the kernel will 18*fdd8201dSApple OSS Distributions * set the process's assertion priority. 19*fdd8201dSApple OSS Distributions * 20*fdd8201dSApple OSS Distributions * If this request is not assertion driven, the kernel 21*fdd8201dSApple OSS Distributions * will set the process's requested priority. 22*fdd8201dSApple OSS Distributions * 23*fdd8201dSApple OSS Distributions * The kernel will then apply policy and move the process 24*fdd8201dSApple OSS Distributions * to the appropriate jetsam priority. 25*fdd8201dSApple OSS Distributions * 26*fdd8201dSApple OSS Distributions * Returns: 0 on success 27*fdd8201dSApple OSS Distributions * non-0 on failure 28*fdd8201dSApple OSS Distributions */ 29*fdd8201dSApple OSS Distributions int 30*fdd8201dSApple OSS Distributions set_priority(pid_t pid, int32_t priority, uint64_t user_data, boolean_t is_assertion_driven); 31*fdd8201dSApple OSS Distributions 32*fdd8201dSApple OSS Distributions /* 33*fdd8201dSApple OSS Distributions * Return: true on success 34*fdd8201dSApple OSS Distributions * false on failure --> this asserts a failure and quits test 35*fdd8201dSApple OSS Distributions */ 36*fdd8201dSApple OSS Distributions boolean_t 37*fdd8201dSApple OSS Distributions check_properties(pid_t pid, int32_t expected_priority, int32_t expected_limit_mb, uint64_t expected_user_data, boolean_t expected_assertion_state, const char *test); 38*fdd8201dSApple OSS Distributions 39*fdd8201dSApple OSS Distributions /* 40*fdd8201dSApple OSS Distributions * Set the active and inactive memlimits for a process. 41*fdd8201dSApple OSS Distributions * Set the fatalness for each limit. 42*fdd8201dSApple OSS Distributions * 43*fdd8201dSApple OSS Distributions * Returns: 0 on success 44*fdd8201dSApple OSS Distributions * non-zero on failure 45*fdd8201dSApple OSS Distributions */ 46*fdd8201dSApple OSS Distributions int 47*fdd8201dSApple OSS Distributions set_memlimits( 48*fdd8201dSApple OSS Distributions pid_t pid, 49*fdd8201dSApple OSS Distributions int32_t active_limit_mb, int32_t inactive_limit_mb, 50*fdd8201dSApple OSS Distributions boolean_t active_is_fatal, boolean_t inactive_is_fatal); 51*fdd8201dSApple OSS Distributions 52*fdd8201dSApple OSS Distributions /* 53*fdd8201dSApple OSS Distributions * Returns: 0 on success 54*fdd8201dSApple OSS Distributions * non-0 on failure 55*fdd8201dSApple OSS Distributions */ 56*fdd8201dSApple OSS Distributions int 57*fdd8201dSApple OSS Distributions set_assertion_priority(pid_t pid, int32_t priority, uint64_t user_data); 58*fdd8201dSApple OSS Distributions 59*fdd8201dSApple OSS Distributions /* 60*fdd8201dSApple OSS Distributions * Returns: 0 on success 61*fdd8201dSApple OSS Distributions * non-0 on failure 62*fdd8201dSApple OSS Distributions */ 63*fdd8201dSApple OSS Distributions int 64*fdd8201dSApple OSS Distributions relinquish_assertion_priority(pid_t pid, uint64_t user_data); 65*fdd8201dSApple OSS Distributions 66*fdd8201dSApple OSS Distributions /* 67*fdd8201dSApple OSS Distributions * Get the priority properties for a single process. 68*fdd8201dSApple OSS Distributions * 69*fdd8201dSApple OSS Distributions * This returns the process's effective jetsam priority, jetsam limit, 70*fdd8201dSApple OSS Distributions * user_data (not kernel related), and proc's kernel state. 71*fdd8201dSApple OSS Distributions * If this call fails, there is no reason to continue the test. 72*fdd8201dSApple OSS Distributions * 73*fdd8201dSApple OSS Distributions * Return: true on success 74*fdd8201dSApple OSS Distributions * false on failure --> this asserts fail and test quits 75*fdd8201dSApple OSS Distributions */ 76*fdd8201dSApple OSS Distributions boolean_t 77*fdd8201dSApple OSS Distributions get_priority_props(pid_t pid, boolean_t verbose, int32_t *priority, int32_t *limit_mb, uint64_t *user_data, uint32_t *state); 78*fdd8201dSApple OSS Distributions 79*fdd8201dSApple OSS Distributions /* 80*fdd8201dSApple OSS Distributions * Input: 81*fdd8201dSApple OSS Distributions * state: kernel state bits from the get_priority_props() call 82*fdd8201dSApple OSS Distributions * expected_assertion_state: 83*fdd8201dSApple OSS Distributions * true if process should be holding an assertion state. 84*fdd8201dSApple OSS Distributions * false if no assertion state is held (eg: relinquished). 85*fdd8201dSApple OSS Distributions * 86*fdd8201dSApple OSS Distributions * Return true: verification passed 87*fdd8201dSApple OSS Distributions * false: verification failed 88*fdd8201dSApple OSS Distributions */ 89*fdd8201dSApple OSS Distributions boolean_t 90*fdd8201dSApple OSS Distributions verify_assertion_state(uint32_t state, boolean_t expected_assertion_state); 91*fdd8201dSApple OSS Distributions 92*fdd8201dSApple OSS Distributions #endif /* MEMORYSTATUS_ASSERTION_HELPERS_H */ 93