[apple/libc.git] / darwin / libproc_internal.h

/*
 * Copyright (c) 2010 Apple Inc. All rights reserved.
 *
 * @APPLE_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. 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_LICENSE_HEADER_END@
 */
#ifndef _LIBPROC_INTERNALH_
#define _LIBPROC_INTERNALH_

#include <TargetConditionals.h>

#include <sys/cdefs.h>
#include <libproc.h>

__BEGIN_DECLS

#if TARGET_OS_EMBEDDED

#define PROC_SETCPU_ACTION_NONE		0
#define PROC_SETCPU_ACTION_THROTTLE	1
#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
#define PROC_APPSTATE_BACKGROUND	2
#define PROC_APPSTATE_NONUI		3
#define PROC_APPSTATE_INACTIVE		4

int proc_setappstate(int pid, int appstate);
int proc_appstate(int pid, int * appstatep);

#define PROC_DEVSTATUS_SHORTTERM	1
#define PROC_DEVSTATUS_LONGTERM		2

int proc_devstatusnotify(int devicestatus);

#define PROC_PIDBIND_CLEAR	0
#define PROC_PIDBIND_SET	1
int proc_pidbind(int pid, uint64_t threadid, int bind);


#else /* TARGET_OS_EMBEDDED */

/* resume the process suspend due to low VM resource */
int proc_clear_vmpressure(pid_t pid);
/* set self as the one who is going to resume suspended processes due to low VM. Need to be root */
int proc_set_owner_vmpressure(void);

/* mark yourself to delay idle sleep on disk IO */
int proc_set_delayidlesleep(void);
/* Reset yourself to delay idle sleep on disk IO, if already set */
int proc_clear_delayidlesleep(void);


/* sub policies for PROC_POLICY_APPTYPE */
#define PROC_POLICY_OSX_APPTYPE_NONE            0
#define PROC_POLICY_OSX_APPTYPE_TAL             1       /* TAL based launched */
#define PROC_POLICY_OSX_APPTYPE_WIDGET          2       /* for dashboard client */
#define PROC_POLICY_OSX_APPTYPE_DASHCLIENT      2       /* rename to move away from widget */

/* 
 * Resumes the backgrounded TAL or dashboard client. Only priv users can disable TAL apps.
 * Valid apptype are PROC_POLICY_OSX_APPTYPE_DASHCLIENT and PROC_POLICY_OSX_APPTYPE_TAL.
 * Returns 0 on success otherwise appropriate error code.
 */
int proc_disable_apptype(pid_t pid, int apptype);
int proc_enable_apptype(pid_t pid, int apptype);

#endif /* TARGET_OS_EMBEDDED */

__END_DECLS

#endif /* _LIBPROC_INTERNALH_ */
Commit	Line	Data
1f2f436a A	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>
1f2f436a A	30
	31	__BEGIN_DECLS
	32
	33	#if TARGET_OS_EMBEDDED
	34
	35	#define PROC_SETCPU_ACTION_NONE 0
	36	#define PROC_SETCPU_ACTION_THROTTLE 1
	37	#define PROC_SETCPU_ACTION_SUSPEND 2
	38	#define PROC_SETCPU_ACTION_TERMINATE 3
	39	#define PROC_SETCPU_ACTION_NOTIFY 4
	40
	41	int proc_setcpu_percentage(pid_t pid, int action, int percentage) __OSX_AVAILABLE_STARTING(__MAC_NA, __IPHONE_5_0);
	42	int proc_setcpu_deadline(pid_t pid, int action, uint64_t deadline) __OSX_AVAILABLE_STARTING(__MAC_NA, __IPHONE_5_0);
	43	int proc_setcpu_percentage_withdeadline(pid_t pid, int action, int percentage, uint64_t deadline) __OSX_AVAILABLE_STARTING(__MAC_NA, __IPHONE_5_0);
	44	int proc_clear_cpulimits(pid_t pid) __OSX_AVAILABLE_STARTING(__MAC_NA, __IPHONE_5_0);
	45
	46	#define PROC_APPSTATE_NONE 0
	47	#define PROC_APPSTATE_ACTIVE 1
	48	#define PROC_APPSTATE_BACKGROUND 2
	49	#define PROC_APPSTATE_NONUI 3
	50	#define PROC_APPSTATE_INACTIVE 4
	51
	52	int proc_setappstate(int pid, int appstate);
	53	int proc_appstate(int pid, int * appstatep);
	54
	55	#define PROC_DEVSTATUS_SHORTTERM 1
	56	#define PROC_DEVSTATUS_LONGTERM 2
	57
	58	int proc_devstatusnotify(int devicestatus);
	59
	60	#define PROC_PIDBIND_CLEAR 0
	61	#define PROC_PIDBIND_SET 1
	62	int proc_pidbind(int pid, uint64_t threadid, int bind);
	63
	64
	65	#else /* TARGET_OS_EMBEDDED */
	66
	67	/* resume the process suspend due to low VM resource */
	68	int proc_clear_vmpressure(pid_t pid);
	69	/* set self as the one who is going to resume suspended processes due to low VM. Need to be root */
	70	int proc_set_owner_vmpressure(void);
	71
ad3c9f2a A	72	/* mark yourself to delay idle sleep on disk IO */
	73	int proc_set_delayidlesleep(void);
	74	/* Reset yourself to delay idle sleep on disk IO, if already set */
	75	int proc_clear_delayidlesleep(void);
	76
	77
	78	/* sub policies for PROC_POLICY_APPTYPE */
	79	#define PROC_POLICY_OSX_APPTYPE_NONE 0
	80	#define PROC_POLICY_OSX_APPTYPE_TAL 1 /* TAL based launched */
	81	#define PROC_POLICY_OSX_APPTYPE_WIDGET 2 /* for dashboard client */
	82	#define PROC_POLICY_OSX_APPTYPE_DASHCLIENT 2 /* rename to move away from widget */
	83
1f2f436a A	84	/*
	85	* Resumes the backgrounded TAL or dashboard client. Only priv users can disable TAL apps.
	86	* Valid apptype are PROC_POLICY_OSX_APPTYPE_DASHCLIENT and PROC_POLICY_OSX_APPTYPE_TAL.
	87	* Returns 0 on success otherwise appropriate error code.
	88	*/
	89	int proc_disable_apptype(pid_t pid, int apptype);
	90	int proc_enable_apptype(pid_t pid, int apptype);
	91
	92	#endif /* TARGET_OS_EMBEDDED */
	93
	94	__END_DECLS
	95
	96	#endif /* _LIBPROC_INTERNALH_ */
	97