blob: 202b936d964f00dec2f7cb8a3fc993f1bd6cfc85 [file] [log] [blame]
Victor Stinnerdfb866d2011-09-29 01:12:24 +02001#ifndef Py_PYMACRO_H
2#define Py_PYMACRO_H
3
Victor Stinner45e8e2f2014-05-14 17:24:35 +02004/* Minimum value between x and y */
Victor Stinnerdfb866d2011-09-29 01:12:24 +02005#define Py_MIN(x, y) (((x) > (y)) ? (y) : (x))
Victor Stinner45e8e2f2014-05-14 17:24:35 +02006
7/* Maximum value between x and y */
Victor Stinnerdfb866d2011-09-29 01:12:24 +02008#define Py_MAX(x, y) (((x) > (y)) ? (x) : (y))
9
Victor Stinner45e8e2f2014-05-14 17:24:35 +020010/* Absolute value of the number x */
11#define Py_ABS(x) ((x) < 0 ? -(x) : (x))
12
13#define _Py_XSTRINGIFY(x) #x
14
15/* Convert the argument to a string. For example, Py_STRINGIFY(123) is replaced
16 with "123" by the preprocessor. Defines are also replaced by their value.
17 For example Py_STRINGIFY(__LINE__) is replaced by the line number, not
18 by "__LINE__". */
19#define Py_STRINGIFY(x) _Py_XSTRINGIFY(x)
20
Victor Stinner98ee9d52016-09-08 09:33:56 -070021/* Get the size of a structure member in bytes */
22#define Py_MEMBER_SIZE(type, member) sizeof(((type *)0)->member)
23
Victor Stinnerdfb866d2011-09-29 01:12:24 +020024/* Argument must be a char or an int in [-128, 127] or [0, 255]. */
25#define Py_CHARMASK(c) ((unsigned char)((c) & 0xff))
26
Victor Stinnerdfb866d2011-09-29 01:12:24 +020027/* Assert a build-time dependency, as an expression.
28
29 Your compile will fail if the condition isn't true, or can't be evaluated
30 by the compiler. This can be used in an expression: its value is 0.
31
32 Example:
33
34 #define foo_to_char(foo) \
35 ((char *)(foo) \
Victor Stinnerf0ddadc2011-09-29 12:43:18 +020036 + Py_BUILD_ASSERT_EXPR(offsetof(struct foo, string) == 0))
Victor Stinnerdfb866d2011-09-29 01:12:24 +020037
Victor Stinner573696a2011-09-29 12:12:39 +020038 Written by Rusty Russell, public domain, http://ccodearchive.net/ */
Victor Stinnerf0ddadc2011-09-29 12:43:18 +020039#define Py_BUILD_ASSERT_EXPR(cond) \
Victor Stinnerdfb866d2011-09-29 01:12:24 +020040 (sizeof(char [1 - 2*!(cond)]) - 1)
41
Serhiy Storchakafad85aa2015-11-07 15:42:38 +020042#define Py_BUILD_ASSERT(cond) do { \
43 (void)Py_BUILD_ASSERT_EXPR(cond); \
44 } while(0)
45
Victor Stinnerdfb866d2011-09-29 01:12:24 +020046/* Get the number of elements in a visible array
47
48 This does not work on pointers, or arrays declared as [], or function
49 parameters. With correct compiler support, such usage will cause a build
Victor Stinnerf0ddadc2011-09-29 12:43:18 +020050 error (see Py_BUILD_ASSERT_EXPR).
Victor Stinnerdfb866d2011-09-29 01:12:24 +020051
Christian Heimes61dbb002013-01-06 16:41:56 +010052 Written by Rusty Russell, public domain, http://ccodearchive.net/
53
54 Requires at GCC 3.1+ */
55#if (defined(__GNUC__) && !defined(__STRICT_ANSI__) && \
Niklas Fiekas83371f42017-03-29 06:58:01 +020056 (((__GNUC__ == 3) && (__GNUC_MINOR__ >= 1)) || (__GNUC__ >= 4)))
Victor Stinner573696a2011-09-29 12:12:39 +020057/* Two gcc extensions.
58 &a[0] degrades to a pointer: a different type from an array */
Victor Stinnerdfb866d2011-09-29 01:12:24 +020059#define Py_ARRAY_LENGTH(array) \
Victor Stinner573696a2011-09-29 12:12:39 +020060 (sizeof(array) / sizeof((array)[0]) \
Victor Stinnerf0ddadc2011-09-29 12:43:18 +020061 + Py_BUILD_ASSERT_EXPR(!__builtin_types_compatible_p(typeof(array), \
62 typeof(&(array)[0]))))
Victor Stinner573696a2011-09-29 12:12:39 +020063#else
64#define Py_ARRAY_LENGTH(array) \
65 (sizeof(array) / sizeof((array)[0]))
66#endif
Victor Stinnerdfb866d2011-09-29 01:12:24 +020067
68
69/* Define macros for inline documentation. */
Inada Naoki926b0cb2019-04-17 08:39:46 +090070#define PyDoc_VAR(name) static const char name[]
Victor Stinnerdfb866d2011-09-29 01:12:24 +020071#define PyDoc_STRVAR(name,str) PyDoc_VAR(name) = PyDoc_STR(str)
72#ifdef WITH_DOC_STRINGS
73#define PyDoc_STR(str) str
74#else
75#define PyDoc_STR(str) ""
76#endif
77
Antoine Pitrouca8aa4a2012-09-20 20:56:47 +020078/* Below "a" is a power of 2. */
79/* Round down size "n" to be a multiple of "a". */
80#define _Py_SIZE_ROUND_DOWN(n, a) ((size_t)(n) & ~(size_t)((a) - 1))
81/* Round up size "n" to be a multiple of "a". */
82#define _Py_SIZE_ROUND_UP(n, a) (((size_t)(n) + \
83 (size_t)((a) - 1)) & ~(size_t)((a) - 1))
84/* Round pointer "p" down to the closest "a"-aligned address <= "p". */
Benjamin Petersonca470632016-09-06 13:47:26 -070085#define _Py_ALIGN_DOWN(p, a) ((void *)((uintptr_t)(p) & ~(uintptr_t)((a) - 1)))
Antoine Pitrouca8aa4a2012-09-20 20:56:47 +020086/* Round pointer "p" up to the closest "a"-aligned address >= "p". */
Benjamin Petersonca470632016-09-06 13:47:26 -070087#define _Py_ALIGN_UP(p, a) ((void *)(((uintptr_t)(p) + \
88 (uintptr_t)((a) - 1)) & ~(uintptr_t)((a) - 1)))
Antoine Pitrouca8aa4a2012-09-20 20:56:47 +020089/* Check if pointer "p" is aligned to "a"-bytes boundary. */
Benjamin Petersonca470632016-09-06 13:47:26 -070090#define _Py_IS_ALIGNED(p, a) (!((uintptr_t)(p) & (uintptr_t)((a) - 1)))
Antoine Pitrouca8aa4a2012-09-20 20:56:47 +020091
Victor Stinnerb3a98432019-05-24 15:16:08 +020092/* Use this for unused arguments in a function definition to silence compiler
93 * warnings. Example:
94 *
95 * int func(int a, int Py_UNUSED(b)) { return a; }
96 */
97#if defined(__GNUC__) || defined(__clang__)
98# define Py_UNUSED(name) _unused_ ## name __attribute__((unused))
Larry Hastings3cceb382014-01-04 11:09:09 -080099#else
Victor Stinnerb3a98432019-05-24 15:16:08 +0200100# define Py_UNUSED(name) _unused_ ## name
Larry Hastings3cceb382014-01-04 11:09:09 -0800101#endif
102
Zachary Ware3ab61472019-09-12 13:35:48 +0100103#if defined(RANDALL_WAS_HERE)
Serhiy Storchakaeebaa9b2020-03-09 20:49:52 +0200104# define Py_UNREACHABLE() \
Victor Stinnerb1542582019-09-20 23:10:16 +0200105 Py_FatalError( \
106 "If you're seeing this, the code is in what I thought was\n" \
107 "an unreachable state.\n\n" \
108 "I could give you advice for what to do, but honestly, why\n" \
109 "should you trust me? I clearly screwed this up. I'm writing\n" \
110 "a message that should never appear, yet I know it will\n" \
111 "probably appear someday.\n\n" \
112 "On a deep level, I know I'm not up to this task.\n" \
113 "I'm so sorry.\n" \
114 "https://xkcd.com/2200")
Zachary Ware3ab61472019-09-12 13:35:48 +0100115#elif defined(Py_DEBUG)
Serhiy Storchakaeebaa9b2020-03-09 20:49:52 +0200116# define Py_UNREACHABLE() \
Victor Stinnerb1542582019-09-20 23:10:16 +0200117 Py_FatalError( \
118 "We've reached an unreachable state. Anything is possible.\n" \
119 "The limits were in our heads all along. Follow your dreams.\n" \
120 "https://xkcd.com/2200")
Dong-hee Na24ba3b02020-09-29 05:41:23 +0900121#elif defined(__GNUC__) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5))
122# define Py_UNREACHABLE() __builtin_unreachable()
123#elif defined(__clang__) || defined(__INTEL_COMPILER)
Serhiy Storchakaeebaa9b2020-03-09 20:49:52 +0200124# define Py_UNREACHABLE() __builtin_unreachable()
125#elif defined(_MSC_VER)
126# define Py_UNREACHABLE() __assume(0)
Zachary Ware3ab61472019-09-12 13:35:48 +0100127#else
Serhiy Storchakaeebaa9b2020-03-09 20:49:52 +0200128# define Py_UNREACHABLE() \
Victor Stinnerb1542582019-09-20 23:10:16 +0200129 Py_FatalError("Unreachable C code path reached")
Zachary Ware3ab61472019-09-12 13:35:48 +0100130#endif
Barry Warsawb2e57942017-09-14 18:13:16 -0700131
Victor Stinnerdfb866d2011-09-29 01:12:24 +0200132#endif /* Py_PYMACRO_H */