Source/JavaScriptCore/tools/CompilerTimingScope.h

/*
 * Copyright (C) 2015-2018 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. 
 */

#pragma once

#include <wtf/MonotonicTime.h>
#include <wtf/Noncopyable.h>

namespace JSC {

// FIXME: We should find some way of reconciling the differences between WTF::TimingScope and this class. The differences
// are:
// - CompilerTimingScope knows to only do work when --logPhaseTimes=true, while TimingScope is unconditional.
// - CompilerTimingScope reports totals on every run, while TimingScope reports averages periodically.

class CompilerTimingScope {
    WTF_MAKE_NONCOPYABLE(CompilerTimingScope);
public:
    CompilerTimingScope(const char* compilerName, const char* name);
    ~CompilerTimingScope();

private:
    const char* m_compilerName;
    const char* m_name;
    MonotonicTime m_before;
};

JS_EXPORT_PRIVATE void logTotalPhaseTimes();

} // namespace JSC