[apple/xnu.git] / osfmk / kern / ledger.h

/*
 * Copyright (c) 2010 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
 * @OSF_COPYRIGHT@
 */

#ifndef _KERN_LEDGER_H_
#define _KERN_LEDGER_H_

#include <mach/mach_types.h>	/* ledger_t */

#define	LEDGER_INFO		0
#define	LEDGER_ENTRY_INFO	1
#define	LEDGER_TEMPLATE_INFO	2
#define	LEDGER_LIMIT		3
/* LEDGER_MAX_CMD always tracks the index of the last ledger command. */
#define	LEDGER_MAX_CMD		LEDGER_LIMIT

#define	LEDGER_NAME_MAX	32

struct ledger_info {
	char	li_name[LEDGER_NAME_MAX];
	int64_t	li_id;
	int64_t	li_entries;
};

struct ledger_template_info {
	char		lti_name[LEDGER_NAME_MAX];
	char		lti_group[LEDGER_NAME_MAX];
	char		lti_units[LEDGER_NAME_MAX];
};

struct ledger_entry_info {
	int64_t		lei_balance;
	int64_t		lei_credit;
	int64_t		lei_debit;
	uint64_t	lei_limit;
	uint64_t	lei_refill_period;	/* In nanoseconds */
	uint64_t	lei_last_refill;	/* Time since last refill */
};

struct ledger_limit_args {
	char		lla_name[LEDGER_NAME_MAX];
        uint64_t	lla_limit;
        uint64_t	lla_refill_period;
};

#ifdef	KERNEL_PRIVATE

typedef struct ledger_template *ledger_template_t;

#define	LEDGER_VALID(ledger)	(ledger != LEDGER_NULL)

/* Action to take when a ledger goes into deficit */
#define	LEDGER_ACTION_IGNORE	0x0000
#define	LEDGER_ACTION_BLOCK	0x0010
#define	LEDGER_ACTION_CALLBACK	0x0020
#define	LEDGER_ACTION_MASK	0x00f0

/*
 * Types of warnings that trigger a callback.
 */
#define	LEDGER_WARNING_ROSE_ABOVE	1
#define	LEDGER_WARNING_DIPPED_BELOW	2

typedef void (*ledger_callback_t)(int warning, const void * param0, const void *param1);

extern void ledger_init(void);

extern ledger_template_t ledger_template_create(const char *name);
extern void ledger_template_dereference(ledger_template_t template);
extern int ledger_entry_add(ledger_template_t template, const char *key,
    const char *group, const char *units);
extern kern_return_t ledger_set_callback(ledger_template_t template, int entry,
	ledger_callback_t callback, const void *param0, const void *param1);
extern kern_return_t ledger_track_maximum(ledger_template_t template, int entry,
	int period_in_secs);
extern kern_return_t ledger_panic_on_negative(ledger_template_t template,
					      int entry);
extern kern_return_t ledger_track_credit_only(ledger_template_t template,
					      int entry);
extern int ledger_key_lookup(ledger_template_t template, const char *key);

/* value of entry type */
#define	LEDGER_CREATE_ACTIVE_ENTRIES	0
#define	LEDGER_CREATE_INACTIVE_ENTRIES	1
extern ledger_t ledger_instantiate(ledger_template_t template, int entry_type);
extern void ledger_template_complete(ledger_template_t template);
extern kern_return_t ledger_disable_callback(ledger_t ledger, int entry);
extern kern_return_t ledger_enable_callback(ledger_t ledger, int entry);
extern kern_return_t ledger_get_limit(ledger_t ledger, int entry,
	ledger_amount_t *limit);
extern kern_return_t ledger_set_limit(ledger_t ledger, int entry,
	ledger_amount_t limit, uint8_t warn_level_percentage);
extern kern_return_t ledger_get_recent_max(ledger_t ledger, int entry,
	ledger_amount_t *max_observed_balance);
