Thanks to visit codestin.com
Credit goes to doxygen.postgresql.org

PostgreSQL Source Code git master
c.h
Go to the documentation of this file.
1/*-------------------------------------------------------------------------
2 *
3 * c.h
4 * Fundamental C definitions. This is included by every .c file in
5 * PostgreSQL (via either postgres.h or postgres_fe.h, as appropriate).
6 *
7 * Note that the definitions here are not intended to be exposed to clients
8 * of the frontend interface libraries --- so we don't worry much about
9 * polluting the namespace with lots of stuff...
10 *
11 *
12 * Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group
13 * Portions Copyright (c) 1994, Regents of the University of California
14 *
15 * src/include/c.h
16 *
17 *-------------------------------------------------------------------------
18 */
19/* IWYU pragma: always_keep */
20/*
21 *----------------------------------------------------------------
22 * TABLE OF CONTENTS
23 *
24 * When adding stuff to this file, please try to put stuff
25 * into the relevant section, or add new sections as appropriate.
26 *
27 * section description
28 * ------- ------------------------------------------------
29 * 0) pg_config.h and standard system headers
30 * 1) compiler characteristics
31 * 2) bool, true, false
32 * 3) standard system types
33 * 4) IsValid macros for system types
34 * 5) lengthof, alignment
35 * 6) assertions
36 * 7) widely useful macros
37 * 8) random stuff
38 * 9) system-specific hacks
39 *
40 * NOTE: since this file is included by both frontend and backend modules,
41 * it's usually wrong to put an "extern" declaration here, unless it's
42 * ifdef'd so that it's seen in only one case or the other.
43 * typedefs and macros are the kind of thing that might go here.
44 *
45 *----------------------------------------------------------------
46 */
47#ifndef C_H
48#define C_H
49
50/* IWYU pragma: begin_exports */
51
52/*
53 * These headers must be included before any system headers, because on some
54 * platforms they affect the behavior of the system headers (for example, by
55 * defining _FILE_OFFSET_BITS).
56 */
57#include "pg_config.h"
58#include "pg_config_manual.h" /* must be after pg_config.h */
59#include "pg_config_os.h" /* config from include/port/PORTNAME.h */
60
61/* System header files that should be available everywhere in Postgres */
62#include <inttypes.h>
63#include <stdio.h>
64#include <stdlib.h>
65#include <string.h>
66#include <stddef.h>
67#include <stdarg.h>
68#ifdef HAVE_STRINGS_H
69#include <strings.h>
70#endif
71#include <stdint.h>
72#include <sys/types.h>
73#include <errno.h>
74#if defined(WIN32) || defined(__CYGWIN__)
75#include <fcntl.h> /* ensure O_BINARY is available */
76#endif
77#include <locale.h>
78#ifdef HAVE_XLOCALE_H
79#include <xlocale.h>
80#endif
81#ifdef ENABLE_NLS
82#include <libintl.h>
83#endif
84
85 /* Pull in fundamental symbols that we also expose to applications */
86#include "postgres_ext.h"
87
88/* Define before including zlib.h to add const decorations to zlib API. */
89#ifdef HAVE_LIBZ
90#define ZLIB_CONST
91#endif
92
93
94/* ----------------------------------------------------------------
95 * Section 1: compiler characteristics
96 *
97 * type prefixes (const, signed, volatile, inline) are handled in pg_config.h.
98 * ----------------------------------------------------------------
99 */
100
101/*
102 * Disable "inline" if PG_FORCE_DISABLE_INLINE is defined.
103 * This is used to work around compiler bugs and might also be useful for
104 * investigatory purposes.
105 */
106#ifdef PG_FORCE_DISABLE_INLINE
107#undef inline
108#define inline
109#endif
110
111/*
112 * Attribute macros
113 *
114 * GCC: https://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html
115 * GCC: https://gcc.gnu.org/onlinedocs/gcc/Type-Attributes.html
116 * Clang: https://clang.llvm.org/docs/AttributeReference.html
117 */
118
119/*
120 * For compilers which don't support __has_attribute, we just define
121 * __has_attribute(x) to 0 so that we can define macros for various
122 * __attribute__s more easily below.
123 */
124#ifndef __has_attribute
125#define __has_attribute(attribute) 0
126#endif
127
128/* only GCC supports the unused attribute */
129#ifdef __GNUC__
130#define pg_attribute_unused() __attribute__((unused))
131#else
132#define pg_attribute_unused()
133#endif
134
135/*
136 * pg_nodiscard means the compiler should warn if the result of a function
137 * call is ignored. The name "nodiscard" is chosen in alignment with the C23
138 * standard attribute with the same name. For maximum forward compatibility,
139 * place it before the declaration.
140 */
141#ifdef __GNUC__
142#define pg_nodiscard __attribute__((warn_unused_result))
143#else
144#define pg_nodiscard
145#endif
146
147/*
148 * pg_noreturn corresponds to the C11 noreturn/_Noreturn function specifier.
149 * We can't use the standard name "noreturn" because some third-party code
150 * uses __attribute__((noreturn)) in headers, which would get confused if
151 * "noreturn" is defined to "_Noreturn", as is done by <stdnoreturn.h>.
152 *
153 * In a declaration, function specifiers go before the function name. The
154 * common style is to put them before the return type. (The MSVC fallback has
155 * the same requirement. The GCC fallback is more flexible.)
156 */
157#if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L
158#define pg_noreturn _Noreturn
159#elif defined(__GNUC__)
160#define pg_noreturn __attribute__((noreturn))
161#elif defined(_MSC_VER)
162#define pg_noreturn __declspec(noreturn)
163#else
164#define pg_noreturn
165#endif
166
167/*
168 * This macro will disable address safety instrumentation for a function
169 * when running with "-fsanitize=address". Think twice before using this!
170 */
171#if defined(__clang__) || __GNUC__ >= 8
172#define pg_attribute_no_sanitize_address() __attribute__((no_sanitize("address")))
173#elif __has_attribute(no_sanitize_address)
174/* This would work for clang, but it's deprecated. */
175#define pg_attribute_no_sanitize_address() __attribute__((no_sanitize_address))
176#else
177#define pg_attribute_no_sanitize_address()
178#endif
179
180/*
181 * Place this macro before functions that should be allowed to make misaligned
182 * accesses. Think twice before using it on non-x86-specific code!
183 * Testing can be done with "-fsanitize=alignment -fsanitize-trap=alignment"
184 * on clang, or "-fsanitize=alignment -fno-sanitize-recover=alignment" on gcc.
185 */
186#if __clang_major__ >= 7 || __GNUC__ >= 8
187#define pg_attribute_no_sanitize_alignment() __attribute__((no_sanitize("alignment")))
188#else
189#define pg_attribute_no_sanitize_alignment()
190#endif
191
192/*
193 * pg_attribute_nonnull means the compiler should warn if the function is
194 * called with the listed arguments set to NULL. If no arguments are
195 * listed, the compiler should warn if any pointer arguments are set to NULL.
196 */
197#if __has_attribute (nonnull)
198#define pg_attribute_nonnull(...) __attribute__((nonnull(__VA_ARGS__)))
199#else
200#define pg_attribute_nonnull(...)
201#endif
202
203/*
204 * pg_attribute_target allows specifying different target options that the
205 * function should be compiled with (e.g., for using special CPU instructions).
206 * Note that there still needs to be a configure-time check to verify that a
207 * specific target is understood by the compiler.
208 */
209#if __has_attribute (target)
210#define pg_attribute_target(...) __attribute__((target(__VA_ARGS__)))
211#else
212#define pg_attribute_target(...)
213#endif
214
215/*
216 * Append PG_USED_FOR_ASSERTS_ONLY to definitions of variables that are only
217 * used in assert-enabled builds, to avoid compiler warnings about unused
218 * variables in assert-disabled builds.
219 */
220#ifdef USE_ASSERT_CHECKING
221#define PG_USED_FOR_ASSERTS_ONLY
222#else
223#define PG_USED_FOR_ASSERTS_ONLY pg_attribute_unused()
224#endif
225
226/* GCC supports format attributes */
227#if defined(__GNUC__)
228#define pg_attribute_format_arg(a) __attribute__((format_arg(a)))
229#define pg_attribute_printf(f,a) __attribute__((format(PG_PRINTF_ATTRIBUTE, f, a)))
230#else
231#define pg_attribute_format_arg(a)
232#define pg_attribute_printf(f,a)
233#endif
234
235/* GCC supports aligned and packed */
236#if defined(__GNUC__)
237#define pg_attribute_aligned(a) __attribute__((aligned(a)))
238#define pg_attribute_packed() __attribute__((packed))
239#elif defined(_MSC_VER)
240/*
241 * MSVC supports aligned.
242 *
243 * Packing is also possible but only by wrapping the entire struct definition
244 * which doesn't fit into our current macro declarations.
245 */
246#define pg_attribute_aligned(a) __declspec(align(a))
247#else
248/*
249 * NB: aligned and packed are not given default definitions because they
250 * affect code functionality; they *must* be implemented by the compiler
251 * if they are to be used.
252 */
253#endif
254
255/*
256 * Use "pg_attribute_always_inline" in place of "inline" for functions that
257 * we wish to force inlining of, even when the compiler's heuristics would
258 * choose not to. But, if possible, don't force inlining in unoptimized
259 * debug builds.
260 */
261#if defined(__GNUC__) && defined(__OPTIMIZE__)
262/* GCC supports always_inline via __attribute__ */
263#define pg_attribute_always_inline __attribute__((always_inline)) inline
264#elif defined(_MSC_VER)
265/* MSVC has a special keyword for this */
266#define pg_attribute_always_inline __forceinline
267#else
268/* Otherwise, the best we can do is to say "inline" */
269#define pg_attribute_always_inline inline
270#endif
271
272/*
273 * Forcing a function not to be inlined can be useful if it's the slow path of
274 * a performance-critical function, or should be visible in profiles to allow
275 * for proper cost attribution. Note that unlike the pg_attribute_XXX macros
276 * above, this should be placed before the function's return type and name.
277 */
278/* GCC supports noinline via __attribute__ */
279#if defined(__GNUC__)
280#define pg_noinline __attribute__((noinline))
281/* msvc via declspec */
282#elif defined(_MSC_VER)
283#define pg_noinline __declspec(noinline)
284#else
285#define pg_noinline
286#endif
287
288/*
289 * For now, just define pg_attribute_cold and pg_attribute_hot to be empty
290 * macros on minGW 8.1. There appears to be a compiler bug that results in
291 * compilation failure. At this time, we still have at least one buildfarm
292 * animal running that compiler, so this should make that green again. It's
293 * likely this compiler is not popular enough to warrant keeping this code
294 * around forever, so let's just remove it once the last buildfarm animal
295 * upgrades.
296 */
297#if defined(__MINGW64__) && __GNUC__ == 8 && __GNUC_MINOR__ == 1
298
299#define pg_attribute_cold
300#define pg_attribute_hot
301
302#else
303/*
304 * Marking certain functions as "hot" or "cold" can be useful to assist the
305 * compiler in arranging the assembly code in a more efficient way.
306 */
307#if __has_attribute (cold)
308#define pg_attribute_cold __attribute__((cold))
309#else
310#define pg_attribute_cold
311#endif
312
313#if __has_attribute (hot)
314#define pg_attribute_hot __attribute__((hot))
315#else
316#define pg_attribute_hot
317#endif
318
319#endif /* defined(__MINGW64__) && __GNUC__ == 8 &&
320 * __GNUC_MINOR__ == 1 */
321/*
322 * Mark a point as unreachable in a portable fashion. This should preferably
323 * be something that the compiler understands, to aid code generation.
324 * In assert-enabled builds, we prefer abort() for debugging reasons.
325 */
326#if defined(HAVE__BUILTIN_UNREACHABLE) && !defined(USE_ASSERT_CHECKING)
327#define pg_unreachable() __builtin_unreachable()
328#elif defined(_MSC_VER) && !defined(USE_ASSERT_CHECKING)
329#define pg_unreachable() __assume(0)
330#else
331#define pg_unreachable() abort()
332#endif
333
334/*
335 * Define a compiler-independent macro for determining if an expression is a
336 * compile-time integer const. We don't define this macro to return 0 when
337 * unsupported due to the risk of users of the macro misbehaving if we return
338 * 0 when the expression *is* an integer constant. Callers may check if this
339 * macro is defined by checking if HAVE_PG_INTEGER_CONSTANT_P is defined.
340 */
341#if defined(HAVE__BUILTIN_CONSTANT_P)
342
343/* When __builtin_constant_p() is available, use it. */
344#define pg_integer_constant_p(x) __builtin_constant_p(x)
345#define HAVE_PG_INTEGER_CONSTANT_P
346#elif defined(_MSC_VER) && defined(__STDC_VERSION__)
347
348/*
349 * With MSVC we can use a trick with _Generic to make this work. This has
350 * been borrowed from:
351 * https://stackoverflow.com/questions/49480442/detecting-integer-constant-expressions-in-macros
352 * and only works with integer constants. Compilation will fail if given a
353 * constant or variable of any type other than an integer.
354 */
355#define pg_integer_constant_p(x) \
356 _Generic((1 ? ((void *) ((x) * (uintptr_t) 0)) : &(int) {1}), int *: 1, void *: 0)
357#define HAVE_PG_INTEGER_CONSTANT_P
358#endif
359
360/*
361 * pg_assume(expr) states that we assume `expr` to evaluate to true. In assert
362 * enabled builds pg_assume() is turned into an assertion, in optimized builds
363 * we try to clue the compiler into the fact that `expr` is true.
364 *
365 * This is useful for two purposes:
366 *
367 * 1) Avoid compiler warnings by telling the compiler about assumptions the
368 * code makes. This is particularly useful when building with optimizations
369 * and w/o assertions.
370 *
371 * 2) Help the compiler to generate more efficient code
372 *
373 * It is unspecified whether `expr` is evaluated, therefore it better be
374 * side-effect free.
375 */
376#if defined(USE_ASSERT_CHECKING)
377#define pg_assume(expr) Assert(expr)
378#elif defined(HAVE__BUILTIN_UNREACHABLE)
379#define pg_assume(expr) \
380 do { \
381 if (!(expr)) \
382 __builtin_unreachable(); \
383 } while (0)
384#elif defined(_MSC_VER)
385#define pg_assume(expr) __assume(expr)
386#else
387#define pg_assume(expr) ((void) 0)
388#endif
389
390/*
391 * Hints to the compiler about the likelihood of a branch. Both likely() and
392 * unlikely() return the boolean value of the contained expression.
393 *
394 * These should only be used sparingly, in very hot code paths. It's very easy
395 * to mis-estimate likelihoods.
396 */
397#ifdef __GNUC__
398#define likely(x) __builtin_expect((x) != 0, 1)
399#define unlikely(x) __builtin_expect((x) != 0, 0)
400#else
401#define likely(x) ((x) != 0)
402#define unlikely(x) ((x) != 0)
403#endif
404
405/*
406 * CppAsString
407 * Convert the argument to a string, using the C preprocessor.
408 * CppAsString2
409 * Convert the argument to a string, after one round of macro expansion.
410 * CppConcat
411 * Concatenate two arguments together, using the C preprocessor.
412 *
413 * Note: There used to be support here for pre-ANSI C compilers that didn't
414 * support # and ##. Nowadays, these macros are just for clarity and/or
415 * backward compatibility with existing PostgreSQL code.
416 */
417#define CppAsString(identifier) #identifier
418#define CppAsString2(x) CppAsString(x)
419#define CppConcat(x, y) x##y
420
421/*
422 * VA_ARGS_NARGS
423 * Returns the number of macro arguments it is passed.
424 *
425 * An empty argument still counts as an argument, so effectively, this is
426 * "one more than the number of commas in the argument list".
427 *
428 * This works for up to 63 arguments. Internally, VA_ARGS_NARGS_() is passed
429 * 64+N arguments, and the C99 standard only requires macros to allow up to
430 * 127 arguments, so we can't portably go higher. The implementation is
431 * pretty trivial: VA_ARGS_NARGS_() returns its 64th argument, and we set up
432 * the call so that that is the appropriate one of the list of constants.
433 * This idea is due to Laurent Deniau.
434 */
435#define VA_ARGS_NARGS(...) \
436 VA_ARGS_NARGS_(__VA_ARGS__, \
437 63,62,61,60, \
438 59,58,57,56,55,54,53,52,51,50, \
439 49,48,47,46,45,44,43,42,41,40, \
440 39,38,37,36,35,34,33,32,31,30, \
441 29,28,27,26,25,24,23,22,21,20, \
442 19,18,17,16,15,14,13,12,11,10, \
443 9, 8, 7, 6, 5, 4, 3, 2, 1, 0)
444
445#define VA_ARGS_NARGS_( \
446 _01,_02,_03,_04,_05,_06,_07,_08,_09,_10, \
447 _11,_12,_13,_14,_15,_16,_17,_18,_19,_20, \
448 _21,_22,_23,_24,_25,_26,_27,_28,_29,_30, \
449 _31,_32,_33,_34,_35,_36,_37,_38,_39,_40, \
450 _41,_42,_43,_44,_45,_46,_47,_48,_49,_50, \
451 _51,_52,_53,_54,_55,_56,_57,_58,_59,_60, \
452 _61,_62,_63, N, ...) \
453 (N)
454
455/*
456 * Generic function pointer. This can be used in the rare cases where it's
457 * necessary to cast a function pointer to a seemingly incompatible function
458 * pointer type while avoiding gcc's -Wcast-function-type warnings.
459 */
460typedef void (*pg_funcptr_t) (void);
461
462/*
463 * We require C99, hence the compiler should understand flexible array
464 * members. However, for documentation purposes we still consider it to be
465 * project style to write "field[FLEXIBLE_ARRAY_MEMBER]" not just "field[]".
466 * When computing the size of such an object, use "offsetof(struct s, f)"
467 * for portability. Don't use "offsetof(struct s, f[0])", as this doesn't
468 * work with MSVC and with C++ compilers.
469 */
470#define FLEXIBLE_ARRAY_MEMBER /* empty */
471
472/*
473 * Does the compiler support #pragma GCC system_header? We optionally use it
474 * to avoid warnings that we can't fix (e.g. in the perl headers).
475 * See https://gcc.gnu.org/onlinedocs/cpp/System-Headers.html
476 *
477 * Headers for which we do not want to show compiler warnings can,
478 * conditionally, use #pragma GCC system_header to avoid warnings. Obviously
479 * this should only be used for external headers over which we do not have
480 * control.
481 *
482 * Support for the pragma is tested here, instead of during configure, as gcc
483 * also warns about the pragma being used in a .c file. It's surprisingly hard
484 * to get autoconf to use .h as the file-ending. Looks like gcc has
485 * implemented the pragma since the 2000, so this test should suffice.
486 *
487 *
488 * Alternatively, we could add the include paths for problematic headers with
489 * -isystem, but that is a larger hammer and is harder to search for.
490 *
491 * A more granular alternative would be to use #pragma GCC diagnostic
492 * push/ignored/pop, but gcc warns about unknown warnings being ignored, so
493 * every to-be-ignored-temporarily compiler warning would require its own
494 * pg_config.h symbol and #ifdef.
495 */
496#ifdef __GNUC__
497#define HAVE_PRAGMA_GCC_SYSTEM_HEADER 1
498#endif
499
500
501/* ----------------------------------------------------------------
502 * Section 2: bool, true, false
503 * ----------------------------------------------------------------
504 */
505
506/*
507 * bool
508 * Boolean value, either true or false.
509 *
510 * PostgreSQL currently cannot deal with bool of size other than 1; there are
511 * static assertions around the code to prevent that.
512 */
513
514#include <stdbool.h>
515
516
517/* ----------------------------------------------------------------
518 * Section 3: standard system types
519 * ----------------------------------------------------------------
520 */
521
522/*
523 * Pointer
524 * Variable holding address of any memory resident object.
525 *
526 * XXX Pointer arithmetic is done with this, so it can't be void *
527 * under "true" ANSI compilers.
528 */
529typedef char *Pointer;
530
531/* Historical names for types in <stdint.h>. */
532typedef int8_t int8;
533typedef int16_t int16;
534typedef int32_t int32;
535typedef int64_t int64;
536typedef uint8_t uint8;
537typedef uint16_t uint16;
538typedef uint32_t uint32;
539typedef uint64_t uint64;
540
541/*
542 * bitsN
543 * Unit of bitwise operation, AT LEAST N BITS IN SIZE.
544 */
545typedef uint8 bits8; /* >= 8 bits */
546typedef uint16 bits16; /* >= 16 bits */
547typedef uint32 bits32; /* >= 32 bits */
548
549/*
550 * 64-bit integers
551 */
552#define INT64CONST(x) INT64_C(x)
553#define UINT64CONST(x) UINT64_C(x)
554
555/* snprintf format strings to use for 64-bit integers */
556#define INT64_FORMAT "%" PRId64
557#define UINT64_FORMAT "%" PRIu64
558
559/*
560 * 128-bit signed and unsigned integers
561 * There currently is only limited support for such types.
562 * E.g. 128bit literals and snprintf are not supported; but math is.
563 * Also, because we exclude such types when choosing MAXIMUM_ALIGNOF,
564 * it must be possible to coerce the compiler to allocate them on no
565 * more than MAXALIGN boundaries.
566 */
567#if defined(PG_INT128_TYPE)
568#if defined(pg_attribute_aligned) || ALIGNOF_PG_INT128_TYPE <= MAXIMUM_ALIGNOF
569#define HAVE_INT128 1
570
571typedef PG_INT128_TYPE int128
572#if defined(pg_attribute_aligned)
573 pg_attribute_aligned(MAXIMUM_ALIGNOF)
574#endif
575 ;
576
577typedef unsigned PG_INT128_TYPE uint128
578#if defined(pg_attribute_aligned)
579 pg_attribute_aligned(MAXIMUM_ALIGNOF)
580#endif
581 ;
582
583#endif
584#endif
585
586/* Historical names for limits in <stdint.h>. */
587#define PG_INT8_MIN INT8_MIN
588#define PG_INT8_MAX INT8_MAX
589#define PG_UINT8_MAX UINT8_MAX
590#define PG_INT16_MIN INT16_MIN
591#define PG_INT16_MAX INT16_MAX
592#define PG_UINT16_MAX UINT16_MAX
593#define PG_INT32_MIN INT32_MIN
594#define PG_INT32_MAX INT32_MAX
595#define PG_UINT32_MAX UINT32_MAX
596#define PG_INT64_MIN INT64_MIN
597#define PG_INT64_MAX INT64_MAX
598#define PG_UINT64_MAX UINT64_MAX
599
600/*
601 * We now always use int64 timestamps, but keep this symbol defined for the
602 * benefit of external code that might test it.
603 */
604#define HAVE_INT64_TIMESTAMP
605
606/*
607 * Size
608 * Size of any memory resident object, as returned by sizeof.
609 */
610typedef size_t Size;
611
612/*
613 * Index
614 * Index into any memory resident array.
615 *
616 * Note:
617 * Indices are non negative.
618 */
619typedef unsigned int Index;
620
621/*
622 * Offset
623 * Offset into any memory resident array.
624 *
625 * Note:
626 * This differs from an Index in that an Index is always
627 * non negative, whereas Offset may be negative.
628 */
629typedef signed int Offset;
630
631/*
632 * Common Postgres datatype names (as used in the catalogs)
633 */
634typedef float float4;
635typedef double float8;
636
637/*
638 * float8, int8, and related datatypes are now always pass-by-value.
639 * We keep this symbol to avoid breaking extension code that may use it.
640 */
641#define FLOAT8PASSBYVAL true
642
643/*
644 * Oid, RegProcedure, TransactionId, SubTransactionId, MultiXactId,
645 * CommandId
646 */
647
648/* typedef Oid is in postgres_ext.h */
649
650/*
651 * regproc is the type name used in the include/catalog headers, but
652 * RegProcedure is the preferred name in C code.
653 */
654typedef Oid regproc;
656
658
660
662
663#define InvalidSubTransactionId ((SubTransactionId) 0)
664#define TopSubTransactionId ((SubTransactionId) 1)
665
666/* MultiXactId must be equivalent to TransactionId, to fit in t_xmax */
668
670
672
673#define FirstCommandId ((CommandId) 0)
674#define InvalidCommandId (~(CommandId)0)
675
676
677/* ----------------
678 * Variable-length datatypes all share the 'struct varlena' header.
679 *
680 * NOTE: for TOASTable types, this is an oversimplification, since the value
681 * may be compressed or moved out-of-line. However datatype-specific routines
682 * are mostly content to deal with de-TOASTed values only, and of course
683 * client-side routines should never see a TOASTed value. But even in a
684 * de-TOASTed value, beware of touching vl_len_ directly, as its
685 * representation is no longer convenient. It's recommended that code always
686 * use macros VARDATA_ANY, VARSIZE_ANY, VARSIZE_ANY_EXHDR, VARDATA, VARSIZE,
687 * and SET_VARSIZE instead of relying on direct mentions of the struct fields.
688 * See varatt.h for details of the TOASTed form.
689 * ----------------
690 */
692{
693 char vl_len_[4]; /* Do not touch this field directly! */
694 char vl_dat[FLEXIBLE_ARRAY_MEMBER]; /* Data content is here */
695};
696
697#define VARHDRSZ ((int32) sizeof(int32))
698
699/*
700 * These widely-used datatypes are just a varlena header and the data bytes.
701 * There is no terminating null or anything like that --- the data length is
702 * always VARSIZE_ANY_EXHDR(ptr).
703 */
704typedef struct varlena bytea;
705typedef struct varlena text;
706typedef struct varlena BpChar; /* blank-padded char, ie SQL char(n) */
707typedef struct varlena VarChar; /* var-length char, ie SQL varchar(n) */
708
709/*
710 * Specialized array types. These are physically laid out just the same
711 * as regular arrays (so that the regular array subscripting code works
712 * with them). They exist as distinct types mostly for historical reasons:
713 * they have nonstandard I/O behavior which we don't want to change for fear
714 * of breaking applications that look at the system catalogs. There is also
715 * an implementation issue for oidvector: it's part of the primary key for
716 * pg_proc, and we can't use the normal btree array support routines for that
717 * without circularity.
718 */
719typedef struct
720{
721 int32 vl_len_; /* these fields must match ArrayType! */
722 int ndim; /* always 1 for int2vector */
723 int32 dataoffset; /* always 0 for int2vector */
725 int dim1;
728} int2vector;
729
730typedef struct
731{
732 int32 vl_len_; /* these fields must match ArrayType! */
733 int ndim; /* always 1 for oidvector */
734 int32 dataoffset; /* always 0 for oidvector */
736 int dim1;
739} oidvector;
740
741/*
742 * Representation of a Name: effectively just a C string, but null-padded to
743 * exactly NAMEDATALEN bytes. The use of a struct is historical.
744 */
745typedef struct nameData
746{
749typedef NameData *Name;
750
751#define NameStr(name) ((name).data)
752
753
754/* ----------------------------------------------------------------
755 * Section 4: IsValid macros for system types
756 * ----------------------------------------------------------------
757 */
758/*
759 * BoolIsValid
760 * True iff bool is valid.
761 */
762#define BoolIsValid(boolean) ((boolean) == false || (boolean) == true)
763
764/*
765 * PointerIsAligned
766 * True iff pointer is properly aligned to point to the given type.
767 */
768#define PointerIsAligned(pointer, type) \
769 (((uintptr_t)(pointer) % (sizeof (type))) == 0)
770
771#define OffsetToPointer(base, offset) \
772 ((void *)((char *) base + offset))
773
774#define OidIsValid(objectId) ((bool) ((objectId) != InvalidOid))
775
776#define RegProcedureIsValid(p) OidIsValid(p)
777
778
779/* ----------------------------------------------------------------
780 * Section 5: lengthof, alignment
781 * ----------------------------------------------------------------
782 */
783/*
784 * lengthof
785 * Number of elements in an array.
786 */
787#define lengthof(array) (sizeof (array) / sizeof ((array)[0]))
788
789/* ----------------
790 * Alignment macros: align a length or address appropriately for a given type.
791 * The fooALIGN() macros round up to a multiple of the required alignment,
792 * while the fooALIGN_DOWN() macros round down. The latter are more useful
793 * for problems like "how many X-sized structures will fit in a page?".
794 *
795 * NOTE: TYPEALIGN[_DOWN] will not work if ALIGNVAL is not a power of 2.
796 * That case seems extremely unlikely to be needed in practice, however.
797 *
798 * NOTE: MAXIMUM_ALIGNOF, and hence MAXALIGN(), intentionally exclude any
799 * larger-than-8-byte types the compiler might have.
800 * ----------------
801 */
802
803#define TYPEALIGN(ALIGNVAL,LEN) \
804 (((uintptr_t) (LEN) + ((ALIGNVAL) - 1)) & ~((uintptr_t) ((ALIGNVAL) - 1)))
805
806#define SHORTALIGN(LEN) TYPEALIGN(ALIGNOF_SHORT, (LEN))
807#define INTALIGN(LEN) TYPEALIGN(ALIGNOF_INT, (LEN))
808#define LONGALIGN(LEN) TYPEALIGN(ALIGNOF_LONG, (LEN))
809#define DOUBLEALIGN(LEN) TYPEALIGN(ALIGNOF_DOUBLE, (LEN))
810#define MAXALIGN(LEN) TYPEALIGN(MAXIMUM_ALIGNOF, (LEN))
811/* MAXALIGN covers only built-in types, not buffers */
812#define BUFFERALIGN(LEN) TYPEALIGN(ALIGNOF_BUFFER, (LEN))
813#define CACHELINEALIGN(LEN) TYPEALIGN(PG_CACHE_LINE_SIZE, (LEN))
814
815#define TYPEALIGN_DOWN(ALIGNVAL,LEN) \
816 (((uintptr_t) (LEN)) & ~((uintptr_t) ((ALIGNVAL) - 1)))
817
818#define SHORTALIGN_DOWN(LEN) TYPEALIGN_DOWN(ALIGNOF_SHORT, (LEN))
819#define INTALIGN_DOWN(LEN) TYPEALIGN_DOWN(ALIGNOF_INT, (LEN))
820#define LONGALIGN_DOWN(LEN) TYPEALIGN_DOWN(ALIGNOF_LONG, (LEN))
821#define DOUBLEALIGN_DOWN(LEN) TYPEALIGN_DOWN(ALIGNOF_DOUBLE, (LEN))
822#define MAXALIGN_DOWN(LEN) TYPEALIGN_DOWN(MAXIMUM_ALIGNOF, (LEN))
823#define BUFFERALIGN_DOWN(LEN) TYPEALIGN_DOWN(ALIGNOF_BUFFER, (LEN))
824
825/*
826 * The above macros will not work with types wider than uintptr_t, like with
827 * uint64 on 32-bit platforms. That's not problem for the usual use where a
828 * pointer or a length is aligned, but for the odd case that you need to
829 * align something (potentially) wider, use TYPEALIGN64.
830 */
831#define TYPEALIGN64(ALIGNVAL,LEN) \
832 (((uint64) (LEN) + ((ALIGNVAL) - 1)) & ~((uint64) ((ALIGNVAL) - 1)))
833
834/* we don't currently need wider versions of the other ALIGN macros */
835#define MAXALIGN64(LEN) TYPEALIGN64(MAXIMUM_ALIGNOF, (LEN))
836
837
838/* ----------------------------------------------------------------
839 * Section 6: assertions
840 * ----------------------------------------------------------------
841 */
842
843/*
844 * USE_ASSERT_CHECKING, if defined, turns on all the assertions.
845 * - plai 9/5/90
846 *
847 * It should _NOT_ be defined in releases or in benchmark copies
848 */
849
850/*
851 * Assert() can be used in both frontend and backend code. In frontend code it
852 * just calls the standard assert, if it's available. If use of assertions is
853 * not configured, it does nothing.
854 */
855#ifndef USE_ASSERT_CHECKING
856
857#define Assert(condition) ((void)true)
858#define AssertMacro(condition) ((void)true)
859
860#elif defined(FRONTEND)
861
862#include <assert.h>
863#define Assert(p) assert(p)
864#define AssertMacro(p) ((void) assert(p))
865
866#else /* USE_ASSERT_CHECKING && !FRONTEND */
867
868/*
869 * Assert
870 * Generates a fatal exception if the given condition is false.
871 */
872#define Assert(condition) \
873 do { \
874 if (!(condition)) \
875 ExceptionalCondition(#condition, __FILE__, __LINE__); \
876 } while (0)
877
878/*
879 * AssertMacro is the same as Assert but it's suitable for use in
880 * expression-like macros, for example:
881 *
882 * #define foo(x) (AssertMacro(x != 0), bar(x))
883 */
884#define AssertMacro(condition) \
885 ((void) ((condition) || \
886 (ExceptionalCondition(#condition, __FILE__, __LINE__), 0)))
887
888#endif /* USE_ASSERT_CHECKING && !FRONTEND */
889
890/*
891 * Check that `ptr' is `bndr' aligned.
892 */
893#define AssertPointerAlignment(ptr, bndr) \
894 Assert(TYPEALIGN(bndr, (uintptr_t)(ptr)) == (uintptr_t)(ptr))
895
896/*
897 * ExceptionalCondition is compiled into the backend whether or not
898 * USE_ASSERT_CHECKING is defined, so as to support use of extensions
899 * that are built with that #define with a backend that isn't. Hence,
900 * we should declare it as long as !FRONTEND.
901 */
902#ifndef FRONTEND
903pg_noreturn extern void ExceptionalCondition(const char *conditionName,
904 const char *fileName, int lineNumber);
905#endif
906
907/*
908 * Macros to support compile-time assertion checks.
909 *
910 * If the "condition" (a compile-time-constant expression) evaluates to false,
911 * throw a compile error using the "errmessage" (a string literal).
912 *
913 * C11 has _Static_assert(), and most C99 compilers already support that. For
914 * portability, we wrap it into StaticAssertDecl(). _Static_assert() is a
915 * "declaration", and so it must be placed where for example a variable
916 * declaration would be valid. As long as we compile with
917 * -Wno-declaration-after-statement, that also means it cannot be placed after
918 * statements in a function. Macros StaticAssertStmt() and StaticAssertExpr()
919 * make it safe to use as a statement or in an expression, respectively.
920 *
921 * For compilers without _Static_assert(), we fall back on a kluge that
922 * assumes the compiler will complain about a negative width for a struct
923 * bit-field. This will not include a helpful error message, but it beats not
924 * getting an error at all.
925 */
926#ifndef __cplusplus
927#ifdef HAVE__STATIC_ASSERT
928#define StaticAssertDecl(condition, errmessage) \
929 _Static_assert(condition, errmessage)
930#define StaticAssertStmt(condition, errmessage) \
931 do { _Static_assert(condition, errmessage); } while(0)
932#define StaticAssertExpr(condition, errmessage) \
933 ((void) ({ StaticAssertStmt(condition, errmessage); true; }))
934#else /* !HAVE__STATIC_ASSERT */
935#define StaticAssertDecl(condition, errmessage) \
936 extern void static_assert_func(int static_assert_failure[(condition) ? 1 : -1])
937#define StaticAssertStmt(condition, errmessage) \
938 ((void) sizeof(struct { int static_assert_failure : (condition) ? 1 : -1; }))
939#define StaticAssertExpr(condition, errmessage) \
940 StaticAssertStmt(condition, errmessage)
941#endif /* HAVE__STATIC_ASSERT */
942#else /* C++ */
943#if defined(__cpp_static_assert) && __cpp_static_assert >= 200410
944#define StaticAssertDecl(condition, errmessage) \
945 static_assert(condition, errmessage)
946#define StaticAssertStmt(condition, errmessage) \
947 static_assert(condition, errmessage)
948#define StaticAssertExpr(condition, errmessage) \
949 ({ static_assert(condition, errmessage); })
950#else /* !__cpp_static_assert */
951#define StaticAssertDecl(condition, errmessage) \
952 extern void static_assert_func(int static_assert_failure[(condition) ? 1 : -1])
953#define StaticAssertStmt(condition, errmessage) \
954 do { struct static_assert_struct { int static_assert_failure : (condition) ? 1 : -1; }; } while(0)
955#define StaticAssertExpr(condition, errmessage) \
956 ((void) ({ StaticAssertStmt(condition, errmessage); }))
957#endif /* __cpp_static_assert */
958#endif /* C++ */
959
960
961/*
962 * Compile-time checks that a variable (or expression) has the specified type.
963 *
964 * AssertVariableIsOfType() can be used as a statement.
965 * AssertVariableIsOfTypeMacro() is intended for use in macros, eg
966 * #define foo(x) (AssertVariableIsOfTypeMacro(x, int), bar(x))
967 *
968 * If we don't have __builtin_types_compatible_p, we can still assert that
969 * the types have the same size. This is far from ideal (especially on 32-bit
970 * platforms) but it provides at least some coverage.
971 */
972#ifdef HAVE__BUILTIN_TYPES_COMPATIBLE_P
973#define AssertVariableIsOfType(varname, typename) \
974 StaticAssertStmt(__builtin_types_compatible_p(__typeof__(varname), typename), \
975 CppAsString(varname) " does not have type " CppAsString(typename))
976#define AssertVariableIsOfTypeMacro(varname, typename) \
977 (StaticAssertExpr(__builtin_types_compatible_p(__typeof__(varname), typename), \
978 CppAsString(varname) " does not have type " CppAsString(typename)))
979#else /* !HAVE__BUILTIN_TYPES_COMPATIBLE_P */
980#define AssertVariableIsOfType(varname, typename) \
981 StaticAssertStmt(sizeof(varname) == sizeof(typename), \
982 CppAsString(varname) " does not have type " CppAsString(typename))
983#define AssertVariableIsOfTypeMacro(varname, typename) \
984 (StaticAssertExpr(sizeof(varname) == sizeof(typename), \
985 CppAsString(varname) " does not have type " CppAsString(typename)))
986#endif /* HAVE__BUILTIN_TYPES_COMPATIBLE_P */
987
988
989/* ----------------------------------------------------------------
990 * Section 7: widely useful macros
991 * ----------------------------------------------------------------
992 */
993/*
994 * Max
995 * Return the maximum of two numbers.
996 */
997#define Max(x, y) ((x) > (y) ? (x) : (y))
998
999/*
1000 * Min
1001 * Return the minimum of two numbers.
1002 */
1003#define Min(x, y) ((x) < (y) ? (x) : (y))
1004
1005
1006/* Get a bit mask of the bits set in non-long aligned addresses */
1007#define LONG_ALIGN_MASK (sizeof(long) - 1)
1008
1009/*
1010 * MemSet
1011 * Exactly the same as standard library function memset(), but considerably
1012 * faster for zeroing small word-aligned structures (such as parsetree nodes).
1013 * This has to be a macro because the main point is to avoid function-call
1014 * overhead. However, we have also found that the loop is faster than
1015 * native libc memset() on some platforms, even those with assembler
1016 * memset() functions. More research needs to be done, perhaps with
1017 * MEMSET_LOOP_LIMIT tests in configure.
1018 */
1019#define MemSet(start, val, len) \
1020 do \
1021 { \
1022 /* must be void* because we don't know if it is integer aligned yet */ \
1023 void *_vstart = (void *) (start); \
1024 int _val = (val); \
1025 Size _len = (len); \
1026\
1027 if ((((uintptr_t) _vstart) & LONG_ALIGN_MASK) == 0 && \
1028 (_len & LONG_ALIGN_MASK) == 0 && \
1029 _val == 0 && \
1030 _len <= MEMSET_LOOP_LIMIT && \
1031 /* \
1032 * If MEMSET_LOOP_LIMIT == 0, optimizer should find \
1033 * the whole "if" false at compile time. \
1034 */ \
1035 MEMSET_LOOP_LIMIT != 0) \
1036 { \
1037 long *_start = (long *) _vstart; \
1038 long *_stop = (long *) ((char *) _start + _len); \
1039 while (_start < _stop) \
1040 *_start++ = 0; \
1041 } \
1042 else \
1043 memset(_vstart, _val, _len); \
1044 } while (0)
1045
1046/*
1047 * MemSetAligned is the same as MemSet except it omits the test to see if
1048 * "start" is word-aligned. This is okay to use if the caller knows a-priori
1049 * that the pointer is suitably aligned (typically, because he just got it
1050 * from palloc(), which always delivers a max-aligned pointer).
1051 */
1052#define MemSetAligned(start, val, len) \
1053 do \
1054 { \
1055 long *_start = (long *) (start); \
1056 int _val = (val); \
1057 Size _len = (len); \
1058\
1059 if ((_len & LONG_ALIGN_MASK) == 0 && \
1060 _val == 0 && \
1061 _len <= MEMSET_LOOP_LIMIT && \
1062 MEMSET_LOOP_LIMIT != 0) \
1063 { \
1064 long *_stop = (long *) ((char *) _start + _len); \
1065 while (_start < _stop) \
1066 *_start++ = 0; \
1067 } \
1068 else \
1069 memset(_start, _val, _len); \
1070 } while (0)
1071
1072
1073/*
1074 * Macros for range-checking float values before converting to integer.
1075 * We must be careful here that the boundary values are expressed exactly
1076 * in the float domain. PG_INTnn_MIN is an exact power of 2, so it will
1077 * be represented exactly; but PG_INTnn_MAX isn't, and might get rounded
1078 * off, so avoid using that.
1079 * The input must be rounded to an integer beforehand, typically with rint(),
1080 * else we might draw the wrong conclusion about close-to-the-limit values.
1081 * These macros will do the right thing for Inf, but not necessarily for NaN,
1082 * so check isnan(num) first if that's a possibility.
1084#define FLOAT4_FITS_IN_INT16(num) \
1085 ((num) >= (float4) PG_INT16_MIN && (num) < -((float4) PG_INT16_MIN))
1086#define FLOAT4_FITS_IN_INT32(num) \
1087 ((num) >= (float4) PG_INT32_MIN && (num) < -((float4) PG_INT32_MIN))
1088#define FLOAT4_FITS_IN_INT64(num) \
1089 ((num) >= (float4) PG_INT64_MIN && (num) < -((float4) PG_INT64_MIN))
1090#define FLOAT8_FITS_IN_INT16(num) \
1091 ((num) >= (float8) PG_INT16_MIN && (num) < -((float8) PG_INT16_MIN))
1092#define FLOAT8_FITS_IN_INT32(num) \
1093 ((num) >= (float8) PG_INT32_MIN && (num) < -((float8) PG_INT32_MIN))
1094#define FLOAT8_FITS_IN_INT64(num) \
1095 ((num) >= (float8) PG_INT64_MIN && (num) < -((float8) PG_INT64_MIN))
1096
1097
1098/* ----------------------------------------------------------------
1099 * Section 8: random stuff
1100 * ----------------------------------------------------------------
1101 */
1102
1103/*
1104 * Invert the sign of a qsort-style comparison result, ie, exchange negative
1105 * and positive integer values, being careful not to get the wrong answer
1106 * for INT_MIN. The argument should be an integral variable.
1107 */
1108#define INVERT_COMPARE_RESULT(var) \
1109 ((var) = ((var) < 0) ? 1 : -(var))
1110
1111/*
1112 * Use this, not "char buf[BLCKSZ]", to declare a field or local variable
1113 * holding a page buffer, if that page might be accessed as a page. Otherwise
1114 * the variable might be under-aligned, causing problems on alignment-picky
1115 * hardware. We include both "double" and "int64" in the union to ensure that
1116 * the compiler knows the value must be MAXALIGN'ed (cf. configure's
1117 * computation of MAXIMUM_ALIGNOF).
1119typedef union PGAlignedBlock
1121 char data[BLCKSZ];
1122 double force_align_d;
1125
1126/*
1127 * Use this to declare a field or local variable holding a page buffer, if that
1128 * page might be accessed as a page or passed to an SMgr I/O function. If
1129 * allocating using the MemoryContext API, the aligned allocation functions
1130 * should be used with PG_IO_ALIGN_SIZE. This alignment may be more efficient
1131 * for I/O in general, but may be strictly required on some platforms when
1132 * using direct I/O.
1133 */
1134typedef union PGIOAlignedBlock
1135{
1136#ifdef pg_attribute_aligned
1138#endif
1139 char data[BLCKSZ];
1140 double force_align_d;
1143
1144/* Same, but for an XLOG_BLCKSZ-sized buffer */
1145typedef union PGAlignedXLogBlock
1146{
1147#ifdef pg_attribute_aligned
1149#endif
1150 char data[XLOG_BLCKSZ];
1151 double force_align_d;
1155/* msb for char */
1156#define HIGHBIT (0x80)
1157#define IS_HIGHBIT_SET(ch) ((unsigned char)(ch) & HIGHBIT)
1158
1159/*
1160 * Support macros for escaping strings. escape_backslash should be true
1161 * if generating a non-standard-conforming string. Prefixing a string
1162 * with ESCAPE_STRING_SYNTAX guarantees it is non-standard-conforming.
1163 * Beware of multiple evaluation of the "ch" argument!
1164 */
1165#define SQL_STR_DOUBLE(ch, escape_backslash) \
1166 ((ch) == '\'' || ((ch) == '\\' && (escape_backslash)))
1167
1168#define ESCAPE_STRING_SYNTAX 'E'
1171#define STATUS_OK (0)
1172#define STATUS_ERROR (-1)
1173#define STATUS_EOF (-2)
1174
1175/*
1176 * gettext support
1177 */
1179#ifndef ENABLE_NLS
1180/* stuff we'd otherwise get from <libintl.h> */
1181#define gettext(x) (x)
1182#define dgettext(d,x) (x)
1183#define ngettext(s,p,n) ((n) == 1 ? (s) : (p))
1184#define dngettext(d,s,p,n) ((n) == 1 ? (s) : (p))
1185#endif
1186
1187#define _(x) gettext(x)
1188
1189/*
1190 * Use this to mark string constants as needing translation at some later
1191 * time, rather than immediately. This is useful for cases where you need
1192 * access to the original string and translated string, and for cases where
1193 * immediate translation is not possible, like when initializing global
1194 * variables.
1196 * https://www.gnu.org/software/gettext/manual/html_node/Special-cases.html
1197 */
1198#define gettext_noop(x) (x)
1199
1200/*
1201 * To better support parallel installations of major PostgreSQL
1202 * versions as well as parallel installations of major library soname
1203 * versions, we mangle the gettext domain name by appending those
1204 * version numbers. The coding rule ought to be that wherever the
1205 * domain name is mentioned as a literal, it must be wrapped into
1206 * PG_TEXTDOMAIN(). The macros below do not work on non-literals; but
1207 * that is somewhat intentional because it avoids having to worry
1208 * about multiple states of premangling and postmangling as the values
1209 * are being passed around.
1210 *
1211 * Make sure this matches the installation rules in nls-global.mk.
1212 */
1213#ifdef SO_MAJOR_VERSION
1214#define PG_TEXTDOMAIN(domain) (domain CppAsString2(SO_MAJOR_VERSION) "-" PG_MAJORVERSION)
1215#else
1216#define PG_TEXTDOMAIN(domain) (domain "-" PG_MAJORVERSION)
1217#endif
1218
1219/*
1220 * Macro that allows to cast constness and volatile away from an expression, but doesn't
1221 * allow changing the underlying type. Enforcement of the latter
1222 * currently only works for gcc like compilers.
1223 *
1224 * Please note IT IS NOT SAFE to cast constness away if the result will ever
1225 * be modified (it would be undefined behaviour). Doing so anyway can cause
1226 * compiler misoptimizations or runtime crashes (modifying readonly memory).
1227 * It is only safe to use when the result will not be modified, but API
1228 * design or language restrictions prevent you from declaring that
1229 * (e.g. because a function returns both const and non-const variables).
1230 *
1231 * Note that this only works in function scope, not for global variables (it'd
1232 * be nice, but not trivial, to improve that).
1233 */
1234#if defined(__cplusplus)
1235#define unconstify(underlying_type, expr) const_cast<underlying_type>(expr)
1236#define unvolatize(underlying_type, expr) const_cast<underlying_type>(expr)
1237#elif defined(HAVE__BUILTIN_TYPES_COMPATIBLE_P)
1238#define unconstify(underlying_type, expr) \
1239 (StaticAssertExpr(__builtin_types_compatible_p(__typeof(expr), const underlying_type), \
1240 "wrong cast"), \
1241 (underlying_type) (expr))
1242#define unvolatize(underlying_type, expr) \
1243 (StaticAssertExpr(__builtin_types_compatible_p(__typeof(expr), volatile underlying_type), \
1244 "wrong cast"), \
1245 (underlying_type) (expr))
1246#else
1247#define unconstify(underlying_type, expr) \
1248 ((underlying_type) (expr))
1249#define unvolatize(underlying_type, expr) \
1250 ((underlying_type) (expr))
1251#endif
1252
1253/* ----------------------------------------------------------------
1254 * Section 9: system-specific hacks
1255 *
1256 * This should be limited to things that absolutely have to be
1257 * included in every source file. The port-specific header file
1258 * is usually a better place for this sort of thing.
1259 * ----------------------------------------------------------------
1260 */
1261
1262/*
1263 * NOTE: this is also used for opening text files.
1264 * WIN32 treats Control-Z as EOF in files opened in text mode.
1265 * Therefore, we open files in binary mode on Win32 so we can read
1266 * literal control-Z. The other affect is that we see CRLF, but
1267 * that is OK because we can already handle those cleanly.
1268 */
1269#if defined(WIN32) || defined(__CYGWIN__)
1270#define PG_BINARY O_BINARY
1271#define PG_BINARY_A "ab"
1272#define PG_BINARY_R "rb"
1273#define PG_BINARY_W "wb"
1274#else
1275#define PG_BINARY 0
1276#define PG_BINARY_A "a"
1277#define PG_BINARY_R "r"
1278#define PG_BINARY_W "w"
1279#endif
1280
1281/*
1282 * Provide prototypes for routines not present in a particular machine's
1283 * standard C library.
1284 */
1285
1286#if !HAVE_DECL_FDATASYNC
1287extern int fdatasync(int fildes);
1288#endif
1289
1290/*
1291 * Thin wrappers that convert strings to exactly 64-bit integers, matching our
1292 * definition of int64. (For the naming, compare that POSIX has
1293 * strtoimax()/strtoumax() which return intmax_t/uintmax_t.)
1294 */
1295#if SIZEOF_LONG == 8
1296#define strtoi64(str, endptr, base) ((int64) strtol(str, endptr, base))
1297#define strtou64(str, endptr, base) ((uint64) strtoul(str, endptr, base))
1298#elif SIZEOF_LONG_LONG == 8
1299#define strtoi64(str, endptr, base) ((int64) strtoll(str, endptr, base))
1300#define strtou64(str, endptr, base) ((uint64) strtoull(str, endptr, base))
1301#else
1302#error "cannot find integer type of the same size as int64_t"
1303#endif
1304
1305/*
1306 * Similarly, wrappers around labs()/llabs() matching our int64.
1307 */
1308#if SIZEOF_LONG == 8
1309#define i64abs(i) ((int64) labs(i))
1310#elif SIZEOF_LONG_LONG == 8
1311#define i64abs(i) ((int64) llabs(i))
1312#else
1313#error "cannot find integer type of the same size as int64_t"
1314#endif
1315
1316/*
1317 * Use "extern PGDLLIMPORT ..." to declare variables that are defined
1318 * in the core backend and need to be accessible by loadable modules.
1319 * No special marking is required on most ports.
1320 */
1321#ifndef PGDLLIMPORT
1322#define PGDLLIMPORT
1323#endif
1324
1325/*
1326 * Use "extern PGDLLEXPORT ..." to declare functions that are defined in
1327 * loadable modules and need to be callable by the core backend or other
1328 * loadable modules.
1329 * If the compiler knows __attribute__((visibility("*"))), we use that,
1330 * unless we already have a platform-specific definition. Otherwise,
1331 * no special marking is required.
1332 */
1333#ifndef PGDLLEXPORT
1334#ifdef HAVE_VISIBILITY_ATTRIBUTE
1335#define PGDLLEXPORT __attribute__((visibility("default")))
1336#else
1337#define PGDLLEXPORT
1338#endif
1339#endif
1340
1341/*
1342 * The following is used as the arg list for signal handlers. Any ports
1343 * that take something other than an int argument should override this in
1344 * their pg_config_os.h file. Note that variable names are required
1345 * because it is used in both the prototypes as well as the definitions.
1346 * Note also the long name. We expect that this won't collide with
1347 * other names causing compiler warnings.
1349
1350#ifndef SIGNAL_ARGS
1351#define SIGNAL_ARGS int postgres_signal_arg
1352#endif
1353
1354/*
1355 * When there is no sigsetjmp, its functionality is provided by plain
1356 * setjmp. We now support the case only on Windows. However, it seems
1357 * that MinGW-64 has some longstanding issues in its setjmp support,
1358 * so on that toolchain we cheat and use gcc's builtins.
1359 */
1360#ifdef WIN32
1361#ifdef __MINGW64__
1362typedef intptr_t sigjmp_buf[5];
1363#define sigsetjmp(x,y) __builtin_setjmp(x)
1364#define siglongjmp __builtin_longjmp
1365#else /* !__MINGW64__ */
1366#define sigjmp_buf jmp_buf
1367#define sigsetjmp(x,y) setjmp(x)
1368#define siglongjmp longjmp
1369#endif /* __MINGW64__ */
1370#endif /* WIN32 */
1371
1372/* /port compatibility functions */
1373#include "port.h"
1374
1375/* IWYU pragma: end_exports */
1376
1377#endif /* C_H */
static Datum values[MAXATTR]
Definition: bootstrap.c:153
uint16 bits16
Definition: c.h:546
NameData * Name
Definition: c.h:749
union PGAlignedBlock PGAlignedBlock
union PGAlignedXLogBlock PGAlignedXLogBlock
uint8_t uint8
Definition: c.h:536
uint32 SubTransactionId
Definition: c.h:661
#define pg_noreturn
Definition: c.h:164
pg_noreturn void ExceptionalCondition(const char *conditionName, const char *fileName, int lineNumber)
Definition: assert.c:30
char * Pointer
Definition: c.h:529
int64_t int64
Definition: c.h:535
Oid regproc
Definition: c.h:654
uint32 MultiXactOffset
Definition: c.h:669
double float8
Definition: c.h:635
TransactionId MultiXactId
Definition: c.h:667
#define FLEXIBLE_ARRAY_MEMBER
Definition: c.h:470
int16_t int16
Definition: c.h:533
regproc RegProcedure
Definition: c.h:655
int8_t int8
Definition: c.h:532
uint8 bits8
Definition: c.h:545
uint32 bits32
Definition: c.h:547
int32_t int32
Definition: c.h:534
uint64_t uint64
Definition: c.h:539
uint16_t uint16
Definition: c.h:537
uint32_t uint32
Definition: c.h:538
unsigned int Index
Definition: c.h:619
float float4
Definition: c.h:634
uint32 LocalTransactionId
Definition: c.h:659
union PGIOAlignedBlock PGIOAlignedBlock
uint32 CommandId
Definition: c.h:671
uint32 TransactionId
Definition: c.h:657
signed int Offset
Definition: c.h:629
int fdatasync(int fildes)
void(* pg_funcptr_t)(void)
Definition: c.h:460
size_t Size
Definition: c.h:610
struct nameData NameData
struct pg_attribute_aligned(8) pg_atomic_uint64
Definition: generic-msvc.h:40
#define NAMEDATALEN
#define PG_IO_ALIGN_SIZE
unsigned int Oid
Definition: postgres_ext.h:32
Definition: c.h:720
int32 vl_len_
Definition: c.h:721
int ndim
Definition: c.h:722
int dim1
Definition: c.h:725
Oid elemtype
Definition: c.h:724
int32 dataoffset
Definition: c.h:723
int lbound1
Definition: c.h:726
Definition: c.h:746
char data[NAMEDATALEN]
Definition: c.h:747
Definition: c.h:731
int dim1
Definition: c.h:736
int32 dataoffset
Definition: c.h:734
Oid elemtype
Definition: c.h:735
int lbound1
Definition: c.h:737
int ndim
Definition: c.h:733
int32 vl_len_
Definition: c.h:732
Definition: c.h:692
char vl_len_[4]
Definition: c.h:693
char vl_dat[FLEXIBLE_ARRAY_MEMBER]
Definition: c.h:694
double force_align_d
Definition: c.h:1119
int64 force_align_i64
Definition: c.h:1120
char data[BLCKSZ]
Definition: c.h:1118
char data[XLOG_BLCKSZ]
Definition: c.h:1147
double force_align_d
Definition: c.h:1148
int64 force_align_i64
Definition: c.h:1149
double force_align_d
Definition: c.h:1137
int64 force_align_i64
Definition: c.h:1138
char data[BLCKSZ]
Definition: c.h:1136