summaryrefslogtreecommitdiff
path: root/base/HybridEntityManager.h
blob: db1f27bf6583074f2f427259f5e11c95818c1865 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
// Copyright (C) 2020 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#pragma once

#include "base/Lookup.h"
#include "base/EntityManager.h"
#include "base/Lock.h"

#include <unordered_map>

namespace android {
namespace base {

template <size_t maxIndex,
          class IndexType, // must be castable to uint64_t
          class Data>
class HybridEntityManager {
public:
    using EM = EntityManager<32, 16, 16, Data>;
    using IterFunc = typename EM::IteratorFunc;
    using ConstIterFunc = typename EM::ConstIteratorFunc;
    using Handle = typename EM::EntityHandle;

    HybridEntityManager() : mEntityManager(maxIndex + 1) { }
    ~HybridEntityManager() { clear(); }

    uint64_t add(const Data& data, size_t type) {
        uint64_t nextIndex = 0;
        {
            SeqLock::ScopedWrite sw(&mEntityManagerLock);
            nextIndex = (uint64_t)mEntityManager.nextFreeIndex();
            if (nextIndex < maxIndex) {
                uint64_t resultHandle = mEntityManager.add(data, type);
                if (EM::getHandleIndex(resultHandle) != nextIndex) {
                    fprintf(stderr, "%s: fatal: handle indices mismatch. wanted 0x%llx got 0x%llx\n", __func__,
                            (unsigned long long)nextIndex,
                            (unsigned long long)EM::getHandleIndex(resultHandle));
                    abort();
                }
                return resultHandle;
            }
        }

        AutoLock lock(mMapLock);
        if (mIndexForMap == 0) {
            mIndexForMap = maxIndex;
        }
        nextIndex = mIndexForMap;
        mMap[nextIndex] = data;
        ++mIndexForMap;
        return EM::makeHandle(nextIndex, 1, type);
    }

    uint64_t addFixed(IndexType index, const Data& data, size_t type) {
        uint64_t index_u64 = (uint64_t)EM::getHandleIndex(index);
        if (index_u64 < maxIndex) {
            SeqLock::ScopedWrite sw(&mEntityManagerLock);
            return mEntityManager.addFixed(index, data, type);
        } else {
            AutoLock lock(mMapLock);
            // Fixed allocations require us to update mIndexForMap to catch up with it.
            // We assume that addFixed/add for the map case do not interleave badly
            // (addFixed at i, add at i+1, addFixed at i+1)
            mIndexForMap = index_u64;
            mMap[index_u64] = data;
            ++mIndexForMap;
            return index;
        }
    }

    void clear() {
        {
            SeqLock::ScopedWrite sw(&mEntityManagerLock);
            mEntityManager.clear();
        }
        {
            AutoLock lock(mMapLock);
            mMap.clear();
            mIndexForMap = 0;
        }
    }

    void remove(IndexType index) {
        uint64_t index_u64 = (uint64_t)EM::getHandleIndex(index);
        if (index_u64 < maxIndex) {
            SeqLock::ScopedWrite sw(&mEntityManagerLock);
            mEntityManager.remove(index);
        } else {
            AutoLock lock(mMapLock);
            mMap.erase(index_u64);
        }
    }

    Data* get(IndexType index) {
        uint64_t index_u64 = (uint64_t)EM::getHandleIndex(index);
        if (index_u64 < maxIndex) {
            SeqLock::ScopedWrite sw(&mEntityManagerLock);
            return mEntityManager.get(index);
        } else {
            AutoLock lock(mMapLock);
            auto res = android::base::find(mMap, index_u64);
            return res;
        }
    }

    const Data* get_const(IndexType index) const {
        uint64_t index_u64 = (uint64_t)EM::getHandleIndex(index);
        if (index_u64 < maxIndex) {
            const Data* res;
            AEMU_SEQLOCK_READ_WITH_RETRY(&mEntityManagerLock,
                res = mEntityManager.get_const(index));
            return res;
        } else {
            AutoLock lock(mMapLock);
            auto res = android::base::find(mMap, index_u64);
            return res;
        }
    }

    Data* getExceptZero(IndexType index) {
        Data* res = get(index);
        if (!res) return nullptr;
        if (!(*res)) return nullptr;
        return res;
    }

    const Data* getExceptZero_const(IndexType index) const {
        const Data* res = get_const(index);
        if (!res) return nullptr;
        if (!(*res)) return nullptr;
        return res;
    }

    void forEach(IterFunc func) {
        {
            SeqLock::ScopedWrite sw(&mEntityManagerLock);
            mEntityManager.forEach(func);
        }

        AutoLock lock(mMapLock);
        for (auto it : mMap) {
            auto handle = index2Handle(it.first);
            func(true /* live */, handle, handle, it.second);
        }
    }

    void forEachLive(IterFunc func) {
        {
            SeqLock::ScopedWrite sw(&mEntityManagerLock);
            mEntityManager.forEachLiveComponent(func);
        }

        AutoLock lock(mMapLock);
        for (auto it : mMap) {
            auto handle = index2Handle(it.first);
            func(true /* live */, handle, handle, it.second);
        }
    }

    void forEachLive_const(ConstIterFunc func) const {
        mEntityManager.forEachLiveEntry_const([this, func](bool live, Handle h, Data& d) {
            AEMU_SEQLOCK_READ_WITH_RETRY(
                &mEntityManagerLock,
                func(live, h, d));
        });

        AutoLock lock(mMapLock);
        for (const auto it : mMap) {
            auto handle = index2Handle(it.first);
            func(true /* live */, handle, handle, it.second);
        }
    }

private:
    static Handle index2Handle(uint64_t index) {
        return EM::makeHandle((uint32_t)index, 1, 1);
    }

    EM mEntityManager;
    std::unordered_map<IndexType, Data> mMap;
    uint64_t mIndexForMap = 0;
    mutable SeqLock mEntityManagerLock;
    mutable Lock mMapLock;
};

} // namespace android
} // namespace base