extern kern_return_t ledger_get_lifetime_max(ledger_t ledger, int entry,
	ledger_amount_t *max_lifetime_balance);
extern kern_return_t ledger_get_actions(ledger_t ledger, int entry, int *actions);
extern kern_return_t ledger_set_action(ledger_t ledger, int entry, int action);
extern kern_return_t ledger_get_period(ledger_t ledger, int entry,
	uint64_t *period);
extern kern_return_t ledger_set_period(ledger_t ledger, int entry,
	uint64_t period);
extern kern_return_t ledger_disable_refill(ledger_t l, int entry);
extern kern_return_t ledger_entry_setactive(ledger_t ledger, int entry);
extern void ledger_check_new_balance(thread_t thread, ledger_t ledger, int entry);
extern kern_return_t ledger_credit(ledger_t ledger, int entry,
	ledger_amount_t amount);
extern kern_return_t ledger_debit(ledger_t ledger, int entry,
	ledger_amount_t amount);
extern kern_return_t ledger_credit_thread(thread_t thread, ledger_t ledger,
                                          int entry, ledger_amount_t amount);
extern kern_return_t ledger_debit_thread(thread_t thread, ledger_t ledger,
                                         int entry, ledger_amount_t amount);
extern kern_return_t ledger_zero_balance(ledger_t ledger, int entry);
extern kern_return_t ledger_get_entries(ledger_t ledger, int entry,
	ledger_amount_t *credit, ledger_amount_t *debit);
extern kern_return_t ledger_get_balance(ledger_t ledger, int entry,
	ledger_amount_t *balance);
extern kern_return_t ledger_reset_callback_state(ledger_t ledger, int entry);
extern kern_return_t ledger_disable_panic_on_negative(ledger_t ledger, int entry);

extern kern_return_t ledger_rollup(ledger_t to_ledger, ledger_t from_ledger);
extern kern_return_t ledger_rollup_entry(ledger_t to_ledger, ledger_t from_ledger, int entry);

extern void ledger_ast(thread_t thread);

extern int ledger_reference_count(ledger_t ledger);
extern kern_return_t ledger_reference(ledger_t ledger);
extern kern_return_t ledger_dereference(ledger_t ledger);

/* Per-pmap ledger operations */
#define	pmap_ledger_debit(p, e, a) ledger_debit((p)->ledger, e, a)
#define	pmap_ledger_credit(p, e, a) ledger_credit((p)->ledger, e, a)

/* Support for ledger() syscall */
#ifdef LEDGER_DEBUG
extern int ledger_limit(task_t task, struct ledger_limit_args *args);
#endif
extern int ledger_info(task_t task, struct ledger_info *info);

extern int 
ledger_get_task_entry_info_multiple(task_t task, void **buf, int *len);

extern void
ledger_get_entry_info(ledger_t ledger, int entry,
                      struct ledger_entry_info *lei);

extern int ledger_template_info(void **buf, int *len);

#endif /* KERNEL_PRIVATE */

#endif	/* _KERN_LEDGER_H_ */
Commit	Line	Data
1c79356b	1	/*
316670eb	2	* Copyright (c) 2010 Apple Computer, Inc. All rights reserved.
1c79356b	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/*
	29	* @OSF_COPYRIGHT@
	30	*/
91447636	31
1c79356b A	32	#ifndef _KERN_LEDGER_H_
	33	#define _KERN_LEDGER_H_
	34
39037602 A	35	#include <mach/mach_types.h> /* ledger_t */
39037602 A	36
316670eb A	37	#define LEDGER_INFO 0
	38	#define LEDGER_ENTRY_INFO 1
	39	#define LEDGER_TEMPLATE_INFO 2
	40	#define LEDGER_LIMIT 3
