1 //===-- sanitizer_procmaps.h ------------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file is shared between AddressSanitizer and ThreadSanitizer.
12 // Information about the process mappings.
13 //===----------------------------------------------------------------------===//
14 #ifndef SANITIZER_PROCMAPS_H
15 #define SANITIZER_PROCMAPS_H
17 #include "sanitizer_common.h"
18 #include "sanitizer_internal_defs.h"
19 #include "sanitizer_mutex.h"
21 namespace __sanitizer {
23 #if SANITIZER_FREEBSD || SANITIZER_LINUX
24 struct ProcSelfMapsBuff {
30 // Reads process memory map in an OS-specific way.
31 void ReadProcMaps(ProcSelfMapsBuff *proc_maps);
32 #endif // SANITIZER_FREEBSD || SANITIZER_LINUX
34 // Memory protection masks.
35 static const uptr kProtectionRead = 1;
36 static const uptr kProtectionWrite = 2;
37 static const uptr kProtectionExecute = 4;
38 static const uptr kProtectionShared = 8;
40 struct MemoryMappedSegment {
41 MemoryMappedSegment(char *buff = nullptr, uptr size = 0)
42 : filename(buff), filename_size(size) {}
43 ~MemoryMappedSegment() {}
45 bool IsReadable() { return protection & kProtectionRead; }
46 bool IsWritable() { return protection & kProtectionWrite; }
47 bool IsExecutable() { return protection & kProtectionExecute; }
48 bool IsShared() { return protection & kProtectionShared; }
53 char *filename; // owned by caller
57 u8 uuid[kModuleUUIDSize];
60 class MemoryMappingLayout {
62 explicit MemoryMappingLayout(bool cache_enabled);
63 ~MemoryMappingLayout();
64 bool Next(MemoryMappedSegment *segment);
66 // In some cases, e.g. when running under a sandbox on Linux, ASan is unable
67 // to obtain the memory mappings. It should fall back to pre-cached data
68 // instead of aborting.
69 static void CacheMemoryMappings();
71 // Adds all mapped objects into a vector.
72 void DumpListOfModules(InternalMmapVector<LoadedModule> *modules);
77 // FIXME: Hide implementation details for different platforms in
78 // platform-specific files.
79 # if SANITIZER_FREEBSD || SANITIZER_LINUX
80 ProcSelfMapsBuff proc_self_maps_;
83 // Static mappings cache.
84 static ProcSelfMapsBuff cached_proc_self_maps_;
85 static StaticSpinMutex cache_lock_; // protects cached_proc_self_maps_.
87 template <u32 kLCSegment, typename SegmentCommand>
88 bool NextSegmentLoad(MemoryMappedSegment *segment);
91 u32 current_filetype_;
92 ModuleArch current_arch_;
93 u8 current_uuid_[kModuleUUIDSize];
94 int current_load_cmd_count_;
95 char *current_load_cmd_addr_;
96 bool current_instrumented_;
100 typedef void (*fill_profile_f)(uptr start, uptr rss, bool file,
101 /*out*/uptr *stats, uptr stats_size);
103 // Parse the contents of /proc/self/smaps and generate a memory profile.
104 // |cb| is a tool-specific callback that fills the |stats| array containing
105 // |stats_size| elements.
106 void GetMemoryProfile(fill_profile_f cb, uptr *stats, uptr stats_size);
108 // Returns code range for the specified module.
109 bool GetCodeRangeForFile(const char *module, uptr *start, uptr *end);
111 bool IsDecimal(char c);
112 uptr ParseDecimal(const char **p);
114 uptr ParseHex(const char **p);
116 } // namespace __sanitizer
118 #endif // SANITIZER_PROCMAPS_H