168d75effSDimitry Andric //===-- asan_mac.cpp ------------------------------------------------------===//
268d75effSDimitry Andric //
368d75effSDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
468d75effSDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
568d75effSDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
668d75effSDimitry Andric //
768d75effSDimitry Andric //===----------------------------------------------------------------------===//
868d75effSDimitry Andric //
968d75effSDimitry Andric // This file is a part of AddressSanitizer, an address sanity checker.
1068d75effSDimitry Andric //
1168d75effSDimitry Andric // Mac-specific details.
1268d75effSDimitry Andric //===----------------------------------------------------------------------===//
1368d75effSDimitry Andric
1468d75effSDimitry Andric #include "sanitizer_common/sanitizer_platform.h"
1581ad6265SDimitry Andric #if SANITIZER_APPLE
1668d75effSDimitry Andric
1768d75effSDimitry Andric #include "asan_interceptors.h"
1868d75effSDimitry Andric #include "asan_internal.h"
1968d75effSDimitry Andric #include "asan_mapping.h"
2068d75effSDimitry Andric #include "asan_stack.h"
2168d75effSDimitry Andric #include "asan_thread.h"
2268d75effSDimitry Andric #include "sanitizer_common/sanitizer_atomic.h"
2368d75effSDimitry Andric #include "sanitizer_common/sanitizer_libc.h"
2468d75effSDimitry Andric #include "sanitizer_common/sanitizer_mac.h"
2568d75effSDimitry Andric
2668d75effSDimitry Andric #include <dlfcn.h>
2768d75effSDimitry Andric #include <fcntl.h>
2868d75effSDimitry Andric #include <libkern/OSAtomic.h>
2968d75effSDimitry Andric #include <mach-o/dyld.h>
3068d75effSDimitry Andric #include <mach-o/getsect.h>
3168d75effSDimitry Andric #include <mach-o/loader.h>
3268d75effSDimitry Andric #include <pthread.h>
3368d75effSDimitry Andric #include <stdlib.h> // for free()
3468d75effSDimitry Andric #include <sys/mman.h>
3568d75effSDimitry Andric #include <sys/resource.h>
3668d75effSDimitry Andric #include <sys/sysctl.h>
3768d75effSDimitry Andric #include <sys/ucontext.h>
3868d75effSDimitry Andric #include <unistd.h>
3968d75effSDimitry Andric
4068d75effSDimitry Andric // from <crt_externs.h>, but we don't have that file on iOS
4168d75effSDimitry Andric extern "C" {
4268d75effSDimitry Andric extern char ***_NSGetArgv(void);
4368d75effSDimitry Andric extern char ***_NSGetEnviron(void);
4468d75effSDimitry Andric }
4568d75effSDimitry Andric
4668d75effSDimitry Andric namespace __asan {
4768d75effSDimitry Andric
InitializePlatformInterceptors()4868d75effSDimitry Andric void InitializePlatformInterceptors() {}
InitializePlatformExceptionHandlers()4968d75effSDimitry Andric void InitializePlatformExceptionHandlers() {}
IsSystemHeapAddress(uptr addr)5068d75effSDimitry Andric bool IsSystemHeapAddress (uptr addr) { return false; }
5168d75effSDimitry Andric
5268d75effSDimitry Andric // No-op. Mac does not support static linkage anyway.
AsanDoesNotSupportStaticLinkage()5368d75effSDimitry Andric void *AsanDoesNotSupportStaticLinkage() {
5468d75effSDimitry Andric return 0;
5568d75effSDimitry Andric }
5668d75effSDimitry Andric
FindDynamicShadowStart()5768d75effSDimitry Andric uptr FindDynamicShadowStart() {
580eae32dcSDimitry Andric return MapDynamicShadow(MemToShadowSize(kHighMemEnd), ASAN_SHADOW_SCALE,
59e8d8bef9SDimitry Andric /*min_shadow_base_alignment*/ 0, kHighMemEnd);
6068d75effSDimitry Andric }
6168d75effSDimitry Andric
6268d75effSDimitry Andric // No-op. Mac does not support static linkage anyway.
AsanCheckDynamicRTPrereqs()6368d75effSDimitry Andric void AsanCheckDynamicRTPrereqs() {}
6468d75effSDimitry Andric
6568d75effSDimitry Andric // No-op. Mac does not support static linkage anyway.
AsanCheckIncompatibleRT()6668d75effSDimitry Andric void AsanCheckIncompatibleRT() {}
6768d75effSDimitry Andric
AsanApplyToGlobals(globals_op_fptr op,const void * needle)6868d75effSDimitry Andric void AsanApplyToGlobals(globals_op_fptr op, const void *needle) {
6968d75effSDimitry Andric // Find the Mach-O header for the image containing the needle
7068d75effSDimitry Andric Dl_info info;
7168d75effSDimitry Andric int err = dladdr(needle, &info);
7268d75effSDimitry Andric if (err == 0) return;
7368d75effSDimitry Andric
7468d75effSDimitry Andric #if __LP64__
7568d75effSDimitry Andric const struct mach_header_64 *mh = (struct mach_header_64 *)info.dli_fbase;
7668d75effSDimitry Andric #else
7768d75effSDimitry Andric const struct mach_header *mh = (struct mach_header *)info.dli_fbase;
7868d75effSDimitry Andric #endif
7968d75effSDimitry Andric
8068d75effSDimitry Andric // Look up the __asan_globals section in that image and register its globals
8168d75effSDimitry Andric unsigned long size = 0;
8268d75effSDimitry Andric __asan_global *globals = (__asan_global *)getsectiondata(
8368d75effSDimitry Andric mh,
8468d75effSDimitry Andric "__DATA", "__asan_globals",
8568d75effSDimitry Andric &size);
8668d75effSDimitry Andric
8768d75effSDimitry Andric if (!globals) return;
8868d75effSDimitry Andric if (size % sizeof(__asan_global) != 0) return;
8968d75effSDimitry Andric op(globals, size / sizeof(__asan_global));
9068d75effSDimitry Andric }
9168d75effSDimitry Andric
FlushUnneededASanShadowMemory(uptr p,uptr size)92e8d8bef9SDimitry Andric void FlushUnneededASanShadowMemory(uptr p, uptr size) {
93e8d8bef9SDimitry Andric // Since asan's mapping is compacting, the shadow chunk may be
94e8d8bef9SDimitry Andric // not page-aligned, so we only flush the page-aligned portion.
95e8d8bef9SDimitry Andric ReleaseMemoryPagesToOS(MemToShadow(p), MemToShadow(p + size));
96e8d8bef9SDimitry Andric }
97e8d8bef9SDimitry Andric
9868d75effSDimitry Andric // Support for the following functions from libdispatch on Mac OS:
9968d75effSDimitry Andric // dispatch_async_f()
10068d75effSDimitry Andric // dispatch_async()
10168d75effSDimitry Andric // dispatch_sync_f()
10268d75effSDimitry Andric // dispatch_sync()
10368d75effSDimitry Andric // dispatch_after_f()
10468d75effSDimitry Andric // dispatch_after()
10568d75effSDimitry Andric // dispatch_group_async_f()
10668d75effSDimitry Andric // dispatch_group_async()
10768d75effSDimitry Andric // TODO(glider): libdispatch API contains other functions that we don't support
10868d75effSDimitry Andric // yet.
10968d75effSDimitry Andric //
11068d75effSDimitry Andric // dispatch_sync() and dispatch_sync_f() are synchronous, although chances are
11168d75effSDimitry Andric // they can cause jobs to run on a thread different from the current one.
11268d75effSDimitry Andric // TODO(glider): if so, we need a test for this (otherwise we should remove
11368d75effSDimitry Andric // them).
11468d75effSDimitry Andric //
11568d75effSDimitry Andric // The following functions use dispatch_barrier_async_f() (which isn't a library
11668d75effSDimitry Andric // function but is exported) and are thus supported:
11768d75effSDimitry Andric // dispatch_source_set_cancel_handler_f()
11868d75effSDimitry Andric // dispatch_source_set_cancel_handler()
11968d75effSDimitry Andric // dispatch_source_set_event_handler_f()
12068d75effSDimitry Andric // dispatch_source_set_event_handler()
12168d75effSDimitry Andric //
12268d75effSDimitry Andric // The reference manual for Grand Central Dispatch is available at
12368d75effSDimitry Andric // http://developer.apple.com/library/mac/#documentation/Performance/Reference/GCD_libdispatch_Ref/Reference/reference.html
12468d75effSDimitry Andric // The implementation details are at
12568d75effSDimitry Andric // http://libdispatch.macosforge.org/trac/browser/trunk/src/queue.c
12668d75effSDimitry Andric
12768d75effSDimitry Andric typedef void* dispatch_group_t;
12868d75effSDimitry Andric typedef void* dispatch_queue_t;
12968d75effSDimitry Andric typedef void* dispatch_source_t;
13068d75effSDimitry Andric typedef u64 dispatch_time_t;
13168d75effSDimitry Andric typedef void (*dispatch_function_t)(void *block);
13268d75effSDimitry Andric typedef void* (*worker_t)(void *block);
13306c3fb27SDimitry Andric typedef unsigned long dispatch_mach_reason;
13406c3fb27SDimitry Andric typedef void *dispatch_mach_msg_t;
13506c3fb27SDimitry Andric typedef int mach_error_t;
13606c3fb27SDimitry Andric typedef void *dispatch_mach_t;
13706c3fb27SDimitry Andric
13806c3fb27SDimitry Andric typedef void (*dispatch_mach_handler_function_t)(void *context,
13906c3fb27SDimitry Andric dispatch_mach_reason reason,
14006c3fb27SDimitry Andric dispatch_mach_msg_t message,
14106c3fb27SDimitry Andric mach_error_t error);
142*5f757f3fSDimitry Andric # if !defined(MISSING_BLOCKS_SUPPORT)
14306c3fb27SDimitry Andric typedef void (^dispatch_mach_handler_t)(dispatch_mach_reason reason,
14406c3fb27SDimitry Andric dispatch_mach_msg_t message,
14506c3fb27SDimitry Andric mach_error_t error);
146*5f757f3fSDimitry Andric # endif
14768d75effSDimitry Andric
14868d75effSDimitry Andric // A wrapper for the ObjC blocks used to support libdispatch.
14968d75effSDimitry Andric typedef struct {
15068d75effSDimitry Andric void *block;
15168d75effSDimitry Andric dispatch_function_t func;
15268d75effSDimitry Andric u32 parent_tid;
15368d75effSDimitry Andric } asan_block_context_t;
15468d75effSDimitry Andric
15568d75effSDimitry Andric ALWAYS_INLINE
asan_register_worker_thread(int parent_tid,StackTrace * stack)15668d75effSDimitry Andric void asan_register_worker_thread(int parent_tid, StackTrace *stack) {
15768d75effSDimitry Andric AsanThread *t = GetCurrentThread();
15868d75effSDimitry Andric if (!t) {
159*5f757f3fSDimitry Andric t = AsanThread::Create(parent_tid, stack, /* detached */ true);
16068d75effSDimitry Andric t->Init();
16168d75effSDimitry Andric asanThreadRegistry().StartThread(t->tid(), GetTid(), ThreadType::Worker,
16268d75effSDimitry Andric nullptr);
16368d75effSDimitry Andric SetCurrentThread(t);
16468d75effSDimitry Andric }
16568d75effSDimitry Andric }
16668d75effSDimitry Andric
16768d75effSDimitry Andric // For use by only those functions that allocated the context via
16868d75effSDimitry Andric // alloc_asan_context().
16968d75effSDimitry Andric extern "C"
asan_dispatch_call_block_and_release(void * block)17068d75effSDimitry Andric void asan_dispatch_call_block_and_release(void *block) {
17168d75effSDimitry Andric GET_STACK_TRACE_THREAD;
17268d75effSDimitry Andric asan_block_context_t *context = (asan_block_context_t*)block;
17368d75effSDimitry Andric VReport(2,
17468d75effSDimitry Andric "asan_dispatch_call_block_and_release(): "
17568d75effSDimitry Andric "context: %p, pthread_self: %p\n",
17606c3fb27SDimitry Andric block, (void*)pthread_self());
17768d75effSDimitry Andric asan_register_worker_thread(context->parent_tid, &stack);
17868d75effSDimitry Andric // Call the original dispatcher for the block.
17968d75effSDimitry Andric context->func(context->block);
18068d75effSDimitry Andric asan_free(context, &stack, FROM_MALLOC);
18168d75effSDimitry Andric }
18268d75effSDimitry Andric
18368d75effSDimitry Andric } // namespace __asan
18468d75effSDimitry Andric
18568d75effSDimitry Andric using namespace __asan;
18668d75effSDimitry Andric
18768d75effSDimitry Andric // Wrap |ctxt| and |func| into an asan_block_context_t.
18868d75effSDimitry Andric // The caller retains control of the allocated context.
18968d75effSDimitry Andric extern "C"
alloc_asan_context(void * ctxt,dispatch_function_t func,BufferedStackTrace * stack)19068d75effSDimitry Andric asan_block_context_t *alloc_asan_context(void *ctxt, dispatch_function_t func,
19168d75effSDimitry Andric BufferedStackTrace *stack) {
19268d75effSDimitry Andric asan_block_context_t *asan_ctxt =
19368d75effSDimitry Andric (asan_block_context_t*) asan_malloc(sizeof(asan_block_context_t), stack);
19468d75effSDimitry Andric asan_ctxt->block = ctxt;
19568d75effSDimitry Andric asan_ctxt->func = func;
19668d75effSDimitry Andric asan_ctxt->parent_tid = GetCurrentTidOrInvalid();
19768d75effSDimitry Andric return asan_ctxt;
19868d75effSDimitry Andric }
19968d75effSDimitry Andric
20068d75effSDimitry Andric // Define interceptor for dispatch_*_f function with the three most common
20168d75effSDimitry Andric // parameters: dispatch_queue_t, context, dispatch_function_t.
20268d75effSDimitry Andric #define INTERCEPT_DISPATCH_X_F_3(dispatch_x_f) \
20368d75effSDimitry Andric INTERCEPTOR(void, dispatch_x_f, dispatch_queue_t dq, void *ctxt, \
20468d75effSDimitry Andric dispatch_function_t func) { \
20568d75effSDimitry Andric GET_STACK_TRACE_THREAD; \
20668d75effSDimitry Andric asan_block_context_t *asan_ctxt = alloc_asan_context(ctxt, func, &stack); \
20768d75effSDimitry Andric if (Verbosity() >= 2) { \
20868d75effSDimitry Andric Report(#dispatch_x_f "(): context: %p, pthread_self: %p\n", \
20906c3fb27SDimitry Andric (void*)asan_ctxt, (void*)pthread_self()); \
21068d75effSDimitry Andric PRINT_CURRENT_STACK(); \
21168d75effSDimitry Andric } \
21268d75effSDimitry Andric return REAL(dispatch_x_f)(dq, (void*)asan_ctxt, \
21368d75effSDimitry Andric asan_dispatch_call_block_and_release); \
21468d75effSDimitry Andric }
21568d75effSDimitry Andric
21668d75effSDimitry Andric INTERCEPT_DISPATCH_X_F_3(dispatch_async_f)
INTERCEPT_DISPATCH_X_F_3(dispatch_sync_f)21768d75effSDimitry Andric INTERCEPT_DISPATCH_X_F_3(dispatch_sync_f)
21868d75effSDimitry Andric INTERCEPT_DISPATCH_X_F_3(dispatch_barrier_async_f)
21968d75effSDimitry Andric
22068d75effSDimitry Andric INTERCEPTOR(void, dispatch_after_f, dispatch_time_t when,
22168d75effSDimitry Andric dispatch_queue_t dq, void *ctxt,
22268d75effSDimitry Andric dispatch_function_t func) {
22368d75effSDimitry Andric GET_STACK_TRACE_THREAD;
22468d75effSDimitry Andric asan_block_context_t *asan_ctxt = alloc_asan_context(ctxt, func, &stack);
22568d75effSDimitry Andric if (Verbosity() >= 2) {
22606c3fb27SDimitry Andric Report("dispatch_after_f: %p\n", (void*)asan_ctxt);
22768d75effSDimitry Andric PRINT_CURRENT_STACK();
22868d75effSDimitry Andric }
22968d75effSDimitry Andric return REAL(dispatch_after_f)(when, dq, (void*)asan_ctxt,
23068d75effSDimitry Andric asan_dispatch_call_block_and_release);
23168d75effSDimitry Andric }
23268d75effSDimitry Andric
INTERCEPTOR(void,dispatch_group_async_f,dispatch_group_t group,dispatch_queue_t dq,void * ctxt,dispatch_function_t func)23368d75effSDimitry Andric INTERCEPTOR(void, dispatch_group_async_f, dispatch_group_t group,
23468d75effSDimitry Andric dispatch_queue_t dq, void *ctxt,
23568d75effSDimitry Andric dispatch_function_t func) {
23668d75effSDimitry Andric GET_STACK_TRACE_THREAD;
23768d75effSDimitry Andric asan_block_context_t *asan_ctxt = alloc_asan_context(ctxt, func, &stack);
23868d75effSDimitry Andric if (Verbosity() >= 2) {
23968d75effSDimitry Andric Report("dispatch_group_async_f(): context: %p, pthread_self: %p\n",
24006c3fb27SDimitry Andric (void*)asan_ctxt, (void*)pthread_self());
24168d75effSDimitry Andric PRINT_CURRENT_STACK();
24268d75effSDimitry Andric }
24368d75effSDimitry Andric REAL(dispatch_group_async_f)(group, dq, (void*)asan_ctxt,
24468d75effSDimitry Andric asan_dispatch_call_block_and_release);
24568d75effSDimitry Andric }
24668d75effSDimitry Andric
24768d75effSDimitry Andric #if !defined(MISSING_BLOCKS_SUPPORT)
24868d75effSDimitry Andric extern "C" {
24968d75effSDimitry Andric void dispatch_async(dispatch_queue_t dq, void(^work)(void));
25068d75effSDimitry Andric void dispatch_group_async(dispatch_group_t dg, dispatch_queue_t dq,
25168d75effSDimitry Andric void(^work)(void));
25268d75effSDimitry Andric void dispatch_after(dispatch_time_t when, dispatch_queue_t queue,
25368d75effSDimitry Andric void(^work)(void));
25468d75effSDimitry Andric void dispatch_source_set_cancel_handler(dispatch_source_t ds,
25568d75effSDimitry Andric void(^work)(void));
25668d75effSDimitry Andric void dispatch_source_set_event_handler(dispatch_source_t ds, void(^work)(void));
25706c3fb27SDimitry Andric dispatch_mach_t dispatch_mach_create(const char *label, dispatch_queue_t queue,
25806c3fb27SDimitry Andric dispatch_mach_handler_t handler);
25968d75effSDimitry Andric }
26068d75effSDimitry Andric
26168d75effSDimitry Andric #define GET_ASAN_BLOCK(work) \
26268d75effSDimitry Andric void (^asan_block)(void); \
26368d75effSDimitry Andric int parent_tid = GetCurrentTidOrInvalid(); \
26468d75effSDimitry Andric asan_block = ^(void) { \
26568d75effSDimitry Andric GET_STACK_TRACE_THREAD; \
26668d75effSDimitry Andric asan_register_worker_thread(parent_tid, &stack); \
26768d75effSDimitry Andric work(); \
26868d75effSDimitry Andric }
26968d75effSDimitry Andric
27068d75effSDimitry Andric INTERCEPTOR(void, dispatch_async,
27168d75effSDimitry Andric dispatch_queue_t dq, void(^work)(void)) {
27268d75effSDimitry Andric ENABLE_FRAME_POINTER;
27368d75effSDimitry Andric GET_ASAN_BLOCK(work);
27468d75effSDimitry Andric REAL(dispatch_async)(dq, asan_block);
27568d75effSDimitry Andric }
27668d75effSDimitry Andric
27768d75effSDimitry Andric INTERCEPTOR(void, dispatch_group_async,
27868d75effSDimitry Andric dispatch_group_t dg, dispatch_queue_t dq, void(^work)(void)) {
27968d75effSDimitry Andric ENABLE_FRAME_POINTER;
28068d75effSDimitry Andric GET_ASAN_BLOCK(work);
28168d75effSDimitry Andric REAL(dispatch_group_async)(dg, dq, asan_block);
28268d75effSDimitry Andric }
28368d75effSDimitry Andric
28468d75effSDimitry Andric INTERCEPTOR(void, dispatch_after,
28568d75effSDimitry Andric dispatch_time_t when, dispatch_queue_t queue, void(^work)(void)) {
28668d75effSDimitry Andric ENABLE_FRAME_POINTER;
28768d75effSDimitry Andric GET_ASAN_BLOCK(work);
28868d75effSDimitry Andric REAL(dispatch_after)(when, queue, asan_block);
28968d75effSDimitry Andric }
29068d75effSDimitry Andric
29168d75effSDimitry Andric INTERCEPTOR(void, dispatch_source_set_cancel_handler,
29268d75effSDimitry Andric dispatch_source_t ds, void(^work)(void)) {
29368d75effSDimitry Andric if (!work) {
29468d75effSDimitry Andric REAL(dispatch_source_set_cancel_handler)(ds, work);
29568d75effSDimitry Andric return;
29668d75effSDimitry Andric }
29768d75effSDimitry Andric ENABLE_FRAME_POINTER;
29868d75effSDimitry Andric GET_ASAN_BLOCK(work);
29968d75effSDimitry Andric REAL(dispatch_source_set_cancel_handler)(ds, asan_block);
30068d75effSDimitry Andric }
30168d75effSDimitry Andric
30268d75effSDimitry Andric INTERCEPTOR(void, dispatch_source_set_event_handler,
30368d75effSDimitry Andric dispatch_source_t ds, void(^work)(void)) {
30468d75effSDimitry Andric ENABLE_FRAME_POINTER;
30568d75effSDimitry Andric GET_ASAN_BLOCK(work);
30668d75effSDimitry Andric REAL(dispatch_source_set_event_handler)(ds, asan_block);
30768d75effSDimitry Andric }
30806c3fb27SDimitry Andric
INTERCEPTOR(void *,dispatch_mach_create,const char * label,dispatch_queue_t dq,dispatch_mach_handler_t handler)30906c3fb27SDimitry Andric INTERCEPTOR(void *, dispatch_mach_create, const char *label,
31006c3fb27SDimitry Andric dispatch_queue_t dq, dispatch_mach_handler_t handler) {
31106c3fb27SDimitry Andric int parent_tid = GetCurrentTidOrInvalid();
31206c3fb27SDimitry Andric return REAL(dispatch_mach_create)(
31306c3fb27SDimitry Andric label, dq,
31406c3fb27SDimitry Andric ^(dispatch_mach_reason reason, dispatch_mach_msg_t message,
31506c3fb27SDimitry Andric mach_error_t error) {
31606c3fb27SDimitry Andric GET_STACK_TRACE_THREAD;
31706c3fb27SDimitry Andric asan_register_worker_thread(parent_tid, &stack);
31806c3fb27SDimitry Andric handler(reason, message, error);
31906c3fb27SDimitry Andric });
32006c3fb27SDimitry Andric }
32106c3fb27SDimitry Andric
INTERCEPTOR(void *,dispatch_mach_create_f,const char * label,dispatch_queue_t dq,void * ctxt,dispatch_mach_handler_function_t handler)32206c3fb27SDimitry Andric INTERCEPTOR(void *, dispatch_mach_create_f, const char *label,
32306c3fb27SDimitry Andric dispatch_queue_t dq, void *ctxt,
32406c3fb27SDimitry Andric dispatch_mach_handler_function_t handler) {
32506c3fb27SDimitry Andric int parent_tid = GetCurrentTidOrInvalid();
32606c3fb27SDimitry Andric return REAL(dispatch_mach_create)(
32706c3fb27SDimitry Andric label, dq,
32806c3fb27SDimitry Andric ^(dispatch_mach_reason reason, dispatch_mach_msg_t message,
32906c3fb27SDimitry Andric mach_error_t error) {
33006c3fb27SDimitry Andric GET_STACK_TRACE_THREAD;
33106c3fb27SDimitry Andric asan_register_worker_thread(parent_tid, &stack);
33206c3fb27SDimitry Andric handler(ctxt, reason, message, error);
33306c3fb27SDimitry Andric });
33406c3fb27SDimitry Andric }
33506c3fb27SDimitry Andric
33668d75effSDimitry Andric #endif
33768d75effSDimitry Andric
33881ad6265SDimitry Andric #endif // SANITIZER_APPLE
339