socket-util: New function xset_nonblocking().
[openvswitch] / lib / compiler.h
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, 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 #ifndef COMPILER_H
18 #define COMPILER_H 1
19
20 #if __GNUC__ && !__CHECKER__
21 #define NO_RETURN __attribute__((__noreturn__))
22 #define OVS_UNUSED __attribute__((__unused__))
23 #define PRINTF_FORMAT(FMT, ARG1) __attribute__((__format__(printf, FMT, ARG1)))
24 #define STRFTIME_FORMAT(FMT) __attribute__((__format__(__strftime__, FMT, 0)))
25 #define MALLOC_LIKE __attribute__((__malloc__))
26 #define ALWAYS_INLINE __attribute__((always_inline))
27 #define WARN_UNUSED_RESULT __attribute__((__warn_unused_result__))
28 #define SENTINEL(N) __attribute__((sentinel(N)))
29 #else
30 #define NO_RETURN
31 #define OVS_UNUSED
32 #define PRINTF_FORMAT(FMT, ARG1)
33 #define STRFTIME_FORMAT(FMT)
34 #define MALLOC_LIKE
35 #define ALWAYS_INLINE
36 #define WARN_UNUSED_RESULT
37 #define SENTINEL(N)
38 #endif
39
40 /* ISO C says that a C implementation may choose any integer type for an enum
41  * that is sufficient to hold all of its values.  Common ABIs (such as the
42  * System V ABI used on i386 GNU/Linux) always use a full-sized "int", even
43  * when a smaller type would suffice.
44  *
45  * In GNU C, "enum __attribute__((packed)) name { ... }" defines 'name' as an
46  * enum compatible with a type that is no bigger than necessary.  This is the
47  * intended use of OVS_PACKED_ENUM.
48  *
49  * OVS_PACKED_ENUM is intended for use only as a space optimization, since it
50  * only works with GCC.  That means that it must not be used in wire protocols
51  * or otherwise exposed outside of a single process. */
52 #if __GNUC__ && !__CHECKER__
53 #define OVS_PACKED_ENUM __attribute__((__packed__))
54 #else
55 #define OVS_PACKED_ENUM
56 #endif
57
58 #endif /* compiler.h */