folly/experimental/hazptr/hazptr-impl.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
  17 /* override-include-guard */
  18 #ifndef HAZPTR_H
  19 #error "This should only be included by hazptr.h"
  20 #endif
  21
  22 #include <folly/experimental/hazptr/debug.h>
  23
  24 #include <unordered_set>
  25
  26 namespace folly {
  27 namespace hazptr {
  28
  29 /** hazptr_domain */
  30
  31 constexpr hazptr_domain::hazptr_domain(memory_resource* mr) noexcept
  32     : mr_(mr) {}
  33
  34 /** hazptr_obj_base */
  35
  36 template <typename T, typename D>
  37 inline void hazptr_obj_base<T, D>::retire(hazptr_domain& domain, D deleter) {
  38   DEBUG_PRINT(this << " " << &domain);
  39   deleter_ = std::move(deleter);
  40   reclaim_ = [](hazptr_obj* p) {
  41     auto hobp = static_cast<hazptr_obj_base*>(p);
  42     auto obj = static_cast<T*>(hobp);
  43     hobp->deleter_(obj);
  44   };
  45   domain.objRetire(this);
  46 }
  47
  48 /** hazptr_rec */
  49
  50 class hazptr_rec {
  51   friend class hazptr_domain;
  52   template <typename> friend class hazptr_owner;
  53
  54   std::atomic<const void*> hazptr_ = {nullptr};
  55   hazptr_rec* next_ = {nullptr};
  56   std::atomic<bool> active_ = {false};
  57
  58   void set(const void* p) noexcept;
  59   const void* get() const noexcept;
  60   void clear() noexcept;
  61   void release() noexcept;
  62 };
  63
  64 /** hazptr_owner */
  65
  66 template <typename T>
  67 inline hazptr_owner<T>::hazptr_owner(hazptr_domain& domain) {
  68   domain_ = &domain;
  69   hazptr_ = domain_->hazptrAcquire();
  70   DEBUG_PRINT(this << " " << domain_ << " " << hazptr_);
  71   if (hazptr_ == nullptr) { std::bad_alloc e; throw e; }
  72 }
  73
  74 template <typename T>
  75 hazptr_owner<T>::~hazptr_owner() {
  76   DEBUG_PRINT(this);
  77   domain_->hazptrRelease(hazptr_);
  78 }
  79
  80 template <typename T>
  81 template <typename A>
  82 inline bool hazptr_owner<T>::try_protect(T*& ptr, const A& src) noexcept {
  83   static_assert(
  84       std::is_same<decltype(std::declval<A>().load()), T*>::value,
  85       "Return type of A::load() must be T*");
  86   DEBUG_PRINT(this << " " << ptr << " " << &src);
  87   set(ptr);
  88   T* p = src.load();
  89   if (p != ptr) {
  90     ptr = p;
  91     clear();
  92     return false;
  93   }
  94   return true;
  95 }
  96
  97 template <typename T>
  98 template <typename A>
  99 inline T* hazptr_owner<T>::get_protected(const A& src) noexcept {
 100   static_assert(
 101       std::is_same<decltype(std::declval<A>().load()), T*>::value,
 102       "Return type of A::load() must be T*");
 103   T* p = src.load();
 104   while (!try_protect(p, src)) {}
 105   DEBUG_PRINT(this << " " << p << " " << &src);
 106   return p;
 107 }
 108
 109 template <typename T>
 110 inline void hazptr_owner<T>::set(const T* ptr) noexcept {
 111   auto p = static_cast<hazptr_obj*>(const_cast<T*>(ptr));
 112   DEBUG_PRINT(this << " " << ptr << " p:" << p);
 113   hazptr_->set(p);
 114 }
 115
 116 template <typename T>
 117 inline void hazptr_owner<T>::clear() noexcept {
 118   DEBUG_PRINT(this);
 119   hazptr_->clear();
 120 }
 121
 122 template <typename T>
 123 inline void hazptr_owner<T>::swap(hazptr_owner<T>& rhs) noexcept {
 124   DEBUG_PRINT(
 125     this << " " <<  this->hazptr_ << " " << this->domain_ << " -- "
 126     << &rhs << " " << rhs.hazptr_ << " " << rhs.domain_);
 127   std::swap(this->domain_, rhs.domain_);
 128   std::swap(this->hazptr_, rhs.hazptr_);
 129 }
 130
 131 template <typename T>
 132 inline void swap(hazptr_owner<T>& lhs, hazptr_owner<T>& rhs) noexcept {
 133   lhs.swap(rhs);
 134 }
 135
 136 ////////////////////////////////////////////////////////////////////////////////
 137 // Non-template part of implementation
 138 ////////////////////////////////////////////////////////////////////////////////
 139 // [TODO]:
 140 // - Thread caching of hazptr_rec-s
 141 // - Private storage of retired objects
 142 // - Control of reclamation (when and by whom)
 143 // - Optimized memory order
 144
 145 /** Definition of default_hazptr_domain() */
 146 inline hazptr_domain& default_hazptr_domain() {
 147   static hazptr_domain d;
 148   DEBUG_PRINT(&d);
 149   return d;
 150 }
 151
 152 /** hazptr_rec */
 153
 154 inline void hazptr_rec::set(const void* p) noexcept {
 155   DEBUG_PRINT(this << " " << p);
 156   hazptr_.store(p);
 157 }
 158
 159 inline const void* hazptr_rec::get() const noexcept {
 160   DEBUG_PRINT(this << " " << hazptr_.load());
 161   return hazptr_.load();
 162 }
 163
 164 inline void hazptr_rec::clear() noexcept {
 165   DEBUG_PRINT(this);
 166   hazptr_.store(nullptr);
 167 }
 168
 169 inline void hazptr_rec::release() noexcept {
 170   DEBUG_PRINT(this);
 171   clear();
 172   active_.store(false);
 173 }
 174
 175 /** hazptr_obj */
 176
 177 inline const void* hazptr_obj::getObjPtr() const {
 178   DEBUG_PRINT(this);
 179   return this;
 180 }
 181
 182 /** hazptr_domain */
 183
 184 inline hazptr_domain::~hazptr_domain() {
 185   DEBUG_PRINT(this);
 186   { /* free all hazptr_rec-s */
 187     hazptr_rec* next;
 188     for (auto p = hazptrs_.load(); p; p = next) {
 189       next = p->next_;
 190       mr_->deallocate(static_cast<void*>(p), sizeof(hazptr_rec));
 191     }
 192   }
 193   { /* reclaim all remaining retired objects */
 194     hazptr_obj* next;
 195     for (auto p = retired_.load(); p; p = next) {
 196       next = p->next_;
 197       (*(p->reclaim_))(p);
 198     }
 199   }
 200 }
 201
 202 inline void hazptr_domain::try_reclaim() {
 203   DEBUG_PRINT(this);
 204   rcount_.exchange(0);
 205   bulkReclaim();
 206 }
 207
 208 inline hazptr_rec* hazptr_domain::hazptrAcquire() {
 209   hazptr_rec* p;
 210   hazptr_rec* next;
 211   for (p = hazptrs_.load(); p; p = next) {
 212     next = p->next_;
 213     bool active = p->active_.load();
 214     if (!active) {
 215       if (p->active_.compare_exchange_weak(active, true)) {
 216         DEBUG_PRINT(this << " " << p);
 217         return p;
 218       }
 219     }
 220   }
 221   p = static_cast<hazptr_rec*>(mr_->allocate(sizeof(hazptr_rec)));
 222   if (p == nullptr) {
 223     return nullptr;
 224   }
 225   p->active_.store(true);
 226   do {
 227     p->next_ = hazptrs_.load();
 228     if (hazptrs_.compare_exchange_weak(p->next_, p)) {
 229       break;
 230     }
 231   } while (true);
 232   auto hcount = hcount_.fetch_add(1);
 233   DEBUG_PRINT(this << " " << p << " " << sizeof(hazptr_rec) << " " << hcount);
 234   return p;
 235 }
 236
 237 inline void hazptr_domain::hazptrRelease(hazptr_rec* p) noexcept {
 238   DEBUG_PRINT(this << " " << p);
 239   p->release();
 240 }
 241
 242 inline int
 243 hazptr_domain::pushRetired(hazptr_obj* head, hazptr_obj* tail, int count) {
 244   tail->next_ = retired_.load();
 245   while (!retired_.compare_exchange_weak(tail->next_, head)) {}
 246   return rcount_.fetch_add(count);
 247 }
 248
 249 inline void hazptr_domain::objRetire(hazptr_obj* p) {
 250   auto rcount = pushRetired(p, p, 1) + 1;
 251   if (rcount >= kScanThreshold * hcount_.load()) {
 252     tryBulkReclaim();
 253   }
 254 }
 255
 256 inline void hazptr_domain::tryBulkReclaim() {
 257   DEBUG_PRINT(this);
 258   do {
 259     auto hcount = hcount_.load();
 260     auto rcount = rcount_.load();
 261     if (rcount < kScanThreshold * hcount) {
 262       return;
 263     }
 264     if (rcount_.compare_exchange_weak(rcount, 0)) {
 265       break;
 266     }
 267   } while (true);
 268   bulkReclaim();
 269 }
 270
 271 inline void hazptr_domain::bulkReclaim() {
 272   DEBUG_PRINT(this);
 273   auto p = retired_.exchange(nullptr);
 274   auto h = hazptrs_.load();
 275   std::unordered_set<const void*> hs;
 276   for (; h; h = h->next_) {
 277     hs.insert(h->hazptr_.load());
 278   }
 279   int rcount = 0;
 280   hazptr_obj* retired = nullptr;
 281   hazptr_obj* tail = nullptr;
 282   hazptr_obj* next;
 283   for (; p; p = next) {
 284     next = p->next_;
 285     if (hs.count(p->getObjPtr()) == 0) {
 286       DEBUG_PRINT(this << " " << p << " " << p->reclaim_);
 287       (*(p->reclaim_))(p);
 288     } else {
 289       p->next_ = retired;
 290       retired = p;
 291       if (tail == nullptr) {
 292         tail = p;
 293       }
 294       ++rcount;
 295     }
 296   }
 297   if (tail) {
 298     pushRetired(retired, tail, rcount);
 299   }
 300 }
 301
 302 } // namespace folly
 303 } // namespace hazptr