1 /*-------------------------------------------------------------------------
2 * drawElements Utility Library
3 * ----------------------------
5 * Copyright 2014 The Android Open Source Project
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
21 * \brief Process abstraction.
22 *//*--------------------------------------------------------------------*/
24 #include "deProcess.h"
28 #if (DE_OS == DE_OS_UNIX) || (DE_OS == DE_OS_OSX) || (DE_OS == DE_OS_IOS) || (DE_OS == DE_OS_ANDROID) || (DE_OS == DE_OS_SYMBIAN) || (DE_OS == DE_OS_QNX)
30 #include "deCommandLine.h"
32 #include <sys/types.h>
40 typedef enum ProcessState_e
42 PROCESSSTATE_NOT_STARTED = 0,
44 PROCESSSTATE_FINISHED,
61 static void die (int statusPipe, const char* message)
63 size_t msgLen = strlen(message);
66 printf("Process launch failed: %s\n", message);
67 res = (int)write(statusPipe, message, msgLen+1);
68 DE_UNREF(res); /* No need to check result. */
72 static void dieLastError (int statusPipe, const char* message)
76 deSprintf(msgBuf, sizeof(msgBuf), "%s, error %d: %s", message, lastErr, strerror(lastErr));
77 die(statusPipe, msgBuf);
80 DE_INLINE deBool beginsWithPath (const char* fileName, const char* pathPrefix)
82 size_t pathLen = strlen(pathPrefix);
84 /* Strip trailing / */
85 while (pathLen > 0 && pathPrefix[pathLen-1] == '/')
88 return pathLen > 0 && deMemoryEqual(fileName, pathPrefix, pathLen) && fileName[pathLen] == '/';
91 static void stripLeadingPath (char* fileName, const char* pathPrefix)
93 size_t pathLen = strlen(pathPrefix);
94 size_t fileNameLen = strlen(fileName);
96 DE_ASSERT(beginsWithPath(fileName, pathPrefix));
98 /* Strip trailing / */
99 while (pathLen > 0 && pathPrefix[pathLen-1] == '/')
102 DE_ASSERT(pathLen > 0);
103 DE_ASSERT(fileName[pathLen] == '/');
105 memmove(&fileName[0], &fileName[0]+pathLen+1, fileNameLen-pathLen);
108 /* Doesn't return on success. */
109 static void execProcess (const char* commandLine, const char* workingDirectory, int statusPipe)
111 deCommandLine* cmdLine = deCommandLine_parse(commandLine);
112 char** argList = cmdLine ? (char**)deCalloc(sizeof(char*)*((size_t)cmdLine->numArgs+1)) : DE_NULL;
114 if (!cmdLine || !argList)
115 die(statusPipe, "Command line parsing failed (out of memory)");
117 if (workingDirectory && chdir(workingDirectory) != 0)
118 dieLastError(statusPipe, "chdir() failed");
122 for (argNdx = 0; argNdx < cmdLine->numArgs; argNdx++)
123 argList[argNdx] = cmdLine->args[argNdx];
124 argList[argNdx] = DE_NULL; /* Terminate with 0. */
127 if (workingDirectory && beginsWithPath(argList[0], workingDirectory))
128 stripLeadingPath(argList[0], workingDirectory);
130 execv(argList[0], argList);
133 dieLastError(statusPipe, "execv() failed");
136 deProcess* deProcess_create (void)
138 deProcess* process = (deProcess*)deCalloc(sizeof(deProcess));
142 process->state = PROCESSSTATE_NOT_STARTED;
147 static void deProcess_cleanupHandles (deProcess* process)
149 if (process->standardIn)
150 deFile_destroy(process->standardIn);
152 if (process->standardOut)
153 deFile_destroy(process->standardOut);
155 if (process->standardErr)
156 deFile_destroy(process->standardErr);
159 process->standardIn = DE_NULL;
160 process->standardOut = DE_NULL;
161 process->standardErr = DE_NULL;
164 void deProcess_destroy (deProcess* process)
166 /* Never leave child processes running. Otherwise we'll have zombies. */
167 if (deProcess_isRunning(process))
169 deProcess_kill(process);
170 deProcess_waitForFinish(process);
173 deProcess_cleanupHandles(process);
174 deFree(process->lastError);
178 const char* deProcess_getLastError (const deProcess* process)
180 return process->lastError ? process->lastError : "No error";
183 int deProcess_getExitCode (const deProcess* process)
185 return process->exitCode;
188 static deBool deProcess_setError (deProcess* process, const char* error)
190 if (process->lastError)
192 deFree(process->lastError);
193 process->lastError = DE_NULL;
196 process->lastError = deStrdup(error);
197 return process->lastError != DE_NULL;
200 static deBool deProcess_setErrorFromErrno (deProcess* process, const char* message)
204 deSprintf(msgBuf, sizeof(msgBuf), "%s, error %d: %s", message, lastErr, strerror(lastErr));
205 return deProcess_setError(process, message);
208 static void closePipe (int p[2])
216 deBool deProcess_start (deProcess* process, const char* commandLine, const char* workingDirectory)
219 int pipeIn[2] = { -1, -1 };
220 int pipeOut[2] = { -1, -1 };
221 int pipeErr[2] = { -1, -1 };
222 int statusPipe[2] = { -1, -1 };
224 if (process->state == PROCESSSTATE_RUNNING)
226 deProcess_setError(process, "Process already running");
229 else if (process->state == PROCESSSTATE_FINISHED)
231 deProcess_cleanupHandles(process);
232 process->state = PROCESSSTATE_NOT_STARTED;
235 if (pipe(pipeIn) < 0 || pipe(pipeOut) < 0 || pipe(pipeErr) < 0 || pipe(statusPipe) < 0)
237 deProcess_setErrorFromErrno(process, "pipe() failed");
242 closePipe(statusPipe);
251 deProcess_setErrorFromErrno(process, "fork() failed");
256 closePipe(statusPipe);
265 /* Close unused endpoints. */
269 close(statusPipe[0]);
271 /* Set status pipe to close on exec(). That way parent will know that exec() succeeded. */
272 if (fcntl(statusPipe[1], F_SETFD, FD_CLOEXEC) != 0)
273 dieLastError(statusPipe[1], "Failed to set FD_CLOEXEC");
276 if (pipeIn[0] != STDIN_FILENO &&
277 dup2(pipeIn[0], STDIN_FILENO) != STDIN_FILENO)
278 dieLastError(statusPipe[1], "dup2() failed");
282 if (pipeOut[1] != STDOUT_FILENO &&
283 dup2(pipeOut[1], STDOUT_FILENO) != STDOUT_FILENO)
284 dieLastError(statusPipe[1], "dup2() failed");
288 if (pipeErr[1] != STDERR_FILENO &&
289 dup2(pipeErr[1], STDERR_FILENO) != STDERR_FILENO)
290 dieLastError(statusPipe[1], "dup2() failed");
293 /* Doesn't return. */
294 execProcess(commandLine, workingDirectory, statusPipe[1]);
298 /* Parent process. */
305 close(statusPipe[1]);
306 while ((result = read(statusPipe[0], errBuf, 1)) == -1)
307 if (errno != EAGAIN && errno != EINTR) break;
313 /* Read full error msg. */
315 while (errPos < DE_LENGTH_OF_ARRAY(errBuf))
317 result = read(statusPipe[0], errBuf+errPos, 1);
324 /* Make sure str is null-terminated. */
328 close(statusPipe[0]);
333 /* Run waitpid to clean up zombie. */
334 waitpid(pid, &procStatus, 0);
336 deProcess_setError(process, errBuf);
341 /* Status pipe is not needed. */
342 close(statusPipe[0]);
345 /* Set running state. */
347 process->state = PROCESSSTATE_RUNNING;
354 process->standardIn = deFile_createFromHandle((deUintptr)pipeIn[1]);
355 process->standardOut = deFile_createFromHandle((deUintptr)pipeOut[0]);
356 process->standardErr = deFile_createFromHandle((deUintptr)pipeErr[0]);
358 if (!process->standardIn)
361 if (!process->standardOut)
364 if (!process->standardErr)
371 deBool deProcess_isRunning (deProcess* process)
373 if (process->state == PROCESSSTATE_RUNNING)
377 if (waitpid(process->pid, &status, WNOHANG) == 0)
378 return DE_TRUE; /* No status available. */
380 if (WIFEXITED(status) || WIFSIGNALED(status))
382 /* Child has finished. */
383 process->state = PROCESSSTATE_FINISHED;
393 deBool deProcess_waitForFinish (deProcess* process)
398 if (process->state != PROCESSSTATE_RUNNING)
400 deProcess_setError(process, "Process is not running");
404 /* \note [pyry] HACK, apparently needed by some versions of OS X. */
405 while ((waitResult = waitpid(process->pid, &status, 0)) != process->pid)
406 if (errno != ENOENT) break;
408 if (waitResult != process->pid)
410 deProcess_setErrorFromErrno(process, "waitpid() failed");
411 return DE_FALSE; /* waitpid() failed. */
414 if (!WIFEXITED(status) && !WIFSIGNALED(status))
416 deProcess_setErrorFromErrno(process, "waitpid() failed");
417 return DE_FALSE; /* Something strange happened. */
420 process->exitCode = WEXITSTATUS(status);
421 process->state = PROCESSSTATE_FINISHED;
425 static deBool deProcess_sendSignal (deProcess* process, int sigNum)
427 if (process->state != PROCESSSTATE_RUNNING)
429 deProcess_setError(process, "Process is not running");
433 if (kill(process->pid, sigNum) == 0)
437 deProcess_setErrorFromErrno(process, "kill() failed");
442 deBool deProcess_terminate (deProcess* process)
444 return deProcess_sendSignal(process, SIGTERM);
447 deBool deProcess_kill (deProcess* process)
449 return deProcess_sendSignal(process, SIGKILL);
452 deFile* deProcess_getStdIn (deProcess* process)
454 return process->standardIn;
457 deFile* deProcess_getStdOut (deProcess* process)
459 return process->standardOut;
462 deFile* deProcess_getStdErr (deProcess* process)
464 return process->standardErr;
467 deBool deProcess_closeStdIn (deProcess* process)
469 if (process->standardIn)
471 deFile_destroy(process->standardIn);
472 process->standardIn = DE_NULL;
479 deBool deProcess_closeStdOut (deProcess* process)
481 if (process->standardOut)
483 deFile_destroy(process->standardOut);
484 process->standardOut = DE_NULL;
491 deBool deProcess_closeStdErr (deProcess* process)
493 if (process->standardErr)
495 deFile_destroy(process->standardErr);
496 process->standardErr = DE_NULL;
503 #elif (DE_OS == DE_OS_WIN32)
506 #define WIN32_LEAN_AND_MEAN
510 typedef enum ProcessState_e
512 PROCESSSTATE_NOT_STARTED = 0,
513 PROCESSSTATE_RUNNING,
514 PROCESSSTATE_FINISHED,
525 PROCESS_INFORMATION procInfo;
531 static deBool deProcess_setError (deProcess* process, const char* error)
533 if (process->lastError)
535 deFree(process->lastError);
536 process->lastError = DE_NULL;
539 process->lastError = deStrdup(error);
540 return process->lastError != DE_NULL;
543 static deBool deProcess_setErrorFromWin32 (deProcess* process, const char* msg)
545 DWORD error = GetLastError();
550 # error Unicode not supported.
553 if (FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER|FORMAT_MESSAGE_FROM_SYSTEM|FORMAT_MESSAGE_IGNORE_INSERTS,
554 NULL, error, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), (LPSTR)&msgBuf, 0, DE_NULL) > 0)
556 deSprintf(errBuf, sizeof(errBuf), "%s, error %d: %s", msg, error, msgBuf);
558 return deProcess_setError(process, errBuf);
562 /* Failed to get error str. */
563 deSprintf(errBuf, sizeof(errBuf), "%s, error %d", msg, error);
564 return deProcess_setError(process, errBuf);
568 deProcess* deProcess_create (void)
570 deProcess* process = (deProcess*)deCalloc(sizeof(deProcess));
574 process->state = PROCESSSTATE_NOT_STARTED;
579 void deProcess_cleanupHandles (deProcess* process)
581 DE_ASSERT(!deProcess_isRunning(process));
583 if (process->standardErr)
584 deFile_destroy(process->standardErr);
586 if (process->standardOut)
587 deFile_destroy(process->standardOut);
589 if (process->standardIn)
590 deFile_destroy(process->standardIn);
592 if (process->procInfo.hProcess)
593 CloseHandle(process->procInfo.hProcess);
595 if (process->procInfo.hThread)
596 CloseHandle(process->procInfo.hThread);
598 process->standardErr = DE_NULL;
599 process->standardOut = DE_NULL;
600 process->standardIn = DE_NULL;
601 process->procInfo.hProcess = DE_NULL;
602 process->procInfo.hThread = DE_NULL;
605 void deProcess_destroy (deProcess* process)
607 if (deProcess_isRunning(process))
609 deProcess_kill(process);
610 deProcess_waitForFinish(process);
613 deProcess_cleanupHandles(process);
614 deFree(process->lastError);
618 const char* deProcess_getLastError (const deProcess* process)
620 return process->lastError ? process->lastError : "No error";
623 int deProcess_getExitCode (const deProcess* process)
625 return process->exitCode;
628 deBool deProcess_start (deProcess* process, const char* commandLine, const char* workingDirectory)
630 SECURITY_ATTRIBUTES securityAttr;
631 STARTUPINFO startInfo;
634 HANDLE stdInRead = DE_NULL;
635 HANDLE stdInWrite = DE_NULL;
636 HANDLE stdOutRead = DE_NULL;
637 HANDLE stdOutWrite = DE_NULL;
638 HANDLE stdErrRead = DE_NULL;
639 HANDLE stdErrWrite = DE_NULL;
641 if (process->state == PROCESSSTATE_RUNNING)
643 deProcess_setError(process, "Process already running");
646 else if (process->state == PROCESSSTATE_FINISHED)
648 /* Process finished, clean up old cruft. */
649 deProcess_cleanupHandles(process);
650 process->state = PROCESSSTATE_NOT_STARTED;
653 deMemset(&startInfo, 0, sizeof(startInfo));
654 deMemset(&securityAttr, 0, sizeof(securityAttr));
656 /* Security attributes for inheriting handle. */
657 securityAttr.nLength = sizeof(SECURITY_ATTRIBUTES);
658 securityAttr.bInheritHandle = TRUE;
659 securityAttr.lpSecurityDescriptor = DE_NULL;
661 /* Create pipes. \todo [2011-10-03 pyry] Clean up handles on error! */
662 if (!CreatePipe(&stdInRead, &stdInWrite, &securityAttr, 0) ||
663 !SetHandleInformation(stdInWrite, HANDLE_FLAG_INHERIT, 0))
665 deProcess_setErrorFromWin32(process, "CreatePipe() failed");
666 CloseHandle(stdInRead);
667 CloseHandle(stdInWrite);
671 if (!CreatePipe(&stdOutRead, &stdOutWrite, &securityAttr, 0) ||
672 !SetHandleInformation(stdOutRead, HANDLE_FLAG_INHERIT, 0))
674 deProcess_setErrorFromWin32(process, "CreatePipe() failed");
675 CloseHandle(stdInRead);
676 CloseHandle(stdInWrite);
677 CloseHandle(stdOutRead);
678 CloseHandle(stdOutWrite);
682 if (!CreatePipe(&stdErrRead, &stdErrWrite, &securityAttr, 0) ||
683 !SetHandleInformation(stdErrRead, HANDLE_FLAG_INHERIT, 0))
685 deProcess_setErrorFromWin32(process, "CreatePipe() failed");
686 CloseHandle(stdInRead);
687 CloseHandle(stdInWrite);
688 CloseHandle(stdOutRead);
689 CloseHandle(stdOutWrite);
690 CloseHandle(stdErrRead);
691 CloseHandle(stdErrWrite);
695 /* Setup startup info. */
696 startInfo.cb = sizeof(startInfo);
697 startInfo.hStdError = stdErrWrite;
698 startInfo.hStdOutput = stdOutWrite;
699 startInfo.hStdInput = stdInRead;
700 startInfo.dwFlags |= STARTF_USESTDHANDLES;
702 if (!CreateProcess(DE_NULL, (LPTSTR)commandLine, DE_NULL, DE_NULL, TRUE /* inherit handles */, 0, DE_NULL, workingDirectory, &startInfo, &process->procInfo))
704 /* Store error info. */
705 deProcess_setErrorFromWin32(process, "CreateProcess() failed");
707 /* Close all handles. */
708 CloseHandle(stdInRead);
709 CloseHandle(stdInWrite);
710 CloseHandle(stdOutRead);
711 CloseHandle(stdOutWrite);
712 CloseHandle(stdErrRead);
713 CloseHandle(stdErrWrite);
718 process->state = PROCESSSTATE_RUNNING;
720 /* Close our ends of handles.*/
721 CloseHandle(stdErrWrite);
722 CloseHandle(stdOutWrite);
723 CloseHandle(stdInRead);
725 /* Construct stdio file objects \note May fail, not detected. */
726 process->standardIn = deFile_createFromHandle((deUintptr)stdInWrite);
727 process->standardOut = deFile_createFromHandle((deUintptr)stdOutRead);
728 process->standardErr = deFile_createFromHandle((deUintptr)stdErrRead);
733 deBool deProcess_isRunning (deProcess* process)
735 if (process->state == PROCESSSTATE_RUNNING)
738 BOOL result = GetExitCodeProcess(process->procInfo.hProcess, (LPDWORD)&exitCode);
742 deProcess_setErrorFromWin32(process, "GetExitCodeProcess() failed");
746 if (exitCode == STILL_ACTIVE)
751 process->exitCode = exitCode;
752 process->state = PROCESSSTATE_FINISHED;
760 deBool deProcess_waitForFinish (deProcess* process)
762 if (process->state == PROCESSSTATE_RUNNING)
764 if (WaitForSingleObject(process->procInfo.hProcess, INFINITE) != WAIT_OBJECT_0)
766 deProcess_setErrorFromWin32(process, "WaitForSingleObject() failed");
769 return !deProcess_isRunning(process);
773 deProcess_setError(process, "Process is not running");
778 static deBool stopProcess (deProcess* process, deBool kill)
780 if (process->state == PROCESSSTATE_RUNNING)
782 if (!TerminateProcess(process->procInfo.hProcess, kill ? -1 : 0))
784 deProcess_setErrorFromWin32(process, "TerminateProcess() failed");
792 deProcess_setError(process, "Process is not running");
797 deBool deProcess_terminate (deProcess* process)
799 return stopProcess(process, DE_FALSE);
802 deBool deProcess_kill (deProcess* process)
804 return stopProcess(process, DE_TRUE);
807 deFile* deProcess_getStdIn (deProcess* process)
809 return process->standardIn;
812 deFile* deProcess_getStdOut (deProcess* process)
814 return process->standardOut;
817 deFile* deProcess_getStdErr (deProcess* process)
819 return process->standardErr;
822 deBool deProcess_closeStdIn (deProcess* process)
824 if (process->standardIn)
826 deFile_destroy(process->standardIn);
827 process->standardIn = DE_NULL;
834 deBool deProcess_closeStdOut (deProcess* process)
836 if (process->standardOut)
838 deFile_destroy(process->standardOut);
839 process->standardOut = DE_NULL;
846 deBool deProcess_closeStdErr (deProcess* process)
848 if (process->standardErr)
850 deFile_destroy(process->standardErr);
851 process->standardErr = DE_NULL;
859 # error Implement deProcess for your OS.