Copying collection shouldn't require O(live bytes) memory overhead
[WebKit-https.git] / Source / JavaScriptCore / heap / CopyVisitor.h
1 /*
2  * Copyright (C) 2012 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef CopyVisitor_h
27 #define CopyVisitor_h
28
29 #include "CopiedSpace.h"
30
31 namespace JSC {
32
33 class GCThreadSharedData;
34
35 class CopyVisitor {
36 public:
37     CopyVisitor(GCThreadSharedData&);
38
39     void copyFromShared();
40
41     void startCopying();
42     void doneCopying();
43
44     // Low-level API for copying, appropriate for cases where the object's heap references
45     // are discontiguous or if the object occurs frequently enough that you need to focus on
46     // performance. Use this with care as it is easy to shoot yourself in the foot.
47     bool checkIfShouldCopy(void*, size_t);
48     void* allocateNewSpace(size_t);
49     void didCopy(void*, size_t);
50
51 private:
52     void* allocateNewSpaceSlow(size_t);
53
54     GCThreadSharedData& m_shared;
55     CopiedAllocator m_copiedAllocator;
56 };
57
58 } // namespace JSC
59
60 #endif