libsyscall/wrappers/libproc/libproc_internal.h

   1 /*
   2  * Copyright (c) 2010 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_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. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 #ifndef _LIBPROC_INTERNALH_
  24 #define _LIBPROC_INTERNALH_
  25
  26 #include <TargetConditionals.h>
  27
  28 #include <sys/cdefs.h>
  29 #include <libproc.h>
  30 #include <mach/message.h>
  31
  32 __BEGIN_DECLS
  33
  34 /* CPU monitor action */
  35 #define PROC_SETCPU_ACTION_NONE         0
  36 #define PROC_SETCPU_ACTION_THROTTLE     1
  37
  38 int proc_setcpu_percentage(pid_t pid, int action, int percentage) __OSX_AVAILABLE_STARTING(__MAC_10_12_2, __IPHONE_5_0);
  39 int proc_clear_cpulimits(pid_t pid) __OSX_AVAILABLE_STARTING(__MAC_10_12_2, __IPHONE_5_0);
  40
  41 /* CPU limits, applies to current thread only. 0% unsets limit */
  42 int proc_setthread_cpupercent(uint8_t percentage, uint32_t ms_refill) __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_5_0);
  43
  44
  45 /* resume the process suspend due to low VM resource */
  46 int proc_clear_vmpressure(pid_t pid);
  47 /* set self as the one who is going to resume suspended processes due to low VM. Need to be root */
  48 int proc_set_owner_vmpressure(void);
  49
  50 /* mark yourself to delay idle sleep on disk IO */
  51 int proc_set_delayidlesleep(void);
  52 /* Reset yourself to delay idle sleep on disk IO, if already set */
  53 int proc_clear_delayidlesleep(void);
  54
  55
  56 /* sub policies for PROC_POLICY_APPTYPE */
  57 #define PROC_POLICY_OSX_APPTYPE_NONE            0
  58 #define PROC_POLICY_OSX_APPTYPE_TAL             1       /* TAL based launched */
  59 #define PROC_POLICY_OSX_APPTYPE_WIDGET          2       /* for dashboard client */
  60 #define PROC_POLICY_OSX_APPTYPE_DASHCLIENT      2       /* rename to move away from widget */
  61
  62 /*
  63  * Resumes the backgrounded TAL or dashboard client. Only priv users can disable TAL apps.
  64  * Valid apptype are PROC_POLICY_OSX_APPTYPE_DASHCLIENT and PROC_POLICY_OSX_APPTYPE_TAL.
  65  * Returns 0 on success otherwise appropriate error code.
  66  */
  67 int proc_disable_apptype(pid_t pid, int apptype);
  68 int proc_enable_apptype(pid_t pid, int apptype);
  69
  70
  71 /* mark process as importance donating */
  72 int proc_donate_importance_boost(void);
  73
  74 /* DEPRECATED: supported for backward compatibility only */
  75 /* check the message for an importance boost and take an assertion on it */
  76 int proc_importance_assertion_begin_with_msg(mach_msg_header_t  *msg,
  77                                              mach_msg_trailer_t *trailer,
  78                                              uint64_t *assertion_token) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_8, __MAC_10_10, __IPHONE_6_0, __IPHONE_8_0);
  79
  80 /* DEPRECATED: supported for backward compatibility only */
  81 /* drop an assertion */
  82 int proc_importance_assertion_complete(uint64_t assertion_handle);
  83
  84 /* check the message for a App De-Nap boost and take an assertion on it */
  85 int proc_denap_assertion_begin_with_msg(mach_msg_header_t  *msg,
  86                                         uint64_t *assertion_token);
  87
  88 /* drop a de-nap assertion */
  89 int proc_denap_assertion_complete(uint64_t assertion_handle);
  90
  91 /* ongoing percent-over-time CPU monitor */
  92 int proc_set_cpumon_defaults(pid_t pid) __OSX_AVAILABLE_STARTING(__MAC_10_8, __IPHONE_6_0);
  93 int proc_set_cpumon_params(pid_t pid, int percentage, int interval) __OSX_AVAILABLE_STARTING(__MAC_10_8, __IPHONE_6_0);
  94 int proc_set_cpumon_params_fatal(pid_t pid, int percentage, int interval) __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_8_0);
  95
  96 int proc_get_cpumon_params(pid_t pid, int *percentage, int *interval) __OSX_AVAILABLE_STARTING(__MAC_10_8, __IPHONE_6_0);
  97 int proc_resume_cpumon(pid_t pid) __OSX_AVAILABLE_STARTING(__MAC_10_12, __IPHONE_10_0);
  98 int proc_disable_cpumon(pid_t pid) __OSX_AVAILABLE_STARTING(__MAC_10_8, __IPHONE_6_0);
  99
 100 /* ongoing wakes/second monitor */
 101 int proc_set_wakemon_defaults(pid_t pid) __OSX_AVAILABLE_STARTING(__MAC_10_9, __IPHONE_7_0);
 102 int proc_set_wakemon_params(pid_t pid, int rate_hz, int flags) __OSX_AVAILABLE_STARTING(__MAC_10_9, __IPHONE_7_0);
 103 int proc_get_wakemon_params(pid_t pid, int *rate_hz, int *flags) __OSX_AVAILABLE_STARTING(__MAC_10_9, __IPHONE_7_0);
 104 int proc_disable_wakemon(pid_t pid) __OSX_AVAILABLE_STARTING(__MAC_10_9, __IPHONE_7_0);
 105
 106 /* request trace buffer collection */
 107 int proc_trace_log(pid_t pid, uint64_t uniqueid) __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_8_0);
 108
 109 /* proc_info call to get the originator information */
 110 int proc_pidoriginatorinfo(int flavor,  void *buffer, int buffersize) __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_8_0);
 111
 112 int proc_listcoalitions(int flavor, int coaltype, void *buffer, int buffersize) __OSX_AVAILABLE_STARTING(__MAC_10_11, __IPHONE_8_3);
 113
 114 #if !TARGET_IPHONE_SIMULATOR
 115
 116 #define PROC_SUPPRESS_SUCCESS                (0)
 117 #define PROC_SUPPRESS_BAD_ARGUMENTS         (-1)
 118 #define PROC_SUPPRESS_OLD_GENERATION        (-2)
 119 #define PROC_SUPPRESS_ALREADY_SUPPRESSED    (-3)
 120
 121 int proc_suppress(pid_t pid, uint64_t *generation);
 122 #endif /* !TARGET_IPHONE_SIMULATOR */
 123
 124 __END_DECLS
 125
 126 #endif /* _LIBPROC_INTERNALH_ */
 127