Zen API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kApiCfg.h
Go to the documentation of this file.
1 
10 #ifndef K_API_API_CFG_H
11 #define K_API_API_CFG_H
12 
13 /* Detect the compiler family; fall back to GCC as default. */
14 #if defined(_MSC_VER)
15 # define K_MSVC
16 #else
17 # define K_GCC
18 #endif
19 
20 /* Helpful constants that can be compared with K_CPP_VERSION (defined below). */
21 #define K_CPP_VERSION_1998 (199711L)
22 #define K_CPP_VERSION_2011 (201103L)
23 #define K_CPP_VERSION_2014 (201402L)
24 #define K_CPP_VERSION_2017 (201703L)
25 
26 /*
27 * Detect language; K_CPP is defined only if the compiler is a C++ compiler; K_CPP_VERSION is
28 * always defined, but will have a definition of -1 if the compiler is a C compiler. */
29 #if defined(__cplusplus)
30 
31 # if defined(_MSVC_LANG)
32 # define K_CPP _MSVC_LANG
33 # else
34 # define K_CPP __cplusplus
35 # endif
36 
37 # if (K_CPP < K_CPP_VERSION_1998)
38 # undef K_CPP
39 # define K_CPP K_CPP_VERSION_1998
40 # endif
41 
42 # define K_CPP_VERSION K_CPP
43 
44 #else
45 
46 # define K_CPP_VERSION -1
47 
48 #endif
49 
50 #if defined(__cplusplus_cli)
51 # define K_CPP_CLI
52 #endif
53 
54 /* Detect the OS; fall back to non-specific POSIX as default. */
55 #if defined(_WIN32) || defined(_WIN64)
56 # define K_WINDOWS
57 #elif defined(_WRS_KERNEL)
58 # define K_VX_KERNEL
59 #else
60 # define K_POSIX
61 # if defined(__linux__)
62 # define K_LINUX
63 # endif
64 # if defined(__APPLE__)
65 # define K_DARWIN
66 # endif
67 # if defined(__QNXNTO__)
68 # define K_QNX
69 # endif
70 #endif
71 
72 /* Code profiling always enabled in debug builds. */
73 #if defined(K_DEBUG)
74 # define K_PROFILE
75 #endif
76 
77 #if defined(K_DEBUG)
78 # define K_DEBUG_ENABLED (1)
79 #else
80 # define K_DEBUG_ENABLED (0)
81 #endif
82 
83 #if defined(K_PROFILE)
84 # define K_PROFILE_ENABLED (1)
85 #else
86 # define K_PROFILE_ENABLED (0)
87 #endif
88 
89 #if (defined(K_DEBUG) || defined(K_ASSERT)) && !defined(K_NO_ASSERT)
90 # define K_ASSERT_ENABLED (1)
91 #else
92 # define K_ASSERT_ENABLED (0)
93 #endif
94 
95 /* Provide shorter symbol to use when checking for Cuda support. */
96 #if defined(K_HAVE_CUDA)
97 # define K_CUDA
98 #endif
99 
100 /*
101  * Include some C standard headers that we heavily rely on. This list is subject to change;
102  * dependent code should not assume that these headers will always be included here.
103  */
104 #if defined(K_MSVC) && defined(K_DEBUG)
105 # define _CRTDBG_MAP_ALLOC
106 # include <stdlib.h>
107 # include <crtdbg.h>
108 #else
109 # include <stdlib.h>
110 #endif
111 
112 #include <stdarg.h>
113 #include <stddef.h>
114 #include <string.h>
115 
116 #if defined(K_MSVC)
117 # include <intrin.h>
118 #endif
119 
120 #if (K_CPP_VERSION >= K_CPP_VERSION_2011)
121 # include <type_traits>
122 #endif
123 
124 /* Utilty macros for stringizing macro arguments. */
125 #define xkStringize(X) #X
126 #define xkStringizeDefine(X) xkStringize(X)
127 
128 /*
129  * Detect pointer size; raise an eror if the pointer size cannot be detected. The behaviour
130  * can be overridden by defining K_POINTER_SIZE as a compiler flag.
131  */
132 #if !defined(K_POINTER_SIZE)
133 # if defined(_WIN64) || defined(WIN64)
134 # define K_POINTER_SIZE (8)
135 # elif defined(_WIN32) || defined(WIN32)
136 # define K_POINTER_SIZE (4)
137 # elif defined(__SIZEOF_POINTER__)
138 # define K_POINTER_SIZE (__SIZEOF_POINTER__)
139 # elif defined(__LP64__) || defined(__LLP64__) || defined(__SILP64__)
140 # define K_POINTER_SIZE (8)
141 # elif defined(__LP32__) || defined(__ILP32__)
142 # define K_POINTER_SIZE (4)
143 # elif defined(_TMS320C6X)
144 # define K_POINTER_SIZE (4)
145 # else
146 # error "Pointer size not detected; define K_POINTER_SIZE as compiler flag."
147 # endif
148 #endif
149 
150 #if (K_POINTER_SIZE == 8)
151 # define K_POINTER_SHIFT (3)
152 #elif (K_POINTER_SIZE == 4)
153 # define K_POINTER_SHIFT (2)
154 #endif
155 
156 /*
157  * Detect endianness; fall back to little endian as default. The behaviour can be overridden
158  * by defining K_ENDIANNESS as a compiler flag.
159  */
160 #if !defined(K_ENDIANNESS)
161 # if defined(K_GCC) && defined(__BYTE_ORDER__) && (__BYTE_ORDER__ == __ORDER_BIG_ENDIAN__)
162 # define K_ENDIANNESS (kENDIANNESS_BIG)
163 # else
164 # define K_ENDIANNESS (kENDIANNESS_LITTLE)
165 # endif
166 #endif
167 
168 #if defined(K_CPP)
169 # define kExtern extern "C"
170 #else
171 # define kExtern extern
172 #endif
173 
174 #if defined(K_GCC)
175 # define K_ATTRIBUTE_UNUSED __attribute__((unused))
176 #elif defined(_MSVC_LANG) && (_MSVC_LANG >= 201703L)
177 # define K_ATTRIBUTE_UNUSED [[maybe_unused]]
178 #else
179 # define K_ATTRIBUTE_UNUSED
180 # if defined(K_MSVC) && !defined(K_WARNINGS_ALL)
181 # pragma warning(disable: 4189)
182 # endif
183 #endif
184 
185 /* Define primitive data types and calling conventions. */
186 #if defined(K_MSVC)
187 
188 # define xkCall __stdcall
189 # define xkDlCall __cdecl
190 
191 # define kExportFx(TYPE) kExtern __declspec(dllexport) TYPE kCall
192 # define kImportFx(TYPE) kExtern __declspec(dllimport) TYPE kCall
193 
194 # define kExportCx(TYPE) kExtern __declspec(dllexport) TYPE xkDlCall
195 # define kImportCx(TYPE) kExtern __declspec(dllimport) TYPE xkDlCall
196 
197 # define kInFx(TYPE) kExtern TYPE kCall
198 # define kInCx(TYPE) kExtern TYPE kCall
199 
200 # define kExportDx(TYPE) __declspec(dllexport) TYPE
201 # define kImportDx(TYPE) __declspec(dllimport) TYPE
202 
203 # define kInDx(TYPE) TYPE
204 
205 # define kExportClass __declspec(dllexport)
206 # define kImportClass __declspec(dllimport)
207 
208 # if _MSC_VER >= 1500
209 # define kInline __inline
210 # else
211 # define kInline
212 # endif
213 
214  typedef unsigned __int8 xk8u;
215  typedef unsigned __int16 xk16u;
216  typedef unsigned __int32 xk32u;
217  typedef unsigned __int64 xk64u;
218  typedef __int8 xk8s;
219  typedef __int16 xk16s;
220  typedef __int32 xk32s;
221  typedef __int64 xk64s;
222  typedef float xk32f;
223  typedef double xk64f;
224  typedef char xkChar;
225  typedef unsigned char xkByte;
226 
227 # define xk64U(CONSTANT) (CONSTANT##ui64)
228 # define xk64S(CONSTANT) (CONSTANT##i64)
229 
230 #else
231 
232 # define xkCall
233 # define xkDlCall
234 
235 # define kExportFx(TYPE) kExtern TYPE kCall
236 # define kImportFx(TYPE) kExtern TYPE kCall
237 
238 # define kExportCx(TYPE) kExtern TYPE kDlCall
239 # define kImportCx(TYPE) kExtern TYPE kDlCall
240 
241 # define kInFx(TYPE) kExtern TYPE kCall
242 # define kInCx(TYPE) kExtern TYPE kCall
243 
244 # define kExportDx(TYPE) TYPE
245 # define kImportDx(TYPE) TYPE
246 
247 # define kInDx(TYPE) TYPE
248 
249 # define kExportClass
250 # define kImportClass
251 
252 # define kInline inline
253 
254  typedef unsigned char xk8u;
255  typedef unsigned short xk16u;
256  typedef unsigned int xk32u;
257  typedef unsigned long long xk64u;
258  typedef signed char xk8s;
259  typedef signed short xk16s;
260  typedef signed int xk32s;
261  typedef signed long long xk64s;
262  typedef float xk32f;
263  typedef double xk64f;
264  typedef char xkChar;
265  typedef unsigned char xkByte;
266 
267 # define xk64U(CONSTANT) (CONSTANT##LLU)
268 # define xk64S(CONSTANT) (CONSTANT##LL)
269 
270 #endif
271 
272 #define xkInlineFx(TYPE) static kInline TYPE kCall
273 
274 #if (K_POINTER_SIZE == 4)
275 
276 typedef xk32u xkSize;
277 # define xkSIZE_MAX k32U_MAX
278 
279 typedef xk32s xkSSize;
280 # define xkSSIZE_MIN k32S_MIN
281 # define xkSSIZE_MAX k32S_MAX
282 
283 #elif (K_POINTER_SIZE == 8)
284 
285 typedef xk64u xkSize;
286 # define xkSIZE_MAX k64U_MAX
287 
288 typedef xk64s xkSSize;
289 # define xkSSIZE_MIN k64S_MIN
290 # define xkSSIZE_MAX k64S_MAX
291 
292 #endif
293 
294 #define kALIGN_ANY (kMEMORY_ALIGNMENT_16)
295 #define kALIGN_ANY_SIZE (1 << kALIGN_ANY)
296 
297 #define kVarArgList va_list
298 
299 #if defined(K_MSVC)
300 # define kVarArgList_Start(ARG_PTR, PREV_PARAM) va_start(ARG_PTR, PREV_PARAM)
301 # define kVarArgList_End(ARG_PTR) va_end(ARG_PTR)
302 # define kVarArgList_Copy(ARG_PTR, SOURCE) ((ARG_PTR) = (SOURCE))
303 # define kVarArgList_Next(ARG_PTR, TYPE) va_arg(ARG_PTR, TYPE)
304 #else
305 # define kVarArgList_Start(ARG_PTR, PREV_PARAM) va_start(ARG_PTR, PREV_PARAM)
306 # define kVarArgList_End(ARG_PTR) va_end(ARG_PTR)
307 # define kVarArgList_Copy(ARG_PTR, SOURCE) va_copy(ARG_PTR, SOURCE)
308 # define kVarArgList_Next(ARG_PTR, TYPE) va_arg(ARG_PTR, TYPE)
309 #endif
310 
311 
312 /* Deprecation support. */
313 #if !defined(K_NO_DEPRECATION)
314 # if defined(K_MSVC)
315 # define xkDeprecate(SYMBOL) __pragma(deprecated(SYMBOL))
316 # else
317 # define xkDeprecate(SYMBOL)
318 # endif
319 #else
320 # define xkDeprecate(SYMBOL)
321 #endif
322 
323 /* Warning support. */
324 #if defined(K_MSVC)
325 
326 # define xkWarn(MESSAGE) __pragma(message(__FILE__ "(" xkStringizeDefine(__LINE__) "): warning: " MESSAGE))
327 
328 #elif defined(K_GCC)
329 
330 # define xkWarnHelper(x) _Pragma (#x)
331 # define xkWarn(MESSAGE) xkWarnHelper(GCC warning MESSAGE)
332 
333 #else
334 
335 # define xkWarn(MESSAGE)
336 
337 #endif
338 
339 /* Software breakpoint support. */
340 #if defined(K_DEBUG) && defined(K_MSVC)
341 # define xkDebugBreak() __debugbreak()
342 #else
343 # define xkDebugBreak()
344 #endif
345 
346 #if defined (K_CPP)
347 # define kBeginCHeader() extern "C" {
348 # define kEndCHeader() }
349 #else
350 # define kBeginCHeader()
351 # define kEndCHeader()
352 #endif
353 
354 
355 /*
356  * Some source files require platform library headers to be included. And, at least
357  * for Windows, there can sometimes exist complicated rules about the particular order
358  * in which headers have to be included. The K_PLATFORM symbol helps to deal with
359  * these issues.
360  *
361  * Any kApi source file that requires platform headers should have #define K_PLATFORM as the
362  * first line in the source file. This ensures that the most common platform headers are
363  * included here, in the correct order.
364  */
365 #if defined(K_PLATFORM)
366 
367 /*
368  * Common for all platforms.
369  */
370 # include <assert.h>
371 
372 /*
373  * Platform specific includes.
374  */
375 # if defined(K_WINDOWS)
376 # include <winsock2.h>
377 # include <mswsock.h>
378 # include <ws2tcpip.h>
379 # include <iphlpapi.h>
380 # include <windows.h>
381 # include <process.h>
382 # endif
383 # if defined(K_VX_KERNEL)
384 # if defined(K_DEBUG)
385 # pragma GCC optimize ("O2")
386 # include <errno.h> /* work-around for error "ldarm: error in obj.o (.eh_frame); no .eh_frame_hdr table will be created." */
387 # pragma GCC reset_options
388 # endif
389 # include <vxWorks.h>
390 # include <sysLib.h>
391 # include <kernelLib.h>
392 # include <loadLib.h>
393 # include <intLib.h>
394 # include <symLib.h>
395 # include <sysSymTbl.h>
396 # include <taskLib.h>
397 # include <inline/semLibInline.h>
398 # include <unldLib.h>
399 # include <stdioLib.h>
400 # include <strLib.h>
401 # include <sockLib.h>
402 # include <inetLib.h>
403 # include <ioLib.h>
404 # include <fioLib.h>
405 # include <selectLib.h>
406 # include <netinet/in.h>
407 # include <netinet/tcp.h>
408 # include <wrapper/wrapperHostLib.h>
409 # include <netdb.h>
410 # include <sys/socket.h>
411 # include <net/if.h>
412 # include <net/if_ll.h>
413 # include <net/ifaddrs.h>
414 # include <net/ethernet.h>
415 # include <ipnet/ipioctl.h>
416 # include <ipcom_sock.h>
417 # include <ipcom_netlink.h>
418 # endif
419 # if defined(K_POSIX)
420 # include <errno.h>
421 # include <unistd.h>
422 # include <pthread.h>
423 # include <semaphore.h>
424 # include <sys/types.h>
425 # include <sys/stat.h>
426 # if defined(K_QNX)
427 # include <fcntl.h>
428 # else
429 # include <sys/fcntl.h>
430 # endif
431 # include <sys/socket.h>
432 # include <sys/select.h>
433 # include <sys/syscall.h>
434 # include <sys/ioctl.h>
435 # include <sys/resource.h>
436 # include <sys/time.h>
437 # include <sys/timeb.h>
438 # include <netinet/in.h>
439 # include <netinet/tcp.h>
440 # include <dlfcn.h>
441 # include <dirent.h>
442 # include <net/if.h>
443 # include <net/if_arp.h>
444 # include <ifaddrs.h> /* not technically posix, but seemingly supported everywhere that matters */
445 # include <netdb.h>
446 
447 # endif
448 # if defined(K_DARWIN)
449 # include <mach-o/dyld.h>
450 # endif
451 # if defined (K_LINUX)
452 # include <signal.h>
453 # include <sys/prctl.h>
454 # include <sys/wait.h>
455 # include <linux/sockios.h>
456 # include <linux/ethtool.h>
457 # include <linux/netlink.h>
458 # include <linux/rtnetlink.h>
459 # endif
460 #endif
461 
462 #if defined(K_VX_KERNEL)
463  typedef xk32s xkAtomic32s;
464  typedef xkSSize xkAtomicPointer;
465 #else
466  typedef volatile xk32s xkAtomic32s;
467  typedef void* volatile xkAtomicPointer;
468 #endif
469 
470 #if defined(K_PLATFORM)
471 # if defined(K_WINDOWS)
472 # define kOS_INFINITE INFINITE
473  typedef DWORD xkThreadId;
474 # elif defined(K_VX_KERNEL)
475 # define kOS_INFINITE WAIT_FOREVER
476  typedef TASK_ID xkThreadId;
477 # elif defined(K_POSIX)
478 # define kOS_INFINITE 0 /* no special "infinite" value */
479  typedef pthread_t xkThreadId;
480 # endif
481 #endif
482 
483 #if defined(K_VX_KERNEL)
484 # if defined(K_MAIN_DYNAMIC)
485 # undef kMain
486 # define kMain kMain_Dynamic
487 # else
488 # undef kMain
489 # define kMain kMain
490 # endif
491 # define kMAIN_DYNAMIC "kMain_Dynamic"
492 #else
493 # define kMAIN_DYNAMIC "kMain"
494 #endif
495 
496 
497 /*
498 * Deprecated (Stage 1): not recommended for further use, but not yet announced via kDeprecate
499 */
500 
501 #if defined (K_CPP)
502 
503  //[Deprecated] No longer required; provided that any C functions are properly annotated.
504  //Use kBeginCHeader/kEndCHeader to include a C header from C++ if the header was not designed to support C++.
505 # define kBeginHeader() extern "C" {
506 
507  //[Deprecated] No longer required; provided that any C functions are properly annotated.
508  //Use kBeginCHeader/kEndCHeader to include a C header from C++ if the header was not designed to support C++.
509 # define kEndHeader() }
510 
511 #else
512 
513  //[Deprecated] No longer required; provided that any C functions are properly annotated.
514  //Use kBeginCHeader/kEndCHeader to include a C header from C++ if the header was not designed to support C++.
515 # define kBeginHeader()
516 
517  //[Deprecated] No longer required; provided that any C functions are properly annotated.
518  //Use kBeginCHeader/kEndCHeader to include a C header from C++ if the header was not designed to support C++.
519 # define kEndHeader()
520 
521 #endif
522 
523 #endif