Go to the documentation of this file.
19 #ifndef GRPC_IMPL_CODEGEN_PORT_PLATFORM_H
20 #define GRPC_IMPL_CODEGEN_PORT_PLATFORM_H
33 #ifndef GPR_ABSEIL_SYNC
38 #if defined(_WIN64) || defined(WIN64) || defined(_WIN32) || defined(WIN32)
39 #ifndef WIN32_LEAN_AND_MEAN
40 #define GRPC_WIN32_LEAN_AND_MEAN_WAS_NOT_DEFINED
41 #define WIN32_LEAN_AND_MEAN
45 #define GRPC_NOMINMX_WAS_NOT_DEFINED
53 "Please compile grpc with _WIN32_WINNT of at least 0x600 (aka Windows Vista)"
55 #if (_WIN32_WINNT < 0x0600)
57 "Please compile grpc with _WIN32_WINNT of at least 0x600 (aka Windows Vista)"
61 #ifdef GRPC_WIN32_LEAN_AND_MEAN_WAS_NOT_DEFINED
62 #undef GRPC_WIN32_LEAN_AND_MEAN_WAS_NOT_DEFINED
63 #undef WIN32_LEAN_AND_MEAN
66 #ifdef GRPC_NOMINMAX_WAS_NOT_DEFINED
67 #undef GRPC_NOMINMAX_WAS_NOT_DEFINED
76 #if !defined(GPR_NO_AUTODETECT_PLATFORM)
77 #if defined(_WIN64) || defined(WIN64) || defined(_WIN32) || defined(WIN32)
78 #if defined(_WIN64) || defined(WIN64)
83 #define GPR_PLATFORM_STRING "windows"
85 #define GPR_WINDOWS_SUBPROCESS 1
86 #define GPR_WINDOWS_ENV
88 #define GPR_GETPID_IN_UNISTD_H 1
89 #define GPR_MSYS_TMPFILE
91 #define GPR_POSIX_STRING
92 #define GPR_POSIX_TIME
94 #define GPR_GETPID_IN_PROCESS_H 1
95 #define GPR_WINDOWS_TMPFILE
96 #define GPR_WINDOWS_LOG
97 #define GPR_WINDOWS_CRASH_HANDLER 1
98 #define GPR_WINDOWS_STRING
99 #define GPR_WINDOWS_TIME
102 #define GPR_GCC_ATOMIC 1
103 #define GPR_GCC_TLS 1
105 #define GPR_WINDOWS_ATOMIC 1
106 #define GPR_MSVC_TLS 1
108 #elif defined(ANDROID) || defined(__ANDROID__)
109 #define GPR_PLATFORM_STRING "android"
110 #define GPR_ANDROID 1
116 #define GPR_ARCH_64 1
118 #define GPR_ARCH_32 1
120 #define GPR_CPU_POSIX 1
121 #define GPR_GCC_SYNC 1
122 #define GPR_GCC_TLS 1
123 #define GPR_POSIX_ENV 1
124 #define GPR_POSIX_TMPFILE 1
125 #define GPR_ANDROID_LOG 1
126 #define GPR_POSIX_STRING 1
127 #define GPR_POSIX_SUBPROCESS 1
128 #define GPR_POSIX_SYNC 1
129 #define GPR_POSIX_TIME 1
130 #define GPR_HAS_PTHREAD_H 1
131 #define GPR_GETPID_IN_UNISTD_H 1
132 #define GPR_SUPPORT_CHANNELS_FROM_FD 1
133 #elif defined(__linux__)
134 #define GPR_PLATFORM_STRING "linux"
138 #ifndef _DEFAULT_SOURCE
139 #define _DEFAULT_SOURCE
144 #include <features.h>
145 #define GPR_CPU_LINUX 1
146 #define GPR_GCC_ATOMIC 1
147 #define GPR_GCC_TLS 1
149 #define GPR_LINUX_LOG
150 #define GPR_SUPPORT_CHANNELS_FROM_FD 1
151 #define GPR_LINUX_ENV 1
152 #define GPR_POSIX_TMPFILE 1
153 #define GPR_POSIX_STRING 1
154 #define GPR_POSIX_SUBPROCESS 1
155 #define GPR_POSIX_SYNC 1
156 #define GPR_POSIX_TIME 1
157 #define GPR_HAS_PTHREAD_H 1
158 #define GPR_GETPID_IN_UNISTD_H 1
160 #define GPR_ARCH_64 1
162 #define GPR_ARCH_32 1
165 #define GPR_POSIX_CRASH_HANDLER 1
166 #define GPR_LINUX_PTHREAD_NAME 1
167 #include <linux/version.h>
169 #define GPR_MUSL_LIBC_COMPAT 1
171 #elif defined(__ASYLO__)
172 #define GPR_ARCH_64 1
173 #define GPR_CPU_POSIX 1
174 #define GPR_GCC_TLS 1
175 #define GPR_PLATFORM_STRING "asylo"
176 #define GPR_GCC_SYNC 1
177 #define GPR_POSIX_SYNC 1
178 #define GPR_POSIX_STRING 1
179 #define GPR_POSIX_LOG 1
180 #define GPR_POSIX_TIME 1
181 #define GPR_POSIX_ENV 1
183 #define GRPC_POSIX_SOCKET 1
184 #define GRPC_POSIX_SOCKETADDR
185 #define GRPC_POSIX_SOCKETUTILS 1
186 #define GRPC_TIMER_USE_GENERIC 1
187 #define GRPC_POSIX_NO_SPECIAL_WAKEUP_FD 1
188 #define GRPC_POSIX_WAKEUP_FD 1
190 #define GPR_NO_AUTODETECT_PLATFORM 1
191 #elif defined(__APPLE__)
192 #include <Availability.h>
193 #include <TargetConditionals.h>
198 #define GPR_PLATFORM_STRING "ios"
199 #define GPR_CPU_IPHONE 1
200 #define GPR_PTHREAD_TLS 1
201 #define GRPC_CFSTREAM 1
205 #define GPR_PLATFORM_STRING "osx"
206 #ifdef __MAC_OS_X_VERSION_MIN_REQUIRED
207 #if __MAC_OS_X_VERSION_MIN_REQUIRED < __MAC_10_7
208 #define GPR_CPU_IPHONE 1
209 #define GPR_PTHREAD_TLS 1
211 #define GPR_CPU_POSIX 1
215 #ifndef GRPC_BAZEL_BUILD
216 #define GPR_GCC_TLS 1
218 #define GPR_PTHREAD_TLS 1
220 #define GPR_APPLE_PTHREAD_NAME 1
223 #define GPR_CPU_POSIX 1
226 #ifndef GRPC_BAZEL_BUILD
227 #define GPR_GCC_TLS 1
229 #define GPR_PTHREAD_TLS 1
232 #define GPR_POSIX_CRASH_HANDLER 1
235 #define GPR_GCC_ATOMIC 1
236 #define GPR_POSIX_LOG 1
237 #define GPR_POSIX_ENV 1
238 #define GPR_POSIX_TMPFILE 1
239 #define GPR_POSIX_STRING 1
240 #define GPR_POSIX_SUBPROCESS 1
241 #define GPR_POSIX_SYNC 1
242 #define GPR_POSIX_TIME 1
243 #define GPR_HAS_PTHREAD_H 1
244 #define GPR_GETPID_IN_UNISTD_H 1
245 #ifndef GRPC_CFSTREAM
246 #define GPR_SUPPORT_CHANNELS_FROM_FD 1
249 #define GPR_ARCH_64 1
251 #define GPR_ARCH_32 1
253 #elif defined(__FreeBSD__)
254 #define GPR_PLATFORM_STRING "freebsd"
258 #define GPR_FREEBSD 1
259 #define GPR_CPU_POSIX 1
260 #define GPR_GCC_ATOMIC 1
261 #define GPR_GCC_TLS 1
262 #define GPR_POSIX_LOG 1
263 #define GPR_POSIX_ENV 1
264 #define GPR_POSIX_TMPFILE 1
265 #define GPR_POSIX_STRING 1
266 #define GPR_POSIX_SUBPROCESS 1
267 #define GPR_POSIX_SYNC 1
268 #define GPR_POSIX_TIME 1
269 #define GPR_HAS_PTHREAD_H 1
270 #define GPR_GETPID_IN_UNISTD_H 1
271 #define GPR_SUPPORT_CHANNELS_FROM_FD 1
273 #define GPR_ARCH_64 1
275 #define GPR_ARCH_32 1
277 #elif defined(__OpenBSD__)
278 #define GPR_PLATFORM_STRING "openbsd"
282 #define GPR_OPENBSD 1
283 #define GPR_CPU_POSIX 1
284 #define GPR_GCC_ATOMIC 1
285 #define GPR_GCC_TLS 1
286 #define GPR_POSIX_LOG 1
287 #define GPR_POSIX_ENV 1
288 #define GPR_POSIX_TMPFILE 1
289 #define GPR_POSIX_STRING 1
290 #define GPR_POSIX_SUBPROCESS 1
291 #define GPR_POSIX_SYNC 1
292 #define GPR_POSIX_TIME 1
293 #define GPR_HAS_PTHREAD_H 1
294 #define GPR_GETPID_IN_UNISTD_H 1
295 #define GPR_SUPPORT_CHANNELS_FROM_FD 1
297 #define GPR_ARCH_64 1
299 #define GPR_ARCH_32 1
301 #elif defined(__sun) && defined(__SVR4)
302 #define GPR_PLATFORM_STRING "solaris"
303 #define GPR_SOLARIS 1
304 #define GPR_CPU_POSIX 1
305 #define GPR_GCC_ATOMIC 1
306 #define GPR_GCC_TLS 1
307 #define GPR_POSIX_LOG 1
308 #define GPR_POSIX_ENV 1
309 #define GPR_POSIX_TMPFILE 1
310 #define GPR_POSIX_STRING 1
311 #define GPR_POSIX_SUBPROCESS 1
312 #define GPR_POSIX_SYNC 1
313 #define GPR_POSIX_TIME 1
314 #define GPR_HAS_PTHREAD_H 1
315 #define GPR_GETPID_IN_UNISTD_H 1
317 #define GPR_ARCH_64 1
319 #define GPR_ARCH_32 1
322 #define GPR_PLATFORM_STRING "aix"
327 #define GPR_CPU_POSIX 1
328 #define GPR_GCC_ATOMIC 1
329 #define GPR_GCC_TLS 1
330 #define GPR_POSIX_LOG 1
331 #define GPR_POSIX_ENV 1
332 #define GPR_POSIX_TMPFILE 1
333 #define GPR_POSIX_STRING 1
334 #define GPR_POSIX_SUBPROCESS 1
335 #define GPR_POSIX_SYNC 1
336 #define GPR_POSIX_TIME 1
337 #define GPR_HAS_PTHREAD_H 1
338 #define GPR_GETPID_IN_UNISTD_H 1
340 #define GPR_ARCH_64 1
342 #define GPR_ARCH_32 1
344 #elif defined(__native_client__)
345 #define GPR_PLATFORM_STRING "nacl"
349 #ifndef _DEFAULT_SOURCE
350 #define _DEFAULT_SOURCE
356 #define GPR_CPU_POSIX 1
357 #define GPR_GCC_ATOMIC 1
358 #define GPR_GCC_TLS 1
359 #define GPR_POSIX_LOG 1
360 #define GPR_POSIX_ENV 1
361 #define GPR_POSIX_TMPFILE 1
362 #define GPR_POSIX_STRING 1
363 #define GPR_POSIX_SUBPROCESS 1
364 #define GPR_POSIX_SYNC 1
365 #define GPR_POSIX_TIME 1
366 #define GPR_HAS_PTHREAD_H 1
367 #define GPR_GETPID_IN_UNISTD_H 1
369 #define GPR_ARCH_64 1
371 #define GPR_ARCH_32 1
373 #elif defined(__Fuchsia__)
374 #define GPR_FUCHSIA 1
375 #define GPR_ARCH_64 1
376 #define GPR_PLATFORM_STRING "fuchsia"
377 #include <features.h>
380 #define GPR_MUSL_LIBC_COMPAT 1
381 #define GPR_CPU_POSIX 1
382 #define GPR_GCC_ATOMIC 1
383 #define GPR_PTHREAD_TLS 1
384 #define GPR_POSIX_LOG 1
385 #define GPR_POSIX_SYNC 1
386 #define GPR_POSIX_ENV 1
387 #define GPR_POSIX_TMPFILE 1
388 #define GPR_POSIX_SUBPROCESS 1
389 #define GPR_POSIX_SYNC 1
390 #define GPR_POSIX_STRING 1
391 #define GPR_POSIX_TIME 1
392 #define GPR_HAS_PTHREAD_H 1
393 #define GPR_GETPID_IN_UNISTD_H 1
395 #error "Could not auto-detect platform"
399 #if defined(GPR_BACKWARDS_COMPATIBILITY_MODE)
405 #if defined(_FORTIFY_SOURCE) && _FORTIFY_SOURCE > 0
406 #undef _FORTIFY_SOURCE
407 #define _FORTIFY_SOURCE 0
422 #if defined(__ANDROID__) && defined(GPR_GCC_TLS)
423 #if __has_include(<android/ndk-version.h>)
424 #include <android/ndk-version.h>
426 #if (defined(__clang__) && defined(__NDK_MAJOR__) && defined(__NDK_MINOR__) && \
427 ((__NDK_MAJOR__ < 12) || \
428 ((__NDK_MAJOR__ == 12) && (__NDK_MINOR__ < 1)))) || \
429 (defined(__GNUC__) && !defined(__clang__))
431 #define GPR_PTHREAD_TLS 1
435 #if defined(__has_include)
436 #if __has_include(<atomic>)
437 #define GRPC_HAS_CXX11_ATOMIC
441 #ifndef GPR_PLATFORM_STRING
442 #warning "GPR_PLATFORM_STRING not auto-detected"
443 #define GPR_PLATFORM_STRING "unknown"
447 #undef GPR_FORBID_UNREACHABLE_CODE
448 #define GPR_FORBID_UNREACHABLE_CODE 1
453 typedef __int8 int8_t;
454 typedef __int16 int16_t;
455 typedef __int32 int32_t;
456 typedef __int64 int64_t;
457 typedef unsigned __int8 uint8_t;
458 typedef unsigned __int16 uint16_t;
459 typedef unsigned __int32 uint32_t;
460 typedef unsigned __int64 uint64_t;
480 #define GPR_CYCLE_COUNTER_FALLBACK 1
482 #define GPR_CYCLE_COUNTER_FALLBACK 1
486 #ifndef GPR_CACHELINE_SIZE_LOG
487 #if defined(__i386__) || defined(__x86_64__)
488 #define GPR_CACHELINE_SIZE_LOG 6
490 #ifndef GPR_CACHELINE_SIZE_LOG
493 #define GPR_CACHELINE_SIZE_LOG 6
497 #define GPR_CACHELINE_SIZE (1 << GPR_CACHELINE_SIZE_LOG)
500 #if defined(GPR_GCC_ATOMIC) && !defined(__ATOMIC_RELAXED)
501 #undef GPR_GCC_ATOMIC
502 #define GPR_GCC_SYNC 1
506 #if defined(GPR_GCC_ATOMIC) + defined(GPR_GCC_SYNC) + \
507 defined(GPR_WINDOWS_ATOMIC) != \
509 #error Must define exactly one of GPR_GCC_ATOMIC, GPR_GCC_SYNC, GPR_WINDOWS_ATOMIC
512 #if defined(GPR_ARCH_32) + defined(GPR_ARCH_64) != 1
513 #error Must define exactly one of GPR_ARCH_32, GPR_ARCH_64
516 #if defined(GPR_CPU_LINUX) + defined(GPR_CPU_POSIX) + defined(GPR_WINDOWS) + \
517 defined(GPR_CPU_IPHONE) + defined(GPR_CPU_CUSTOM) != \
519 #error Must define exactly one of GPR_CPU_LINUX, GPR_CPU_POSIX, GPR_WINDOWS, GPR_CPU_IPHONE, GPR_CPU_CUSTOM
522 #if defined(GPR_MSVC_TLS) + defined(GPR_GCC_TLS) + defined(GPR_PTHREAD_TLS) + \
523 defined(GPR_CUSTOM_TLS) != \
525 #error Must define exactly one of GPR_MSVC_TLS, GPR_GCC_TLS, GPR_PTHREAD_TLS, GPR_CUSTOM_TLS
530 #define GPR_MAX_ALIGNMENT 16
536 #ifndef GRPC_IF_NAMETOINDEX
537 #define GRPC_IF_NAMETOINDEX 1
540 #ifndef GRPC_MUST_USE_RESULT
541 #if defined(__GNUC__) && !defined(__MINGW32__)
542 #define GRPC_MUST_USE_RESULT __attribute__((warn_unused_result))
543 #define GPR_ALIGN_STRUCT(n) __attribute__((aligned(n)))
545 #define GRPC_MUST_USE_RESULT
546 #define GPR_ALIGN_STRUCT(n)
551 #if defined(__GNUC__) && !defined(__MINGW32__)
552 #define GRPC_UNUSED __attribute__((unused))
558 #ifndef GPR_PRINT_FORMAT_CHECK
560 #define GPR_PRINT_FORMAT_CHECK(FORMAT_STR, ARGS) \
561 __attribute__((format(printf, FORMAT_STR, ARGS)))
563 #define GPR_PRINT_FORMAT_CHECK(FORMAT_STR, ARGS)
567 #if GPR_FORBID_UNREACHABLE_CODE
568 #define GPR_UNREACHABLE_CODE(STATEMENT)
570 #define GPR_UNREACHABLE_CODE(STATEMENT) \
572 gpr_log(GPR_ERROR, "Should never reach here."); \
583 #define GRPCAPI GPRAPI
587 #define CENSUSAPI GRPCAPI
590 #ifndef GPR_HAS_ATTRIBUTE
591 #ifdef __has_attribute
592 #define GPR_HAS_ATTRIBUTE(a) __has_attribute(a)
594 #define GPR_HAS_ATTRIBUTE(a) 0
598 #ifndef GPR_HAS_FEATURE
600 #define GPR_HAS_FEATURE(a) __has_feature(a)
602 #define GPR_HAS_FEATURE(a) 0
606 #ifndef GPR_ATTRIBUTE_NOINLINE
607 #if GPR_HAS_ATTRIBUTE(noinline) || (defined(__GNUC__) && !defined(__clang__))
608 #define GPR_ATTRIBUTE_NOINLINE __attribute__((noinline))
609 #define GPR_HAS_ATTRIBUTE_NOINLINE 1
611 #define GPR_ATTRIBUTE_NOINLINE
615 #ifndef GPR_ATTRIBUTE_WEAK
618 #if (GPR_HAS_ATTRIBUTE(weak) || (defined(__GNUC__) && !defined(__clang__))) && \
619 !(defined(__llvm__) && defined(_WIN32))
620 #define GPR_ATTRIBUTE_WEAK __attribute__((weak))
621 #define GPR_HAS_ATTRIBUTE_WEAK 1
623 #define GPR_ATTRIBUTE_WEAK
627 #ifndef GPR_ATTRIBUTE_NO_TSAN
628 #if GPR_HAS_FEATURE(thread_sanitizer)
629 #define GPR_ATTRIBUTE_NO_TSAN __attribute__((no_sanitize("thread")))
631 #ifndef GPR_ATTRIBUTE_NO_TSAN
632 #define GPR_ATTRIBUTE_NO_TSAN
637 #ifndef GRPC_TSAN_SUPPRESSED
638 #if defined(__SANITIZE_THREAD__)
639 #define GRPC_TSAN_ENABLED
640 #elif GPR_HAS_FEATURE(thread_sanitizer)
641 #define GRPC_TSAN_ENABLED
646 #ifndef GRPC_ASAN_SUPPRESSED
647 #if defined(__SANITIZE_ADDRESS__)
648 #define GRPC_ASAN_ENABLED
649 #elif GPR_HAS_FEATURE(address_sanitizer)
650 #define GRPC_ASAN_ENABLED
655 #ifndef GRPC_ALLOW_EXCEPTIONS
657 #if defined(_MSC_VER) && defined(_CPPUNWIND)
658 #define GRPC_ALLOW_EXCEPTIONS 1
659 #elif defined(__EXCEPTIONS)
660 #define GRPC_ALLOW_EXCEPTIONS 1
662 #define GRPC_ALLOW_EXCEPTIONS 0
666 #define GRPC_ALLOW_EXCEPTIONS 1
668 #define GRPC_ALLOW_EXCEPTIONS 0
677 #define GPR_LIKELY(x) __builtin_expect((x), 1)
678 #define GPR_UNLIKELY(x) __builtin_expect((x), 0)
680 #define GPR_LIKELY(x) (x)
681 #define GPR_UNLIKELY(x) (x)
684 #ifndef __STDC_FORMAT_MACROS
685 #define __STDC_FORMAT_MACROS