GenericPluginUI: tweak MIDI patch select layout
[ardour.git] / libs / pbd / system_exec.cc
index bf02fd72540d39a0beca7022529b9ff4783cdcae..351e4ee066ae118f2f69e0e64de6cf2b90715f42 100644 (file)
@@ -1,7 +1,7 @@
 /*
     Copyright (C) 2010 Paul Davis
-    Copyright 2005-2008 Lennart Poettering
-    Author: Robin Gareus <robin@gareus.org>
+    Copyright (C) 2010-2014 Robin Gareus <robin@gareus.org>
+    Copyright (C) 2005-2008 Lennart Poettering
 
     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
 #include <string.h>
 #include <errno.h>
 #include <unistd.h>
+#include <algorithm>
 
 #include <assert.h>
+
+#ifndef COMPILER_MSVC
 #include <dirent.h>
+#endif
 
-#ifdef __WIN32__
+#ifdef PLATFORM_WINDOWS
 #include <windows.h>
 #else
 #include <fcntl.h>
 #include <sys/resource.h>
 #endif
 
+#include <glibmm/miscutils.h>
+
+#define USE_VFORK
 
+#include "pbd/file_utils.h"
+#include "pbd/search_path.h"
 #include "pbd/system_exec.h"
 
 using namespace std;
-void * interposer_thread (void *arg);
+using namespace PBD;
 
+static void * interposer_thread (void *arg);
+
+#ifndef PLATFORM_WINDOWS /* POSIX Process only */
 static void close_fd (int& fd) { if (fd >= 0) ::close (fd); fd = -1; }
+#endif
 
-#ifndef __WIN32__
+#if (!defined PLATFORM_WINDOWS && defined NO_VFORK)
 /*
  * This function was part of libasyncns.
  * LGPL v2.1
@@ -142,7 +155,7 @@ static int close_allv(const int except_fds[]) {
 
        return 0;
 }
-#endif /* not on windows */
+#endif /* not on windows, nor vfork */
 
 void
 SystemExec::init ()
@@ -153,10 +166,11 @@ SystemExec::init ()
        pin[1] = -1;
        nicelevel = 0;
        envp = NULL;
-#ifdef __WIN32__
+#ifdef PLATFORM_WINDOWS
        stdinP[0] = stdinP[1] = INVALID_HANDLE_VALUE;
        stdoutP[0] = stdoutP[1] = INVALID_HANDLE_VALUE;
        stderrP[0] = stderrP[1] = INVALID_HANDLE_VALUE;
+       w_args = NULL;
 #endif
 }
 
