Source/JavaScriptCore/tools/CompilerTimingScope.cpp

/*
 * Copyright (C) 2015-2021 Apple Inc. All rights reserved.
 *
 * 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 APPLE INC. ``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 APPLE INC. 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. 
 */

#include "config.h"
#include "CompilerTimingScope.h"

#include "Options.h"
#include <wtf/DataLog.h>
#include <wtf/Lock.h>
#include <wtf/Vector.h>
#include <wtf/text/WTFString.h>

namespace JSC {

namespace {

class CompilerTimingScopeState {
    WTF_MAKE_NONCOPYABLE(CompilerTimingScopeState);
    WTF_MAKE_FAST_ALLOCATED;
public:
    CompilerTimingScopeState() { }
    
    Seconds addToTotal(const char* compilerName, const char* name, Seconds duration)
    {
        Locker locker { lock };

        for (auto& tuple : totals) {
            if (!strcmp(std::get<0>(tuple), compilerName) && !strcmp(std::get<1>(tuple), name)) {
                std::get<2>(tuple) += duration;
                std::get<3>(tuple) = std::max(std::get<3>(tuple), duration);
                return std::get<2>(tuple);
            }
        }

        totals.append({ compilerName, name, duration, duration });
        return duration;
    }

    void logTotals()
    {
        for (auto& tuple : totals) {
            dataLogLn(
                "total ms: ", FixedWidthDouble(std::get<2>(tuple).milliseconds(), 8, 3), " max ms: ", FixedWidthDouble(std::get<3>(tuple).milliseconds(), 7, 3), " [", std::get<0>(tuple), "] ", std::get<1>(tuple));
        }
    }
    
private:
    Vector<std::tuple<const char*, const char*, Seconds, Seconds>> totals;
    Lock lock;
};

CompilerTimingScopeState& compilerTimingScopeState()
{
    static Atomic<CompilerTimingScopeState*> s_state;
    return ensurePointer(s_state, [] { return new CompilerTimingScopeState(); });
}

} // anonymous namespace

CompilerTimingScope::CompilerTimingScope(const char* compilerName, const char* name)
    : m_compilerName(compilerName)
    , m_name(name)
{
    if (UNLIKELY(Options::logPhaseTimes() || Options::reportTotalPhaseTimes()))
        m_before = MonotonicTime::now();
}

CompilerTimingScope::~CompilerTimingScope()
{
    if (UNLIKELY(Options::logPhaseTimes() || Options::reportTotalPhaseTimes())) {
        Seconds duration = MonotonicTime::now() - m_before;
        auto total = compilerTimingScopeState().addToTotal(m_compilerName, m_name, duration);
        if (Options::logPhaseTimes()) {
            dataLog(
                "[", m_compilerName, "] ", m_name, " took: ", duration.milliseconds(), " ms ",
                "(total: ", total.milliseconds(),
                " ms).\n");
        }
    }
}

void logTotalPhaseTimes()
{
    compilerTimingScopeState().logTotals();
}

} // namespace JSC