ProcessUNIX.c 50.6 KB
Newer Older
1
2
/*=========================================================================

Brad King's avatar
Brad King committed
3
4
  Program:   KWSys - Kitware System Library
  Module:    ProcessUNIX.c
5

Brad King's avatar
Brad King committed
6
7
  Copyright (c) Kitware, Inc., Insight Consortium.  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
8

Brad King's avatar
Brad King committed
9
10
11
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.
12
13
14

=========================================================================*/
#define KWSYS_IN_PROCESS_C
15
16
#include "kwsysPrivate.h"
#include KWSYS_HEADER(Process.h)
17
18
19
20

/*

Implementation for UNIX
21

22
23
24
25
26
27
28
29
30
31
32
On UNIX, a child process is forked to exec the program.  Three
output pipes from the child are read by the parent process using a
select call to block until data are ready.  Two of the pipes are
stdout and stderr for the child.  The third is a special error pipe
that has two purposes.  First, if the child cannot exec the program,
the error is reported through the error pipe.  Second, the error
pipe is left open until the child exits.  This is used in
conjunction with the timeout on the select call to implement a
timeout for program even when it closes stdout and stderr.
*/

33
34
35
36
37
38
39
40
41
42
43
/*

TODO:

We cannot create the pipeline of processes in suspended states.  How
do we cleanup processes already started when one fails to load?  Right
now we are just killing them, which is probably not the right thing to
do.

*/

44
45
46
47
48
49
#include <stdio.h>     /* snprintf */
#include <stdlib.h>    /* malloc, free */
#include <string.h>    /* strdup, strerror, memset */
#include <sys/time.h>  /* struct timeval */
#include <sys/types.h> /* pid_t, fd_set */
#include <sys/wait.h>  /* waitpid */
50
#include <sys/stat.h>  /* open mode */
51
52
53
54
55
#include <unistd.h>    /* pipe, close, fork, execvp, select, _exit */
#include <fcntl.h>     /* fcntl */
#include <errno.h>     /* errno */
#include <time.h>      /* gettimeofday */
#include <signal.h>    /* sigaction */
56
#include <dirent.h>    /* DIR, dirent */
57
58

/* The number of pipes for the child's output.  The standard stdout
59
60
61
62
   and stderr pipes are the first two.  One more pipe is used to
   detect when the child process has terminated.  The third pipe is
   not given to the child process, so it cannot close it until it
   terminates.  */
63
64
65
#define KWSYSPE_PIPE_COUNT 3
#define KWSYSPE_PIPE_STDOUT 0
#define KWSYSPE_PIPE_STDERR 1
66
#define KWSYSPE_PIPE_TERM 2
67
68
69
70
71
72

/* The maximum amount to read from a pipe at a time.  */
#define KWSYSPE_PIPE_BUFFER_SIZE 1024

typedef struct timeval kwsysProcessTime;

73
74
typedef struct kwsysProcessCreateInformation_s
{
75
76
77
78
79
  int StdIn;
  int StdOut;
  int StdErr;
  int TermPipe;
  int ErrorPipe[2];
80
81
} kwsysProcessCreateInformation;

82
/*--------------------------------------------------------------------------*/
83
static int kwsysProcessInitialize(kwsysProcess* cp);
84
85
static void kwsysProcessCleanup(kwsysProcess* cp, int error);
static void kwsysProcessCleanupDescriptor(int* pfd);
86
87
static int kwsysProcessCreate(kwsysProcess* cp, int index,
                              kwsysProcessCreateInformation* si, int* readEnd);
88
static int kwsysProcessSetupOutputPipeFile(int* p, const char* name);
89
90
91
92
static int kwsysProcessGetTimeoutTime(kwsysProcess* cp, double* userTimeout,
                                      kwsysProcessTime* timeoutTime);
static int kwsysProcessGetTimeoutLeft(kwsysProcessTime* timeoutTime,
                                      kwsysProcessTime* timeoutLength);
93
static kwsysProcessTime kwsysProcessTimeGetCurrent(void);
94
95
96
97
98
static double kwsysProcessTimeToDouble(kwsysProcessTime t);
static kwsysProcessTime kwsysProcessTimeFromDouble(double d);
static int kwsysProcessTimeLess(kwsysProcessTime in1, kwsysProcessTime in2);
static kwsysProcessTime kwsysProcessTimeAdd(kwsysProcessTime in1, kwsysProcessTime in2);
static kwsysProcessTime kwsysProcessTimeSubtract(kwsysProcessTime in1, kwsysProcessTime in2);
99
static void kwsysProcessSetExitException(kwsysProcess* cp, int sig);
100
static void kwsysProcessChildErrorExit(int errorPipe);
101
static void kwsysProcessRestoreDefaultSignalHandlers(void);
102
103
static pid_t kwsysProcessFork(kwsysProcess* cp,
                              kwsysProcessCreateInformation* si);
104
static void kwsysProcessKill(pid_t process_id);
105
106
107
108
109

/*--------------------------------------------------------------------------*/
/* Structure containing data used to implement the child's execution.  */
struct kwsysProcess_s
{
110
111
112
  /* The command lines to execute.  */
  char*** Commands;
  int NumberOfCommands;
113
114
115

  /* Descriptors for the read ends of the child's output pipes. */
  int PipeReadEnds[KWSYSPE_PIPE_COUNT];
116

117
118
119
  /* Buffer for pipe data.  */
  char PipeBuffer[KWSYSPE_PIPE_BUFFER_SIZE];

120
121
  /* Process IDs returned by the calls to fork.  */
  pid_t* ForkPIDs;
122

123
124
  /* Flag for whether the children were terminated by a faild select.  */
  int SelectError;
125

126
  /* The timeout length.  */
127
  double Timeout;
128
129
130

