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