folly/Malloc.h

   1 /*
   2  * Copyright 2015 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 // Functions to provide smarter use of jemalloc, if jemalloc is being used.
  18 // http://www.canonware.com/download/jemalloc/jemalloc-latest/doc/jemalloc.html
  19
  20 #ifndef FOLLY_MALLOC_H_
  21 #define FOLLY_MALLOC_H_
  22
  23 /**
  24  * Define various MALLOCX_* macros normally provided by jemalloc.  We define
  25  * them so that we don't have to include jemalloc.h, in case the program is
  26  * built without jemalloc support.
  27  */
  28 #ifndef MALLOCX_LG_ALIGN
  29 #define MALLOCX_LG_ALIGN(la) (la)
  30 #endif
  31 #ifndef MALLOCX_ZERO
  32 #define MALLOCX_ZERO (static_cast<int>(0x40))
  33 #endif
  34
  35 // If using fbstring from libstdc++ (see comment in FBString.h), then
  36 // just define stub code here to typedef the fbstring type into the
  37 // folly namespace.
  38 // This provides backwards compatibility for code that explicitly
  39 // includes and uses fbstring.
  40 #if defined(_GLIBCXX_USE_FB) && !defined(_LIBSTDCXX_FBSTRING)
  41
  42 #include <folly/detail/Malloc.h>
  43
  44 #include <string>
  45
  46 namespace folly {
  47   using std::goodMallocSize;
  48   using std::jemallocMinInPlaceExpandable;
  49   using std::usingJEMalloc;
  50   using std::smartRealloc;
  51   using std::checkedMalloc;
  52   using std::checkedCalloc;
  53   using std::checkedRealloc;
  54 }
  55
  56 #else // !defined(_GLIBCXX_USE_FB) || defined(_LIBSTDCXX_FBSTRING)
  57
  58 #ifdef _LIBSTDCXX_FBSTRING
  59 #pragma GCC system_header
  60
  61 /**
  62  * Declare *allocx() and mallctl*() as weak symbols. These will be provided by
  63  * jemalloc if we are using jemalloc, or will be NULL if we are using another
  64  * malloc implementation.
  65  */
  66 extern "C" void* mallocx(size_t, int)
  67 __attribute__((__weak__));
  68 extern "C" void* rallocx(void*, size_t, int)
  69 __attribute__((__weak__));
  70 extern "C" size_t xallocx(void*, size_t, size_t, int)
  71 __attribute__((__weak__));
  72 extern "C" size_t sallocx(const void*, int)
  73 __attribute__((__weak__));
  74 extern "C" void dallocx(void*, int)
  75 __attribute__((__weak__));
  76 extern "C" void sdallocx(void*, size_t, int)
  77 __attribute__((__weak__));
  78 extern "C" size_t nallocx(size_t, int)
  79 __attribute__((__weak__));
  80 extern "C" int mallctl(const char*, void*, size_t*, void*, size_t)
  81 __attribute__((__weak__));
  82 extern "C" int mallctlnametomib(const char*, size_t*, size_t*)
  83 __attribute__((__weak__));
  84 extern "C" int mallctlbymib(const size_t*, size_t, void*, size_t*, void*,
  85                             size_t)
  86 __attribute__((__weak__));
  87
  88 #include <bits/functexcept.h>
  89 #define FOLLY_HAVE_MALLOC_H 1
  90 #else
  91 #include <folly/detail/Malloc.h> /* nolint */
  92 #endif
  93
  94 // for malloc_usable_size
  95 // NOTE: FreeBSD 9 doesn't have malloc.h.  It's defitions
  96 // are found in stdlib.h.
  97 #if FOLLY_HAVE_MALLOC_H
  98 #include <malloc.h>
  99 #else
 100 #include <stdlib.h>
 101 #endif
 102
 103 #include <cassert>
 104 #include <cstddef>
 105 #include <cstdint>
 106 #include <cstdlib>
 107 #include <cstring>
 108
 109 #include <new>
 110
 111 #ifdef _LIBSTDCXX_FBSTRING
 112 namespace std _GLIBCXX_VISIBILITY(default) {
 113 _GLIBCXX_BEGIN_NAMESPACE_VERSION
 114 #else
 115 namespace folly {
 116 #endif
 117
 118 // Cannot depend on Portability.h when _LIBSTDCXX_FBSTRING.
 119 #ifdef __GNUC__
 120 #define FOLLY_MALLOC_NOINLINE __attribute__((__noinline__))
 121 #else
 122 #define FOLLY_MALLOC_NOINLINE
 123 #endif
 124
 125 /**
 126  * Determine if we are using jemalloc or not.
 127  */
 128 inline bool usingJEMalloc() noexcept {
 129   // Checking for rallocx != NULL is not sufficient; we may be in a dlopen()ed
 130   // module that depends on libjemalloc, so rallocx is resolved, but the main
 131   // program might be using a different memory allocator.
 132   // How do we determine that we're using jemalloc? In the hackiest
 133   // way possible. We allocate memory using malloc() and see if the
 134   // per-thread counter of allocated memory increases. This makes me
 135   // feel dirty inside. Also note that this requires jemalloc to have
 136   // been compiled with --enable-stats.
 137   static const bool result = [] () FOLLY_MALLOC_NOINLINE noexcept {
 138     // Some platforms (*cough* OSX *cough*) require weak symbol checks to be
 139     // in the form if (mallctl != nullptr). Not if (mallctl) or if (!mallctl)
 140     // (!!). http://goo.gl/xpmctm
 141     if (mallocx == nullptr || rallocx == nullptr || xallocx == nullptr
 142         || sallocx == nullptr || dallocx == nullptr || sdallocx == nullptr
 143         || nallocx == nullptr || mallctl == nullptr
 144         || mallctlnametomib == nullptr || mallctlbymib == nullptr) {
 145       return false;
 146     }
 147
 148     // "volatile" because gcc optimizes out the reads from *counter, because
 149     // it "knows" malloc doesn't modify global state...
 150     /* nolint */ volatile uint64_t* counter;
 151     size_t counterLen = sizeof(uint64_t*);
 152
 153     if (mallctl("thread.allocatedp", static_cast<void*>(&counter), &counterLen,
 154                 nullptr, 0) != 0) {
 155       return false;
 156     }
 157
 158     if (counterLen != sizeof(uint64_t*)) {
 159       return false;
 160     }
 161
 162     uint64_t origAllocated = *counter;
 163
 164     // Static because otherwise clever compilers will find out that
 165     // the ptr is not used and does not escape the scope, so they will
 166     // just optimize away the malloc.
 167     static void* ptr = malloc(1);
 168     if (!ptr) {
 169       // wtf, failing to allocate 1 byte
 170       return false;
 171     }
 172
 173     return (origAllocated != *counter);
 174   }();
 175
 176   return result;
 177 }
 178
 179 inline size_t goodMallocSize(size_t minSize) noexcept {
 180   if (minSize == 0) {
 181     return 0;
 182   }
 183
 184   if (!usingJEMalloc()) {
 185     // Not using jemalloc - no smarts
 186     return minSize;
 187   }
 188
 189   return nallocx(minSize, 0);
 190 }
 191
 192 // We always request "good" sizes for allocation, so jemalloc can
 193 // never grow in place small blocks; they're already occupied to the
 194 // brim.  Blocks larger than or equal to 4096 bytes can in fact be
 195 // expanded in place, and this constant reflects that.
 196 static const size_t jemallocMinInPlaceExpandable = 4096;
 197
 198 /**
 199  * Trivial wrappers around malloc, calloc, realloc that check for allocation
 200  * failure and throw std::bad_alloc in that case.
 201  */
 202 inline void* checkedMalloc(size_t size) {
 203   void* p = malloc(size);
 204   if (!p) std::__throw_bad_alloc();
 205   return p;
 206 }
 207
 208 inline void* checkedCalloc(size_t n, size_t size) {
 209   void* p = calloc(n, size);
 210   if (!p) std::__throw_bad_alloc();
 211   return p;
 212 }
 213
 214 inline void* checkedRealloc(void* ptr, size_t size) {
 215   void* p = realloc(ptr, size);
 216   if (!p) std::__throw_bad_alloc();
 217   return p;
 218 }
 219
 220 /**
 221  * This function tries to reallocate a buffer of which only the first
 222  * currentSize bytes are used. The problem with using realloc is that
 223  * if currentSize is relatively small _and_ if realloc decides it
 224  * needs to move the memory chunk to a new buffer, then realloc ends
 225  * up copying data that is not used. It's impossible to hook into
 226  * GNU's malloc to figure whether expansion will occur in-place or as
 227  * a malloc-copy-free troika. (If an expand_in_place primitive would
 228  * be available, smartRealloc would use it.) As things stand, this
 229  * routine just tries to call realloc() (thus benefitting of potential
 230  * copy-free coalescing) unless there's too much slack memory.
 231  */
 232 inline void* smartRealloc(void* p,
 233                           const size_t currentSize,
 234                           const size_t currentCapacity,
 235                           const size_t newCapacity) {
 236   assert(p);
 237   assert(currentSize <= currentCapacity &&
 238          currentCapacity < newCapacity);
 239
 240   if (usingJEMalloc()) {
 241     // using jemalloc's API. Don't forget that jemalloc can never grow
 242     // in place blocks smaller than 4096 bytes.
 243     //
 244     // NB: newCapacity may not be precisely equal to a jemalloc size class,
 245     // i.e. newCapacity is not guaranteed to be the result of a
 246     // goodMallocSize() call, therefore xallocx() may return more than
 247     // newCapacity bytes of space.  Use >= rather than == to check whether
 248     // xallocx() successfully expanded in place.
 249     if (currentCapacity >= jemallocMinInPlaceExpandable &&
 250         xallocx(p, newCapacity, 0, 0) >= newCapacity) {
 251       // Managed to expand in place
 252       return p;
 253     }
 254     // Cannot expand; must move
 255     auto const result = checkedMalloc(newCapacity);
 256     std::memcpy(result, p, currentSize);
 257     free(p);
 258     return result;
 259   }
 260
 261   // No jemalloc no honey
 262   auto const slack = currentCapacity - currentSize;
 263   if (slack * 2 > currentSize) {
 264     // Too much slack, malloc-copy-free cycle:
 265     auto const result = checkedMalloc(newCapacity);
 266     std::memcpy(result, p, currentSize);
 267     free(p);
 268     return result;
 269   }
 270   // If there's not too much slack, we realloc in hope of coalescing
 271   return checkedRealloc(p, newCapacity);
 272 }
 273
 274 #ifdef _LIBSTDCXX_FBSTRING
 275 _GLIBCXX_END_NAMESPACE_VERSION
 276 #endif
 277
 278 } // folly
 279
 280 #endif // !defined(_GLIBCXX_USE_FB) || defined(_LIBSTDCXX_FBSTRING)
 281
 282 #endif // FOLLY_MALLOC_H_