  /* The working directory for the process. */
  char* WorkingDirectory;
131

132
133
134
135
136
137
  /* Whether to create the child as a detached process.  */
  int OptionDetach;

  /* Whether the child was created as a detached process.  */
  int Detached;

138
139
  /* Time at which the child started.  Negative for no timeout.  */
  kwsysProcessTime StartTime;
140

141
142
  /* Time at which the child will timeout.  Negative for no timeout.  */
  kwsysProcessTime TimeoutTime;
143

144
145
  /* Flag for whether the timeout expired.  */
  int TimeoutExpired;
146

147
148
  /* The old SIGCHLD handler.  */
  struct sigaction OldSigChldAction;
149

150
151
  /* The number of pipes left open during execution.  */
  int PipesLeft;
152

153
154
155
156
157
  /* File descriptor set for call to select.  */
  fd_set PipeSet;

  /* The current status of the child process. */
  int State;
158

159
160
161
  /* The exceptional behavior that terminated the child process, if
   * any.  */
  int ExitException;
162

163
  /* The exit code of the child process.  */
164
  int ExitCode;
165

166
167
  /* The exit value of the child process, if any.  */
  int ExitValue;
168

169
170
  /* Whether the process was killed.  */
  int Killed;
171

172
173
  /* Buffer for error message in case of failure.  */
  char ErrorMessage[KWSYSPE_PIPE_BUFFER_SIZE+1];
174

175
176
177
  /* Description for the ExitException.  */
  char ExitExceptionString[KWSYSPE_PIPE_BUFFER_SIZE+1];

178
179
  /* The exit codes of each child process in the pipeline.  */
  int* CommandExitCodes;
180
181
182
183
184
185

  /* Name of files to which stdin and stdout pipes are attached.  */
  char* PipeFileSTDIN;
  char* PipeFileSTDOUT;
  char* PipeFileSTDERR;

186
187
188
189
190
  /* Whether each pipe is shared with the parent process.  */
  int PipeSharedSTDIN;
  int PipeSharedSTDOUT;
  int PipeSharedSTDERR;

191
192
193
  /* The real working directory of this process.  */
  int RealWorkingDirectoryLength;
  char* RealWorkingDirectory;
194
195
196
};

/*--------------------------------------------------------------------------*/
197
kwsysProcess* kwsysProcess_New(void)
198
199
200
201
202
203
204
205
{
  /* Allocate a process control structure.  */
  kwsysProcess* cp = (kwsysProcess*)malloc(sizeof(kwsysProcess));
  if(!cp)
    {
    return 0;
    }
  memset(cp, 0, sizeof(kwsysProcess));
206
207
208
209
210

  /* Share stdin with the parent process by default.  */
  cp->PipeSharedSTDIN = 1;

  /* Set initial status.  */
211
  cp->State = kwsysProcess_State_Starting;
212

213
214
215
216
217
218
  return cp;
}

/*--------------------------------------------------------------------------*/
void kwsysProcess_Delete(kwsysProcess* cp)
{
219
220
221
222
223
224
  /* Make sure we have an instance.  */
  if(!cp)
    {
    return;
    }

225
  /* If the process is executing, wait for it to finish.  */
226
  if(cp->State == kwsysProcess_State_Executing)
227
    {
228
229
230
231
232
233
234
235
    if(cp->Detached)
      {
      kwsysProcess_Disown(cp);
      }
    else
      {
      kwsysProcess_WaitForExit(cp, 0);
      }
236
    }
237

238
239
  /* Free memory.  */
  kwsysProcess_SetCommand(cp, 0);
240
  kwsysProcess_SetWorkingDirectory(cp, 0);
241
242
243
  kwsysProcess_SetPipeFile(cp, kwsysProcess_Pipe_STDIN, 0);
  kwsysProcess_SetPipeFile(cp, kwsysProcess_Pipe_STDOUT, 0);
  kwsysProcess_SetPipeFile(cp, kwsysProcess_Pipe_STDERR, 0);
244
245
246
247
  if(cp->CommandExitCodes)
    {
    free(cp->CommandExitCodes);
    }
248
249
250
251
  free(cp);
}

/*--------------------------------------------------------------------------*/
252
int kwsysProcess_SetCommand(kwsysProcess* cp, char const* const* command)
253
{
254
  int i;
255
256
257
258
  if(!cp)
    {
    return 0;
    }
259
  for(i=0; i < cp->NumberOfCommands; ++i)
260
    {
261
    char** c = cp->Commands[i];
262
263
264
265
    while(*c)
      {
      free(*c++);
      }
266
267
268
269
270
271
272
    free(cp->Commands[i]);
    }
  cp->NumberOfCommands = 0;
  if(cp->Commands)
    {
    free(cp->Commands);
    cp->Commands = 0;
273
274
275
    }
  if(command)
    {
276
277
278
279
280
281
282
283
284
285
286
287
    return kwsysProcess_AddCommand(cp, command);
    }
  return 1;
}

