contrib/compiler-rt/lib/sanitizer_common/sanitizer_procmaps.h

   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, char filename[],
  39             uptr filename_size, uptr *protection, ModuleArch *arch = nullptr,
  40             u8 *uuid = nullptr);
  41   void Reset();
  42   // In some cases, e.g. when running under a sandbox on Linux, ASan is unable
  43   // to obtain the memory mappings. It should fall back to pre-cached data
  44   // instead of aborting.
  45   static void CacheMemoryMappings();
  46
  47   // Adds all mapped objects into a vector.
  48   void DumpListOfModules(InternalMmapVector<LoadedModule> *modules);
  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, char filename[],
  71                        uptr filename_size, ModuleArch *arch, u8 *uuid,
  72                        uptr *protection);
  73   void GetSegmentAddrRange(uptr *start, uptr *end, uptr vmaddr, uptr vmsize);
  74   int current_image_;
  75   u32 current_magic_;
  76   u32 current_filetype_;
  77   ModuleArch current_arch_;
  78   u8 current_uuid_[kModuleUUIDSize];
  79   int current_load_cmd_count_;
  80   char *current_load_cmd_addr_;
  81   bool current_instrumented_;
  82 # endif
  83 };
  84
  85 typedef void (*fill_profile_f)(uptr start, uptr rss, bool file,
  86                                /*out*/uptr *stats, uptr stats_size);
  87
  88 // Parse the contents of /proc/self/smaps and generate a memory profile.
  89 // |cb| is a tool-specific callback that fills the |stats| array containing
  90 // |stats_size| elements.
  91 void GetMemoryProfile(fill_profile_f cb, uptr *stats, uptr stats_size);
  92
  93 // Returns code range for the specified module.
  94 bool GetCodeRangeForFile(const char *module, uptr *start, uptr *end);
  95
  96 bool IsDecimal(char c);
  97 uptr ParseDecimal(const char **p);
  98 bool IsHex(char c);
  99 uptr ParseHex(const char **p);
 100
 101 }  // namespace __sanitizer
 102
 103 #endif  // SANITIZER_PROCMAPS_H