@@ -175,7 +189,7 @@ SystemExec::SystemExec (std::string c, char **a)
 {
        init ();
 
-#ifdef __WIN32__
+#ifdef PLATFORM_WINDOWS
        make_wargs(a);
 #endif
        make_envp();
@@ -185,8 +199,40 @@ SystemExec::SystemExec (std::string command, const std::map<char, std::string> s
 {
        init ();
        make_argp_escaped(command, subs);
-       cmd = argp[0];
-       // cmd = strdup(argp[0]);
+
+#ifdef PLATFORM_WINDOWS
+       if (argp[0] && strlen (argp[0]) > 0) {
+               std::string wa = argp[0];
+               // only add quotes to command if required..
+               if (argp[0][0] != '"'
+                               && argp[0][strlen(argp[0])-1] != '"'
+                               && strchr(argp[0], ' ')) {
+                       wa = "\"";
+                       wa += argp[0];
+                       wa += "\"";
+               }
+               // ...but always quote all args
+               for (int i = 1; argp[i]; ++i) {
+                       std::string tmp (argp[i]);
+                       while (tmp.find("\"") != std::string::npos)
+                               tmp.replace(tmp.find("\""), 1, "\\\"");
+                       wa += " \"";
+                       wa += tmp;
+                       wa += '"';
+               }
+               w_args = strdup(wa.c_str());
+       }
+#else
+       if (find_file (Searchpath (Glib::getenv ("PATH")), argp[0], cmd)) {
+               // argp[0] exists in $PATH` - set it to the actual path where it was found
+               free (argp[0]);
+               argp[0] = strdup(cmd.c_str ());
+       }
+       // else argp[0] not found in path - leave it as-is, it might be an absolute path
+
+       // Glib::find_program_in_path () is only available in Glib >= 2.28
+       // cmd = Glib::find_program_in_path (argp[0]);
+#endif
        make_envp();
 }
 
@@ -234,7 +280,7 @@ SystemExec::make_argp_escaped(std::string command, const std::map<char, std::str
                                switch (c) {
                                        case ' ' :
                                        case '"' : arg += c; break; // "\\", "\" at end-of-string => "\"
-                                       case '\0': 
+                                       case '\0':
                                        case '\\': arg += '\\'; break;
                                        default  : arg += '\\'; arg += c; break;
                                }
@@ -258,14 +304,6 @@ SystemExec::make_argp_escaped(std::string command, const std::map<char, std::str
                }
        }
        argp[n] = NULL;
-
-       char *p = argp[0];
-       n = 0;
-       do {
-               std::cerr << "argv[" << n << "] == \"" << p << "\"" << std::endl;
-               p = argp[n++];
-       } while (p);
-
 }
 
 SystemExec::~SystemExec ()
@@ -273,23 +311,23 @@ SystemExec::~SystemExec ()
        terminate ();
        if (envp) {
                for (int i=0;envp[i];++i) {
-                 free(envp[i]);
+                       free(envp[i]);
                }
                free (envp);
        }
        if (argp) {
                for (int i=0;argp[i];++i) {
-                 free(argp[i]);
+                       free(argp[i]);
                }
                free (argp);
        }
-#ifdef __WIN32__
+#ifdef PLATFORM_WINDOWS
        if (w_args) free(w_args);
 #endif
        pthread_mutex_destroy(&write_lock);
 }
 
