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