bmalloc should support system memory analysis tools (part 1)
[WebKit-https.git] / Source / bmalloc / bmalloc / Deallocator.h
1 /*
2  * Copyright (C) 2014 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 #ifndef Deallocator_h
27 #define Deallocator_h
28
29 #include "FixedVector.h"
30
31 namespace bmalloc {
32
33 class Heap;
34
35 // Per-cache object deallocator.
36
37 class Deallocator {
38 public:
39     Deallocator(Heap*);
40     ~Deallocator();
41
42     void deallocate(void*);
43     void scavenge();
44     
45 private:
46     bool deallocateFastCase(void*);
47     void deallocateSlowCase(void*);
48
49     void deallocateLarge(void*);
50     void deallocateXLarge(void*);
51     void processObjectLog();
52
53     FixedVector<void*, deallocatorLogCapacity> m_objectLog;
54     bool m_isBmallocEnabled;
55 };
56
57 inline bool Deallocator::deallocateFastCase(void* object)
58 {
59     if (!isSmallOrMedium(object))
60         return false;
61
62     BASSERT(object);
63
64     if (m_objectLog.size() == m_objectLog.capacity())
65         return false;
66
67     m_objectLog.push(object);
68     return true;
69 }
70
71 inline void Deallocator::deallocate(void* object)
72 {
73     if (!deallocateFastCase(object))
74         deallocateSlowCase(object);
75 }
76
77 } // namespace bmalloc
78
79 #endif // Deallocator_h