-void *
+static void *
 interposer_thread (void *arg) {
        SystemExec *sex = static_cast<SystemExec *>(arg);
        sex->output_interposer();
@@ -297,7 +335,23 @@ interposer_thread (void *arg) {
        return 0;
 }
 
-#ifdef __WIN32__ /* Windows Process */
+string
+SystemExec::to_s () const
+{
+#ifdef PLATFORM_WINDOWS
+       return string (w_args ? w_args : "");
+#else
+       stringstream out;
+       if (argp) {
+               for (int i = 0; argp[i]; ++i) {
+                       out << argp[i] << " ";
+               }
+       }
+       return out.str();
+#endif
+}
+
+#ifdef PLATFORM_WINDOWS /* Windows Process */
 
 /* HELPER FUNCTIONS */
 
@@ -346,10 +400,13 @@ SystemExec::make_wargs(char **a) {
        std::string wa = cmd;
        if (cmd[0] != '"' && cmd[cmd.size()] != '"' && strchr(cmd.c_str(), ' ')) { wa = "\"" + cmd + "\""; }
        std::replace(cmd.begin(), cmd.end(), '/', '\\' );
-       char **tmp = a;
+       char **tmp = ++a;
        while (tmp && *tmp) {
                wa.append(" \"");
                wa.append(*tmp);
+               if (strlen(*tmp) > 0 && (*tmp)[strlen(*tmp) - 1] == '\\') {
+                       wa.append("\\");
+               }
                wa.append("\"");
                tmp++;
        }
@@ -370,6 +427,9 @@ void
 SystemExec::terminate ()
 {
        ::pthread_mutex_lock(&write_lock);
+
+       close_stdin();
+
        if (pid) {
                /* terminate */
                EnumWindows(my_terminateApp, (LPARAM)pid->dwProcessId);
@@ -393,8 +453,7 @@ int
 SystemExec::wait (int options)
 {
        while (is_running()) {
-               WaitForSingleObject(pid->hProcess, INFINITE);
-               Sleep(20);
+               WaitForSingleObject(pid->hProcess, 40);
        }
        return 0;
 }
@@ -402,11 +461,16 @@ SystemExec::wait (int options)
 bool
 SystemExec::is_running ()
 {
-       return pid?true:false;
+       if (!pid) return false;
+       DWORD exit_code;
+       if (GetExitCodeProcess(pid->hProcess, &exit_code)) {
+               if (exit_code == STILL_ACTIVE) return true;
+       }
+       return false;
 }
 
 int
-SystemExec::start (int stderr_mode)
+SystemExec::start (int stderr_mode, const char * /*vfork_exec_wrapper*/)
 {
        char* working_dir = 0;
 
@@ -496,12 +560,17 @@ SystemExec::output_interposer()
                if (bytesAvail < 1) {Sleep(500); printf("N/A\n"); continue;}
 #endif
                if (stdoutP[0] == INVALID_HANDLE_VALUE) break;
-               if (!ReadFile(stdoutP[0], data, BUFSIZ, &bytesRead, 0)) break;
+               if (!ReadFile(stdoutP[0], data, BUFSIZ, &bytesRead, 0)) {
+                       DWORD err =  GetLastError();
+                       if (err == ERROR_IO_PENDING) continue;
+                       break;
+               }
                if (bytesRead < 1) continue; /* actually not needed; but this is safe. */
                data[bytesRead] = 0;
                ReadStdout(data, bytesRead);/* EMIT SIGNAL */
        }
        Terminated();/* EMIT SIGNAL */
+       pthread_exit(0);
 }
 
 void
@@ -612,7 +681,7 @@ SystemExec::terminate ()
        close_stdin();
 
        if (pid) {
-               ::usleep(50000);
+               ::usleep(200000);
                sched_yield();
                wait(WNOHANG);
        }
@@ -620,10 +689,10 @@ SystemExec::terminate ()
        /* if pid is non-zero, the child task is still executing (i.e. it did
         * not exit in response to stdin being closed). try to kill it.
         */
-       
+
        if (pid) {
                ::kill(pid, SIGTERM);
-               ::usleep(50000);
+               ::usleep(250000);
                sched_yield();
                wait(WNOHANG);
        }
@@ -640,6 +709,7 @@ SystemExec::terminate ()
        wait();
        if (thread_active) pthread_join(thread_id_tt, NULL);
        thread_active = false;
+       assert(pid == 0);
        ::pthread_mutex_unlock(&write_lock);
 }
 
@@ -678,7 +748,7 @@ SystemExec::is_running ()
 }
 
 int
-SystemExec::start (int stderr_mode)
+SystemExec::start (int stderr_mode, const char *vfork_exec_wrapper)
 {
        if (is_running()) {
                return 0; // mmh what to return here?
@@ -690,7 +760,11 @@ SystemExec::start (int stderr_mode)
                return -1;
        }
 
+#ifndef NO_VFORK
+       r = ::vfork();
+#else
        r = ::fork();
+#endif
        if (r < 0) {
                /* failed to fork */
                return -2;
@@ -709,11 +783,11 @@ SystemExec::start (int stderr_mode)
                                /* child process returned from execve */
                                pid=0;
                                close_fd(pok[0]);
+                               close_fd(pok[1]);
                                close_fd(pin[1]);
                                close_fd(pin[0]);
                                close_fd(pout[1]);
                                close_fd(pout[0]);
-                               pin[1] = -1;
                                return -3;
                        } else if ( n==-1 ) {
                                 if ( errno==EAGAIN || errno==EINTR )
@@ -724,28 +798,6 @@ SystemExec::start (int stderr_mode)
                close_fd(pok[0]);
                /* child started successfully */
 
-#if 0
-/* use fork for output-interposer
- * it will run in a separated process
- */
-               /* catch stdout thread */
-               r = ::fork();
-               if (r < 0) {
-                       // failed to fork
-                       terminate();
-                       return -2;
-               }
-               if (r == 0) {
-                       /* 2nd child process - catch stdout */
-                       close_fd(pin[1]);
-                       close_fd(pout[1]);
-                       output_interposer();
-                       exit(0);
-               }
-               close_fd(pout[1]);
-               close_fd(pin[0]);
-               close_fd(pout[0]);
-#else /* use pthread */
                close_fd(pout[1]);
                close_fd(pin[0]);
                int rv = pthread_create(&thread_id_tt, NULL, interposer_thread, this);
@@ -756,10 +808,10 @@ SystemExec::start (int stderr_mode)
                        terminate();
                        return -2;
                }
-#endif
                return 0; /* all systems go - return to main */
        }
 
+#ifdef NO_VFORK
        /* child process - exec external process */
        close_fd(pok[0]);
        ::fcntl(pok[1], F_SETFD, FD_CLOEXEC);
@@ -794,23 +846,17 @@ SystemExec::start (int stderr_mode)
                ::nice(nicelevel);
        }
 
