Mark constructing an Unexpected as cold
[folly.git] / folly / CppAttributes.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  * GCC compatible wrappers around clang attributes.
19  *
20  * @author Dominik Gabi
21  */
22
23 #pragma once
24
25 #ifndef __has_attribute
26 #define FOLLY_HAS_ATTRIBUTE(x) 0
27 #else
28 #define FOLLY_HAS_ATTRIBUTE(x) __has_attribute(x)
29 #endif
30
31 #ifndef __has_cpp_attribute
32 #define FOLLY_HAS_CPP_ATTRIBUTE(x) 0
33 #else
34 #define FOLLY_HAS_CPP_ATTRIBUTE(x) __has_cpp_attribute(x)
35 #endif
36
37 #ifndef __has_extension
38 #define FOLLY_HAS_EXTENSION(x) 0
39 #else
40 #define FOLLY_HAS_EXTENSION(x) __has_extension(x)
41 #endif
42
43 /**
44  * Fallthrough to indicate that `break` was left out on purpose in a switch
45  * statement, e.g.
46  *
47  * switch (n) {
48  *   case 22:
49  *   case 33:  // no warning: no statements between case labels
50  *     f();
51  *   case 44:  // warning: unannotated fall-through
52  *     g();
53  *     FOLLY_FALLTHROUGH; // no warning: annotated fall-through
54  * }
55  */
56 #if FOLLY_HAS_CPP_ATTRIBUTE(clang::fallthrough)
57 #define FOLLY_FALLTHROUGH [[clang::fallthrough]]
58 #else
59 #define FOLLY_FALLTHROUGH
60 #endif
61
62 /**
63  *  Maybe_unused indicates that a function, variable or parameter might or
64  *  might not be used, e.g.
65  *
66  *  int foo(FOLLY_MAYBE_UNUSED int x) {
67  *    #ifdef USE_X
68  *      return x;
69  *    #else
70  *      return 0;
71  *    #endif
72  *  }
73  */
74 #if FOLLY_HAS_CPP_ATTRIBUTE(maybe_unused)
75 #define FOLLY_MAYBE_UNUSED [[maybe_unused]]
76 #elif FOLLY_HAS_ATTRIBUTE(__unused__) || __GNUC__
77 #define FOLLY_MAYBE_UNUSED __attribute__((__unused__))
78 #else
79 #define FOLLY_MAYBE_UNUSED
80 #endif
81
82 /**
83  * Nullable indicates that a return value or a parameter may be a `nullptr`,
84  * e.g.
85  *
86  * int* FOLLY_NULLABLE foo(int* a, int* FOLLY_NULLABLE b) {
87  *   if (*a > 0) {  // safe dereference
88  *     return nullptr;
89  *   }
90  *   if (*b < 0) {  // unsafe dereference
91  *     return *a;
92  *   }
93  *   if (b != nullptr && *b == 1) {  // safe checked dereference
94  *     return new int(1);
95  *   }
96  *   return nullptr;
97  * }
98  */
99 #if FOLLY_HAS_EXTENSION(nullability)
100 #define FOLLY_NULLABLE _Nullable
101 #define FOLLY_NONNULL _Nonnull
102 #else
103 #define FOLLY_NULLABLE
104 #define FOLLY_NONNULL
105 #endif
106
107 /**
108  * "Cold" indicates to the compiler that a function is only expected to be
109  * called from unlikely code paths. It can affect decisions made by the
110  * optimizer both when processing the function body and when analyzing
111  * call-sites.
112  */
113 #if __GNUC__
114 #define FOLLY_COLD __attribute__((__cold__))
115 #else
116 #define FOLLY_COLD
117 #endif