ecc0ceb4 A	41	/* LEDGER_MAX_CMD always tracks the index of the last ledger command. */
ecc0ceb4 A	42	#define LEDGER_MAX_CMD LEDGER_LIMIT
9bccf70c	43
316670eb	44	#define LEDGER_NAME_MAX 32
1c79356b	45
316670eb A	46	struct ledger_info {
	47	char li_name[LEDGER_NAME_MAX];
	48	int64_t li_id;
	49	int64_t li_entries;
1c79356b A	50	};
1c79356b A	51
316670eb A	52	struct 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	};
1c79356b	57
316670eb	58	struct ledger_entry_info {
39037602 A	59	int64_t lei_balance;
	60	int64_t lei_credit;
	61	int64_t lei_debit;
	62	uint64_t lei_limit;
	63	uint64_t lei_refill_period; /* In nanoseconds */
316670eb A	64	uint64_t lei_last_refill; /* Time since last refill */
316670eb A	65	};
9bccf70c	66
316670eb A	67	struct ledger_limit_args {
	68	char lla_name[LEDGER_NAME_MAX];
	69	uint64_t lla_limit;
	70	uint64_t lla_refill_period;
	71	};
9bccf70c	72
316670eb A	73	#ifdef KERNEL_PRIVATE
	74
	75	typedef struct ledger_template *ledger_template_t;
	76
	77	#define LEDGER_VALID(ledger) (ledger != LEDGER_NULL)
	78
	79	/* Action to take when a ledger goes into deficit */
	80	#define LEDGER_ACTION_IGNORE 0x0000
	81	#define LEDGER_ACTION_BLOCK 0x0010
39236c6e	82	#define LEDGER_ACTION_CALLBACK 0x0020
316670eb A	83	#define LEDGER_ACTION_MASK 0x00f0
316670eb A	84
39236c6e A	85	/*
	86	* Types of warnings that trigger a callback.
	87	*/
	88	#define LEDGER_WARNING_ROSE_ABOVE 1
	89	#define LEDGER_WARNING_DIPPED_BELOW 2
	90
	91	typedef void (ledger_callback_t)(int warning, const void param0, const void *param1);
316670eb A	92
	93	extern void ledger_init(void);
	94
	95	extern ledger_template_t ledger_template_create(const char *name);
	96	extern void ledger_template_dereference(ledger_template_t template);
	97	extern int ledger_entry_add(ledger_template_t template, const char *key,
	98	const char group, const char units);
	99	extern kern_return_t ledger_set_callback(ledger_template_t template, int entry,
	100	ledger_callback_t callback, const void param0, const void param1);
39236c6e A	101	extern kern_return_t ledger_track_maximum(ledger_template_t template, int entry,
39236c6e A	102	int period_in_secs);
fe8ab488 A	103	extern kern_return_t ledger_panic_on_negative(ledger_template_t template,
fe8ab488 A	104	int entry);
39037602 A	105	extern kern_return_t ledger_track_credit_only(ledger_template_t template,
39037602 A	106	int entry);
316670eb A	107	extern int ledger_key_lookup(ledger_template_t template, const char *key);
	108
	109	/* value of entry type */
	110	#define LEDGER_CREATE_ACTIVE_ENTRIES 0
	111	#define LEDGER_CREATE_INACTIVE_ENTRIES 1
	112	extern ledger_t ledger_instantiate(ledger_template_t template, int entry_type);
5ba3f43e	113	extern void ledger_template_complete(ledger_template_t template);
316670eb	114	extern kern_return_t ledger_disable_callback(ledger_t ledger, int entry);
39236c6e A	115	extern kern_return_t ledger_enable_callback(ledger_t ledger, int entry);
	116	extern kern_return_t ledger_get_limit(ledger_t ledger, int entry,
	117	ledger_amount_t *limit);
