xref: /optee_os/lib/libutils/ext/include/compiler.h (revision b18dfc622d4b24249738fdc48257b1ab9bd1f12f)
1 /*
2  * Copyright (c) 2014, STMicroelectronics International N.V.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation
13  * and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
19  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25  * POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #ifndef COMPILER_H
29 #define COMPILER_H
30 
31 /*
32  * Macros that should be used instead of using __attribute__ directly to
33  * ease portability and make the code easier to read.
34  */
35 
36 #define __deprecated	__attribute__((deprecated))
37 #define __packed	__attribute__((packed))
38 #define __weak		__attribute__((weak))
39 #define __noreturn	__attribute__((noreturn))
40 #define __pure		__attribute__((pure))
41 #define __aligned(x)	__attribute__((aligned(x)))
42 #define __printf(a, b)	__attribute__((format(printf, a, b)))
43 #define __noinline	__attribute__((noinline))
44 #define __attr_const	__attribute__((__const__))
45 #define __unused	__attribute__((unused))
46 #define __maybe_unused	__attribute__((unused))
47 #define __used		__attribute__((__used__))
48 #define __must_check	__attribute__((warn_unused_result))
49 #define __cold		__attribute__((__cold__))
50 #define __section(x)	__attribute__((section(x)))
51 #define __data		__section(".data")
52 #define __bss		__section(".bss")
53 #define __rodata	__section(".rodata")
54 #define __rodata_unpaged __section(".rodata.__unpaged")
55 #define __early_bss	__section(".early_bss")
56 
57 #define __compiler_bswap64(x)	__builtin_bswap64((x))
58 #define __compiler_bswap32(x)	__builtin_bswap32((x))
59 #define __compiler_bswap16(x)	__builtin_bswap16((x))
60 
61 #endif /*COMPILER_H*/
62