niklas/cyclonedds
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Rudimentary process management.

Browse source 
Signed-off-by: Martin Bremmer <martin.bremmer@adlinktech.com>
This commit is contained in:
Martin Bremmer 2019-04-05 15:00:48 +02:00
parent d146716d1d
commit 0269774a60
9 changed files with 1378 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

173
src/ddsrt/include/dds/ddsrt/process.h
View file

@ -13,11 +13,9 @@
#define DDSRT_PROCESS_H
#include "dds/export.h"
#include "dds/ddsrt/time.h"
#include "dds/ddsrt/types.h"
#if defined (__cplusplus)
extern "C" {
#endif
#include "dds/ddsrt/retcode.h"
#if defined(_WIN32)
typedef DWORD ddsrt_pid_t;
@ -33,6 +31,11 @@ typedef pid_t ddsrt_pid_t;
#endif
#endif /* _WIN32 */
#if defined (__cplusplus)
extern "C" {
#endif
/**
* @brief Return process ID (PID) of the calling process.
*
@ -41,6 +44,168 @@ typedef pid_t ddsrt_pid_t;
DDS_EXPORT ddsrt_pid_t
ddsrt_getpid(void);
/**
* @brief Create new process.
*
* Creates a new process using the provided executable file. It will have
* default priority and scheduling.
*
* Process arguments are represented by argv, which can be null. If argv is
* not null, then the array must be null terminated. The argv array only has
* to contain the arguments, the executable filename doesn't have to be in
* the first element, which is normally the convention.
*
* @param[in] executable Executable file name.
* @param[in] argv Arguments array.
* @param[out] pid ID of the created process.
*
* @returns A dds_retcode_t indicating success or failure.
*
* @retval DDS_RETCODE_OK
* Process successfully created.
* @retval DDS_RETCODE_BAD_PARAMETER
* Provided file is not available or not executable.
* @retval DDS_RETCODE_NOT_ALLOWED
* Caller is not permitted to start the process.
* @retval DDS_RETCODE_OUT_OF_RESOURCES
* Not enough resources to start the process.
* @retval DDS_RETCODE_ERROR
* Process could not be created.
*/
DDS_EXPORT dds_retcode_t
ddsrt_proc_create(
const char *executable,
char *const argv[],
ddsrt_pid_t *pid);
/**
* @brief Wait for a specific child process to have finished.
*
* This function takes a process id and will wait until the related process
* has finished or the timeout is reached.
*
* If the process finished, then the exit code of that process will be copied
* into the given 'code' argument.
*
* Internally, the timeout can be round-up to the nearest milliseconds or
* seconds, depending on the platform.
*
* See ddsrt_proc_waitpids() for waiting on all child processes.
*
* @param[in] pid Process ID (PID) to get the exit code from.
* @param[in] timemout Time within the process is expected to finish.
* @param[out] code The exit code of the process.
*
* @returns A dds_retcode_t indicating success or failure.
*
* @retval DDS_RETCODE_OK
* Process has terminated and its exit code has been captured.
* @retval DDS_RETCODE_PRECONDITION_NOT_MET
* Process is still alive (only when timeout == 0).
* @retval DDS_RETCODE_TIMEOUT
* Process is still alive (even after the timeout).
* @retval DDS_RETCODE_BAD_PARAMETER
* Negative timeout.
* @retval DDS_RETCODE_NOT_FOUND
* Process unknown.
* @retval DDS_RETCODE_ERROR
* Getting the exit code failed for an unknown reason.
*/
DDS_EXPORT dds_retcode_t
ddsrt_proc_waitpid(
ddsrt_pid_t pid,
dds_duration_t timeout,
int32_t *code);
/**
* @brief Wait for a random child process to have finished.
*
* This function will wait until anyone of the child processes has
* finished or the timeout is reached.
*
* If a process finished, then the exit code of that process will be
* copied into the given 'code' argument. The pid of the process will
* be put in the 'pid' argument.
*
* Internally, the timeout can be round-up to the nearest milliseconds or
* seconds, depending on the platform.
*
* See ddsrt_proc_waitpid() for waiting on a specific child process.
*
* @param[in] timemout Time within a process is expected to finish.
* @param[out] pid Process ID (PID) of the finished process.
* @param[out] code The exit code of the process.
*
* @returns A dds_retcode_t indicating success or failure.
*
* @retval DDS_RETCODE_OK
* A process has terminated.
* Its exit code and pid have been captured.
* @retval DDS_RETCODE_PRECONDITION_NOT_MET
* All child processes are still alive (only when timeout == 0).
* @retval DDS_RETCODE_TIMEOUT
* All child processes are still alive (even after the timeout).
* @retval DDS_RETCODE_BAD_PARAMETER
* Negative timeout.
* @retval DDS_RETCODE_NOT_FOUND
* There are no processes to wait for.
* @retval DDS_RETCODE_ERROR
* Getting the exit code failed for an unknown reason.
*/
DDS_EXPORT dds_retcode_t
ddsrt_proc_waitpids(
dds_duration_t timeout,
ddsrt_pid_t *pid,
int32_t *code);
/**
* @brief Checks if a process exists.
*
* @param[in] pid Process ID (PID) to check if it exists.
*
* @returns A dds_retcode_t indicating success or failure.
*
* @retval DDS_RETCODE_OK
* The process exists.
* @retval DDS_RETCODE_NOT_FOUND
* The process does not exist.
* @retval DDS_RETCODE_ERROR
* Determining if a process exists or not, failed.
*/
DDS_EXPORT dds_retcode_t
ddsrt_proc_exists(
ddsrt_pid_t pid);
/**
* @brief Kill a process.
*
* This function will try to forcefully kill the process (identified
* by pid).
*
* When DDS_RETCODE_OK is returned, it doesn't mean that the process
* was actually killed. It only indicates that the process was
* 'told' to terminate. Call ddsrt_proc_exists() to know
* for sure if the process was killed.
*
* @param[in] pid Process ID (PID) of the process to terminate.
*
* @returns A dds_retcode_t indicating success or failure.
*
* @retval DDS_RETCODE_OK
* Kill attempt has been started.
* @retval DDS_RETCODE_BAD_PARAMETER
* Process unknown.
* @retval DDS_RETCODE_ILLEGAL_OPERATION
* Caller is not allowed to kill the process.
* @retval DDS_RETCODE_ERROR
* Kill failed for an unknown reason.
*/
DDS_EXPORT dds_retcode_t
ddsrt_proc_kill(
ddsrt_pid_t pid);
#if defined (__cplusplus)
}
#endif