folly/io/IOBufQueue.h

   1 /*
   2  * Copyright 2013 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 FOLLY_IO_IOBUF_QUEUE_H
  18 #define FOLLY_IO_IOBUF_QUEUE_H
  19
  20 #include "folly/io/IOBuf.h"
  21
  22 #include <stdexcept>
  23 #include <string>
  24
  25 namespace folly {
  26
  27 /**
  28  * An IOBufQueue encapsulates a chain of IOBufs and provides
  29  * convenience functions to append data to the back of the chain
  30  * and remove data from the front.
  31  *
  32  * You may also prepend data into the headroom of the first buffer in the
  33  * chain, if any.
  34  */
  35 class IOBufQueue {
  36  public:
  37   struct Options {
  38     Options() : cacheChainLength(false) { }
  39     bool cacheChainLength;
  40   };
  41
  42   /**
  43    * Commonly used Options, currently the only possible value other than
  44    * the default.
  45    */
  46   static Options cacheChainLength() {
  47     Options options;
  48     options.cacheChainLength = true;
  49     return options;
  50   }
  51
  52   explicit IOBufQueue(const Options& options = Options());
  53
  54   /**
  55    * Return a space to prepend bytes and the amount of headroom available.
  56    */
  57   std::pair<void*, uint32_t> headroom();
  58
  59   /**
  60    * Indicate that n bytes from the headroom have been used.
  61    */
  62   void markPrepended(uint32_t n);
  63
  64   /**
  65    * Prepend an existing range; throws std::overflow_error if not enough
  66    * room.
  67    */
  68   void prepend(const void* buf, uint32_t n);
  69
  70   /**
  71    * Add a buffer or buffer chain to the end of this queue. The
  72    * queue takes ownership of buf.
  73    *
  74    * If pack is true, we try to reduce wastage at the end of this queue
  75    * by copying some data from the first buffers in the buf chain (and
  76    * releasing the buffers), if possible.  If pack is false, we leave
  77    * the chain topology unchanged.
  78    */
  79   void append(std::unique_ptr<folly::IOBuf>&& buf,
  80               bool pack=false);
  81
  82   /**
  83    * Add a queue to the end of this queue. The queue takes ownership of
  84    * all buffers from the other queue.
  85    */
  86   void append(IOBufQueue& other, bool pack=false);
  87   void append(IOBufQueue&& other, bool pack=false) {
  88     append(other, pack);  // call lvalue reference overload, above
  89   }
  90
  91   /**
  92    * Copy len bytes, starting at buf, to the end of this queue.
  93    * The caller retains ownership of the source data.
  94    */
  95   void append(const void* buf, size_t len);
  96
  97   /**
  98    * Copy a string to the end of this queue.
  99    * The caller retains ownership of the source data.
 100    */
 101   void append(const std::string& buf) {
 102     append(buf.data(), buf.length());
 103   }
 104
 105   /**
 106    * Append a chain of IOBuf objects that point to consecutive regions
 107    * within buf.
 108    *
 109    * Just like IOBuf::wrapBuffer, this should only be used when the caller
 110    * knows ahead of time and can ensure that all IOBuf objects that will point
 111    * to this buffer will be destroyed before the buffer itself is destroyed;
 112    * all other caveats from wrapBuffer also apply.
 113    *
 114    * Every buffer except for the last will wrap exactly blockSize bytes.
 115    * Importantly, this method may be used to wrap buffers larger than 4GB.
 116    */
 117   void wrapBuffer(const void* buf, size_t len,
 118                   uint32_t blockSize=(1U << 31));  // default block size: 2GB
 119
 120   /**
 121    * Obtain a writable block of contiguous bytes at the end of this
 122    * queue, allocating more space if necessary.  The amount of space
 123    * reserved will be at least min.  If min contiguous space is not
 124    * available at the end of the queue, and IOBuf with size newAllocationSize
 125    * is appended to the chain and returned.  The actual available space
 126    * may be larger than newAllocationSize, but will be truncated to max,
 127    * if specified.
 128    *
 129    * If the caller subsequently writes anything into the returned space,
 130    * it must call the postallocate() method.
 131    *
 132    * @return The starting address of the block and the length in bytes.
 133    *
 134    * @note The point of the preallocate()/postallocate() mechanism is
 135    *       to support I/O APIs such as Thrift's TAsyncSocket::ReadCallback
 136    *       that request a buffer from the application and then, in a later
 137    *       callback, tell the application how much of the buffer they've
 138    *       filled with data.
 139    */
 140   std::pair<void*,uint32_t> preallocate(
 141     uint32_t min, uint32_t newAllocationSize,
 142     uint32_t max = std::numeric_limits<uint32_t>::max());
 143
 144   /**
 145    * Tell the queue that the caller has written data into the first n
 146    * bytes provided by the previous preallocate() call.
 147    *
 148    * @note n should be less than or equal to the size returned by
 149    *       preallocate().  If n is zero, the caller may skip the call
 150    *       to postallocate().  If n is nonzero, the caller must not
 151    *       invoke any other non-const methods on this IOBufQueue between
 152    *       the call to preallocate and the call to postallocate().
 153    */
 154   void postallocate(uint32_t n);
 155
 156   /**
 157    * Obtain a writable block of n contiguous bytes, allocating more space
 158    * if necessary, and mark it as used.  The caller can fill it later.
 159    */
 160   void* allocate(uint32_t n) {
 161     void* p = preallocate(n, n).first;
 162     postallocate(n);
 163     return p;
 164   }
 165
 166   /**
 167    * Split off the first n bytes of the queue into a separate IOBuf chain,
 168    * and transfer ownership of the new chain to the caller.  The IOBufQueue
 169    * retains ownership of everything after the split point.
 170    *
 171    * @warning If the split point lies in the middle of some IOBuf within
 172    *          the chain, this function may, as an implementation detail,
 173    *          clone that IOBuf.
 174    *
 175    * @throws std::underflow_error if n exceeds the number of bytes
 176    *         in the queue.
 177    */
 178   std::unique_ptr<folly::IOBuf> split(size_t n);
 179
 180   /**
 181    * Similar to IOBuf::trimStart, but works on the whole queue.  Will
 182    * pop off buffers that have been completely trimmed.
 183    */
 184   void trimStart(size_t amount);
 185
 186   /**
 187    * Similar to IOBuf::trimEnd, but works on the whole queue.  Will
 188    * pop off buffers that have been completely trimmed.
 189    */
 190   void trimEnd(size_t amount);
 191
 192   /**
 193    * Transfer ownership of the queue's entire IOBuf chain to the caller.
 194    */
 195   std::unique_ptr<folly::IOBuf> move() {
 196     chainLength_ = 0;
 197     return std::move(head_);
 198   }
 199
 200   /**
 201    * Access
 202    */
 203   const folly::IOBuf* front() const {
 204     return head_.get();
 205   }
 206
 207   /**
 208    * returns the first IOBuf in the chain and removes it from the chain
 209    *
 210    * @return first IOBuf in the chain or nullptr if none.
 211    */
 212   std::unique_ptr<folly::IOBuf> pop_front();
 213
 214   /**
 215    * Total chain length, only valid if cacheLength was specified in the
 216    * constructor.
 217    */
 218   size_t chainLength() const {
 219     if (!options_.cacheChainLength) {
 220       throw std::invalid_argument("IOBufQueue: chain length not cached");
 221     }
 222     return chainLength_;
 223   }
 224
 225   const Options& options() const {
 226     return options_;
 227   }
 228
 229   /**
 230    * Clear the queue.  Note that this does not release the buffers, it
 231    * just sets their length to zero; useful if you want to reuse the
 232    * same queue without reallocating.
 233    */
 234   void clear();
 235
 236   /** Movable */
 237   IOBufQueue(IOBufQueue&&);
 238   IOBufQueue& operator=(IOBufQueue&&);
 239
 240  private:
 241   static const size_t kChainLengthNotCached = (size_t)-1;
 242   /** Not copyable */
 243   IOBufQueue(const IOBufQueue&) = delete;
 244   IOBufQueue& operator=(const IOBufQueue&) = delete;
 245
 246   Options options_;
 247   size_t chainLength_;
 248   /** Everything that has been appended but not yet discarded or moved out */
 249   std::unique_ptr<folly::IOBuf> head_;
 250 };
 251
 252 } // folly
 253
 254 #endif // FOLLY_IO_IOBUF_QUEUE_H