1/*
2 * Copyright (c) 2013 Apple 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#ifndef _SYS_COALITION_H_
30#define _SYS_COALITION_H_
31
32#include <sys/cdefs.h>
33#include <Availability.h>
34#include <stdint.h>
35#include <sys/types.h>
36
37__BEGIN_DECLS
38
39#ifndef KERNEL
40/* Userspace syscall prototypes */
41
42/* Syscalls */
43int coalition_create(uint64_t *cid_out, uint32_t flags);
44int coalition_terminate(uint64_t cid, uint32_t flags);
45int coalition_reap(uint64_t cid, uint32_t flags);
46
47/* This struct is also defined in osfmk/kern/coalition.h. Keep in sync. */
48struct coalition_resource_usage {
49	uint64_t tasks_started;
50	uint64_t tasks_exited;
51	uint64_t time_nonempty;
52	uint64_t cpu_time;
53	uint64_t interrupt_wakeups;
54	uint64_t platform_idle_wakeups;
55	uint64_t bytesread;
56	uint64_t byteswritten;
57	uint64_t gpu_time;
58};
59
60/* Wrappers around __coalition_info syscall (with proper struct types) */
61int coalition_info_resource_usage(uint64_t cid, struct coalition_resource_usage *cru, size_t sz);
62
63#endif /* KERNEL */
64
65/* Flags shared by userspace and xnu */
66
67#define COALITION_CREATE_FLAG_PRIVILEGED ((uint32_t)0x1)
68
69#define COALITION_CREATE_FLAG_MASK ((uint32_t)0x1)
70
71#ifdef PRIVATE
72/* Flavors shared by only xnu + Libsyscall */
73
74/* Syscall flavors */
75#define COALITION_OP_CREATE 1
76#define COALITION_OP_TERMINATE 2
77#define COALITION_OP_REAP 3
78
79/* coalition_info flavors */
80#define COALITION_INFO_RESOURCE_USAGE 1
81
82#endif /* PRIVATE */
83
84__END_DECLS
85
86#endif /* _SYS_COALITION_H_ */
87