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