1/*
2 *
3 * Copyright 2015 gRPC authors.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 */
18
19#ifndef GRPC_IMPL_CODEGEN_PORT_PLATFORM_H
20#define GRPC_IMPL_CODEGEN_PORT_PLATFORM_H
21
22// IWYU pragma: private, include <grpc/support/port_platform.h>
23
24/*
25 * Define GPR_BACKWARDS_COMPATIBILITY_MODE to try harder to be ABI
26 * compatible with older platforms (currently only on Linux)
27 * Causes:
28 * - some libc calls to be gotten via dlsym
29 * - some syscalls to be made directly
30 */
31
32// [[deprecated]] attribute is only available since C++14
33#if __cplusplus >= 201402L
34#define GRPC_DEPRECATED(reason) [[deprecated(reason)]]
35#else
36#define GRPC_DEPRECATED(reason)
37#endif // __cplusplus >= 201402L
38
39/*
40 * Defines GPR_ABSEIL_SYNC to use synchronization features from Abseil
41 */
42#ifndef GPR_ABSEIL_SYNC
43#if defined(__APPLE__)
44// This is disabled on Apple platforms because macos/grpc_basictests_c_cpp
45// fails with this. https://github.com/grpc/grpc/issues/23661
46#else
47#define GPR_ABSEIL_SYNC 1
48#endif
49#endif // GPR_ABSEIL_SYNC
50
51/* Get windows.h included everywhere (we need it) */
52#if defined(_WIN64) || defined(WIN64) || defined(_WIN32) || defined(WIN32)
53#ifndef WIN32_LEAN_AND_MEAN
54#define GRPC_WIN32_LEAN_AND_MEAN_WAS_NOT_DEFINED
55#define WIN32_LEAN_AND_MEAN
56#endif /* WIN32_LEAN_AND_MEAN */
57
58#ifndef NOMINMAX
59#define GRPC_NOMINMX_WAS_NOT_DEFINED
60#define NOMINMAX
61#endif /* NOMINMAX */
62
63#include <windows.h>
64
65#ifndef _WIN32_WINNT
66#error \
67 "Please compile grpc with _WIN32_WINNT of at least 0x600 (aka Windows Vista)"
68#else /* !defined(_WIN32_WINNT) */
69#if (_WIN32_WINNT < 0x0600)
70#error \
71 "Please compile grpc with _WIN32_WINNT of at least 0x600 (aka Windows Vista)"
72#endif /* _WIN32_WINNT < 0x0600 */
73#endif /* defined(_WIN32_WINNT) */
74
75#ifdef GRPC_WIN32_LEAN_AND_MEAN_WAS_NOT_DEFINED
76#undef GRPC_WIN32_LEAN_AND_MEAN_WAS_NOT_DEFINED
77#undef WIN32_LEAN_AND_MEAN
78#endif /* GRPC_WIN32_LEAN_AND_MEAN_WAS_NOT_DEFINED */
79
80#ifdef GRPC_NOMINMAX_WAS_NOT_DEFINED
81#undef GRPC_NOMINMAX_WAS_NOT_DEFINED
82#undef NOMINMAX
83#endif /* GRPC_WIN32_LEAN_AND_MEAN_WAS_NOT_DEFINED */
84#endif /* defined(_WIN64) || defined(WIN64) || defined(_WIN32) || \
85 defined(WIN32) */
86
87/* Override this file with one for your platform if you need to redefine
88 things. */
89
90#if !defined(GPR_NO_AUTODETECT_PLATFORM)
91#if defined(_WIN64) || defined(WIN64) || defined(_WIN32) || defined(WIN32)
92#if defined(_WIN64) || defined(WIN64)
93#define GPR_ARCH_64 1
94#else
95#define GPR_ARCH_32 1
96#endif
97#define GPR_PLATFORM_STRING "windows"
98#define GPR_WINDOWS 1
99#define GPR_WINDOWS_SUBPROCESS 1
100#define GPR_WINDOWS_ENV
101#ifdef __MSYS__
102#define GPR_GETPID_IN_UNISTD_H 1
103#define GPR_MSYS_TMPFILE
104#define GPR_POSIX_LOG
105#define GPR_POSIX_STRING
106#define GPR_POSIX_TIME
107#else
108#define GPR_GETPID_IN_PROCESS_H 1
109#define GPR_WINDOWS_TMPFILE
110#define GPR_WINDOWS_LOG
111#define GPR_WINDOWS_CRASH_HANDLER 1
112#define GPR_WINDOWS_STAT
113#define GPR_WINDOWS_STRING
114#define GPR_WINDOWS_TIME
115#endif
116#ifdef __GNUC__
117#define GPR_GCC_ATOMIC 1
118#else
119#define GPR_WINDOWS_ATOMIC 1
120#endif
121#elif defined(ANDROID) || defined(__ANDROID__)
122#define GPR_PLATFORM_STRING "android"
123#define GPR_ANDROID 1
124#ifndef __ANDROID_API__
125#error "__ANDROID_API__ must be defined for Android builds."
126#endif
127#if __ANDROID_API__ < 21
128#error "Requires Android API v21 and above"
129#endif
130#define GPR_SUPPORT_BINDER_TRANSPORT 1
131// TODO(apolcyn): re-evaluate support for c-ares
132// on android after upgrading our c-ares dependency.
133// See https://github.com/grpc/grpc/issues/18038.
134#define GRPC_ARES 0
135#ifdef _LP64
136#define GPR_ARCH_64 1
137#else /* _LP64 */
138#define GPR_ARCH_32 1
139#endif /* _LP64 */
140#define GPR_CPU_POSIX 1
141#define GPR_GCC_SYNC 1
142#define GPR_POSIX_ENV 1
143#define GPR_POSIX_TMPFILE 1
144#define GPR_POSIX_STAT 1
145#define GPR_ANDROID_LOG 1
146#define GPR_POSIX_STRING 1
147#define GPR_POSIX_SUBPROCESS 1
148#define GPR_POSIX_SYNC 1
149#define GPR_POSIX_TIME 1
150#define GPR_HAS_PTHREAD_H 1
151#define GPR_GETPID_IN_UNISTD_H 1
152#define GPR_SUPPORT_CHANNELS_FROM_FD 1
153#elif defined(__linux__)
154#define GPR_PLATFORM_STRING "linux"
155#ifndef _BSD_SOURCE
156#define _BSD_SOURCE
157#endif
158#ifndef _DEFAULT_SOURCE
159#define _DEFAULT_SOURCE
160#endif
161#ifndef _GNU_SOURCE
162#define _GNU_SOURCE
163#endif
164#include <features.h>
165#define GPR_CPU_LINUX 1
166#define GPR_GCC_ATOMIC 1
167#define GPR_LINUX 1
168#define GPR_LINUX_LOG
169#define GPR_SUPPORT_CHANNELS_FROM_FD 1
170#define GPR_LINUX_ENV 1
171#define GPR_POSIX_TMPFILE 1
172#define GPR_POSIX_STAT 1
173#define GPR_POSIX_STRING 1
174#define GPR_POSIX_SUBPROCESS 1
175#define GPR_POSIX_SYNC 1
176#define GPR_POSIX_TIME 1
177#define GPR_HAS_PTHREAD_H 1
178#define GPR_GETPID_IN_UNISTD_H 1
179#ifdef _LP64
180#define GPR_ARCH_64 1
181#else /* _LP64 */
182#define GPR_ARCH_32 1
183#endif /* _LP64 */
184#ifdef __GLIBC__
185#define GPR_POSIX_CRASH_HANDLER 1
186#ifdef __GLIBC_PREREQ
187#if __GLIBC_PREREQ(2, 12)
188#define GPR_LINUX_PTHREAD_NAME 1
189#endif
190#else
191// musl libc & others
192#define GPR_LINUX_PTHREAD_NAME 1
193#endif
194#include <linux/version.h>
195#else /* musl libc */
196#define GPR_MUSL_LIBC_COMPAT 1
197#endif
198#elif defined(__ASYLO__)
199#define GPR_ARCH_64 1
200#define GPR_CPU_POSIX 1
201#define GPR_PLATFORM_STRING "asylo"
202#define GPR_GCC_SYNC 1
203#define GPR_POSIX_STAT 1
204#define GPR_POSIX_SYNC 1
205#define GPR_POSIX_STRING 1
206#define GPR_POSIX_LOG 1
207#define GPR_POSIX_TIME 1
208#define GPR_POSIX_ENV 1
209#define GPR_ASYLO 1
210#define GRPC_POSIX_SOCKET 1
211#define GRPC_POSIX_SOCKETADDR
212#define GRPC_POSIX_SOCKETUTILS 1
213#define GRPC_TIMER_USE_GENERIC 1
214#define GRPC_POSIX_NO_SPECIAL_WAKEUP_FD 1
215#define GRPC_POSIX_WAKEUP_FD 1
216#define GRPC_HAVE_MSG_NOSIGNAL 1
217#define GRPC_HAVE_UNIX_SOCKET 1
218#define GRPC_ARES 0
219#define GPR_NO_AUTODETECT_PLATFORM 1
220#elif defined(__APPLE__)
221#include <Availability.h>
222#include <TargetConditionals.h>
223#ifndef _BSD_SOURCE
224#define _BSD_SOURCE
225#endif
226#if TARGET_OS_IPHONE
227#define GPR_PLATFORM_STRING "ios"
228#define GPR_CPU_IPHONE 1
229#define GRPC_CFSTREAM 1
230/* the c-ares resolver isn't safe to enable on iOS */
231#define GRPC_ARES 0
232#else /* TARGET_OS_IPHONE */
233#define GPR_PLATFORM_STRING "osx"
234#define GPR_CPU_POSIX 1
235#define GPR_POSIX_CRASH_HANDLER 1
236#endif
237#define GPR_APPLE 1
238#define GPR_GCC_ATOMIC 1
239#define GPR_POSIX_LOG 1
240#define GPR_POSIX_ENV 1
241#define GPR_POSIX_TMPFILE 1
242#define GPR_POSIX_STAT 1
243#define GPR_POSIX_STRING 1
244#define GPR_POSIX_SUBPROCESS 1
245#define GPR_POSIX_SYNC 1
246#define GPR_POSIX_TIME 1
247#define GPR_HAS_PTHREAD_H 1
248#define GPR_GETPID_IN_UNISTD_H 1
249#ifndef GRPC_CFSTREAM
250#define GPR_SUPPORT_CHANNELS_FROM_FD 1
251#endif
252#ifdef _LP64
253#define GPR_ARCH_64 1
254#else /* _LP64 */
255#define GPR_ARCH_32 1
256#endif /* _LP64 */
257#elif defined(__FreeBSD__)
258#define GPR_PLATFORM_STRING "freebsd"
259#ifndef _BSD_SOURCE
260#define _BSD_SOURCE
261#endif
262#define GPR_FREEBSD 1
263#define GPR_CPU_POSIX 1
264#define GPR_GCC_ATOMIC 1
265#define GPR_POSIX_LOG 1
266#define GPR_POSIX_ENV 1
267#define GPR_POSIX_TMPFILE 1
268#define GPR_POSIX_STAT 1
269#define GPR_POSIX_STRING 1
270#define GPR_POSIX_SUBPROCESS 1
271#define GPR_POSIX_SYNC 1
272#define GPR_POSIX_TIME 1
273#define GPR_HAS_PTHREAD_H 1
274#define GPR_GETPID_IN_UNISTD_H 1
275#define GPR_SUPPORT_CHANNELS_FROM_FD 1
276#ifdef _LP64
277#define GPR_ARCH_64 1
278#else /* _LP64 */
279#define GPR_ARCH_32 1
280#endif /* _LP64 */
281#elif defined(__OpenBSD__)
282#define GPR_PLATFORM_STRING "openbsd"
283#ifndef _BSD_SOURCE
284#define _BSD_SOURCE
285#endif
286#define GPR_OPENBSD 1
287#define GPR_CPU_POSIX 1
288#define GPR_GCC_ATOMIC 1
289#define GPR_POSIX_LOG 1
290#define GPR_POSIX_ENV 1
291#define GPR_POSIX_TMPFILE 1
292#define GPR_POSIX_STAT 1
293#define GPR_POSIX_STRING 1
294#define GPR_POSIX_SUBPROCESS 1
295#define GPR_POSIX_SYNC 1
296#define GPR_POSIX_TIME 1
297#define GPR_HAS_PTHREAD_H 1
298#define GPR_GETPID_IN_UNISTD_H 1
299#define GPR_SUPPORT_CHANNELS_FROM_FD 1
300#ifdef _LP64
301#define GPR_ARCH_64 1
302#else /* _LP64 */
303#define GPR_ARCH_32 1
304#endif /* _LP64 */
305#elif defined(__sun) && defined(__SVR4)
306#define GPR_PLATFORM_STRING "solaris"
307#define GPR_SOLARIS 1
308#define GPR_CPU_POSIX 1
309#define GPR_GCC_ATOMIC 1
310#define GPR_POSIX_LOG 1
311#define GPR_POSIX_ENV 1
312#define GPR_POSIX_TMPFILE 1
313#define GPR_POSIX_STAT 1
314#define GPR_POSIX_STRING 1
315#define GPR_POSIX_SUBPROCESS 1
316#define GPR_POSIX_SYNC 1
317#define GPR_POSIX_TIME 1
318#define GPR_HAS_PTHREAD_H 1
319#define GPR_GETPID_IN_UNISTD_H 1
320#ifdef _LP64
321#define GPR_ARCH_64 1
322#else /* _LP64 */
323#define GPR_ARCH_32 1
324#endif /* _LP64 */
325#elif defined(_AIX)
326#define GPR_PLATFORM_STRING "aix"
327#ifndef _ALL_SOURCE
328#define _ALL_SOURCE
329#endif
330#define GPR_AIX 1
331#define GPR_CPU_POSIX 1
332#define GPR_GCC_ATOMIC 1
333#define GPR_POSIX_LOG 1
334#define GPR_POSIX_ENV 1
335#define GPR_POSIX_TMPFILE 1
336#define GPR_POSIX_STAT 1
337#define GPR_POSIX_STRING 1
338#define GPR_POSIX_SUBPROCESS 1
339#define GPR_POSIX_SYNC 1
340#define GPR_POSIX_TIME 1
341#define GPR_HAS_PTHREAD_H 1
342#define GPR_GETPID_IN_UNISTD_H 1
343#ifdef _LP64
344#define GPR_ARCH_64 1
345#else /* _LP64 */
346#define GPR_ARCH_32 1
347#endif /* _LP64 */
348#elif defined(__NetBSD__)
349// NetBSD is a community-supported platform.
350// Please contact Thomas Klausner <wiz@NetBSD.org> for support.
351#define GPR_PLATFORM_STRING "netbsd"
352#ifndef _BSD_SOURCE
353#define _BSD_SOURCE
354#endif
355#define GPR_NETBSD 1
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_STAT 1
363#define GPR_POSIX_STRING 1
364#define GPR_POSIX_SUBPROCESS 1
365#define GPR_POSIX_SYNC 1
366#define GPR_POSIX_TIME 1
367#define GPR_GETPID_IN_UNISTD_H 1
368#define GPR_SUPPORT_CHANNELS_FROM_FD 1
369#ifdef _LP64
370#define GPR_ARCH_64 1
371#else /* _LP64 */
372#define GPR_ARCH_32 1
373#endif /* _LP64 */
374#elif defined(__native_client__)
375#define GPR_PLATFORM_STRING "nacl"
376#ifndef _BSD_SOURCE
377#define _BSD_SOURCE
378#endif
379#ifndef _DEFAULT_SOURCE
380#define _DEFAULT_SOURCE
381#endif
382#ifndef _GNU_SOURCE
383#define _GNU_SOURCE
384#endif
385#define GPR_NACL 1
386#define GPR_CPU_POSIX 1
387#define GPR_GCC_ATOMIC 1
388#define GPR_POSIX_LOG 1
389#define GPR_POSIX_ENV 1
390#define GPR_POSIX_TMPFILE 1
391#define GPR_POSIX_STAT 1
392#define GPR_POSIX_STRING 1
393#define GPR_POSIX_SUBPROCESS 1
394#define GPR_POSIX_SYNC 1
395#define GPR_POSIX_TIME 1
396#define GPR_HAS_PTHREAD_H 1
397#define GPR_GETPID_IN_UNISTD_H 1
398#ifdef _LP64
399#define GPR_ARCH_64 1
400#else /* _LP64 */
401#define GPR_ARCH_32 1
402#endif /* _LP64 */
403#elif defined(__Fuchsia__)
404#define GRPC_ARES 0
405#define GPR_FUCHSIA 1
406#define GPR_ARCH_64 1
407#define GPR_PLATFORM_STRING "fuchsia"
408#include <features.h>
409// Specifying musl libc affects wrap_memcpy.c. It causes memmove() to be
410// invoked.
411#define GPR_MUSL_LIBC_COMPAT 1
412#define GPR_CPU_POSIX 1
413#define GPR_GCC_ATOMIC 1
414#define GPR_POSIX_LOG 1
415#define GPR_POSIX_SYNC 1
416#define GPR_POSIX_ENV 1
417#define GPR_POSIX_TMPFILE 1
418#define GPR_POSIX_STAT 1
419#define GPR_POSIX_SUBPROCESS 1
420#define GPR_POSIX_SYNC 1
421#define GPR_POSIX_STRING 1
422#define GPR_POSIX_TIME 1
423#define GPR_HAS_PTHREAD_H 1
424#define GPR_GETPID_IN_UNISTD_H 1
425#define GRPC_ROOT_PEM_PATH "/config/ssl/cert.pem"
426#elif defined(__HAIKU__)
427#define GPR_PLATFORM_STRING "haiku"
428// Haiku is a community-supported platform.
429// Please contact Jerome Duval <jerome.duval@gmail.com> for support.
430#ifndef _BSD_SOURCE
431#define _BSD_SOURCE
432#endif
433#define GPR_HAIKU 1
434#define GPR_CPU_POSIX 1
435#define GPR_GCC_ATOMIC 1
436#define GPR_POSIX_LOG 1
437#define GPR_POSIX_ENV 1
438#define GPR_POSIX_TMPFILE 1
439#define GPR_POSIX_STAT 1
440#define GPR_POSIX_STRING 1
441#define GPR_POSIX_SUBPROCESS 1
442#define GPR_POSIX_SYNC 1
443#define GPR_POSIX_TIME 1
444#define GPR_HAS_PTHREAD_H 1
445#define GPR_GETPID_IN_UNISTD_H 1
446#define GPR_SUPPORT_CHANNELS_FROM_FD 1
447#ifdef _LP64
448#define GPR_ARCH_64 1
449#else /* _LP64 */
450#define GPR_ARCH_32 1
451#endif /* _LP64 */
452#else
453#error "Could not auto-detect platform"
454#endif
455#endif /* GPR_NO_AUTODETECT_PLATFORM */
456
457#if defined(GPR_BACKWARDS_COMPATIBILITY_MODE)
458/*
459 * For backward compatibility mode, reset _FORTIFY_SOURCE to prevent
460 * a library from having non-standard symbols such as __asprintf_chk.
461 * This helps non-glibc systems such as alpine using musl to find symbols.
462 */
463#if defined(_FORTIFY_SOURCE) && _FORTIFY_SOURCE > 0
464#undef _FORTIFY_SOURCE
465#define _FORTIFY_SOURCE 0
466#endif
467#endif
468
469#if defined(__has_include)
470#if __has_include(<atomic>)
471#define GRPC_HAS_CXX11_ATOMIC
472#endif /* __has_include(<atomic>) */
473#endif /* defined(__has_include) */
474
475#ifndef GPR_PLATFORM_STRING
476#warning "GPR_PLATFORM_STRING not auto-detected"
477#define GPR_PLATFORM_STRING "unknown"
478#endif
479
480#ifdef GPR_GCOV
481#undef GPR_FORBID_UNREACHABLE_CODE
482#define GPR_FORBID_UNREACHABLE_CODE 1
483#endif
484
485#ifdef _MSC_VER
486#if _MSC_VER < 1700
487typedef __int8 int8_t;
488typedef __int16 int16_t;
489typedef __int32 int32_t;
490typedef __int64 int64_t;
491typedef unsigned __int8 uint8_t;
492typedef unsigned __int16 uint16_t;
493typedef unsigned __int32 uint32_t;
494typedef unsigned __int64 uint64_t;
495#else
496#include <stdint.h>
497#endif /* _MSC_VER < 1700 */
498#else
499#include <stdint.h>
500#endif /* _MSC_VER */
501
502/* Type of cycle clock implementation */
503#ifdef GPR_LINUX
504/* Disable cycle clock by default.
505 TODO(soheil): enable when we support fallback for unstable cycle clocks.
506#if defined(__i386__)
507#define GPR_CYCLE_COUNTER_RDTSC_32 1
508#elif defined(__x86_64__) || defined(__amd64__)
509#define GPR_CYCLE_COUNTER_RDTSC_64 1
510#else
511#define GPR_CYCLE_COUNTER_FALLBACK 1
512#endif
513*/
514#define GPR_CYCLE_COUNTER_FALLBACK 1
515#else
516#define GPR_CYCLE_COUNTER_FALLBACK 1
517#endif /* GPR_LINUX */
518
519/* Cache line alignment */
520#ifndef GPR_CACHELINE_SIZE_LOG
521#if defined(__i386__) || defined(__x86_64__)
522#define GPR_CACHELINE_SIZE_LOG 6
523#endif
524#ifndef GPR_CACHELINE_SIZE_LOG
525/* A reasonable default guess. Note that overestimates tend to waste more
526 space, while underestimates tend to waste more time. */
527#define GPR_CACHELINE_SIZE_LOG 6
528#endif /* GPR_CACHELINE_SIZE_LOG */
529#endif /* GPR_CACHELINE_SIZE_LOG */
530
531#define GPR_CACHELINE_SIZE (1 << GPR_CACHELINE_SIZE_LOG)
532
533/* scrub GCC_ATOMIC if it's not available on this compiler */
534#if defined(GPR_GCC_ATOMIC) && !defined(__ATOMIC_RELAXED)
535#undef GPR_GCC_ATOMIC
536#define GPR_GCC_SYNC 1
537#endif
538
539/* Validate platform combinations */
540#if defined(GPR_GCC_ATOMIC) + defined(GPR_GCC_SYNC) + \
541 defined(GPR_WINDOWS_ATOMIC) != \
542 1
543#error Must define exactly one of GPR_GCC_ATOMIC, GPR_GCC_SYNC, GPR_WINDOWS_ATOMIC
544#endif
545
546#if defined(GPR_ARCH_32) + defined(GPR_ARCH_64) != 1
547#error Must define exactly one of GPR_ARCH_32, GPR_ARCH_64
548#endif
549
550#if defined(GPR_CPU_LINUX) + defined(GPR_CPU_POSIX) + defined(GPR_WINDOWS) + \
551 defined(GPR_CPU_IPHONE) + defined(GPR_CPU_CUSTOM) != \
552 1
553#error Must define exactly one of GPR_CPU_LINUX, GPR_CPU_POSIX, GPR_WINDOWS, GPR_CPU_IPHONE, GPR_CPU_CUSTOM
554#endif
555
556/* maximum alignment needed for any type on this platform, rounded up to a
557 power of two */
558#define GPR_MAX_ALIGNMENT 16
559
560#ifndef GRPC_ARES
561#define GRPC_ARES 1
562#endif
563
564#ifndef GRPC_IF_NAMETOINDEX
565#define GRPC_IF_NAMETOINDEX 1
566#endif
567
568#ifndef GRPC_MUST_USE_RESULT
569#if defined(__GNUC__) && !defined(__MINGW32__)
570#define GRPC_MUST_USE_RESULT __attribute__((warn_unused_result))
571#define GPR_ALIGN_STRUCT(n) __attribute__((aligned(n)))
572#else
573#define GRPC_MUST_USE_RESULT
574#define GPR_ALIGN_STRUCT(n)
575#endif
576#ifdef USE_STRICT_WARNING
577/* When building with USE_STRICT_WARNING (which -Werror), types with this
578 attribute will be treated as annotated with warn_unused_result, enforcing
579 returned values of this type should be used.
580 This is added in grpc::Status in mind to address the issue where it always
581 has this annotation internally but OSS doesn't, sometimes causing internal
582 build failure. To prevent this, this is added while not introducing
583 a breaking change to existing user code which may not use returned values
584 of grpc::Status. */
585#define GRPC_MUST_USE_RESULT_WHEN_USE_STRICT_WARNING GRPC_MUST_USE_RESULT
586#else
587#define GRPC_MUST_USE_RESULT_WHEN_USE_STRICT_WARNING
588#endif
589#endif
590
591#ifndef GRPC_UNUSED
592#if defined(__GNUC__) && !defined(__MINGW32__)
593#define GRPC_UNUSED __attribute__((unused))
594#else
595#define GRPC_UNUSED
596#endif
597#endif
598
599#ifndef GPR_PRINT_FORMAT_CHECK
600#ifdef __GNUC__
601#define GPR_PRINT_FORMAT_CHECK(FORMAT_STR, ARGS) \
602 __attribute__((format(printf, FORMAT_STR, ARGS)))
603#else
604#define GPR_PRINT_FORMAT_CHECK(FORMAT_STR, ARGS)
605#endif
606#endif /* GPR_PRINT_FORMAT_CHECK */
607
608#ifndef GPR_HAS_CPP_ATTRIBUTE
609#ifdef __has_cpp_attribute
610#define GPR_HAS_CPP_ATTRIBUTE(a) __has_cpp_attribute(a)
611#else
612#define GPR_HAS_CPP_ATTRIBUTE(a) 0
613#endif
614#endif /* GPR_HAS_CPP_ATTRIBUTE */
615
616#ifndef GPR_HAS_ATTRIBUTE
617#ifdef __has_attribute
618#define GPR_HAS_ATTRIBUTE(a) __has_attribute(a)
619#else
620#define GPR_HAS_ATTRIBUTE(a) 0
621#endif
622#endif /* GPR_HAS_ATTRIBUTE */
623
624#if GPR_HAS_ATTRIBUTE(noreturn)
625#define GPR_ATTRIBUTE_NORETURN __attribute__((noreturn))
626#else
627#define GPR_ATTRIBUTE_NORETURN
628#endif
629
630#if GPR_FORBID_UNREACHABLE_CODE
631#define GPR_UNREACHABLE_CODE(STATEMENT)
632#else
633#ifdef __cplusplus
634extern "C" {
635#endif
636extern void gpr_unreachable_code(const char* reason, const char* file,
637 int line) GPR_ATTRIBUTE_NORETURN;
638#ifdef __cplusplus
639}
640#endif
641#define GPR_UNREACHABLE_CODE(STATEMENT) \
642 do { \
643 gpr_unreachable_code(#STATEMENT, __FILE__, __LINE__); \
644 STATEMENT; \
645 } while (0)
646#endif /* GPR_FORBID_UNREACHABLE_CODE */
647
648#ifndef GPRAPI
649#define GPRAPI
650#endif
651
652#ifndef GRPCAPI
653#define GRPCAPI GPRAPI
654#endif
655
656#ifndef CENSUSAPI
657#define CENSUSAPI GRPCAPI
658#endif
659
660#ifndef GPR_HAS_FEATURE
661#ifdef __has_feature
662#define GPR_HAS_FEATURE(a) __has_feature(a)
663#else
664#define GPR_HAS_FEATURE(a) 0
665#endif
666#endif /* GPR_HAS_FEATURE */
667
668#ifndef GPR_ATTRIBUTE_NOINLINE
669#if GPR_HAS_ATTRIBUTE(noinline) || (defined(__GNUC__) && !defined(__clang__))
670#define GPR_ATTRIBUTE_NOINLINE __attribute__((noinline))
671#define GPR_HAS_ATTRIBUTE_NOINLINE 1
672#else
673#define GPR_ATTRIBUTE_NOINLINE
674#endif
675#endif /* GPR_ATTRIBUTE_NOINLINE */
676
677#ifndef GPR_NO_UNIQUE_ADDRESS
678#if GPR_HAS_CPP_ATTRIBUTE(no_unique_address)
679#define GPR_NO_UNIQUE_ADDRESS [[no_unique_address]]
680#else
681#define GPR_NO_UNIQUE_ADDRESS
682#endif
683#endif /* GPR_NO_UNIQUE_ADDRESS */
684
685#ifndef GRPC_DEPRECATED
686#if GPR_HAS_CPP_ATTRIBUTE(deprecated)
687#define GRPC_DEPRECATED(reason) [[deprecated(reason)]]
688#else
689#define GRPC_DEPRECATED(reason)
690#endif
691#endif /* GRPC_DEPRECATED */
692
693#ifndef GPR_ATTRIBUTE_WEAK
694/* Attribute weak is broken on LLVM/windows:
695 * https://bugs.llvm.org/show_bug.cgi?id=37598 */
696#if (GPR_HAS_ATTRIBUTE(weak) || (defined(__GNUC__) && !defined(__clang__))) && \
697 !(defined(__llvm__) && defined(_WIN32))
698#define GPR_ATTRIBUTE_WEAK __attribute__((weak))
699#define GPR_HAS_ATTRIBUTE_WEAK 1
700#else
701#define GPR_ATTRIBUTE_WEAK
702#endif
703#endif /* GPR_ATTRIBUTE_WEAK */
704
705#ifndef GPR_ATTRIBUTE_NO_TSAN /* (1) */
706#if GPR_HAS_FEATURE(thread_sanitizer)
707#define GPR_ATTRIBUTE_NO_TSAN __attribute__((no_sanitize("thread")))
708#endif /* GPR_HAS_FEATURE */
709#ifndef GPR_ATTRIBUTE_NO_TSAN /* (2) */
710#define GPR_ATTRIBUTE_NO_TSAN
711#endif /* GPR_ATTRIBUTE_NO_TSAN (2) */
712#endif /* GPR_ATTRIBUTE_NO_TSAN (1) */
713
714/* GRPC_TSAN_ENABLED will be defined, when compiled with thread sanitizer. */
715#ifndef GRPC_TSAN_SUPPRESSED
716#if defined(__SANITIZE_THREAD__)
717#define GRPC_TSAN_ENABLED
718#elif GPR_HAS_FEATURE(thread_sanitizer)
719#define GRPC_TSAN_ENABLED
720#endif
721#endif
722
723/* GRPC_ASAN_ENABLED will be defined, when compiled with address sanitizer. */
724#ifndef GRPC_ASAN_SUPPRESSED
725#if defined(__SANITIZE_ADDRESS__)
726#define GRPC_ASAN_ENABLED
727#elif GPR_HAS_FEATURE(address_sanitizer)
728#define GRPC_ASAN_ENABLED
729#endif
730#endif
731
732/* GRPC_ALLOW_EXCEPTIONS should be 0 or 1 if exceptions are allowed or not */
733#ifndef GRPC_ALLOW_EXCEPTIONS
734#ifdef GPR_WINDOWS
735#if defined(_MSC_VER) && defined(_CPPUNWIND)
736#define GRPC_ALLOW_EXCEPTIONS 1
737#elif defined(__EXCEPTIONS)
738#define GRPC_ALLOW_EXCEPTIONS 1
739#else
740#define GRPC_ALLOW_EXCEPTIONS 0
741#endif
742#else /* GPR_WINDOWS */
743#ifdef __EXCEPTIONS
744#define GRPC_ALLOW_EXCEPTIONS 1
745#else /* __EXCEPTIONS */
746#define GRPC_ALLOW_EXCEPTIONS 0
747#endif /* __EXCEPTIONS */
748#endif /* __GPR_WINDOWS */
749#endif /* GRPC_ALLOW_EXCEPTIONS */
750
751/* Use GPR_LIKELY only in cases where you are sure that a certain outcome is the
752 * most likely. Ideally, also collect performance numbers to justify the claim.
753 */
754#ifdef __GNUC__
755#define GPR_LIKELY(x) __builtin_expect((x), 1)
756#define GPR_UNLIKELY(x) __builtin_expect((x), 0)
757#else /* __GNUC__ */
758#define GPR_LIKELY(x) (x)
759#define GPR_UNLIKELY(x) (x)
760#endif /* __GNUC__ */
761
762#ifndef __STDC_FORMAT_MACROS
763#define __STDC_FORMAT_MACROS
764#endif
765
766#define GRPC_CALLBACK_API_NONEXPERIMENTAL
767
768/* clang 11 with msan miscompiles destruction of [[no_unique_address]] members
769 * of zero size - for a repro see:
770 * test/core/compiler_bugs/miscompile_with_no_unique_address_test.cc
771 */
772#ifdef __clang__
773#if __clang__ && __clang_major__ <= 11 && __has_feature(memory_sanitizer)
774#undef GPR_NO_UNIQUE_ADDRESS
775#define GPR_NO_UNIQUE_ADDRESS
776#endif
777#endif
778
779#endif /* GRPC_IMPL_CODEGEN_PORT_PLATFORM_H */
780

source code of include/grpc/impl/codegen/port_platform.h