xref: /xnu-12377.81.4/bsd/sys/resource_private.h (revision 043036a2b3718f7f0be807e2870f8f47d3fa0796)

/*
 * Copyright (c) 2000-2021 Apple 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@
 */

#ifndef _SYS_RESOURCE_PRIVATE_H_
#define _SYS_RESOURCE_PRIVATE_H_

#include <os/base.h>
#include <stdint.h>
#include <sys/cdefs.h>

/*
 * The kind of counters to copy into the destination buffer with
 * `thread_selfcounts`.
 */
__enum_decl(thread_selfcounts_kind_t, uint32_t, {
	/*
	 * Get the current thread's cycles and instructions -- may return ENOTSUP
	 * on certain hardware.
	 */
	THSC_CPI = 1,
	/*
	 * Same as `THSC_CPI`, except fills in an array indexed by CPU perf-level,
	 * with `sysctl hw.nperflevels` entries.
	 */
	THSC_CPI_PER_PERF_LEVEL = 2,
	/*
	 * Get the current thread's cycles, instructions, user time and system time.
	 * Instructions and cycles may be left 0 on certain hardware.  System time
	 * may be accounted for by user time and left 0 on certain hardware.
	 */
	THSC_TIME_CPI = 3,
	/*
	 * Same as `THSC_TIME_CPI`, except fills in an array indexed by CPU
	 * perf-level, with `sysctl hw.nperflevels` entries.
	 */
	THSC_TIME_CPI_PER_PERF_LEVEL = 4,
	/*
	 * Get the current thread's cycles, instructions, times, and energy usage.
	 */
	THSC_TIME_ENERGY_CPI = 5,
	/*
	 * Same as `THSC_TIME_ENERGY_CPI`, except fills in an array indexd by CPU
	 * perf-level, with `sysctl hw.nperflevels` entries.
	 */
	THSC_TIME_ENERGY_CPI_PER_PERF_LEVEL = 6,
});

/*
 * The data structure expected by `THSC_CPI*`.
 */
struct thsc_cpi {
	uint64_t tcpi_instructions;
	uint64_t tcpi_cycles;
};

/*
 * The data structure expected by `THSC_TIME_CPI*`.
 */
struct thsc_time_cpi {
	uint64_t ttci_instructions;
	uint64_t ttci_cycles;
	uint64_t ttci_user_time_mach;
	uint64_t ttci_system_time_mach;
};

/*
 * The data structure expected by `THSC_TIME_ENERGY_CPI*`.
 */
struct thsc_time_energy_cpi {
	uint64_t ttec_instructions;
	uint64_t ttec_cycles;
	uint64_t ttec_user_time_mach;
	uint64_t ttec_system_time_mach;
	uint64_t ttec_energy_nj;
};

#ifndef KERNEL

#include <stddef.h>
#include <Availability.h>
#include <AvailabilityInternalPrivate.h>

__BEGIN_DECLS

/*
 * Get the current thread's counters according to a `kind` and store them into
 * `dst`.
 */
__SPI_AVAILABLE(macos(12.4), ios(15.4), watchos(8.5), tvos(15.4))
int thread_selfcounts(thread_selfcounts_kind_t kind, void *dst, size_t size);

__END_DECLS

#endif /* !defined(KERNEL) */

/* Additional private parameters to getpriority()/setpriority() */

#define PRIO_DARWIN_GPU         5               /* Second argument is a PID */

__enum_decl(darwin_gpu_role_t, uint8_t, {
	/* GPU Role unmanaged, default value at task start */
	PRIO_DARWIN_GPU_UNKNOWN         = 0x0,
	/* existing allow state for compatibility */
	PRIO_DARWIN_GPU_ALLOW           = 0x1,
	/* GPU access is denied by Runningboard */
	PRIO_DARWIN_GPU_DENY            = 0x2,
	/* Allowed to use GPU at Background priority, not visible to user, prioritizes running most-efficiently */
	PRIO_DARWIN_GPU_BACKGROUND      = 0x3,
	/* GPU used for non-visible-UI long-running progress-bar workloads, balances between sustainable thermals and perf */
	PRIO_DARWIN_GPU_UTILITY         = 0x4,
	/* Renders visible UI, known to be a non-focal app */
	PRIO_DARWIN_GPU_UI_NON_FOCAL    = 0x5,
	/* Renders visible UI, unknown focality */
	PRIO_DARWIN_GPU_UI              = 0x6,
	/* Renders visible UI, is part of a focal app */
	PRIO_DARWIN_GPU_UI_FOCAL        = 0x7,
});

