[WTF] Use m_suspendCount instead of m_suspended flag in Thread
[WebKit-https.git] / Source / JavaScriptCore / heap / FreeList.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 <wtf/Noncopyable.h>
29 #include <wtf/PrintStream.h>
30
31 namespace JSC {
32
33 class HeapCell;
34
35 struct FreeCell {
36     static uintptr_t scramble(FreeCell* cell, uintptr_t secret)
37     {
38         return bitwise_cast<uintptr_t>(cell) ^ secret;
39     }
40     
41     static FreeCell* descramble(uintptr_t cell, uintptr_t secret)
42     {
43         return bitwise_cast<FreeCell*>(cell ^ secret);
44     }
45     
46     void setNext(FreeCell* next, uintptr_t secret)
47     {
48         scrambledNext = scramble(next, secret);
49     }
50     
51     FreeCell* next(uintptr_t secret) const
52     {
53         return descramble(scrambledNext, secret);
54     }
55     
56     uintptr_t scrambledNext;
57 };
58
59 class FreeList {
60     WTF_MAKE_NONCOPYABLE(FreeList);
61     
62 public:
63     FreeList(unsigned cellSize);
64     ~FreeList();
65     
66     void clear();
67     
68     void initializeList(FreeCell* head, uintptr_t secret, unsigned bytes);
69     void initializeBump(char* payloadEnd, unsigned remaining);
70     
71     bool allocationWillFail() const { return !head() && !m_remaining; }
72     bool allocationWillSucceed() const { return !allocationWillFail(); }
73     
74     template<typename Func>
75     HeapCell* allocate(const Func& slowPath);
76     
77     bool contains(HeapCell*) const;
78     
79     template<typename Func>
80     void forEach(const Func&) const;
81     
82     unsigned originalSize() const { return m_originalSize; }
83
84     static ptrdiff_t offsetOfScrambledHead() { return OBJECT_OFFSETOF(FreeList, m_scrambledHead); }
85     static ptrdiff_t offsetOfSecret() { return OBJECT_OFFSETOF(FreeList, m_secret); }
86     static ptrdiff_t offsetOfPayloadEnd() { return OBJECT_OFFSETOF(FreeList, m_payloadEnd); }
87     static ptrdiff_t offsetOfRemaining() { return OBJECT_OFFSETOF(FreeList, m_remaining); }
88     static ptrdiff_t offsetOfOriginalSize() { return OBJECT_OFFSETOF(FreeList, m_originalSize); }
89     
90     void dump(PrintStream&) const;
91     
92 private:
93     FreeCell* head() const { return FreeCell::descramble(m_scrambledHead, m_secret); }
94     
95     uintptr_t m_scrambledHead { 0 };
96     uintptr_t m_secret { 0 };
97     char* m_payloadEnd { nullptr };
98     unsigned m_remaining { 0 };
99     unsigned m_originalSize { 0 };
100     unsigned m_cellSize { 0 };
101 };
102
103 } // namespace JSC
104