summaryrefslogtreecommitdiffstats
path: root/clib/builtin.h
blob: 5a7ac08fc7106091bacde79e63ffcad1402ef09e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: clib/builtin.h $                                              */
/*                                                                        */
/* OpenPOWER FFS Project                                                  */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2014,2015                        */
/* [+] International Business Machines Corp.                              */
/*                                                                        */
/*                                                                        */
/* Licensed under the Apache License, Version 2.0 (the "License");        */
/* you may not use this file except in compliance with the License.       */
/* You may obtain a copy of the License at                                */
/*                                                                        */
/*     http://www.apache.org/licenses/LICENSE-2.0                         */
/*                                                                        */
/* Unless required by applicable law or agreed to in writing, software    */
/* distributed under the License is distributed on an "AS IS" BASIS,      */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or        */
/* implied. See the License for the specific language governing           */
/* permissions and limitations under the License.                         */
/*                                                                        */
/* IBM_PROLOG_END_TAG                                                     */

/*! @file builtin.h
 *  @brief Builtin Function Macros
 *  @author Shaun Wetzstein <shaun@us.ibm.com>
 *  @date 2010-2011
 */

#ifndef __BUILTIN_H__
#define __BUILTIN_H__

/*!
 * @def likely(x)
 * @hideinitializer
 * @brief Indicate an expression is likely to occur
 * @param x [in] Expression
 */
#define likely(x)		__builtin_expect(!!(x), 1)

/*!
 * @def unlikely(x)
 * @hideinitializer
 * @brief Indicate an expression is unlikely to occur
 * @param x [in] Expression
 */
#define unlikely(x)		__builtin_expect(!!(x), 0)

/*!
 * @def parity(x)
 * @hideinitializer
 * @brief Return parity of the input
 * @param x [in] Object
 */
#define	parity(x)		__builtin_parity((x))
#define	ffs(x)			__builtin_ffs((x))

/*!
 * @def popcount(x)
 * @hideinitializer
 * @brief Return number of 0b'1' bits of an int
 * @param x [in] Object
 */
#define	popcount(x)		__builtin_popcount((x))

/*!
 * @def ctz(x)
 * @hideinitializer
 * @brief Count trailing zeros of an int
 * @param x [in] @em int value
 */
#define	ctz(x)			__builtin_ctz((x))

/*!
 * @def ctzl(x)
 * @hideinitializer
 * @brief Count trailing zeros of a long
 * @param x [in] @em long value
 */
#define	ctzl(x)			__builtin_ctzl((x))

/*!
 * @def ctzll(x)
 * @hideinitializer
 * @brief Count trailing zeros of a long long
 * @param x [in] @em long @em long value
 */
#define	ctzll(x)		__builtin_ctzll((x))

/*!
 * @def clz(x)
 * @hideinitializer
 * @brief Count leading zeros of an int
 * @param x [in] @em int value
 */
#define	clz(x)			__builtin_clzl((x))

/*!
 * @def clzl(x)
 * @hideinitializer
 * @brief Count leading zeros of a long
 * @param x [in] @em long value
 */
#define	clzl(x)			__builtin_clzl((x))

/*!
 * @def clzll(x)
 * @hideinitializer
 * @brief Count leading zeros of a long long
 * @param x [in] @em long long value
 */
#define	clzll(x)		__builtin_clzll((x))

/*!
 * @def caller(x)
 * @hideinitializer
 * @brief Return callers return address
 * @param x [in] Function name
 */
#define caller(x)		__builtin_return_address((x))

#define choose_expr(x,y,z)	__builtin_choose_expr((x),(y),(z))

/*!
 * @def const_expr(x)
 * @hideinitializer
 * @brief Return callers return address
 * @param x [in] Function name
 */
#define const_expr(x)		__builtin_constant_p((x))

/*!
 * @def compatible_type(x)
 * @hideinitializer
 * @brief Return @em true if typeof(x) and typeof(y) are compatible
 * @param x [in] Type name
 * @param y [in] Type name
 */
#define compatible_type(x,y)	__builtin_types_compatible_p((x),(y))

#endif				/* __BUILTIN_H__ */
OpenPOWER on IntegriCloud