folly/experimental/io/IOBufQueue.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 #ifndef FOLLY_IO_IOBUF_QUEUE_H
  18 #define FOLLY_IO_IOBUF_QUEUE_H
  19
  20 #include "folly/experimental/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 class IOBufQueue {
  33  public:
  34   struct Options {
  35     Options() : cacheChainLength(false) { }
  36     bool cacheChainLength;
  37   };
  38
  39   explicit IOBufQueue(const Options& options = Options());
  40
  41   /**
  42    * Add a buffer or buffer chain to the end of this queue. The
  43    * queue takes ownership of buf.
  44    */
  45   void append(std::unique_ptr<folly::IOBuf>&& buf);
  46
  47   /**
  48    * Add a queue to the end of this queue. The queue takes ownership of
  49    * all buffers from the other queue.
  50    */
  51   void append(IOBufQueue& other);
  52   void append(IOBufQueue&& other) {
  53     append(other);  // call lvalue reference overload, above
  54   }
  55
  56   /**
  57    * Copy len bytes, starting at buf, to the end of this queue.
  58    * The caller retains ownership of the source data.
  59    */
  60   void append(const void* buf, size_t len);
  61
  62   /**
  63    * Copy a string to the end of this queue.
  64    * The caller retains ownership of the source data.
  65    */
  66   void append(const std::string& buf) {
  67     append(buf.data(), buf.length());
  68   }
  69
  70   /**
  71    * Append a chain of IOBuf objects that point to consecutive regions
  72    * within buf.
  73    *
  74    * Just like IOBuf::wrapBuffer, this should only be used when the caller
  75    * knows ahead of time and can ensure that all IOBuf objects that will point
  76    * to this buffer will be destroyed before the buffer itself is destroyed;
  77    * all other caveats from wrapBuffer also apply.
  78    *
  79    * Every buffer except for the last will wrap exactly blockSize bytes.
  80    * Importantly, this method may be used to wrap buffers larger than 4GB.
  81    */
  82   void wrapBuffer(const void* buf, size_t len,
  83                   uint32_t blockSize=(1U << 31));  // default block size: 2GB
  84
  85   /**
  86    * Obtain a writable block of contiguous bytes at the end of this
  87    * queue, allocating more space if necessary.  The amount of space
  88    * reserved will be between min and max, inclusive; the IOBufQueue
  89    * implementation may pick a value in that range that makes efficient
  90    * use of already-allocated internal space.
  91    *
  92    * If the caller subsequently writes anything into the returned space,
  93    * it must call the postallocate() method.
  94    *
  95    * @return The starting address of the block and the length in bytes.
  96    *
  97    * @note The point of the preallocate()/postallocate() mechanism is
  98    *       to support I/O APIs such as Thrift's TAsyncSocket::ReadCallback
  99    *       that request a buffer from the application and then, in a later
 100    *       callback, tell the application how much of the buffer they've
 101    *       filled with data.
 102    */
 103   std::pair<void*,uint32_t> preallocate(uint32_t min, uint32_t max);
 104
 105   /**
 106    * Tell the queue that the caller has written data into the first n
 107    * bytes provided by the previous preallocate() call.
 108    *
 109    * @note n should be less than or equal to the size returned by
 110    *       preallocate().  If n is zero, the caller may skip the call
 111    *       to postallocate().  If n is nonzero, the caller must not
 112    *       invoke any other non-const methods on this IOBufQueue between
 113    *       the call to preallocate and the call to postallocate().
 114    */
 115   void postallocate(uint32_t n);
 116
 117   /**
 118    * Obtain a writable block of n contiguous bytes, allocating more space
 119    * if necessary, and mark it as used.  The caller can fill it later.
 120    */
 121   void* allocate(uint32_t n) {
 122     void* p = preallocate(n, n).first;
 123     postallocate(n);
 124     return p;
 125   }
 126
 127   /**
 128    * Split off the first n bytes of the queue into a separate IOBuf chain,
 129    * and transfer ownership of the new chain to the caller.  The IOBufQueue
 130    * retains ownership of everything after the split point.
 131    *
 132    * @warning If the split point lies in the middle of some IOBuf within
 133    *          the chain, this function may, as an implementation detail,
 134    *          clone that IOBuf.
 135    *
 136    * @throws std::underflow_error if n exceeds the number of bytes
 137    *         in the queue.
 138    */
 139   std::unique_ptr<folly::IOBuf> split(size_t n);
 140
 141   /**
 142    * Similar to IOBuf::trimStart, but works on the whole queue.  Will
 143    * pop off buffers that have been completely trimmed.
 144    */
 145   void trimStart(size_t amount);
 146
 147   /**
 148    * Similar to IOBuf::trimEnd, but works on the whole queue.  Will
 149    * pop off buffers that have been completely trimmed.
 150    */
 151   void trimEnd(size_t amount);
 152
 153   /**
 154    * Transfer ownership of the queue's entire IOBuf chain to the caller.
 155    */
 156   std::unique_ptr<folly::IOBuf>&& move() {
 157     chainLength_ = 0;
 158     return std::move(head_);
 159   }
 160
 161   /**
 162    * Access
 163    */
 164   const folly::IOBuf* front() const {
 165     return head_.get();
 166   }
 167
 168   /**
 169    * Total chain length, only valid if cacheLength was specified in the
 170    * constructor.
 171    */
 172   size_t chainLength() const {
 173     if (!options_.cacheChainLength) {
 174       throw std::invalid_argument("IOBufQueue: chain length not cached");
 175     }
 176     return chainLength_;
 177   }
 178
 179   const Options& options() const {
 180     return options_;
 181   }
 182
 183   /** Movable */
 184   IOBufQueue(IOBufQueue&&);
 185   IOBufQueue& operator=(IOBufQueue&&);
 186
 187  private:
 188   static const size_t kChainLengthNotCached = (size_t)-1;
 189   /** Not copyable */
 190   IOBufQueue(const IOBufQueue&) = delete;
 191   IOBufQueue& operator=(const IOBufQueue&) = delete;
 192
 193   Options options_;
 194   size_t chainLength_;
 195   /** Everything that has been appended but not yet discarded or moved out */
 196   std::unique_ptr<folly::IOBuf> head_;
 197 };
 198
 199 } // folly
 200
 201 #endif // FOLLY_IO_IOBUF_QUEUE_H