Source/JavaScriptCore/heap/CopyVisitor.h

/*
 * Copyright (C) 2012, 2015 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. AND ITS 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 APPLE INC. OR ITS 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.
 */

#ifndef CopyVisitor_h
#define CopyVisitor_h

#include "CopiedSpace.h"
#include <wtf/Noncopyable.h>

namespace JSC {

class Heap;

class CopyVisitor {
    WTF_MAKE_NONCOPYABLE(CopyVisitor);
public:
    CopyVisitor(Heap&);
    ~CopyVisitor();

    void copyFromShared();

    // Low-level API for copying, appropriate for cases where the object's heap references
    // are discontiguous or if the object occurs frequently enough that you need to focus on
    // performance. Use this with care as it is easy to shoot yourself in the foot.
    bool checkIfShouldCopy(void*);
    void* allocateNewSpace(size_t);
    void didCopy(void*, size_t);

private:
    void* allocateNewSpaceSlow(size_t);
    void visitItem(CopyWorklistItem);

    Heap& m_heap;
    CopiedAllocator m_copiedAllocator;
};

} // namespace JSC

#endif