/////////////////////////////////////////////////////////////////////////////
// Name: src/unix/utilsunx.cpp
-// Purpose: generic Unix implementation of many wx functions
+// Purpose: generic Unix implementation of many wx functions (for wxBase)
// Author: Vadim Zeitlin
// Id: $Id$
// Copyright: (c) 1998 Robert Roebling, Vadim Zeitlin
+// (c) 2013 Rob Bresalier, Vadim Zeitlin
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#include "wx/apptrait.h"
#include "wx/process.h"
+#include "wx/scopedptr.h"
#include "wx/thread.h"
+#include "wx/cmdline.h"
+
#include "wx/wfstream.h"
+#include "wx/private/selectdispatcher.h"
+#include "wx/private/fdiodispatcher.h"
#include "wx/unix/execute.h"
#include "wx/unix/private.h"
+#include "wx/evtloop.h"
+#include "wx/mstream.h"
+#include "wx/private/fdioeventloopsourcehandler.h"
+
#include <pwd.h>
#include <sys/wait.h> // waitpid()
# include <sys/select.h>
#endif
-#define HAS_PIPE_INPUT_STREAM (wxUSE_STREAMS && wxUSE_FILE)
-
-#if HAS_PIPE_INPUT_STREAM
-
-// define this to let wxexec.cpp know that we know what we're doing
-#define _WX_USED_BY_WXEXECUTE_
-#include "../common/execcmn.cpp"
-
-#endif // HAS_PIPE_INPUT_STREAM
+#define HAS_PIPE_STREAMS (wxUSE_STREAMS && wxUSE_FILE)
-#if wxUSE_BASE
+#if HAS_PIPE_STREAMS
-#if defined(__MWERKS__) && defined(__MACH__)
- #ifndef WXWIN_OS_DESCRIPTION
- #define WXWIN_OS_DESCRIPTION "MacOS X"
- #endif
- #ifndef HAVE_NANOSLEEP
- #define HAVE_NANOSLEEP
- #endif
- #ifndef HAVE_UNAME
- #define HAVE_UNAME
- #endif
+#include "wx/private/pipestream.h"
+#include "wx/private/streamtempinput.h"
+#include "wx/unix/private/executeiohandler.h"
- // our configure test believes we can use sigaction() if the function is
- // available but Metrowekrs with MSL run-time does have the function but
- // doesn't have sigaction struct so finally we can't use it...
- #ifdef __MSL__
- #undef wxUSE_ON_FATAL_EXCEPTION
- #define wxUSE_ON_FATAL_EXCEPTION 0
- #endif
-#endif
+#endif // HAS_PIPE_STREAMS
// not only the statfs syscall is called differently depending on platform, but
// one of its incarnations, statvfs(), takes different arguments under
#include <errno.h>
#include <netdb.h>
#include <signal.h>
-#include <fcntl.h> // for O_WRONLY and friends
#include <time.h> // nanosleep() and/or usleep()
#include <ctype.h> // isspace()
#include <sys/time.h> // needed for FD_SETSIZE
#include <sys/sysinfo.h> // for SAGET and MINFO structures
#endif
+#ifdef HAVE_SETPRIORITY
+ #include <sys/resource.h> // for setpriority()
+#endif
+
// ----------------------------------------------------------------------------
// conditional compilation
// ----------------------------------------------------------------------------
tmReq.tv_nsec = (microseconds % 1000000) * 1000;
// we're not interested in remaining time nor in return value
- (void)nanosleep(&tmReq, (timespec *)NULL);
+ (void)nanosleep(&tmReq, NULL);
#elif defined(HAVE_USLEEP)
// uncomment this if you feel brave or if you are sure that your version
// of Solaris has a safe usleep() function but please notice that usleep()
default:
// this goes against Unix98 docs so log it
- wxLogDebug(_T("unexpected kill(2) return value %d"), err);
+ wxLogDebug(wxT("unexpected kill(2) return value %d"), err);
// something else...
*rc = wxKILL_ERROR;
return err;
}
-#define WXEXECUTE_NARGS 127
+// Shutdown or reboot the PC
+bool wxShutdown(int flags)
+{
+ flags &= ~wxSHUTDOWN_FORCE;
-#if defined(__DARWIN__)
-long wxMacExecute(wxChar **argv,
- int flags,
- wxProcess *process);
-#endif
+ wxChar level;
+ switch ( flags )
+ {
+ case wxSHUTDOWN_POWEROFF:
+ level = wxT('0');
+ break;
-long wxExecute( const wxString& command, int flags, wxProcess *process )
-{
- wxCHECK_MSG( !command.empty(), 0, wxT("can't exec empty command") );
+ case wxSHUTDOWN_REBOOT:
+ level = wxT('6');
+ break;
- wxLogTrace(wxT("exec"), wxT("Executing \"%s\""), command.c_str());
+ case wxSHUTDOWN_LOGOFF:
+ // TODO: use dcop to log off?
+ return false;
-#if wxUSE_THREADS
- // fork() doesn't mix well with POSIX threads: on many systems the program
- // deadlocks or crashes for some reason. Probably our code is buggy and
- // doesn't do something which must be done to allow this to work, but I
- // don't know what yet, so for now just warn the user (this is the least we
- // can do) about it
- wxASSERT_MSG( wxThread::IsMain(),
- _T("wxExecute() can be called only from the main thread") );
-#endif // wxUSE_THREADS
+ default:
+ wxFAIL_MSG( wxT("unknown wxShutdown() flag") );
+ return false;
+ }
- int argc = 0;
- wxChar *argv[WXEXECUTE_NARGS];
- wxString argument;
- const wxChar *cptr = command.c_str();
- wxChar quotechar = wxT('\0'); // is arg quoted?
- bool escaped = false;
+ return system(wxString::Format("init %c", level).mb_str()) == 0;
+}
- // split the command line in arguments
- do
- {
- argument = wxEmptyString;
- quotechar = wxT('\0');
+// ----------------------------------------------------------------------------
+// wxStream classes to support IO redirection in wxExecute
+// ----------------------------------------------------------------------------
- // eat leading whitespace:
- while ( wxIsspace(*cptr) )
- cptr++;
+#if HAS_PIPE_STREAMS
- if ( *cptr == wxT('\'') || *cptr == wxT('"') )
- quotechar = *cptr++;
+bool wxPipeInputStream::CanRead() const
+{
+ if ( m_lasterror == wxSTREAM_EOF )
+ return false;
- do
- {
- if ( *cptr == wxT('\\') && ! escaped )
- {
- escaped = true;
- cptr++;
- continue;
- }
+ // check if there is any input available
+ struct timeval tv;
+ tv.tv_sec = 0;
+ tv.tv_usec = 0;
- // all other characters:
- argument += *cptr++;
- escaped = false;
+ const int fd = m_file->fd();
- // have we reached the end of the argument?
- if ( (*cptr == quotechar && ! escaped)
- || (quotechar == wxT('\0') && wxIsspace(*cptr))
- || *cptr == wxT('\0') )
- {
- wxASSERT_MSG( argc < WXEXECUTE_NARGS,
- wxT("too many arguments in wxExecute") );
+ fd_set readfds;
- argv[argc] = new wxChar[argument.length() + 1];
- wxStrcpy(argv[argc], argument.c_str());
- argc++;
+ wxFD_ZERO(&readfds);
+ wxFD_SET(fd, &readfds);
- // if not at end of buffer, swallow last character:
- if(*cptr)
- cptr++;
+ switch ( select(fd + 1, &readfds, NULL, NULL, &tv) )
+ {
+ case -1:
+ wxLogSysError(_("Impossible to get child process input"));
+ // fall through
- break; // done with this one, start over
- }
- } while(*cptr);
- } while(*cptr);
- argv[argc] = NULL;
+ case 0:
+ return false;
- long lRc;
-#if defined(__DARWIN__)
- // wxMacExecute only executes app bundles.
- // It returns an error code if the target is not an app bundle, thus falling
- // through to the regular wxExecute for non app bundles.
- lRc = wxMacExecute(argv, flags, process);
- if( lRc != ((flags & wxEXEC_SYNC) ? -1 : 0))
- return lRc;
-#endif
+ default:
+ wxFAIL_MSG(wxT("unexpected select() return value"));
+ // still fall through
- // do execute the command
- lRc = wxExecute(argv, flags, process);
+ case 1:
+ // input available -- or maybe not, as select() returns 1 when a
+ // read() will complete without delay, but it could still not read
+ // anything
+ return !Eof();
+ }
+}
- // clean up
- argc = 0;
- while( argv[argc] )
- delete [] argv[argc++];
+size_t wxPipeOutputStream::OnSysWrite(const void *buffer, size_t size)
+{
+ // We need to suppress error logging here, because on writing to a pipe
+ // which is full, wxFile::Write reports a system error. However, this is
+ // not an extraordinary situation, and it should not be reported to the
+ // user (but if really needed, the program can recognize it by checking
+ // whether LastRead() == 0.) Other errors will be reported below.
+ size_t ret;
+ {
+ wxLogNull logNo;
+ ret = m_file->Write(buffer, size);
+ }
- return lRc;
+ switch ( m_file->GetLastError() )
+ {
+ // pipe is full
+#ifdef EAGAIN
+ case EAGAIN:
+#endif
+#if defined(EWOULDBLOCK) && (EWOULDBLOCK != EAGAIN)
+ case EWOULDBLOCK:
+#endif
+ // do not treat it as an error
+ m_file->ClearLastError();
+ // fall through
+
+ // no error
+ case 0:
+ break;
+
+ // some real error
+ default:
+ wxLogSysError(_("Can't write to child process's stdin"));
+ m_lasterror = wxSTREAM_WRITE_ERROR;
+ }
+
+ return ret;
}
+#endif // HAS_PIPE_STREAMS
+
// ----------------------------------------------------------------------------
// wxShell
// ----------------------------------------------------------------------------
if ( !command )
{
// just an interactive shell
- cmd = _T("xterm");
+ cmd = wxT("xterm");
}
else
{
// execute command in a shell
- cmd << _T("/bin/sh -c '") << command << _T('\'');
+ cmd << wxT("/bin/sh -c '") << command << wxT('\'');
}
return cmd;
bool wxShell(const wxString& command, wxArrayString& output)
{
- wxCHECK_MSG( !command.empty(), false, _T("can't exec shell non interactively") );
+ wxCHECK_MSG( !command.empty(), false, wxT("can't exec shell non interactively") );
return wxExecute(wxMakeShellCommand(command), output);
}
-// Shutdown or reboot the PC
-bool wxShutdown(wxShutdownFlags wFlags)
+namespace
{
- wxChar level;
- switch ( wFlags )
+
+// helper class for storing arguments as char** array suitable for passing to
+// execvp(), whatever form they were passed to us
+class ArgsArray
+{
+public:
+ ArgsArray(const wxArrayString& args)
{
- case wxSHUTDOWN_POWEROFF:
- level = _T('0');
- break;
+ Init(args.size());
- case wxSHUTDOWN_REBOOT:
- level = _T('6');
- break;
+ for ( int i = 0; i < m_argc; i++ )
+ {
+ m_argv[i] = wxStrdup(args[i]);
+ }
+ }
- default:
- wxFAIL_MSG( _T("unknown wxShutdown() flag") );
- return false;
+#if wxUSE_UNICODE
+ ArgsArray(wchar_t **wargv)
+ {
+ int argc = 0;
+ while ( wargv[argc] )
+ argc++;
+
+ Init(argc);
+
+ for ( int i = 0; i < m_argc; i++ )
+ {
+ m_argv[i] = wxSafeConvertWX2MB(wargv[i]).release();
+ }
}
+#endif // wxUSE_UNICODE
- return system(wxString::Format(_T("init %c"), level).mb_str()) == 0;
-}
+ ~ArgsArray()
+ {
+ for ( int i = 0; i < m_argc; i++ )
+ {
+ free(m_argv[i]);
+ }
+
+ delete [] m_argv;
+ }
+
+ operator char**() const { return m_argv; }
+
+private:
+ void Init(int argc)
+ {
+ m_argc = argc;
+ m_argv = new char *[m_argc + 1];
+ m_argv[m_argc] = NULL;
+ }
+
+ int m_argc;
+ char **m_argv;
+
+ wxDECLARE_NO_COPY_CLASS(ArgsArray);
+};
+
+} // anonymous namespace
// ----------------------------------------------------------------------------
-// wxStream classes to support IO redirection in wxExecute
+// wxExecute implementations
// ----------------------------------------------------------------------------
-#if HAS_PIPE_INPUT_STREAM
+#if defined(__DARWIN__)
+bool wxMacLaunch(char **argv);
+#endif
-bool wxPipeInputStream::CanRead() const
+long wxExecute(const wxString& command, int flags, wxProcess *process,
+ const wxExecuteEnv *env)
{
- if ( m_lasterror == wxSTREAM_EOF )
- return false;
+ ArgsArray argv(wxCmdLineParser::ConvertStringToArgs(command,
+ wxCMD_LINE_SPLIT_UNIX));
- // check if there is any input available
- struct timeval tv;
- tv.tv_sec = 0;
- tv.tv_usec = 0;
+ return wxExecute(argv, flags, process, env);
+}
- const int fd = m_file->fd();
+#if wxUSE_UNICODE
- fd_set readfds;
+long wxExecute(wchar_t **wargv, int flags, wxProcess *process,
+ const wxExecuteEnv *env)
+{
+ ArgsArray argv(wargv);
- wxFD_ZERO(&readfds);
- wxFD_SET(fd, &readfds);
+ return wxExecute(argv, flags, process, env);
+}
- switch ( select(fd + 1, &readfds, NULL, NULL, &tv) )
- {
- case -1:
- wxLogSysError(_("Impossible to get child process input"));
- // fall through
+#endif // wxUSE_UNICODE
- case 0:
- return false;
+namespace
+{
- default:
- wxFAIL_MSG(_T("unexpected select() return value"));
- // still fall through
+// Helper function of wxExecute(): wait for the process termination without
+// dispatching any events.
+//
+// This is used in wxEXEC_NOEVENTS case.
+int BlockUntilChildExit(wxExecuteData& execData)
+{
+ wxCHECK_MSG( wxTheApp, -1,
+ wxS("Can't block until child exit without wxTheApp") );
+
+ // Even if we don't want to dispatch events, we still need to handle
+ // child IO notifications and process termination concurrently, i.e.
+ // we can't simply block waiting for the child to terminate as we would
+ // dead lock if it writes more than the pipe buffer size (typically
+ // 4KB) bytes of output -- it would then block waiting for us to read
+ // the data while we'd block waiting for it to terminate.
+ //
+ // So while we don't use the full blown event loop, we still do use a
+ // dispatcher with which we register just the 3 FDs we're interested
+ // in: the child stdout and stderr and the pipe written to by the
+ // signal handler so that we could react to the child process
+ // termination too.
+
+ // Notice that we must create a new dispatcher object here instead of
+ // reusing the global wxFDIODispatcher::Get() because we want to
+ // monitor only the events on the FDs explicitly registered with this
+ // one and not all the other ones that could be registered with the
+ // global dispatcher (think about the case of nested wxExecute() calls).
+ wxSelectDispatcher dispatcher;
+
+ // Do register all the FDs we want to monitor here: first, the one used to
+ // handle the signals asynchronously.
+ wxScopedPtr<wxFDIOHandler>
+ signalHandler(wxTheApp->RegisterSignalWakeUpPipe(dispatcher));
+
+#if wxUSE_STREAMS
+ // And then the two for the child output and error streams if necessary.
+ wxScopedPtr<wxFDIOHandler>
+ stdoutHandler,
+ stderrHandler;
+ if ( execData.IsRedirected() )
+ {
+ stdoutHandler.reset(new wxExecuteFDIOHandler
+ (
+ dispatcher,
+ execData.fdOut,
+ execData.bufOut
+ ));
+ stderrHandler.reset(new wxExecuteFDIOHandler
+ (
+ dispatcher,
+ execData.fdErr,
+ execData.bufErr
+ ));
+ }
+#endif // wxUSE_STREAMS
- case 1:
- // input available -- or maybe not, as select() returns 1 when a
- // read() will complete without delay, but it could still not read
- // anything
- return !Eof();
+ // And dispatch until the PID is reset from wxExecuteData::OnExit().
+ while ( execData.pid )
+ {
+ dispatcher.Dispatch();
}
+
+ return execData.exitcode;
}
-#endif // HAS_PIPE_INPUT_STREAM
+} // anonymous namespace
-// ----------------------------------------------------------------------------
// wxExecute: the real worker function
-// ----------------------------------------------------------------------------
-
-long wxExecute(wxChar **argv, int flags, wxProcess *process)
+long wxExecute(char **argv, int flags, wxProcess *process,
+ const wxExecuteEnv *env)
{
// for the sync execution, we return -1 to indicate failure, but for async
// case we return 0 which is never a valid PID
wxCHECK_MSG( *argv, ERROR_RETURN_CODE, wxT("can't exec empty command") );
-#if wxUSE_UNICODE
- int mb_argc = 0;
- char *mb_argv[WXEXECUTE_NARGS];
+#if wxUSE_THREADS
+ // fork() doesn't mix well with POSIX threads: on many systems the program
+ // deadlocks or crashes for some reason. Probably our code is buggy and
+ // doesn't do something which must be done to allow this to work, but I
+ // don't know what yet, so for now just warn the user (this is the least we
+ // can do) about it
+ wxASSERT_MSG( wxThread::IsMain(),
+ wxT("wxExecute() can be called only from the main thread") );
+#endif // wxUSE_THREADS
- while (argv[mb_argc])
+#if defined(__WXCOCOA__) || ( defined(__WXOSX_MAC__) && wxOSX_USE_COCOA_OR_CARBON )
+ // wxMacLaunch() only executes app bundles and only does it asynchronously.
+ // It returns false if the target is not an app bundle, thus falling
+ // through to the regular code for non app bundles.
+ if ( !(flags & wxEXEC_SYNC) && wxMacLaunch(argv) )
{
- wxWX2MBbuf mb_arg = wxSafeConvertWX2MB(argv[mb_argc]);
- mb_argv[mb_argc] = strdup(mb_arg);
- mb_argc++;
+ // we don't have any PID to return so just make up something non null
+ return -1;
}
- mb_argv[mb_argc] = (char *) NULL;
-
- // this macro will free memory we used above
- #define ARGS_CLEANUP \
- for ( mb_argc = 0; mb_argv[mb_argc]; mb_argc++ ) \
- free(mb_argv[mb_argc])
-#else // ANSI
- // no need for cleanup
- #define ARGS_CLEANUP
-
- wxChar **mb_argv = argv;
-#endif // Unicode/ANSI
-
- // we want this function to work even if there is no wxApp so ensure that
- // we have a valid traits pointer
- wxConsoleAppTraits traitsConsole;
- wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
- if ( !traits )
- traits = &traitsConsole;
-
- // this struct contains all information which we pass to and from
- // wxAppTraits methods
- wxExecuteData execData;
- execData.flags = flags;
- execData.process = process;
-
- // create pipes
- if ( !traits->CreateEndProcessPipe(execData) )
- {
- wxLogError( _("Failed to execute '%s'\n"), *argv );
+#endif // __DARWIN__
- ARGS_CLEANUP;
+ // this struct contains all information which we use for housekeeping
+ wxScopedPtr<wxExecuteData> execDataPtr(new wxExecuteData);
+ wxExecuteData& execData = *execDataPtr;
- return ERROR_RETURN_CODE;
- }
+ execData.flags = flags;
+ execData.process = process;
- // pipes for inter process communication
+ // create pipes for inter process communication
wxPipe pipeIn, // stdin
pipeOut, // stdout
pipeErr; // stderr
{
wxLogError( _("Failed to execute '%s'\n"), *argv );
- ARGS_CLEANUP;
-
return ERROR_RETURN_CODE;
}
}
+ // priority: we need to map wxWidgets priority which is in the range 0..100
+ // to Unix nice value which is in the range -20..19. As there is an odd
+ // number of elements in our range and an even number in the Unix one, we
+ // have to do it in this rather ugly way to guarantee that:
+ // 1. wxPRIORITY_{MIN,DEFAULT,MAX} map to -20, 0 and 19 respectively.
+ // 2. The mapping is monotonously increasing.
+ // 3. The mapping is onto the target range.
+ int prio = process ? process->GetPriority() : 0;
+ if ( prio <= 50 )
+ prio = (2*prio)/5 - 20;
+ else if ( prio < 55 )
+ prio = 1;
+ else
+ prio = (2*prio)/5 - 21;
+
// fork the process
//
// NB: do *not* use vfork() here, it completely breaks this code for some
{
wxLogSysError( _("Fork failed") );
- ARGS_CLEANUP;
-
return ERROR_RETURN_CODE;
}
else if ( pid == 0 ) // we're in child
{
- // These lines close the open file descriptors to to avoid any
- // input/output which might block the process or irritate the user. If
- // one wants proper IO for the subprocess, the right thing to do is to
- // start an xterm executing it.
- if ( !(flags & wxEXEC_SYNC) )
- {
- // FD_SETSIZE is unsigned under BSD, signed under other platforms
- // so we need a cast to avoid warnings on all platforms
- for ( int fd = 0; fd < (int)FD_SETSIZE; fd++ )
- {
- if ( fd == pipeIn[wxPipe::Read]
- || fd == pipeOut[wxPipe::Write]
- || fd == pipeErr[wxPipe::Write]
- || traits->IsWriteFDOfEndProcessPipe(execData, fd) )
- {
- // don't close this one, we still need it
- continue;
- }
-
- // leave stderr opened too, it won't do any harm
- if ( fd != STDERR_FILENO )
- close(fd);
- }
- }
+ // NB: we used to close all the unused descriptors of the child here
+ // but this broke some programs which relied on e.g. FD 1 being
+ // always opened so don't do it any more, after all there doesn't
+ // seem to be any real problem with keeping them opened
#if !defined(__VMS) && !defined(__EMX__)
if ( flags & wxEXEC_MAKE_GROUP_LEADER )
}
#endif // !__VMS
- // reading side can be safely closed but we should keep the write one
- // opened
- traits->DetachWriteFDOfEndProcessPipe(execData);
+#if defined(HAVE_SETPRIORITY)
+ if ( prio && setpriority(PRIO_PROCESS, 0, prio) != 0 )
+ {
+ wxLogSysError(_("Failed to set process priority"));
+ }
+#endif // HAVE_SETPRIORITY
// redirect stdin, stdout and stderr
if ( pipeIn.IsOk() )
pipeErr.Close();
}
- execvp (*mb_argv, mb_argv);
+ // Close all (presumably accidentally) inherited file descriptors to
+ // avoid descriptor leaks. This means that we don't allow inheriting
+ // them purposefully but this seems like a lesser evil in wx code.
+ // Ideally we'd provide some flag to indicate that none (or some?) of
+ // the descriptors do not need to be closed but for now this is better
+ // than never closing them at all as wx code never used FD_CLOEXEC.
+
+ // TODO: Iterating up to FD_SETSIZE is both inefficient (because it may
+ // be quite big) and incorrect (because in principle we could
+ // have more opened descriptions than this number). Unfortunately
+ // there is no good portable solution for closing all descriptors
+ // above a certain threshold but non-portable solutions exist for
+ // most platforms, see [http://stackoverflow.com/questions/899038/
+ // getting-the-highest-allocated-file-descriptor]
+ for ( int fd = 0; fd < (int)FD_SETSIZE; ++fd )
+ {
+ if ( fd != STDIN_FILENO &&
+ fd != STDOUT_FILENO &&
+ fd != STDERR_FILENO )
+ {
+ close(fd);
+ }
+ }
+
+
+ // Process additional options if we have any
+ if ( env )
+ {
+ // Change working directory if it is specified
+ if ( !env->cwd.empty() )
+ wxSetWorkingDirectory(env->cwd);
+
+ // Change environment if needed.
+ //
+ // NB: We can't use execve() currently because we allow using
+ // non full paths to wxExecute(), i.e. we want to search for
+ // the program in PATH. However it just might be simpler/better
+ // to do the search manually and use execve() envp parameter to
+ // set up the environment of the child process explicitly
+ // instead of doing what we do below.
+ if ( !env->env.empty() )
+ {
+ wxEnvVariableHashMap oldenv;
+ wxGetEnvMap(&oldenv);
+
+ // Remove unwanted variables
+ wxEnvVariableHashMap::const_iterator it;
+ for ( it = oldenv.begin(); it != oldenv.end(); ++it )
+ {
+ if ( env->env.find(it->first) == env->env.end() )
+ wxUnsetEnv(it->first);
+ }
+
+ // And add the new ones (possibly replacing the old values)
+ for ( it = env->env.begin(); it != env->env.end(); ++it )
+ wxSetEnv(it->first, it->second);
+ }
+ }
+
+ execvp(*argv, argv);
fprintf(stderr, "execvp(");
- // CS changed ppc to ppc_ as ppc is not available under mac os CW Mach-O
- for ( char **ppc_ = mb_argv; *ppc_; ppc_++ )
- fprintf(stderr, "%s%s", ppc_ == mb_argv ? "" : ", ", *ppc_);
+ for ( char **a = argv; *a; a++ )
+ fprintf(stderr, "%s%s", a == argv ? "" : ", ", *a);
fprintf(stderr, ") failed with error %d!\n", errno);
// there is no return after successful exec()
}
else // we're in parent
{
- ARGS_CLEANUP;
-
- // save it for WaitForChild() use
- execData.pid = pid;
+ execData.OnStart(pid);
// prepare for IO redirection
-#if HAS_PIPE_INPUT_STREAM
- // the input buffer bufOut is connected to stdout, this is why it is
- // called bufOut and not bufIn
- wxStreamTempInputBuffer bufOut,
- bufErr;
-#endif // HAS_PIPE_INPUT_STREAM
+#if HAS_PIPE_STREAMS
if ( process && process->IsRedirected() )
{
-#if HAS_PIPE_INPUT_STREAM
+ // Avoid deadlocks which could result from trying to write to the
+ // child input pipe end while the child itself is writing to its
+ // output end and waiting for us to read from it.
+ if ( !pipeIn.MakeNonBlocking(wxPipe::Write) )
+ {
+ // This message is not terrible useful for the user but what
+ // else can we do? Also, should we fail here or take the risk
+ // to continue and deadlock? Currently we choose the latter but
+ // it might not be the best idea.
+ wxLogSysError(_("Failed to set up non-blocking pipe, "
+ "the program might hang."));
+#if wxUSE_LOG
+ wxLog::FlushActive();
+#endif
+ }
+
wxOutputStream *inStream =
- new wxFileOutputStream(pipeIn.Detach(wxPipe::Write));
+ new wxPipeOutputStream(pipeIn.Detach(wxPipe::Write));
- wxPipeInputStream *outStream =
- new wxPipeInputStream(pipeOut.Detach(wxPipe::Read));
+ const int fdOut = pipeOut.Detach(wxPipe::Read);
+ wxPipeInputStream *outStream = new wxPipeInputStream(fdOut);
- wxPipeInputStream *errStream =
- new wxPipeInputStream(pipeErr.Detach(wxPipe::Read));
+ const int fdErr = pipeErr.Detach(wxPipe::Read);
+ wxPipeInputStream *errStream = new wxPipeInputStream(fdErr);
process->SetPipeStreams(outStream, inStream, errStream);
- bufOut.Init(outStream);
- bufErr.Init(errStream);
+ if ( flags & wxEXEC_SYNC )
+ {
+ execData.bufOut.Init(outStream);
+ execData.bufErr.Init(errStream);
- execData.bufOut = &bufOut;
- execData.bufErr = &bufErr;
-#endif // HAS_PIPE_INPUT_STREAM
+ execData.fdOut = fdOut;
+ execData.fdErr = fdErr;
+ }
}
+#endif // HAS_PIPE_STREAMS
if ( pipeIn.IsOk() )
{
pipeErr.Close();
}
- return traits->WaitForChild(execData);
+ // For the asynchronous case we don't have to do anything else, just
+ // let the process run.
+ if ( !(flags & wxEXEC_SYNC) )
+ {
+ // Ensure that the housekeeping data is kept alive, it will be
+ // destroyed only when the child terminates.
+ execDataPtr.release();
+
+ return execData.pid;
+ }
+
+
+ // If we don't need to dispatch any events, things are relatively
+ // simple and we don't need to delegate to wxAppTraits.
+ if ( flags & wxEXEC_NOEVENTS )
+ {
+ return BlockUntilChildExit(execData);
+ }
+
+
+ // If we do need to dispatch events, enter a local event loop waiting
+ // until the child exits. As the exact kind of event loop depends on
+ // the sort of application we're in (console or GUI), we delegate this
+ // to wxAppTraits which virtualizes all the differences between the
+ // console and the GUI programs.
+ return wxApp::GetValidTraits().WaitForChild(execData);
}
#if !defined(__VMS) && !defined(__INTEL_COMPILER)
}
#undef ERROR_RETURN_CODE
-#undef ARGS_CLEANUP
// ----------------------------------------------------------------------------
// file and directory functions
// the trailing newline
static wxString wxGetCommandOutput(const wxString &cmd)
{
- FILE *f = popen(cmd.ToAscii(), "r");
+ // Suppress stderr from the shell to avoid outputting errors if the command
+ // doesn't exist.
+ FILE *f = popen((cmd + " 2>/dev/null").ToAscii(), "r");
if ( !f )
{
- wxLogSysError(_T("Executing \"%s\" failed"), cmd.c_str());
- return wxEmptyString;
+ // Notice that this doesn't happen simply if the command doesn't exist,
+ // but only in case of some really catastrophic failure inside popen()
+ // so we should really notify the user about this as this is not normal.
+ wxLogSysError(wxT("Executing \"%s\" failed"), cmd);
+ return wxString();
}
wxString s;
pclose(f);
- if ( !s.empty() && s.Last() == _T('\n') )
+ if ( !s.empty() && s.Last() == wxT('\n') )
s.RemoveLast();
return s;
bool ok = uname(&uts) != -1;
if ( ok )
{
- wxStrncpy(buf, wxSafeConvertMB2WX(uts.nodename), sz - 1);
- buf[sz] = wxT('\0');
+ wxStrlcpy(buf, wxSafeConvertMB2WX(uts.nodename), sz);
}
#elif defined(HAVE_GETHOSTNAME)
char cbuf[sz];
bool ok = gethostname(cbuf, sz) != -1;
if ( ok )
{
- wxStrncpy(buf, wxSafeConvertMB2WX(cbuf), sz - 1);
- buf[sz] = wxT('\0');
+ wxStrlcpy(buf, wxSafeConvertMB2WX(cbuf), sz);
}
#else // no uname, no gethostname
wxFAIL_MSG(wxT("don't know host name for this machine"));
else
{
// the canonical name
- wxStrncpy(buf, wxSafeConvertMB2WX(host->h_name), sz);
+ wxStrlcpy(buf, wxSafeConvertMB2WX(host->h_name), sz);
}
}
//else: it's already a FQDN (BSD behaves this way)
*buf = wxT('\0');
if ((who = getpwuid(getuid ())) != NULL)
{
- wxStrncpy (buf, wxSafeConvertMB2WX(who->pw_name), sz - 1);
+ wxStrlcpy (buf, wxSafeConvertMB2WX(who->pw_name), sz);
return true;
}
char *comma = strchr(who->pw_gecos, ',');
if (comma)
*comma = '\0'; // cut off non-name comment fields
- wxStrncpy (buf, wxSafeConvertMB2WX(who->pw_gecos), sz - 1);
+ wxStrlcpy(buf, wxSafeConvertMB2WX(who->pw_gecos), sz);
return true;
}
machine.Contains(wxT("alpha"));
}
-// these functions are in mac/utils.cpp for wxMac
-#ifndef __WXMAC__
+#ifdef __LINUX__
+wxLinuxDistributionInfo wxGetLinuxDistributionInfo()
+{
+ const wxString id = wxGetCommandOutput(wxT("lsb_release --id"));
+ const wxString desc = wxGetCommandOutput(wxT("lsb_release --description"));
+ const wxString rel = wxGetCommandOutput(wxT("lsb_release --release"));
+ const wxString codename = wxGetCommandOutput(wxT("lsb_release --codename"));
+
+ wxLinuxDistributionInfo ret;
+
+ id.StartsWith("Distributor ID:\t", &ret.Id);
+ desc.StartsWith("Description:\t", &ret.Description);
+ rel.StartsWith("Release:\t", &ret.Release);
+ codename.StartsWith("Codename:\t", &ret.CodeName);
+
+ return ret;
+}
+#endif
+
+// these functions are in src/osx/utilsexc_base.cpp for wxMac
+#ifndef __DARWIN__
wxOperatingSystemId wxGetOsVersion(int *verMaj, int *verMin)
{
return wxGetCommandOutput(wxT("uname -s -r -m"));
}
-#endif // !__WXMAC__
+#endif // !__DARWIN__
unsigned long wxGetProcessId()
{
#elif defined(HAVE_PUTENV)
wxString s = variable;
if ( value )
- s << _T('=') << value;
+ s << wxT('=') << value;
// transform to ANSI
const wxWX2MBbuf p = s.mb_str();
ok &= sigaction(SIGSEGV, &act, &s_handlerSEGV) == 0;
if ( !ok )
{
- wxLogDebug(_T("Failed to install our signal handler."));
+ wxLogDebug(wxT("Failed to install our signal handler."));
}
s_savedHandlers = true;
ok &= sigaction(SIGSEGV, &s_handlerSEGV, NULL) == 0;
if ( !ok )
{
- wxLogDebug(_T("Failed to uninstall our signal handler."));
+ wxLogDebug(wxT("Failed to uninstall our signal handler."));
}
s_savedHandlers = false;
#endif // wxUSE_ON_FATAL_EXCEPTION
-#endif // wxUSE_BASE
-
-#if wxUSE_GUI
-
-#if __DARWIN__
- #include <sys/errno.h>
-#endif
// ----------------------------------------------------------------------------
// wxExecute support
// ----------------------------------------------------------------------------
-/*
- NOTE: If this proves not to work well for wxMac then move back to the old
- behavior. If, however, it proves to work just fine, nuke all of the code
- for the old behavior. I strongly suggest backporting this to 2.8 as well.
- However, beware that while you can nuke the old code here, you cannot
- nuke the wxAddProcessCallbackForPid from the 2.8 branch (found in
- utilsexc_cf since it's an exported symbol).
- */
-// #define USE_OLD_DARWIN_END_PROCESS_DETECT (defined(__DARWIN__) && defined(__WXMAC__))
-#define USE_OLD_DARWIN_END_PROCESS_DETECT 0
-
-// wxMac/wxCocoa don't use the same process end detection mechanisms so we don't
-// need wxExecute-related helpers for them
-#if !USE_OLD_DARWIN_END_PROCESS_DETECT
-
-bool wxGUIAppTraits::CreateEndProcessPipe(wxExecuteData& execData)
+int wxAppTraits::WaitForChild(wxExecuteData& execData)
{
- return execData.pipeEndProcDetect.Create();
+ wxConsoleEventLoop loop;
+ return RunLoopUntilChildExit(execData, loop);
}
-bool wxGUIAppTraits::IsWriteFDOfEndProcessPipe(wxExecuteData& execData, int fd)
+// This function is common code for both console and GUI applications and used
+// by wxExecute() to wait for the child exit while dispatching events.
+//
+// Notice that it should not be used for all the other cases, e.g. when we
+// don't need to wait for the child (wxEXEC_ASYNC) or when the events must not
+// dispatched (wxEXEC_NOEVENTS).
+int
+wxAppTraits::RunLoopUntilChildExit(wxExecuteData& execData,
+ wxEventLoopBase& loop)
{
- return fd == (execData.pipeEndProcDetect)[wxPipe::Write];
-}
+ // It is possible that wxExecuteData::OnExit() had already been called
+ // and reset the PID to 0, in which case we don't need to do anything
+ // at all.
+ if ( !execData.pid )
+ return execData.exitcode;
+
+#if wxUSE_STREAMS
+ // Monitor the child streams if necessary.
+ wxScopedPtr<wxEventLoopSourceHandler>
+ stdoutHandler,
+ stderrHandler;
+ if ( execData.IsRedirected() )
+ {
+ stdoutHandler.reset(new wxExecuteEventLoopSourceHandler
+ (
+ execData.fdOut, execData.bufOut
+ ));
+ stderrHandler.reset(new wxExecuteEventLoopSourceHandler
+ (
+ execData.fdErr, execData.bufErr
+ ));
+ }
+#endif // wxUSE_STREAMS
-void wxGUIAppTraits::DetachWriteFDOfEndProcessPipe(wxExecuteData& execData)
-{
- execData.pipeEndProcDetect.Detach(wxPipe::Write);
- execData.pipeEndProcDetect.Close();
-}
+ // Store the event loop in the data associated with the child
+ // process so that it could exit the loop when the child exits.
+ execData.syncEventLoop = &loop;
-#else // !Darwin
+ // And run it.
+ loop.Run();
-bool wxGUIAppTraits::CreateEndProcessPipe(wxExecuteData& WXUNUSED(execData))
-{
- return true;
+ // The exit code will have been set when the child termination was detected.
+ return execData.exitcode;
}
-bool
-wxGUIAppTraits::IsWriteFDOfEndProcessPipe(wxExecuteData& WXUNUSED(execData),
- int WXUNUSED(fd))
-{
- return false;
-}
+// ----------------------------------------------------------------------------
+// wxExecuteData
+// ----------------------------------------------------------------------------
-void
-wxGUIAppTraits::DetachWriteFDOfEndProcessPipe(wxExecuteData& WXUNUSED(execData))
+namespace
{
- // nothing to do here, we don't use the pipe
-}
-
-#endif // !Darwin/Darwin
-int wxGUIAppTraits::WaitForChild(wxExecuteData& execData)
+// Helper function that checks whether the child with the given PID has exited
+// and fills the provided parameter with its return code if it did.
+bool CheckForChildExit(int pid, int* exitcodeOut)
{
- wxEndProcessData *endProcData = new wxEndProcessData;
+ wxASSERT_MSG( pid > 0, "invalid PID" );
- const int flags = execData.flags;
+ int status, rc;
- // wxAddProcessCallback is now (with DARWIN) allowed to call the
- // callback function directly if the process terminates before
- // the callback can be added to the run loop. Set up the endProcData.
- if ( flags & wxEXEC_SYNC )
+ // loop while we're getting EINTR
+ for ( ;; )
{
- // we may have process for capturing the program output, but it's
- // not used in wxEndProcessData in the case of sync execution
- endProcData->process = NULL;
+ rc = waitpid(pid, &status, WNOHANG);
- // sync execution: indicate it by negating the pid
- endProcData->pid = -execData.pid;
+ if ( rc != -1 || errno != EINTR )
+ break;
}
- else
+
+ switch ( rc )
{
- // async execution, nothing special to do -- caller will be
- // notified about the process termination if process != NULL, endProcData
- // will be deleted in GTK_EndProcessDetector
- endProcData->process = execData.process;
- endProcData->pid = execData.pid;
- }
+ case 0:
+ // No error but the child is still running.
+ return false;
+ case -1:
+ // Checking child status failed. Invalid PID?
+ wxLogLastError(wxString::Format("waitpid(%d)", pid));
+ return false;
- if ( !(flags & wxEXEC_NOEVENTS) )
- {
-#if USE_OLD_DARWIN_END_PROCESS_DETECT
- endProcData->tag = wxAddProcessCallbackForPid(endProcData, execData.pid);
-#else
- endProcData->tag = wxAddProcessCallback
- (
- endProcData,
- execData.pipeEndProcDetect.Detach(wxPipe::Read)
- );
-
- execData.pipeEndProcDetect.Close();
-#endif // USE_OLD_DARWIN_END_PROCESS_DETECT
+ default:
+ // Child did terminate.
+ wxASSERT_MSG( rc == pid, "unexpected waitpid() return value" );
+
+ // notice that the caller expects the exit code to be signed, e.g. -1
+ // instead of 255 so don't assign WEXITSTATUS() to an int
+ signed char exitcode;
+ if ( WIFEXITED(status) )
+ exitcode = WEXITSTATUS(status);
+ else if ( WIFSIGNALED(status) )
+ exitcode = -WTERMSIG(status);
+ else
+ {
+ wxLogError("Child process (PID %d) exited for unknown reason, "
+ "status = %d", pid, status);
+ exitcode = -1;
+ }
+
+ if ( exitcodeOut )
+ *exitcodeOut = exitcode;
+
+ return true;
}
+}
- if ( flags & wxEXEC_SYNC )
- {
- wxBusyCursor bc;
- int exitcode = 0;
+} // anonymous namespace
- wxWindowDisabler *wd = flags & (wxEXEC_NODISABLE | wxEXEC_NOEVENTS)
- ? NULL
- : new wxWindowDisabler;
+wxExecuteData::ChildProcessesData wxExecuteData::ms_childProcesses;
- if ( flags & wxEXEC_NOEVENTS )
- {
- // just block waiting for the child to exit
- int status = 0;
-
- int result = waitpid(execData.pid, &status, 0);
-#ifdef __DARWIN__
- /* DE: waitpid manpage states that waitpid can fail with EINTR
- if the call is interrupted by a caught signal. I suppose
- that means that this ought to be a while loop.
-
- The odd thing is that it seems to fail EVERY time. It fails
- with a quickly exiting process (e.g. echo), and fails with a
- slowly exiting process (e.g. sleep 2) but clearly after
- having waited for the child to exit. Maybe it's a bug in
- my particular version.
-
- It works, however, from the CFSocket callback without this
- trick but in that case it's used only after CFSocket calls
- the callback and with the WNOHANG flag which would seem to
- preclude it from being interrupted or at least make it much
- less likely since it would not then be waiting.
-
- If Darwin's man page is to be believed then this is definitely
- necessary. It's just weird that I've never seen it before
- and apparently no one else has either or you'd think they'd
- have reported it by now. Perhaps blocking the GUI while
- waiting for a child process to exit is simply not that common.
- */
- if(result == -1 && errno == EINTR)
- {
- result = waitpid(execData.pid, &status, 0);
- }
+/* static */
+void wxExecuteData::OnSomeChildExited(int WXUNUSED(sig))
+{
+ // We know that some child process has terminated, but we don't know which
+ // one, so check all of them (notice that more than one could have exited).
+ //
+ // An alternative approach would be to call waitpid(-1, &status, WNOHANG)
+ // (in a loop to take care of the multiple children exiting case) and
+ // perhaps this would be more efficient. But for now this seems to work.
-#endif
- if ( result == -1 )
- {
- wxLogLastError(_T("waitpid"));
- exitcode = -1;
- }
- else
- {
- wxASSERT_MSG( result == execData.pid,
- _T("unexpected waitpid() return value") );
+ // Make a copy of the list before iterating over it to avoid problems due
+ // to deleting entries from it in the process.
+ const ChildProcessesData allChildProcesses = ms_childProcesses;
+ for ( ChildProcessesData::const_iterator it = allChildProcesses.begin();
+ it != allChildProcesses.end();
+ ++it )
+ {
+ const int pid = it->first;
- if ( WIFEXITED(status) )
- {
- exitcode = WEXITSTATUS(status);
- }
- else // abnormal termination?
- {
- wxASSERT_MSG( WIFSIGNALED(status),
- _T("unexpected child wait status") );
- exitcode = -1;
- }
- }
- }
- else // !wxEXEC_NOEVENTS
- {
- // endProcData->pid will be set to 0 from GTK_EndProcessDetector when the
- // process terminates
- while ( endProcData->pid != 0 )
- {
- bool idle = true;
+ // Check whether this child exited.
+ int exitcode;
+ if ( !CheckForChildExit(pid, &exitcode) )
+ continue;
-#if HAS_PIPE_INPUT_STREAM
- if ( execData.bufOut )
- {
- execData.bufOut->Update();
- idle = false;
- }
+ // And handle its termination if it did.
+ //
+ // Notice that this will implicitly remove it from ms_childProcesses.
+ it->second->OnExit(exitcode);
+ }
+}
- if ( execData.bufErr )
- {
- execData.bufErr->Update();
- idle = false;
- }
-#endif // HAS_PIPE_INPUT_STREAM
+void wxExecuteData::OnStart(int pid_)
+{
+ wxCHECK_RET( wxTheApp,
+ wxS("Ensure wxTheApp is set before calling wxExecute()") );
- // don't consume 100% of the CPU while we're sitting in this
- // loop
- if ( idle )
- wxMilliSleep(1);
+ // Setup the signal handler for SIGCHLD to be able to detect the child
+ // termination.
+ //
+ // Notice that SetSignalHandler() is idempotent, so it's fine to call
+ // it more than once with the same handler.
+ wxTheApp->SetSignalHandler(SIGCHLD, OnSomeChildExited);
- // give GTK+ a chance to call GTK_EndProcessDetector here and
- // also repaint the GUI
- wxYield();
- }
- exitcode = endProcData->exitcode;
- }
+ // Remember the child PID to be able to wait for it later.
+ pid = pid_;
- delete wd;
- delete endProcData;
+ // Also save it in wxProcess where it will be accessible to the user code.
+ if ( process )
+ process->SetPid(pid);
- return exitcode;
- }
- else // async execution
+ // Finally, add this object itself to the list of child processes so that
+ // we can check for its termination the next time we get SIGCHLD.
+ ms_childProcesses[pid] = this;
+}
+
+void wxExecuteData::OnExit(int exitcode_)
+{
+ // Remove this process from the hash list of child processes that are
+ // still open as soon as possible to ensure we don't process it again even
+ // if another SIGCHLD happens.
+ if ( !ms_childProcesses.erase(pid) )
{
- return execData.pid;
+ wxFAIL_MSG(wxString::Format(wxS("Data for PID %d not in the list?"), pid));
}
-}
-#endif // wxUSE_GUI
-#if wxUSE_BASE
-void wxHandleProcessTermination(wxEndProcessData *proc_data)
-{
- // notify user about termination if required
- if ( proc_data->process )
+ exitcode = exitcode_;
+
+#if wxUSE_STREAMS
+ if ( IsRedirected() )
{
- proc_data->process->OnTerminate(proc_data->pid, proc_data->exitcode);
+ // Read the remaining data in a blocking way: this is fine because the
+ // child has already exited and hence all the data must be already
+ // available in the streams buffers.
+ bufOut.ReadAll();
+ bufErr.ReadAll();
}
+#endif // wxUSE_STREAMS
- // clean up
- if ( proc_data->pid > 0 )
+ // Notify user about termination if required
+ if ( !(flags & wxEXEC_SYNC) )
{
- delete proc_data;
+ if ( process )
+ process->OnTerminate(pid, exitcode);
+
+ // in case of asynchronous execution we don't need this object any more
+ // after the child terminates
+ delete this;
}
- else
+ else // sync execution
{
- // let wxExecute() know that the process has terminated
- proc_data->pid = 0;
+ // let wxExecute() know that the process has terminated
+ pid = 0;
+
+ // Stop the event loop for synchronous wxExecute() if we're running one.
+ if ( syncEventLoop )
+ syncEventLoop->ScheduleExit();
}
}
-
-#endif // wxUSE_BASE
projects / wxWidgets.git / blobdiff