source: trunk/src/kmk/kmkbuiltin/kSubmit.c@ 2879

Last change on this file since 2879 was 2879, checked in by bird, 9 years ago

fixes
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 52.1 KB
Line 
1/* $Id: kSubmit.c 2879 2016-09-05 20:14:21Z bird $ */
2/** @file
3 * kMk Builtin command - submit job to a kWorker.
4 */
5
6/*
7 * Copyright (c) 2007-2016 knut st. osmundsen <bird-kBuild-spamx@anduin.net>
8 *
9 * This file is part of kBuild.
10 *
11 * kBuild is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 3 of the License, or
14 * (at your option) any later version.
15 *
16 * kBuild is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with kBuild. If not, see <http://www.gnu.org/licenses/>
23 *
24 */
25
26/*******************************************************************************
27* Header Files *
28*******************************************************************************/
29#ifdef __APPLE__
30# define _POSIX_C_SOURCE 1 /* 10.4 sdk and unsetenv */
31#endif
32#include "make.h"
33#include "job.h"
34#include "variable.h"
35#include "pathstuff.h"
36#include <stdio.h>
37#include <stdlib.h>
38#include <string.h>
39#include <errno.h>
40#include <assert.h>
41#ifdef HAVE_ALLOCA_H
42# include <alloca.h>
43#endif
44#if defined(_MSC_VER)
45# include <ctype.h>
46# include <io.h>
47# include <direct.h>
48# include <process.h>
49#else
50# include <unistd.h>
51#endif
52#ifdef KBUILD_OS_WINDOWS
53# include "sub_proc.h"
54#endif
55
56#include "kbuild.h"
57#include "kmkbuiltin.h"
58#include "err.h"
59
60
61/*********************************************************************************************************************************
62* Defined Constants And Macros *
63*********************************************************************************************************************************/
64/** Hashes a pid. */
65#define KWORKER_PID_HASH(a_pid) ((size_t)(a_pid) % 61)
66
67
68/*********************************************************************************************************************************
69* Structures and Typedefs *
70*********************************************************************************************************************************/
71typedef struct WORKERINSTANCE *PWORKERINSTANCE;
72typedef struct WORKERINSTANCE
73{
74 /** Pointer to the next worker instance. */
75 PWORKERINSTANCE pNext;
76 /** Pointer to the previous worker instance. */
77 PWORKERINSTANCE pPrev;
78 /** Pointer to the next worker with the same pid hash slot. */
79 PWORKERINSTANCE pNextPidHash;
80 /** 32 or 64. */
81 unsigned cBits;
82 /** The process ID of the kWorker process. */
83 pid_t pid;
84 union
85 {
86 struct
87 {
88 /** The exit code. */
89 int32_t rcExit;
90 /** Set to 1 if the worker is exiting. */
91 uint8_t bWorkerExiting;
92 uint8_t abUnused[3];
93 } s;
94 uint8_t ab[8];
95 } Result;
96 /** Number of result bytes read alread. */
97 size_t cbResultRead;
98
99#ifdef KBUILD_OS_WINDOWS
100 /** The process handle. */
101 HANDLE hProcess;
102 /** The bi-directional pipe we use to talk to the kWorker process. */
103 HANDLE hPipe;
104 /** For overlapped read (have valid event semaphore). */
105 OVERLAPPED OverlappedRead;
106#else
107 /** The socket descriptor we use to talk to the kWorker process. */
108 int fdSocket;
109#endif
110
111 /** What it's busy with. NULL if idle. */
112 struct child *pBusyWith;
113} WORKERINSTANCE;
114
115
116typedef struct WORKERLIST
117{
118 /** The head of the list. NULL if empty. */
119 PWORKERINSTANCE pHead;
120 /** The tail of the list. NULL if empty. */
121 PWORKERINSTANCE pTail;
122 /** Number of list entries. */
123 size_t cEntries;
124} WORKERLIST;
125typedef WORKERLIST *PWORKERLIST;
126
127
128/*********************************************************************************************************************************
129* Global Variables *
130*********************************************************************************************************************************/
131/** List of idle worker.*/
132static WORKERLIST g_IdleList;
133/** List of busy workers. */
134static WORKERLIST g_BusyList;
135/** PID hash table for the workers.
136 * @sa KWORKER_PID_HASH() */
137static PWORKERINSTANCE g_apPidHash[61];
138
139#ifdef KBUILD_OS_WINDOWS
140/** For naming the pipes.
141 * Also indicates how many worker instances we've spawned. */
142static unsigned g_uWorkerSeqNo = 0;
143#endif
144/** Set if we've registred the atexit handler already. */
145static int g_fAtExitRegistered = 0;
146
147/** @var g_cArchBits
148 * The bit count of the architecture this binary is compiled for. */
149/** @var g_szArch
150 * The name of the architecture this binary is compiled for. */
151/** @var g_cArchBits
152 * The bit count of the alternative architecture. */
153/** @var g_szAltArch
154 * The name of the alternative architecture. */
155#if defined(KBUILD_ARCH_AMD64)
156static unsigned g_cArchBits = 64;
157static char const g_szArch[] = "amd64";
158static unsigned g_cAltArchBits = 32;
159static char const g_szAltArch[] = "x86";
160#elif defined(KBUILD_ARCH_X86)
161static unsigned g_cArchBits = 32;
162static char const g_szArch[] = "x86";
163static unsigned g_cAltArchBits = 64;
164static char const g_szAltArch[] = "amd64";
165#else
166# error "Port me!"
167#endif
168
169
170
171/**
172 * Unlinks a worker instance from a list.
173 *
174 * @param pList The list.
175 * @param pWorker The worker.
176 */
177static void kSubmitListUnlink(PWORKERLIST pList, PWORKERINSTANCE pWorker)
178{
179 PWORKERINSTANCE pNext = pWorker->pNext;
180 PWORKERINSTANCE pPrev = pWorker->pPrev;
181
182 if (pNext)
183 {
184 assert(pNext->pPrev == pWorker);
185 pNext->pPrev = pPrev;
186 }
187 else
188 {
189 assert(pList->pTail == pWorker);
190 pList->pTail = pPrev;
191 }
192
193 if (pPrev)
194 {
195 assert(pPrev->pNext == pWorker);
196 pPrev->pNext = pNext;
197 }
198 else
199 {
200 assert(pList->pHead == pWorker);
201 pList->pHead = pNext;
202 }
203
204 assert(!pList->pHead || pList->pHead->pPrev == NULL);
205 assert(!pList->pTail || pList->pTail->pNext == NULL);
206
207 assert(pList->cEntries > 0);
208 pList->cEntries--;
209
210 pWorker->pNext = NULL;
211 pWorker->pPrev = NULL;
212}
213
214
215/**
216 * Appends a worker instance to the tail of a list.
217 *
218 * @param pList The list.
219 * @param pWorker The worker.
220 */
221static void kSubmitListAppend(PWORKERLIST pList, PWORKERINSTANCE pWorker)
222{
223 PWORKERINSTANCE pTail = pList->pTail;
224
225 assert(pTail != pWorker);
226 assert(pList->pHead != pWorker);
227
228 pWorker->pNext = NULL;
229 pWorker->pPrev = pTail;
230 if (pTail != NULL)
231 {
232 assert(pTail->pNext == NULL);
233 pTail->pNext = pWorker;
234 }
235 else
236 {
237 assert(pList->pHead == NULL);
238 pList->pHead = pWorker;
239 }
240 pList->pTail = pWorker;
241
242 assert(pList->pHead->pPrev == NULL);
243 assert(pList->pTail->pNext == NULL);
244
245 pList->cEntries++;
246}
247
248
249/**
250 * Remove worker from the process ID hash table.
251 *
252 * @param pWorker The worker.
253 */
254static void kSubmitPidHashRemove(PWORKERINSTANCE pWorker)
255{
256 size_t idxHash = KWORKER_PID_HASH(pWorker->pid);
257 if (g_apPidHash[idxHash] == pWorker)
258 g_apPidHash[idxHash] = pWorker->pNext;
259 else
260 {
261 PWORKERINSTANCE pPrev = g_apPidHash[idxHash];
262 while (pPrev && pPrev->pNext != pWorker)
263 pPrev = pPrev->pNext;
264 assert(pPrev != NULL);
265 if (pPrev)
266 pPrev->pNext = pWorker->pNext;
267 }
268 pWorker->pid = -1;
269}
270
271
272/**
273 * Looks up a worker by its process ID.
274 *
275 * @returns Pointer to the worker instance if found. NULL if not.
276 * @param pid The process ID of the worker.
277 */
278static PWORKERINSTANCE kSubmitFindWorkerByPid(pid_t pid)
279{
280 PWORKERINSTANCE pWorker = g_apPidHash[KWORKER_PID_HASH(pid)];
281 while (pWorker && pWorker->pid != pid)
282 pWorker = pWorker->pNextPidHash;
283 return pWorker;
284}
285
286
287/**
288 * Creates a new worker process.
289 *
290 * @returns 0 on success, non-zero value on failure.
291 * @param pWorker The worker structure. Caller does the linking
292 * (as we might be reusing an existing worker
293 * instance because a worker shut itself down due
294 * to high resource leak level).
295 * @param cVerbosity The verbosity level.
296 */
297static int kSubmitSpawnWorker(PWORKERINSTANCE pWorker, int cVerbosity)
298{
299#if defined(KBUILD_OS_WINDOWS) || defined(KBUILD_OS_OS2)
300 static const char s_szWorkerName[] = "kWorker.exe";
301#else
302 static const char s_szWorkerName[] = "kWorker";
303#endif
304 const char *pszBinPath = get_kbuild_bin_path();
305 size_t const cchBinPath = strlen(pszBinPath);
306 size_t cchExectuable;
307 size_t const cbExecutableBuf = GET_PATH_MAX;
308 PATH_VAR(szExecutable);
309#define TUPLE(a_sz) a_sz, sizeof(a_sz) - 1
310 struct variable *pVarVolatile = lookup_variable(TUPLE("PATH_OUT"));
311 if (pVarVolatile)
312 { /* likely */ }
313 else
314 {
315 pVarVolatile = lookup_variable(TUPLE("PATH_OUT_BASE"));
316 if (!pVarVolatile)
317 warn("Neither PATH_OUT_BASE nor PATH_OUT was found.");
318 }
319
320 /*
321 * Construct the executable path.
322 */
323 if ( pWorker->cBits == g_cArchBits
324 ? cchBinPath + 1 + sizeof(s_szWorkerName) <= cbExecutableBuf
325 : cchBinPath + 1 - sizeof(g_szArch) + sizeof(g_szAltArch) + sizeof(s_szWorkerName) <= cbExecutableBuf )
326 {
327#ifdef KBUILD_OS_WINDOWS
328 static DWORD s_fDenyRemoteClients = ~(DWORD)0;
329 wchar_t wszPipeName[64];
330 HANDLE hWorkerPipe;
331 SECURITY_ATTRIBUTES SecAttrs = { /*nLength:*/ sizeof(SecAttrs), /*pAttrs:*/ NULL, /*bInheritHandle:*/ TRUE };
332#else
333 int aiPair[2] = { -1, -1 };
334#endif
335
336 memcpy(szExecutable, pszBinPath, cchBinPath);
337 cchExectuable = cchBinPath;
338
339 /* Replace the arch bin directory extension with the alternative one if requested. */
340 if (pWorker->cBits != g_cArchBits)
341 {
342 if ( cchBinPath < sizeof(g_szArch)
343 || memcmp(&szExecutable[cchBinPath - sizeof(g_szArch) + 1], g_szArch, sizeof(g_szArch) - 1) != 0)
344 return errx(1, "KBUILD_BIN_PATH does not end with main architecture (%s) as expected: %s", pszBinPath, g_szArch);
345 cchExectuable -= sizeof(g_szArch) - 1;
346 memcpy(&szExecutable[cchExectuable], g_szAltArch, sizeof(g_szAltArch) - 1);
347 cchExectuable += sizeof(g_szAltArch) - 1;
348 }
349
350 /* Append a slash and the worker name. */
351 szExecutable[cchExectuable++] = '/';
352 memcpy(&szExecutable[cchExectuable], s_szWorkerName, sizeof(s_szWorkerName));
353
354#ifdef KBUILD_OS_WINDOWS
355 /*
356 * Create the bi-directional pipe. Worker end is marked inheritable, our end is not.
357 */
358 if (s_fDenyRemoteClients == ~(DWORD)0)
359 s_fDenyRemoteClients = GetVersion() >= 0x60000 ? PIPE_REJECT_REMOTE_CLIENTS : 0;
360 _snwprintf(wszPipeName, sizeof(wszPipeName), L"\\\\.\\pipe\\kmk-%u-kWorker-%u", getpid(), g_uWorkerSeqNo++);
361 hWorkerPipe = CreateNamedPipeW(wszPipeName,
362 PIPE_ACCESS_DUPLEX | FILE_FLAG_OVERLAPPED | FILE_FLAG_FIRST_PIPE_INSTANCE /* win2k sp2+ */,
363 PIPE_TYPE_BYTE | PIPE_READMODE_BYTE | PIPE_WAIT | s_fDenyRemoteClients,
364 1 /* cMaxInstances */,
365 64 /*cbOutBuffer*/,
366 65536 /*cbInBuffer*/,
367 0 /*cMsDefaultTimeout -> 50ms*/,
368 &SecAttrs /* inherit */);
369 if (hWorkerPipe != INVALID_HANDLE_VALUE)
370 {
371 pWorker->hPipe = CreateFileW(wszPipeName,
372 GENERIC_READ | GENERIC_WRITE,
373 0 /* dwShareMode - no sharing */,
374 NULL /*pSecAttr - no inherit */,
375 OPEN_EXISTING,
376 FILE_FLAG_OVERLAPPED,
377 NULL /*hTemplate*/);
378 if (pWorker->hPipe != INVALID_HANDLE_VALUE)
379 {
380 pWorker->OverlappedRead.hEvent = CreateEventW(NULL /*pSecAttrs - no inherit*/, TRUE /*bManualReset*/,
381 TRUE /*bInitialState*/, NULL /*pwszName*/);
382 if (pWorker->OverlappedRead.hEvent != NULL)
383 {
384 char szHandleArg[32];
385 const char *apszArgs[6] =
386 {
387 szExecutable, "--pipe", szHandleArg,
388 pVarVolatile ? "--volatile" : NULL, pVarVolatile ? pVarVolatile->value : NULL,
389 NULL
390 };
391 _snprintf(szHandleArg, sizeof(szHandleArg), "%p", hWorkerPipe);
392
393 /*
394 * Create the worker process.
395 */
396 pWorker->hProcess = (HANDLE) _spawnve(_P_NOWAIT, szExecutable, apszArgs, environ);
397 if ((intptr_t)pWorker->hProcess != -1)
398 {
399 CloseHandle(hWorkerPipe);
400 pWorker->pid = GetProcessId(pWorker->hProcess);
401 if (cVerbosity > 0)
402 fprintf(stderr, "kSubmit: created %d bit worker %d\n", pWorker->cBits, pWorker->pid);
403 return 0;
404 }
405 err(1, "_spawnve(,%s,,)", szExecutable);
406 CloseHandle(pWorker->OverlappedRead.hEvent);
407 pWorker->OverlappedRead.hEvent = INVALID_HANDLE_VALUE;
408 }
409 else
410 errx(1, "CreateEventW failed: %u", GetLastError());
411 CloseHandle(pWorker->hPipe);
412 pWorker->hPipe = INVALID_HANDLE_VALUE;
413 }
414 else
415 errx(1, "Opening named pipe failed: %u", GetLastError());
416 CloseHandle(hWorkerPipe);
417 }
418 else
419 errx(1, "CreateNamedPipeW failed: %u", GetLastError());
420
421#else
422 /*
423 * Create a socket pair.
424 */
425 if (socketpair(AF_LOCAL, SOCK_STREAM, 0, aiPair) == 0)
426 {
427 pWorker->fdSocket = aiPair[1];
428 }
429 else
430 err(1, "socketpair");
431#endif
432 }
433 else
434 errx(1, "KBUILD_BIN_PATH is too long");
435 return -1;
436}
437
438
439/**
440 * Selects an idle worker or spawns a new one.
441 *
442 * @returns Pointer to the selected worker instance. NULL on error.
443 * @param pWorker The idle worker instance to respawn.
444 * On failure this will be freed!
445 * @param cBitsWorker The worker bitness - 64 or 32.
446 */
447static int kSubmitRespawnWorker(PWORKERINSTANCE pWorker, int cVerbosity)
448{
449 /*
450 * Clean up after the old worker.
451 */
452#ifdef KBUILD_OS_WINDOWS
453 DWORD rcWait;
454
455 /* Close the pipe handle first, breaking the pipe in case it's not already
456 busted up. Close the event semaphore too before waiting for the process. */
457 if (pWorker->hPipe != INVALID_HANDLE_VALUE)
458 {
459 if (!CloseHandle(pWorker->hPipe))
460 warnx("CloseHandle(pWorker->hPipe): %u", GetLastError());
461 pWorker->hPipe = INVALID_HANDLE_VALUE;
462 }
463
464 if (!CloseHandle(pWorker->OverlappedRead.hEvent))
465 warnx("CloseHandle(pWorker->OverlappedRead.hEvent): %u", GetLastError());
466 pWorker->OverlappedRead.hEvent = INVALID_HANDLE_VALUE;
467
468 /* It's probably shutdown already, if not give it 10 milliseconds before
469 we terminate it forcefully. */
470 rcWait = WaitForSingleObject(pWorker->hProcess, 10);
471 if (rcWait != WAIT_OBJECT_0)
472 {
473 BOOL fRc = TerminateProcess(pWorker->hProcess, 127);
474 rcWait = WaitForSingleObject(pWorker->hProcess, 100);
475 if (rcWait != WAIT_OBJECT_0)
476 warnx("WaitForSingleObject returns %u (and TerminateProcess %d)", rcWait, fRc);
477 }
478
479 if (!CloseHandle(pWorker->hProcess))
480 warnx("CloseHandle(pWorker->hProcess): %u", GetLastError());
481 pWorker->hProcess = INVALID_HANDLE_VALUE;
482
483#else
484 pid_t pidWait;
485 int rc;
486
487 if (pWorker->fdSocket != -1)
488 {
489 if (close(pWorker->fdSocket) != 0)
490 warn("close(pWorker->fdSocket)");
491 pWorker->fdSocket = -1;
492 }
493
494 kill(pWorker->pid, SIGTERM);
495 pidWait = waitpid(pWorker->pid, &rc, 0);
496 if (pidWait != pWorker->pid)
497 warn("waitpid(pWorker->pid,,0)");
498#endif
499
500 /*
501 * Unlink it from the hash table.
502 */
503 kSubmitPidHashRemove(pWorker);
504
505 /*
506 * Respawn it.
507 */
508 if (kSubmitSpawnWorker(pWorker, cVerbosity) == 0)
509 {
510 /*
511 * Insert it into the process ID hash table and idle list.
512 */
513 size_t idxHash = KWORKER_PID_HASH(pWorker->pid);
514 pWorker->pNextPidHash = g_apPidHash[idxHash];
515 g_apPidHash[idxHash] = pWorker;
516 return 0;
517 }
518
519 kSubmitListUnlink(&g_IdleList, pWorker);
520 free(pWorker);
521 return -1;
522}
523
524
525/**
526 * Selects an idle worker or spawns a new one.
527 *
528 * @returns Pointer to the selected worker instance. NULL on error.
529 * @param cBitsWorker The worker bitness - 64 or 32.
530 */
531static PWORKERINSTANCE kSubmitSelectWorkSpawnNewIfNecessary(unsigned cBitsWorker, int cVerbosity)
532{
533 /*
534 * Lookup up an idle worker.
535 */
536 PWORKERINSTANCE pWorker = g_IdleList.pHead;
537 while (pWorker)
538 {
539 if (pWorker->cBits == cBitsWorker)
540 return pWorker;
541 pWorker = pWorker->pNext;
542 }
543
544 /*
545 * Create a new worker instance.
546 */
547 pWorker = (PWORKERINSTANCE)xcalloc(sizeof(*pWorker));
548 pWorker->cBits = cBitsWorker;
549 if (kSubmitSpawnWorker(pWorker, cVerbosity) == 0)
550 {
551 /*
552 * Insert it into the process ID hash table and idle list.
553 */
554 size_t idxHash = KWORKER_PID_HASH(pWorker->pid);
555 pWorker->pNextPidHash = g_apPidHash[idxHash];
556 g_apPidHash[idxHash] = pWorker;
557
558 kSubmitListAppend(&g_IdleList, pWorker);
559 return pWorker;
560 }
561
562 free(pWorker);
563 return NULL;
564}
565
566
567/**
568 * Composes a JOB mesage for a worker.
569 *
570 * @returns Pointer to the message.
571 * @param pszExecutable The executable to run.
572 * @param papszArgs The argument vector.
573 * @param papszEnvVars The environment vector.
574 * @param pszCwd The current directory.
575 * @param fWatcomBrainDamage The wcc/wcc386 workaround.
576 * @param pcbMsg Where to return the message length.
577 */
578static void *kSubmitComposeJobMessage(const char *pszExecutable, char **papszArgs, char **papszEnvVars,
579 const char *pszCwd, int fWatcomBrainDamage, uint32_t *pcbMsg)
580{
581 size_t cbTmp;
582 uint32_t i;
583 uint32_t cbMsg;
584 uint32_t cArgs;
585 uint32_t cEnvVars;
586 uint8_t *pbMsg;
587 uint8_t *pbCursor;
588
589 /*
590 * Adjust input.
591 */
592 if (!pszExecutable)
593 pszExecutable = papszArgs[0];
594
595 /*
596 * Calculate the message length first.
597 */
598 cbMsg = sizeof(cbMsg);
599 cbMsg += sizeof("JOB");
600 cbMsg += strlen(pszExecutable) + 1;
601 cbMsg += strlen(pszCwd) + 1;
602
603 cbMsg += sizeof(cArgs);
604 for (i = 0; papszArgs[i] != NULL; i++)
605 cbMsg += 1 + strlen(papszArgs[i]) + 1;
606 cArgs = i;
607
608 cbMsg += sizeof(cArgs);
609 for (i = 0; papszEnvVars[i] != NULL; i++)
610 cbMsg += strlen(papszEnvVars[i]) + 1;
611 cEnvVars = i;
612
613 cbMsg += 1;
614
615 /*
616 * Compose the message.
617 */
618 pbMsg = pbCursor = xmalloc(cbMsg);
619
620 memcpy(pbCursor, &cbMsg, sizeof(cbMsg));
621 pbCursor += sizeof(cbMsg);
622 memcpy(pbCursor, "JOB", sizeof("JOB"));
623 pbCursor += sizeof("JOB");
624
625 cbTmp = strlen(pszExecutable) + 1;
626 memcpy(pbCursor, pszExecutable, cbTmp);
627 pbCursor += cbTmp;
628
629 cbTmp = strlen(pszCwd) + 1;
630 memcpy(pbCursor, pszCwd, cbTmp);
631 pbCursor += cbTmp;
632
633 memcpy(pbCursor, &cArgs, sizeof(cArgs));
634 pbCursor += sizeof(cArgs);
635 for (i = 0; papszArgs[i] != NULL; i++)
636 {
637 *pbCursor++ = 0; /* Argument expansion flags (MSC, EMX). */
638 cbTmp = strlen(papszArgs[i]) + 1;
639 memcpy(pbCursor, papszArgs[i], cbTmp);
640 pbCursor += cbTmp;
641 }
642 assert(i == cArgs);
643
644 memcpy(pbCursor, &cEnvVars, sizeof(cEnvVars));
645 pbCursor += sizeof(cEnvVars);
646 for (i = 0; papszEnvVars[i] != NULL; i++)
647 {
648 cbTmp = strlen(papszEnvVars[i]) + 1;
649 memcpy(pbCursor, papszEnvVars[i], cbTmp);
650 pbCursor += cbTmp;
651 }
652 assert(i == cEnvVars);
653
654 *pbCursor++ = fWatcomBrainDamage != 0;
655
656 assert(pbCursor - pbMsg == (size_t)cbMsg);
657
658 /* done */
659 *pcbMsg = cbMsg;
660 return pbMsg;
661}
662
663
664/**
665 * Sends the job message to the given worker, respawning the worker if
666 * necessary.
667 *
668 * @returns 0 on success, non-zero on failure.
669 *
670 * @param pWorker The work to send the request to. The worker is
671 * on the idle list.
672 * @param pvMsg The message to send.
673 * @param cbMsg The size of the message.
674 * @param fNoRespawning Set if
675 * @param cVerbosity The verbosity level.
676 */
677static int kSubmitSendJobMessage(PWORKERINSTANCE pWorker, void const *pvMsg, uint32_t cbMsg, int fNoRespawning, int cVerbosity)
678{
679 int cRetries;
680
681 /*
682 * Respawn the worker if it stopped by itself and we closed the pipe already.
683 */
684#ifdef KBUILD_OS_WINDOWS
685 if (pWorker->hPipe == INVALID_HANDLE_VALUE)
686#else
687 if (pWorker->fdSocket == -1)
688#endif
689 {
690 if (!fNoRespawning)
691 {
692 if (cVerbosity > 0)
693 fprintf(stderr, "kSubmit: Respawning worker (#1)...\n");
694 if (kSubmitRespawnWorker(pWorker, cVerbosity) != 0)
695 return 2;
696 }
697
698 }
699
700 /*
701 * Restart-on-broken-pipe loop. Necessary?
702 */
703 for (cRetries = !fNoRespawning ? 1 : 0; ; cRetries--)
704 {
705 /*
706 * Try write the message.
707 */
708 uint32_t cbLeft = cbMsg;
709 uint8_t const *pbLeft = (uint8_t const *)pvMsg;
710#ifdef KBUILD_OS_WINDOWS
711 DWORD dwErr;
712 DWORD cbWritten;
713 while (WriteFile(pWorker->hPipe, pbLeft, cbLeft, &cbWritten, NULL /*pOverlapped*/))
714 {
715 assert(cbWritten <= cbLeft);
716 cbLeft -= cbWritten;
717 if (!cbLeft)
718 return 0;
719
720 /* This scenario shouldn't really ever happen. But just in case... */
721 pbLeft += cbWritten;
722 }
723 dwErr = GetLastError();
724 if ( ( dwErr != ERROR_BROKEN_PIPE
725 && dwErr != ERROR_NO_DATA)
726 || cRetries <= 0)
727 return errx(1, "Error writing to worker: %u", dwErr);
728#else
729 ssize_t cbWritten
730 while ((cbWritten = write(pWorker->fdSocket, pbLeft, cbLeft)) >= 0)
731 {
732 assert(cbWritten <= cbLeft);
733 cbLeft -= cbWritten;
734 if (!cbLeft)
735 return 0;
736
737 pbLeft += cbWritten;
738 }
739 if ( ( errno != EPIPE
740 && errno != ENOTCONN
741 && errno != ECONNRESET))
742 || cRetries <= 0)
743 return err(1, "Error writing to worker");
744# error "later"
745#endif
746
747 /*
748 * Broken connection. Try respawn the worker.
749 */
750 if (cVerbosity > 0)
751 fprintf(stderr, "kSubmit: Respawning worker (#2)...\n");
752 if (kSubmitRespawnWorker(pWorker, cVerbosity) != 0)
753 return 2;
754 }
755}
756
757
758/**
759 * Closes the connection on a worker that said it is going to exit now.
760 *
761 * This is a way of dealing with imperfect resource management in the worker, it
762 * will monitor it a little and trigger a respawn when it looks bad.
763 *
764 * This function just closes the pipe / socket connection to the worker. The
765 * kSubmitSendJobMessage function will see this a trigger a respawn the next
766 * time the worker is engaged. This will usually mean there's a little delay in
767 * which the process can terminate without us having to actively wait for it.
768 *
769 * @param pWorker The worker instance.
770 */
771static void kSubmitCloseConnectOnExitingWorker(PWORKERINSTANCE pWorker)
772{
773#ifdef KBUILD_OS_WINDOWS
774 if (!CloseHandle(pWorker->hPipe))
775 warnx("CloseHandle(pWorker->hPipe): %u", GetLastError());
776 pWorker->hPipe = INVALID_HANDLE_VALUE;
777#else
778 if (close(pWorker->fdSocket) != 0)
779 warn("close(pWorker->fdSocket)");
780 pWorker->fdSocket = -1;
781#endif
782}
783
784
785#ifdef KBUILD_OS_WINDOWS
786
787/**
788 * Handles read failure.
789 *
790 * @returns Exit code.
791 * @param pWorker The worker instance.
792 * @param dwErr The error code.
793 * @param pszWhere Where it failed.
794 */
795static int kSubmitWinReadFailed(PWORKERINSTANCE pWorker, DWORD dwErr, const char *pszWhere)
796{
797 DWORD dwExitCode;
798
799 if (pWorker->cbResultRead == 0)
800 errx(1, "%s/ReadFile failed: %u", pszWhere, dwErr);
801 else
802 errx(1, "%s/ReadFile failed: %u (read %u bytes)", pszWhere, dwErr, pWorker->cbResultRead);
803 assert(dwErr != 0);
804
805 /* Complete the result. */
806 pWorker->Result.s.rcExit = 127;
807 pWorker->Result.s.bWorkerExiting = 1;
808 pWorker->cbResultRead = sizeof(pWorker->Result);
809
810 if (GetExitCodeProcess(pWorker->hProcess, &dwExitCode))
811 {
812 if (dwExitCode != 0)
813 pWorker->Result.s.rcExit = dwExitCode;
814 }
815
816 return dwErr != 0 ? (int)(dwErr & 0x7fffffff) : 0x7fffffff;
817
818}
819
820
821/**
822 * Used by
823 * @returns 0 if we got the whole result, -1 if I/O is pending, and windows last
824 * error on ReadFile failure.
825 * @param pWorker The worker instance.
826 */
827static int kSubmitReadMoreResultWin(PWORKERINSTANCE pWorker, const char *pszWhere)
828{
829 /*
830 * Set up the result read, telling the sub_proc.c unit about it.
831 */
832 while (pWorker->cbResultRead < sizeof(pWorker->Result))
833 {
834 DWORD cbRead = 0;
835
836 BOOL fRc = ResetEvent(pWorker->OverlappedRead.hEvent);
837 assert(fRc); (void)fRc;
838
839 pWorker->OverlappedRead.Offset = 0;
840 pWorker->OverlappedRead.OffsetHigh = 0;
841
842 if (!ReadFile(pWorker->hPipe, &pWorker->Result.ab[pWorker->cbResultRead],
843 sizeof(pWorker->Result) - pWorker->cbResultRead,
844 &cbRead,
845 &pWorker->OverlappedRead))
846 {
847 DWORD dwErr = GetLastError();
848 if (dwErr == ERROR_IO_PENDING)
849 return -1;
850 return kSubmitWinReadFailed(pWorker, dwErr, pszWhere);
851 }
852
853 pWorker->cbResultRead += cbRead;
854 assert(pWorker->cbResultRead <= sizeof(pWorker->Result));
855 }
856 return 0;
857}
858
859#endif /* KBUILD_OS_WINDOWS */
860
861/**
862 * Marks the worker active.
863 *
864 * On windows this involves setting up the async result read and telling
865 * sub_proc.c about the process.
866 *
867 * @returns Exit code.
868 * @param pWorker The worker instance to mark as active.
869 * @param cVerbosity The verbosity level.
870 * @param pChild The kmk child to associate the job with.
871 * @param pPidSpawned If @a *pPidSpawned is non-zero if the child is
872 * running, otherwise the worker is already done
873 * and we've returned the exit code of the job.
874 */
875static int kSubmitMarkActive(PWORKERINSTANCE pWorker, int cVerbosity, struct child *pChild, pid_t *pPidSpawned)
876{
877#ifdef KBUILD_OS_WINDOWS
878 int rc;
879#endif
880
881 pWorker->cbResultRead = 0;
882
883#ifdef KBUILD_OS_WINDOWS
884 /*
885 * Setup the async result read on windows. If we're slow and the worker
886 * very fast, this may actually get the result immediately.
887 */
888l_again:
889 rc = kSubmitReadMoreResultWin(pWorker, "kSubmitMarkActive");
890 if (rc == -1)
891 {
892 if (process_kmk_register_submit(pWorker->OverlappedRead.hEvent, (intptr_t)pWorker, pPidSpawned) == 0)
893 { /* likely */ }
894 else
895 {
896 /* We need to do the waiting here because sub_proc.c has too much to do. */
897 warnx("Too many processes for sub_proc.c to handle!");
898 WaitForSingleObject(pWorker->OverlappedRead.hEvent, INFINITE);
899 goto l_again;
900 }
901 }
902 else
903 {
904 assert(rc == 0 || pWorker->Result.s.rcExit != 0);
905 if (pWorker->Result.s.bWorkerExiting)
906 kSubmitCloseConnectOnExitingWorker(pWorker);
907 *pPidSpawned = 0;
908 return pWorker->Result.s.rcExit;
909 }
910#endif
911
912 /*
913 * Mark it busy and move it to the active instance.
914 */
915 pWorker->pBusyWith = pChild;
916#ifndef KBUILD_OS_WINDOWS
917 *pPidSpawned = pWorker->pid;
918#endif
919
920 kSubmitListUnlink(&g_IdleList, pWorker);
921 kSubmitListAppend(&g_BusyList, pWorker);
922 return 0;
923}
924
925
926#ifdef KBUILD_OS_WINDOWS
927
928/**
929 * Retrieve the worker child result.
930 *
931 * If incomplete, we restart the ReadFile operation like kSubmitMarkActive does.
932 *
933 * @returns 0 on success, -1 if ReadFile was restarted.
934 * @param pvUser The worker instance.
935 * @param prcExit Where to return the exit code.
936 * @param piSigNo Where to return the signal number.
937 */
938int kSubmitSubProcGetResult(intptr_t pvUser, int *prcExit, int *piSigNo)
939{
940 PWORKERINSTANCE pWorker = (PWORKERINSTANCE)pvUser;
941
942 /*
943 * Get the overlapped result. There should be one since we're here
944 * because of a satisfied WaitForMultipleObject.
945 */
946 DWORD cbRead = 0;
947 if (GetOverlappedResult(pWorker->hPipe, &pWorker->OverlappedRead, &cbRead, TRUE))
948 {
949 pWorker->cbResultRead += cbRead;
950 assert(pWorker->cbResultRead <= sizeof(pWorker->Result));
951
952 /* More to be read? */
953 while (pWorker->cbResultRead < sizeof(pWorker->Result))
954 {
955 int rc = kSubmitReadMoreResultWin(pWorker, "kSubmitSubProcGetResult/more");
956 if (rc == -1)
957 return -1;
958 assert(rc == 0 || pWorker->Result.s.rcExit != 0);
959 }
960 assert(pWorker->cbResultRead == sizeof(pWorker->Result));
961 }
962 else
963 {
964 DWORD dwErr = GetLastError();
965 kSubmitWinReadFailed(pWorker, dwErr, "kSubmitSubProcGetResult/result");
966 }
967
968 /*
969 * Okay, we've got a result.
970 */
971 *prcExit = pWorker->Result.s.rcExit;
972 switch (pWorker->Result.s.rcExit)
973 {
974 default: *piSigNo = 0; break;
975 case CONTROL_C_EXIT: *piSigNo = SIGINT; break;
976 case STATUS_INTEGER_DIVIDE_BY_ZERO: *piSigNo = SIGFPE; break;
977 case STATUS_ACCESS_VIOLATION: *piSigNo = SIGSEGV; break;
978 case STATUS_PRIVILEGED_INSTRUCTION:
979 case STATUS_ILLEGAL_INSTRUCTION: *piSigNo = SIGILL; break;
980 }
981
982 return 0;
983}
984
985
986int kSubmitSubProcKill(intptr_t pvUser, int iSignal)
987{
988 return -1;
989}
990
991
992/**
993 * Called by process_cleanup when it's done with the worker.
994 *
995 * @param pvUser The worker instance.
996 */
997void kSubmitSubProcCleanup(intptr_t pvUser)
998{
999 PWORKERINSTANCE pWorker = (PWORKERINSTANCE)pvUser;
1000 kSubmitListUnlink(&g_BusyList, pWorker);
1001 kSubmitListAppend(&g_IdleList, pWorker);
1002}
1003
1004#endif /* KBUILD_OS_WINDOWS */
1005
1006
1007/**
1008 * atexit callback that trigger worker termination.
1009 */
1010static void kSubmitAtExitCallback(void)
1011{
1012 PWORKERINSTANCE pWorker;
1013 DWORD msStartTick;
1014 DWORD cKillRaids = 0;
1015
1016 /*
1017 * Tell all the workers to exit by breaking the connection.
1018 */
1019 for (pWorker = g_IdleList.pHead; pWorker != NULL; pWorker = pWorker->pNext)
1020 kSubmitCloseConnectOnExitingWorker(pWorker);
1021 for (pWorker = g_BusyList.pHead; pWorker != NULL; pWorker = pWorker->pNext)
1022 kSubmitCloseConnectOnExitingWorker(pWorker);
1023
1024 /*
1025 * Wait a little while for them to stop.
1026 */
1027 Sleep(0);
1028 msStartTick = GetTickCount();
1029 for (;;)
1030 {
1031 /*
1032 * Collect handles of running processes.
1033 */
1034 PWORKERINSTANCE apWorkers[MAXIMUM_WAIT_OBJECTS];
1035 HANDLE ahHandles[MAXIMUM_WAIT_OBJECTS];
1036 DWORD cHandles = 0;
1037
1038 for (pWorker = g_IdleList.pHead; pWorker != NULL; pWorker = pWorker->pNext)
1039 if (pWorker->hProcess != INVALID_HANDLE_VALUE)
1040 {
1041 if (cHandles < MAXIMUM_WAIT_OBJECTS)
1042 {
1043 apWorkers[cHandles] = pWorker;
1044 ahHandles[cHandles] = pWorker->hProcess;
1045 }
1046 cHandles++;
1047 }
1048 for (pWorker = g_BusyList.pHead; pWorker != NULL; pWorker = pWorker->pNext)
1049 if (pWorker->hProcess != INVALID_HANDLE_VALUE)
1050 {
1051 if (cHandles < MAXIMUM_WAIT_OBJECTS)
1052 {
1053 apWorkers[cHandles] = pWorker;
1054 ahHandles[cHandles] = pWorker->hProcess;
1055 }
1056 cHandles++;
1057 }
1058 if (cHandles == 0)
1059 return;
1060
1061 /*
1062 * Wait for the processes.
1063 */
1064 for (;;)
1065 {
1066 DWORD cMsElapsed = GetTickCount() - msStartTick;
1067 DWORD dwWait = WaitForMultipleObjects(cHandles <= MAXIMUM_WAIT_OBJECTS ? cHandles : MAXIMUM_WAIT_OBJECTS,
1068 ahHandles, FALSE /*bWaitAll*/,
1069 cMsElapsed < 1000 ? 1000 - cMsElapsed + 16 : 16);
1070 if ( dwWait >= WAIT_OBJECT_0
1071 && dwWait <= WAIT_OBJECT_0 + MAXIMUM_WAIT_OBJECTS)
1072 {
1073 size_t idx = dwWait - WAIT_OBJECT_0;
1074 CloseHandle(apWorkers[idx]->hProcess);
1075 apWorkers[idx]->hProcess = INVALID_HANDLE_VALUE;
1076
1077 if (cHandles <= MAXIMUM_WAIT_OBJECTS)
1078 {
1079 /* Restart the wait with the worker removed, or quit if it was the last worker. */
1080 cHandles--;
1081 if (!cHandles)
1082 return;
1083 if (idx != cHandles)
1084 {
1085 apWorkers[idx] = apWorkers[cHandles];
1086 ahHandles[idx] = ahHandles[cHandles];
1087 }
1088 continue;
1089 }
1090 /* else: Reconstruct the wait array so we get maximum coverage. */
1091 }
1092 else if (dwWait == WAIT_TIMEOUT)
1093 {
1094 /* Terminate the whole bunch. */
1095 cKillRaids++;
1096 if (cKillRaids <= 2)
1097 {
1098 fprintf(stderr, "kmk/kSubmit: Killing %u lingering worker processe(s)!\n", cHandles);
1099 for (pWorker = g_IdleList.pHead; pWorker != NULL; pWorker = pWorker->pNext)
1100 if (pWorker->hProcess != INVALID_HANDLE_VALUE)
1101 TerminateProcess(pWorker->hProcess, WAIT_TIMEOUT);
1102 for (pWorker = g_BusyList.pHead; pWorker != NULL; pWorker = pWorker->pNext)
1103 if (pWorker->hProcess != INVALID_HANDLE_VALUE)
1104 TerminateProcess(pWorker->hProcess, WAIT_TIMEOUT);
1105 }
1106 else
1107 {
1108 fprintf(stderr, "kmk/kSubmit: Giving up on the last %u worker processe(s). :-(\n", cHandles);
1109 break;
1110 }
1111 }
1112 else
1113 {
1114 /* Some kind of wait error. Could be a bad handle, check each and remove
1115 bad ones as well as completed ones. */
1116 size_t idx;
1117 fprintf(stderr, "kmk/kSubmit: WaitForMultipleObjects unexpectedly returned %#u (err=%u)\n",
1118 dwWait, GetLastError());
1119 for (idx = 0; idx < cHandles; idx++)
1120 {
1121 dwWait = WaitForSingleObject(ahHandles[idx], 0 /*ms*/);
1122 if (dwWait != WAIT_TIMEOUT)
1123 {
1124 CloseHandle(apWorkers[idx]->hProcess);
1125 apWorkers[idx]->hProcess = INVALID_HANDLE_VALUE;
1126 }
1127 }
1128 }
1129 break;
1130 } /* wait loop */
1131 } /* outer wait loop */
1132}
1133
1134
1135/** The environment variable compare function.
1136 * We must use case insensitive compare on windows (Path vs PATH). */
1137#ifdef KBUILD_OS_WINDOWS
1138# define KSUBMIT_ENV_NCMP _strnicmp
1139#else
1140# define KSUBMIT_ENV_NCMP strncmp
1141#endif
1142
1143
1144/**
1145 * Handles the --set var=value option.
1146 *
1147 * @returns 0 on success, non-zero exit code on error.
1148 * @param papszEnv The environment vector.
1149 * @param pcEnvVars Pointer to the variable holding the number of
1150 * environment variables held by @a papszEnv.
1151 * @param pcAllocatedEnvVars Pointer to the variable holding max size of the
1152 * environment vector.
1153 * @param cVerbosity The verbosity level.
1154 * @param pszValue The var=value string to apply.
1155 */
1156static int kSubmitOptEnvSet(char ***ppapszEnv, unsigned *pcEnvVars, unsigned *pcAllocatedEnvVars,
1157 int cVerbosity, const char *pszValue)
1158{
1159 const char *pszEqual = strchr(pszValue, '=');
1160 if (pszEqual)
1161 {
1162 char **papszEnv = *ppapszEnv;
1163 unsigned iEnvVar;
1164 unsigned cEnvVars = *pcEnvVars;
1165 size_t const cchVar = pszEqual - pszValue;
1166 for (iEnvVar = 0; iEnvVar < cEnvVars; iEnvVar++)
1167 {
1168 char *pszCur = papszEnv[iEnvVar];
1169 if ( KSUBMIT_ENV_NCMP(pszCur, pszValue, cchVar) == 0
1170 && pszCur[cchVar] == '=')
1171 {
1172 if (cVerbosity > 0)
1173 fprintf(stderr, "kSubmit: replacing '%s' with '%s'\n", papszEnv[iEnvVar], pszValue);
1174 free(papszEnv[iEnvVar]);
1175 papszEnv[iEnvVar] = xstrdup(pszValue);
1176 break;
1177 }
1178 }
1179 if (iEnvVar == cEnvVars)
1180 {
1181 /* Append new variable. We probably need to resize the vector. */
1182 if ((cEnvVars + 2) > *pcAllocatedEnvVars)
1183 {
1184 *pcAllocatedEnvVars = (cEnvVars + 2 + 0xf) & ~(unsigned)0xf;
1185 *ppapszEnv = papszEnv = (char **)xrealloc(papszEnv, *pcAllocatedEnvVars * sizeof(papszEnv[0]));
1186 }
1187 papszEnv[cEnvVars++] = xstrdup(pszValue);
1188 papszEnv[cEnvVars] = NULL;
1189 *pcEnvVars = cEnvVars;
1190 if (cVerbosity > 0)
1191 fprintf(stderr, "kSubmit: added '%s'\n", papszEnv[iEnvVar]);
1192 }
1193 else
1194 {
1195 /* Check for duplicates. */
1196 for (iEnvVar++; iEnvVar < cEnvVars; iEnvVar++)
1197 if ( KSUBMIT_ENV_NCMP(papszEnv[iEnvVar], pszValue, cchVar) == 0
1198 && papszEnv[iEnvVar][cchVar] == '=')
1199 {
1200 if (cVerbosity > 0)
1201 fprintf(stderr, "kSubmit: removing duplicate '%s'\n", papszEnv[iEnvVar]);
1202 free(papszEnv[iEnvVar]);
1203 cEnvVars--;
1204 if (iEnvVar != cEnvVars)
1205 papszEnv[iEnvVar] = papszEnv[cEnvVars];
1206 papszEnv[cEnvVars] = NULL;
1207 iEnvVar--;
1208 }
1209 }
1210 }
1211 else
1212 return errx(1, "Missing '=': -E %s", pszValue);
1213
1214 return 0;
1215}
1216
1217
1218/**
1219 * Handles the --unset var option.
1220 *
1221 * @returns 0 on success, non-zero exit code on error.
1222 * @param papszEnv The environment vector.
1223 * @param pcEnvVars Pointer to the variable holding the number of
1224 * environment variables held by @a papszEnv.
1225 * @param cVerbosity The verbosity level.
1226 * @param pszVarToRemove The name of the variable to remove.
1227 */
1228static int kSubmitOptEnvUnset(char **papszEnv, unsigned *pcEnvVars, int cVerbosity, const char *pszVarToRemove)
1229{
1230 if (strchr(pszVarToRemove, '=') == NULL)
1231 {
1232 unsigned cRemoved = 0;
1233 size_t const cchVar = strlen(pszVarToRemove);
1234 unsigned cEnvVars = *pcEnvVars;
1235 unsigned iEnvVar;
1236
1237 for (iEnvVar = 0; iEnvVar < cEnvVars; iEnvVar++)
1238 if ( KSUBMIT_ENV_NCMP(papszEnv[iEnvVar], pszVarToRemove, cchVar) == 0
1239 && papszEnv[iEnvVar][cchVar] == '=')
1240 {
1241 if (cVerbosity > 0)
1242 fprintf(stderr, !cRemoved ? "kSubmit: removing '%s'\n"
1243 : "kSubmit: removing duplicate '%s'\n", papszEnv[iEnvVar]);
1244 free(papszEnv[iEnvVar]);
1245 cEnvVars--;
1246 if (iEnvVar != cEnvVars)
1247 papszEnv[iEnvVar] = papszEnv[cEnvVars];
1248 papszEnv[cEnvVars] = NULL;
1249 cRemoved++;
1250 iEnvVar--;
1251 }
1252 *pcEnvVars = cEnvVars;
1253
1254 if (cVerbosity > 0 && !cRemoved)
1255 fprintf(stderr, "kSubmit: not found '%s'\n", pszVarToRemove);
1256 }
1257 else
1258 return errx(1, "Found invalid variable name character '=' in: -U %s", pszVarToRemove);
1259 return 0;
1260}
1261
1262
1263
1264/**
1265 * Handles the --chdir dir option.
1266 *
1267 * @returns 0 on success, non-zero exit code on error.
1268 * @param pszCwd The CWD buffer. Contains current CWD on input,
1269 * modified by @a pszValue on output.
1270 * @param cbCwdBuf The size of the CWD buffer.
1271 * @param pszValue The --chdir value to apply.
1272 */
1273static int kSubmitOptChDir(char *pszCwd, size_t cbCwdBuf, const char *pszValue)
1274{
1275 size_t cchNewCwd = strlen(pszValue);
1276 size_t offDst;
1277 if (cchNewCwd)
1278 {
1279#ifdef HAVE_DOS_PATHS
1280 if (*pszValue == '/' || *pszValue == '\\')
1281 {
1282 if (pszValue[1] == '/' || pszValue[1] == '\\')
1283 offDst = 0; /* UNC */
1284 else if (pszCwd[1] == ':' && isalpha(pszCwd[0]))
1285 offDst = 2; /* Take drive letter from CWD. */
1286 else
1287 return errx(1, "UNC relative CWD not implemented: cur='%s' new='%s'", pszCwd, pszValue);
1288 }
1289 else if ( pszValue[1] == ':'
1290 && isalpha(pszValue[0]))
1291 {
1292 if (pszValue[2] == '/'|| pszValue[2] == '\\')
1293 offDst = 0; /* DOS style absolute path. */
1294 else if ( pszCwd[1] == ':'
1295 && tolower(pszCwd[0]) == tolower(pszValue[0]) )
1296 {
1297 pszValue += 2; /* Same drive as CWD, append drive relative path from value. */
1298 cchNewCwd -= 2;
1299 offDst = strlen(pszCwd);
1300 }
1301 else
1302 {
1303 /* Get current CWD on the specified drive and append value. */
1304 int iDrive = tolower(pszValue[0]) - 'a' + 1;
1305 if (!_getdcwd(iDrive, pszCwd, cbCwdBuf))
1306 return err(1, "_getdcwd(%d,,) failed", iDrive);
1307 pszValue += 2;
1308 cchNewCwd -= 2;
1309 }
1310 }
1311#else
1312 if (*pszValue == '/')
1313 offDst = 0;
1314#endif
1315 else
1316 offDst = strlen(pszCwd); /* Relative path, append to the existing CWD value. */
1317
1318 /* Do the copying. */
1319#ifdef HAVE_DOS_PATHS
1320 if (offDst > 0 && pszCwd[offDst - 1] != '/' && pszCwd[offDst - 1] != '\\')
1321#else
1322 if (offDst > 0 && pszCwd[offDst - 1] != '/')
1323#endif
1324 pszCwd[offDst++] = '/';
1325 if (offDst + cchNewCwd >= cbCwdBuf)
1326 return errx(1, "Too long CWD: %*.*s%s", offDst, offDst, pszCwd, pszValue);
1327 memcpy(&pszCwd[offDst], pszValue, cchNewCwd + 1);
1328 }
1329 /* else: relative, no change - quitely ignore. */
1330 return 0;
1331}
1332
1333
1334static int usage(FILE *pOut, const char *argv0)
1335{
1336 fprintf(pOut,
1337 "usage: %s [-Z|--zap-env] [-E|--set <var=val>] [-U|--unset <var=val>]\n"
1338 " [-C|--chdir <dir>] [--wcc-brain-damage]\n"
1339 " [-3|--32-bit] [-6|--64-bit] [-v] -- <program> [args]\n"
1340 " or: %s --help\n"
1341 " or: %s --version\n"
1342 "\n"
1343 "Options:\n"
1344 " -Z, --zap-env, -i, --ignore-environment\n"
1345 " Zaps the environment. Position dependent.\n"
1346 " -E, --set <var>=[value]\n"
1347 " Sets an enviornment variable putenv fashion. Position dependent.\n"
1348 " -U, --unset <var>\n"
1349 " Removes an environment variable. Position dependent.\n"
1350 " -C, --chdir <dir>\n"
1351 " Specifies the current directory for the program. Relative paths\n"
1352 " are relative to the previous -C option. Default is getcwd value.\n"
1353 " -3, --32-bit\n"
1354 " Selects a 32-bit kWorker process. Default: kmk bit count\n"
1355 " -6, --64-bit\n"
1356 " Selects a 64-bit kWorker process. Default: kmk bit count\n"
1357 " --wcc-brain-damage\n"
1358 " Works around wcc and wcc386 (Open Watcom) not following normal\n"
1359 " quoting conventions on Windows, OS/2, and DOS.\n"
1360 " -v,--verbose\n"
1361 " More verbose execution.\n"
1362 " -V,--version\n"
1363 " Show the version number.\n"
1364 " -h,--help\n"
1365 " Show this usage information.\n"
1366 "\n"
1367 ,
1368 argv0, argv0, argv0);
1369 return 1;
1370}
1371
1372
1373int kmk_builtin_kSubmit(int argc, char **argv, char **envp, struct child *pChild, pid_t *pPidSpawned)
1374{
1375 int rcExit = 0;
1376 int iArg;
1377 unsigned cAllocatedEnvVars;
1378 unsigned iEnvVar;
1379 unsigned cEnvVars;
1380 char **papszEnv = NULL;
1381 const char *pszExecutable = NULL;
1382 const char *pszCwd = NULL;
1383 unsigned cBitsWorker = g_cArchBits;
1384 int fWatcomBrainDamage = 0;
1385 int cVerbosity = 0;
1386 size_t const cbCwdBuf = GET_PATH_MAX;
1387 PATH_VAR(szCwd);
1388
1389 g_progname = argv[0];
1390
1391 /*
1392 * Create default program environment.
1393 */
1394 if (getcwd_fs(szCwd, cbCwdBuf) != NULL)
1395 { /* likely */ }
1396 else
1397 return err(1, "getcwd_fs failed\n");
1398
1399 papszEnv = pChild->environment;
1400 if (!papszEnv)
1401 pChild->environment = papszEnv = target_environment(pChild->file);
1402 cEnvVars = 0;
1403 while (papszEnv[cEnvVars] != NULL)
1404 cEnvVars++;
1405 cAllocatedEnvVars = cEnvVars;
1406
1407 /*
1408 * Parse the command line.
1409 */
1410 for (iArg = 1; iArg < argc; iArg++)
1411 {
1412 const char *pszArg = argv[iArg];
1413 if (*pszArg == '-')
1414 {
1415 char chOpt = *++pszArg;
1416 pszArg++;
1417 if (chOpt != '-')
1418 {
1419 if (chOpt != '\0')
1420 { /* likely */ }
1421 else
1422 {
1423 errx(1, "Incomplete option: '-'");
1424 return usage(stderr, argv[0]);
1425 }
1426 }
1427 else
1428 {
1429 /* '--' indicates where the bits to execute start. */
1430 if (*pszArg == '\0')
1431 {
1432 iArg++;
1433 break;
1434 }
1435
1436 if ( strcmp(pszArg, "wcc-brain-damage") == 0
1437 || strcmp(pszArg, "watcom-brain-damage") == 0)
1438 {
1439 fWatcomBrainDamage = 1;
1440 continue;
1441 }
1442
1443 /* convert to short. */
1444 if (strcmp(pszArg, "help") == 0)
1445 chOpt = 'h';
1446 else if (strcmp(pszArg, "version") == 0)
1447 chOpt = 'V';
1448 else if (strcmp(pszArg, "set") == 0)
1449 chOpt = 'E';
1450 else if (strcmp(pszArg, "unset") == 0)
1451 chOpt = 'U';
1452 else if ( strcmp(pszArg, "zap-env") == 0
1453 || strcmp(pszArg, "ignore-environment") == 0 /* GNU env compatibility. */ )
1454 chOpt = 'Z';
1455 else if (strcmp(pszArg, "chdir") == 0)
1456 chOpt = 'C';
1457 else if (strcmp(pszArg, "32-bit") == 0)
1458 chOpt = '3';
1459 else if (strcmp(pszArg, "64-bit") == 0)
1460 chOpt = '6';
1461 else if (strcmp(pszArg, "verbose") == 0)
1462 chOpt = 'v';
1463 else if (strcmp(pszArg, "executable") == 0)
1464 chOpt = 'e';
1465 else
1466 {
1467 errx(1, "Unknown option: '%s'", pszArg - 2);
1468 return usage(stderr, argv[0]);
1469 }
1470 pszArg = "";
1471 }
1472
1473 do
1474 {
1475 /* Get option value first, if the option takes one. */
1476 const char *pszValue = NULL;
1477 switch (chOpt)
1478 {
1479 case 'E':
1480 case 'U':
1481 case 'C':
1482 case 'e':
1483 if (*pszArg != '\0')
1484 pszValue = pszArg + (*pszArg == ':' || *pszArg == '=');
1485 else if (++iArg < argc)
1486 pszValue = argv[iArg];
1487 else
1488 {
1489 errx(1, "Option -%c requires an value!", chOpt);
1490 return usage(stderr, argv[0]);
1491 }
1492 break;
1493 }
1494
1495 switch (chOpt)
1496 {
1497 case 'Z':
1498 case 'i': /* GNU env compatibility. */
1499 for (iEnvVar = 0; iEnvVar < cEnvVars; iEnvVar++)
1500 free(papszEnv[iEnvVar]);
1501 papszEnv[0] = NULL;
1502 cEnvVars = 0;
1503 break;
1504
1505 case 'E':
1506 rcExit = kSubmitOptEnvSet(&papszEnv, &cEnvVars, &cAllocatedEnvVars, cVerbosity, pszValue);
1507 pChild->environment = papszEnv;
1508 if (rcExit == 0)
1509 break;
1510 return rcExit;
1511
1512 case 'U':
1513 rcExit = kSubmitOptEnvUnset(papszEnv, &cEnvVars, cVerbosity, pszValue);
1514 if (rcExit == 0)
1515 break;
1516 return rcExit;
1517
1518 case 'C':
1519 rcExit = kSubmitOptChDir(szCwd, cbCwdBuf, pszValue);
1520 if (rcExit == 0)
1521 break;
1522 return rcExit;
1523
1524 case '3':
1525 cBitsWorker = 32;
1526 break;
1527
1528 case '6':
1529 cBitsWorker = 64;
1530 break;
1531
1532 case 'e':
1533 pszExecutable = pszValue;
1534 break;
1535
1536 case 'v':
1537 cVerbosity++;
1538 break;
1539
1540 case 'h':
1541 usage(stdout, argv[0]);
1542 return 0;
1543
1544 case 'V':
1545 return kbuild_version(argv[0]);
1546 }
1547 } while ((chOpt = *pszArg++) != '\0');
1548 }
1549 else
1550 {
1551 errx(1, "Unknown argument: '%s'", pszArg);
1552 return usage(stderr, argv[0]);
1553 }
1554 }
1555
1556 /*
1557 * Check that we've got something to execute.
1558 */
1559 if (iArg < argc)
1560 {
1561 uint32_t cbMsg;
1562 void *pvMsg = kSubmitComposeJobMessage(pszExecutable, &argv[iArg], papszEnv, szCwd,
1563 fWatcomBrainDamage, &cbMsg);
1564 PWORKERINSTANCE pWorker = kSubmitSelectWorkSpawnNewIfNecessary(cBitsWorker, cVerbosity);
1565 if (pWorker)
1566 {
1567 if (!pszExecutable)
1568 pszExecutable = argv[iArg];
1569
1570 rcExit = kSubmitSendJobMessage(pWorker, pvMsg, cbMsg, 0 /*fNoRespawning*/, cVerbosity);
1571 if (rcExit == 0)
1572 rcExit = kSubmitMarkActive(pWorker, cVerbosity, pChild, pPidSpawned);
1573
1574 if (!g_fAtExitRegistered)
1575 if (atexit(kSubmitAtExitCallback) == 0)
1576 g_fAtExitRegistered = 1;
1577 }
1578 else
1579 rcExit = 1;
1580 free(pvMsg);
1581 }
1582 else
1583 {
1584 errx(1, "Nothing to executed!");
1585 rcExit = usage(stderr, argv[0]);
1586 }
1587
1588 return rcExit;
1589}
1590
1591
1592
Note: See TracBrowser for help on using the repository browser.