-#if 0
-       /* chdir to executable dir */
-       char *directory;
-       directory = strdup(cmd.c_str());
-       if (strrchr(directory, '/') != (char *) 0) {
-               ::chdir(directory);
-       }
-       free(directory);
-#endif
-
 #ifdef HAVE_SIGSET
        sigset(SIGPIPE, SIG_DFL);
 #else
        signal(SIGPIPE, SIG_DFL);
 #endif
+       if (!vfork_exec_wrapper) {
+               error << _("Cannot start external process, no vfork wrapper") << endmsg;
+               return -1;
+       }
 
-       int good_fds[1] = { -1 };
+       int good_fds[2] = { pok[1],  -1 };
        close_allv(good_fds);
 
        ::execve(argp[0], argp, envp);
@@ -820,6 +866,42 @@ SystemExec::start (int stderr_mode)
        close_fd(pok[1]);
        exit(-1);
        return -1;
+#else
+
+       /* XXX this should be done before vfork()
+        * calling malloc here only increases the time vfork() blocks
+        */
+       int argn = 0;
+       for (int i=0;argp[i];++i) { argn++; }
+       char **argx = (char **) malloc((argn + 10) * sizeof(char *));
+       argx[0] = strdup(vfork_exec_wrapper); // XXX
+
+#define FDARG(NUM, FDN) \
+       argx[NUM] = (char*) calloc(6, sizeof(char)); snprintf(argx[NUM], 6, "%d", FDN);
+
+       FDARG(1, pok[0])
+       FDARG(2, pok[1])
+       FDARG(3, pin[0])
+       FDARG(4, pin[1])
+       FDARG(5, pout[0])
+       FDARG(6, pout[1])
+       FDARG(7, stderr_mode)
+       FDARG(8, nicelevel)
+
+       for (int i=0;argp[i];++i) {
+               argx[9+i] = argp[i];
+       }
+       argx[argn+9] = NULL;
+
+       ::execve(argx[0], argx, envp);
+
+       /* if we reach here something went wrong.. */
+       char buf = 0;
+       (void) ::write(pok[1], &buf, 1 );
+       close_fd(pok[1]);
+       exit(-1);
+       return -1;
+#endif
 }
 
 void
@@ -835,7 +917,16 @@ SystemExec::output_interposer()
        for (;fcntl(rfd, F_GETFL)!=-1;) {
                r = read(rfd, buf, sizeof(buf));
                if (r < 0 && (errno == EINTR || errno == EAGAIN)) {
-                       ::usleep(1000);
+                       fd_set rfds;
+                       struct timeval tv;
+                       FD_ZERO(&rfds);
+                       FD_SET(rfd, &rfds);
+                       tv.tv_sec = 0;
+                       tv.tv_usec = 10000;
+                       int rv = select(1, &rfds, NULL, NULL, &tv);
+                       if (rv == -1) {
+                               break;
+                       }
                        continue;
                }
                if (r <= 0) {
@@ -846,6 +937,7 @@ SystemExec::output_interposer()
                ReadStdout(rv, r);/* EMIT SIGNAL */
        }
        Terminated();/* EMIT SIGNAL */
+       pthread_exit(0);
 }
 
 void