/*--------------------------------------------------------------------------*/
int kwsysProcess_AddCommand(kwsysProcess* cp, char const* const* command)
{
  int newNumberOfCommands;
  char*** newCommands;

  /* Make sure we have a command to add.  */
288
  if(!cp || !command)
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
    {
    return 0;
    }

  /* Allocate a new array for command pointers.  */
  newNumberOfCommands = cp->NumberOfCommands + 1;
  if(!(newCommands = (char***)malloc(sizeof(char**) * newNumberOfCommands)))
    {
    /* Out of memory.  */
    return 0;
    }

  /* Copy any existing commands into the new array.  */
  {
  int i;
  for(i=0; i < cp->NumberOfCommands; ++i)
    {
    newCommands[i] = cp->Commands[i];
    }
  }

  /* Add the new command.  */
  {
  char const* const* c = command;
  int n = 0;
  int i = 0;
  while(*c++);
  n = c - command - 1;
  newCommands[cp->NumberOfCommands] = (char**)malloc((n+1)*sizeof(char*));
  if(!newCommands[cp->NumberOfCommands])
    {
    /* Out of memory.  */
    free(newCommands);
    return 0;
    }
  for(i=0; i < n; ++i)
    {
    newCommands[cp->NumberOfCommands][i] = strdup(command[i]);
    if(!newCommands[cp->NumberOfCommands][i])
328
      {
329
      break;
330
      }
331
    }
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
  if(i < n)
    {
    /* Out of memory.  */
    for(;i > 0; --i)
      {
      free(newCommands[cp->NumberOfCommands][i-1]);
      }
    free(newCommands);
    return 0;
    }
  newCommands[cp->NumberOfCommands][n] = 0;
  }

  /* Successfully allocated new command array.  Free the old array. */
  free(cp->Commands);
  cp->Commands = newCommands;
  cp->NumberOfCommands = newNumberOfCommands;

  return 1;
351
352
353
354
355
}

/*--------------------------------------------------------------------------*/
void kwsysProcess_SetTimeout(kwsysProcess* cp, double timeout)
{
356
357
358
359
  if(!cp)
    {
    return;
    }
360
361
362
363
364
365
366
367
  cp->Timeout = timeout;
  if(cp->Timeout < 0)
    {
    cp->Timeout = 0;
    }
}

/*--------------------------------------------------------------------------*/
368
int kwsysProcess_SetWorkingDirectory(kwsysProcess* cp, const char* dir)
369
{
370
371
  if(!cp)
    {
372
    return 0;
373
    }
374
375
  if(cp->WorkingDirectory == dir)
    {
376
    return 1;
377
378
379
    }
  if(cp->WorkingDirectory && dir && strcmp(cp->WorkingDirectory, dir) == 0)
    {
380
    return 1;
381
382
383
384
385
386
387
388
    }
  if(cp->WorkingDirectory)
    {
    free(cp->WorkingDirectory);
    cp->WorkingDirectory = 0;
    }
  if(dir)
    {
389
    cp->WorkingDirectory = (char*)malloc(strlen(dir) + 1);
390
391
392
393
    if(!cp->WorkingDirectory)
      {
      return 0;
      }
394
395
    strcpy(cp->WorkingDirectory, dir);
    }
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
  return 1;
}

/*--------------------------------------------------------------------------*/
int kwsysProcess_SetPipeFile(kwsysProcess* cp, int pipe, const char* file)
{
  char** pfile;
  if(!cp)
    {
    return 0;
    }
  switch(pipe)
    {
    case kwsysProcess_Pipe_STDIN: pfile = &cp->PipeFileSTDIN; break;
    case kwsysProcess_Pipe_STDOUT: pfile = &cp->PipeFileSTDOUT; break;
    case kwsysProcess_Pipe_STDERR: pfile = &cp->PipeFileSTDERR; break;
    default: return 0;
    }
  if(*pfile)
    {
    free(*pfile);
    *pfile = 0;
    }
  if(file)
    {
    *pfile = malloc(strlen(file)+1);
    if(!*pfile)
      {
      return 0;
      }
    strcpy(*pfile, file);
    }
428
429
430
431
432
433

  /* If we are redirecting the pipe, do not share it.  */
  if(*pfile)
    {
    kwsysProcess_SetPipeShared(cp, pipe, 0);
    }
434
  return 1;
435
436
}

437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
/*--------------------------------------------------------------------------*/
void kwsysProcess_SetPipeShared(kwsysProcess* cp, int pipe, int shared)
{
  if(!cp)
    {
    return;
    }

  switch(pipe)
    {
    case kwsysProcess_Pipe_STDIN: cp->PipeSharedSTDIN = shared?1:0; break;
    case kwsysProcess_Pipe_STDOUT: cp->PipeSharedSTDOUT = shared?1:0; break;
    case kwsysProcess_Pipe_STDERR: cp->PipeSharedSTDERR = shared?1:0; break;
    default: return;
    }

  /* If we are sharing the pipe, do not redirect it to a file.  */
  if(shared)
    {
    kwsysProcess_SetPipeFile(cp, pipe, 0);
    }
}

460
461
462
/*--------------------------------------------------------------------------*/
int kwsysProcess_GetOption(kwsysProcess* cp, int optionId)
{
463
464
465
466
467
468
469
470
471
472
  if(!cp)
    {
    return 0;
    }

  switch(optionId)
    {
    case kwsysProcess_Option_Detach: return cp->OptionDetach;
    default: return 0;
    }
473
474
475
476
477
}

/*--------------------------------------------------------------------------*/
void kwsysProcess_SetOption(kwsysProcess* cp, int optionId, int value)
{
478
479
480
481
482
483
484
485
486
487
  if(!cp)
    {
    return;
    }

  switch(optionId)
    {
    case kwsysProcess_Option_Detach: cp->OptionDetach = value; break;
    default: break;
    }
488
489
}

490
/*--------------------------------------------------------------------------*/
491
492
int kwsysProcess_GetState(kwsysProcess* cp)
{
493
  return cp? cp->State : kwsysProcess_State_Error;
494
495
}

496
497
498
/*--------------------------------------------------------------------------*/
int kwsysProcess_GetExitException(kwsysProcess* cp)
{
499
  return cp? cp->ExitException : kwsysProcess_Exception_Other;
500
501
}

