folly/Malloc.h

   1 /*
   2  * Copyright 2012 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 // If using fbstring from libstdc++, then just define stub code
  24 // here to typedef the fbstring type into the folly namespace.
  25 // This provides backwards compatibility for code that explicitly
  26 // includes and uses fbstring.
  27 #if defined(_GLIBCXX_USE_FB) && !defined(_LIBSTDCXX_FBSTRING)
  28
  29 #include <string>
  30 namespace folly {
  31   using std::goodMallocSize;
  32   using std::jemallocMinInPlaceExpandable;
  33   using std::usingJEMalloc;
  34   using std::smartRealloc;
  35   using std::checkedMalloc;
  36   using std::checkedCalloc;
  37   using std::checkedRealloc;
  38 }
  39
  40 #else // !defined(_GLIBCXX_USE_FB) || defined(_LIBSTDCXX_FBSTRING)
  41
  42 #ifdef _LIBSTDCXX_FBSTRING
  43 #pragma GCC system_header
  44 #define FOLLY_HAVE_MALLOC_H 1
  45 #else
  46 #include "folly-config.h"
  47 #endif
  48
  49 // for malloc_usable_size
  50 // NOTE: FreeBSD 9 doesn't have malloc.h.  It's defitions
  51 // are found in stdlib.h.
  52 #ifdef FOLLY_HAVE_MALLOC_H
  53 #include <malloc.h>
  54 #else
  55 #include <stdlib.h>
  56 #endif
  57
  58 #include <cassert>
  59 #include <cstddef>
  60 #include <cstdlib>
  61 #include <cstring>
  62
  63 #include <new>
  64
  65 /**
  66  * Declare rallocm() and malloc_usable_size() as weak symbols.  It
  67  * will be provided by jemalloc if we are using jemalloc, or it will
  68  * be NULL if we are using another malloc implementation.
  69  */
  70 extern "C" int rallocm(void**, size_t*, size_t, size_t, int)
  71 __attribute__((weak));
  72
  73 /**
  74  * Define the ALLOCM_SUCCESS, ALLOCM_ZERO, and ALLOCM_NO_MOVE constants
  75  * normally provided by jemalloc.  We define them so that we don't have to
  76  * include jemalloc.h, in case the program is built without jemalloc support.
  77  */
  78 #ifndef ALLOCM_SUCCESS
  79 #define ALLOCM_SUCCESS 0
  80 #define ALLOCM_ERR_OOM 1
  81 #define ALLOCM_ERR_NOT_MOVED 2
  82
  83 #define ALLOCM_ZERO    64
  84 #define ALLOCM_NO_MOVE 128
  85 #endif
  86
  87 #ifdef _LIBSTDCXX_FBSTRING
  88 namespace std _GLIBCXX_VISIBILITY(default) {
  89 _GLIBCXX_BEGIN_NAMESPACE_VERSION
  90 #else
  91 namespace folly {
  92 #endif
  93
  94
  95 /**
  96  * Determine if we are using jemalloc or not.
  97  */
  98 inline bool usingJEMalloc() {
  99   return rallocm != NULL;
 100 }
 101
 102 /**
 103  * For jemalloc's size classes, see
 104  * http://www.canonware.com/download/jemalloc/jemalloc-latest/doc/jemalloc.html
 105  */
 106 inline size_t goodMallocSize(size_t minSize) {
 107   if (!usingJEMalloc()) {
 108     // Not using jemalloc - no smarts
 109     return minSize;
 110   }
 111   if (minSize <= 64) {
 112     // Choose smallest allocation to be 64 bytes - no tripping over
 113     // cache line boundaries, and small string optimization takes care
 114     // of short strings anyway.
 115     return 64;
 116   }
 117   if (minSize <= 512) {
 118     // Round up to the next multiple of 64; we don't want to trip over
 119     // cache line boundaries.
 120     return (minSize + 63) & ~size_t(63);
 121   }
 122   if (minSize <= 3840) {
 123     // Round up to the next multiple of 256
 124     return (minSize + 255) & ~size_t(255);
 125   }
 126   if (minSize <= 4072 * 1024) {
 127     // Round up to the next multiple of 4KB
 128     return (minSize + 4095) & ~size_t(4095);
 129   }
 130   // Holy Moly
 131   // Round up to the next multiple of 4MB
 132   return (minSize + 4194303) & ~size_t(4194303);
 133 }
 134
 135 // We always request "good" sizes for allocation, so jemalloc can
 136 // never grow in place small blocks; they're already occupied to the
 137 // brim.  Blocks larger than or equal to 4096 bytes can in fact be
 138 // expanded in place, and this constant reflects that.
 139 static const size_t jemallocMinInPlaceExpandable = 4096;
 140
 141 /**
 142  * Trivial wrappers around malloc, calloc, realloc that check for allocation
 143  * failure and throw std::bad_alloc in that case.
 144  */
 145 inline void* checkedMalloc(size_t size) {
 146   void* p = malloc(size);
 147   if (!p) throw std::bad_alloc();
 148   return p;
 149 }
 150
 151 inline void* checkedCalloc(size_t n, size_t size) {
 152   void* p = calloc(n, size);
 153   if (!p) throw std::bad_alloc();
 154   return p;
 155 }
 156
 157 inline void* checkedRealloc(void* ptr, size_t size) {
 158   void* p = realloc(ptr, size);
 159   if (!p) throw std::bad_alloc();
 160   return p;
 161 }
 162
 163 /**
 164  * This function tries to reallocate a buffer of which only the first
 165  * currentSize bytes are used. The problem with using realloc is that
 166  * if currentSize is relatively small _and_ if realloc decides it
 167  * needs to move the memory chunk to a new buffer, then realloc ends
 168  * up copying data that is not used. It's impossible to hook into
 169  * GNU's malloc to figure whether expansion will occur in-place or as
 170  * a malloc-copy-free troika. (If an expand_in_place primitive would
 171  * be available, smartRealloc would use it.) As things stand, this
 172  * routine just tries to call realloc() (thus benefitting of potential
 173  * copy-free coalescing) unless there's too much slack memory.
 174  */
 175 inline void* smartRealloc(void* p,
 176                           const size_t currentSize,
 177                           const size_t currentCapacity,
 178                           const size_t newCapacity) {
 179   assert(p);
 180   assert(currentSize <= currentCapacity &&
 181          currentCapacity < newCapacity);
 182
 183   if (usingJEMalloc()) {
 184     // using jemalloc's API. Don't forget that jemalloc can never grow
 185     // in place blocks smaller than 4096 bytes.
 186     if (currentCapacity >= jemallocMinInPlaceExpandable &&
 187         rallocm(&p, NULL, newCapacity, 0, ALLOCM_NO_MOVE) == ALLOCM_SUCCESS) {
 188       // Managed to expand in place
 189       return p;
 190     }
 191     // Cannot expand; must move
 192     auto const result = checkedMalloc(newCapacity);
 193     std::memcpy(result, p, currentSize);
 194     free(p);
 195     return result;
 196   }
 197
 198   // No jemalloc no honey
 199   auto const slack = currentCapacity - currentSize;
 200   if (slack * 2 > currentSize) {
 201     // Too much slack, malloc-copy-free cycle:
 202     auto const result = checkedMalloc(newCapacity);
 203     std::memcpy(result, p, currentSize);
 204     free(p);
 205     return result;
 206   }
 207   // If there's not too much slack, we realloc in hope of coalescing
 208   return checkedRealloc(p, newCapacity);
 209 }
 210
 211 #ifdef _LIBSTDCXX_FBSTRING
 212 _GLIBCXX_END_NAMESPACE_VERSION
 213 #endif
 214
 215 } // folly
 216
 217 #endif // !defined(_GLIBCXX_USE_FB) || defined(_LIBSTDCXX_FBSTRING)
 218
 219 #endif // FOLLY_MALLOC_H_