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#define LEDGER_INFO 0
38#define LEDGER_ENTRY_INFO 1
39#define LEDGER_TEMPLATE_INFO 2
40#define LEDGER_LIMIT 3
41/* LEDGER_MAX_CMD always tracks the index of the last ledger command. */
42#define LEDGER_MAX_CMD LEDGER_LIMIT
43
44#define LEDGER_NAME_MAX 32
45
46struct ledger_info {
47 char li_name[LEDGER_NAME_MAX];
48 int64_t li_id;
49 int64_t li_entries;
50};
51
52struct ledger_template_info {
53 char lti_name[LEDGER_NAME_MAX];
54 char lti_group[LEDGER_NAME_MAX];
55 char lti_units[LEDGER_NAME_MAX];
56};
57
58#ifdef MACH_KERNEL_PRIVATE
59/*
60 * These definitions are only here to allow pmap.c to determine the expected
61 * size of a ledger at build time. Direct access to ledger fields or to
62 * ledger entries is prohibited.
63 */
64
65/*
66 * The explicit alignment is to ensure that atomic operations don't panic
67 * on ARM.
68 */
69struct ledger_entry {
70 volatile uint32_t le_flags;
71 ledger_amount_t le_limit;
72 ledger_amount_t le_warn_level;
73 volatile ledger_amount_t le_credit __attribute__((aligned(8)));
74 volatile ledger_amount_t le_debit __attribute__((aligned(8)));
75 union {
76 struct {
77 /*
78 * XXX - the following two fields can go away if we move all of
79 * the refill logic into process policy
80 */
81 uint64_t le_refill_period;
82 uint64_t le_last_refill;
83 } le_refill;
84 struct {
85 ledger_amount_t le_lifetime_max; /* Process lifetime peak */
86#if CONFIG_LEDGER_INTERVAL_MAX
87 ledger_amount_t le_interval_max; /* Interval peak XXX better name needed */
88#endif
89 } _le_max;
90 } _le;
91} __attribute__((aligned(8)));
92
93struct ledger {
94 uint64_t l_id;
95 int32_t l_refs;
96 int32_t l_size;
97 struct ledger_template *l_template;
98 struct ledger_entry l_entries[0] __attribute__((aligned(8)));
99};
100#endif /* MACH_KERNEL_PRIVATE */
101
102struct ledger_entry_info {
103 int64_t lei_balance;
104 int64_t lei_credit;
105 int64_t lei_debit;
106 uint64_t lei_limit;
107 uint64_t lei_refill_period; /* In nanoseconds */
108 uint64_t lei_last_refill; /* Time since last refill */
109};
110
111struct ledger_limit_args {
112 char lla_name[LEDGER_NAME_MAX];
113 uint64_t lla_limit;
114 uint64_t lla_refill_period;
115};
116
117#ifdef KERNEL_PRIVATE
118
119typedef struct ledger_template *ledger_template_t;
120
121#define LEDGER_VALID(ledger) (ledger != LEDGER_NULL)
122
123/* Action to take when a ledger goes into deficit */
124#define LEDGER_ACTION_IGNORE 0x0000
125#define LEDGER_ACTION_BLOCK 0x0010
126#define LEDGER_ACTION_CALLBACK 0x0020
127#define LEDGER_ACTION_MASK 0x00f0
128
129/*
130 * Types of warnings that trigger a callback.
131 */
132#define LEDGER_WARNING_ROSE_ABOVE 1
133#define LEDGER_WARNING_DIPPED_BELOW 2
134
135typedef void (*ledger_callback_t)(int warning, const void * param0, const void *param1);
136
137extern void ledger_init(void);
138
139extern ledger_template_t ledger_template_create(const char *name);
140extern void ledger_template_dereference(ledger_template_t template);
141extern int ledger_entry_add(ledger_template_t template, const char *key,
142 const char *group, const char *units);
143extern kern_return_t ledger_set_callback(ledger_template_t template, int entry,
144 ledger_callback_t callback, const void *param0, const void *param1);
145extern kern_return_t ledger_track_maximum(ledger_template_t template, int entry,
146 int period_in_secs);
147extern kern_return_t ledger_panic_on_negative(ledger_template_t template,
148 int entry);
149extern kern_return_t ledger_track_credit_only(ledger_template_t template,
150 int entry);
151extern int ledger_key_lookup(ledger_template_t template, const char *key);
152
153/* value of entry type */
154#define LEDGER_CREATE_ACTIVE_ENTRIES 0
155#define LEDGER_CREATE_INACTIVE_ENTRIES 1
156extern ledger_t ledger_instantiate(ledger_template_t template, int entry_type);
157extern void ledger_template_complete(ledger_template_t template);
158extern void ledger_template_complete_secure_alloc(ledger_template_t template);
159extern kern_return_t ledger_disable_callback(ledger_t ledger, int entry);
160extern kern_return_t ledger_enable_callback(ledger_t ledger, int entry);
161extern kern_return_t ledger_get_limit(ledger_t ledger, int entry,
162 ledger_amount_t *limit);
163extern kern_return_t ledger_set_limit(ledger_t ledger, int entry,
164 ledger_amount_t limit, uint8_t warn_level_percentage);
165#if CONFIG_LEDGER_INTERVAL_MAX
166extern kern_return_t ledger_get_interval_max(ledger_t ledger, int entry,
167 ledger_amount_t *max_interval_balance, int reset);
168#endif /* CONFIG_LEDGER_INTERVAL_MAX */
169extern kern_return_t ledger_get_lifetime_max(ledger_t ledger, int entry,
170 ledger_amount_t *max_lifetime_balance);
171extern kern_return_t ledger_get_actions(ledger_t ledger, int entry, int *actions);
172extern kern_return_t ledger_set_action(ledger_t ledger, int entry, int action);
173extern kern_return_t ledger_get_period(ledger_t ledger, int entry,
174 uint64_t *period);
175extern kern_return_t ledger_set_period(ledger_t ledger, int entry,
176 uint64_t period);
177extern kern_return_t ledger_disable_refill(ledger_t l, int entry);
178extern kern_return_t ledger_entry_setactive(ledger_t ledger, int entry);
179extern void ledger_check_new_balance(thread_t thread, ledger_t ledger, int entry);
180extern kern_return_t ledger_credit(ledger_t ledger, int entry,
181 ledger_amount_t amount);
182extern kern_return_t ledger_credit_nocheck(ledger_t ledger, int entry,
183 ledger_amount_t amount);
184extern kern_return_t ledger_debit(ledger_t ledger, int entry,
185 ledger_amount_t amount);
186extern kern_return_t ledger_debit_nocheck(ledger_t ledger, int entry,
187 ledger_amount_t amount);
188extern kern_return_t ledger_credit_thread(thread_t thread, ledger_t ledger,
189 int entry, ledger_amount_t amount);
190extern kern_return_t ledger_debit_thread(thread_t thread, ledger_t ledger,
191 int entry, ledger_amount_t amount);
192extern kern_return_t ledger_zero_balance(ledger_t ledger, int entry);
193extern kern_return_t ledger_get_entries(ledger_t ledger, int entry,
194 ledger_amount_t *credit, ledger_amount_t *debit);
195extern kern_return_t ledger_get_balance(ledger_t ledger, int entry,
196 ledger_amount_t *balance);
197extern kern_return_t ledger_reset_callback_state(ledger_t ledger, int entry);
198extern kern_return_t ledger_disable_panic_on_negative(ledger_t ledger, int entry);
199extern kern_return_t ledger_get_panic_on_negative(ledger_t ledger, int entry, int *panic_on_negative);
200
201extern kern_return_t ledger_rollup(ledger_t to_ledger, ledger_t from_ledger);
202extern kern_return_t ledger_rollup_entry(ledger_t to_ledger, ledger_t from_ledger, int entry);
203
204extern void ledger_ast(thread_t thread);
205
206extern int ledger_reference_count(ledger_t ledger);
207extern kern_return_t ledger_reference(ledger_t ledger);
208extern kern_return_t ledger_dereference(ledger_t ledger);
209
210/* Support for ledger() syscall */
211#ifdef LEDGER_DEBUG
212extern int ledger_limit(task_t task, struct ledger_limit_args *args);
213#endif
214extern int ledger_info(task_t task, struct ledger_info *info);
215
216extern int
217ledger_get_task_entry_info_multiple(task_t task, void **buf, int *len);
218
219extern void
220ledger_get_entry_info(ledger_t ledger, int entry,
221 struct ledger_entry_info *lei);
222
223extern int ledger_template_info(void **buf, int *len);
224
225#endif /* KERNEL_PRIVATE */
226
227#endif /* _KERN_LEDGER_H_ */
228