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