folly/Assume.h

   1 /*
   2  * Copyright 2016 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/Portability.h>
  20 #include <glog/logging.h>
  21
  22 namespace folly {
  23
  24 /**
  25  * Inform the compiler that the argument can be assumed true. It is
  26  * undefined behavior if the argument is not actually true, so use
  27  * with care.
  28  *
  29  * Implemented as a function instead of a macro because
  30  * __builtin_assume does not evaluate its argument at runtime, so it
  31  * cannot be used with expressions that have side-effects.
  32  */
  33
  34 FOLLY_ALWAYS_INLINE void assume(bool cond) {
  35 #ifndef NDEBUG
  36   DCHECK(cond);
  37 #elif defined(__clang__)  // Must go first because Clang also defines __GNUC__.
  38   __builtin_assume(cond);
  39 #elif defined(__GNUC__)
  40   if (!cond) { __builtin_unreachable(); }
  41 #elif defined(_MSC_VER)
  42   __assume(cond);
  43 #else
  44   // Do nothing.
  45 #endif
  46 }
  47
  48 }  // namespace folly