LCOV - code coverage report
Current view: top level - net - progclient.cc (source / functions) Hit Total Coverage
Test: Test Coverage for xapian-core 4ba52dacf4fb Lines: 16 48 33.3 %
Date: 2019-05-20 14:58:19 Functions: 4 5 80.0 %
Branches: 9 70 12.9 %

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

Generated by: LCOV version 1.11