502
503
504
/*--------------------------------------------------------------------------*/
int kwsysProcess_GetExitCode(kwsysProcess* cp)
{
505
  return cp? cp->ExitCode : 0;
506
507
}

508
509
510
/*--------------------------------------------------------------------------*/
int kwsysProcess_GetExitValue(kwsysProcess* cp)
{
511
  return cp? cp->ExitValue : -1;
512
513
}

514
515
516
/*--------------------------------------------------------------------------*/
const char* kwsysProcess_GetErrorString(kwsysProcess* cp)
{
517
518
  if(!cp)
    {
519
    return "Process management structure could not be allocated";
520
521
    }
  else if(cp->State == kwsysProcess_State_Error)
522
    {
523
    return cp->ErrorMessage;
524
    }
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
  return "Success";
}

/*--------------------------------------------------------------------------*/
const char* kwsysProcess_GetExceptionString(kwsysProcess* cp)
{
  if(!cp)
    {
    return "GetExceptionString called with NULL process management structure";
    }
  else if(cp->State == kwsysProcess_State_Exception)
    {
    return cp->ExitExceptionString;
    }
  return "No exception";
540
541
542
543
544
545
546
}

/*--------------------------------------------------------------------------*/
void kwsysProcess_Execute(kwsysProcess* cp)
{
  int i;
  struct sigaction newSigChldAction;
547
  kwsysProcessCreateInformation si = {-1, -1, -1, -1, {-1, -1}};
548

549
  /* Do not execute a second copy simultaneously.  */
550
  if(!cp || cp->State == kwsysProcess_State_Executing)
551
552
553
    {
    return;
    }
554

555
  /* Initialize the control structure for a new process.  */
556
557
558
559
560
561
  if(!kwsysProcessInitialize(cp))
    {
    strcpy(cp->ErrorMessage, "Out of memory");
    cp->State = kwsysProcess_State_Error;
    return;
    }
562

563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
  /* Save the real working directory of this process and change to
     the working directory for the child processes.  This is needed
     to make pipe file paths evaluate correctly.  */
  if(cp->WorkingDirectory)
    {
    int r;
    if(!getcwd(cp->RealWorkingDirectory, cp->RealWorkingDirectoryLength))
      {
      kwsysProcessCleanup(cp, 1);
      return;
      }

    /* Some platforms specify that the chdir call may be
       interrupted.  Repeat the call until it finishes.  */
    while(((r = chdir(cp->WorkingDirectory)) < 0) && (errno == EINTR));
    if(r < 0)
      {
      kwsysProcessCleanup(cp, 1);
581
      return;
582
583
584
      }
    }

585
586
  /* We want no special handling of SIGCHLD.  Repeat call until it is
     not interrupted.  */
587
  memset(&newSigChldAction, 0, sizeof(struct sigaction));
588
589
590
  newSigChldAction.sa_handler = SIG_DFL;
  while((sigaction(SIGCHLD, &newSigChldAction, &cp->OldSigChldAction) < 0) &&
        (errno == EINTR));
591

592
593
  /* Setup the stderr and termination pipes to be shared by all processes.  */
  for(i=KWSYSPE_PIPE_STDERR; i < KWSYSPE_PIPE_COUNT; ++i)
594
595
    {
    /* Create the pipe.  */
596
    int p[2];
597
598
599
600
601
    if(pipe(p) < 0)
      {
      kwsysProcessCleanup(cp, 1);
      return;
      }
602

603
604
605
606
    /* Store the pipe.  */
    cp->PipeReadEnds[i] = p[0];
    if(i == KWSYSPE_PIPE_STDERR)
      {
607
      si.StdErr = p[1];
608
609
610
      }
    else
      {
611
      si.TermPipe = p[1];
612
613
      }

614
615
616
617
618
    /* Set close-on-exec flag on the pipe's ends.  */
    if((fcntl(p[0], F_SETFD, FD_CLOEXEC) < 0) ||
       (fcntl(p[1], F_SETFD, FD_CLOEXEC) < 0))
      {
      kwsysProcessCleanup(cp, 1);
619
620
      kwsysProcessCleanupDescriptor(&si.StdErr);
      kwsysProcessCleanupDescriptor(&si.TermPipe);
621
622
623
      return;
      }
    }
624

625
626
627
628
629
630
631
632
633
634
635
636
637
  /* Replace the stderr pipe with a file if requested.  In this case
     the select call will report that stderr is closed immediately.  */
  if(cp->PipeFileSTDERR)
    {
    if(!kwsysProcessSetupOutputPipeFile(&si.StdErr, cp->PipeFileSTDERR))
      {
      kwsysProcessCleanup(cp, 1);
      kwsysProcessCleanupDescriptor(&si.StdErr);
      kwsysProcessCleanupDescriptor(&si.TermPipe);
      return;
      }
    }

638
639
640
641
642
643
644
645
  /* Replace the stderr pipe with the parent's if requested.  In this
     case the select call will report that stderr is closed
     immediately.  */
  if(cp->PipeSharedSTDERR)
    {
    kwsysProcessCleanupDescriptor(&si.StdErr);
    si.StdErr = 2;
    }
646

647
648
649
650
  /* The timeout period starts now.  */
  cp->StartTime = kwsysProcessTimeGetCurrent();
  cp->TimeoutTime.tv_sec = -1;
  cp->TimeoutTime.tv_usec = -1;
651

652
653
  /* Create the pipeline of processes.  */
  {
654
  int readEnd = -1;
655
  for(i=0; i < cp->NumberOfCommands; ++i)
656
    {
657
    if(!kwsysProcessCreate(cp, i, &si, &readEnd))
658
      {
659
660
661
662
      kwsysProcessCleanup(cp, 1);

      /* Release resources that may have been allocated for this
         process before an error occurred.  */
663
664
      kwsysProcessCleanupDescriptor(&readEnd);
      if(si.StdIn != 0)
665
        {
666
        kwsysProcessCleanupDescriptor(&si.StdIn);
667
        }
668
669
670
671
672
673
674
675
      if(si.StdOut != 1)
        {
        kwsysProcessCleanupDescriptor(&si.StdOut);
        }
      if(si.StdErr != 2)
        {
        kwsysProcessCleanupDescriptor(&si.StdErr);
        }
676
677
678
      kwsysProcessCleanupDescriptor(&si.TermPipe);
      kwsysProcessCleanupDescriptor(&si.ErrorPipe[0]);
      kwsysProcessCleanupDescriptor(&si.ErrorPipe[1]);
679
      return;
680
      }
681
    }
682
683
684
  /* Save a handle to the output pipe for the last process.  */
  cp->PipeReadEnds[KWSYSPE_PIPE_STDOUT] = readEnd;
  }
685

686
  /* The parent process does not need the output pipe write ends.  */
687
688
  kwsysProcessCleanupDescriptor(&si.StdErr);
  kwsysProcessCleanupDescriptor(&si.TermPipe);
689

690
691
692
693
694
695
696
697
698
699
  /* Restore the working directory. */
  if(cp->RealWorkingDirectory)
    {
    /* Some platforms specify that the chdir call may be
       interrupted.  Repeat the call until it finishes.  */
    while((chdir(cp->RealWorkingDirectory) < 0) && (errno == EINTR));
    free(cp->RealWorkingDirectory);
    cp->RealWorkingDirectory = 0;
    }

700
701
  /* All the pipes are now open.  */
  cp->PipesLeft = KWSYSPE_PIPE_COUNT;
702

703
  /* The process has now started.  */
704
  cp->State = kwsysProcess_State_Executing;
705
706
707
708
709
710
711
712
713
  cp->Detached = cp->OptionDetach;
}

