folly/detail/CacheLocality.cpp

   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 #include <folly/detail/CacheLocality.h>
  18
  19 #ifndef _MSC_VER
  20 #define _GNU_SOURCE 1 // for RTLD_NOLOAD
  21 #include <dlfcn.h>
  22 #endif
  23 #include <fstream>
  24
  25 #include <folly/Conv.h>
  26 #include <folly/Exception.h>
  27 #include <folly/FileUtil.h>
  28 #include <folly/Format.h>
  29 #include <folly/ScopeGuard.h>
  30
  31 namespace folly {
  32 namespace detail {
  33
  34 ///////////// CacheLocality
  35
  36 /// Returns the best real CacheLocality information available
  37 static CacheLocality getSystemLocalityInfo() {
  38 #ifdef __linux__
  39   try {
  40     return CacheLocality::readFromSysfs();
  41   } catch (...) {
  42     // keep trying
  43   }
  44 #endif
  45
  46   long numCpus = sysconf(_SC_NPROCESSORS_CONF);
  47   if (numCpus <= 0) {
  48     // This shouldn't happen, but if it does we should try to keep
  49     // going.  We are probably not going to be able to parse /sys on
  50     // this box either (although we will try), which means we are going
  51     // to fall back to the SequentialThreadId splitter.  On my 16 core
  52     // (x hyperthreading) dev box 16 stripes is enough to get pretty good
  53     // contention avoidance with SequentialThreadId, and there is little
  54     // improvement from going from 32 to 64.  This default gives us some
  55     // wiggle room
  56     numCpus = 32;
  57   }
  58   return CacheLocality::uniform(numCpus);
  59 }
  60
  61 template <>
  62 const CacheLocality& CacheLocality::system<std::atomic>() {
  63   static auto* cache = new CacheLocality(getSystemLocalityInfo());
  64   return *cache;
  65 }
  66
  67 // Each level of cache has sharing sets, which are the set of cpus
  68 // that share a common cache at that level.  These are available in a
  69 // hex bitset form (/sys/devices/system/cpu/cpu0/index0/shared_cpu_map,
  70 // for example).  They are also available in a human-readable list form,
  71 // as in /sys/devices/system/cpu/cpu0/index0/shared_cpu_list.  The list
  72 // is a comma-separated list of numbers and ranges, where the ranges are
  73 // a pair of decimal numbers separated by a '-'.
  74 //
  75 // To sort the cpus for optimum locality we don't really need to parse
  76 // the sharing sets, we just need a unique representative from the
  77 // equivalence class.  The smallest value works fine, and happens to be
  78 // the first decimal number in the file.  We load all of the equivalence
  79 // class information from all of the cpu*/index* directories, order the
  80 // cpus first by increasing last-level cache equivalence class, then by
  81 // the smaller caches.  Finally, we break ties with the cpu number itself.
  82
  83 /// Returns the first decimal number in the string, or throws an exception
  84 /// if the string does not start with a number terminated by ',', '-',
  85 /// '\n', or eos.
  86 static size_t parseLeadingNumber(const std::string& line) {
  87   auto raw = line.c_str();
  88   char* end;
  89   unsigned long val = strtoul(raw, &end, 10);
  90   if (end == raw || (*end != ',' && *end != '-' && *end != '\n' && *end != 0)) {
  91     throw std::runtime_error(
  92         to<std::string>("error parsing list '", line, "'").c_str());
  93   }
  94   return val;
  95 }
  96
  97 CacheLocality CacheLocality::readFromSysfsTree(
  98     const std::function<std::string(std::string)>& mapping) {
  99   // number of equivalence classes per level
 100   std::vector<size_t> numCachesByLevel;
 101
 102   // the list of cache equivalence classes, where equivalance classes
 103   // are named by the smallest cpu in the class
 104   std::vector<std::vector<size_t>> equivClassesByCpu;
 105
 106   std::vector<size_t> cpus;
 107
 108   while (true) {
 109     auto cpu = cpus.size();
 110     std::vector<size_t> levels;
 111     for (size_t index = 0;; ++index) {
 112       auto dir =
 113           sformat("/sys/devices/system/cpu/cpu{}/cache/index{}/", cpu, index);
 114       auto cacheType = mapping(dir + "type");
 115       auto equivStr = mapping(dir + "shared_cpu_list");
 116       if (cacheType.size() == 0 || equivStr.size() == 0) {
 117         // no more caches
 118         break;
 119       }
 120       if (cacheType[0] == 'I') {
 121         // cacheType in { "Data", "Instruction", "Unified" }. skip icache
 122         continue;
 123       }
 124       auto equiv = parseLeadingNumber(equivStr);
 125       auto level = levels.size();
 126       levels.push_back(equiv);
 127
 128       if (equiv == cpu) {
 129         // we only want to count the equiv classes once, so we do it when
 130         // we first encounter them
 131         while (numCachesByLevel.size() <= level) {
 132           numCachesByLevel.push_back(0);
 133         }
 134         numCachesByLevel[level]++;
 135       }
 136     }
 137
 138     if (levels.size() == 0) {
 139       // no levels at all for this cpu, we must be done
 140       break;
 141     }
 142     equivClassesByCpu.emplace_back(std::move(levels));
 143     cpus.push_back(cpu);
 144   }
 145
 146   if (cpus.size() == 0) {
 147     throw std::runtime_error("unable to load cache sharing info");
 148   }
 149
 150   std::sort(cpus.begin(),
 151             cpus.end(),
 152             [&](size_t lhs, size_t rhs) -> bool {
 153               // sort first by equiv class of cache with highest index,
 154               // direction doesn't matter.  If different cpus have
 155               // different numbers of caches then this code might produce
 156               // a sub-optimal ordering, but it won't crash
 157               auto& lhsEquiv = equivClassesByCpu[lhs];
 158               auto& rhsEquiv = equivClassesByCpu[rhs];
 159               for (int i = int(std::min(lhsEquiv.size(), rhsEquiv.size())) - 1;
 160                    i >= 0;
 161                    --i) {
 162                 if (lhsEquiv[i] != rhsEquiv[i]) {
 163                   return lhsEquiv[i] < rhsEquiv[i];
 164                 }
 165               }
 166
 167               // break ties deterministically by cpu
 168               return lhs < rhs;
 169             });
 170
 171   // the cpus are now sorted by locality, with neighboring entries closer
 172   // to each other than entries that are far away.  For striping we want
 173   // the inverse map, since we are starting with the cpu
 174   std::vector<size_t> indexes(cpus.size());
 175   for (size_t i = 0; i < cpus.size(); ++i) {
 176     indexes[cpus[i]] = i;
 177   }
 178
 179   return CacheLocality{
 180       cpus.size(), std::move(numCachesByLevel), std::move(indexes)};
 181 }
 182
 183 CacheLocality CacheLocality::readFromSysfs() {
 184   return readFromSysfsTree([](std::string name) {
 185     std::ifstream xi(name.c_str());
 186     std::string rv;
 187     std::getline(xi, rv);
 188     return rv;
 189   });
 190 }
 191
 192 CacheLocality CacheLocality::uniform(size_t numCpus) {
 193   CacheLocality rv;
 194
 195   rv.numCpus = numCpus;
 196
 197   // one cache shared by all cpus
 198   rv.numCachesByLevel.push_back(numCpus);
 199
 200   // no permutations in locality index mapping
 201   for (size_t cpu = 0; cpu < numCpus; ++cpu) {
 202     rv.localityIndexByCpu.push_back(cpu);
 203   }
 204
 205   return rv;
 206 }
 207
 208 ////////////// Getcpu
 209
 210 Getcpu::Func Getcpu::resolveVdsoFunc() {
 211 #if !FOLLY_HAVE_LINUX_VDSO
 212   return nullptr;
 213 #else
 214   void* h = dlopen("linux-vdso.so.1", RTLD_LAZY | RTLD_LOCAL | RTLD_NOLOAD);
 215   if (h == nullptr) {
 216     return nullptr;
 217   }
 218
 219   auto func = Getcpu::Func(dlsym(h, "__vdso_getcpu"));
 220   if (func == nullptr) {
 221     // technically a null result could either be a failure or a successful
 222     // lookup of a symbol with the null value, but the second can't actually
 223     // happen for this symbol.  No point holding the handle forever if
 224     // we don't need the code
 225     dlclose(h);
 226   }
 227
 228   return func;
 229 #endif
 230 }
 231
 232 #ifdef FOLLY_TLS
 233 /////////////// SequentialThreadId
 234 template struct SequentialThreadId<std::atomic>;
 235 #endif
 236
 237 /////////////// AccessSpreader
 238 template struct AccessSpreader<std::atomic>;
 239
 240 } // namespace detail
 241 } // namespace folly