xnu-4570.31.3.tar.gz

[apple/xnu.git] / libsyscall / wrappers / libproc / libproc_internal.h

diff --git a/libsyscall/wrappers/libproc/libproc_internal.h b/libsyscall/wrappers/libproc/libproc_internal.h
index f04e9e1a394a8206280dbd047f33aec2aad8cc5c..f18366427aa8ad1126f905925578d7f9387890bc 100644 (file)
--- a/libsyscall/wrappers/libproc/libproc_internal.h
+++ b/libsyscall/wrappers/libproc/libproc_internal.h
@@ -27,21 +27,29 @@
 
 #include <sys/cdefs.h>
 #include <libproc.h>
+#include <mach/message.h>
 
 __BEGIN_DECLS
 
-#if TARGET_OS_EMBEDDED
-
+/* CPU monitor action */
 #define PROC_SETCPU_ACTION_NONE                0
 #define PROC_SETCPU_ACTION_THROTTLE    1
+
+int proc_setcpu_percentage(pid_t pid, int action, int percentage) __OSX_AVAILABLE_STARTING(__MAC_10_12_2, __IPHONE_5_0);
+int proc_clear_cpulimits(pid_t pid) __OSX_AVAILABLE_STARTING(__MAC_10_12_2, __IPHONE_5_0);
+
+/* CPU limits, applies to current thread only. 0% unsets limit */
+int proc_setthread_cpupercent(uint8_t percentage, uint32_t ms_refill) __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_5_0);
+
+#if TARGET_OS_EMBEDDED
+
+/* CPU monitor action, continued */
 #define PROC_SETCPU_ACTION_SUSPEND     2
 #define PROC_SETCPU_ACTION_TERMINATE   3
 #define PROC_SETCPU_ACTION_NOTIFY      4
 
-int proc_setcpu_percentage(pid_t pid, int action, int percentage) __OSX_AVAILABLE_STARTING(__MAC_NA, __IPHONE_5_0);
 int proc_setcpu_deadline(pid_t pid, int action, uint64_t deadline) __OSX_AVAILABLE_STARTING(__MAC_NA, __IPHONE_5_0);
 int proc_setcpu_percentage_withdeadline(pid_t pid, int action, int percentage, uint64_t deadline) __OSX_AVAILABLE_STARTING(__MAC_NA, __IPHONE_5_0);
-int proc_clear_cpulimits(pid_t pid) __OSX_AVAILABLE_STARTING(__MAC_NA, __IPHONE_5_0);
 
 #define PROC_APPSTATE_NONE             0
 #define PROC_APPSTATE_ACTIVE           1
@@ -61,6 +69,23 @@ int proc_devstatusnotify(int devicestatus);
 #define PROC_PIDBIND_SET       1
 int proc_pidbind(int pid, uint64_t threadid, int bind);
 
+/*
+ * High level check to see if a process is allowed to use HW
+ * resources reserved for foreground applications.
+ * Returns:
+ *      1 if the PID is allowed
+ *      0 if the PID is NOT allowed
+ *     <0 on error
+ *
+ *     When 0 is returned, 'reason' is set to indicate why
+ *     the pid is not allowed to use foreground-only hardware.
+ *     Reasons returned by the kernel are found in <sys/proc_info.h>
+ *
+ *     When <0 is returned, errno indicates the reason
+ *     for the failure.
+ */
+int proc_can_use_foreground_hw(int pid, uint32_t *reason);
+
 #else /* TARGET_OS_EMBEDDED */
 
 /* resume the process suspend due to low VM resource */
@@ -93,24 +118,46 @@ int proc_enable_apptype(pid_t pid, int apptype);
 /* mark process as importance donating */
 int proc_donate_importance_boost(void);
 
+/* DEPRECATED: supported for backward compatibility only */
 /* check the message for an importance boost and take an assertion on it */
 int proc_importance_assertion_begin_with_msg(mach_msg_header_t  *msg,
-                                                                                        mach_msg_trailer_t *trailer,
-                                                                                        uint64_t *assertion_token);
+                                            mach_msg_trailer_t *trailer,
+                                            uint64_t *assertion_token) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_8, __MAC_10_10, __IPHONE_6_0, __IPHONE_8_0);
 
+/* DEPRECATED: supported for backward compatibility only */
 /* drop an assertion */
 int proc_importance_assertion_complete(uint64_t assertion_handle);
 
+/* check the message for a App De-Nap boost and take an assertion on it */
+int proc_denap_assertion_begin_with_msg(mach_msg_header_t  *msg,
+                                       uint64_t *assertion_token);
+
+/* drop a de-nap assertion */
+int proc_denap_assertion_complete(uint64_t assertion_handle);
+
+/* ongoing percent-over-time CPU monitor */
+int proc_set_cpumon_defaults(pid_t pid) __OSX_AVAILABLE_STARTING(__MAC_10_8, __IPHONE_6_0);
 int proc_set_cpumon_params(pid_t pid, int percentage, int interval) __OSX_AVAILABLE_STARTING(__MAC_10_8, __IPHONE_6_0);
+int proc_set_cpumon_params_fatal(pid_t pid, int percentage, int interval) __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_8_0);
+
 int proc_get_cpumon_params(pid_t pid, int *percentage, int *interval) __OSX_AVAILABLE_STARTING(__MAC_10_8, __IPHONE_6_0);
-int proc_set_cpumon_defaults(pid_t pid) __OSX_AVAILABLE_STARTING(__MAC_10_8, __IPHONE_6_0);
+int proc_resume_cpumon(pid_t pid) __OSX_AVAILABLE_STARTING(__MAC_10_12, __IPHONE_10_0);
 int proc_disable_cpumon(pid_t pid) __OSX_AVAILABLE_STARTING(__MAC_10_8, __IPHONE_6_0);
 
+/* ongoing wakes/second monitor */
+int proc_set_wakemon_defaults(pid_t pid) __OSX_AVAILABLE_STARTING(__MAC_10_9, __IPHONE_7_0);
 int proc_set_wakemon_params(pid_t pid, int rate_hz, int flags) __OSX_AVAILABLE_STARTING(__MAC_10_9, __IPHONE_7_0);
 int proc_get_wakemon_params(pid_t pid, int *rate_hz, int *flags) __OSX_AVAILABLE_STARTING(__MAC_10_9, __IPHONE_7_0);
-int proc_set_wakemon_defaults(pid_t pid) __OSX_AVAILABLE_STARTING(__MAC_10_9, __IPHONE_7_0);
 int proc_disable_wakemon(pid_t pid) __OSX_AVAILABLE_STARTING(__MAC_10_9, __IPHONE_7_0);
 
+/* request trace buffer collection */
+int proc_trace_log(pid_t pid, uint64_t uniqueid) __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_8_0);
+
+/* proc_info call to get the originator information */
+int proc_pidoriginatorinfo(int flavor,  void *buffer, int buffersize) __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_8_0);
+
+int proc_listcoalitions(int flavor, int coaltype, void *buffer, int buffersize) __OSX_AVAILABLE_STARTING(__MAC_10_11, __IPHONE_8_3);
+
 #if !TARGET_IPHONE_SIMULATOR
 
 #define PROC_SUPPRESS_SUCCESS                (0)