/*--------------------------------------------------------------------------*/
kwsysEXPORT void kwsysProcess_Disown(kwsysProcess* cp)
{
  int i;

  /* Make sure a detached child process is running.  */
714
715
  if(!cp || !cp->Detached || cp->State != kwsysProcess_State_Executing ||
     cp->TimeoutExpired || cp->Killed)
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
    {
    return;
    }

  /* Close any pipes that are still open.  */
  for(i=0; i < KWSYSPE_PIPE_COUNT; ++i)
    {
    if(cp->PipeReadEnds[i] >= 0)
      {
      /* If the pipe was reported by the last call to select, we must
         read from it.  Ignore the data.  */
      if(FD_ISSET(cp->PipeReadEnds[i], &cp->PipeSet))
        {
        /* We are handling this pipe now.  Remove it from the set.  */
        FD_CLR(cp->PipeReadEnds[i], &cp->PipeSet);

        /* The pipe is ready to read without blocking.  Keep trying to
           read until the operation is not interrupted.  */
        while((read(cp->PipeReadEnds[i], cp->PipeBuffer,
                    KWSYSPE_PIPE_BUFFER_SIZE) < 0) && (errno == EINTR));
        }

      /* We are done reading from this pipe.  */
      kwsysProcessCleanupDescriptor(&cp->PipeReadEnds[i]);
      --cp->PipesLeft;
      }
    }

744
745
746
747
  /* We will not wait for exit, so cleanup now.  */
  kwsysProcessCleanup(cp, 0);

  /* The process has been disowned.  */
748
  cp->State = kwsysProcess_State_Disowned;
749
750
751
}

/*--------------------------------------------------------------------------*/
752
753
int kwsysProcess_WaitForData(kwsysProcess* cp, char** data, int* length,
                             double* userTimeout)
