1/*
2 * Copyright (C) 2011-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 *
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. Neither the name of Apple Inc. ("Apple") nor the names of
14 * its contributors may be used to endorse or promote products derived
15 * from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29#pragma once
30
31#include <wtf/Assertions.h>
32#include <wtf/MetaAllocatorPtr.h>
33#include <wtf/RedBlackTree.h>
34#include <wtf/ThreadSafeRefCounted.h>
35
36namespace WTF {
37
38class MetaAllocator;
39class PrintStream;
40
41class MetaAllocatorHandle : public ThreadSafeRefCounted<MetaAllocatorHandle>, public RedBlackTree<MetaAllocatorHandle, void*>::Node {
42private:
43 MetaAllocatorHandle(MetaAllocator*, void* start, size_t sizeInBytes, void* ownerUID);
44
45public:
46 using MemoryPtr = MetaAllocatorPtr<HandleMemoryPtrTag>;
47
48 WTF_EXPORT_PRIVATE ~MetaAllocatorHandle();
49
50 MemoryPtr start() const
51 {
52 return m_start;
53 }
54
55 MemoryPtr end() const
56 {
57 return m_end;
58 }
59
60 uintptr_t startAsInteger() const
61 {
62 return m_start.untaggedPtr<uintptr_t>();
63 }
64
65 uintptr_t endAsInteger() const
66 {
67 return m_end.untaggedPtr<uintptr_t>();
68 }
69
70 size_t sizeInBytes() const
71 {
72 return m_end.untaggedPtr<size_t>() - m_start.untaggedPtr<size_t>();
73 }
74
75 bool containsIntegerAddress(uintptr_t address) const
76 {
77 return address >= startAsInteger() && address < endAsInteger();
78 }
79
80 bool contains(void* address) const
81 {
82 return containsIntegerAddress(reinterpret_cast<uintptr_t>(address));
83 }
84
85 WTF_EXPORT_PRIVATE void shrink(size_t newSizeInBytes);
86
87 bool isManaged()
88 {
89 return !!m_allocator;
90 }
91
92 MetaAllocator* allocator()
93 {
94 ASSERT(m_allocator);
95 return m_allocator;
96 }
97
98 void* ownerUID()
99 {
100 return m_ownerUID;
101 }
102
103 void* key()
104 {
105 return m_start.untaggedPtr();
106 }
107
108 WTF_EXPORT_PRIVATE void dump(PrintStream& out) const;
109
110private:
111 friend class MetaAllocator;
112
113 MetaAllocator* m_allocator;
114 MemoryPtr m_start;
115 MemoryPtr m_end;
116 void* m_ownerUID;
117};
118
119}
120