#define PRIO_DARWIN_ROLE        6               /* Second argument is a PID */

#define PRIO_DARWIN_ROLE_DEFAULT        0x0     /* Reset to default state */
#define PRIO_DARWIN_ROLE_UI_FOCAL       0x1     /* On  screen,     focal UI */
#define PRIO_DARWIN_ROLE_UI             0x2     /* On  screen UI,  focal unknown */
#define PRIO_DARWIN_ROLE_NON_UI         0x3     /* Off screen, non-focal UI */
#define PRIO_DARWIN_ROLE_UI_NON_FOCAL   0x4     /* On  screen, non-focal UI */
#define PRIO_DARWIN_ROLE_TAL_LAUNCH     0x5     /* Throttled-launch (for OS X TAL resume) */
#define PRIO_DARWIN_ROLE_DARWIN_BG      0x6     /* Throttled for running in the background */
#define PRIO_DARWIN_ROLE_USER_INIT      0x7     /* Off-screen doing user-initiated work */

#define PRIO_DARWIN_GAME_MODE   7               /* Second argument is a PID */
#define PRIO_DARWIN_CARPLAY_MODE   8            /* Second argument is a PID */
#define PRIO_DARWIN_RUNAWAY_MITIGATION  9       /* Second argument is a PID */

#define PRIO_DARWIN_GAME_MODE_OFF   0x0
#define PRIO_DARWIN_GAME_MODE_ON    0x1

#define PRIO_DARWIN_CARPLAY_MODE_OFF   0x0
#define PRIO_DARWIN_CARPLAY_MODE_ON    0x1

#define PRIO_DARWIN_RUNAWAY_MITIGATION_OFF      0x0
#define PRIO_DARWIN_RUNAWAY_MITIGATION_ON       0x1

/*
 * Flags for I/O monitor control.
 */
#define IOMON_ENABLE                    0x01
#define IOMON_DISABLE                   0x02

/* Private I/O type */
#define IOPOL_TYPE_VFS_HFS_CASE_SENSITIVITY 1
#define IOPOL_TYPE_VFS_ALTLINK 11
#define IOPOL_TYPE_VFS_NOCACHE_WRITE_FS_BLKSIZE  12
#define IOPOL_TYPE_VFS_SUPPORT_LONG_PATHS 13

#define IOPOL_VFS_HFS_CASE_SENSITIVITY_DEFAULT  0
#define IOPOL_VFS_HFS_CASE_SENSITIVITY_FORCE_CASE_SENSITIVE     1

#define IOPOL_VFS_ALTLINK_DISABLED 0
#define IOPOL_VFS_ALTLINK_ENABLED  1

#define IOPOL_VFS_SUPPORT_LONG_PATHS_DEFAULT 0
#define IOPOL_VFS_SUPPORT_LONG_PATHS_ON 1

/*
 * Structures for use in communicating via iopolicysys() between Libc and the
 * kernel.  Not to be used by user programs directly.
 */

/*
 * the command to iopolicysys()
 */
#define IOPOL_CMD_GET           0x00000001      /* Get I/O policy */
#define IOPOL_CMD_SET           0x00000002      /* Set I/O policy */

/*
 * Second parameter to iopolicysys()
 */
struct _iopol_param_t {
	int iop_scope;  /* current process or a thread */
	int iop_iotype;
	int iop_policy;
};

#endif  /* !defined(_SYS_RESOURCE_PRIVATE_H_) */