1 /* 2 * Copyright (c) 2010-2018 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 #ifndef _KERN_LEDGER_H_ 33 #define _KERN_LEDGER_H_ 34 35 #include <mach/mach_types.h> /* ledger_t */ 36 37 #ifdef MACH_KERNEL_PRIVATE 38 #include <os/refcnt.h> 39 #include <kern/counter.h> 40 #endif /* MACH_KERNEL_PRIVATE */ 41 42 #define LEDGER_INFO 0 43 #define LEDGER_ENTRY_INFO 1 44 #define LEDGER_TEMPLATE_INFO 2 45 #define LEDGER_LIMIT 3 46 #define LEDGER_ENTRY_INFO_V2 4 47 /* LEDGER_MAX_CMD always tracks the index of the last ledger command. */ 48 #define LEDGER_MAX_CMD LEDGER_ENTRY_INFO_V2 49 50 #define LEDGER_NAME_MAX 32 51 52 struct ledger_info { 53 char li_name[LEDGER_NAME_MAX]; 54 int64_t li_id; 55 int64_t li_entries; 56 }; 57 58 struct ledger_template_info { 59 char lti_name[LEDGER_NAME_MAX]; 60 char lti_group[LEDGER_NAME_MAX]; 61 char lti_units[LEDGER_NAME_MAX]; 62 }; 63 64 #ifdef MACH_KERNEL_PRIVATE 65 /* 66 * The explicit alignment is to ensure that atomic operations don't panic 67 * on ARM. 68 */ 69 struct ledger_entry { 70 volatile uint32_t le_flags; 71 #define LEDGER_PERCENT_NONE UINT16_MAX 72 #define LEDGER_DIAG_MEM_THRESHOLD_INFINITY ((int16_t)((1ULL << 16) - 1)) 73 74 uint16_t le_warn_percent; 75 int16_t le_diag_threshold_scaled; /* Diag mem threshold for this entry, handled in Mbytes */ 76 ledger_amount_t le_limit; 77 volatile ledger_amount_t le_credit __attribute__((aligned(8))); 78 volatile ledger_amount_t le_debit __attribute__((aligned(8))); 79 union { 80 struct { 81 /* 82 * XXX - the following two fields can go away if we move all of 83 * the refill logic into process policy 84 */ 85 uint64_t le_refill_period; 86 uint64_t le_last_refill; 87 } le_refill; 88 struct { 89 ledger_amount_t le_lifetime_max; /* Process lifetime peak */ 90 #if CONFIG_LEDGER_INTERVAL_MAX 91 ledger_amount_t le_interval_max; /* Interval peak XXX better name needed */ 92 #endif 93 } _le_max; 94 } _le; 95 } __attribute__((aligned(8))); 96 97 /* 98 * Many ledger entries just need to track an amount 99 * and have a few flags (panic on negative, active / inactive, etc...). 100 * Those entries use this struct to save memory. 101 */ 102 struct ledger_entry_small { 103 volatile uint32_t les_flags; 104 volatile ledger_amount_t les_credit __attribute__((aligned(8))); 105 } __attribute__((aligned(8))); 106 107 /* 108 * Some ledger entries would benefit from the use of a scalable counter 109 * and don't care about limits - those entries use this struct. 110 */ 111 struct ledger_entry_counter { 112 volatile uint32_t lec_flags; 113 counter_t lec_counter __attribute__((aligned(8))); 114 } __attribute__((aligned(8))); 115 116 struct ledger { 117 uint64_t l_id; 118 os_refcnt_t l_refs; 119 int32_t l_size; 120 struct ledger_template * l_template; 121 struct ledger_entry_small l_entries[] __attribute__((aligned(8))); 122 }; 123 #endif /* MACH_KERNEL_PRIVATE */ 124 125 struct ledger_entry_info { 126 int64_t lei_balance; 127 int64_t lei_credit; 128 int64_t lei_debit; 129 uint64_t lei_limit; 130 uint64_t lei_refill_period; /* In nanoseconds */ 131 uint64_t lei_last_refill; /* Time since last refill */ 132 }; 133 134 struct ledger_entry_info_v2 { 135 int64_t lei_balance; 136 int64_t lei_credit; 137 int64_t lei_debit; 138 uint64_t lei_limit; 139 uint64_t lei_refill_period; /* In nanoseconds */ 140 uint64_t lei_last_refill; /* Time since last refill */ 141 int64_t lei_lifetime_max; /* for phys_footprint/neural_nofootprint_lifetime_max */ 142 uint64_t lei_reserved[4]; 143 }; 144 145 struct ledger_limit_args { 146 char lla_name[LEDGER_NAME_MAX]; 147 uint64_t lla_limit; 148 uint64_t lla_refill_period; 149 }; 150 151 #ifdef KERNEL_PRIVATE 152 153 typedef struct ledger_template *ledger_template_t; 154 155 #define LEDGER_VALID(ledger) (ledger != LEDGER_NULL) 156 157 /* Action to take when a ledger goes into deficit */ 158 #define LEDGER_ACTION_IGNORE 0x0000 159 #define LEDGER_ACTION_BLOCK 0x0010 160 #define LEDGER_ACTION_CALLBACK 0x0020 161 #define LEDGER_ACTION_MASK 0x00f0 162 163 /* 164 * Types of warnings that trigger a callback. 165 */ 166 #define LEDGER_WARNING_ROSE_ABOVE 1 167 #define LEDGER_WARNING_DIPPED_BELOW 2 168 #define LEDGER_WARNING_DIAG_MEM_THRESHOLD 3 169 170 typedef void (*ledger_callback_t)(int warning, const void * param0, const void *param1); 171 172 extern ledger_template_t ledger_template_create(const char *name); 173 extern ledger_template_t ledger_template_copy(ledger_template_t template, const char *name); 174 extern void ledger_template_dereference(ledger_template_t template); 175 /* 176 * DEPRECATED. Use ledger_entry_add_with_flags instead. 177 */ 178 extern int ledger_entry_add(ledger_template_t template, const char *key, 179 const char *group, const char *units); 180 extern kern_return_t ledger_set_callback(ledger_template_t template, int entry, 181 ledger_callback_t callback, const void *param0, const void *param1); 182 extern kern_return_t ledger_track_maximum(ledger_template_t template, int entry, 183 int period_in_secs); 184 extern kern_return_t ledger_panic_on_negative(ledger_template_t template, 185 int entry); 186 extern kern_return_t ledger_track_credit_only(ledger_template_t template, 187 int entry); 188 extern int ledger_key_lookup(ledger_template_t template, const char *key); 189 190 /* 191 * Supported ledger features. 192 * Passed in as a bitwise OR to ledger_entry_add_with_flags 193 */ 194 __options_decl(ledger_entry_flags, uint64_t, { 195 LEDGER_ENTRY_ALLOW_CALLBACK = 0x1, 196 LEDGER_ENTRY_ALLOW_MAXIMUM = 0x2, 197 LEDGER_ENTRY_ALLOW_PANIC_ON_NEGATIVE = 0x4, 198 LEDGER_ENTRY_ALLOW_DEBIT = 0x8, 199 LEDGER_ENTRY_ALLOW_LIMIT = 0x10, 200 LEDGER_ENTRY_ALLOW_ACTION = 0x20, 201 LEDGER_ENTRY_ALLOW_INACTIVE = 0x40, 202 LEDGER_ENTRY_USE_COUNTER = 0x80, 203 }); 204 205 /* 206 * Create a new ledger entry that only supports the feature set passed in via 207 * flags. 208 * 209 * This is the recommended way to create new ledger entries, as it allows 210 * the ledger code to allocate less memory for simpler entries. 211 * ledger_entry_add is kept for backwards compatibility. 212 * 213 * See below for the set of valid flags. 214 */ 215 extern int ledger_entry_add_with_flags(ledger_template_t template, const char *key, 216 const char *group, const char *units, ledger_entry_flags flags); 217 218 /* value of entry type */ 219 #define LEDGER_CREATE_ACTIVE_ENTRIES 0 220 #define LEDGER_CREATE_INACTIVE_ENTRIES 1 221 extern ledger_t ledger_instantiate(ledger_template_t template, int entry_type); 222 extern void ledger_template_complete(ledger_template_t template); 223 extern void ledger_template_complete_secure_alloc(ledger_template_t template); 224 extern kern_return_t ledger_disable_callback(ledger_t ledger, int entry); 225 extern kern_return_t ledger_enable_callback(ledger_t ledger, int entry); 226 extern kern_return_t ledger_get_limit(ledger_t ledger, int entry, 227 ledger_amount_t *limit); 228 extern kern_return_t ledger_set_limit(ledger_t ledger, int entry, 229 ledger_amount_t limit, uint8_t warn_level_percentage); 230 #if CONFIG_LEDGER_INTERVAL_MAX 231 extern kern_return_t ledger_get_interval_max(ledger_t ledger, int entry, 232 ledger_amount_t *max_interval_balance, int reset); 233 #endif /* CONFIG_LEDGER_INTERVAL_MAX */ 234 extern kern_return_t ledger_get_lifetime_max(ledger_t ledger, int entry, 235 ledger_amount_t *max_lifetime_balance); 236 extern kern_return_t ledger_get_actions(ledger_t ledger, int entry, int *actions); 237 extern kern_return_t ledger_set_action(ledger_t ledger, int entry, int action); 238 extern kern_return_t ledger_get_period(ledger_t ledger, int entry, 239 uint64_t *period); 240 extern kern_return_t ledger_set_period(ledger_t ledger, int entry, 241 uint64_t period); 242 extern kern_return_t ledger_disable_refill(ledger_t l, int entry); 243 extern kern_return_t ledger_entry_setactive(ledger_t ledger, int entry); 244 extern void ledger_check_new_balance(thread_t thread, ledger_t ledger, int entry); 245 extern kern_return_t ledger_credit(ledger_t ledger, int entry, 246 ledger_amount_t amount); 247 extern kern_return_t ledger_credit_nocheck(ledger_t ledger, int entry, 248 ledger_amount_t amount); 249 extern kern_return_t ledger_debit(ledger_t ledger, int entry, 250 ledger_amount_t amount); 251 extern kern_return_t ledger_debit_nocheck(ledger_t ledger, int entry, 252 ledger_amount_t amount); 253 extern kern_return_t ledger_credit_thread(thread_t thread, ledger_t ledger, 254 int entry, ledger_amount_t amount); 255 extern kern_return_t ledger_debit_thread(thread_t thread, ledger_t ledger, 256 int entry, ledger_amount_t amount); 257 extern kern_return_t ledger_zero_balance(ledger_t ledger, int entry); 258 extern kern_return_t ledger_get_entries(ledger_t ledger, int entry, 259 ledger_amount_t *credit, ledger_amount_t *debit); 260 extern kern_return_t ledger_get_balance(ledger_t ledger, int entry, 261 ledger_amount_t *balance); 262 extern kern_return_t ledger_reset_callback_state(ledger_t ledger, int entry); 263 extern kern_return_t ledger_disable_panic_on_negative(ledger_t ledger, int entry); 264 extern kern_return_t ledger_get_panic_on_negative(ledger_t ledger, int entry, int *panic_on_negative); 265 266 extern kern_return_t ledger_rollup(ledger_t to_ledger, ledger_t from_ledger); 267 extern kern_return_t ledger_rollup_entry(ledger_t to_ledger, ledger_t from_ledger, int entry); 268 269 extern void ledger_ast(thread_t thread); 270 271 extern void ledger_reference(ledger_t ledger); 272 extern void ledger_dereference(ledger_t ledger); 273 274 extern ledger_amount_t ledger_get_remaining(ledger_t ledger, int entry); 275 extern void ledger_restart(ledger_t ledger, int entry, uint64_t now); 276 extern uint64_t ledger_get_interval_remaining(ledger_t ledger, int entry, uint64_t now); 277 278 /* Support for ledger() syscall */ 279 #ifdef LEDGER_DEBUG 280 extern int ledger_limit(task_t task, struct ledger_limit_args *args); 281 #endif 282 extern int ledger_info(task_t task, struct ledger_info *info); 283 284 extern int 285 ledger_get_task_entry_info_multiple(task_t task, void **buf, int *len, bool v2); 286 287 extern void 288 ledger_get_entry_info(ledger_t ledger, int entry, 289 struct ledger_entry_info *lei); 290 291 extern int ledger_template_info(void **buf, int *len); 292 293 #if DEBUG || DEVELOPMENT 294 extern kern_return_t ledger_get_diag_mem_threshold(ledger_t ledger, int entry, 295 ledger_amount_t *limit); 296 297 extern kern_return_t ledger_set_diag_mem_threshold(ledger_t ledger, int entry, 298 ledger_amount_t limit); 299 extern kern_return_t ledger_set_diag_mem_threshold_disabled(ledger_t ledger, int entry); 300 extern kern_return_t ledger_set_diag_mem_threshold_enabled(ledger_t ledger, int entry); 301 extern kern_return_t ledger_is_diag_threshold_enabled(ledger_t ledger, int entry, bool *status); 302 #endif // DEBUG || DEVELOPMENT 303 304 #endif /* KERNEL_PRIVATE */ 305 306 #endif /* _KERN_LEDGER_H_ */ 307