process.h revision dba6b8a60465a62d3e1ee74942535288802e2b79
/** @file
* InnoTek Portable Runtime - Process Management.
*/
/*
* Copyright (C) 2006 InnoTek Systemberatung GmbH
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* General Public License as published by the Free Software Foundation,
* in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
* distribution. VirtualBox OSE is distributed in the hope that it will
* be useful, but WITHOUT ANY WARRANTY of any kind.
*
* If you received this file as part of a commercial VirtualBox
* distribution, then only the terms of your commercial VirtualBox
* license agreement apply instead of the previous paragraph.
*/
#ifndef __iprt_process_h__
#define __iprt_process_h__
/** @defgroup grp_rt_process RTProc - Process Management
* @ingroup grp_rt
* @{
*/
/**
* Process priority.
*
* The process priority is used to select how scheduling properties
* are assigned to the different thread types (see THREADTYPE).
*
* In addition to using the policy assigned to the process at startup (DEFAULT)
* it is possible to change the process priority at runtime. This allows for
* a GUI, resource manager or admin to adjust the general priorty of a task
* without upsetting the fine-tuned priority of the threads within.
*/
typedef enum RTPROCPRIORITY
{
/** Invalid priority. */
/** Default priority.
* Derive the schedulding policy from the priority of the RTR3Init()
* and RTProcSetPriority() callers and the rights the process have
* to alter its own priority.
*/
/** Flat priority.
* Assumes a scheduling policy which puts the process at the default priority
* and with all thread at the same priority.
*/
/** Low priority.
* Assumes a scheduling policy which puts the process mostly below the
* default priority of the host OS.
*/
/** Normal priority.
* Assume a scheduling policy which shares the cpu resources fairly with
* other processes running with the default priority of the host OS.
*/
/** High priority.
* Assumes a scheduling policy which puts the task above the default
* priority of the host OS. This policy might easily cause other tasks
* in the system to starve.
*/
/** Last priority, used for validation. */
/**
* Get the current process identifier.
*
* @returns Process identifier.
*/
#ifdef IN_RING0
/**
* Get the current process handle.
*
* @returns Ring-0 process handle.
*/
#endif
#ifdef IN_RING3
/**
* Attempts to alter the priority of the current process.
*
* @returns iprt status code.
* @param enmPriority The new priority.
*/
/**
* Gets the current priority of this process.
*
* @returns The priority (see RTPROCPRIORITY).
*/
/**
* Create a child process.
*
* @returns iprt status code.
* @param pszExec Executable image to use to create the child process.
* @param papszArgs Pointer to an array of arguments to the child. The array terminated by an entry containing NULL.
* @param papszEnv Pointer to array of environment variables for the child process. An NULL entry
* terminates the array. The variables are on the form '\<var\>=\<value\>'.
* If NULL the environment of the process will be used.
* @param fFlags Flags. This is currently reserved and must be 0.
* @param pProcess Where to store the process identifier on successful return.
* The content is not changed on failure. NULL is allowed.
*/
RTR3DECL(int) RTProcCreate(const char *pszExec, const char * const *papszArgs, const char * const *papszEnv, unsigned fFlags, PRTPROCESS pProcess);
/**
* Process exit reason.
*/
typedef enum RTPROCEXITREASON
{
/** Normal exit. iStatus contains the exit code. */
/** Any abnormal exit. iStatus is undefined. */
/** Killed by a signal. The iStatus field contains the signal number. */
/**
* Process exit status.
*/
typedef struct RTPROCSTATUS
{
/** The process exit status if the exit was a normal one. */
int iStatus;
/** The reason the process terminated. */
} RTPROCSTATUS;
/** Pointer to a process exit status structure. */
typedef RTPROCSTATUS *PRTPROCSTATUS;
/** Pointer to a const process exit status structure. */
typedef const RTPROCSTATUS *PCRTPROCSTATUS;
/** Flags for RTProcWait().
* @{ */
/** Block indefinitly waiting for the process to exit. */
#define RTPROCWAIT_FLAGS_BLOCK 0
/** Don't block, just check if the process have exitted. */
#define RTPROCWAIT_FLAGS_NOBLOCK 1
/** @} */
/**
* Waits for a process, resumes on interruption.
*
* @returns VINF_SUCCESS when the status code for the process was collected and put in *pProcStatus.
* @returns VERR_PROCESS_NOT_FOUND if the specified process wasn't found.
* @returns VERR_PROCESS_RUNNING when the RTPROCWAIT_FLAG_NOBLOCK and the process haven't exitted yet.
*
* @param Process The process to wait for.
* @param fFlags The wait flags, any of the RTPROCWAIT_FLAGS_ \#defines.
* @param pProcStatus Where to store the exit status on success.
*/
/**
* Waits for a process, returns on interruption.
*
* @returns VINF_SUCCESS when the status code for the process was collected and put in *pProcStatus.
* @returns VERR_PROCESS_NOT_FOUND if the specified process wasn't found.
* @returns VERR_PROCESS_RUNNING when the RTPROCWAIT_FLAG_NOBLOCK and the process haven't exitted yet.
* @returns VERR_INTERRUPTED when the wait was interrupted by the arrival of a signal or other async event.
*
* @param Process The process to wait for.
* @param fFlags The wait flags, any of the RTPROCWAIT_FLAGS_ \#defines.
* @param pProcStatus Where to store the exit status on success.
*/
/**
* Terminates (kills) a running process.
*
* @returns IPRT status code.
* @param Process The process to terminate.
*/
/**
* Gets the processor affinity mask of the current process.
*
* @returns The affinity mask.
*/
/**
* Gets the executable image name of the current process.
*
*
* @returns pszExecName on success. NULL on buffer overflow or other errors.
*
* @param pszExecName Where to store the name.
* @param cchExecName The size of the buffer.
*/
#endif /* IN_RING3 */
/** @} */
#endif