folly/Likely.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 /**
  18  * Compiler hints to indicate the fast path of an "if" branch: whether
  19  * the if condition is likely to be true or false.
  20  *
  21  * @author Tudor Bosman (tudorb@fb.com)
  22  */
  23
  24 #pragma once
  25
  26 #undef LIKELY
  27 #undef UNLIKELY
  28
  29 #if defined(__GNUC__) && __GNUC__ >= 4
  30 #define LIKELY(x)   (__builtin_expect((x), 1))
  31 #define UNLIKELY(x) (__builtin_expect((x), 0))
  32 #else
  33 #define LIKELY(x)   (x)
  34 #define UNLIKELY(x) (x)
  35 #endif