LLVM 17.0.0git
Go to the documentation of this file.
1//===- ASanStackFrameLayout.h - ComputeASanStackFrameLayout -----*- C++ -*-===//
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
9// This header defines ComputeASanStackFrameLayout and auxiliary data structs.
17namespace llvm {
19class AllocaInst;
21// These magic constants should be the same as in
22// in asan_internal.h from ASan runtime in compiler-rt.
23static const int kAsanStackLeftRedzoneMagic = 0xf1;
24static const int kAsanStackMidRedzoneMagic = 0xf2;
25static const int kAsanStackRightRedzoneMagic = 0xf3;
26static const int kAsanStackUseAfterReturnMagic = 0xf5;
27static const int kAsanStackUseAfterScopeMagic = 0xf8;
29// Input/output data struct for ComputeASanStackFrameLayout.
31 const char *Name; // Name of the variable that will be displayed by asan
32 // if a stack-related bug is reported.
33 uint64_t Size; // Size of the variable in bytes.
34 size_t LifetimeSize; // Size in bytes to use for lifetime analysis check.
35 // Will be rounded up to Granularity.
36 uint64_t Alignment; // Alignment of the variable (power of 2).
37 AllocaInst *AI; // The actual AllocaInst.
38 size_t Offset; // Offset from the beginning of the frame;
39 // set by ComputeASanStackFrameLayout.
40 unsigned Line; // Line number.
43// Output data struct for ComputeASanStackFrameLayout.
45 uint64_t Granularity; // Shadow granularity.
46 uint64_t FrameAlignment; // Alignment for the entire frame.
47 uint64_t FrameSize; // Size of the frame in bytes.
51 // The array of stack variables. The elements may get reordered and changed.
53 // AddressSanitizer's shadow granularity. Usually 8, may also be 16, 32, 64.
54 uint64_t Granularity,
55 // The minimal size of the left-most redzone (header).
56 // At least 4 pointer sizes, power of 2, and >= Granularity.
57 // The resulting FrameSize should be multiple of MinHeaderSize.
58 uint64_t MinHeaderSize);
60// Compute frame description, see DescribeAddressIfStack in ASan runtime.
64// Returns shadow bytes with marked red zones. This shadow represents the state
65// if the stack frame when all local variables are inside of the own scope.
68 const ASanStackFrameLayout &Layout);
70// Returns shadow bytes with marked red zones and after scope. This shadow
71// represents the state if the stack frame when all local variables are outside
72// of the own scope.
74 // The array of stack variables. The elements may get reordered and changed.
76 const ASanStackFrameLayout &Layout);
78} // llvm namespace
This file defines the SmallString class.
This file defines the SmallVector class.
an instruction to allocate memory on the stack
Definition: Instructions.h:58
SmallString - A SmallString is just a SmallVector with methods and accessors that make it work better...
Definition: SmallString.h:26
This class consists of common code factored out of the SmallVector class to reduce code duplication b...
Definition: SmallVector.h:577
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
Definition: SmallVector.h:1200
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
SmallVector< uint8_t, 64 > GetShadowBytesAfterScope(const SmallVectorImpl< ASanStackVariableDescription > &Vars, const ASanStackFrameLayout &Layout)
SmallString< 64 > ComputeASanStackFrameDescription(const SmallVectorImpl< ASanStackVariableDescription > &Vars)
SmallVector< uint8_t, 64 > GetShadowBytes(const SmallVectorImpl< ASanStackVariableDescription > &Vars, const ASanStackFrameLayout &Layout)
static const int kAsanStackUseAfterScopeMagic
ASanStackFrameLayout ComputeASanStackFrameLayout(SmallVectorImpl< ASanStackVariableDescription > &Vars, uint64_t Granularity, uint64_t MinHeaderSize)
static const int kAsanStackLeftRedzoneMagic
static const int kAsanStackUseAfterReturnMagic
static const int kAsanStackRightRedzoneMagic
static const int kAsanStackMidRedzoneMagic