/*      $NetBSD: trace.c,v 1.35 2025/05/09 18:42:56 rillig Exp $        */

/*
 * Copyright (c) 2000 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Bill Sommerfeld
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

/*
 * trace.c --
 *      handle logging of trace events generated by various parts of make.
 *
 * Interface:
 *      Trace_Init              Initialize tracing (called once during
 *                              the lifetime of the process)
 *
 *      Trace_End               Finalize tracing (called before make exits)
 *
 *      Trace_Log               Log an event about a particular make job.
 */

#include <sys/time.h>

#include "make.h"
#include "job.h"
#include "trace.h"

MAKE_RCSID("$NetBSD: trace.c,v 1.35 2025/05/09 18:42:56 rillig Exp $");

static FILE *trfile;
static pid_t trpid;
static const char *trwd;

static const char evname[][4] = {
        "BEG",
        "END",
        "ERR",
        "JOB",
        "DON",
        "INT",
};

void
Trace_Init(const char *pathname)
{
        if (pathname != NULL) {
                FStr curDir;
                trpid = getpid();
                /*
                 * XXX: This variable may get overwritten later, which would
                 * make trwd point to undefined behavior.
                 */
                curDir = Var_Value(SCOPE_GLOBAL, ".CURDIR");
                trwd = curDir.str;

                trfile = fopen(pathname, "a");
        }
}

void
Trace_Log(TrEvent event, Job *job)
{
        struct timeval rightnow;

        if (trfile == NULL)
                return;

        gettimeofday(&rightnow, NULL);

#if __STDC_VERSION__ >= 199901L
        fprintf(trfile, "%lld.%06ld %d %s %d %s",
            (long long)rightnow.tv_sec, (long)rightnow.tv_usec,
            jobTokensRunning,
            evname[event], trpid, trwd);
#else
        fprintf(trfile, "%ld.%06ld %d %s %d %s",
            (long)rightnow.tv_sec, (long)rightnow.tv_usec,
            jobTokensRunning,
            evname[event], trpid, trwd);
#endif
        if (job != NULL) {
                GNode *gn = Job_Node(job);
                char *type = GNodeType_ToString(gn->type);
                char flags[4];
                Job_FlagsToString(job, flags, sizeof flags);
                fprintf(trfile, " %s %d %s %s",
                    gn->name, Job_Pid(job), flags, type);
                free(type);
        }
        fputc('\n', trfile);
        fflush(trfile);
}

void
Trace_End(void)
{
        if (trfile != NULL)
                fclose(trfile);
}