Source/JavaScriptCore/heap/HeapProfiler.h

/*
 * Copyright (C) 2016 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/Vector.h>

namespace JSC {

class HeapSnapshot;
class HeapAnalyzer;
class VM;

class HeapProfiler {
    WTF_MAKE_FAST_ALLOCATED;
public:
    HeapProfiler(VM&);
    ~HeapProfiler();

    VM& vm() const { return m_vm; }

    HeapSnapshot* mostRecentSnapshot();
    void appendSnapshot(std::unique_ptr<HeapSnapshot>);
    void clearSnapshots();

    HeapAnalyzer* activeHeapAnalyzer() const { return m_activeAnalyzer; }
    void setActiveHeapAnalyzer(HeapAnalyzer*);

private:
    VM& m_vm;
    Vector<std::unique_ptr<HeapSnapshot>> m_snapshots;
    HeapAnalyzer* m_activeAnalyzer { nullptr };
};

} // namespace JSC