Home | History | Annotate | Line # | Download | only in make 
      1 /*	$NetBSD: trace.c,v 1.35 2025/05/09 18:42: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.35 2025/05/09 18:42:56 rillig Exp $");
     52 
     53 static FILE *trfile;
     54 static pid_t trpid;
     55 static const char *trwd;
     56 
     57 static const char evname[][4] = {
     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 		FStr curDir;
     71 		trpid = getpid();
     72 		/*
     73 		 * XXX: This variable may get overwritten later, which would
     74 		 * make trwd point to undefined behavior.
     75 		 */
     76 		curDir = Var_Value(SCOPE_GLOBAL, ".CURDIR");
     77 		trwd = curDir.str;
     78 
     79 		trfile = fopen(pathname, "a");
     80 	}
     81 }
     82 
     83 void
     84 Trace_Log(TrEvent event, Job *job)
     85 {
     86 	struct timeval rightnow;
     87 
     88 	if (trfile == NULL)
     89 		return;
     90 
     91 	gettimeofday(&rightnow, NULL);
     92 
     93 #if __STDC_VERSION__ >= 199901L
     94 	fprintf(trfile, "%lld.%06ld %d %s %d %s",
     95 	    (long long)rightnow.tv_sec, (long)rightnow.tv_usec,
     96 	    jobTokensRunning,
     97 	    evname[event], trpid, trwd);
     98 #else
     99 	fprintf(trfile, "%ld.%06ld %d %s %d %s",
    100 	    (long)rightnow.tv_sec, (long)rightnow.tv_usec,
    101 	    jobTokensRunning,
    102 	    evname[event], trpid, trwd);
    103 #endif
    104 	if (job != NULL) {
    105 		GNode *gn = Job_Node(job);
    106 		char *type = GNodeType_ToString(gn->type);
    107 		char flags[4];
    108 		Job_FlagsToString(job, flags, sizeof flags);
    109 		fprintf(trfile, " %s %d %s %s",
    110 		    gn->name, Job_Pid(job), flags, type);
    111 		free(type);
    112 	}
    113 	fputc('\n', trfile);
    114 	fflush(trfile);
    115 }
    116 
    117 void
    118 Trace_End(void)
    119 {
    120 	if (trfile != NULL)
    121 		fclose(trfile);
    122 }
    123