135aac07157af03803d8ef681e0eeb60321371ed
[WebKit-https.git] / Source / bmalloc / bmalloc / 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 "BExport.h"
29 #include <cstddef>
30 #include <cstdint>
31
32 namespace bmalloc {
33
34 struct FreeCell {
35     static uintptr_t scramble(FreeCell* cell, uintptr_t secret)
36     {
37         return reinterpret_cast<uintptr_t>(cell) ^ secret;
38     }
39     
40     static FreeCell* descramble(uintptr_t cell, uintptr_t secret)
41     {
42         return reinterpret_cast<FreeCell*>(cell ^ secret);
43     }
44     
45     void setNext(FreeCell* next, uintptr_t secret)
46     {
47         scrambledNext = scramble(next, secret);
48     }
49     
50     FreeCell* next(uintptr_t secret) const
51     {
52         return descramble(scrambledNext, secret);
53     }
54     
55     uintptr_t scrambledNext;
56 };
57
58 class FreeList {
59 public:
60     BEXPORT FreeList();
61     BEXPORT ~FreeList();
62     
63     BEXPORT void clear();
64     
65     BEXPORT void initializeList(FreeCell* head, uintptr_t secret, unsigned bytes);
66     BEXPORT void initializeBump(char* payloadEnd, unsigned remaining);
67     
68     bool allocationWillFail() const { return !head() && !m_remaining; }
69     bool allocationWillSucceed() const { return !allocationWillFail(); }
70     
71     template<typename Config, typename Func>
72     void* allocate(const Func& slowPath);
73     
74     bool contains(void*) const;
75     
76     template<typename Config, typename Func>
77     void forEach(const Func&) const;
78     
79     unsigned originalSize() const { return m_originalSize; }
80
81 private:
82     FreeCell* head() const { return FreeCell::descramble(m_scrambledHead, m_secret); }
83     
84     uintptr_t m_scrambledHead { 0 };
85     uintptr_t m_secret { 0 };
86     char* m_payloadEnd { nullptr };
87     unsigned m_remaining { 0 };
88     unsigned m_originalSize { 0 };
89 };
90
91 } // namespace bmalloc
92