CodeBlocks should be in IsoSubspaces
[WebKit-https.git] / Source / JavaScriptCore / heap / HeapCell.h
1 /*
2  * Copyright (C) 2016-2017 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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #pragma once
27
28 #include "DestructionMode.h"
29
30 namespace JSC {
31
32 class CellContainer;
33 class Heap;
34 class LargeAllocation;
35 class MarkedBlock;
36 class Subspace;
37 class VM;
38 struct AllocatorAttributes;
39
40 class HeapCell {
41 public:
42     enum Kind : int8_t {
43         JSCell,
44         Auxiliary
45     };
46     
47     HeapCell() { }
48     
49     void zap() { *reinterpret_cast_ptr<uintptr_t**>(this) = 0; }
50     bool isZapped() const { return !*reinterpret_cast_ptr<uintptr_t* const*>(this); }
51
52     bool isLive();
53
54     bool isLargeAllocation() const;
55     CellContainer cellContainer() const;
56     MarkedBlock& markedBlock() const;
57     LargeAllocation& largeAllocation() const;
58
59     // If you want performance and you know that your cell is small, you can do this instead:
60     // ASSERT(!cell->isLargeAllocation());
61     // cell->markedBlock().vm()
62     // We currently only use this hack for callees to make ExecState::vm() fast. It's not
63     // recommended to use it for too many other things, since the large allocation cutoff is
64     // a runtime option and its default value is small (400 bytes).
65     Heap* heap() const;
66     VM* vm() const;
67     
68     size_t cellSize() const;
69     AllocatorAttributes allocatorAttributes() const;
70     DestructionMode destructionMode() const;
71     Kind cellKind() const;
72     Subspace* subspace() const;
73     
74     // Call use() after the last point where you need `this` pointer to be kept alive. You usually don't
75     // need to use this, but it might be necessary if you're otherwise referring to an object's innards
76     // but not the object itself.
77 #if COMPILER(GCC_OR_CLANG)
78     void use() const
79     {
80         asm volatile ("" : : "r"(this) : "memory");
81     }
82 #else
83     void use() const;
84 #endif
85 };
86
87 } // namespace JSC
88
89 namespace WTF {
90
91 class PrintStream;
92
93 void printInternal(PrintStream&, JSC::HeapCell::Kind);
94
95 } // namespace WTF
96