266 lines
8.8 KiB
C++
266 lines
8.8 KiB
C++
/*
|
|
* Copyright (C) 2010-2019 Robin Gareus <robin@gareus.org>
|
|
* Copyright (C) 2013-2014 Colin Fletcher <colin.m.fletcher@googlemail.com>
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*/
|
|
#ifndef _libpbd_system_exec_h_
|
|
#define _libpbd_system_exec_h_
|
|
|
|
#ifndef STDIN_FILENO
|
|
#define STDIN_FILENO 0
|
|
#endif
|
|
#ifndef STDOUT_FILENO
|
|
#define STDOUT_FILENO 1
|
|
#endif
|
|
#ifndef STDERR_FILENO
|
|
#define STDERR_FILENO 2
|
|
#endif
|
|
|
|
#ifdef PLATFORM_WINDOWS
|
|
#include <windows.h>
|
|
|
|
#ifdef interface
|
|
#undef interface // VKamyshniy: to avoid "include/giomm-2.4/giomm/dbusmessage.h:270:94: error: expected ',' or '...' before 'struct'"
|
|
#endif
|
|
|
|
#else // posix
|
|
#include <sys/types.h>
|
|
#include <sys/wait.h> /* WNOHANG is part of the exposed API */
|
|
#endif
|
|
|
|
#include <string>
|
|
#include <pthread.h>
|
|
#include <signal.h>
|
|
#include <map>
|
|
|
|
#ifdef NOPBD /* unit-test outside ardour */
|
|
#include <sigc++/bind.h>
|
|
#include <sigc++/signal.h>
|
|
#else
|
|
#include "pbd/signals.h"
|
|
#endif
|
|
|
|
namespace PBD {
|
|
|
|
/** @class: SystemExec
|
|
* @brief execute an external command
|
|
*
|
|
* This class allows launche an external command-line application
|
|
* opening a full-duplex connection to its standard I/O.
|
|
*
|
|
* In Ardour context it is used to launch xjadeo and ffmpeg.
|
|
*
|
|
* The \ref write_to_stdin function provides for injecting data into STDIN
|
|
* of the child-application while output of the program to STDOUT/STDERR is
|
|
* forwarded using the \ref ReadStdout signal.
|
|
* \ref Terminated is sent if the child application exits.
|
|
*
|
|
*/
|
|
class LIBPBD_API SystemExec
|
|
{
|
|
public:
|
|
/** prepare execution of a program with 'execve'
|
|
*
|
|
* This function takes over the existing environment variable and provides
|
|
* an easy way to speciy command-line arguments for the new process.
|
|
*
|
|
* Note: The argument parser does not interpret quotation-marks and splits
|
|
* arugments on whitespace. The argument string can be empty.
|
|
* The alternative constructor below allows to specify quoted parameters
|
|
* incl. whitespace.
|
|
*
|
|
* @param cmd program pathname that identifies the new process image file.
|
|
* @param argv string of commandline-arguments to be passed to the new program.
|
|
* @param supress_ld_env On Linux, unset LD_LIBRARY_PATH environment variable
|
|
*/
|
|
SystemExec (std::string cmd, std::string argv = "", bool supress_ld_env = false);
|
|
/** similar to \ref SystemExec but allows to specify custom arguments
|
|
*
|
|
* @param cmd program pathname that identifies the new process image file.
|
|
* @param argv array of argument strings passed to the new program as 'argv'.
|
|
* it must be terminated by a null pointer (see the 'evecve'
|
|
* POSIX-C documentation for more information)
|
|
* The array must be dynamically allocated using malloc or strdup.
|
|
* Unless they're NULL, the array itself and each of its content
|
|
* memory is freed() in the destructor.
|
|
* @param supress_ld_env On Linux, unset LD_LIBRARY_PATH environment variable
|
|
*/
|
|
SystemExec (std::string cmd, char **argv, bool supress_ld_env = false);
|
|
|
|
/** similar to \ref SystemExec but expects a whole command line, and
|
|
* handles some simple escape sequences.
|
|
*
|
|
* @param command complete command-line to be executed
|
|
* @param subs a map of <char, std::string> listing the % substitutions to
|
|
* be made.
|
|
*
|
|
* creates an argv array from the given command string, splitting into
|
|
* parameters at spaces.
|
|
* "\ " is non-splitting space, "\\" (and "\" at end of command) as "\",
|
|
* for "%<char>", \<char\> is looked up in subs and the corresponding string
|
|
* substituted. "%%" (and "%" at end of command)
|
|
* @param supress_ld_env On Linux, unset LD_LIBRARY_PATH environment variable
|
|
*/
|
|
SystemExec (std::string command, const std::map<char, std::string> subs, bool supress_ld_env = false);
|
|
|
|
virtual ~SystemExec ();
|
|
|
|
static char* format_key_value_parameter (std::string, std::string);
|
|
|
|
std::string to_s() const;
|
|
|
|
enum StdErrMode {
|
|
ShareWithParent = 0,
|
|
IgnoreAndClose = 1,
|
|
MergeWithStdin = 2
|
|
};
|
|
|
|
/** fork and execute the given program
|
|
*
|
|
* @param stderr_mode select what to do with program's standard error
|
|
* output:
|
|
* '0': keep STDERR; mix it with parent-process' STDERR
|
|
* '1': ignore STDERR of child-program
|
|
* '2': merge STDERR into STDOUT and send it with the
|
|
* ReadStdout signal.
|
|
* @param _vfork_exec_wrapper path to vfork-wrapper binary
|
|
* @return If the process is already running or was launched successfully
|
|
* the function returns zero (0). A negative number indicates an error.
|
|
*/
|
|
int start (StdErrMode stderr_mode, const char *_vfork_exec_wrapper);
|
|
/** kill running child-process
|
|
*
|
|
* if a child process exists trt to shut it down by closing its STDIN.
|
|
* if the program dies not react try SIGTERM and eventually SIGKILL
|
|
*/
|
|
void terminate ();
|
|
/** check if the child programm is (still) running.
|
|
*
|
|
* This function calls waitpid(WNOHANG) to check the state of the
|
|
* child-process.
|
|
* @return true if the program is (still) running.
|
|
*/
|
|
bool is_running ();
|
|
/** call the waitpid system-call with the pid of the child-program
|
|
*
|
|
* Basically what \ref terminate uses internally.
|
|
*
|
|
* This function is only useful if you want to control application
|
|
* termination yourself (eg timeouts or progress-dialog).
|
|
* @param options flags - see waitpid manual
|
|
* @return status info from waitpid call (not waitpid's return value)
|
|
* or -1 if the child-program is not running.
|
|
*/
|
|
int wait (int options=0);
|
|
/** closes both STDIN and STDOUT connections to/from
|
|
* the child-program.
|
|
* With the output-interposer thread gone, the program
|
|
* should terminate.
|
|
* used by \ref terminate()
|
|
*/
|
|
void close_stdin ();
|
|
/** write into child-program's STDIN
|
|
* @param d text to write
|
|
* @param len length of data to write, if it is 0 (zero), d.length() is
|
|
* used to determine the number of bytes to transmit.
|
|
* @return number of bytes written.
|
|
*/
|
|
size_t write_to_stdin (std::string const& d, size_t len=0);
|
|
|
|
/** write into child-program's STDIN
|
|
* @param d text to write
|
|
* @param len length of data to write, if it is 0 (zero), d.length() is
|
|
* used to determine the number of bytes to transmit.
|
|
* @return number of bytes written.
|
|
*/
|
|
size_t write_to_stdin (const char* d, size_t len=0);
|
|
|
|
/** write into child-program's STDIN
|
|
* @param data data to write
|
|
* @param bytes length of data to write
|
|
* @return number of bytes written.
|
|
*/
|
|
size_t write_to_stdin (const void* data, size_t bytes=0);
|
|
|
|
/** The ReadStdout signal is emitted when the application writes to STDOUT.
|
|
* it passes the written data and its length in bytes as arguments to the bound
|
|
* slot(s).
|
|
*/
|
|
#ifdef NOPBD /* outside ardour */
|
|
sigc::signal<void, std::string,size_t> ReadStdout;
|
|
#else
|
|
PBD::Signal2<void, std::string,size_t> ReadStdout;
|
|
#endif
|
|
|
|
/** The Terminated signal is emitted when application terminates. */
|
|
#ifdef NOPBD /* outside ardour */
|
|
sigc::signal<void> Terminated;
|
|
#else
|
|
PBD::Signal0<void> Terminated;
|
|
#endif
|
|
|
|
/** interposer to emit signal for writes to STDOUT/ERR.
|
|
*
|
|
* Thread that reads the stdout of the forked
|
|
* process and signal-sends it to the main thread.
|
|
* It also emits the Terminated() signal once
|
|
* the the forked process closes it's stdout.
|
|
*
|
|
* Note: it's actually 'private' function but used
|
|
* by the internal pthread, which only has a pointer
|
|
* to this instance and thus can only access public fn.
|
|
*/
|
|
void output_interposer ();
|
|
|
|
protected:
|
|
std::string cmd; ///< path to command - set when creating the class
|
|
int nicelevel; ///< process nice level - defaults to 0
|
|
|
|
void make_argp(std::string);
|
|
void make_argp_escaped(std::string command, const std::map<char, std::string> subs);
|
|
void make_envp (bool supress_ld_env);
|
|
|
|
char **argp;
|
|
char **envp;
|
|
|
|
private:
|
|
#ifdef PLATFORM_WINDOWS
|
|
PROCESS_INFORMATION *pid;
|
|
HANDLE stdinP[2];
|
|
HANDLE stdoutP[2];
|
|
HANDLE stderrP[2];
|
|
char *w_args;
|
|
void make_wargs(char **);
|
|
#else
|
|
pid_t pid;
|
|
char **argx;
|
|
#endif
|
|
void init ();
|
|
pthread_mutex_t write_lock;
|
|
|
|
int pok[2];
|
|
int pin[2];
|
|
int pout[2];
|
|
|
|
pthread_t thread_id_tt;
|
|
bool thread_active;
|
|
|
|
}; /* end class */
|
|
|
|
}; /* end namespace */
|
|
|
|
#endif /* _libpbd_system_exec_h_ */
|