ceph/src/rocksdb/docs/_posts/2017-08-24-pinnableslice.markdown

   1 ---
   2 title: PinnableSlice; less memcpy with point lookups
   3 layout: post
   4 author: maysamyabandeh
   5 category: blog
   6 ---
   7
   8 The classic API for [DB::Get](https://github.com/facebook/rocksdb/blob/9e583711144f580390ce21a49a8ceacca338fcd5/include/rocksdb/db.h#L310) receives a std::string as argument to which it will copy the value. The memcpy overhead could be non-trivial when the value is large. The [new API](https://github.com/facebook/rocksdb/blob/9e583711144f580390ce21a49a8ceacca338fcd5/include/rocksdb/db.h#L322) receives a PinnableSlice instead, which avoids memcpy in most of the cases.
   9
  10 ### What is PinnableSlice?
  11
  12 Similarly to Slice, PinnableSlice refers to some in-memory data so it does not incur the memcpy cost. To ensure that the data will not be erased while it is being processed by the user, PinnableSlice, as its name suggests, has the data pinned in memory. The pinned data are released when PinnableSlice object is destructed or when ::Reset is invoked explicitly on it.
  13
  14 ### How good is it?
  15
  16 Here are the improvements in throughput for an [in-memory benchmark](https://github.com/facebook/rocksdb/pull/1756#issuecomment-286201693):
  17 * value 1k byte: 14%
  18 * value 10k byte: 34%
  19
  20 ### Any limitations?
  21
  22 PinnableSlice tries to avoid memcpy as much as possible. The primary gain is when reading large values from the block cache. There are however cases that it would still have to copy the data into its internal buffer. The reason is mainly the complexity of implementation and if there is enough motivation on the application side. the scope of PinnableSlice could be extended to such cases too. These include:
  23 * Merged values
  24 * Reads from memtables
  25
  26 ### How to use it?
  27
  28 ```cpp
  29 PinnableSlice pinnable_val;
  30 while (!stopped) {
  31    auto s = db->Get(opt, cf, key, &pinnable_val);
  32    // ... use it
  33    pinnable_val.Reset(); // then release it immediately
  34 }
  35 ```
  36
  37 You can also [initialize the internal buffer](https://github.com/facebook/rocksdb/blob/9e583711144f580390ce21a49a8ceacca338fcd5/include/rocksdb/db.h#L314) of PinnableSlice by passing your own string in the constructor. [simple_example.cc](https://github.com/facebook/rocksdb/blob/master/examples/simple_example.cc) demonstrates that with more examples.