folly/Launder.h

   1 /*
   2  * Copyright 2017-present 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 #pragma once
  18
  19 #include <folly/CPortability.h>
  20 #include <folly/Portability.h>
  21
  22 namespace folly {
  23
  24 /**
  25  * Approximate backport from C++17 of std::launder. It should be `constexpr`
  26  * but that can't be done without specific support from the compiler.
  27  */
  28 template <typename T>
  29 FOLLY_NODISCARD inline T* launder(T* in) noexcept {
  30 #if FOLLY_HAS_BUILTIN(__builtin_launder) || __GNUC__ >= 7
  31   // The builtin has no unwanted side-effects.
  32   return __builtin_launder(in);
  33 #elif __GNUC__
  34   // This inline assembler block declares that `in` is an input and an output,
  35   // so the compiler has to assume that it has been changed inside the block.
  36   __asm__("" : "+r"(in));
  37   return in;
  38 #elif defined(_WIN32)
  39   // MSVC does not currently have optimizations around const members of structs.
  40   // _ReadWriteBarrier() will prevent compiler reordering memory accesses.
  41   _ReadWriteBarrier();
  42   return in;
  43 #else
  44   static_assert(
  45       false, "folly::launder is not implemented for this environment");
  46 #endif
  47 }
  48
  49 /* The standard explicitly forbids laundering these */
  50 void launder(void*) = delete;
  51 void launder(void const*) = delete;
  52 void launder(void volatile*) = delete;
  53 void launder(void const volatile*) = delete;
  54 template <typename T, typename... Args>
  55 void launder(T (*)(Args...)) = delete;
  56 } // namespace folly