1//===-- msan_interface_internal.h -------------------------------*- C++ -*-===//
2//
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
6//
7//===----------------------------------------------------------------------===//
8//
9// This file is a part of MemorySanitizer.
10//
11// Private MSan interface header.
12//===----------------------------------------------------------------------===//
13
14#ifndef MSAN_INTERFACE_INTERNAL_H
15#define MSAN_INTERFACE_INTERNAL_H
16
17#include "sanitizer_common/sanitizer_internal_defs.h"
18
19extern "C" {
20// FIXME: document all interface functions.
21
22SANITIZER_INTERFACE_ATTRIBUTE
23int __msan_get_track_origins();
24
25SANITIZER_INTERFACE_ATTRIBUTE
26void __msan_init();
27
28// Print a warning and maybe return.
29// This function can die based on common_flags()->exitcode.
30SANITIZER_INTERFACE_ATTRIBUTE
31void __msan_warning();
32
33// Print a warning and die.
34// Instrumentation inserts calls to this function when building in "fast" mode
35// (i.e. -mllvm -msan-keep-going)
36SANITIZER_INTERFACE_ATTRIBUTE __attribute__((noreturn))
37void __msan_warning_noreturn();
38
39using __sanitizer::uptr;
40using __sanitizer::sptr;
41using __sanitizer::uu64;
42using __sanitizer::uu32;
43using __sanitizer::uu16;
44using __sanitizer::u64;
45using __sanitizer::u32;
46using __sanitizer::u16;
47using __sanitizer::u8;
48
49// Versions of the above which take Origin as a parameter
50SANITIZER_INTERFACE_ATTRIBUTE
51void __msan_warning_with_origin(u32 origin);
52SANITIZER_INTERFACE_ATTRIBUTE __attribute__((noreturn)) void
53__msan_warning_with_origin_noreturn(u32 origin);
54
55SANITIZER_INTERFACE_ATTRIBUTE
56void __msan_maybe_warning_1(u8 s, u32 o);
57SANITIZER_INTERFACE_ATTRIBUTE
58void __msan_maybe_warning_2(u16 s, u32 o);
59SANITIZER_INTERFACE_ATTRIBUTE
60void __msan_maybe_warning_4(u32 s, u32 o);
61SANITIZER_INTERFACE_ATTRIBUTE
62void __msan_maybe_warning_8(u64 s, u32 o);
63SANITIZER_INTERFACE_ATTRIBUTE
64void __msan_maybe_warning_N(void *shadow, u64 size, u32 o);
65
66SANITIZER_INTERFACE_ATTRIBUTE
67void __msan_maybe_store_origin_1(u8 s, void *p, u32 o);
68SANITIZER_INTERFACE_ATTRIBUTE
69void __msan_maybe_store_origin_2(u16 s, void *p, u32 o);
70SANITIZER_INTERFACE_ATTRIBUTE
71void __msan_maybe_store_origin_4(u32 s, void *p, u32 o);
72SANITIZER_INTERFACE_ATTRIBUTE
73void __msan_maybe_store_origin_8(u64 s, void *p, u32 o);
74
75SANITIZER_INTERFACE_ATTRIBUTE
76void __msan_unpoison(const void *a, uptr size);
77SANITIZER_INTERFACE_ATTRIBUTE
78void __msan_unpoison_string(const char *s);
79SANITIZER_INTERFACE_ATTRIBUTE
80void __msan_unpoison_param(uptr n);
81SANITIZER_INTERFACE_ATTRIBUTE
82void __msan_clear_and_unpoison(void *a, uptr size);
83SANITIZER_INTERFACE_ATTRIBUTE
84void* __msan_memcpy(void *dst, const void *src, uptr size);
85SANITIZER_INTERFACE_ATTRIBUTE
86void* __msan_memset(void *s, int c, uptr n);
87SANITIZER_INTERFACE_ATTRIBUTE
88void* __msan_memmove(void* dest, const void* src, uptr n);
89SANITIZER_INTERFACE_ATTRIBUTE
90void __msan_poison(const void *a, uptr size);
91SANITIZER_INTERFACE_ATTRIBUTE
92void __msan_poison_stack(void *a, uptr size);
93
94// Copy size bytes from src to dst and unpoison the result.
95// Useful to implement unsafe loads.
96SANITIZER_INTERFACE_ATTRIBUTE
97void __msan_load_unpoisoned(void *src, uptr size, void *dst);
98
99// Returns the offset of the first (at least partially) poisoned byte,
100// or -1 if the whole range is good.
101SANITIZER_INTERFACE_ATTRIBUTE
102sptr __msan_test_shadow(const void *x, uptr size);
103
104SANITIZER_INTERFACE_ATTRIBUTE
105void __msan_check_mem_is_initialized(const void *x, uptr size);
106
107SANITIZER_INTERFACE_ATTRIBUTE
108void __msan_set_origin(const void *a, uptr size, u32 origin);
109SANITIZER_INTERFACE_ATTRIBUTE
110void __msan_set_alloca_origin(void *a, uptr size, char *descr);
111SANITIZER_INTERFACE_ATTRIBUTE
112void __msan_set_alloca_origin4(void *a, uptr size, char *descr, uptr pc);
113SANITIZER_INTERFACE_ATTRIBUTE
114void __msan_set_alloca_origin_with_descr(void *a, uptr size, u32 *id_ptr,
115 char *descr);
116SANITIZER_INTERFACE_ATTRIBUTE
117void __msan_set_alloca_origin_no_descr(void *a, uptr size, u32 *id_ptr);
118SANITIZER_INTERFACE_ATTRIBUTE
119u32 __msan_chain_origin(u32 id);
120SANITIZER_INTERFACE_ATTRIBUTE
121u32 __msan_get_origin(const void *a);
122
123// Test that this_id is a descendant of prev_id (or they are simply equal).
124// "descendant" here means that are part of the same chain, created with
125// __msan_chain_origin.
126SANITIZER_INTERFACE_ATTRIBUTE
127int __msan_origin_is_descendant_or_same(u32 this_id, u32 prev_id);
128
129
130SANITIZER_INTERFACE_ATTRIBUTE
131void __msan_clear_on_return();
132
133SANITIZER_INTERFACE_ATTRIBUTE
134void __msan_set_keep_going(int keep_going);
135
136SANITIZER_INTERFACE_ATTRIBUTE
137int __msan_set_poison_in_malloc(int do_poison);
138
139SANITIZER_INTERFACE_ATTRIBUTE
140const char *__msan_default_options();
141
142// For testing.
143SANITIZER_INTERFACE_ATTRIBUTE
144void __msan_set_expect_umr(int expect_umr);
145SANITIZER_INTERFACE_ATTRIBUTE
146void __msan_print_shadow(const void *x, uptr size);
147SANITIZER_INTERFACE_ATTRIBUTE
148void __msan_dump_shadow(const void *x, uptr size);
149SANITIZER_INTERFACE_ATTRIBUTE
150int __msan_has_dynamic_component();
151
152// For testing.
153SANITIZER_INTERFACE_ATTRIBUTE
154u32 __msan_get_umr_origin();
155SANITIZER_INTERFACE_ATTRIBUTE
156void __msan_partial_poison(const void* data, void* shadow, uptr size);
157
158// Tell MSan about newly allocated memory (ex.: custom allocator).
159// Memory will be marked uninitialized, with origin at the call site.
160SANITIZER_INTERFACE_ATTRIBUTE
161void __msan_allocated_memory(const void* data, uptr size);
162
163// Tell MSan about newly destroyed memory. Memory will be marked
164// uninitialized.
165SANITIZER_INTERFACE_ATTRIBUTE
166void __sanitizer_dtor_callback(const void* data, uptr size);
167SANITIZER_INTERFACE_ATTRIBUTE
168void __sanitizer_dtor_callback_fields(const void *data, uptr size);
169SANITIZER_INTERFACE_ATTRIBUTE
170void __sanitizer_dtor_callback_vptr(const void *data);
171
172SANITIZER_INTERFACE_ATTRIBUTE
173u16 __sanitizer_unaligned_load16(const uu16 *p);
174
175SANITIZER_INTERFACE_ATTRIBUTE
176u32 __sanitizer_unaligned_load32(const uu32 *p);
177
178SANITIZER_INTERFACE_ATTRIBUTE
179u64 __sanitizer_unaligned_load64(const uu64 *p);
180
181SANITIZER_INTERFACE_ATTRIBUTE
182void __sanitizer_unaligned_store16(uu16 *p, u16 x);
183
184SANITIZER_INTERFACE_ATTRIBUTE
185void __sanitizer_unaligned_store32(uu32 *p, u32 x);
186
187SANITIZER_INTERFACE_ATTRIBUTE
188void __sanitizer_unaligned_store64(uu64 *p, u64 x);
189
190SANITIZER_INTERFACE_ATTRIBUTE
191void __msan_set_death_callback(void (*callback)(void));
192
193SANITIZER_INTERFACE_ATTRIBUTE
194void __msan_copy_shadow(void *dst, const void *src, uptr size);
195
196SANITIZER_INTERFACE_ATTRIBUTE
197void __msan_scoped_disable_interceptor_checks();
198
199SANITIZER_INTERFACE_ATTRIBUTE
200void __msan_scoped_enable_interceptor_checks();
201
202SANITIZER_INTERFACE_ATTRIBUTE
203void __msan_start_switch_fiber(const void *bottom, uptr size);
204
205SANITIZER_INTERFACE_ATTRIBUTE
206void __msan_finish_switch_fiber(const void **bottom_old, uptr *size_old);
207} // extern "C"
208
209#endif // MSAN_INTERFACE_INTERNAL_H
210