316670eb	118	extern kern_return_t ledger_set_limit(ledger_t ledger, int entry,
39236c6e	119	ledger_amount_t limit, uint8_t warn_level_percentage);
5ba3f43e	120	extern kern_return_t ledger_get_recent_max(ledger_t ledger, int entry,
39236c6e	121	ledger_amount_t *max_observed_balance);
5ba3f43e A	122	extern kern_return_t ledger_get_lifetime_max(ledger_t ledger, int entry,
5ba3f43e A	123	ledger_amount_t *max_lifetime_balance);
39236c6e	124	extern kern_return_t ledger_get_actions(ledger_t ledger, int entry, int *actions);
316670eb	125	extern kern_return_t ledger_set_action(ledger_t ledger, int entry, int action);
39236c6e	126	extern kern_return_t ledger_get_period(ledger_t ledger, int entry,
5ba3f43e	127	uint64_t *period);
316670eb	128	extern kern_return_t ledger_set_period(ledger_t ledger, int entry,
5ba3f43e	129	uint64_t period);
39236c6e	130	extern kern_return_t ledger_disable_refill(ledger_t l, int entry);
316670eb	131	extern kern_return_t ledger_entry_setactive(ledger_t ledger, int entry);
5c9f4661	132	extern void ledger_check_new_balance(thread_t thread, ledger_t ledger, int entry);
316670eb A	133	extern kern_return_t ledger_credit(ledger_t ledger, int entry,
	134	ledger_amount_t amount);
	135	extern kern_return_t ledger_debit(ledger_t ledger, int entry,
	136	ledger_amount_t amount);
5c9f4661 A	137	extern kern_return_t ledger_credit_thread(thread_t thread, ledger_t ledger,
	138	int entry, ledger_amount_t amount);
	139	extern kern_return_t ledger_debit_thread(thread_t thread, ledger_t ledger,
	140	int entry, ledger_amount_t amount);
39236c6e	141	extern kern_return_t ledger_zero_balance(ledger_t ledger, int entry);
316670eb A	142	extern kern_return_t ledger_get_entries(ledger_t ledger, int entry,
316670eb A	143	ledger_amount_t credit, ledger_amount_t debit);
39236c6e A	144	extern kern_return_t ledger_get_balance(ledger_t ledger, int entry,
39236c6e A	145	ledger_amount_t *balance);
fe8ab488 A	146	extern kern_return_t ledger_reset_callback_state(ledger_t ledger, int entry);
	147	extern kern_return_t ledger_disable_panic_on_negative(ledger_t ledger, int entry);
	148
	149	extern kern_return_t ledger_rollup(ledger_t to_ledger, ledger_t from_ledger);
743345f9	150	extern kern_return_t ledger_rollup_entry(ledger_t to_ledger, ledger_t from_ledger, int entry);
316670eb A	151
316670eb A	152	extern void ledger_ast(thread_t thread);
316670eb A	153
	154	extern int ledger_reference_count(ledger_t ledger);
	155	extern kern_return_t ledger_reference(ledger_t ledger);
	156	extern kern_return_t ledger_dereference(ledger_t ledger);
	157
	158	/* Per-pmap ledger operations */
	159	#define pmap_ledger_debit(p, e, a) ledger_debit((p)->ledger, e, a)
	160	#define pmap_ledger_credit(p, e, a) ledger_credit((p)->ledger, e, a)
	161
	162	/* Support for ledger() syscall */
	163	#ifdef LEDGER_DEBUG
	164	extern int ledger_limit(task_t task, struct ledger_limit_args *args);
	165	#endif
	166	extern int ledger_info(task_t task, struct ledger_info *info);
39236c6e A	167
	168	extern int
	169	ledger_get_task_entry_info_multiple(task_t task, void *buf, int len);
	170
	171	extern void
	172	ledger_get_entry_info(ledger_t ledger, int entry,
	173	struct ledger_entry_info *lei);
	174
316670eb A	175	extern int ledger_template_info(void *buf, int len);
	176
	177	#endif /* KERNEL_PRIVATE */
1c79356b A	178
1c79356b A	179	#endif /* _KERN_LEDGER_H_ */