754
755
756
757
758
759
760
761
762
{
  int i;
  int max = -1;
  kwsysProcessTime* timeout = 0;
  kwsysProcessTime timeoutLength;
  kwsysProcessTime timeoutTime;
  kwsysProcessTime userStartTime;
  int user = 0;
  int expired = 0;
Brad King's avatar
Brad King committed
763
  int pipeId = kwsysProcess_Pipe_None;
764
  int numReady = 0;
765

766
767
768
769
770
771
772
  /* Make sure we are executing a process.  */
  if(!cp || cp->State != kwsysProcess_State_Executing || cp->Killed ||
     cp->TimeoutExpired)
    {
    return kwsysProcess_Pipe_None;
    }

773
774
775
776
777
  /* Record the time at which user timeout period starts.  */
  if(userTimeout)
    {
    userStartTime = kwsysProcessTimeGetCurrent();
    }
778

779
780
781
  /* Calculate the time at which a timeout will expire, and whether it
     is the user or process timeout.  */
  user = kwsysProcessGetTimeoutTime(cp, userTimeout, &timeoutTime);
782

783
784
785
786
787
788
789
790
791
792
793
794
  /* Data can only be available when pipes are open.  If the process
     is not running, cp->PipesLeft will be 0.  */
  while(cp->PipesLeft > 0)
    {
    /* Check for any open pipes with data reported ready by the last
       call to select.  */
    for(i=0; i < KWSYSPE_PIPE_COUNT; ++i)
      {
      if(cp->PipeReadEnds[i] >= 0 &&
         FD_ISSET(cp->PipeReadEnds[i], &cp->PipeSet))
        {
        int n;
795

796
797
        /* We are handling this pipe now.  Remove it from the set.  */
        FD_CLR(cp->PipeReadEnds[i], &cp->PipeSet);
798

799
800
801
802
803
804
805
        /* The pipe is ready to read without blocking.  Keep trying to
           read until the operation is not interrupted.  */
        while(((n = read(cp->PipeReadEnds[i], cp->PipeBuffer,
                         KWSYSPE_PIPE_BUFFER_SIZE)) < 0) && (errno == EINTR));
        if(n > 0)
          {
          /* We have data on this pipe.  */
806
          if(i == KWSYSPE_PIPE_TERM)
807
            {
808
            /* This is data on the special termination pipe.  Ignore it.  */
809
            }
810
          else if(data && length)
811
            {
812
            /* Report this data.  */
813
814
            *data = cp->PipeBuffer;
            *length = n;
Brad King's avatar
Brad King committed
815
816
817
818
819
820
821
            switch(i)
              {
              case KWSYSPE_PIPE_STDOUT:
                pipeId = kwsysProcess_Pipe_STDOUT; break;
              case KWSYSPE_PIPE_STDERR:
                pipeId = kwsysProcess_Pipe_STDERR; break;
              };
822
823
824
825
826
827
828
829
830
831
832
            break;
            }
          }
        else
          {
          /* We are done reading from this pipe.  */
          kwsysProcessCleanupDescriptor(&cp->PipeReadEnds[i]);
          --cp->PipesLeft;
          }
        }
      }
833

834
835
836
837
838
    /* If we have data, break early.  */
    if(pipeId)
      {
      break;
      }
839

840
841
842
    /* Make sure the set is empty (it should always be empty here
       anyway).  */
    FD_ZERO(&cp->PipeSet);
843

844
845
846
847
848
849
850
851
852
853
854
855
856
    /* Add the pipe reading ends that are still open.  */
    max = -1;
    for(i=0; i < KWSYSPE_PIPE_COUNT; ++i)
      {
      if(cp->PipeReadEnds[i] >= 0)
        {
        FD_SET(cp->PipeReadEnds[i], &cp->PipeSet);
        if(cp->PipeReadEnds[i] > max)
          {
          max = cp->PipeReadEnds[i];
          }
        }
      }
857

858
859
860
861
862
863
    /* Make sure we have a non-empty set.  */
    if(max < 0)
      {
      /* All pipes have closed.  Child has terminated.  */
      break;
      }
864

865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
    /* Setup a timeout if required.  */
    if(timeoutTime.tv_sec < 0)
      {
      timeout = 0;
      }
    else
      {
      timeout = &timeoutLength;
      }
    if(kwsysProcessGetTimeoutLeft(&timeoutTime, &timeoutLength))
      {
      /* Timeout has already expired.  */
      expired = 1;
      break;
      }
880

881
882
883
884
    /* Run select to block until data are available.  Repeat call
       until it is not interrupted.  */
    while(((numReady = select(max+1, &cp->PipeSet, 0, 0, timeout)) < 0) &&
          (errno == EINTR));
885

886
887
888
889
890
891
892
893
894
895
896
    /* Check result of select.  */
    if(numReady == 0)
      {
      /* Select's timeout expired.  */
      expired = 1;
      break;
      }
    else if(numReady < 0)
      {
      /* Select returned an error.  Leave the error description in the
         pipe buffer.  */
897
      strncpy(cp->ErrorMessage, strerror(errno), KWSYSPE_PIPE_BUFFER_SIZE);
898

899
      /* Kill the children now.  */
900
901
      kwsysProcess_Kill(cp);
      cp->Killed = 0;
902
      cp->SelectError = 1;
903
904
905
      cp->PipesLeft = 0;
      }
    }
906

907
908
909
910
911
912
913
914
915
916
917
918
919
  /* Update the user timeout.  */
  if(userTimeout)
    {
    kwsysProcessTime userEndTime = kwsysProcessTimeGetCurrent();
    kwsysProcessTime difference = kwsysProcessTimeSubtract(userEndTime,
                                                     userStartTime);
    double d = kwsysProcessTimeToDouble(difference);
    *userTimeout -= d;
    if(*userTimeout < 0)
      {
      *userTimeout = 0;
      }
    }
920

921
922
923
924
925
926
927
928
929
930
931
932
  /* Check what happened.  */
  if(pipeId)
    {
    /* Data are ready on a pipe.  */
    return pipeId;
    }
  else if(expired)
    {
    /* A timeout has expired.  */
    if(user)
      {
      /* The user timeout has expired.  It has no time left.  */
933
      return kwsysProcess_Pipe_Timeout;
934
935
936
      }
    else
      {
937
      /* The process timeout has expired.  Kill the children now.  */
938
939
940
941
      kwsysProcess_Kill(cp);
      cp->Killed = 0;
      cp->TimeoutExpired = 1;
      cp->PipesLeft = 0;
Brad King's avatar
Brad King committed
942
      return kwsysProcess_Pipe_None;
943
944
945
946
947
      }
    }
  else
    {
    /* No pipes are left open.  */
Brad King's avatar
Brad King committed
948
    return kwsysProcess_Pipe_None;
949
950
951
952
953
954
955
956
957
    }
}

