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
|
// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_GWP_ASAN_CLIENT_SAMPLING_STATE_H_
#define COMPONENTS_GWP_ASAN_CLIENT_SAMPLING_STATE_H_
#include <stddef.h> // for size_t
#include <limits>
#include <random>
#include "base/check_op.h"
#include "base/compiler_specific.h"
#include "components/gwp_asan/client/thread_local_random_bit_generator.h"
#include "components/gwp_asan/client/thread_local_state.h"
#include "third_party/boringssl/src/include/openssl/rand.h"
namespace gwp_asan {
namespace internal {
enum ParentAllocator {
MALLOC = 0,
PARTITIONALLOC = 1,
LIGHTWEIGHTDETECTOR = 2,
EXTREMELIGHTWEIGHTDETECTOR = 3,
};
// Class that encapsulates the current sampling state. Sampling is performed
// using a counter stored in thread-local storage.
//
// This class is templated so that a thread-local global it contains is not
// shared between different instances (used by shims for different allocators.)
template <ParentAllocator PA>
class SamplingState : ThreadLocalState<SamplingState<PA>> {
public:
using TLS = ThreadLocalState<SamplingState<PA>>;
constexpr SamplingState() = default;
void Init(size_t sampling_frequency) {
DCHECK_GT(sampling_frequency, 0U);
sampling_probability_ = 1.0 / sampling_frequency;
ThreadLocalRandomBitGenerator::InitIfNeeded();
TLS::InitIfNeeded();
}
void SetSampleSizeRestriction(size_t sampling_min_size,
size_t sampling_max_size) {
sampling_min_size_ = sampling_min_size;
sampling_max_size_ = sampling_max_size;
}
// Return true if this allocation should be sampled.
ALWAYS_INLINE bool Sample(size_t alloc_size = 0) {
// For a new thread the initial TLS value will be zero, we do not want to
// sample on zero as it will always sample the first allocation on thread
// creation and heavily bias allocations towards that particular call site.
//
// Instead, use zero to mean 'get a new counter value' and one to mean
// that this allocation should be sampled.
if (alloc_size != 0 &&
(alloc_size < sampling_min_size_ || sampling_max_size_ < alloc_size)) {
// Skip sampling to increase chance of catching an OOB issue
return false;
}
size_t samples_left = TLS::GetState();
if (samples_left == 0) [[unlikely]] {
samples_left = NextSample();
}
--samples_left;
TLS::SetState(samples_left);
return samples_left == 0;
}
private:
// Sample an allocation on every average one out of every
// |sampling_frequency_| allocations.
size_t NextSample() {
ThreadLocalRandomBitGenerator generator;
std::geometric_distribution<size_t> distribution(sampling_probability_);
return distribution(generator) + 1;
}
size_t sampling_min_size_ = 0;
size_t sampling_max_size_ = std::numeric_limits<size_t>::max();
double sampling_probability_ = 0;
};
} // namespace internal
} // namespace gwp_asan
#endif // COMPONENTS_GWP_ASAN_CLIENT_SAMPLING_STATE_H_
|