xref: /aosp_15_r20/external/compiler-rt/lib/msan/msan_poisoning.h (revision 7c3d14c8b49c529e04be81a3ce6f5cc23712e4c6)
1*7c3d14c8STreehugger Robot //===-- msan_poisoning.h ----------------------------------------*- C++ -*-===//
2*7c3d14c8STreehugger Robot //
3*7c3d14c8STreehugger Robot //                     The LLVM Compiler Infrastructure
4*7c3d14c8STreehugger Robot //
5*7c3d14c8STreehugger Robot // This file is distributed under the University of Illinois Open Source
6*7c3d14c8STreehugger Robot // License. See LICENSE.TXT for details.
7*7c3d14c8STreehugger Robot //
8*7c3d14c8STreehugger Robot //===----------------------------------------------------------------------===//
9*7c3d14c8STreehugger Robot //
10*7c3d14c8STreehugger Robot // This file is a part of MemorySanitizer.
11*7c3d14c8STreehugger Robot //
12*7c3d14c8STreehugger Robot //===----------------------------------------------------------------------===//
13*7c3d14c8STreehugger Robot 
14*7c3d14c8STreehugger Robot #ifndef MSAN_POISONING_H
15*7c3d14c8STreehugger Robot #define MSAN_POISONING_H
16*7c3d14c8STreehugger Robot 
17*7c3d14c8STreehugger Robot #include "msan.h"
18*7c3d14c8STreehugger Robot 
19*7c3d14c8STreehugger Robot namespace __msan {
20*7c3d14c8STreehugger Robot 
21*7c3d14c8STreehugger Robot // Return origin for the first poisoned byte in the memory range, or 0.
22*7c3d14c8STreehugger Robot u32 GetOriginIfPoisoned(uptr addr, uptr size);
23*7c3d14c8STreehugger Robot 
24*7c3d14c8STreehugger Robot // Walk [addr, addr+size) app memory region, copying origin tags from the
25*7c3d14c8STreehugger Robot // corresponding positions in [src_origin, src_origin+size) where the
26*7c3d14c8STreehugger Robot // corresponding shadow in [src_shadow, src_shadow+size) is non-zero.
27*7c3d14c8STreehugger Robot void SetOriginIfPoisoned(uptr addr, uptr src_shadow, uptr size, u32 src_origin);
28*7c3d14c8STreehugger Robot 
29*7c3d14c8STreehugger Robot // Copy origin from src (app address) to dst (app address), creating chained
30*7c3d14c8STreehugger Robot // origin ids as necessary, without overriding origin for fully initialized
31*7c3d14c8STreehugger Robot // quads.
32*7c3d14c8STreehugger Robot void CopyOrigin(const void *dst, const void *src, uptr size, StackTrace *stack);
33*7c3d14c8STreehugger Robot 
34*7c3d14c8STreehugger Robot // memmove() shadow and origin. Dst and src are application addresses.
35*7c3d14c8STreehugger Robot // See CopyOrigin() for the origin copying logic.
36*7c3d14c8STreehugger Robot void MoveShadowAndOrigin(const void *dst, const void *src, uptr size,
37*7c3d14c8STreehugger Robot                          StackTrace *stack);
38*7c3d14c8STreehugger Robot 
39*7c3d14c8STreehugger Robot // memcpy() shadow and origin. Dst and src are application addresses.
40*7c3d14c8STreehugger Robot // See CopyOrigin() for the origin copying logic.
41*7c3d14c8STreehugger Robot void CopyShadowAndOrigin(const void *dst, const void *src, uptr size,
42*7c3d14c8STreehugger Robot                          StackTrace *stack);
43*7c3d14c8STreehugger Robot 
44*7c3d14c8STreehugger Robot // memcpy() app memory, and do "the right thing" to the corresponding shadow and
45*7c3d14c8STreehugger Robot // origin regions.
46*7c3d14c8STreehugger Robot void CopyMemory(void *dst, const void *src, uptr size, StackTrace *stack);
47*7c3d14c8STreehugger Robot 
48*7c3d14c8STreehugger Robot // Fill shadow will value. Ptr is an application address.
49*7c3d14c8STreehugger Robot void SetShadow(const void *ptr, uptr size, u8 value);
50*7c3d14c8STreehugger Robot 
51*7c3d14c8STreehugger Robot // Set origin for the memory region.
52*7c3d14c8STreehugger Robot void SetOrigin(const void *dst, uptr size, u32 origin);
53*7c3d14c8STreehugger Robot 
54*7c3d14c8STreehugger Robot // Mark memory region uninitialized, with origins.
55*7c3d14c8STreehugger Robot void PoisonMemory(const void *dst, uptr size, StackTrace *stack);
56*7c3d14c8STreehugger Robot 
57*7c3d14c8STreehugger Robot }  // namespace __msan
58*7c3d14c8STreehugger Robot 
59*7c3d14c8STreehugger Robot #endif  // MSAN_POISONING_H
60