/*--------------------------------------------------------------------------*/
int kwsysProcess_WaitForExit(kwsysProcess* cp, double* userTimeout)
{
  int result = 0;
  int status = 0;
  int pipe = 0;
958

959
  /* Make sure we are executing a process.  */
960
  if(!cp || cp->State != kwsysProcess_State_Executing)
961
962
963
    {
    return 1;
    }
964

965
  /* Wait for all the pipes to close.  Ignore all data.  */
966
  while((pipe = kwsysProcess_WaitForData(cp, 0, 0, userTimeout)) > 0)
967
    {
968
    if(pipe == kwsysProcess_Pipe_Timeout)
969
970
971
972
973
      {
      return 0;
      }
    }

974
975
976
  /* Wait for each child to terminate.  The process should have
     already exited because KWSYSPE_PIPE_TERM has been closed by this
     point.  Repeat the call until it is not interrupted.  */
977
  if(!cp->Detached)
978
    {
979
980
    int i;
    for(i=0; i < cp->NumberOfCommands; ++i)
981
      {
982
983
984
985
986
987
988
989
990
      while(((result = waitpid(cp->ForkPIDs[i],
                               &cp->CommandExitCodes[i], 0)) < 0) &&
            (errno == EINTR));
      if(result <= 0 && cp->State != kwsysProcess_State_Error)
        {
        /* Unexpected error.  Report the first time this happens.  */
        strncpy(cp->ErrorMessage, strerror(errno), KWSYSPE_PIPE_BUFFER_SIZE);
        cp->State = kwsysProcess_State_Error;
        }
991
992
993
994
995
      }
    }

  /* Check if there was an error in one of the waitpid calls.  */
  if(cp->State == kwsysProcess_State_Error)
996
    {
997
998
999
    /* The error message is already in its buffer.  Tell
       kwsysProcessCleanup to not create it.  */
    kwsysProcessCleanup(cp, 0);
1000
1001
    return 1;
    }
1002

1003
  /* Check whether the child reported an error invoking the process.  */
1004
  if(cp->SelectError)
1005
1006
1007
1008
    {
    /* The error message is already in its buffer.  Tell
       kwsysProcessCleanup to not create it.  */
    kwsysProcessCleanup(cp, 0);
1009
    cp->State = kwsysProcess_State_Error;
1010
1011
    return 1;
    }
1012

1013
1014
1015
  /* Use the status of the last process in the pipeline.  */
  status = cp->CommandExitCodes[cp->NumberOfCommands-1];

1016
1017
1018
1019
  /* Determine the outcome.  */
  if(cp->Killed)
    {
    /* We killed the child.  */
1020
    cp->State = kwsysProcess_State_Killed;
1021
1022
1023
1024
    }
  else if(cp->TimeoutExpired)
    {
    /* The timeout expired.  */
1025
    cp->State = kwsysProcess_State_Expired;
1026
1027
1028
    }
  else if(WIFEXITED(status))
    {
1029
1030
1031
1032
1033
    /* The child exited normally.  */
    cp->State = kwsysProcess_State_Exited;
    cp->ExitException = kwsysProcess_Exception_None;
    cp->ExitCode = status;
    cp->ExitValue = (int)WEXITSTATUS(status);
1034
1035
1036
1037
    }
  else if(WIFSIGNALED(status))
    {
    /* The child received an unhandled signal.  */
1038
1039
    cp->State = kwsysProcess_State_Exception;
    cp->ExitCode = status;
1040
    kwsysProcessSetExitException(cp, (int)WTERMSIG(status));
1041
1042
1043
1044
1045
    }
  else
    {
    /* Error getting the child return code.  */
    strcpy(cp->ErrorMessage, "Error getting child return code.");
1046
    cp->State = kwsysProcess_State_Error;
1047
    }
1048

1049
1050
1051
1052
1053
1054
1055
  /* Normal cleanup.  */
  kwsysProcessCleanup(cp, 0);
  return 1;
}

/*--------------------------------------------------------------------------*/
void kwsysProcess_Kill(kwsysProcess* cp)
1056
{
1057
1058
  int i;

1059
  /* Make sure we are executing a process.  */
1060
  if(!cp || cp->State != kwsysProcess_State_Executing)
1061
1062
1063
    {
    return;
    }
1064

1065
  /* Kill the children.  */
1066
  cp->Killed = 1;
1067
1068
1069
1070
  for(i=0; i < cp->NumberOfCommands; ++i)
    {
    if(cp->ForkPIDs[i])
      {
1071
      kwsysProcessKill(cp->ForkPIDs[i]);
1072
1073
      }
    }
1074
1075
1076
1077
}

/*--------------------------------------------------------------------------*/
/* Initialize a process control structure for kwsysProcess_Execute.  */
1078
static int kwsysProcessInitialize(kwsysProcess* cp)
1079
1080
1081
1082
1083
1084
{
  int i;
  for(i=0; i < KWSYSPE_PIPE_COUNT; ++i)
    {
    cp->PipeReadEnds[i] = -1;
    }
1085
  cp->SelectError = 0;
1086
1087
1088
1089
1090
1091
1092
  cp->StartTime.tv_sec = -1;
  cp->StartTime.tv_usec = -1;
  cp->TimeoutTime.tv_sec = -1;
  cp->TimeoutTime.tv_usec = -1;
  cp->TimeoutExpired = 0;
  cp->PipesLeft = 0;
  FD_ZERO(&cp->PipeSet);
1093
  cp->State = kwsysProcess_State_Starting;
1094
  cp->Killed = 0;
1095
1096
1097
  cp->ExitException = kwsysProcess_Exception_None;
  cp->ExitCode = 1;
  cp->ExitValue = 1;
1098
  cp->ErrorMessage[0] = 0;
1099
  strcpy(cp->ExitExceptionString, "No exception");
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122

  if(cp->ForkPIDs)
    {
    free(cp->ForkPIDs);
    }
  cp->ForkPIDs = (pid_t*)malloc(sizeof(pid_t)*cp->NumberOfCommands);
  if(!cp->ForkPIDs)
    {
    return 0;
    }
  memset(cp->ForkPIDs, 0, sizeof(pid_t)*cp->NumberOfCommands);

  if(cp->CommandExitCodes)
    {
    free(cp->CommandExitCodes);
    }
  cp->CommandExitCodes = (int*)malloc(sizeof(int)*cp->NumberOfCommands);
  if(!cp->CommandExitCodes)
    {
    return 0;
    }
  memset(cp->CommandExitCodes, 0, sizeof(int)*cp->NumberOfCommands);

1123
  /* Allocate memory to save the real working directory.  */
1124
1125
  if ( cp->WorkingDirectory )
    {
1126
#if defined(MAXPATHLEN)
1127
    cp->RealWorkingDirectoryLength = MAXPATHLEN;
1128
#elif defined(PATH_MAX)
1129
    cp->RealWorkingDirectoryLength = PATH_MAX;
1130
#else
1131
    cp->RealWorkingDirectoryLength = 4096;
1132
#endif
1133
1134
1135
1136
1137
    cp->RealWorkingDirectory = malloc(cp->RealWorkingDirectoryLength);
    if(!cp->RealWorkingDirectory)
      {
      return 0;
      }
1138
1139
    }

1140
  return 1;
1141
1142
1143
1144
1145
}

