summaryrefslogtreecommitdiff
path: root/kern/macros.h
blob: 23ad4d22606db18614b2f3b08d9c3279a2dfe7fc (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
/*
 * Copyright (c) 2009, 2010, 2013 Richard Braun.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *
 * Helper macros.
 *
 * This file is a top header in the inclusion hierarchy, and shouldn't include
 * other headers that may cause circular dependencies.
 */

#ifndef _KERN_MACROS_H
#define _KERN_MACROS_H

#if !defined(__GNUC__) || (__GNUC__ < 4)
#error "GCC 4+ required"
#endif

/*
 * Attributes for variables that are mostly read and seldom changed.
 */
#define __read_mostly __section(".data.read_mostly")

#define MACRO_BEGIN         ({
#define MACRO_END           })

#define __QUOTE(x)          #x
#define QUOTE(x)            __QUOTE(x)

#ifdef __ASSEMBLER__
#define DECL_CONST(x, s)    x
#else /* __ASSEMBLER__ */
#define __DECL_CONST(x, s)  x##s
void cga_putc(char c);

static inline void
moo_print(const char *s)
{
    while (*s != '\0') {
        cga_putc(*s);
        s++;
    }
}
#define DECL_CONST(x, s)    __DECL_CONST(x, s)
#endif /* __ASSEMBLER__ */

#define STRLEN(x)           (sizeof(x) - 1)
#define ARRAY_SIZE(x)       (sizeof(x) / sizeof((x)[0]))

#define MIN(a, b)           ((a) < (b) ? (a) : (b))
#define MAX(a, b)           ((a) > (b) ? (a) : (b))

#define DIV_CEIL(n, d)      (((n) + (d) - 1) / (d))

#define P2ALIGNED(x, a)     (((x) & ((a) - 1)) == 0)
#define ISP2(x)             P2ALIGNED(x, x)
#define P2ALIGN(x, a)       ((x) & -(a))        /* decreases if not aligned */
#define P2ROUND(x, a)       (-(-(x) & -(a)))    /* increases if not aligned */
#define P2END(x, a)         (-(~(x) & -(a)))    /* always increases */

#define structof(ptr, type, member) \
    ((type *)((char *)(ptr) - offsetof(type, member)))

#define likely(expr)        __builtin_expect(!!(expr), 1)
#define unlikely(expr)      __builtin_expect(!!(expr), 0)

#define barrier()           asm volatile("" : : : "memory")

/*
 * The following macros may be provided by the C environment.
 */

#ifndef __noinline
#define __noinline          __attribute__((noinline))
#endif

#ifndef __always_inline
#define __always_inline     inline __attribute__((always_inline))
#endif

#ifndef __section
#define __section(x)        __attribute__((section(x)))
#endif

#ifndef __packed
#define __packed            __attribute__((packed))
#endif

#ifndef __unused
#define __unused            __attribute__((unused))
#endif

#ifndef __used
#define __used              __attribute__((used))
#endif

#ifndef __fallthrough
#if __GNUC__ >= 7
#define __fallthrough       __attribute__((fallthrough))
#else
/* TODO: clang 6 might add support for -Wimplicit-fallthrough */
#define __fallthrough
#endif
#endif

#endif /* _KERN_MACROS_H */