qualcomm/qbox
Loading...
Searching...
No Matches
incbin.h
Go to the documentation of this file.
1
9
18#ifndef INCBIN_HDR
19#define INCBIN_HDR
20#include <limits.h>
21#if defined(__AVX512BW__) || defined(__AVX512CD__) || defined(__AVX512DQ__) || defined(__AVX512ER__) || \
22 defined(__AVX512PF__) || defined(__AVX512VL__) || defined(__AVX512F__)
23#define INCBIN_ALIGNMENT_INDEX 6
24#elif defined(__AVX__) || defined(__AVX2__)
25#define INCBIN_ALIGNMENT_INDEX 5
26#elif defined(__SSE__) || defined(__SSE2__) || defined(__SSE3__) || defined(__SSSE3__) || defined(__SSE4_1__) || \
27 defined(__SSE4_2__) || defined(__neon__) || defined(__ARM_NEON) || defined(__ALTIVEC__)
28#define INCBIN_ALIGNMENT_INDEX 4
29#elif ULONG_MAX != 0xffffffffu
30#define INCBIN_ALIGNMENT_INDEX 3
31#else
32#define INCBIN_ALIGNMENT_INDEX 2
33#endif
34
35/* Lookup table of (1 << n) where `n' is `INCBIN_ALIGNMENT_INDEX' */
36#define INCBIN_ALIGN_SHIFT_0 1
37#define INCBIN_ALIGN_SHIFT_1 2
38#define INCBIN_ALIGN_SHIFT_2 4
39#define INCBIN_ALIGN_SHIFT_3 8
40#define INCBIN_ALIGN_SHIFT_4 16
41#define INCBIN_ALIGN_SHIFT_5 32
42#define INCBIN_ALIGN_SHIFT_6 64
43
44/* Actual alignment value */
45#define INCBIN_ALIGNMENT INCBIN_CONCATENATE(INCBIN_CONCATENATE(INCBIN_ALIGN_SHIFT, _), INCBIN_ALIGNMENT_INDEX)
46
47/* Stringize */
48#define INCBIN_STR(X) #X
49#define INCBIN_STRINGIZE(X) INCBIN_STR(X)
50/* Concatenate */
51#define INCBIN_CAT(X, Y) X##Y
52#define INCBIN_CONCATENATE(X, Y) INCBIN_CAT(X, Y)
53/* Deferred macro expansion */
54#define INCBIN_EVAL(X) X
55#define INCBIN_INVOKE(N, ...) INCBIN_EVAL(N(__VA_ARGS__))
56/* Variable argument count for overloading by arity */
57#define INCBIN_VA_ARG_COUNTER(_1, _2, _3, N, ...) N
58#define INCBIN_VA_ARGC(...) INCBIN_VA_ARG_COUNTER(__VA_ARGS__, 3, 2, 1, 0)
59
60/* Green Hills uses a different directive for including binary data */
61#if defined(__ghs__)
62#if (__ghs_asm == 2)
63#define INCBIN_MACRO ".file"
64/* Or consider the ".myrawdata" entry in the ld file */
65#else
66#define INCBIN_MACRO "\tINCBIN"
67#endif
68#else
69#define INCBIN_MACRO ".incbin"
70#endif
71
72#ifndef _MSC_VER
73#define INCBIN_ALIGN __attribute__((aligned(INCBIN_ALIGNMENT)))
74#else
75#define INCBIN_ALIGN __declspec(align(INCBIN_ALIGNMENT))
76#endif
77
78#if defined(__arm__) || /* GNU C and RealView */ \
79 defined(__arm) || /* Diab */ \
80 defined(_ARM) /* ImageCraft */
81#define INCBIN_ARM
82#endif
83
84#ifdef __GNUC__
85/* Utilize .balign where supported */
86#define INCBIN_ALIGN_HOST ".balign " INCBIN_STRINGIZE(INCBIN_ALIGNMENT) "\n"
87#define INCBIN_ALIGN_BYTE ".balign 1\n"
88#elif defined(INCBIN_ARM)
89/*
90 * On arm assemblers, the alignment value is calculated as (1 << n) where `n' is
91 * the shift count. This is the value passed to `.align'
92 */
93#define INCBIN_ALIGN_HOST ".align " INCBIN_STRINGIZE(INCBIN_ALIGNMENT_INDEX) "\n"
94#define INCBIN_ALIGN_BYTE ".align 0\n"
95#else
96/* We assume other inline assembler's treat `.align' as `.balign' */
97#define INCBIN_ALIGN_HOST ".align " INCBIN_STRINGIZE(INCBIN_ALIGNMENT) "\n"
98#define INCBIN_ALIGN_BYTE ".align 1\n"
99#endif
100
101/* INCBIN_CONST is used by incbin.c generated files */
102#if defined(__cplusplus)
103#define INCBIN_EXTERNAL extern "C"
104#define INCBIN_CONST extern const
105#else
106#define INCBIN_EXTERNAL extern
107#define INCBIN_CONST const
108#endif
109
117#if !defined(INCBIN_OUTPUT_SECTION)
118#if defined(__APPLE__)
119#define INCBIN_OUTPUT_SECTION ".const_data"
120#else
121#define INCBIN_OUTPUT_SECTION ".rodata"
122#endif
123#endif
124
131#if !defined(INCBIN_OUTPUT_DATA_SECTION)
132#define INCBIN_OUTPUT_DATA_SECTION INCBIN_OUTPUT_SECTION
133#endif
134
145#if !defined(INCBIN_OUTPUT_SIZE_SECTION)
146#define INCBIN_OUTPUT_SIZE_SECTION INCBIN_OUTPUT_SECTION
147#endif
148
149#if defined(__APPLE__)
150#include "TargetConditionals.h"
151#if defined(TARGET_OS_IPHONE) && !defined(INCBIN_SILENCE_BITCODE_WARNING)
152#warning \
153 "incbin is incompatible with bitcode. Using the library will break upload to App Store if you have bitcode enabled. Add `#define INCBIN_SILENCE_BITCODE_WARNING` before including this header to silence this warning."
154#endif
155/* The directives are different for Apple branded compilers */
156#define INCBIN_SECTION INCBIN_OUTPUT_SECTION "\n"
157#define INCBIN_GLOBAL(NAME) ".globl " INCBIN_MANGLE INCBIN_STRINGIZE(INCBIN_PREFIX) #NAME "\n"
158#define INCBIN_INT ".long "
159#define INCBIN_MANGLE "_"
160#define INCBIN_BYTE ".byte "
161#define INCBIN_TYPE(...)
162#else
163#define INCBIN_SECTION ".section " INCBIN_OUTPUT_SECTION "\n"
164#define INCBIN_GLOBAL(NAME) ".global " INCBIN_STRINGIZE(INCBIN_PREFIX) #NAME "\n"
165#if defined(__ghs__)
166#define INCBIN_INT ".word "
167#else
168#define INCBIN_INT ".int "
169#endif
170#if defined(__USER_LABEL_PREFIX__)
171#define INCBIN_MANGLE INCBIN_STRINGIZE(__USER_LABEL_PREFIX__)
172#else
173#define INCBIN_MANGLE ""
174#endif
175#if defined(INCBIN_ARM)
176/* On arm assemblers, `@' is used as a line comment token */
177#define INCBIN_TYPE(NAME) ".type " INCBIN_STRINGIZE(INCBIN_PREFIX) #NAME ", %object\n"
178#elif defined(__MINGW32__) || defined(__MINGW64__)
179/* Mingw doesn't support this directive either */
180#define INCBIN_TYPE(NAME)
181#else
182/* It's safe to use `@' on other architectures */
183#define INCBIN_TYPE(NAME) ".type " INCBIN_STRINGIZE(INCBIN_PREFIX) #NAME ", @object\n"
184#endif
185#define INCBIN_BYTE ".byte "
186#endif
187
188/* List of style types used for symbol names */
189#define INCBIN_STYLE_CAMEL 0
190#define INCBIN_STYLE_SNAKE 1
191
208#if !defined(INCBIN_PREFIX)
209#define INCBIN_PREFIX g
210#endif
211
232#if !defined(INCBIN_STYLE)
233#define INCBIN_STYLE INCBIN_STYLE_CAMEL
234#endif
235
236/* Style lookup tables */
237#define INCBIN_STYLE_0_DATA Data
238#define INCBIN_STYLE_0_END End
239#define INCBIN_STYLE_0_SIZE Size
240#define INCBIN_STYLE_1_DATA _data
241#define INCBIN_STYLE_1_END _end
242#define INCBIN_STYLE_1_SIZE _size
243
244/* Style lookup: returning identifier */
245#define INCBIN_STYLE_IDENT(TYPE) \
246 INCBIN_CONCATENATE(INCBIN_STYLE_, INCBIN_CONCATENATE(INCBIN_EVAL(INCBIN_STYLE), INCBIN_CONCATENATE(_, TYPE)))
247
248/* Style lookup: returning string literal */
249#define INCBIN_STYLE_STRING(TYPE) INCBIN_STRINGIZE(INCBIN_STYLE_IDENT(TYPE))
250
251/* Generate the global labels by indirectly invoking the macro with our style
252 * type and concatenating the name against them. */
253#define INCBIN_GLOBAL_LABELS(NAME, TYPE) \
254 INCBIN_INVOKE(INCBIN_GLOBAL, INCBIN_CONCATENATE(NAME, INCBIN_INVOKE(INCBIN_STYLE_IDENT, TYPE))) \
255 INCBIN_INVOKE(INCBIN_TYPE, INCBIN_CONCATENATE(NAME, INCBIN_INVOKE(INCBIN_STYLE_IDENT, TYPE)))
256
288#define INCBIN_EXTERN(...) INCBIN_CONCATENATE(INCBIN_EXTERN_, INCBIN_VA_ARGC(__VA_ARGS__))(__VA_ARGS__)
289#define INCBIN_EXTERN_1(NAME, ...) INCBIN_EXTERN_2(unsigned char, NAME)
290#define INCBIN_EXTERN_2(TYPE, NAME) \
291 INCBIN_EXTERNAL const INCBIN_ALIGN TYPE INCBIN_CONCATENATE(INCBIN_CONCATENATE(INCBIN_PREFIX, NAME), \
292 INCBIN_STYLE_IDENT(DATA))[]; \
293 INCBIN_EXTERNAL const INCBIN_ALIGN TYPE* const INCBIN_CONCATENATE(INCBIN_CONCATENATE(INCBIN_PREFIX, NAME), \
294 INCBIN_STYLE_IDENT(END)); \
295 INCBIN_EXTERNAL const unsigned int INCBIN_CONCATENATE(INCBIN_CONCATENATE(INCBIN_PREFIX, NAME), \
296 INCBIN_STYLE_IDENT(SIZE))
297
318#define INCTXT_EXTERN(NAME) INCBIN_EXTERN_2(char, NAME)
319
359#ifdef _MSC_VER
360#define INCBIN(NAME, FILENAME) INCBIN_EXTERN(NAME)
361#else
362#define INCBIN(...) INCBIN_CONCATENATE(INCBIN_, INCBIN_VA_ARGC(__VA_ARGS__))(__VA_ARGS__)
363#if defined(__GNUC__)
364#define INCBIN_1(...) _Pragma("GCC error \"Single argument INCBIN not allowed\"")
365#elif defined(__clang__)
366#define INCBIN_1(...) _Pragma("clang error \"Single argument INCBIN not allowed\"")
367#else
368#define INCBIN_1(...) /* Cannot do anything here */
369#endif
370#define INCBIN_2(NAME, FILENAME) INCBIN_3(unsigned char, NAME, FILENAME)
371#define INCBIN_3(TYPE, NAME, FILENAME) INCBIN_COMMON(TYPE, NAME, FILENAME, /* No terminator for binary data */)
372#define INCBIN_COMMON(TYPE, NAME, FILENAME, TERMINATOR) \
373 __asm__(INCBIN_SECTION INCBIN_GLOBAL_LABELS(NAME, DATA) \
374 INCBIN_ALIGN_HOST INCBIN_MANGLE INCBIN_STRINGIZE(INCBIN_PREFIX) #NAME INCBIN_STYLE_STRING( \
375 DATA) ":\n" INCBIN_MACRO " \"" FILENAME "\"\n" TERMINATOR INCBIN_GLOBAL_LABELS(NAME, END) \
376 INCBIN_ALIGN_BYTE INCBIN_MANGLE INCBIN_STRINGIZE(INCBIN_PREFIX) #NAME INCBIN_STYLE_STRING( \
377 END) ":\n" INCBIN_BYTE "1\n" INCBIN_GLOBAL_LABELS(NAME, SIZE) \
378 INCBIN_ALIGN_HOST INCBIN_MANGLE INCBIN_STRINGIZE(INCBIN_PREFIX) #NAME INCBIN_STYLE_STRING( \
379 SIZE) ":\n" INCBIN_INT INCBIN_MANGLE \
380 INCBIN_STRINGIZE(INCBIN_PREFIX) #NAME INCBIN_STYLE_STRING(END) " - " INCBIN_MANGLE \
381 INCBIN_STRINGIZE(INCBIN_PREFIX) #NAME INCBIN_STYLE_STRING(DATA) "\n" INCBIN_ALIGN_HOST \
382 ".text\n"); \
383 INCBIN_EXTERN(TYPE, NAME)
384#endif
385
417#if defined(_MSC_VER)
418#define INCTXT(NAME, FILENAME) INCBIN_EXTERN(NAME)
419#else
420#define INCTXT(NAME, FILENAME) INCBIN_COMMON(char, NAME, FILENAME, INCBIN_BYTE "0\n")
421#endif
422
423#endif