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