/*--------------------------------------------------------------------------*/
/* Free all resources used by the given kwsysProcess instance that were
   allocated by kwsysProcess_Execute.  */
1146
static void kwsysProcessCleanup(kwsysProcess* cp, int error)
1147
1148
{
  int i;
1149

1150
1151
  if(error)
    {
1152
1153
1154
1155
1156
1157
1158
1159
    /* We are cleaning up due to an error.  Report the error message
       if one has not been provided already.  */
    if(cp->ErrorMessage[0] == 0)
      {
      strncpy(cp->ErrorMessage, strerror(errno), KWSYSPE_PIPE_BUFFER_SIZE);
      }

    /* Set the error state.  */
1160
    cp->State = kwsysProcess_State_Error;
1161
1162
1163
1164
1165
1166
1167
1168

    /* Kill any children already started.  */
    if(cp->ForkPIDs)
      {
      for(i=0; i < cp->NumberOfCommands; ++i)
        {
        if(cp->ForkPIDs[i])
          {
1169
          kwsysProcessKill(cp->ForkPIDs[i]);
1170
1171
1172
          }
        }
      }
1173
1174
1175
1176
1177
1178

    /* Restore the working directory.  */
    if(cp->RealWorkingDirectory)
      {
      while((chdir(cp->RealWorkingDirectory) < 0) && (errno == EINTR));
      }
1179
    }
1180

1181
1182
1183
  /* Restore the SIGCHLD handler.  */
  while((sigaction(SIGCHLD, &cp->OldSigChldAction, 0) < 0) &&
        (errno == EINTR));
1184

1185
1186
1187
1188
1189
1190
  /* Free memory.  */
  if(cp->ForkPIDs)
    {
    free(cp->ForkPIDs);
    cp->ForkPIDs = 0;
    }
1191
1192
1193
1194
1195
  if(cp->RealWorkingDirectory)
    {
    free(cp->RealWorkingDirectory);
    cp->RealWorkingDirectory = 0;
    }
1196

1197
1198
1199
1200
1201
1202
1203
1204
1205
  /* Close pipe handles.  */
  for(i=0; i < KWSYSPE_PIPE_COUNT; ++i)
    {
    kwsysProcessCleanupDescriptor(&cp->PipeReadEnds[i]);
    }
}

/*--------------------------------------------------------------------------*/
/* Close the given file descriptor if it is open.  Reset its value to -1.  */
1206
static void kwsysProcessCleanupDescriptor(int* pfd)
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
{
  if(pfd && *pfd >= 0)
    {
    /* Keep trying to close until it is not interrupted by a
     * signal.  */
    while((close(*pfd) < 0) && (errno == EINTR));
    *pfd = -1;
    }
}

1217
/*--------------------------------------------------------------------------*/
1218
1219
static int kwsysProcessCreate(kwsysProcess* cp, int index,
                              kwsysProcessCreateInformation* si, int* readEnd)
1220
1221
1222
1223
{
  /* Setup the process's stdin.  */
  if(index > 0)
    {
1224
    si->StdIn = *readEnd;
1225
1226
    *readEnd = 0;
    }
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
  else if(cp->PipeFileSTDIN)
    {
    /* Open a file for the child's stdin to read.  */
    si->StdIn = open(cp->PipeFileSTDIN, O_RDONLY);
    if(si->StdIn < 0)
      {
      return 0;
      }

    /* Set close-on-exec flag on the pipe's end.  */
    if(fcntl(si->StdIn, F_SETFD, FD_CLOEXEC) < 0)
      {
      return 0;
      }
    }
1242
  else if(cp->PipeSharedSTDIN)
1243
    {
1244
    si->StdIn = 0;
1245
    }
1246
1247
1248
1249
  else
    {
    si->StdIn = -1;
    }
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259

  /* Setup the process's stdout.  */
  {
  /* Create the pipe.  */
  int p[2];
  if(pipe(p) < 0)
    {
    return 0;
    }
  *readEnd = p[0];
1260
  si->StdOut = p[1];
1261
1262
1263
1264
1265
1266
1267
1268
1269

  /* Set close-on-exec flag on the pipe's ends.  */
  if((fcntl(p[0], F_SETFD, FD_CLOEXEC) < 0) ||
     (fcntl(p[1], F_SETFD, FD_CLOEXEC) < 0))
    {
    return 0;
    }
  }

1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
  /* Replace the stdout pipe with a file if requested.  In this case
     the select call will report that stdout is closed immediately.  */
  if(index == cp->NumberOfCommands-1 && cp->PipeFileSTDOUT)
    {
    if(!kwsysProcessSetupOutputPipeFile(&si->StdOut, cp->PipeFileSTDOUT))
      {
      return 0;
      }
    }

Brad King's avatar