1 //===-- sanitizer_procmaps.h ------------------------------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file is shared between AddressSanitizer and ThreadSanitizer.
11 //
12 // Information about the process mappings.
13 //===----------------------------------------------------------------------===//
14 #ifndef SANITIZER_PROCMAPS_H
15 #define SANITIZER_PROCMAPS_H
16 
17 #include "sanitizer_common.h"
18 #include "sanitizer_internal_defs.h"
19 #include "sanitizer_mutex.h"
20 
21 namespace __sanitizer {
22 
23 #if SANITIZER_FREEBSD || SANITIZER_LINUX
24 struct ProcSelfMapsBuff {
25   char *data;
26   uptr mmaped_size;
27   uptr len;
28 };
29 
30 // Reads process memory map in an OS-specific way.
31 void ReadProcMaps(ProcSelfMapsBuff *proc_maps);
32 #endif  // SANITIZER_FREEBSD || SANITIZER_LINUX
33 
34 class MemoryMappingLayout {
35  public:
36   explicit MemoryMappingLayout(bool cache_enabled);
37   ~MemoryMappingLayout();
38   bool Next(uptr *start, uptr *end, uptr *offset,
39             char filename[], uptr filename_size, uptr *protection);
40   void Reset();
41   // In some cases, e.g. when running under a sandbox on Linux, ASan is unable
42   // to obtain the memory mappings. It should fall back to pre-cached data
43   // instead of aborting.
44   static void CacheMemoryMappings();
45 
46   // Stores the list of mapped objects into an array.
47   uptr DumpListOfModules(LoadedModule *modules, uptr max_modules,
48                          string_predicate_t filter);
49 
50   // Memory protection masks.
51   static const uptr kProtectionRead = 1;
52   static const uptr kProtectionWrite = 2;
53   static const uptr kProtectionExecute = 4;
54   static const uptr kProtectionShared = 8;
55 
56  private:
57   void LoadFromCache();
58 
59   // FIXME: Hide implementation details for different platforms in
60   // platform-specific files.
61 # if SANITIZER_FREEBSD || SANITIZER_LINUX
62   ProcSelfMapsBuff proc_self_maps_;
63   const char *current_;
64 
65   // Static mappings cache.
66   static ProcSelfMapsBuff cached_proc_self_maps_;
67   static StaticSpinMutex cache_lock_;  // protects cached_proc_self_maps_.
68 # elif SANITIZER_MAC
69   template<u32 kLCSegment, typename SegmentCommand>
70   bool NextSegmentLoad(uptr *start, uptr *end, uptr *offset,
71                        char filename[], uptr filename_size,
72                        uptr *protection);
73   int current_image_;
74   u32 current_magic_;
75   u32 current_filetype_;
76   int current_load_cmd_count_;
77   char *current_load_cmd_addr_;
78 # endif
79 };
80 
81 typedef void (*fill_profile_f)(uptr start, uptr rss, bool file,
82                                /*out*/uptr *stats, uptr stats_size);
83 
84 // Parse the contents of /proc/self/smaps and generate a memory profile.
85 // |cb| is a tool-specific callback that fills the |stats| array containing
86 // |stats_size| elements.
87 void GetMemoryProfile(fill_profile_f cb, uptr *stats, uptr stats_size);
88 
89 // Returns code range for the specified module.
90 bool GetCodeRangeForFile(const char *module, uptr *start, uptr *end);
91 
92 bool IsDecimal(char c);
93 uptr ParseDecimal(const char **p);
94 bool IsHex(char c);
95 uptr ParseHex(const char **p);
96 
97 }  // namespace __sanitizer
98 
99 #endif  // SANITIZER_PROCMAPS_H
100