process.h revision 90de5e214ec7539b24f593bc48954cb016c1f1e9
/** @file
* IPRT - Process Management.
*/
/*
* Copyright (C) 2006-2007 Oracle Corporation
*
* 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 (GPL) 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.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*/
#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 priority of a task
* without upsetting the fine-tuned priority of the threads within.
*/
typedef enum RTPROCPRIORITY
{
/** Invalid priority. */
/** Default priority.
* Derive the scheduling 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 Env Handle to the environment block for the child.
* @param fFlags Flags, one of the RTPROC_FLAGS_* defines.
* @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, RTENV Env, unsigned fFlags, PRTPROCESS pProcess);
/**
* 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 hEnv Handle to the environment block for the child. Pass
* RTENV_DEFAULT to use the environment of the current
* process.
* @param fFlags Flags, one of the RTPROC_FLAGS_* defines.
* @param phStdIn The standard in handle to assign the new process. Pass
* NULL to use the same as the current process. If the
* handle is NIL, we'll close the standard input of the
* guest.
* @param phStdOut The standard out handle to assign the new process. Pass
* NULL to use the same as the current process. If the
* handle is NIL, we'll close the standard output of the
* guest.
* @param phStdErr The standard error handle to assign the new process. Pass
* NULL to use the same as the current process. If the
* handle is NIL, we'll close the standard error of the
* guest.
* @param pszAsUser User to run the process as. Pass NULL to use the same
* user as the current process.
* Windows: Use user@domain format to specify a domain.
* @param pszPassword Password to use to authenticate @a pszAsUser. Must be
* NULL wif pszAsUser is NULL. Whether this is actually
* used or not depends on the platform.
* @param phProcess Where to store the process handle on successful return.
* The content is not changed on failure. NULL is allowed.
*
* @remarks The handles does not have to be created as inheritable, but it
* doesn't hurt if they are as it may avoid race conditions on some
* platforms.
*
* @remarks The as-user feature isn't supported/implemented on all platforms and
* will cause a-yet-to-be-determined-error-status on these.
*/
RTR3DECL(int) RTProcCreateEx(const char *pszExec, const char * const *papszArgs, RTENV hEnv, uint32_t fFlags,
/** @name RTProcCreate and RTProcCreateEx flags
* @{ */
/** Detach the child process from the parents process tree and process group,
*
* The new process will not be a direct decendent of the parent and it will not
* be possible to wait for it, i.e. @a phProcess shall be NULL. */
#define RTPROC_FLAGS_DETACHED RT_BIT(0)
/** Daemonize the child process, without changing the directory.
* @deprecated Dont use this for new code, it is not portable. Use
* RTProcDaemonize instead. */
/** Use special code path for starting child processes from
* a service (daemon). On Windows this is required for services
* because of the so called "Session 0" isolation which was
* introduced with Windows Vista. */
/** @} */
/**
* 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 exited. */
#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_FLAGS_NOBLOCK and the
* process haven't exited 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.
* Optional.
*/
/**
* 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_FLAGS_NOBLOCK and the
* process haven't exited 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.
* Optional.
*/
/**
* 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 (full path) 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.
*/
/**
* Daemonize the current process, making it a background process.
*
* The way this work is that it will spawn a detached / backgrounded /
* daemonized / call-it-what-you-want process that isn't a direct child of the
* current process. The spawned will have the same arguments a the caller,
* except that the @a pszDaemonizedOpt is appended to prevent that the new
* process calls this API again.
*
* bitbucket.
*
* @returns IPRT status code. On success it is normal for the caller to exit
* the process by returning from main().
*
* @param papszArgs The argument vector of the calling process.
* @param pszDaemonized The daemonized option. This is appended to the end
* of the parameter list of the daemonized process.
*/
/**
* Daemonize the current process, making it a background process. The current
* process will exit if daemonizing is successful.
*
* @returns IPRT status code. On success it will only return in the child
* process, the parent will exit. On failure, it will return in the
* parent process and no child has been spawned.
*
* @param fNoChDir Pass false to change working directory to "/".
* @param fNoClose Pass false to redirect standard file streams to the null device.
* @param pszPidfile Path to a file to write the process id of the daemon
* process to. Daemonizing will fail if this file already
* exists or cannot be written. May be NULL.
*/
/**
* Check if the given process is running on the system.
*
* This check is case sensitive on most systems, except for Windows, OS/2 and
* Darwin.
*
* @returns true if the process is running & false otherwise.
* @param pszName Process name to search for. If no path is given only the
* filename part of the running process set will be
* matched. If a path is specified, the full path will be
* matched.
*/
#endif /* IN_RING3 */
/** @} */
#endif