xref: /openbsd-src/gnu/llvm/compiler-rt/lib/sanitizer_common/sanitizer_stackdepot.h (revision 810390e339a5425391477d5d41c78d7cab2424ac)
13cab2bb3Spatrick //===-- sanitizer_stackdepot.h ----------------------------------*- C++ -*-===//
23cab2bb3Spatrick //
33cab2bb3Spatrick // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
43cab2bb3Spatrick // See https://llvm.org/LICENSE.txt for license information.
53cab2bb3Spatrick // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
63cab2bb3Spatrick //
73cab2bb3Spatrick //===----------------------------------------------------------------------===//
83cab2bb3Spatrick //
93cab2bb3Spatrick // This file is shared between AddressSanitizer and ThreadSanitizer
103cab2bb3Spatrick // run-time libraries.
113cab2bb3Spatrick //===----------------------------------------------------------------------===//
123cab2bb3Spatrick 
133cab2bb3Spatrick #ifndef SANITIZER_STACKDEPOT_H
143cab2bb3Spatrick #define SANITIZER_STACKDEPOT_H
153cab2bb3Spatrick 
163cab2bb3Spatrick #include "sanitizer_common.h"
173cab2bb3Spatrick #include "sanitizer_internal_defs.h"
183cab2bb3Spatrick #include "sanitizer_stacktrace.h"
193cab2bb3Spatrick 
203cab2bb3Spatrick namespace __sanitizer {
213cab2bb3Spatrick 
223cab2bb3Spatrick // StackDepot efficiently stores huge amounts of stack traces.
233cab2bb3Spatrick struct StackDepotNode;
243cab2bb3Spatrick struct StackDepotHandle {
25*810390e3Srobert   StackDepotNode *node_ = nullptr;
26*810390e3Srobert   u32 id_ = 0;
StackDepotHandleStackDepotHandle27*810390e3Srobert   StackDepotHandle(StackDepotNode *node, u32 id) : node_(node), id_(id) {}
validStackDepotHandle28*810390e3Srobert   bool valid() const { return node_; }
idStackDepotHandle29*810390e3Srobert   u32 id() const { return id_; }
30*810390e3Srobert   int use_count() const;
313cab2bb3Spatrick   void inc_use_count_unsafe();
323cab2bb3Spatrick };
333cab2bb3Spatrick 
343cab2bb3Spatrick const int kStackDepotMaxUseCount = 1U << (SANITIZER_ANDROID ? 16 : 20);
353cab2bb3Spatrick 
36*810390e3Srobert StackDepotStats StackDepotGetStats();
373cab2bb3Spatrick u32 StackDepotPut(StackTrace stack);
383cab2bb3Spatrick StackDepotHandle StackDepotPut_WithHandle(StackTrace stack);
393cab2bb3Spatrick // Retrieves a stored stack trace by the id.
403cab2bb3Spatrick StackTrace StackDepotGet(u32 id);
413cab2bb3Spatrick 
423cab2bb3Spatrick void StackDepotLockAll();
433cab2bb3Spatrick void StackDepotUnlockAll();
44d89ec533Spatrick void StackDepotPrintAll();
45*810390e3Srobert void StackDepotStopBackgroundThread();
463cab2bb3Spatrick 
47*810390e3Srobert void StackDepotTestOnlyUnmap();
483cab2bb3Spatrick 
493cab2bb3Spatrick } // namespace __sanitizer
503cab2bb3Spatrick 
513cab2bb3Spatrick #endif // SANITIZER_STACKDEPOT_H
52