src/make1.c

   1 /*
   2  * Copyright 1993-2002 Christopher Seiwald and Perforce Software, Inc.
   3  *
   4  * This file is part of Jam - see jam.c for Copyright information.
   5  */
   6 /*
   7  * make1.c - execute command to bring targets up to date
   8  *
   9  * This module contains make1(), the entry point called by make() to
  10  * recursively decend the dependency graph executing update actions as
  11  * marked by make0().
  12  *
  13  * External routines:
  14  *
  15  *  make1() - execute commands to update a TARGET and all its dependents
  16  *
  17  * Internal routines, the recursive/asynchronous command executors:
  18  *
  19  *  make1a() - recursively traverse target tree, calling make1b()
  20  *  make1b() - dependents of target built, now build target with make1c()
  21  *  make1c() - launch target's next command, call make1b() when done
  22  *  make1d() - handle command execution completion and call back make1c()
  23  *
  24  * Internal support routines:
  25  *
  26  *  make1cmds() - turn ACTIONS into CMDs, grouping, splitting, etc
  27  *  make1list() - turn a list of targets into a LIST, for $(<) and $(>)
  28  *  make1settings() - for vars that get bound, build up replacement lists
  29  *  make1bind() - bind targets that weren't bound in dependency analysis
  30  *
  31  * 04/16/94 (seiwald) - Split from make.c.
  32  * 04/21/94 (seiwald) - Handle empty "updated" actions.
  33  * 05/04/94 (seiwald) - async multiprocess (-j) support
  34  * 06/01/94 (seiwald) - new 'actions existing' does existing sources
  35  * 12/20/94 (seiwald) - NOTIME renamed NOTFILE.
  36  * 01/19/95 (seiwald) - distinguish between CANTFIND/CANTMAKE targets.
  37  * 01/22/94 (seiwald) - pass per-target JAMSHELL down to execcmd().
  38  * 02/28/95 (seiwald) - Handle empty "existing" actions.
  39  * 03/10/95 (seiwald) - Fancy counts.
  40  * 02/07/01 (seiwald) - Fix jam -d0 return status.
  41  * 01/21/02 (seiwald) - new -q to quit quickly on build failure
  42  * 02/28/02 (seiwald) - don't delete 'actions updated' targets on failure
  43  * 02/28/02 (seiwald) - merge EXEC_xxx flags in with RULE_xxx
  44  * 07/17/02 (seiwald) - TEMPORARY sources for headers now get built
  45  * 09/23/02 (seiwald) - "...using temp..." only displayed on -da now.
  46  * 10/22/02 (seiwald) - list_new() now does its own newstr()/copystr()
  47  * 11/04/02 (seiwald) - const-ing for string literals
  48  * 12/03/02 (seiwald) - fix odd includes support by grafting them onto depends
  49  */
  50 #include <unistd.h>
  51
  52 #include "jam.h"
  53
  54 #include "lists.h"
  55 #include "parse.h"
  56 #include "variable.h"
  57 #include "rules.h"
  58
  59 #include "search.h"
  60 #include "newstr.h"
  61 #include "make.h"
  62 #include "command.h"
  63 #include "execcmd.h"
  64
  65 //#ifdef OPT_IMPROVED_PROGRESS_EXT
  66 #include "progress.h"
  67 //#endif
  68
  69
  70 static void make1a (TARGET *t, TARGET *parent);
  71 static void make1b (TARGET *t);
  72 static void make1c (TARGET *t);
  73 static void make1d (void *closure, int status);
  74
  75 static CMD *make1cmds (ACTIONS *a0);
  76 static LIST *make1list (LIST *l, TARGETS *targets, int flags);
  77 static SETTINGS *make1settings (LIST *vars);
  78 static void make1bind (TARGET *t, int warn);
  79
  80
  81 /* Ugly static - it's too hard to carry it through the callbacks. */
  82 static struct {
  83   int failed;
  84   int skipped;
  85   int total;
  86   int made;
  87 } counts[1];
  88
  89
  90 /*
  91  * make1() - execute commands to update a TARGET and all its dependents
  92  */
  93 static int intr = 0;
  94
  95 int make1 (TARGET *t) {
  96   memset((char *)counts, 0, sizeof(*counts));
  97   /* recursively make the target and its dependents */
  98   make1a(t, (TARGET *)0);
  99   /* wait for any outstanding commands to finish running */
 100   while (execwait()) ;
 101   /* talk about it */
 102   if (DEBUG_MAKE && counts->failed) printf("...failed updating %d target%s...\n", counts->failed, multiFormSfx(counts->failed));
 103   if (DEBUG_MAKE && counts->skipped) printf("...skipped %d target%s...\n", counts->skipped, multiFormSfx(counts->skipped));
 104   if (DEBUG_MAKE && counts->made) printf("...updated %d target%s...\n", counts->made, multiFormSfx(counts->made));
 105   return counts->total != counts->made;
 106 }
 107
 108
 109 /*
 110  * make1a() - recursively traverse target tree, calling make1b()
 111  */
 112 static void make1a (TARGET *t, TARGET *parent) {
 113   TARGETS *c;
 114   /* if the parent is the first to try to build this target */
 115   /* or this target is in the make1c() quagmire, arrange for the */
 116   /* parent to be notified when this target is built */
 117   if (parent) {
 118     switch (t->progress) {
 119       case T_MAKE_INIT:
 120       case T_MAKE_ACTIVE:
 121       case T_MAKE_RUNNING:
 122         t->parents = targetentry(t->parents, parent);
 123         ++parent->asynccnt;
 124         break;
 125     }
 126   }
 127   if (t->progress != T_MAKE_INIT) return;
 128   /* asynccnt counts the dependents preventing this target from proceeding to make1b() for actual building */
 129   /* we start off with a count of 1 to prevent anything from happening until we can call all dependents */
 130   /* this 1 is accounted for when we call make1b() ourselves, below */
 131   t->asynccnt = 1;
 132   /* recurse on our dependents, manipulating progress to guard against circular dependency */
 133   t->progress = T_MAKE_ONSTACK;
 134   for (c = t->depends; c && !intr; c = c->next) make1a(c->target, t);
 135   t->progress = T_MAKE_ACTIVE;
 136   /* now that all dependents have bumped asynccnt, we now allow decrement our reference to asynccnt */
 137   make1b(t);
 138 }
 139
 140
 141 /*
 142  * make1b() - dependents of target built, now build target with make1c()
 143  */
 144 static void make1b (TARGET *t) {
 145   TARGETS *c;
 146   const char *failed = "dependents";
 147   /* if any dependents are still outstanding, wait until they call make1b() to signal their completion */
 148   if (--t->asynccnt) return;
 149 #ifdef JAM_OPT_SEMAPHORE
 150   if (t->semaphore && t->semaphore->asynccnt) {
 151     /* append 't' to the list of targets waiting on semaphore. */
 152     t->semaphore->parents = targetentry(t->semaphore->parents, t);
 153     ++t->asynccnt;
 154     if (DEBUG_EXECCMD) printf( "SEM: %s is busy, delaying launch of %s\n", t->semaphore->name, t->name );
 155     //pop_state(&state_stack);
 156     return;
 157   }
 158 #endif
 159   /* now ready to build target 't'... if dependents built ok */
 160   /* collect status from dependents */
 161   for (c = t->depends; c; c = c->next) {
 162     if (c->target->status > t->status) {
 163       failed = c->target->name;
 164       t->status = c->target->status;
 165     }
 166   }
 167   /* if actions on deps have failed, bail, otherwise, execute all actions to make target */
 168   if (t->status == EXEC_CMD_FAIL && t->actions) {
 169     ++counts->skipped;
 170     printf("...skipped %s for lack of %s...\n", t->name, failed);
 171   }
 172   if (t->status == EXEC_CMD_OK) {
 173     switch(t->fate) {
 174       case T_FATE_INIT:
 175       case T_FATE_MAKING:
 176         /* shouldn't happen */
 177       case T_FATE_STABLE:
 178       case T_FATE_NEWER:
 179         break;
 180       case T_FATE_CANTFIND:
 181       case T_FATE_CANTMAKE:
 182         t->status = EXEC_CMD_FAIL;
 183         break;
 184       case T_FATE_ISTMP:
 185         if (DEBUG_MAKEQ) printf("...using %s...\n", t->name);
 186         break;
 187       case T_FATE_TOUCHED:
 188       case T_FATE_MISSING:
 189       case T_FATE_NEEDTMP:
 190       case T_FATE_OUTDATED:
 191       case T_FATE_UPDATE:
 192         /* set "on target" vars, build actions, unset vars */
 193         /* set "progress" so that make1c() counts this target among the successes/failures. */
 194         if (t->actions) {
 195           ++counts->total;
 196 //#ifndef OPT_IMPROVED_PROGRESS_EXT
 197           //if (DEBUG_MAKE && !(counts->total % 100)) printf("...on %dth target...\n", counts->total);
 198 //#else
 199         {
 200           double est_remaining = progress_update(globs.progress, counts->total);
 201           if (est_remaining > 0.0) {
 202             int minutes = (int)est_remaining/60;
 203             int seconds = (int)est_remaining%60;
 204             if (minutes > 0 || seconds > 0) {
 205               printf("*** completed %.0f%% (", ((double)counts->total*100/globs.updating));
 206               if (minutes > 0) printf("%d min ", minutes);
 207               if (seconds >= 0) printf("%d sec ", seconds);
 208               printf("remaining)...\n");
 209             }
 210           }
 211         }
 212 //#endif
 213           pushsettings(t->settings);
 214           t->cmds = (char *)make1cmds(t->actions);
 215           popsettings(t->settings);
 216           t->progress = T_MAKE_RUNNING;
 217         }
 218         break;
 219     }
 220   }
 221   /* call make1c() to begin the execution of the chain of commands needed to build target */
 222   /* if we're not going to build target (because of dependency failures or because no commands
 223    * need to be run) the chain will be empty and make1c() will directly
 224    * signal the completion of target */
 225 #ifdef JAM_OPT_SEMAPHORE
 226   /* if there is a semaphore, indicate that it is in use */
 227   if (pState->t->semaphore) {
 228     ++pState->t->semaphore->asynccnt;
 229     if (DEBUG_EXECCMD) printf( "SEM: %s now used by %s\n", pState->t->semaphore->name, pState->t->name);
 230   }
 231 #endif
 232   make1c(t); //pState->curstate = T_STATE_MAKE1C;
 233 }
 234
 235
 236 /*
 237  * make1c() - launch target's next command, call make1b() when done
 238  */
 239 static void make1c (TARGET *t) {
 240   CMD *cmd = (CMD *)t->cmds;
 241   /* if there are (more) commands to run to build this target
 242    * (and we haven't hit an error running earlier comands) we
 243    * launch the command with execcmd() */
 244   /* if there are no more commands to run, we collect the status
 245    * from all the actions then report our completion to all the
 246    * parents */
 247   if (cmd && t->status == EXEC_CMD_OK) {
 248     if (DEBUG_MAKE) {
 249       if (DEBUG_MAKEQ || !(cmd->rule->flags&RULE_QUIETLY)) {
 250         printf("(%3d%%) ", counts->total*100/globs.updating);
 251         printf("%s ", cmd->rule->name);
 252         list_print(lol_get(&cmd->args, 0));
 253         printf("\n");
 254       }
 255     }
 256     if (DEBUG_EXEC) printf("%s\n", kStringCStr(&cmd->buf));
 257     if (globs.cmdout) fprintf(globs.cmdout, "%s", kStringCStr(&cmd->buf));
 258     if (globs.noexec) make1d(t, EXEC_CMD_OK);
 259     else {
 260       fflush(stdout);
 261       execcmd(kStringCStr(&cmd->buf), make1d, t, cmd->shell);
 262     }
 263   } else {
 264     TARGETS *c;
 265     ACTIONS *actions;
 266     /* collect status from actions, and distribute it as well */
 267     for (actions = t->actions; actions; actions = actions->next) {
 268       if (actions->action->status > t->status) t->status = actions->action->status;
 269     }
 270     for (actions = t->actions; actions; actions = actions->next) {
 271       if (t->status > actions->action->status) actions->action->status = t->status;
 272     }
 273     /* tally success/failure for those we tried to update */
 274     if (t->progress == T_MAKE_RUNNING) {
 275       switch(t->status) {
 276         case EXEC_CMD_OK: ++counts->made; break;
 277         case EXEC_CMD_FAIL: ++counts->failed; break;
 278       }
 279     }
 280     /* tell parents dependent has been built */
 281     t->progress = T_MAKE_DONE;
 282     for (c = t->parents; c; c = c->next) make1b(c->target);
 283 #ifdef JAM_OPT_SEMAPHORE
 284     /* if there is a semaphore, it is now free */
 285     if (t->semaphore) {
 286       assert(t->semaphore->asynccnt == 1);
 287       --t->semaphore->asynccnt;
 288       if (DEBUG_EXECCMD) printf( "SEM: %s is now free\n", t->semaphore->name );
 289       /* If anything is waiting, notify the next target */
 290       /* there is no point in notifying waiting targets, since they will be notified again */
 291       if (t->semaphore->parents) {
 292         TARGETS *first = t->semaphore->parents;
 293         if (first->next) first->next->tail = first->tail;
 294         t->semaphore->parents = first->next;
 295         if (DEBUG_EXECCMD) printf( "SEM: placing %s on stack\n", first->target->name );
 296         push_state(&temp_stack, first->target, NULL, T_STATE_MAKE1B);
 297         BJAM_FREE(first);
 298       }
 299     }
 300 #endif
 301   }
 302 }
 303
 304
 305 /*
 306  * make1d() - handle command execution completion and call back make1c()
 307  */
 308 static void make1d (void *closure, int status) {
 309   TARGET *t = (TARGET *)closure;
 310   CMD *cmd = (CMD *)t->cmds;
 311   /* execcmd() has completed */
 312   /* all we need to do is fiddle with the status and signal our completion so make1c() can run the next command */
 313   /* in interrupts, we bail heavily */
 314   if (status == EXEC_CMD_FAIL && (cmd->rule->flags & RULE_IGNORE)) status = EXEC_CMD_OK;
 315   /* on interrupt, set intr so _everything_ fails */
 316   if (status == EXEC_CMD_INTR) ++intr;
 317   if (status == EXEC_CMD_FAIL && DEBUG_MAKE) {
 318     /* print command text on failure */
 319     if (!DEBUG_EXEC) printf("%s\n", kStringCStr(&cmd->buf));
 320     printf("...failed %s ", cmd->rule->name);
 321     list_print(lol_get(&cmd->args, 0));
 322     printf("...\n");
 323     if (globs.quitquick) ++intr;
 324   }
 325   /* if the command was interrupted or failed and the target is not "precious", remove the targets */
 326   /* precious == 'actions updated' -- the target maintains state */
 327   if (status != EXEC_CMD_OK && !(cmd->rule->flags & RULE_UPDATED)) {
 328     LIST *targets = lol_get(&cmd->args, 0);
 329     for (; targets; targets = list_next(targets)) {
 330       if (!unlink(targets->string)) printf("...removing %s\n", targets->string);
 331     }
 332   }
 333   /* free this command and call make1c() to move onto next command */
 334   t->status = status;
 335   t->cmds = (char *)cmd_next(cmd);
 336   cmd_free(cmd);
 337   make1c(t);
 338 }
 339
 340
 341 /*
 342  * make1cmds() - turn ACTIONS into CMDs, grouping, splitting, etc
 343  *
 344  * Essentially copies a chain of ACTIONs to a chain of CMDs,
 345  * grouping RULE_TOGETHER actions, splitting RULE_PIECEMEAL actions,
 346  * and handling RULE_UPDATED actions.  The result is a chain of
 347  * CMDs which can be expanded by var_string() and executed with
 348  * execcmd().
 349  */
 350 static CMD *make1cmds (ACTIONS *a0) {
 351   CMD *cmds = 0;
 352   LIST *shell = var_get("JAMSHELL"); /* shell is per-target */
 353   /* step through actions */
 354   /* actions may be shared with other targets or grouped with RULE_TOGETHER, so actions already seen are skipped */
 355   for (; a0; a0 = a0->next) {
 356     RULE *rule = a0->action->rule;
 357     SETTINGS *boundvars;
 358     LIST *nt, *ns;
 359     ACTIONS *a1;
 360     int start, chunk, length, maxline;
 361     /* only do rules with commands to execute */
 362     /* if this action has already been executed, use saved status */
 363     if (!rule->actions || a0->action->running) continue;
 364     a0->action->running = 1;
 365     /* make LISTS of targets and sources */
 366     /* if `execute together` has been specified for this rule, tack
 367      * on sources from each instance of this rule for this target */
 368     nt = make1list(L0, a0->action->targets, 0);
 369     ns = make1list(L0, a0->action->sources, rule->flags);
 370     if (rule->flags & RULE_TOGETHER) {
 371       for (a1 = a0->next; a1; a1 = a1->next) {
 372         if (a1->action->rule == rule && !a1->action->running) {
 373           ns = make1list(ns, a1->action->sources, rule->flags);
 374           a1->action->running = 1;
 375         }
 376       }
 377     }
 378     /* if doing only updated (or existing) sources, but none have
 379      * been updated (or exist), skip this action */
 380     if (!ns && (rule->flags & (RULE_UPDATED | RULE_EXISTING))) {
 381       list_free(nt);
 382       continue;
 383     }
 384     /* if we had 'actions xxx bind vars' we bind the vars now */
 385     boundvars = make1settings(rule->bindlist);
 386     pushsettings(boundvars);
 387     /*
 388      * Build command, starting with all source args.
 389      *
 390      * If cmd_new returns 0, it's because the resulting command
 391      * length is > MAXLINE.  In this case, we'll slowly reduce
 392      * the number of source arguments presented until it does
 393      * fit.  This only applies to actions that allow PIECEMEAL
 394      * commands.
 395      *
 396      * While reducing slowly takes a bit of compute time to get
 397      * things just right, it's worth it to get as close to MAXLINE
 398      * as possible, because launching the commands we're executing
 399      * is likely to be much more compute intensive!
 400      *
 401      * Note we loop through at least once, for sourceless actions.
 402      *
 403      * Max line length is the action specific maxline or, if not
 404      * given or bigger than MAXLINE, MAXLINE.
 405      */
 406     start = 0;
 407     chunk = length = list_length(ns);
 408     maxline = rule->flags / RULE_MAXLINE;
 409     maxline = maxline && maxline < MAXLINE ? maxline : MAXLINE;
 410     do {
 411       /* build cmd: cmd_new consumes its lists */
 412       CMD *cmd = cmd_new(rule,
 413         list_copy(L0, nt),
 414         list_sublist(ns, start, chunk),
 415         list_copy(L0, shell),
 416         maxline);
 417       if (cmd) {
 418         /* it fit: chain it up */
 419         if (!cmds) cmds = cmd; else cmds->tail->next = cmd;
 420         cmds->tail = cmd;
 421         start += chunk;
 422       } else if ((rule->flags & RULE_PIECEMEAL) && chunk > 1) {
 423         /* reduce chunk size slowly */
 424         chunk = chunk*9/10;
 425       } else {
 426         /* too long and not splittable */
 427         printf("%s actions too long (max %d)!\n", rule->name, maxline);
 428         exit(EXITBAD);
 429       }
 430     } while (start < length);
 431     /* these were always copied when used */
 432     list_free(nt);
 433     list_free(ns);
 434     /* free the variables whose values were bound by 'actions xxx bind vars' */
 435     popsettings(boundvars);
 436     freesettings(boundvars);
 437   }
 438   return cmds;
 439 }
 440
 441
 442 /*
 443  * make1list() - turn a list of targets into a LIST, for $(<) and $(>)
 444  */
 445 static LIST *make1list (LIST *l, TARGETS *targets, int flags) {
 446   for (; targets; targets = targets->next) {
 447     TARGET *t = targets->target;
 448     /* sources to 'actions existing' are never in the dependency
 449      * graph (if they were, they'd get built and 'existing' would
 450      * be superfluous, so throttle warning message about independent
 451      * targets */
 452     if (t->binding == T_BIND_UNBOUND) make1bind(t, !(flags & RULE_EXISTING));
 453     if ((flags & RULE_EXISTING) && t->binding != T_BIND_EXISTS) continue;
 454     if ((flags & RULE_UPDATED) && t->fate <= T_FATE_STABLE) continue;
 455     /* prohibit duplicates for RULE_TOGETHER */
 456     if (flags & RULE_TOGETHER) {
 457       LIST *m;
 458       //
 459       for (m = l; m; m = m->next) if (!strcmp(m->string, t->boundname)) break;
 460       if (m) continue;
 461     }
 462     /* build new list */
 463     l = list_new(l, t->boundname, 1);
 464   }
 465   return l;
 466 }
 467
 468
 469 /*
 470  * make1settings() - for vars that get bound values, build up replacement lists
 471  */
 472 static SETTINGS *make1settings (LIST *vars) {
 473   SETTINGS *settings = NULL;
 474   //
 475   for (; vars; vars = list_next(vars)) {
 476     LIST *l = var_get(vars->string), *nl = NULL;
 477     //
 478     for (; l; l = list_next(l)) {
 479       TARGET *t = bindtarget(l->string);
 480       /* make sure the target is bound, warning if it is not in the dependency graph */
 481       if (t->binding == T_BIND_UNBOUND) make1bind(t, 1);
 482       /* build new list */
 483       nl = list_new(nl, t->boundname, 1);
 484     }
 485     /* add to settings chain */
 486     settings = addsettings(settings, 0, vars->string, nl);
 487   }
 488   return settings;
 489 }
 490
 491
 492 /*
 493  * make1bind() - bind targets that weren't bound in dependency analysis
 494  *
 495  * Spot the kludge!  If a target is not in the dependency tree, it didn't
 496  * get bound by make0(), so we have to do it here.  Ugly.
 497  */
 498 static void make1bind (TARGET *t, int warn) {
 499   if (t->flags & T_FLAG_NOTFILE) return;
 500   /* sources to 'actions existing' are never in the dependency
 501    * graph (if they were, they'd get built and 'existing' would
 502    * be superfluous, so throttle warning message about independent
 503    * targets */
 504   if (warn) printf("warning: using independent target %s\n", t->name);
 505   pushsettings(t->settings);
 506   t->boundname = search(t->name, &t->time);
 507   t->binding = t->time?T_BIND_EXISTS:T_BIND_MISSING;
 508   popsettings(t->settings);
 509 }