aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/tcmalloc/tcmalloc/span_test.cc
blob: 750f3cca26b3bc09ef8ee2a2a19459efee9c97a6 (plain) (blame)
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
// 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.

#include "tcmalloc/span.h"

#include <stdlib.h>

#include <utility>
#include <vector>

#include "gtest/gtest.h"
#include "absl/base/internal/spinlock.h"
#include "absl/container/flat_hash_set.h"
#include "absl/random/random.h"
#include "tcmalloc/common.h"
#include "tcmalloc/internal/logging.h"
#include "tcmalloc/static_vars.h"

namespace tcmalloc {
namespace tcmalloc_internal {
namespace {

class RawSpan {
 public:
  void Init(size_t cl) {
    size_t size = Static::sizemap().class_to_size(cl);
    auto npages = Length(Static::sizemap().class_to_pages(cl));
    size_t objects_per_span = npages.in_bytes() / size;

    void *mem;
    int res = posix_memalign(&mem, kPageSize, npages.in_bytes());
    CHECK_CONDITION(res == 0);
    span_.set_first_page(PageIdContaining(mem));
    span_.set_num_pages(npages);
    span_.BuildFreelist(size, objects_per_span, nullptr, 0);
  }

  ~RawSpan() { free(span_.start_address()); }

  Span &span() { return span_; }

 private:
  Span span_;
};

class SpanTest : public testing::TestWithParam<size_t> {
 protected:
  size_t cl_;
  size_t size_;
  size_t npages_;
  size_t batch_size_;
  size_t objects_per_span_;
  RawSpan raw_span_;

 private:
  void SetUp() override {
    cl_ = GetParam();
    size_ = Static::sizemap().class_to_size(cl_);
    if (size_ == 0) {
      GTEST_SKIP() << "Skipping empty size class.";
    }

    npages_ = Static::sizemap().class_to_pages(cl_);
    batch_size_ = Static::sizemap().num_objects_to_move(cl_);
    objects_per_span_ = npages_ * kPageSize / size_;

    raw_span_.Init(cl_);
  }

  void TearDown() override {}
};

TEST_P(SpanTest, FreelistBasic) {
  Span &span_ = raw_span_.span();

  EXPECT_FALSE(span_.FreelistEmpty(size_));
  void *batch[kMaxObjectsToMove];
  size_t popped = 0;
  size_t want = 1;
  char *start = static_cast<char *>(span_.start_address());
  std::vector<bool> objects(objects_per_span_);
  for (size_t x = 0; x < 2; ++x) {
    // Pop all objects in batches of varying size and ensure that we've got
    // all objects.
    for (;;) {
      size_t n = span_.FreelistPopBatch(batch, want, size_);
      popped += n;
      EXPECT_EQ(span_.FreelistEmpty(size_), popped == objects_per_span_);
      for (size_t i = 0; i < n; ++i) {
        void *p = batch[i];
        uintptr_t off = reinterpret_cast<char *>(p) - start;
        EXPECT_LT(off, span_.bytes_in_span());
        EXPECT_EQ(off % size_, 0);
        size_t idx = off / size_;
        EXPECT_FALSE(objects[idx]);
        objects[idx] = true;
      }
      if (n < want) {
        break;
      }
      ++want;
      if (want > batch_size_) {
        want = 1;
      }
    }
    EXPECT_TRUE(span_.FreelistEmpty(size_));
    EXPECT_EQ(span_.FreelistPopBatch(batch, 1, size_), 0);
    EXPECT_EQ(popped, objects_per_span_);

    // Push all objects back except the last one (which would not be pushed).
    for (size_t idx = 0; idx < objects_per_span_ - 1; ++idx) {
      EXPECT_TRUE(objects[idx]);
      bool ok = span_.FreelistPush(start + idx * size_, size_);
      EXPECT_TRUE(ok);
      EXPECT_FALSE(span_.FreelistEmpty(size_));
      objects[idx] = false;
      --popped;
    }
    // On the last iteration we can actually push the last object.
    if (x == 1) {
      bool ok =
          span_.FreelistPush(start + (objects_per_span_ - 1) * size_, size_);
      EXPECT_FALSE(ok);
    }
  }
}

TEST_P(SpanTest, FreelistRandomized) {
  Span &span_ = raw_span_.span();

  char *start = static_cast<char *>(span_.start_address());

  // Do a bunch of random pushes/pops with random batch size.
  absl::BitGen rng;
  absl::flat_hash_set<void *> objects;
  void *batch[kMaxObjectsToMove];
  for (size_t x = 0; x < 10000; ++x) {
    if (!objects.empty() && absl::Bernoulli(rng, 1.0 / 2)) {
      void *p = *objects.begin();
      if (span_.FreelistPush(p, size_)) {
        objects.erase(objects.begin());
      } else {
        EXPECT_EQ(objects.size(), 1);
      }
      EXPECT_EQ(span_.FreelistEmpty(size_), objects_per_span_ == 1);
    } else {
      size_t want = absl::Uniform<int32_t>(rng, 0, batch_size_) + 1;
      size_t n = span_.FreelistPopBatch(batch, want, size_);
      if (n < want) {
        EXPECT_TRUE(span_.FreelistEmpty(size_));
      }
      for (size_t i = 0; i < n; ++i) {
        EXPECT_TRUE(objects.insert(batch[i]).second);
      }
    }
  }
  // Now pop everything what's there.
  for (;;) {
    size_t n = span_.FreelistPopBatch(batch, batch_size_, size_);
    for (size_t i = 0; i < n; ++i) {
      EXPECT_TRUE(objects.insert(batch[i]).second);
    }
    if (n < batch_size_) {
      break;
    }
  }
  // Check that we have collected all objects.
  EXPECT_EQ(objects.size(), objects_per_span_);
  for (void *p : objects) {
    uintptr_t off = reinterpret_cast<char *>(p) - start;
    EXPECT_LT(off, span_.bytes_in_span());
    EXPECT_EQ(off % size_, 0);
  }
}

INSTANTIATE_TEST_SUITE_P(All, SpanTest, testing::Range(size_t(1), kNumClasses));

}  // namespace
}  // namespace tcmalloc_internal
}  // namespace tcmalloc