Branch data Line data Source code
1 : : /* progclient.cc: implementation of NetClient which spawns a program.
2 : : *
3 : : * Copyright 1999,2000,2001 BrightStation PLC
4 : : * Copyright 2002 Ananova Ltd
5 : : * Copyright 2003,2004,2005,2006,2007,2010,2011 Olly Betts
6 : : *
7 : : * This program is free software; you can redistribute it and/or
8 : : * modify it under the terms of the GNU General Public License as
9 : : * published by the Free Software Foundation; either version 2 of the
10 : : * License, or (at your option) any later version.
11 : : *
12 : : * This program is distributed in the hope that it will be useful,
13 : : * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 : : * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 : : * GNU General Public License for more details.
16 : : *
17 : : * You should have received a copy of the GNU General Public License
18 : : * along with this program; if not, write to the Free Software
19 : : * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
20 : : * USA
21 : : */
22 : :
23 : : #include <config.h>
24 : :
25 : : #include "safeerrno.h"
26 : : #include "safefcntl.h"
27 : :
28 : : #include "progclient.h"
29 : : #include <xapian/error.h>
30 : : #include "closefrom.h"
31 : : #include "debuglog.h"
32 : :
33 : : #include <string>
34 : : #include <vector>
35 : :
36 : : #include <sys/types.h>
37 : : #ifndef __WIN32__
38 : : # include <sys/socket.h>
39 : : # include <sys/wait.h>
40 : : #else
41 : : # include <cstdio> // For sprintf().
42 : : # include <io.h>
43 : : #endif
44 : :
45 : : using namespace std;
46 : :
47 : : #ifndef __WIN32__
48 : : /** Split a string into a vector of strings, using a given separator
49 : : * character (default space)
50 : : */
51 : : static void
52 : 0 : split_words(const string &text, vector<string> &words, char ws = ' ')
53 : : {
54 : 0 : size_t i = 0;
55 [ # # ][ # # ]: 0 : if (i < text.length() && text[0] == ws) {
[ # # ]
56 : 0 : i = text.find_first_not_of(ws, i);
57 : : }
58 [ # # ]: 0 : while (i < text.length()) {
59 : 0 : size_t j = text.find_first_of(ws, i);
60 : 0 : words.push_back(text.substr(i, j - i));
61 : 0 : i = text.find_first_not_of(ws, j);
62 : : }
63 : 0 : }
64 : : #endif
65 : :
66 : 783 : ProgClient::ProgClient(const string &progname, const string &args,
67 : : double timeout_, bool writable)
68 : : : RemoteDatabase(run_program(progname, args
69 : : #ifndef __WIN32__
70 : : , pid
71 : : #endif
72 : : ),
73 : 783 : timeout_, get_progcontext(progname, args), writable)
74 : : {
75 : : LOGCALL_VOID(DB, "ProgClient::ProgClient", progname | args | timeout_ | writable);
76 : 783 : }
77 : :
78 : : string
79 : 783 : ProgClient::get_progcontext(const string &progname, const string &args)
80 : : {
81 : : LOGCALL_STATIC(DB, string, "ProgClient::get_progcontext", progname | args);
82 : 783 : RETURN("remote:prog(" + progname + " " + args);
83 : : }
84 : :
85 : : int
86 : 783 : ProgClient::run_program(const string &progname, const string &args
87 : : #ifndef __WIN32__
88 : : , pid_t &pid
89 : : #endif
90 : : )
91 : : {
92 : : #if defined HAVE_SOCKETPAIR && defined HAVE_FORK
93 : : LOGCALL_STATIC(DB, int, "ProgClient::run_program", progname | args | Literal("[&pid]"));
94 : : /* socketpair() returns two sockets. We keep sv[0] and give
95 : : * sv[1] to the child process.
96 : : */
97 : : int sv[2];
98 : :
99 [ - + ]: 783 : if (socketpair(PF_UNIX, SOCK_STREAM, 0, sv) < 0) {
100 : 0 : throw Xapian::NetworkError(string("socketpair failed"), get_progcontext(progname, args), errno);
101 : : }
102 : :
103 : 783 : pid = fork();
104 : :
105 [ - + ]: 783 : if (pid < 0) {
106 : 0 : throw Xapian::NetworkError(string("fork failed"), get_progcontext(progname, args), errno);
107 : : }
108 : :
109 [ + - ]: 783 : if (pid != 0) {
110 : : // parent
111 : : // close the child's end of the socket
112 : 783 : ::close(sv[1]);
113 : 783 : return sv[0];
114 : : }
115 : :
116 : : /* child process:
117 : : * set up file descriptors and exec program
118 : : */
119 : :
120 : : // replace stdin and stdout with the socket
121 : : // FIXME: check return values from dup2.
122 [ # # ]: 0 : if (sv[1] != 0) {
123 : 0 : dup2(sv[1], 0);
124 : : }
125 [ # # ]: 0 : if (sv[1] != 1) {
126 : 0 : dup2(sv[1], 1);
127 : : }
128 : :
129 : : // close unnecessary file descriptors
130 : 0 : closefrom(2);
131 : :
132 : : // Redirect stderr to /dev/null
133 : 0 : int stderrfd = open("/dev/null", O_WRONLY);
134 [ # # ]: 0 : if (stderrfd == -1) {
135 : 0 : throw Xapian::NetworkError(string("Redirecting stderr to /dev/null failed"), get_progcontext(progname, args), errno);
136 : : }
137 [ # # ]: 0 : if (stderrfd != 2) {
138 : : // Not sure why it wouldn't be 2, but handle the situation anyway.
139 : 0 : dup2(stderrfd, 2);
140 : 0 : ::close(stderrfd);
141 : : }
142 : :
143 : 0 : vector<string> argvec;
144 : 0 : split_words(args, argvec);
145 : :
146 : : // We never explicitly free this memory, but that's OK as we're about
147 : : // to either execvp() or _exit().
148 : 0 : const char **new_argv = new const char *[argvec.size() + 2];
149 : :
150 : 0 : new_argv[0] = progname.c_str();
151 [ # # ]: 0 : for (vector<string>::size_type i = 0; i < argvec.size(); ++i) {
152 : 0 : new_argv[i + 1] = argvec[i].c_str();
153 : : }
154 : 0 : new_argv[argvec.size() + 1] = 0;
155 : 0 : execvp(progname.c_str(), const_cast<char *const *>(new_argv));
156 : :
157 : : // if we get here, then execvp failed.
158 : : /* throwing an exception is a bad idea, since we're
159 : : * not the original process. */
160 : 0 : _exit(-1);
161 : : #ifdef __sgi
162 : : // Avoid "missing return statement" warning.
163 : : return 0;
164 : : #endif
165 : : #elif defined __WIN32__
166 : : LOGCALL_STATIC(DB, int, "ProgClient::run_program", progname | args);
167 : :
168 : : static unsigned int pipecount = 0;
169 : : char pipename[256];
170 : : sprintf(pipename, "\\\\.\\pipe\\xapian-remote-%lx-%lx-%x",
171 : : (unsigned long)GetCurrentProcessId(),
172 : : (unsigned long)GetCurrentThreadId(), pipecount++);
173 : : // Create a pipe so we can read stdout from the child process.
174 : : HANDLE hPipe = CreateNamedPipe(pipename,
175 : : PIPE_ACCESS_DUPLEX|FILE_FLAG_OVERLAPPED,
176 : : 0,
177 : : 1, 4096, 4096, NMPWAIT_USE_DEFAULT_WAIT,
178 : : NULL);
179 : :
180 : : if (hPipe == INVALID_HANDLE_VALUE) {
181 : : throw Xapian::NetworkError("CreateNamedPipe failed",
182 : : get_progcontext(progname, args),
183 : : -(int)GetLastError());
184 : : }
185 : :
186 : : HANDLE hClient = CreateFile(pipename,
187 : : GENERIC_READ|GENERIC_WRITE, 0, NULL, OPEN_EXISTING,
188 : : FILE_FLAG_OVERLAPPED, NULL);
189 : :
190 : : if (hClient == INVALID_HANDLE_VALUE) {
191 : : throw Xapian::NetworkError("CreateFile failed",
192 : : get_progcontext(progname, args),
193 : : -(int)GetLastError());
194 : : }
195 : :
196 : : if (!ConnectNamedPipe(hPipe, NULL) && GetLastError() != ERROR_PIPE_CONNECTED) {
197 : : throw Xapian::NetworkError("ConnectNamedPipe failed",
198 : : get_progcontext(progname, args),
199 : : -(int)GetLastError());
200 : : }
201 : :
202 : : // Set the appropriate handles to be inherited by the child process.
203 : : SetHandleInformation(hClient, HANDLE_FLAG_INHERIT, 1);
204 : :
205 : : // Create the child process.
206 : : PROCESS_INFORMATION procinfo;
207 : : memset(&procinfo, 0, sizeof(PROCESS_INFORMATION));
208 : :
209 : : STARTUPINFO startupinfo;
210 : : memset(&startupinfo, 0, sizeof(STARTUPINFO));
211 : : startupinfo.cb = sizeof(STARTUPINFO);
212 : : startupinfo.hStdError = hClient;
213 : : startupinfo.hStdOutput = hClient;
214 : : startupinfo.hStdInput = hClient;
215 : : startupinfo.dwFlags |= STARTF_USESTDHANDLES;
216 : :
217 : : // For some reason Windows wants a modifiable copy!
218 : : BOOL ok;
219 : : char * cmdline = strdup((progname + ' ' + args).c_str());
220 : : ok = CreateProcess(0, cmdline, 0, 0, TRUE, 0, 0, 0, &startupinfo, &procinfo);
221 : : free(cmdline);
222 : : if (!ok) {
223 : : throw Xapian::NetworkError("CreateProcess failed",
224 : : get_progcontext(progname, args),
225 : : -(int)GetLastError());
226 : : }
227 : :
228 : : CloseHandle(hClient);
229 : : CloseHandle(procinfo.hThread);
230 : : return _open_osfhandle((intptr_t)hPipe, O_RDWR|O_BINARY);
231 : : #endif
232 : : }
233 : :
234 : 783 : ProgClient::~ProgClient()
235 : : {
236 : : // Close the socket and reap the child.
237 : 783 : do_close();
238 : : #ifndef __WIN32__
239 : 783 : waitpid(pid, 0, 0);
240 : : #endif
241 [ + - ][ # # ]: 783 : }
[ # # ]
|
