summaryrefslogtreecommitdiff
path: root/compiler/simpleops-compiler-utils.h
blob: 187386dcfc7e427973eefe6b4d81d221579ab3cf (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
/* -*- Mode: c; c-basic-offset: 4; indent-tabs-mode: t; tab-width: 8; -*- */
/*
 * Copyright 2010-2011 Andrea Canciani
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use, copy,
 * modify, merge, publish, distribute, sublicense, and/or sell copies
 * of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 * Author(s): Andrea Canciani <ranma42@gmail.com>
 */

#ifndef SIMPLEOPS_COMPILER_UTILS_H
#define SIMPLEOPS_COMPILER_UTILS_H

#ifndef SIMPLEOPS_COMPILER_H
#error Private header used directly
#endif

/**
 * Computes the number of elements of an array
 */
#define SIMPLEOPS_ARRAY_LENGTH(x) (sizeof (x) / sizeof (x[0]))

#define _SIMPLEOPS_CONCAT(x,y) x ## y
#define _SIMPLEOPS_RESOLVE_CONCAT(x,y) _SIMPLEOPS_CONCAT(x,y)

/**
 * Prepends the SIMPLEOPS_PREFIX to the argument.
 *
 * This macro is used to generate non-static identifiers that do not
 * collide across multiple libraries. In order to use it,
 * SIMPLEOPS_PREFIX should be defined to an appropriate identifier.
 */
#define SIMPLEOPS_ADD_PREFIX(x) _SIMPLEOPS_RESOLVE_CONCAT(SIMPLEOPS_PREFIX, x)

#define _SIMPLEOPS_COMPILE_TIME_RAW_ASSERT(condition, line)		\
    typedef int compile_time_assertion_at_line_##line##_failed [(condition)?1:-1]
#define _SIMPLEOPS_COMPILE_TIME_RESOLVE_ASSERT(condition, line)	\
    _SIMPLEOPS_COMPILE_TIME_RAW_ASSERT(condition, line)

/**
 * Asserts that the condition is TRUE at compile time.
 *
 * Conditions that cannot be evaluated at compile time cannot be used
 * in these assertions.
 */
#define SIMPLEOPS_COMPILE_TIME_ASSERT(condition)	\
    _SIMPLEOPS_COMPILE_TIME_RESOLVE_ASSERT(condition, __LINE__)


#if defined(__GNUC__) && (__GNUC__ > 2) && defined(__OPTIMIZE__)

#define _SIMPLEOPS_BOOLEAN_EXPR(expr) ((expr) ? TRUE : FALSE)

#define SIMPLEOPS_LIKELY(expr) \
    (__builtin_expect (_SIMPLEOPS_BOOLEAN_EXPR (expr), TRUE))
#define SIMPLEOPS_UNLIKELY(expr) \
    (__builtin_expect (_SIMPLEOPS_BOOLEAN_EXPR (expr), FALSE))

#else

/**
 * Provides an hint to the compiler that the expression is probably
 * going to be TRUE and evaluates to the value of the expression.
 */
#define SIMPLEOPS_LIKELY(expr) (expr)

/**
 * Provides an hint to the compiler that the expression is probably
 * going to be FALSE and evaluates to the value of the expression.
 */
#define SIMPLEOPS_UNLIKELY(expr) (expr)
#endif

/**
 * Computes the address of a structure given its type and the address
 * and name of one of its fields.
 */
#define SIMPLEOPS_CONTAINER_OF(ptr, type, member)	\
    ((type*)(((char *) ptr) - offsetof (type, member)))

#endif