Nagios  4.0.1
Dev docs for Nagios core and neb-module hackers
 All Data Structures Files Functions Variables Typedefs Macros Pages
runcmd.h File Reference

runcmd library function declarations More...

#include <signal.h>

Go to the source code of this file.

#define RUNCMD_HAS_REDIR   (1 << 0)
 Return code bitflags for runcmd_cmd2strv() More...
 
#define RUNCMD_HAS_SUBCOMMAND   (1 << 1)
 subcommands present
 
#define RUNCMD_HAS_PAREN   (1 << 2)
 parentheses present in command
 
#define RUNCMD_HAS_JOBCONTROL   (1 << 3)
 job control stuff present
 
#define RUNCMD_HAS_UBSQ   (1 << 4)
 unbalanced single quotes
 
#define RUNCMD_HAS_UBDQ   (1 << 5)
 unbalanced double quotes
 
#define RUNCMD_HAS_WILDCARD   (1 << 6)
 wildcards present
 
#define RUNCMD_HAS_SHVAR   (1 << 7)
 shell variables present
 
#define RUNCMD_EFD   (-1)
 Failed to pipe() or open()
 
#define RUNCMD_EALLOC   (-2)
 Failed to alloc.
 
#define RUNCMD_ECMD   (-3)
 Bad command.
 
#define RUNCMD_EFORK   (-4)
 Failed to fork()
 
#define RUNCMD_EINVAL   (-5)
 Invalid parameters.
 
#define RUNCMD_EWAIT   (-6)
 Failed to wait()
 
void runcmd_init (void)
 Initialize the runcmd library. More...
 
pid_t runcmd_pid (int fd)
 Return pid of a command with a specific file descriptor. More...
 
const char * runcmd_strerror (int code)
 Return explanation of which system call or operation failed. More...
 
int runcmd_open (const char *cmdstring, int *pfd, int *pfderr, char **env) __attribute__((__nonnull__(1
 Start a command from a command string. More...
 
int int runcmd_close (int fd)
 Close a command and return its exit status. More...
 
int runcmd_cmd2strv (const char *str, int *out_argc, char **out_argv)
 Convert a string to a vector of arguments like a shell would. More...
 

Detailed Description

runcmd library function declarations

Note
This is inherited from the nagiosplugins project, although I (AE) wrote the original code, and it might need refactoring for performance later.

Macro Definition Documentation

#define RUNCMD_HAS_REDIR   (1 << 0)

Return code bitflags for runcmd_cmd2strv()

I/O redirection

Function Documentation

int int runcmd_close ( int  fd)

Close a command and return its exit status.

Note
Don't use this. It's a retarded way to reap children suitable only for launching a one-shot program.
Parameters
[in]fdThe child's stdout filedescriptor
Returns
exit-status of the child, or -1 in case of errors
int runcmd_cmd2strv ( const char *  str,
int *  out_argc,
char **  out_argv 
)

Convert a string to a vector of arguments like a shell would.

Note
This might have bugs and is only tested to behave similar to how /bin/sh does things. For csh or other non bash-ish shells there are no guarantees.
The out_argv array has to be large enough to hold all strings found in the command.
Parameters
[in]strThe string to convert to an argument vector
[out]out_argcThe number of arguments found
[out]out_argvThe argument vector
Returns
0 on (great) success, or a bitmask of failure-codes representing f.e. unclosed quotes, job control or output redirection. See the RUNCMD_HAS_* and their ilk to find out about the flag.
void runcmd_init ( void  )

Initialize the runcmd library.

Only multi-threaded programs that might launch the first external program from multiple threads simultaneously need to bother with this.

int runcmd_open ( const char *  cmdstring,
int *  pfd,
int *  pfderr,
char **  env 
)

Start a command from a command string.

Parameters
[in]cmdstringThe command to launch
[out]pfdChild's stdout filedescriptor
[out]pfderrChild's stderr filedescriptor
[in]envCurrently ignored for portability
pid_t runcmd_pid ( int  fd)

Return pid of a command with a specific file descriptor.

Parameters
[in]fdstdout filedescriptor of the child to get pid from
Returns
pid of the child, or 0 on errors
const char* runcmd_strerror ( int  code)

Return explanation of which system call or operation failed.

Parameters
codeError code returned by a library function
Returns
A non-free()'able string explaining where the error occurred