folly/io/IOBuf.cpp

   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 #define __STDC_LIMIT_MACROS
  18
  19 #include <folly/io/IOBuf.h>
  20
  21 #include <folly/Conv.h>
  22 #include <folly/Likely.h>
  23 #include <folly/Malloc.h>
  24 #include <folly/Memory.h>
  25 #include <folly/ScopeGuard.h>
  26 #include <folly/SpookyHashV2.h>
  27 #include <folly/io/Cursor.h>
  28
  29 #include <stdexcept>
  30 #include <assert.h>
  31 #include <stdint.h>
  32 #include <stdlib.h>
  33
  34 using std::unique_ptr;
  35
  36 namespace {
  37
  38 enum : uint16_t {
  39   kHeapMagic = 0xa5a5,
  40   // This memory segment contains an IOBuf that is still in use
  41   kIOBufInUse = 0x01,
  42   // This memory segment contains buffer data that is still in use
  43   kDataInUse = 0x02,
  44 };
  45
  46 enum : uint64_t {
  47   // When create() is called for buffers less than kDefaultCombinedBufSize,
  48   // we allocate a single combined memory segment for the IOBuf and the data
  49   // together.  See the comments for createCombined()/createSeparate() for more
  50   // details.
  51   //
  52   // (The size of 1k is largely just a guess here.  We could could probably do
  53   // benchmarks of real applications to see if adjusting this number makes a
  54   // difference.  Callers that know their exact use case can also explicitly
  55   // call createCombined() or createSeparate().)
  56   kDefaultCombinedBufSize = 1024
  57 };
  58
  59 // Helper function for IOBuf::takeOwnership()
  60 void takeOwnershipError(bool freeOnError, void* buf,
  61                         folly::IOBuf::FreeFunction freeFn,
  62                         void* userData) {
  63   if (!freeOnError) {
  64     return;
  65   }
  66   if (!freeFn) {
  67     free(buf);
  68     return;
  69   }
  70   try {
  71     freeFn(buf, userData);
  72   } catch (...) {
  73     // The user's free function is not allowed to throw.
  74     // (We are already in the middle of throwing an exception, so
  75     // we cannot let this exception go unhandled.)
  76     abort();
  77   }
  78 }
  79
  80 } // unnamed namespace
  81
  82 namespace folly {
  83
  84 struct IOBuf::HeapPrefix {
  85   HeapPrefix(uint16_t flg)
  86     : magic(kHeapMagic),
  87       flags(flg) {}
  88   ~HeapPrefix() {
  89     // Reset magic to 0 on destruction.  This is solely for debugging purposes
  90     // to help catch bugs where someone tries to use HeapStorage after it has
  91     // been deleted.
  92     magic = 0;
  93   }
  94
  95   uint16_t magic;
  96   std::atomic<uint16_t> flags;
  97 };
  98
  99 struct IOBuf::HeapStorage {
 100   HeapPrefix prefix;
 101   // The IOBuf is last in the HeapStorage object.
 102   // This way operator new will work even if allocating a subclass of IOBuf
 103   // that requires more space.
 104   folly::IOBuf buf;
 105 };
 106
 107 struct IOBuf::HeapFullStorage {
 108   // Make sure jemalloc allocates from the 64-byte class.  Putting this here
 109   // because HeapStorage is private so it can't be at namespace level.
 110   static_assert(sizeof(HeapStorage) <= 64,
 111                 "IOBuf may not grow over 56 bytes!");
 112
 113   HeapStorage hs;
 114   SharedInfo shared;
 115   MaxAlign align;
 116 };
 117
 118 IOBuf::SharedInfo::SharedInfo()
 119   : freeFn(nullptr),
 120     userData(nullptr) {
 121   // Use relaxed memory ordering here.  Since we are creating a new SharedInfo,
 122   // no other threads should be referring to it yet.
 123   refcount.store(1, std::memory_order_relaxed);
 124 }
 125
 126 IOBuf::SharedInfo::SharedInfo(FreeFunction fn, void* arg)
 127   : freeFn(fn),
 128     userData(arg) {
 129   // Use relaxed memory ordering here.  Since we are creating a new SharedInfo,
 130   // no other threads should be referring to it yet.
 131   refcount.store(1, std::memory_order_relaxed);
 132 }
 133
 134 void* IOBuf::operator new(size_t size) {
 135   size_t fullSize = offsetof(HeapStorage, buf) + size;
 136   auto* storage = static_cast<HeapStorage*>(malloc(fullSize));
 137   // operator new is not allowed to return NULL
 138   if (UNLIKELY(storage == nullptr)) {
 139     throw std::bad_alloc();
 140   }
 141
 142   new (&storage->prefix) HeapPrefix(kIOBufInUse);
 143   return &(storage->buf);
 144 }
 145
 146 void* IOBuf::operator new(size_t size, void* ptr) {
 147   return ptr;
 148 }
 149
 150 void IOBuf::operator delete(void* ptr) {
 151   auto* storageAddr = static_cast<uint8_t*>(ptr) - offsetof(HeapStorage, buf);
 152   auto* storage = reinterpret_cast<HeapStorage*>(storageAddr);
 153   releaseStorage(storage, kIOBufInUse);
 154 }
 155
 156 void IOBuf::releaseStorage(HeapStorage* storage, uint16_t freeFlags) {
 157   CHECK_EQ(storage->prefix.magic, static_cast<uint16_t>(kHeapMagic));
 158
 159   // Use relaxed memory order here.  If we are unlucky and happen to get
 160   // out-of-date data the compare_exchange_weak() call below will catch
 161   // it and load new data with memory_order_acq_rel.
 162   auto flags = storage->prefix.flags.load(std::memory_order_acquire);
 163   DCHECK_EQ((flags & freeFlags), freeFlags);
 164
 165   while (true) {
 166     uint16_t newFlags = (flags & ~freeFlags);
 167     if (newFlags == 0) {
 168       // The storage space is now unused.  Free it.
 169       storage->prefix.HeapPrefix::~HeapPrefix();
 170       free(storage);
 171       return;
 172     }
 173
 174     // This storage segment still contains portions that are in use.
 175     // Just clear the flags specified in freeFlags for now.
 176     auto ret = storage->prefix.flags.compare_exchange_weak(
 177         flags, newFlags, std::memory_order_acq_rel);
 178     if (ret) {
 179       // We successfully updated the flags.
 180       return;
 181     }
 182
 183     // We failed to update the flags.  Some other thread probably updated them
 184     // and cleared some of the other bits.  Continue around the loop to see if
 185     // we are the last user now, or if we need to try updating the flags again.
 186   }
 187 }
 188
 189 void IOBuf::freeInternalBuf(void* buf, void* userData) {
 190   auto* storage = static_cast<HeapStorage*>(userData);
 191   releaseStorage(storage, kDataInUse);
 192 }
 193
 194 IOBuf::IOBuf(CreateOp, uint64_t capacity)
 195   : next_(this),
 196     prev_(this),
 197     data_(nullptr),
 198     length_(0),
 199     flagsAndSharedInfo_(0) {
 200   SharedInfo* info;
 201   allocExtBuffer(capacity, &buf_, &info, &capacity_);
 202   setSharedInfo(info);
 203   data_ = buf_;
 204 }
 205
 206 IOBuf::IOBuf(CopyBufferOp op, const void* buf, uint64_t size,
 207              uint64_t headroom, uint64_t minTailroom)
 208   : IOBuf(CREATE, headroom + size + minTailroom) {
 209   advance(headroom);
 210   memcpy(writableData(), buf, size);
 211   append(size);
 212 }
 213
 214 IOBuf::IOBuf(CopyBufferOp op, ByteRange br,
 215              uint64_t headroom, uint64_t minTailroom)
 216   : IOBuf(op, br.data(), br.size(), headroom, minTailroom) {
 217 }
 218
 219 unique_ptr<IOBuf> IOBuf::create(uint64_t capacity) {
 220   // For smaller-sized buffers, allocate the IOBuf, SharedInfo, and the buffer
 221   // all with a single allocation.
 222   //
 223   // We don't do this for larger buffers since it can be wasteful if the user
 224   // needs to reallocate the buffer but keeps using the same IOBuf object.
 225   // In this case we can't free the data space until the IOBuf is also
 226   // destroyed.  Callers can explicitly call createCombined() or
 227   // createSeparate() if they know their use case better, and know if they are
 228   // likely to reallocate the buffer later.
 229   if (capacity <= kDefaultCombinedBufSize) {
 230     return createCombined(capacity);
 231   }
 232   return createSeparate(capacity);
 233 }
 234
 235 unique_ptr<IOBuf> IOBuf::createCombined(uint64_t capacity) {
 236   // To save a memory allocation, allocate space for the IOBuf object, the
 237   // SharedInfo struct, and the data itself all with a single call to malloc().
 238   size_t requiredStorage = offsetof(HeapFullStorage, align) + capacity;
 239   size_t mallocSize = goodMallocSize(requiredStorage);
 240   auto* storage = static_cast<HeapFullStorage*>(malloc(mallocSize));
 241
 242   new (&storage->hs.prefix) HeapPrefix(kIOBufInUse | kDataInUse);
 243   new (&storage->shared) SharedInfo(freeInternalBuf, storage);
 244
 245   uint8_t* bufAddr = reinterpret_cast<uint8_t*>(&storage->align);
 246   uint8_t* storageEnd = reinterpret_cast<uint8_t*>(storage) + mallocSize;
 247   size_t actualCapacity = storageEnd - bufAddr;
 248   unique_ptr<IOBuf> ret(new (&storage->hs.buf) IOBuf(
 249         InternalConstructor(), packFlagsAndSharedInfo(0, &storage->shared),
 250         bufAddr, actualCapacity, bufAddr, 0));
 251   return ret;
 252 }
 253
 254 unique_ptr<IOBuf> IOBuf::createSeparate(uint64_t capacity) {
 255   return make_unique<IOBuf>(CREATE, capacity);
 256 }
 257
 258 unique_ptr<IOBuf> IOBuf::createChain(
 259     size_t totalCapacity, uint64_t maxBufCapacity) {
 260   unique_ptr<IOBuf> out = create(
 261       std::min(totalCapacity, size_t(maxBufCapacity)));
 262   size_t allocatedCapacity = out->capacity();
 263
 264   while (allocatedCapacity < totalCapacity) {
 265     unique_ptr<IOBuf> newBuf = create(
 266         std::min(totalCapacity - allocatedCapacity, size_t(maxBufCapacity)));
 267     allocatedCapacity += newBuf->capacity();
 268     out->prependChain(std::move(newBuf));
 269   }
 270
 271   return out;
 272 }
 273
 274 IOBuf::IOBuf(TakeOwnershipOp, void* buf, uint64_t capacity, uint64_t length,
 275              FreeFunction freeFn, void* userData,
 276              bool freeOnError)
 277   : next_(this),
 278     prev_(this),
 279     data_(static_cast<uint8_t*>(buf)),
 280     buf_(static_cast<uint8_t*>(buf)),
 281     length_(length),
 282     capacity_(capacity),
 283     flagsAndSharedInfo_(packFlagsAndSharedInfo(kFlagFreeSharedInfo, nullptr)) {
 284   try {
 285     setSharedInfo(new SharedInfo(freeFn, userData));
 286   } catch (...) {
 287     takeOwnershipError(freeOnError, buf, freeFn, userData);
 288     throw;
 289   }
 290 }
 291
 292 unique_ptr<IOBuf> IOBuf::takeOwnership(void* buf, uint64_t capacity,
 293                                        uint64_t length,
 294                                        FreeFunction freeFn,
 295                                        void* userData,
 296                                        bool freeOnError) {
 297   try {
 298     // TODO: We could allocate the IOBuf object and SharedInfo all in a single
 299     // memory allocation.  We could use the existing HeapStorage class, and
 300     // define a new kSharedInfoInUse flag.  We could change our code to call
 301     // releaseStorage(kFlagFreeSharedInfo) when this kFlagFreeSharedInfo,
 302     // rather than directly calling delete.
 303     //
 304     // Note that we always pass freeOnError as false to the constructor.
 305     // If the constructor throws we'll handle it below.  (We have to handle
 306     // allocation failures from make_unique too.)
 307     return make_unique<IOBuf>(TAKE_OWNERSHIP, buf, capacity, length,
 308                               freeFn, userData, false);
 309   } catch (...) {
 310     takeOwnershipError(freeOnError, buf, freeFn, userData);
 311     throw;
 312   }
 313 }
 314
 315 IOBuf::IOBuf(WrapBufferOp, const void* buf, uint64_t capacity)
 316   : IOBuf(InternalConstructor(), 0,
 317           // We cast away the const-ness of the buffer here.
 318           // This is okay since IOBuf users must use unshare() to create a copy
 319           // of this buffer before writing to the buffer.
 320           static_cast<uint8_t*>(const_cast<void*>(buf)), capacity,
 321           static_cast<uint8_t*>(const_cast<void*>(buf)), capacity) {
 322 }
 323
 324 IOBuf::IOBuf(WrapBufferOp op, ByteRange br)
 325   : IOBuf(op, br.data(), br.size()) {
 326 }
 327
 328 unique_ptr<IOBuf> IOBuf::wrapBuffer(const void* buf, uint64_t capacity) {
 329   return make_unique<IOBuf>(WRAP_BUFFER, buf, capacity);
 330 }
 331
 332 IOBuf::IOBuf() noexcept {
 333 }
 334
 335 IOBuf::IOBuf(IOBuf&& other) noexcept {
 336   *this = std::move(other);
 337 }
 338
 339 IOBuf::IOBuf(InternalConstructor,
 340              uintptr_t flagsAndSharedInfo,
 341              uint8_t* buf,
 342              uint64_t capacity,
 343              uint8_t* data,
 344              uint64_t length)
 345   : next_(this),
 346     prev_(this),
 347     data_(data),
 348     buf_(buf),
 349     length_(length),
 350     capacity_(capacity),
 351     flagsAndSharedInfo_(flagsAndSharedInfo) {
 352   assert(data >= buf);
 353   assert(data + length <= buf + capacity);
 354 }
 355
 356 IOBuf::~IOBuf() {
 357   // Destroying an IOBuf destroys the entire chain.
 358   // Users of IOBuf should only explicitly delete the head of any chain.
 359   // The other elements in the chain will be automatically destroyed.
 360   while (next_ != this) {
 361     // Since unlink() returns unique_ptr() and we don't store it,
 362     // it will automatically delete the unlinked element.
 363     (void)next_->unlink();
 364   }
 365
 366   decrementRefcount();
 367 }
 368
 369 IOBuf& IOBuf::operator=(IOBuf&& other) noexcept {
 370   if (this == &other) {
 371     return *this;
 372   }
 373
 374   // If we are part of a chain, delete the rest of the chain.
 375   while (next_ != this) {
 376     // Since unlink() returns unique_ptr() and we don't store it,
 377     // it will automatically delete the unlinked element.
 378     (void)next_->unlink();
 379   }
 380
 381   // Decrement our refcount on the current buffer
 382   decrementRefcount();
 383
 384   // Take ownership of the other buffer's data
 385   data_ = other.data_;
 386   buf_ = other.buf_;
 387   length_ = other.length_;
 388   capacity_ = other.capacity_;
 389   flagsAndSharedInfo_ = other.flagsAndSharedInfo_;
 390   // Reset other so it is a clean state to be destroyed.
 391   other.data_ = nullptr;
 392   other.buf_ = nullptr;
 393   other.length_ = 0;
 394   other.capacity_ = 0;
 395   other.flagsAndSharedInfo_ = 0;
 396
 397   // If other was part of the chain, assume ownership of the rest of its chain.
 398   // (It's only valid to perform move assignment on the head of a chain.)
 399   if (other.next_ != &other) {
 400     next_ = other.next_;
 401     next_->prev_ = this;
 402     other.next_ = &other;
 403
 404     prev_ = other.prev_;
 405     prev_->next_ = this;
 406     other.prev_ = &other;
 407   }
 408
 409   // Sanity check to make sure that other is in a valid state to be destroyed.
 410   DCHECK_EQ(other.prev_, &other);
 411   DCHECK_EQ(other.next_, &other);
 412
 413   return *this;
 414 }
 415
 416 bool IOBuf::empty() const {
 417   const IOBuf* current = this;
 418   do {
 419     if (current->length() != 0) {
 420       return false;
 421     }
 422     current = current->next_;
 423   } while (current != this);
 424   return true;
 425 }
 426
 427 size_t IOBuf::countChainElements() const {
 428   size_t numElements = 1;
 429   for (IOBuf* current = next_; current != this; current = current->next_) {
 430     ++numElements;
 431   }
 432   return numElements;
 433 }
 434
 435 uint64_t IOBuf::computeChainDataLength() const {
 436   uint64_t fullLength = length_;
 437   for (IOBuf* current = next_; current != this; current = current->next_) {
 438     fullLength += current->length_;
 439   }
 440   return fullLength;
 441 }
 442
 443 void IOBuf::prependChain(unique_ptr<IOBuf>&& iobuf) {
 444   // Take ownership of the specified IOBuf
 445   IOBuf* other = iobuf.release();
 446
 447   // Remember the pointer to the tail of the other chain
 448   IOBuf* otherTail = other->prev_;
 449
 450   // Hook up prev_->next_ to point at the start of the other chain,
 451   // and other->prev_ to point at prev_
 452   prev_->next_ = other;
 453   other->prev_ = prev_;
 454
 455   // Hook up otherTail->next_ to point at us,
 456   // and prev_ to point back at otherTail,
 457   otherTail->next_ = this;
 458   prev_ = otherTail;
 459 }
 460
 461 unique_ptr<IOBuf> IOBuf::clone() const {
 462   unique_ptr<IOBuf> ret = make_unique<IOBuf>();
 463   cloneInto(*ret);
 464   return ret;
 465 }
 466
 467 unique_ptr<IOBuf> IOBuf::cloneOne() const {
 468   unique_ptr<IOBuf> ret = make_unique<IOBuf>();
 469   cloneOneInto(*ret);
 470   return ret;
 471 }
 472
 473 void IOBuf::cloneInto(IOBuf& other) const {
 474   IOBuf tmp;
 475   cloneOneInto(tmp);
 476
 477   for (IOBuf* current = next_; current != this; current = current->next_) {
 478     tmp.prependChain(current->cloneOne());
 479   }
 480
 481   other = std::move(tmp);
 482 }
 483
 484 void IOBuf::cloneOneInto(IOBuf& other) const {
 485   SharedInfo* info = sharedInfo();
 486   if (info) {
 487     setFlags(kFlagMaybeShared);
 488   }
 489   other = IOBuf(InternalConstructor(),
 490                 flagsAndSharedInfo_, buf_, capacity_,
 491                 data_, length_);
 492   if (info) {
 493     info->refcount.fetch_add(1, std::memory_order_acq_rel);
 494   }
 495 }
 496
 497 void IOBuf::unshareOneSlow() {
 498   // Allocate a new buffer for the data
 499   uint8_t* buf;
 500   SharedInfo* sharedInfo;
 501   uint64_t actualCapacity;
 502   allocExtBuffer(capacity_, &buf, &sharedInfo, &actualCapacity);
 503
 504   // Copy the data
 505   // Maintain the same amount of headroom.  Since we maintained the same
 506   // minimum capacity we also maintain at least the same amount of tailroom.
 507   uint64_t headlen = headroom();
 508   memcpy(buf + headlen, data_, length_);
 509
 510   // Release our reference on the old buffer
 511   decrementRefcount();
 512   // Make sure kFlagMaybeShared and kFlagFreeSharedInfo are all cleared.
 513   setFlagsAndSharedInfo(0, sharedInfo);
 514
 515   // Update the buffer pointers to point to the new buffer
 516   data_ = buf + headlen;
 517   buf_ = buf;
 518 }
 519
 520 void IOBuf::unshareChained() {
 521   // unshareChained() should only be called if we are part of a chain of
 522   // multiple IOBufs.  The caller should have already verified this.
 523   assert(isChained());
 524
 525   IOBuf* current = this;
 526   while (true) {
 527     if (current->isSharedOne()) {
 528       // we have to unshare
 529       break;
 530     }
 531
 532     current = current->next_;
 533     if (current == this) {
 534       // None of the IOBufs in the chain are shared,
 535       // so return without doing anything
 536       return;
 537     }
 538   }
 539
 540   // We have to unshare.  Let coalesceSlow() do the work.
 541   coalesceSlow();
 542 }
 543
 544 void IOBuf::coalesceSlow() {
 545   // coalesceSlow() should only be called if we are part of a chain of multiple
 546   // IOBufs.  The caller should have already verified this.
 547   DCHECK(isChained());
 548
 549   // Compute the length of the entire chain
 550   uint64_t newLength = 0;
 551   IOBuf* end = this;
 552   do {
 553     newLength += end->length_;
 554     end = end->next_;
 555   } while (end != this);
 556
 557   coalesceAndReallocate(newLength, end);
 558   // We should be only element left in the chain now
 559   DCHECK(!isChained());
 560 }
 561
 562 void IOBuf::coalesceSlow(size_t maxLength) {
 563   // coalesceSlow() should only be called if we are part of a chain of multiple
 564   // IOBufs.  The caller should have already verified this.
 565   DCHECK(isChained());
 566   DCHECK_LT(length_, maxLength);
 567
 568   // Compute the length of the entire chain
 569   uint64_t newLength = 0;
 570   IOBuf* end = this;
 571   while (true) {
 572     newLength += end->length_;
 573     end = end->next_;
 574     if (newLength >= maxLength) {
 575       break;
 576     }
 577     if (end == this) {
 578       throw std::overflow_error("attempted to coalesce more data than "
 579                                 "available");
 580     }
 581   }
 582
 583   coalesceAndReallocate(newLength, end);
 584   // We should have the requested length now
 585   DCHECK_GE(length_, maxLength);
 586 }
 587
 588 void IOBuf::coalesceAndReallocate(size_t newHeadroom,
 589                                   size_t newLength,
 590                                   IOBuf* end,
 591                                   size_t newTailroom) {
 592   uint64_t newCapacity = newLength + newHeadroom + newTailroom;
 593
 594   // Allocate space for the coalesced buffer.
 595   // We always convert to an external buffer, even if we happened to be an
 596   // internal buffer before.
 597   uint8_t* newBuf;
 598   SharedInfo* newInfo;
 599   uint64_t actualCapacity;
 600   allocExtBuffer(newCapacity, &newBuf, &newInfo, &actualCapacity);
 601
 602   // Copy the data into the new buffer
 603   uint8_t* newData = newBuf + newHeadroom;
 604   uint8_t* p = newData;
 605   IOBuf* current = this;
 606   size_t remaining = newLength;
 607   do {
 608     assert(current->length_ <= remaining);
 609     remaining -= current->length_;
 610     memcpy(p, current->data_, current->length_);
 611     p += current->length_;
 612     current = current->next_;
 613   } while (current != end);
 614   assert(remaining == 0);
 615
 616   // Point at the new buffer
 617   decrementRefcount();
 618
 619   // Make sure kFlagMaybeShared and kFlagFreeSharedInfo are all cleared.
 620   setFlagsAndSharedInfo(0, newInfo);
 621
 622   capacity_ = actualCapacity;
 623   buf_ = newBuf;
 624   data_ = newData;
 625   length_ = newLength;
 626
 627   // Separate from the rest of our chain.
 628   // Since we don't store the unique_ptr returned by separateChain(),
 629   // this will immediately delete the returned subchain.
 630   if (isChained()) {
 631     (void)separateChain(next_, current->prev_);
 632   }
 633 }
 634
 635 void IOBuf::decrementRefcount() {
 636   // Externally owned buffers don't have a SharedInfo object and aren't managed
 637   // by the reference count
 638   SharedInfo* info = sharedInfo();
 639   if (!info) {
 640     return;
 641   }
 642
 643   // Decrement the refcount
 644   uint32_t newcnt = info->refcount.fetch_sub(
 645       1, std::memory_order_acq_rel);
 646   // Note that fetch_sub() returns the value before we decremented.
 647   // If it is 1, we were the only remaining user; if it is greater there are
 648   // still other users.
 649   if (newcnt > 1) {
 650     return;
 651   }
 652
 653   // We were the last user.  Free the buffer
 654   freeExtBuffer();
 655
 656   // Free the SharedInfo if it was allocated separately.
 657   //
 658   // This is only used by takeOwnership().
 659   //
 660   // To avoid this special case handling in decrementRefcount(), we could have
 661   // takeOwnership() set a custom freeFn() that calls the user's free function
 662   // then frees the SharedInfo object.  (This would require that
 663   // takeOwnership() store the user's free function with its allocated
 664   // SharedInfo object.)  However, handling this specially with a flag seems
 665   // like it shouldn't be problematic.
 666   if (flags() & kFlagFreeSharedInfo) {
 667     delete sharedInfo();
 668   }
 669 }
 670
 671 void IOBuf::reserveSlow(uint64_t minHeadroom, uint64_t minTailroom) {
 672   size_t newCapacity = (size_t)length_ + minHeadroom + minTailroom;
 673   DCHECK_LT(newCapacity, UINT32_MAX);
 674
 675   // reserveSlow() is dangerous if anyone else is sharing the buffer, as we may
 676   // reallocate and free the original buffer.  It should only ever be called if
 677   // we are the only user of the buffer.
 678   DCHECK(!isSharedOne());
 679
 680   // We'll need to reallocate the buffer.
 681   // There are a few options.
 682   // - If we have enough total room, move the data around in the buffer
 683   //   and adjust the data_ pointer.
 684   // - If we're using an internal buffer, we'll switch to an external
 685   //   buffer with enough headroom and tailroom.
 686   // - If we have enough headroom (headroom() >= minHeadroom) but not too much
 687   //   (so we don't waste memory), we can try one of two things, depending on
 688   //   whether we use jemalloc or not:
 689   //   - If using jemalloc, we can try to expand in place, avoiding a memcpy()
 690   //   - If not using jemalloc and we don't have too much to copy,
 691   //     we'll use realloc() (note that realloc might have to copy
 692   //     headroom + data + tailroom, see smartRealloc in folly/Malloc.h)
 693   // - Otherwise, bite the bullet and reallocate.
 694   if (headroom() + tailroom() >= minHeadroom + minTailroom) {
 695     uint8_t* newData = writableBuffer() + minHeadroom;
 696     memmove(newData, data_, length_);
 697     data_ = newData;
 698     return;
 699   }
 700
 701   size_t newAllocatedCapacity = goodExtBufferSize(newCapacity);
 702   uint8_t* newBuffer = nullptr;
 703   uint64_t newHeadroom = 0;
 704   uint64_t oldHeadroom = headroom();
 705
 706   // If we have a buffer allocated with malloc and we just need more tailroom,
 707   // try to use realloc()/xallocx() to grow the buffer in place.
 708   SharedInfo* info = sharedInfo();
 709   if (info && (info->freeFn == nullptr) && length_ != 0 &&
 710       oldHeadroom >= minHeadroom) {
 711     if (usingJEMalloc()) {
 712       size_t headSlack = oldHeadroom - minHeadroom;
 713       // We assume that tailroom is more useful and more important than
 714       // headroom (not least because realloc / xallocx allow us to grow the
 715       // buffer at the tail, but not at the head)  So, if we have more headroom
 716       // than we need, we consider that "wasted".  We arbitrarily define "too
 717       // much" headroom to be 25% of the capacity.
 718       if (headSlack * 4 <= newCapacity) {
 719         size_t allocatedCapacity = capacity() + sizeof(SharedInfo);
 720         void* p = buf_;
 721         if (allocatedCapacity >= jemallocMinInPlaceExpandable) {
 722           if (xallocx(p, newAllocatedCapacity, 0, 0) == newAllocatedCapacity) {
 723             newBuffer = static_cast<uint8_t*>(p);
 724             newHeadroom = oldHeadroom;
 725             newAllocatedCapacity = newAllocatedCapacity;
 726           }
 727           // if xallocx failed, do nothing, fall back to malloc/memcpy/free
 728         }
 729       }
 730     } else {  // Not using jemalloc
 731       size_t copySlack = capacity() - length_;
 732       if (copySlack * 2 <= length_) {
 733         void* p = realloc(buf_, newAllocatedCapacity);
 734         if (UNLIKELY(p == nullptr)) {
 735           throw std::bad_alloc();
 736         }
 737         newBuffer = static_cast<uint8_t*>(p);
 738         newHeadroom = oldHeadroom;
 739       }
 740     }
 741   }
 742
 743   // None of the previous reallocation strategies worked (or we're using
 744   // an internal buffer).  malloc/copy/free.
 745   if (newBuffer == nullptr) {
 746     void* p = malloc(newAllocatedCapacity);
 747     if (UNLIKELY(p == nullptr)) {
 748       throw std::bad_alloc();
 749     }
 750     newBuffer = static_cast<uint8_t*>(p);
 751     memcpy(newBuffer + minHeadroom, data_, length_);
 752     if (sharedInfo()) {
 753       freeExtBuffer();
 754     }
 755     newHeadroom = minHeadroom;
 756   }
 757
 758   uint64_t cap;
 759   initExtBuffer(newBuffer, newAllocatedCapacity, &info, &cap);
 760
 761   if (flags() & kFlagFreeSharedInfo) {
 762     delete sharedInfo();
 763   }
 764
 765   setFlagsAndSharedInfo(0, info);
 766   capacity_ = cap;
 767   buf_ = newBuffer;
 768   data_ = newBuffer + newHeadroom;
 769   // length_ is unchanged
 770 }
 771
 772 void IOBuf::freeExtBuffer() {
 773   SharedInfo* info = sharedInfo();
 774   DCHECK(info);
 775
 776   if (info->freeFn) {
 777     try {
 778       info->freeFn(buf_, info->userData);
 779     } catch (...) {
 780       // The user's free function should never throw.  Otherwise we might
 781       // throw from the IOBuf destructor.  Other code paths like coalesce()
 782       // also assume that decrementRefcount() cannot throw.
 783       abort();
 784     }
 785   } else {
 786     free(buf_);
 787   }
 788 }
 789
 790 void IOBuf::allocExtBuffer(uint64_t minCapacity,
 791                            uint8_t** bufReturn,
 792                            SharedInfo** infoReturn,
 793                            uint64_t* capacityReturn) {
 794   size_t mallocSize = goodExtBufferSize(minCapacity);
 795   uint8_t* buf = static_cast<uint8_t*>(malloc(mallocSize));
 796   if (UNLIKELY(buf == nullptr)) {
 797     throw std::bad_alloc();
 798   }
 799   initExtBuffer(buf, mallocSize, infoReturn, capacityReturn);
 800   *bufReturn = buf;
 801 }
 802
 803 size_t IOBuf::goodExtBufferSize(uint64_t minCapacity) {
 804   // Determine how much space we should allocate.  We'll store the SharedInfo
 805   // for the external buffer just after the buffer itself.  (We store it just
 806   // after the buffer rather than just before so that the code can still just
 807   // use free(buf_) to free the buffer.)
 808   size_t minSize = static_cast<size_t>(minCapacity) + sizeof(SharedInfo);
 809   // Add room for padding so that the SharedInfo will be aligned on an 8-byte
 810   // boundary.
 811   minSize = (minSize + 7) & ~7;
 812
 813   // Use goodMallocSize() to bump up the capacity to a decent size to request
 814   // from malloc, so we can use all of the space that malloc will probably give
 815   // us anyway.
 816   return goodMallocSize(minSize);
 817 }
 818
 819 void IOBuf::initExtBuffer(uint8_t* buf, size_t mallocSize,
 820                           SharedInfo** infoReturn,
 821                           uint64_t* capacityReturn) {
 822   // Find the SharedInfo storage at the end of the buffer
 823   // and construct the SharedInfo.
 824   uint8_t* infoStart = (buf + mallocSize) - sizeof(SharedInfo);
 825   SharedInfo* sharedInfo = new(infoStart) SharedInfo;
 826
 827   *capacityReturn = infoStart - buf;
 828   *infoReturn = sharedInfo;
 829 }
 830
 831 fbstring IOBuf::moveToFbString() {
 832   // malloc-allocated buffers are just fine, everything else needs
 833   // to be turned into one.
 834   if (!sharedInfo() ||         // user owned, not ours to give up
 835       sharedInfo()->freeFn ||  // not malloc()-ed
 836       headroom() != 0 ||       // malloc()-ed block doesn't start at beginning
 837       tailroom() == 0 ||       // no room for NUL terminator
 838       isShared() ||            // shared
 839       isChained()) {           // chained
 840     // We might as well get rid of all head and tailroom if we're going
 841     // to reallocate; we need 1 byte for NUL terminator.
 842     coalesceAndReallocate(0, computeChainDataLength(), this, 1);
 843   }
 844
 845   // Ensure NUL terminated
 846   *writableTail() = 0;
 847   fbstring str(reinterpret_cast<char*>(writableData()),
 848                length(),  capacity(),
 849                AcquireMallocatedString());
 850
 851   if (flags() & kFlagFreeSharedInfo) {
 852     delete sharedInfo();
 853   }
 854
 855   // Reset to a state where we can be deleted cleanly
 856   flagsAndSharedInfo_ = 0;
 857   buf_ = nullptr;
 858   clear();
 859   return str;
 860 }
 861
 862 IOBuf::Iterator IOBuf::cbegin() const {
 863   return Iterator(this, this);
 864 }
 865
 866 IOBuf::Iterator IOBuf::cend() const {
 867   return Iterator(nullptr, nullptr);
 868 }
 869
 870 folly::fbvector<struct iovec> IOBuf::getIov() const {
 871   folly::fbvector<struct iovec> iov;
 872   iov.reserve(countChainElements());
 873   appendToIov(&iov);
 874   return iov;
 875 }
 876
 877 void IOBuf::appendToIov(folly::fbvector<struct iovec>* iov) const {
 878   IOBuf const* p = this;
 879   do {
 880     // some code can get confused by empty iovs, so skip them
 881     if (p->length() > 0) {
 882       iov->push_back({(void*)p->data(), folly::to<size_t>(p->length())});
 883     }
 884     p = p->next();
 885   } while (p != this);
 886 }
 887
 888 size_t IOBufHash::operator()(const IOBuf& buf) const {
 889   folly::hash::SpookyHashV2 hasher;
 890   hasher.Init(0, 0);
 891   io::Cursor cursor(&buf);
 892   for (;;) {
 893     auto p = cursor.peek();
 894     if (p.second == 0) {
 895       break;
 896     }
 897     hasher.Update(p.first, p.second);
 898     cursor.skip(p.second);
 899   }
 900   uint64_t h1;
 901   uint64_t h2;
 902   hasher.Final(&h1, &h2);
 903   return h1;
 904 }
 905
 906 bool IOBufEqual::operator()(const IOBuf& a, const IOBuf& b) const {
 907   io::Cursor ca(&a);
 908   io::Cursor cb(&b);
 909   for (;;) {
 910     auto pa = ca.peek();
 911     auto pb = cb.peek();
 912     if (pa.second == 0 && pb.second == 0) {
 913       return true;
 914     } else if (pa.second == 0 || pb.second == 0) {
 915       return false;
 916     }
 917     size_t n = std::min(pa.second, pb.second);
 918     DCHECK_GT(n, 0);
 919     if (memcmp(pa.first, pb.first, n)) {
 920       return false;
 921     }
 922     ca.skip(n);
 923     cb.skip(n);
 924   }
 925 }
 926
 927 } // folly