1//===-- sanitizer_stackdepot.h ----------------------------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file is shared between AddressSanitizer and ThreadSanitizer
10// run-time libraries.
11//===----------------------------------------------------------------------===//
12
13#ifndef SANITIZER_STACKDEPOT_H
14#define SANITIZER_STACKDEPOT_H
15
16#include "sanitizer_common.h"
17#include "sanitizer_internal_defs.h"
18#include "sanitizer_stacktrace.h"
19
20namespace __sanitizer {
21
22// StackDepot efficiently stores huge amounts of stack traces.
23struct StackDepotNode;
24struct StackDepotHandle {
25 StackDepotNode *node_;
26 StackDepotHandle() : node_(nullptr) {}
27 explicit StackDepotHandle(StackDepotNode *node) : node_(node) {}
28 bool valid() { return node_; }
29 u32 id();
30 int use_count();
31 void inc_use_count_unsafe();
32};
33
34const int kStackDepotMaxUseCount = 1U << (SANITIZER_ANDROID ? 16 : 20);
35
36StackDepotStats *StackDepotGetStats();
37u32 StackDepotPut(StackTrace stack);
38StackDepotHandle StackDepotPut_WithHandle(StackTrace stack);
39// Retrieves a stored stack trace by the id.
40StackTrace StackDepotGet(u32 id);
41
42void StackDepotLockAll();
43void StackDepotUnlockAll();
44void StackDepotPrintAll();
45
46// Instantiating this class creates a snapshot of StackDepot which can be
47// efficiently queried with StackDepotGet(). You can use it concurrently with
48// StackDepot, but the snapshot is only guaranteed to contain those stack traces
49// which were stored before it was instantiated.
50class StackDepotReverseMap {
51 public:
52 StackDepotReverseMap();
53 StackTrace Get(u32 id);
54
55 private:
56 struct IdDescPair {
57 u32 id;
58 StackDepotNode *desc;
59
60 static bool IdComparator(const IdDescPair &a, const IdDescPair &b);
61 };
62
63 InternalMmapVector<IdDescPair> map_;
64
65 // Disallow evil constructors.
66 StackDepotReverseMap(const StackDepotReverseMap&);
67 void operator=(const StackDepotReverseMap&);
68};
69
70} // namespace __sanitizer
71
72#endif // SANITIZER_STACKDEPOT_H
73