1//===-- memprof_mapping.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 MemProfiler, a memory profiler.
10//
11// Defines MemProf memory mapping.
12//===----------------------------------------------------------------------===//
13#ifndef MEMPROF_MAPPING_H
14#define MEMPROF_MAPPING_H
15
16#include "memprof_internal.h"
17
18static const u64 kDefaultShadowScale = 3;
19#define SHADOW_SCALE kDefaultShadowScale
20
21#define SHADOW_OFFSET __memprof_shadow_memory_dynamic_address
22
23#define SHADOW_GRANULARITY (1ULL << SHADOW_SCALE)
24#define MEMPROF_ALIGNMENT 32
25
26namespace __memprof {
27
28extern uptr kHighMemEnd; // Initialized in __memprof_init.
29
30} // namespace __memprof
31
32// Size of memory block mapped to a single shadow location
33#define MEM_GRANULARITY 64ULL
34
35#define SHADOW_MASK ~(MEM_GRANULARITY - 1)
36
37#define MEM_TO_SHADOW(mem) \
38 ((((mem) & SHADOW_MASK) >> SHADOW_SCALE) + (SHADOW_OFFSET))
39
40#define SHADOW_ENTRY_SIZE (MEM_GRANULARITY >> SHADOW_SCALE)
41
42#define kLowMemBeg 0
43#define kLowMemEnd (SHADOW_OFFSET ? SHADOW_OFFSET - 1 : 0)
44
45#define kLowShadowBeg SHADOW_OFFSET
46#define kLowShadowEnd (MEM_TO_SHADOW(kLowMemEnd) + SHADOW_ENTRY_SIZE - 1)
47
48#define kHighMemBeg (MEM_TO_SHADOW(kHighMemEnd) + 1 + SHADOW_ENTRY_SIZE - 1)
49
50#define kHighShadowBeg MEM_TO_SHADOW(kHighMemBeg)
51#define kHighShadowEnd (MEM_TO_SHADOW(kHighMemEnd) + SHADOW_ENTRY_SIZE - 1)
52
53// With the zero shadow base we can not actually map pages starting from 0.
54// This constant is somewhat arbitrary.
55#define kZeroBaseShadowStart 0
56#define kZeroBaseMaxShadowStart (1 << 18)
57
58#define kShadowGapBeg (kLowShadowEnd ? kLowShadowEnd + 1 : kZeroBaseShadowStart)
59#define kShadowGapEnd (kHighShadowBeg - 1)
60
61namespace __memprof {
62
63inline uptr MemToShadowSize(uptr size) { return size >> SHADOW_SCALE; }
64inline bool AddrIsInLowMem(uptr a) { return a <= kLowMemEnd; }
65
66inline bool AddrIsInLowShadow(uptr a) {
67 return a >= kLowShadowBeg && a <= kLowShadowEnd;
68}
69
70inline bool AddrIsInHighMem(uptr a) {
71 return kHighMemBeg && a >= kHighMemBeg && a <= kHighMemEnd;
72}
73
74inline bool AddrIsInHighShadow(uptr a) {
75 return kHighMemBeg && a >= kHighShadowBeg && a <= kHighShadowEnd;
76}
77
78inline bool AddrIsInShadowGap(uptr a) {
79 // In zero-based shadow mode we treat addresses near zero as addresses
80 // in shadow gap as well.
81 if (SHADOW_OFFSET == 0)
82 return a <= kShadowGapEnd;
83 return a >= kShadowGapBeg && a <= kShadowGapEnd;
84}
85
86inline bool AddrIsInMem(uptr a) {
87 return AddrIsInLowMem(a) || AddrIsInHighMem(a) ||
88 (flags()->protect_shadow_gap == 0 && AddrIsInShadowGap(a));
89}
90
91inline uptr MemToShadow(uptr p) {
92 CHECK(AddrIsInMem(p));
93 return MEM_TO_SHADOW(p);
94}
95
96inline bool AddrIsInShadow(uptr a) {
97 return AddrIsInLowShadow(a) || AddrIsInHighShadow(a);
98}
99
100inline bool AddrIsAlignedByGranularity(uptr a) {
101 return (a & (SHADOW_GRANULARITY - 1)) == 0;
102}
103
104inline void RecordAccess(uptr a) {
105 // If we use a different shadow size then the type below needs adjustment.
106 CHECK_EQ(SHADOW_ENTRY_SIZE, 8);
107 u64 *shadow_address = (u64 *)MEM_TO_SHADOW(a);
108 (*shadow_address)++;
109}
110
111} // namespace __memprof
112
113#endif // MEMPROF_MAPPING_H
114

source code of compiler-rt/lib/memprof/memprof_mapping.h