contrib/bmake/trace.c

   1 /*      $NetBSD: trace.c,v 1.21 2020/10/31 22:05:56 rillig Exp $        */
   2
   3 /*-
   4  * Copyright (c) 2000 The NetBSD Foundation, Inc.
   5  * All rights reserved.
   6  *
   7  * This code is derived from software contributed to The NetBSD Foundation
   8  * by Bill Sommerfeld
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29  * POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 /*-
  33  * trace.c --
  34  *      handle logging of trace events generated by various parts of make.
  35  *
  36  * Interface:
  37  *      Trace_Init              Initialize tracing (called once during
  38  *                              the lifetime of the process)
  39  *
  40  *      Trace_End               Finalize tracing (called before make exits)
  41  *
  42  *      Trace_Log               Log an event about a particular make job.
  43  */
  44
  45 #include <sys/time.h>
  46
  47 #include "make.h"
  48 #include "job.h"
  49 #include "trace.h"
  50
  51 MAKE_RCSID("$NetBSD: trace.c,v 1.21 2020/10/31 22:05:56 rillig Exp $");
  52
  53 static FILE *trfile;
  54 static pid_t trpid;
  55 const char *trwd;
  56
  57 static const char *evname[] = {
  58         "BEG",
  59         "END",
  60         "ERR",
  61         "JOB",
  62         "DON",
  63         "INT",
  64 };
  65
  66 void
  67 Trace_Init(const char *pathname)
  68 {
  69         if (pathname != NULL) {
  70                 void *dontFreeIt;
  71                 trpid = getpid();
  72                 /* XXX: This variable may get overwritten later, which
  73                  * would make trwd point to undefined behavior. */
  74                 trwd = Var_Value(".CURDIR", VAR_GLOBAL, &dontFreeIt);
  75
  76                 trfile = fopen(pathname, "a");
  77         }
  78 }
  79
  80 void
  81 Trace_Log(TrEvent event, Job *job)
  82 {
  83         struct timeval rightnow;
  84
  85         if (trfile == NULL)
  86                 return;
  87
  88         gettimeofday(&rightnow, NULL);
  89
  90         fprintf(trfile, "%lld.%06ld %d %s %d %s",
  91             (long long)rightnow.tv_sec, (long)rightnow.tv_usec,
  92             jobTokensRunning,
  93             evname[event], trpid, trwd);
  94         if (job != NULL) {
  95                 fprintf(trfile, " %s %d %x %x", job->node->name,
  96                     job->pid, job->flags, job->node->type);
  97         }
  98         fputc('\n', trfile);
  99         fflush(trfile);
 100 }
 101
 102 void
 103 Trace_End(void)
 104 {
 105         if (trfile != NULL)
 106                 fclose(trfile);
 107 }