folly/experimental/symbolizer/ElfCache.h

   1 /*
   2  * Copyright 2016 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #pragma once
  18
  19 #include <cstring>
  20 #include <limits.h>  // for PATH_MAX
  21 #include <memory>
  22 #include <mutex>
  23 #include <string>
  24 #include <vector>
  25 #include <unordered_map>
  26
  27 #include <boost/operators.hpp>
  28 #include <boost/container/flat_map.hpp>
  29 #include <boost/intrusive/list.hpp>
  30 #include <glog/logging.h>
  31
  32 #include <folly/Hash.h>
  33 #include <folly/Range.h>
  34 #include <folly/experimental/symbolizer/Elf.h>
  35
  36 namespace folly { namespace symbolizer {
  37
  38 class ElfCacheBase {
  39  public:
  40   virtual std::shared_ptr<ElfFile> getFile(StringPiece path) = 0;
  41   virtual ~ElfCacheBase() { }
  42 };
  43
  44 /**
  45  * Cache ELF files. Async-signal-safe: does memory allocation upfront.
  46  *
  47  * Will not grow; once the capacity is reached, lookups for files that
  48  * aren't already in the cache will fail (return nullptr).
  49  *
  50  * Not MT-safe. May not be used concurrently from multiple threads.
  51  *
  52  * NOTE that async-signal-safety is preserved only as long as the
  53  * SignalSafeElfCache object exists; after the SignalSafeElfCache object
  54  * is destroyed, destroying returned shared_ptr<ElfFile> objects may
  55  * cause ElfFile objects to be destroyed, and that's not async-signal-safe.
  56  */
  57 class SignalSafeElfCache : public ElfCacheBase {
  58  public:
  59   explicit SignalSafeElfCache(size_t capacity);
  60
  61   std::shared_ptr<ElfFile> getFile(StringPiece path) override;
  62
  63  private:
  64   // We can't use std::string (allocating memory is bad!) so we roll our
  65   // own wrapper around a fixed-size, null-terminated string.
  66   class Path : private boost::totally_ordered<Path> {
  67    public:
  68     explicit Path(StringPiece s) {
  69       DCHECK_LE(s.size(), kMaxSize);
  70       memcpy(data_, s.data(), s.size());
  71       data_[s.size()] = '\0';
  72     }
  73
  74     bool operator<(const Path& other) const {
  75       return strcmp(data_, other.data_) < 0;
  76     }
  77
  78     bool operator==(const Path& other) const {
  79       return strcmp(data_, other.data_) == 0;
  80     }
  81
  82     const char* data() const {
  83       return data_;
  84     }
  85
  86     static constexpr size_t kMaxSize = PATH_MAX - 1;
  87
  88    private:
  89     char data_[kMaxSize + 1];
  90   };
  91
  92   boost::container::flat_map<Path, int> map_;
  93   std::vector<std::shared_ptr<ElfFile>> slots_;
  94 };
  95
  96 /**
  97  * General-purpose ELF file cache.
  98  *
  99  * LRU of given capacity. MT-safe (uses locking). Not async-signal-safe.
 100  */
 101 class ElfCache : public ElfCacheBase {
 102  public:
 103   explicit ElfCache(size_t capacity);
 104
 105   std::shared_ptr<ElfFile> getFile(StringPiece path) override;
 106
 107  private:
 108   std::mutex mutex_;
 109
 110   typedef boost::intrusive::list_member_hook<> LruLink;
 111
 112   struct Entry {
 113     std::string path;
 114     ElfFile file;
 115     LruLink lruLink;
 116   };
 117
 118   static std::shared_ptr<ElfFile> filePtr(const std::shared_ptr<Entry>& e);
 119
 120   size_t capacity_;
 121   std::unordered_map<StringPiece, std::shared_ptr<Entry>, Hash> files_;
 122
 123   typedef boost::intrusive::list<
 124       Entry,
 125       boost::intrusive::member_hook<Entry, LruLink, &Entry::lruLink>,
 126       boost::intrusive::constant_time_size<false>> LruList;
 127   LruList lruList_;
 128 };
 129
 130 }}  // namespaces