2dc913b308217218c7801b8714ca2eacfc39a2a8
[WebKit-https.git] / Source / bmalloc / bmalloc / IsoDirectory.h
1 /*
2  * Copyright (C) 2017-2018 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 "Bits.h"
29 #include "EligibilityResult.h"
30 #include "IsoPage.h"
31 #include "Vector.h"
32
33 namespace bmalloc {
34
35 template<typename Config> class IsoHeapImpl;
36
37 class IsoDirectoryBaseBase {
38 public:
39     IsoDirectoryBaseBase() { }
40     virtual ~IsoDirectoryBaseBase() { }
41
42     virtual void didDecommit(unsigned index) = 0;
43 };
44
45 template<typename Config>
46 class IsoDirectoryBase : public IsoDirectoryBaseBase {
47 public:
48     IsoDirectoryBase(IsoHeapImpl<Config>&);
49     
50     IsoHeapImpl<Config>& heap() { return m_heap; }
51     
52     virtual void didBecome(IsoPage<Config>*, IsoPageTrigger) = 0;
53     
54 protected:
55     IsoHeapImpl<Config>& m_heap;
56 };
57
58 template<typename Config, unsigned passedNumPages>
59 class IsoDirectory : public IsoDirectoryBase<Config> {
60 public:
61     static constexpr unsigned numPages = passedNumPages;
62     
63     IsoDirectory(IsoHeapImpl<Config>&);
64     
65     // Find the first page that is eligible for allocation and return it. May return null if there is no
66     // such thing. May allocate a new page if we have an uncommitted page.
67     EligibilityResult<Config> takeFirstEligible();
68     
69     void didBecome(IsoPage<Config>*, IsoPageTrigger) override;
70     
71     // This gets called from a bulk decommit function in the Scavenger, so no locks are held. This function
72     // needs to get the heap lock.
73     void didDecommit(unsigned index) override;
74     
75     // Iterate over all empty and committed pages, and put them into the vector. This also records the
76     // pages as being decommitted. It's the caller's job to do the actual decommitting.
77     void scavenge(Vector<DeferredDecommit>&);
78     void scavengeToHighWatermark(Vector<DeferredDecommit>&);
79
80     template<typename Func>
81     void forEachCommittedPage(const Func&);
82     
83 private:
84     void scavengePage(size_t, Vector<DeferredDecommit>&);
85
86     // NOTE: I suppose that this could be two bitvectors. But from working on the GC, I found that the
87     // number of bitvectors does not matter as much as whether or not they make intuitive sense.
88     Bits<numPages> m_eligible;
89     Bits<numPages> m_empty;
90     Bits<numPages> m_committed;
91     std::array<IsoPage<Config>*, numPages> m_pages;
92     unsigned m_firstEligible { 0 };
93     unsigned m_highWatermark { 0 };
94 };
95
96 } // namespace bmalloc
97