Alexey Samsonov | e5f5895 | 2012-06-04 13:50:10 +0000 | [diff] [blame] | 1 | //===-- asan_thread.cc ----------------------------------------------------===// |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 2 | // |
| 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
| 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
| 7 | // |
| 8 | //===----------------------------------------------------------------------===// |
| 9 | // |
| 10 | // This file is a part of AddressSanitizer, an address sanity checker. |
| 11 | // |
| 12 | // Thread-related code. |
| 13 | //===----------------------------------------------------------------------===// |
| 14 | #include "asan_allocator.h" |
| 15 | #include "asan_interceptors.h" |
Alexey Samsonov | 55cdfc6 | 2012-01-17 06:35:31 +0000 | [diff] [blame] | 16 | #include "asan_stack.h" |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 17 | #include "asan_thread.h" |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 18 | #include "asan_mapping.h" |
Alexey Samsonov | e5931fd | 2012-06-07 07:13:46 +0000 | [diff] [blame] | 19 | #include "sanitizer_common/sanitizer_common.h" |
Alexey Samsonov | def1be9 | 2013-03-21 11:23:41 +0000 | [diff] [blame] | 20 | #include "sanitizer_common/sanitizer_placement_new.h" |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 21 | |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 22 | namespace __asan { |
| 23 | |
Alexey Samsonov | def1be9 | 2013-03-21 11:23:41 +0000 | [diff] [blame] | 24 | // AsanThreadContext implementation. |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 25 | |
Alexey Samsonov | def1be9 | 2013-03-21 11:23:41 +0000 | [diff] [blame] | 26 | void AsanThreadContext::OnCreated(void *arg) { |
| 27 | CreateThreadContextArgs *args = static_cast<CreateThreadContextArgs*>(arg); |
| 28 | if (args->stack) { |
| 29 | internal_memcpy(&stack, args->stack, sizeof(stack)); |
| 30 | } |
| 31 | thread = args->thread; |
| 32 | thread->set_context(this); |
| 33 | } |
| 34 | |
| 35 | void AsanThreadContext::OnFinished() { |
| 36 | // Drop the link to the AsanThread object. |
| 37 | thread = 0; |
| 38 | } |
| 39 | |
| 40 | static char thread_registry_placeholder[sizeof(ThreadRegistry)]; |
| 41 | static ThreadRegistry *asan_thread_registry; |
| 42 | |
| 43 | static ThreadContextBase *GetAsanThreadContext(u32 tid) { |
| 44 | void *mem = MmapOrDie(sizeof(AsanThreadContext), "AsanThreadContext"); |
| 45 | return new(mem) AsanThreadContext(tid); |
| 46 | } |
| 47 | |
| 48 | ThreadRegistry &asanThreadRegistry() { |
| 49 | static bool initialized; |
| 50 | // Don't worry about thread_safety - this should be called when there is |
| 51 | // a single thread. |
| 52 | if (!initialized) { |
| 53 | // Never reuse ASan threads: we store pointer to AsanThreadContext |
| 54 | // in TSD and can't reliably tell when no more TSD destructors will |
| 55 | // be called. It would be wrong to reuse AsanThreadContext for another |
| 56 | // thread before all TSD destructors will be called for it. |
| 57 | asan_thread_registry = new(thread_registry_placeholder) ThreadRegistry( |
| 58 | GetAsanThreadContext, kMaxNumberOfThreads, kMaxNumberOfThreads); |
| 59 | initialized = true; |
| 60 | } |
| 61 | return *asan_thread_registry; |
| 62 | } |
| 63 | |
| 64 | AsanThreadContext *GetThreadContextByTidLocked(u32 tid) { |
| 65 | return static_cast<AsanThreadContext *>( |
| 66 | asanThreadRegistry().GetThreadLocked(tid)); |
| 67 | } |
| 68 | |
| 69 | // AsanThread implementation. |
| 70 | |
| 71 | AsanThread *AsanThread::Create(thread_callback_t start_routine, |
| 72 | void *arg) { |
Kostya Serebryany | f67ec2b | 2012-11-23 15:38:49 +0000 | [diff] [blame] | 73 | uptr PageSize = GetPageSizeCached(); |
| 74 | uptr size = RoundUpTo(sizeof(AsanThread), PageSize); |
Alexey Samsonov | a25b346 | 2012-06-06 16:15:07 +0000 | [diff] [blame] | 75 | AsanThread *thread = (AsanThread*)MmapOrDie(size, __FUNCTION__); |
Alexey Samsonov | 55cdfc6 | 2012-01-17 06:35:31 +0000 | [diff] [blame] | 76 | thread->start_routine_ = start_routine; |
| 77 | thread->arg_ = arg; |
Alexey Samsonov | def1be9 | 2013-03-21 11:23:41 +0000 | [diff] [blame] | 78 | thread->context_ = 0; |
Alexey Samsonov | 55cdfc6 | 2012-01-17 06:35:31 +0000 | [diff] [blame] | 79 | |
| 80 | return thread; |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 81 | } |
| 82 | |
Alexey Samsonov | def1be9 | 2013-03-21 11:23:41 +0000 | [diff] [blame] | 83 | void AsanThread::TSDDtor(void *tsd) { |
| 84 | AsanThreadContext *context = (AsanThreadContext*)tsd; |
| 85 | if (flags()->verbosity >= 1) |
| 86 | Report("T%d TSDDtor\n", context->tid); |
| 87 | if (context->thread) |
| 88 | context->thread->Destroy(); |
Kostya Serebryany | f58f998 | 2012-02-07 00:27:15 +0000 | [diff] [blame] | 89 | } |
| 90 | |
Kostya Serebryany | a6b5226 | 2012-01-06 19:44:11 +0000 | [diff] [blame] | 91 | void AsanThread::Destroy() { |
Alexey Samsonov | cb8c4dc | 2012-07-09 14:36:04 +0000 | [diff] [blame] | 92 | if (flags()->verbosity >= 1) { |
Kostya Serebryany | f58f998 | 2012-02-07 00:27:15 +0000 | [diff] [blame] | 93 | Report("T%d exited\n", tid()); |
| 94 | } |
| 95 | |
Alexey Samsonov | def1be9 | 2013-03-21 11:23:41 +0000 | [diff] [blame] | 96 | asanThreadRegistry().FinishThread(tid()); |
| 97 | FlushToAccumulatedStats(&stats_); |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 98 | // We also clear the shadow on thread destruction because |
| 99 | // some code may still be executing in later TSD destructors |
| 100 | // and we don't want it to have any poisoned stack. |
| 101 | ClearShadowForThreadStack(); |
Alexey Samsonov | 55cdfc6 | 2012-01-17 06:35:31 +0000 | [diff] [blame] | 102 | fake_stack().Cleanup(); |
Kostya Serebryany | f67ec2b | 2012-11-23 15:38:49 +0000 | [diff] [blame] | 103 | uptr size = RoundUpTo(sizeof(AsanThread), GetPageSizeCached()); |
Alexey Samsonov | a25b346 | 2012-06-06 16:15:07 +0000 | [diff] [blame] | 104 | UnmapOrDie(this, size); |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 105 | } |
| 106 | |
Kostya Serebryany | 69eca73 | 2011-12-16 19:13:35 +0000 | [diff] [blame] | 107 | void AsanThread::Init() { |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 108 | SetThreadStackTopAndBottom(); |
Alexey Samsonov | 55cdfc6 | 2012-01-17 06:35:31 +0000 | [diff] [blame] | 109 | CHECK(AddrIsInMem(stack_bottom_)); |
Kostya Serebryany | 541cfb1 | 2013-01-18 11:30:36 +0000 | [diff] [blame] | 110 | CHECK(AddrIsInMem(stack_top_ - 1)); |
Alexey Samsonov | 55cdfc6 | 2012-01-17 06:35:31 +0000 | [diff] [blame] | 111 | ClearShadowForThreadStack(); |
Alexey Samsonov | cb8c4dc | 2012-07-09 14:36:04 +0000 | [diff] [blame] | 112 | if (flags()->verbosity >= 1) { |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 113 | int local = 0; |
Evgeniy Stepanov | 739eb79 | 2012-03-21 11:32:46 +0000 | [diff] [blame] | 114 | Report("T%d: stack [%p,%p) size 0x%zx; local=%p\n", |
Alexey Samsonov | 5bcca4e | 2012-06-06 10:46:00 +0000 | [diff] [blame] | 115 | tid(), (void*)stack_bottom_, (void*)stack_top_, |
Kostya Serebryany | a7e760a | 2012-01-09 19:18:27 +0000 | [diff] [blame] | 116 | stack_top_ - stack_bottom_, &local); |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 117 | } |
Alexey Samsonov | 55cdfc6 | 2012-01-17 06:35:31 +0000 | [diff] [blame] | 118 | fake_stack_.Init(stack_size()); |
Alexander Potapenko | 75b19eb | 2012-07-23 14:07:58 +0000 | [diff] [blame] | 119 | AsanPlatformThreadInit(); |
Kostya Serebryany | 69eca73 | 2011-12-16 19:13:35 +0000 | [diff] [blame] | 120 | } |
| 121 | |
Alexey Samsonov | def1be9 | 2013-03-21 11:23:41 +0000 | [diff] [blame] | 122 | thread_return_t AsanThread::ThreadStart(uptr os_id) { |
Kostya Serebryany | 69eca73 | 2011-12-16 19:13:35 +0000 | [diff] [blame] | 123 | Init(); |
Alexey Samsonov | def1be9 | 2013-03-21 11:23:41 +0000 | [diff] [blame] | 124 | asanThreadRegistry().StartThread(tid(), os_id, 0); |
Alexey Samsonov | cb8c4dc | 2012-07-09 14:36:04 +0000 | [diff] [blame] | 125 | if (flags()->use_sigaltstack) SetAlternateSignalStack(); |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 126 | |
| 127 | if (!start_routine_) { |
Kostya Serebryany | 3f4c387 | 2012-05-31 14:35:53 +0000 | [diff] [blame] | 128 | // start_routine_ == 0 if we're on the main thread or on one of the |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 129 | // OS X libdispatch worker threads. But nobody is supposed to call |
| 130 | // ThreadStart() for the worker threads. |
| 131 | CHECK(tid() == 0); |
| 132 | return 0; |
| 133 | } |
| 134 | |
Timur Iskhodzhanov | 600972e | 2012-02-24 15:28:43 +0000 | [diff] [blame] | 135 | thread_return_t res = start_routine_(arg_); |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 136 | malloc_storage().CommitBack(); |
Alexey Samsonov | cb8c4dc | 2012-07-09 14:36:04 +0000 | [diff] [blame] | 137 | if (flags()->use_sigaltstack) UnsetAlternateSignalStack(); |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 138 | |
Kostya Serebryany | af34415 | 2012-01-11 02:03:16 +0000 | [diff] [blame] | 139 | this->Destroy(); |
| 140 | |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 141 | return res; |
| 142 | } |
| 143 | |
Alexey Samsonov | e5931fd | 2012-06-07 07:13:46 +0000 | [diff] [blame] | 144 | void AsanThread::SetThreadStackTopAndBottom() { |
| 145 | GetThreadStackTopAndBottom(tid() == 0, &stack_top_, &stack_bottom_); |
| 146 | int local; |
| 147 | CHECK(AddrIsInStack((uptr)&local)); |
| 148 | } |
| 149 | |
Alexey Samsonov | 55cdfc6 | 2012-01-17 06:35:31 +0000 | [diff] [blame] | 150 | void AsanThread::ClearShadowForThreadStack() { |
| 151 | PoisonShadow(stack_bottom_, stack_top_ - stack_bottom_, 0); |
| 152 | } |
| 153 | |
Kostya Serebryany | 3f4c387 | 2012-05-31 14:35:53 +0000 | [diff] [blame] | 154 | const char *AsanThread::GetFrameNameByAddr(uptr addr, uptr *offset) { |
| 155 | uptr bottom = 0; |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 156 | if (AddrIsInStack(addr)) { |
| 157 | bottom = stack_bottom(); |
| 158 | } else { |
| 159 | bottom = fake_stack().AddrIsInFakeStack(addr); |
| 160 | CHECK(bottom); |
Alexander Potapenko | e406c8c | 2012-11-15 15:24:42 +0000 | [diff] [blame] | 161 | *offset = addr - bottom; |
| 162 | return (const char *)((uptr*)bottom)[1]; |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 163 | } |
Kostya Serebryany | 5af39e5 | 2012-11-21 12:38:58 +0000 | [diff] [blame] | 164 | uptr aligned_addr = addr & ~(SANITIZER_WORDSIZE/8 - 1); // align addr. |
Kostya Serebryany | ee39255 | 2012-05-31 15:02:07 +0000 | [diff] [blame] | 165 | u8 *shadow_ptr = (u8*)MemToShadow(aligned_addr); |
| 166 | u8 *shadow_bottom = (u8*)MemToShadow(bottom); |
Evgeniy Stepanov | 3972ea0 | 2012-05-12 12:33:10 +0000 | [diff] [blame] | 167 | |
| 168 | while (shadow_ptr >= shadow_bottom && |
Alexander Potapenko | e406c8c | 2012-11-15 15:24:42 +0000 | [diff] [blame] | 169 | *shadow_ptr != kAsanStackLeftRedzoneMagic) { |
Evgeniy Stepanov | 3972ea0 | 2012-05-12 12:33:10 +0000 | [diff] [blame] | 170 | shadow_ptr--; |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 171 | } |
Evgeniy Stepanov | 3972ea0 | 2012-05-12 12:33:10 +0000 | [diff] [blame] | 172 | |
| 173 | while (shadow_ptr >= shadow_bottom && |
Alexander Potapenko | e406c8c | 2012-11-15 15:24:42 +0000 | [diff] [blame] | 174 | *shadow_ptr == kAsanStackLeftRedzoneMagic) { |
Evgeniy Stepanov | 3972ea0 | 2012-05-12 12:33:10 +0000 | [diff] [blame] | 175 | shadow_ptr--; |
| 176 | } |
| 177 | |
| 178 | if (shadow_ptr < shadow_bottom) { |
Alexander Potapenko | e406c8c | 2012-11-15 15:24:42 +0000 | [diff] [blame] | 179 | *offset = 0; |
| 180 | return "UNKNOWN"; |
Evgeniy Stepanov | 3972ea0 | 2012-05-12 12:33:10 +0000 | [diff] [blame] | 181 | } |
| 182 | |
Kostya Serebryany | 3f4c387 | 2012-05-31 14:35:53 +0000 | [diff] [blame] | 183 | uptr* ptr = (uptr*)SHADOW_TO_MEM((uptr)(shadow_ptr + 1)); |
Alexander Potapenko | e406c8c | 2012-11-15 15:24:42 +0000 | [diff] [blame] | 184 | CHECK(ptr[0] == kCurrentStackFrameMagic); |
Kostya Serebryany | 3f4c387 | 2012-05-31 14:35:53 +0000 | [diff] [blame] | 185 | *offset = addr - (uptr)ptr; |
Evgeniy Stepanov | 3972ea0 | 2012-05-12 12:33:10 +0000 | [diff] [blame] | 186 | return (const char*)ptr[1]; |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 187 | } |
| 188 | |
Alexey Samsonov | def1be9 | 2013-03-21 11:23:41 +0000 | [diff] [blame] | 189 | static bool ThreadStackContainsAddress(ThreadContextBase *tctx_base, |
| 190 | void *addr) { |
| 191 | AsanThreadContext *tctx = static_cast<AsanThreadContext*>(tctx_base); |
| 192 | AsanThread *t = tctx->thread; |
| 193 | return (t && t->fake_stack().StackSize() && |
| 194 | (t->fake_stack().AddrIsInFakeStack((uptr)addr) || |
| 195 | t->AddrIsInStack((uptr)addr))); |
| 196 | } |
| 197 | |
Alexey Samsonov | 89c1384 | 2013-03-20 09:23:28 +0000 | [diff] [blame] | 198 | AsanThread *GetCurrentThread() { |
Alexey Samsonov | def1be9 | 2013-03-21 11:23:41 +0000 | [diff] [blame] | 199 | AsanThreadContext *context = (AsanThreadContext*)AsanTSDGet(); |
| 200 | if (!context) { |
| 201 | if (SANITIZER_ANDROID) { |
| 202 | // On Android, libc constructor is called _after_ asan_init, and cleans up |
| 203 | // TSD. Try to figure out if this is still the main thread by the stack |
| 204 | // address. We are not entirely sure that we have correct main thread |
Dmitry Vyukov | 195369b | 2013-03-22 07:29:59 +0000 | [diff] [blame] | 205 | // limits, so only do this magic on Android, and only if the found thread |
| 206 | // is the main thread. |
Alexey Samsonov | def1be9 | 2013-03-21 11:23:41 +0000 | [diff] [blame] | 207 | AsanThreadContext *tctx = GetThreadContextByTidLocked(0); |
| 208 | if (ThreadStackContainsAddress(tctx, &context)) { |
| 209 | SetCurrentThread(tctx->thread); |
| 210 | return tctx->thread; |
| 211 | } |
Alexey Samsonov | 89c1384 | 2013-03-20 09:23:28 +0000 | [diff] [blame] | 212 | } |
Alexey Samsonov | 89c1384 | 2013-03-20 09:23:28 +0000 | [diff] [blame] | 213 | return 0; |
| 214 | } |
Alexey Samsonov | def1be9 | 2013-03-21 11:23:41 +0000 | [diff] [blame] | 215 | return context->thread; |
Alexey Samsonov | 89c1384 | 2013-03-20 09:23:28 +0000 | [diff] [blame] | 216 | } |
| 217 | |
| 218 | void SetCurrentThread(AsanThread *t) { |
Alexey Samsonov | def1be9 | 2013-03-21 11:23:41 +0000 | [diff] [blame] | 219 | CHECK(t->context()); |
Alexey Samsonov | 89c1384 | 2013-03-20 09:23:28 +0000 | [diff] [blame] | 220 | if (flags()->verbosity >= 2) { |
| 221 | Report("SetCurrentThread: %p for thread %p\n", |
Alexey Samsonov | def1be9 | 2013-03-21 11:23:41 +0000 | [diff] [blame] | 222 | t->context(), (void*)GetThreadSelf()); |
Alexey Samsonov | 89c1384 | 2013-03-20 09:23:28 +0000 | [diff] [blame] | 223 | } |
| 224 | // Make sure we do not reset the current AsanThread. |
Alexey Samsonov | def1be9 | 2013-03-21 11:23:41 +0000 | [diff] [blame] | 225 | CHECK_EQ(0, AsanTSDGet()); |
| 226 | AsanTSDSet(t->context()); |
| 227 | CHECK_EQ(t->context(), AsanTSDGet()); |
Alexey Samsonov | 89c1384 | 2013-03-20 09:23:28 +0000 | [diff] [blame] | 228 | } |
| 229 | |
| 230 | u32 GetCurrentTidOrInvalid() { |
| 231 | AsanThread *t = GetCurrentThread(); |
| 232 | return t ? t->tid() : kInvalidTid; |
| 233 | } |
| 234 | |
Alexey Samsonov | def1be9 | 2013-03-21 11:23:41 +0000 | [diff] [blame] | 235 | AsanThread *FindThreadByStackAddress(uptr addr) { |
| 236 | asanThreadRegistry().CheckLocked(); |
| 237 | AsanThreadContext *tctx = static_cast<AsanThreadContext *>( |
| 238 | asanThreadRegistry().FindThreadContextLocked(ThreadStackContainsAddress, |
| 239 | (void *)addr)); |
| 240 | return tctx ? tctx->thread : 0; |
| 241 | } |
| 242 | |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 243 | } // namespace __asan |