folly/experimental/hazptr/hazptr.h

   1 /*
   2  * Copyright 2017 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 #pragma once
  17 #define HAZPTR_H
  18
  19 #include <atomic>
  20
  21 /* Stand-in for C++17 std::pmr::memory_resource */
  22 #include <folly/experimental/hazptr/memory_resource.h>
  23
  24 namespace folly {
  25 namespace hazptr {
  26
  27 /** hazptr_rec: Private class that contains hazard pointers. */
  28 class hazptr_rec;
  29
  30 /** hazptr_obj: Private class for objects protected by hazard pointers. */
  31 class hazptr_obj;
  32
  33 /** hazptr_obj_base: Base template for objects protected by hazard pointers. */
  34 template <typename T, typename Deleter>
  35 class hazptr_obj_base;
  36
  37 /** hazptr_obj_base_refcounted:
  38  *  Base template for reference counted objects protected by hazard pointers.
  39  */
  40 template <typename T, typename Deleter>
  41 class hazptr_obj_base_refcounted;
  42
  43 /** hazptr_local: Optimized template for bulk construction and destruction of
  44  *  hazard pointers */
  45 template <size_t M>
  46 class hazptr_array;
  47
  48 /** hazptr_local: Optimized template for locally-used hazard pointers */
  49 template <size_t M>
  50 class hazptr_local;
  51
  52 /** hazptr_domain: Class of hazard pointer domains. Each domain manages a set
  53  *  of hazard pointers and a set of retired objects. */
  54 class hazptr_domain {
  55  public:
  56   constexpr explicit hazptr_domain(
  57       memory_resource* = get_default_resource()) noexcept;
  58   ~hazptr_domain();
  59
  60   hazptr_domain(const hazptr_domain&) = delete;
  61   hazptr_domain(hazptr_domain&&) = delete;
  62   hazptr_domain& operator=(const hazptr_domain&) = delete;
  63   hazptr_domain& operator=(hazptr_domain&&) = delete;
  64
  65  private:
  66   friend class hazptr_holder;
  67   template <typename, typename>
  68   friend class hazptr_obj_base;
  69   template <typename, typename>
  70   friend class hazptr_obj_base_refcounted;
  71   friend struct hazptr_priv;
  72
  73   memory_resource* mr_;
  74   std::atomic<hazptr_rec*> hazptrs_ = {nullptr};
  75   std::atomic<hazptr_obj*> retired_ = {nullptr};
  76   std::atomic<int> hcount_ = {0};
  77   std::atomic<int> rcount_ = {0};
  78
  79   void objRetire(hazptr_obj*);
  80   hazptr_rec* hazptrAcquire();
  81   void hazptrRelease(hazptr_rec*) noexcept;
  82   int pushRetired(hazptr_obj* head, hazptr_obj* tail, int count);
  83   bool reachedThreshold(int rcount);
  84   void tryBulkReclaim();
  85   void bulkReclaim();
  86 };
  87
  88 /** Get the default hazptr_domain */
  89 hazptr_domain& default_hazptr_domain();
  90
  91 extern hazptr_domain default_domain_;
  92
  93 /** Definition of hazptr_obj */
  94 class hazptr_obj {
  95   friend class hazptr_domain;
  96   template <typename, typename>
  97   friend class hazptr_obj_base;
  98   template <typename, typename>
  99   friend class hazptr_obj_base_refcounted;
 100   friend struct hazptr_priv;
 101
 102   void (*reclaim_)(hazptr_obj*);
 103   hazptr_obj* next_;
 104
 105   const void* getObjPtr() const;
 106 };
 107
 108 /** Definition of hazptr_obj_base */
 109 template <typename T, typename D = std::default_delete<T>>
 110 class hazptr_obj_base : public hazptr_obj {
 111  public:
 112   /* Retire a removed object and pass the responsibility for
 113    * reclaiming it to the hazptr library */
 114   void retire(hazptr_domain& domain = default_hazptr_domain(), D reclaim = {});
 115
 116  private:
 117   D deleter_;
 118 };
 119
 120 /** Definition of hazptr_recounted_obj_base */
 121 template <typename T, typename D = std::default_delete<T>>
 122 class hazptr_obj_base_refcounted : public hazptr_obj {
 123  public:
 124   /* Retire a removed object and pass the responsibility for
 125    * reclaiming it to the hazptr library */
 126   void retire(hazptr_domain& domain = default_hazptr_domain(), D reclaim = {});
 127
 128   /* aquire_ref() increments the reference count
 129    *
 130    * acquire_ref_safe() is the same as acquire_ref() except that in
 131    * addition the caller guarantees that the call is made in a
 132    * thread-safe context, e.g., the object is not yet shared. This is
 133    * just an optimization to save an atomic operation.
 134    *
 135    * release_ref() decrements the reference count and returns true if
 136    * the object is safe to reclaim.
 137    */
 138   void acquire_ref();
 139   void acquire_ref_safe();
 140   bool release_ref();
 141
 142  private:
 143   std::atomic<uint32_t> refcount_{0};
 144   D deleter_;
 145 };
 146
 147 /** hazptr_holder: Class for automatic acquisition and release of
 148  *  hazard pointers, and interface for hazard pointer operations. */
 149 class hazptr_holder {
 150   template <size_t M>
 151   friend class hazptr_array;
 152   template <size_t M>
 153   friend class hazptr_local;
 154
 155  public:
 156   /* Constructor automatically acquires a hazard pointer. */
 157   explicit hazptr_holder(hazptr_domain& domain = default_hazptr_domain());
 158   /* Construct an empty hazptr_holder. */
 159   // Note: This diverges from the proposal in P0233R4
 160   explicit hazptr_holder(std::nullptr_t) noexcept;
 161
 162   /* Destructor automatically clears and releases the owned hazard pointer. */
 163   ~hazptr_holder();
 164
 165   hazptr_holder(const hazptr_holder&) = delete;
 166   hazptr_holder& operator=(const hazptr_holder&) = delete;
 167   // Note: This diverges from the proposal in P0233R4 which disallows
 168   // move constructor and assignment operator.
 169   hazptr_holder(hazptr_holder&&) noexcept;
 170   hazptr_holder& operator=(hazptr_holder&&) noexcept;
 171
 172   /** Hazard pointer operations */
 173   /* Returns a protected pointer from the source */
 174   template <typename T>
 175   T* get_protected(const std::atomic<T*>& src) noexcept;
 176   /* Returns a protected pointer from the source, filtering
 177      the protected pointer through function Func.  Useful for
 178      stealing bits of the pointer word */
 179   template <typename T, typename Func>
 180   T* get_protected(const std::atomic<T*>& src, Func f) noexcept;
 181   /* Return true if successful in protecting ptr if src == ptr after
 182    * setting the hazard pointer.  Otherwise sets ptr to src. */
 183   template <typename T>
 184   bool try_protect(T*& ptr, const std::atomic<T*>& src) noexcept;
 185   /* Return true if successful in protecting ptr if src == ptr after
 186    * setting the hazard pointer, filtering the pointer through Func.
 187    * Otherwise sets ptr to src. */
 188   template <typename T, typename Func>
 189   bool try_protect(T*& ptr, const std::atomic<T*>& src, Func f) noexcept;
 190   /* Set the hazard pointer to ptr */
 191   template <typename T>
 192   void reset(const T* ptr) noexcept;
 193   /* Set the hazard pointer to nullptr */
 194   void reset(std::nullptr_t = nullptr) noexcept;
 195
 196   /* Swap ownership of hazard pointers between hazptr_holder-s. */
 197   /* Note: The owned hazard pointers remain unmodified during the swap
 198    * and continue to protect the respective objects that they were
 199    * protecting before the swap, if any. */
 200   void swap(hazptr_holder&) noexcept;
 201
 202  private:
 203   hazptr_domain* domain_;
 204   hazptr_rec* hazptr_;
 205 };
 206
 207 void swap(hazptr_holder&, hazptr_holder&) noexcept;
 208
 209 using aligned_hazptr_holder = typename std::
 210     aligned_storage<sizeof(hazptr_holder), alignof(hazptr_holder)>::type;
 211
 212 /**
 213  *  hazptr_array: Optimized for bulk construction and destruction of
 214  *  hazptr_holder-s.
 215  *
 216  *  WARNING: Do not move from or to individual hazptr_holder-s.
 217  *  Only move the whole hazptr_array.
 218  */
 219 template <size_t M = 1>
 220 class hazptr_array {
 221   static_assert(M > 0, "M must be a positive integer.");
 222
 223  public:
 224   hazptr_array();
 225   explicit hazptr_array(std::nullptr_t) noexcept;
 226
 227   hazptr_array(const hazptr_array&) = delete;
 228   hazptr_array& operator=(const hazptr_array&) = delete;
 229   hazptr_array(hazptr_array&& other) noexcept;
 230   hazptr_array& operator=(hazptr_array&& other) noexcept;
 231
 232   ~hazptr_array();
 233
 234   hazptr_holder& operator[](size_t i) noexcept;
 235
 236  private:
 237   aligned_hazptr_holder raw_[M];
 238   bool empty_{false};
 239 };
 240
 241 /**
 242  *  hazptr_local: Optimized for construction and destruction of
 243  *  one or more hazptr_holder-s with local scope.
 244  *
 245  *  WARNING 1: Do not move from or to individual hazptr_holder-s.
 246  *
 247  *  WARNING 2: There can only be one hazptr_local active for the same
 248  *  thread at any time. This is not tracked and checked by the
 249  *  implementation because it would negate the performance gains of
 250  *  this class.
 251  */
 252 template <size_t M = 1>
 253 class hazptr_local {
 254   static_assert(M > 0, "M must be a positive integer.");
 255
 256  public:
 257   hazptr_local();
 258   hazptr_local(const hazptr_local&) = delete;
 259   hazptr_local& operator=(const hazptr_local&) = delete;
 260   hazptr_local(hazptr_local&&) = delete;
 261   hazptr_local& operator=(hazptr_local&&) = delete;
 262
 263   ~hazptr_local();
 264
 265   hazptr_holder& operator[](size_t i) noexcept;
 266
 267  private:
 268   aligned_hazptr_holder raw_[M];
 269   bool need_destruct_{false};
 270 };
 271
 272 } // namespace hazptr
 273 } // namespace folly
 274
 275 #include "hazptr-impl.h"