1 //===-- hwasan_thread.h -----------------------------------------*- C++ -*-===//
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
7 //===----------------------------------------------------------------------===//
9 // This file is a part of HWAddressSanitizer.
11 //===----------------------------------------------------------------------===//
13 #ifndef HWASAN_THREAD_H
14 #define HWASAN_THREAD_H
16 #include "hwasan_allocator.h"
17 #include "sanitizer_common/sanitizer_common.h"
18 #include "sanitizer_common/sanitizer_ring_buffer.h"
22 typedef __sanitizer::CompactRingBuffer
<uptr
> StackAllocationsRingBuffer
;
26 void Init(uptr stack_buffer_start
, uptr stack_buffer_size
); // Must be called from the thread itself.
27 void InitRandomState();
30 uptr
stack_top() { return stack_top_
; }
31 uptr
stack_bottom() { return stack_bottom_
; }
32 uptr
stack_size() { return stack_top() - stack_bottom(); }
33 uptr
tls_begin() { return tls_begin_
; }
34 uptr
tls_end() { return tls_end_
; }
35 bool IsMainThread() { return unique_id_
== 0; }
37 bool AddrIsInStack(uptr addr
) {
38 return addr
>= stack_bottom_
&& addr
< stack_top_
;
41 AllocatorCache
*allocator_cache() { return &allocator_cache_
; }
42 HeapAllocationsRingBuffer
*heap_allocations() { return heap_allocations_
; }
43 StackAllocationsRingBuffer
*stack_allocations() { return stack_allocations_
; }
45 tag_t
GenerateRandomTag(uptr num_bits
= kTagBits
);
47 void DisableTagging() { tagging_disabled_
++; }
48 void EnableTagging() { tagging_disabled_
--; }
50 u64
unique_id() const { return unique_id_
; }
52 if (announced_
) return;
57 uptr
&vfork_spill() { return vfork_spill_
; }
60 // NOTE: There is no Thread constructor. It is allocated
61 // via mmap() and *must* be valid in zero-initialized state.
62 void ClearShadowForThreadStackAndTLS();
63 void Print(const char *prefix
);
73 AllocatorCache allocator_cache_
;
74 HeapAllocationsRingBuffer
*heap_allocations_
;
75 StackAllocationsRingBuffer
*stack_allocations_
;
77 u64 unique_id_
; // counting from zero.
79 u32 tagging_disabled_
; // if non-zero, malloc uses zero tag in this thread.
83 friend struct ThreadListHead
;
86 Thread
*GetCurrentThread();
87 uptr
*GetCurrentThreadLongPtr();
89 struct ScopedTaggingDisabler
{
90 ScopedTaggingDisabler() { GetCurrentThread()->DisableTagging(); }
91 ~ScopedTaggingDisabler() { GetCurrentThread()->EnableTagging(); }
94 } // namespace __hwasan
96 #endif // HWASAN_THREAD_H