1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
/**
* @file llprocesslauncher.h
* @brief Utility class for launching, terminating, and tracking the state of processes.
*
* $LicenseInfo:firstyear=2008&license=viewerlgpl$
* Second Life Viewer Source Code
* Copyright (C) 2010, Linden Research, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation;
* version 2.1 of the License only.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* Linden Research, Inc., 945 Battery Street, San Francisco, CA 94111 USA
* $/LicenseInfo$
*/
#ifndef LL_LLPROCESSLAUNCHER_H
#define LL_LLPROCESSLAUNCHER_H
#if LL_WINDOWS
#define WIN32_LEAN_AND_MEAN
#include <windows.h>
#endif
/*
LLProcessLauncher handles launching external processes with specified command line arguments.
It also keeps track of whether the process is still running, and can kill it if required.
*/
class LL_COMMON_API LLProcessLauncher
{
LOG_CLASS(LLProcessLauncher);
public:
LLProcessLauncher();
virtual ~LLProcessLauncher();
void setExecutable(const std::string &executable);
void setWorkingDirectory(const std::string &dir);
const std::string& getExecutable() const;
void clearArguments();
void addArgument(const std::string &arg);
int launch(void);
// isRunning isn't const because, if child isn't running, it clears stored
// process ID
bool isRunning(void);
// Attempt to kill the process -- returns true if the process is no longer running when it returns.
// Note that even if this returns false, the process may exit some time after it's called.
bool kill(void);
// Use this if you want the external process to continue execution after the LLProcessLauncher instance controlling it is deleted.
// Normally, the destructor will attempt to kill the process and wait for termination.
// This should only be used if the viewer is about to exit -- otherwise, the child process will become a zombie after it exits.
void orphan(void);
// This needs to be called periodically on Mac/Linux to clean up zombie processes.
// (However, as of 2012-01-12 there are no such calls in the viewer code base. :-P )
static void reap(void);
// Accessors for platform-specific process ID
#if LL_WINDOWS
// (Windows flavor unused as of 2012-01-12)
typedef HANDLE ll_pid_t;
HANDLE getProcessHandle() const { return mProcessHandle; }
ll_pid_t getProcessID() const { return mProcessHandle; }
#else
typedef pid_t ll_pid_t;
ll_pid_t getProcessID() const { return mProcessID; };
#endif
/**
* Test if a process (ll_pid_t obtained from getProcessID()) is still
* running. Return is same nonzero ll_pid_t value if still running, else
* zero, so you can test it like a bool. But if you want to update a
* stored variable as a side effect, you can write code like this:
* @code
* childpid = LLProcessLauncher::isRunning(childpid);
* @endcode
*/
static ll_pid_t isRunning(ll_pid_t);
private:
std::string mExecutable;
std::string mWorkingDir;
std::vector<std::string> mLaunchArguments;
#if LL_WINDOWS
HANDLE mProcessHandle;
#else
pid_t mProcessID;
#endif
};
#endif // LL_LLPROCESSLAUNCHER_H
|