Logan Chien | 55afb0a | 2018-10-15 10:42:14 +0800 | [diff] [blame] | 1 | //===-- msan_interface.h --------------------------------------------------===// |
| 2 | // |
Logan Chien | dbcf412 | 2019-03-21 10:50:25 +0800 | [diff] [blame] | 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 |
Logan Chien | 55afb0a | 2018-10-15 10:42:14 +0800 | [diff] [blame] | 6 | // |
| 7 | //===----------------------------------------------------------------------===// |
| 8 | // |
| 9 | // This file is a part of MemorySanitizer. |
| 10 | // |
| 11 | // Public interface header. |
| 12 | //===----------------------------------------------------------------------===// |
| 13 | #ifndef MSAN_INTERFACE_H |
| 14 | #define MSAN_INTERFACE_H |
| 15 | |
| 16 | #include <sanitizer/common_interface_defs.h> |
| 17 | |
| 18 | #ifdef __cplusplus |
| 19 | extern "C" { |
| 20 | #endif |
| 21 | /* Set raw origin for the memory range. */ |
| 22 | void __msan_set_origin(const volatile void *a, size_t size, uint32_t origin); |
| 23 | |
| 24 | /* Get raw origin for an address. */ |
| 25 | uint32_t __msan_get_origin(const volatile void *a); |
| 26 | |
| 27 | /* Test that this_id is a descendant of prev_id (or they are simply equal). |
| 28 | * "descendant" here means they are part of the same chain, created with |
| 29 | * __msan_chain_origin. */ |
| 30 | int __msan_origin_is_descendant_or_same(uint32_t this_id, uint32_t prev_id); |
| 31 | |
| 32 | /* Returns non-zero if tracking origins. */ |
| 33 | int __msan_get_track_origins(void); |
| 34 | |
| 35 | /* Returns the origin id of the latest UMR in the calling thread. */ |
| 36 | uint32_t __msan_get_umr_origin(void); |
| 37 | |
| 38 | /* Make memory region fully initialized (without changing its contents). */ |
| 39 | void __msan_unpoison(const volatile void *a, size_t size); |
| 40 | |
| 41 | /* Make a null-terminated string fully initialized (without changing its |
| 42 | contents). */ |
| 43 | void __msan_unpoison_string(const volatile char *a); |
| 44 | |
Logan Chien | df4f766 | 2019-09-04 16:45:23 -0700 | [diff] [blame] | 45 | /* Make first n parameters of the next function call fully initialized. */ |
| 46 | void __msan_unpoison_param(size_t n); |
| 47 | |
Logan Chien | 55afb0a | 2018-10-15 10:42:14 +0800 | [diff] [blame] | 48 | /* Make memory region fully uninitialized (without changing its contents). |
| 49 | This is a legacy interface that does not update origin information. Use |
| 50 | __msan_allocated_memory() instead. */ |
| 51 | void __msan_poison(const volatile void *a, size_t size); |
| 52 | |
| 53 | /* Make memory region partially uninitialized (without changing its contents). |
| 54 | */ |
| 55 | void __msan_partial_poison(const volatile void *data, void *shadow, |
| 56 | size_t size); |
| 57 | |
| 58 | /* Returns the offset of the first (at least partially) poisoned byte in the |
| 59 | memory range, or -1 if the whole range is good. */ |
| 60 | intptr_t __msan_test_shadow(const volatile void *x, size_t size); |
| 61 | |
| 62 | /* Checks that memory range is fully initialized, and reports an error if it |
| 63 | * is not. */ |
| 64 | void __msan_check_mem_is_initialized(const volatile void *x, size_t size); |
| 65 | |
| 66 | /* For testing: |
| 67 | __msan_set_expect_umr(1); |
| 68 | ... some buggy code ... |
| 69 | __msan_set_expect_umr(0); |
| 70 | The last line will verify that a UMR happened. */ |
| 71 | void __msan_set_expect_umr(int expect_umr); |
| 72 | |
| 73 | /* Change the value of keep_going flag. Non-zero value means don't terminate |
| 74 | program execution when an error is detected. This will not affect error in |
| 75 | modules that were compiled without the corresponding compiler flag. */ |
| 76 | void __msan_set_keep_going(int keep_going); |
| 77 | |
| 78 | /* Print shadow and origin for the memory range to stderr in a human-readable |
| 79 | format. */ |
| 80 | void __msan_print_shadow(const volatile void *x, size_t size); |
| 81 | |
| 82 | /* Print shadow for the memory range to stderr in a minimalistic |
| 83 | human-readable format. */ |
| 84 | void __msan_dump_shadow(const volatile void *x, size_t size); |
| 85 | |
| 86 | /* Returns true if running under a dynamic tool (DynamoRio-based). */ |
| 87 | int __msan_has_dynamic_component(void); |
| 88 | |
| 89 | /* Tell MSan about newly allocated memory (ex.: custom allocator). |
| 90 | Memory will be marked uninitialized, with origin at the call site. */ |
| 91 | void __msan_allocated_memory(const volatile void* data, size_t size); |
| 92 | |
| 93 | /* Tell MSan about newly destroyed memory. Mark memory as uninitialized. */ |
| 94 | void __sanitizer_dtor_callback(const volatile void* data, size_t size); |
| 95 | |
| 96 | /* This function may be optionally provided by user and should return |
| 97 | a string containing Msan runtime options. See msan_flags.h for details. */ |
| 98 | const char* __msan_default_options(void); |
| 99 | |
| 100 | /* Deprecated. Call __sanitizer_set_death_callback instead. */ |
| 101 | void __msan_set_death_callback(void (*callback)(void)); |
| 102 | |
| 103 | /* Update shadow for the application copy of size bytes from src to dst. |
| 104 | Src and dst are application addresses. This function does not copy the |
| 105 | actual application memory, it only updates shadow and origin for such |
| 106 | copy. Source and destination regions can overlap. */ |
| 107 | void __msan_copy_shadow(const volatile void *dst, const volatile void *src, |
| 108 | size_t size); |
| 109 | |
| 110 | /* Disables uninitialized memory checks in interceptors. */ |
| 111 | void __msan_scoped_disable_interceptor_checks(void); |
| 112 | |
| 113 | /* Re-enables uninitialized memory checks in interceptors after a previous |
| 114 | call to __msan_scoped_disable_interceptor_checks. */ |
| 115 | void __msan_scoped_enable_interceptor_checks(void); |
| 116 | |
Sasha Smundak | 4b1f33a | 2021-01-11 15:05:07 -0800 | [diff] [blame] | 117 | void __msan_start_switch_fiber(const void *bottom, size_t size); |
| 118 | void __msan_finish_switch_fiber(const void **bottom_old, size_t *size_old); |
| 119 | |
Logan Chien | 55afb0a | 2018-10-15 10:42:14 +0800 | [diff] [blame] | 120 | #ifdef __cplusplus |
| 121 | } // extern "C" |
| 122 | #endif |
| 123 | |
| 124 | #endif |