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
|
// Copyright 2019 The TCMalloc Authors
//
// 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
//
// https://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.
#ifndef TCMALLOC_PAGE_ALLOCATOR_INTERFACE_H_
#define TCMALLOC_PAGE_ALLOCATOR_INTERFACE_H_
#include <stddef.h>
#include <limits>
#include <utility>
#include "absl/base/internal/spinlock.h"
#include "absl/base/thread_annotations.h"
#include "tcmalloc/common.h"
#include "tcmalloc/span.h"
#include "tcmalloc/stats.h"
GOOGLE_MALLOC_SECTION_BEGIN
namespace tcmalloc {
namespace tcmalloc_internal {
class PageMap;
class PageAllocatorInterface {
public:
PageAllocatorInterface(const char* label, MemoryTag tag);
// For testing: use a non-default pagemap.
PageAllocatorInterface(const char* label, PageMap* map, MemoryTag tag);
virtual ~PageAllocatorInterface();
// Allocate a run of "n" pages. Returns zero if out of memory.
// Caller should not pass "n == 0" -- instead, n should have
// been rounded up already.
virtual Span* New(Length n) ABSL_LOCKS_EXCLUDED(pageheap_lock) = 0;
// As New, but the returned span is aligned to a <align>-page boundary.
// <align> must be a power of two.
virtual Span* NewAligned(Length n, Length align)
ABSL_LOCKS_EXCLUDED(pageheap_lock) = 0;
// Delete the span "[p, p+n-1]".
// REQUIRES: span was returned by earlier call to New() and
// has not yet been deleted.
virtual void Delete(Span* span)
ABSL_EXCLUSIVE_LOCKS_REQUIRED(pageheap_lock) = 0;
virtual BackingStats stats() const
ABSL_EXCLUSIVE_LOCKS_REQUIRED(pageheap_lock) = 0;
virtual void GetSmallSpanStats(SmallSpanStats* result)
ABSL_EXCLUSIVE_LOCKS_REQUIRED(pageheap_lock) = 0;
virtual void GetLargeSpanStats(LargeSpanStats* result)
ABSL_EXCLUSIVE_LOCKS_REQUIRED(pageheap_lock) = 0;
// Try to release at least num_pages for reuse by the OS. Returns
// the actual number of pages released, which may be less than
// num_pages if there weren't enough pages to release. The result
// may also be larger than num_pages since page_heap might decide to
// release one large range instead of fragmenting it into two
// smaller released and unreleased ranges.
virtual Length ReleaseAtLeastNPages(Length num_pages)
ABSL_EXCLUSIVE_LOCKS_REQUIRED(pageheap_lock) = 0;
// Prints stats about the page heap to *out.
virtual void Print(Printer* out) ABSL_LOCKS_EXCLUDED(pageheap_lock) = 0;
// Prints stats about the page heap in pbtxt format.
//
// TODO(b/130249686): Remove this one and make `Print` print in pbtxt.
virtual void PrintInPbtxt(PbtxtRegion* region)
ABSL_LOCKS_EXCLUDED(pageheap_lock) = 0;
const PageAllocInfo& info() const { return info_; }
protected:
PageAllocInfo info_ ABSL_GUARDED_BY(pageheap_lock);
PageMap* pagemap_;
MemoryTag tag_; // The type of tagged memory this heap manages
};
} // namespace tcmalloc_internal
} // namespace tcmalloc
GOOGLE_MALLOC_SECTION_END
#endif // TCMALLOC_PAGE_ALLOCATOR_INTERFACE_H_
|
