1 /*-------------------------------------------------------------------------
4 * Fundamental C definitions. This is included by every .c file in
5 * PostgreSQL (via either postgres.h or postgres_fe.h, as appropriate).
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...
12 * Portions Copyright (c) 1996-2016, PostgreSQL Global Development Group
13 * Portions Copyright (c) 1994, Regents of the University of California
17 *-------------------------------------------------------------------------
20 *----------------------------------------------------------------
23 * When adding stuff to this file, please try to put stuff
24 * into the relevant section, or add new sections as appropriate.
27 * ------- ------------------------------------------------
28 * 0) pg_config.h and standard system headers
29 * 1) hacks to cope with non-ANSI C compilers
30 * 2) bool, true, false, TRUE, FALSE, NULL
31 * 3) standard system types
32 * 4) IsValid macros for system types
33 * 5) offsetof, lengthof, endof, alignment
35 * 7) widely useful macros
37 * 9) system-specific hacks
39 * NOTE: since this file is included by both frontend and backend modules, it's
40 * almost certainly wrong to put an "extern" declaration here. typedefs and
41 * macros are the kind of thing that might go here.
43 *----------------------------------------------------------------
48 #include "postgres_ext.h"
50 /* Must undef pg_config_ext.h symbols before including pg_config.h */
53 #include "pg_config.h"
54 #include "pg_config_manual.h" /* must be after pg_config.h */
57 * We always rely on the WIN32 macro being set by our build system,
58 * but _WIN32 is the compiler pre-defined macro. So make sure we define
59 * WIN32 whenever _WIN32 is set, to facilitate standalone building.
61 #if defined(_WIN32) && !defined(WIN32)
65 #if !defined(WIN32) && !defined(__CYGWIN__) /* win32 includes further down */
66 #include "pg_config_os.h" /* must be before any system header files */
69 #if _MSC_VER >= 1400 || defined(HAVE_CRTDEFS_H)
70 #define errcode __msvc_errcode
76 * We have to include stdlib.h here because it defines many of these macros
77 * on some platforms, and we only want our definitions used if stdlib.h doesn't
78 * have its own. The same goes for stddef and stdarg if present.
92 #include <sys/types.h>
95 #if defined(WIN32) || defined(__CYGWIN__)
96 #include <fcntl.h> /* ensure O_BINARY is available */
99 #if defined(WIN32) || defined(__CYGWIN__)
100 /* We have to redefine some system functions after they are included above. */
101 #include "pg_config_os.h"
105 * Force disable inlining if PG_FORCE_DISABLE_INLINE is defined. This is used
106 * to work around compiler bugs and might also be useful for investigatory
107 * purposes by defining the symbol in the platform's header..
109 * This is done early (in slightly the wrong section) as functionality later
110 * in this file might want to rely on inline functions.
112 #ifdef PG_FORCE_DISABLE_INLINE
117 /* Must be before gettext() games below */
120 #define _(x) gettext(x)
125 #define gettext(x) (x)
126 #define dgettext(d,x) (x)
127 #define ngettext(s,p,n) ((n) == 1 ? (s) : (p))
128 #define dngettext(d,s,p,n) ((n) == 1 ? (s) : (p))
132 * Use this to mark string constants as needing translation at some later
133 * time, rather than immediately. This is useful for cases where you need
134 * access to the original string and translated string, and for cases where
135 * immediate translation is not possible, like when initializing global
137 * http://www.gnu.org/software/autoconf/manual/gettext/Special-cases.html
139 #define gettext_noop(x) (x)
142 /* ----------------------------------------------------------------
143 * Section 1: hacks to cope with non-ANSI C compilers
145 * type prefixes (const, signed, volatile, inline) are handled in pg_config.h.
146 * ----------------------------------------------------------------
151 * Convert the argument to a string, using the C preprocessor.
153 * Concatenate two arguments together, using the C preprocessor.
155 * Note: There used to be support here for pre-ANSI C compilers that didn't
156 * support # and ##. Nowadays, these macros are just for clarity and/or
157 * backward compatibility with existing PostgreSQL code.
159 #define CppAsString(identifier) #identifier
160 #define CppConcat(x, y) x##y
163 * dummyret is used to set return values in macros that use ?: to make
164 * assignments. gcc wants these to be void, other compilers like char
166 #ifdef __GNUC__ /* GNU cc */
167 #define dummyret void
169 #define dummyret char
172 /* Which __func__ symbol do we have, if any? */
173 #ifdef HAVE_FUNCNAME__FUNC
174 #define PG_FUNCNAME_MACRO __func__
176 #ifdef HAVE_FUNCNAME__FUNCTION
177 #define PG_FUNCNAME_MACRO __FUNCTION__
179 #define PG_FUNCNAME_MACRO NULL
183 /* ----------------------------------------------------------------
184 * Section 2: bool, true, false, TRUE, FALSE, NULL
185 * ----------------------------------------------------------------
190 * Boolean value, either true or false.
192 * XXX for C++ compilers, we assume the compiler has a compatible
193 * built-in definition of bool.
203 #define true ((bool) 1)
207 #define false ((bool) 0)
211 typedef bool *BoolPtr;
226 #define NULL ((void *) 0)
230 /* ----------------------------------------------------------------
231 * Section 3: standard system types
232 * ----------------------------------------------------------------
237 * Variable holding address of any memory resident object.
239 * XXX Pointer arithmetic is done with this, so it can't be void *
240 * under "true" ANSI compilers.
242 typedef char *Pointer;
246 * Signed integer, EXACTLY N BITS IN SIZE,
247 * used for numerical computations and the
248 * frontend/backend protocol.
251 typedef signed char int8; /* == 8 bits */
252 typedef signed short int16; /* == 16 bits */
253 typedef signed int int32; /* == 32 bits */
254 #endif /* not HAVE_INT8 */
258 * Unsigned integer, EXACTLY N BITS IN SIZE,
259 * used for numerical computations and the
260 * frontend/backend protocol.
263 typedef unsigned char uint8; /* == 8 bits */
264 typedef unsigned short uint16; /* == 16 bits */
265 typedef unsigned int uint32; /* == 32 bits */
266 #endif /* not HAVE_UINT8 */
270 * Unit of bitwise operation, AT LEAST N BITS IN SIZE.
272 typedef uint8 bits8; /* >= 8 bits */
273 typedef uint16 bits16; /* >= 16 bits */
274 typedef uint32 bits32; /* >= 32 bits */
279 #ifdef HAVE_LONG_INT_64
280 /* Plain "long int" fits, use it */
283 typedef long int int64;
286 typedef unsigned long int uint64;
288 #elif defined(HAVE_LONG_LONG_INT_64)
289 /* We have working support for "long long int", use that */
292 typedef long long int int64;
295 typedef unsigned long long int uint64;
298 /* neither HAVE_LONG_INT_64 nor HAVE_LONG_LONG_INT_64 */
299 #error must have a working 64-bit integer datatype
302 /* Decide if we need to decorate 64-bit constants */
303 #ifdef HAVE_LL_CONSTANTS
304 #define INT64CONST(x) ((int64) x##LL)
305 #define UINT64CONST(x) ((uint64) x##ULL)
307 #define INT64CONST(x) ((int64) x)
308 #define UINT64CONST(x) ((uint64) x)
311 /* snprintf format strings to use for 64-bit integers */
312 #define INT64_FORMAT "%" INT64_MODIFIER "d"
313 #define UINT64_FORMAT "%" INT64_MODIFIER "u"
316 * 128-bit signed and unsigned integers
317 * There currently is only a limited support for the type. E.g. 128bit
318 * literals and snprintf are not supported; but math is.
320 #if defined(PG_INT128_TYPE)
322 typedef PG_INT128_TYPE int128;
323 typedef unsigned PG_INT128_TYPE uint128;
327 * stdint.h limits aren't guaranteed to be present and aren't guaranteed to
328 * have compatible types with our fixed width types. So just define our own.
330 #define PG_INT8_MIN (-0x7F-1)
331 #define PG_INT8_MAX (0x7F)
332 #define PG_UINT8_MAX (0xFF)
333 #define PG_INT16_MIN (-0x7FFF-1)
334 #define PG_INT16_MAX (0x7FFF)
335 #define PG_UINT16_MAX (0xFFFF)
336 #define PG_INT32_MIN (-0x7FFFFFFF-1)
337 #define PG_INT32_MAX (0x7FFFFFFF)
338 #define PG_UINT32_MAX (0xFFFFFFFF)
339 #define PG_INT64_MIN (-INT64CONST(0x7FFFFFFFFFFFFFFF) - 1)
340 #define PG_INT64_MAX INT64CONST(0x7FFFFFFFFFFFFFFF)
341 #define PG_UINT64_MAX UINT64CONST(0xFFFFFFFFFFFFFFFF)
343 /* Select timestamp representation (float8 or int64) */
344 #ifdef USE_INTEGER_DATETIMES
345 #define HAVE_INT64_TIMESTAMP
350 * Size of any memory resident object, as returned by sizeof.
356 * Index into any memory resident array.
359 * Indices are non negative.
361 typedef unsigned int Index;
365 * Offset into any memory resident array.
368 * This differs from an Index in that an Index is always
369 * non negative, whereas Offset may be negative.
371 typedef signed int Offset;
374 * Common Postgres datatype names (as used in the catalogs)
376 typedef float float4;
377 typedef double float8;
380 * Oid, RegProcedure, TransactionId, SubTransactionId, MultiXactId,
384 /* typedef Oid is in postgres_ext.h */
387 * regproc is the type name used in the include/catalog headers, but
388 * RegProcedure is the preferred name in C code.
391 typedef regproc RegProcedure;
393 typedef uint32 TransactionId;
395 typedef uint32 LocalTransactionId;
397 typedef uint32 SubTransactionId;
399 #define InvalidSubTransactionId ((SubTransactionId) 0)
400 #define TopSubTransactionId ((SubTransactionId) 1)
402 /* MultiXactId must be equivalent to TransactionId, to fit in t_xmax */
403 typedef TransactionId MultiXactId;
405 typedef uint32 MultiXactOffset;
407 typedef uint32 CommandId;
409 #define FirstCommandId ((CommandId) 0)
410 #define InvalidCommandId (~(CommandId)0)
413 * Array indexing support
422 * Variable-length datatypes all share the 'struct varlena' header.
424 * NOTE: for TOASTable types, this is an oversimplification, since the value
425 * may be compressed or moved out-of-line. However datatype-specific routines
426 * are mostly content to deal with de-TOASTed values only, and of course
427 * client-side routines should never see a TOASTed value. But even in a
428 * de-TOASTed value, beware of touching vl_len_ directly, as its representation
429 * is no longer convenient. It's recommended that code always use the VARDATA,
430 * VARSIZE, and SET_VARSIZE macros instead of relying on direct mentions of
431 * the struct fields. See postgres.h for details of the TOASTed form.
436 char vl_len_[4]; /* Do not touch this field directly! */
437 char vl_dat[FLEXIBLE_ARRAY_MEMBER]; /* Data content is here */
440 #define VARHDRSZ ((int32) sizeof(int32))
443 * These widely-used datatypes are just a varlena header and the data bytes.
444 * There is no terminating null or anything like that --- the data length is
445 * always VARSIZE(ptr) - VARHDRSZ.
447 typedef struct varlena bytea;
448 typedef struct varlena text;
449 typedef struct varlena BpChar; /* blank-padded char, ie SQL char(n) */
450 typedef struct varlena VarChar; /* var-length char, ie SQL varchar(n) */
453 * Specialized array types. These are physically laid out just the same
454 * as regular arrays (so that the regular array subscripting code works
455 * with them). They exist as distinct types mostly for historical reasons:
456 * they have nonstandard I/O behavior which we don't want to change for fear
457 * of breaking applications that look at the system catalogs. There is also
458 * an implementation issue for oidvector: it's part of the primary key for
459 * pg_proc, and we can't use the normal btree array support routines for that
460 * without circularity.
464 int32 vl_len_; /* these fields must match ArrayType! */
465 int ndim; /* always 1 for int2vector */
466 int32 dataoffset; /* always 0 for int2vector */
470 int16 values[FLEXIBLE_ARRAY_MEMBER];
475 int32 vl_len_; /* these fields must match ArrayType! */
476 int ndim; /* always 1 for oidvector */
477 int32 dataoffset; /* always 0 for oidvector */
481 Oid values[FLEXIBLE_ARRAY_MEMBER];
485 * Representation of a Name: effectively just a C string, but null-padded to
486 * exactly NAMEDATALEN bytes. The use of a struct is historical.
488 typedef struct nameData
490 char data[NAMEDATALEN];
492 typedef NameData *Name;
494 #define NameStr(name) ((name).data)
497 * Support macros for escaping strings. escape_backslash should be TRUE
498 * if generating a non-standard-conforming string. Prefixing a string
499 * with ESCAPE_STRING_SYNTAX guarantees it is non-standard-conforming.
500 * Beware of multiple evaluation of the "ch" argument!
502 #define SQL_STR_DOUBLE(ch, escape_backslash) \
503 ((ch) == '\'' || ((ch) == '\\' && (escape_backslash)))
505 #define ESCAPE_STRING_SYNTAX 'E'
507 /* ----------------------------------------------------------------
508 * Section 4: IsValid macros for system types
509 * ----------------------------------------------------------------
513 * True iff bool is valid.
515 #define BoolIsValid(boolean) ((boolean) == false || (boolean) == true)
519 * True iff pointer is valid.
521 #define PointerIsValid(pointer) ((const void*)(pointer) != NULL)
525 * True iff pointer is properly aligned to point to the given type.
527 #define PointerIsAligned(pointer, type) \
528 (((uintptr_t)(pointer) % (sizeof (type))) == 0)
530 #define OidIsValid(objectId) ((bool) ((objectId) != InvalidOid))
532 #define RegProcedureIsValid(p) OidIsValid(p)
535 /* ----------------------------------------------------------------
536 * Section 5: offsetof, lengthof, endof, alignment
537 * ----------------------------------------------------------------
541 * Offset of a structure/union field within that structure/union.
543 * XXX This is supposed to be part of stddef.h, but isn't on
544 * some systems (like SunOS 4).
547 #define offsetof(type, field) ((long) &((type *)0)->field)
548 #endif /* offsetof */
552 * Number of elements in an array.
554 #define lengthof(array) (sizeof (array) / sizeof ((array)[0]))
558 * Address of the element one past the last in an array.
560 #define endof(array) (&(array)[lengthof(array)])
563 * Alignment macros: align a length or address appropriately for a given type.
564 * The fooALIGN() macros round up to a multiple of the required alignment,
565 * while the fooALIGN_DOWN() macros round down. The latter are more useful
566 * for problems like "how many X-sized structures will fit in a page?".
568 * NOTE: TYPEALIGN[_DOWN] will not work if ALIGNVAL is not a power of 2.
569 * That case seems extremely unlikely to be needed in practice, however.
573 #define TYPEALIGN(ALIGNVAL,LEN) \
574 (((uintptr_t) (LEN) + ((ALIGNVAL) - 1)) & ~((uintptr_t) ((ALIGNVAL) - 1)))
576 #define SHORTALIGN(LEN) TYPEALIGN(ALIGNOF_SHORT, (LEN))
577 #define INTALIGN(LEN) TYPEALIGN(ALIGNOF_INT, (LEN))
578 #define LONGALIGN(LEN) TYPEALIGN(ALIGNOF_LONG, (LEN))
579 #define DOUBLEALIGN(LEN) TYPEALIGN(ALIGNOF_DOUBLE, (LEN))
580 #define MAXALIGN(LEN) TYPEALIGN(MAXIMUM_ALIGNOF, (LEN))
581 /* MAXALIGN covers only built-in types, not buffers */
582 #define BUFFERALIGN(LEN) TYPEALIGN(ALIGNOF_BUFFER, (LEN))
583 #define CACHELINEALIGN(LEN) TYPEALIGN(PG_CACHE_LINE_SIZE, (LEN))
585 #define TYPEALIGN_DOWN(ALIGNVAL,LEN) \
586 (((uintptr_t) (LEN)) & ~((uintptr_t) ((ALIGNVAL) - 1)))
588 #define SHORTALIGN_DOWN(LEN) TYPEALIGN_DOWN(ALIGNOF_SHORT, (LEN))
589 #define INTALIGN_DOWN(LEN) TYPEALIGN_DOWN(ALIGNOF_INT, (LEN))
590 #define LONGALIGN_DOWN(LEN) TYPEALIGN_DOWN(ALIGNOF_LONG, (LEN))
591 #define DOUBLEALIGN_DOWN(LEN) TYPEALIGN_DOWN(ALIGNOF_DOUBLE, (LEN))
592 #define MAXALIGN_DOWN(LEN) TYPEALIGN_DOWN(MAXIMUM_ALIGNOF, (LEN))
595 * The above macros will not work with types wider than uintptr_t, like with
596 * uint64 on 32-bit platforms. That's not problem for the usual use where a
597 * pointer or a length is aligned, but for the odd case that you need to
598 * align something (potentially) wider, use TYPEALIGN64.
600 #define TYPEALIGN64(ALIGNVAL,LEN) \
601 (((uint64) (LEN) + ((ALIGNVAL) - 1)) & ~((uint64) ((ALIGNVAL) - 1)))
603 /* we don't currently need wider versions of the other ALIGN macros */
604 #define MAXALIGN64(LEN) TYPEALIGN64(MAXIMUM_ALIGNOF, (LEN))
609 * GCC: https://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html
610 * GCC: https://gcc.gnu.org/onlinedocs/gcc/Type-Attributes.html
611 * Sunpro: https://docs.oracle.com/cd/E18659_01/html/821-1384/gjzke.html
612 * XLC: http://www-01.ibm.com/support/knowledgecenter/SSGH2K_11.1.0/com.ibm.xlc111.aix.doc/language_ref/function_attributes.html
613 * XLC: http://www-01.ibm.com/support/knowledgecenter/SSGH2K_11.1.0/com.ibm.xlc111.aix.doc/language_ref/type_attrib.html
617 /* only GCC supports the unused attribute */
619 #define pg_attribute_unused() __attribute__((unused))
621 #define pg_attribute_unused()
624 /* GCC and XLC support format attributes */
625 #if defined(__GNUC__) || defined(__IBMC__)
626 #define pg_attribute_format_arg(a) __attribute__((format_arg(a)))
627 #define pg_attribute_printf(f,a) __attribute__((format(PG_PRINTF_ATTRIBUTE, f, a)))
629 #define pg_attribute_format_arg(a)
630 #define pg_attribute_printf(f,a)
633 /* GCC, Sunpro and XLC support aligned, packed and noreturn */
634 #if defined(__GNUC__) || defined(__SUNPRO_C) || defined(__IBMC__)
635 #define pg_attribute_aligned(a) __attribute__((aligned(a)))
636 #define pg_attribute_noreturn() __attribute__((noreturn))
637 #define pg_attribute_packed() __attribute__((packed))
638 #define HAVE_PG_ATTRIBUTE_NORETURN 1
641 * NB: aligned and packed are not given default definitions because they
642 * affect code functionality; they *must* be implemented by the compiler
643 * if they are to be used.
645 #define pg_attribute_noreturn()
648 /* ----------------------------------------------------------------
649 * Section 6: assertions
650 * ----------------------------------------------------------------
654 * USE_ASSERT_CHECKING, if defined, turns on all the assertions.
657 * It should _NOT_ be defined in releases or in benchmark copies
661 * Assert() can be used in both frontend and backend code. In frontend code it
662 * just calls the standard assert, if it's available. If use of assertions is
663 * not configured, it does nothing.
665 #ifndef USE_ASSERT_CHECKING
667 #define Assert(condition) ((void)true)
668 #define AssertMacro(condition) ((void)true)
669 #define AssertArg(condition) ((void)true)
670 #define AssertState(condition) ((void)true)
671 #define AssertPointerAlignment(ptr, bndr) ((void)true)
672 #define Trap(condition, errorType) ((void)true)
673 #define TrapMacro(condition, errorType) (true)
675 #elif defined(FRONTEND)
678 #define Assert(p) assert(p)
679 #define AssertMacro(p) ((void) assert(p))
680 #define AssertArg(condition) assert(condition)
681 #define AssertState(condition) assert(condition)
682 #define AssertPointerAlignment(ptr, bndr) ((void)true)
683 #else /* USE_ASSERT_CHECKING && !FRONTEND */
687 * Generates an exception if the given condition is true.
689 #define Trap(condition, errorType) \
692 ExceptionalCondition(CppAsString(condition), (errorType), \
693 __FILE__, __LINE__); \
697 * TrapMacro is the same as Trap but it's intended for use in macros:
699 * #define foo(x) (AssertMacro(x != 0), bar(x))
703 #define TrapMacro(condition, errorType) \
704 ((bool) (! (condition) || \
705 (ExceptionalCondition(CppAsString(condition), (errorType), \
706 __FILE__, __LINE__), 0)))
708 #define Assert(condition) \
709 Trap(!(condition), "FailedAssertion")
711 #define AssertMacro(condition) \
712 ((void) TrapMacro(!(condition), "FailedAssertion"))
714 #define AssertArg(condition) \
715 Trap(!(condition), "BadArgument")
717 #define AssertState(condition) \
718 Trap(!(condition), "BadState")
721 * Check that `ptr' is `bndr' aligned.
723 #define AssertPointerAlignment(ptr, bndr) \
724 Trap(TYPEALIGN(bndr, (uintptr_t)(ptr)) != (uintptr_t)(ptr), \
727 #endif /* USE_ASSERT_CHECKING && !FRONTEND */
730 * Macros to support compile-time assertion checks.
732 * If the "condition" (a compile-time-constant expression) evaluates to false,
733 * throw a compile error using the "errmessage" (a string literal).
735 * gcc 4.6 and up supports _Static_assert(), but there are bizarre syntactic
736 * placement restrictions. These macros make it safe to use as a statement
737 * or in an expression, respectively.
739 * Otherwise we fall back on a kluge that assumes the compiler will complain
740 * about a negative width for a struct bit-field. This will not include a
741 * helpful error message, but it beats not getting an error at all.
743 #ifdef HAVE__STATIC_ASSERT
744 #define StaticAssertStmt(condition, errmessage) \
745 do { _Static_assert(condition, errmessage); } while(0)
746 #define StaticAssertExpr(condition, errmessage) \
747 ({ StaticAssertStmt(condition, errmessage); true; })
748 #else /* !HAVE__STATIC_ASSERT */
749 #define StaticAssertStmt(condition, errmessage) \
750 ((void) sizeof(struct { int static_assert_failure : (condition) ? 1 : -1; }))
751 #define StaticAssertExpr(condition, errmessage) \
752 StaticAssertStmt(condition, errmessage)
753 #endif /* HAVE__STATIC_ASSERT */
757 * Compile-time checks that a variable (or expression) has the specified type.
759 * AssertVariableIsOfType() can be used as a statement.
760 * AssertVariableIsOfTypeMacro() is intended for use in macros, eg
761 * #define foo(x) (AssertVariableIsOfTypeMacro(x, int), bar(x))
763 * If we don't have __builtin_types_compatible_p, we can still assert that
764 * the types have the same size. This is far from ideal (especially on 32-bit
765 * platforms) but it provides at least some coverage.
767 #ifdef HAVE__BUILTIN_TYPES_COMPATIBLE_P
768 #define AssertVariableIsOfType(varname, typename) \
769 StaticAssertStmt(__builtin_types_compatible_p(__typeof__(varname), typename), \
770 CppAsString(varname) " does not have type " CppAsString(typename))
771 #define AssertVariableIsOfTypeMacro(varname, typename) \
772 ((void) StaticAssertExpr(__builtin_types_compatible_p(__typeof__(varname), typename), \
773 CppAsString(varname) " does not have type " CppAsString(typename)))
774 #else /* !HAVE__BUILTIN_TYPES_COMPATIBLE_P */
775 #define AssertVariableIsOfType(varname, typename) \
776 StaticAssertStmt(sizeof(varname) == sizeof(typename), \
777 CppAsString(varname) " does not have type " CppAsString(typename))
778 #define AssertVariableIsOfTypeMacro(varname, typename) \
779 ((void) StaticAssertExpr(sizeof(varname) == sizeof(typename), \
780 CppAsString(varname) " does not have type " CppAsString(typename)))
781 #endif /* HAVE__BUILTIN_TYPES_COMPATIBLE_P */
784 /* ----------------------------------------------------------------
785 * Section 7: widely useful macros
786 * ----------------------------------------------------------------
790 * Return the maximum of two numbers.
792 #define Max(x, y) ((x) > (y) ? (x) : (y))
796 * Return the minimum of two numbers.
798 #define Min(x, y) ((x) < (y) ? (x) : (y))
802 * Return the absolute value of the argument.
804 #define Abs(x) ((x) >= 0 ? (x) : -(x))
808 * Like standard library function strncpy(), except that result string
809 * is guaranteed to be null-terminated --- that is, at most N-1 bytes
810 * of the source string will be kept.
811 * Also, the macro returns no result (too hard to do that without
812 * evaluating the arguments multiple times, which seems worse).
814 * BTW: when you need to copy a non-null-terminated string (like a text
815 * datum) and add a null, do not do it with StrNCpy(..., len+1). That
816 * might seem to work, but it fetches one byte more than there is in the
817 * text object. One fine day you'll have a SIGSEGV because there isn't
818 * another byte before the end of memory. Don't laugh, we've had real
819 * live bug reports from real live users over exactly this mistake.
820 * Do it honestly with "memcpy(dst,src,len); dst[len] = '\0';", instead.
822 #define StrNCpy(dst,src,len) \
825 char * _dst = (dst); \
830 strncpy(_dst, (src), _len); \
831 _dst[_len-1] = '\0'; \
836 /* Get a bit mask of the bits set in non-long aligned addresses */
837 #define LONG_ALIGN_MASK (sizeof(long) - 1)
841 * Exactly the same as standard library function memset(), but considerably
842 * faster for zeroing small word-aligned structures (such as parsetree nodes).
843 * This has to be a macro because the main point is to avoid function-call
844 * overhead. However, we have also found that the loop is faster than
845 * native libc memset() on some platforms, even those with assembler
846 * memset() functions. More research needs to be done, perhaps with
847 * MEMSET_LOOP_LIMIT tests in configure.
849 #define MemSet(start, val, len) \
852 /* must be void* because we don't know if it is integer aligned yet */ \
853 void *_vstart = (void *) (start); \
857 if ((((uintptr_t) _vstart) & LONG_ALIGN_MASK) == 0 && \
858 (_len & LONG_ALIGN_MASK) == 0 && \
860 _len <= MEMSET_LOOP_LIMIT && \
862 * If MEMSET_LOOP_LIMIT == 0, optimizer should find \
863 * the whole "if" false at compile time. \
865 MEMSET_LOOP_LIMIT != 0) \
867 long *_start = (long *) _vstart; \
868 long *_stop = (long *) ((char *) _start + _len); \
869 while (_start < _stop) \
873 memset(_vstart, _val, _len); \
877 * MemSetAligned is the same as MemSet except it omits the test to see if
878 * "start" is word-aligned. This is okay to use if the caller knows a-priori
879 * that the pointer is suitably aligned (typically, because he just got it
880 * from palloc(), which always delivers a max-aligned pointer).
882 #define MemSetAligned(start, val, len) \
885 long *_start = (long *) (start); \
889 if ((_len & LONG_ALIGN_MASK) == 0 && \
891 _len <= MEMSET_LOOP_LIMIT && \
892 MEMSET_LOOP_LIMIT != 0) \
894 long *_stop = (long *) ((char *) _start + _len); \
895 while (_start < _stop) \
899 memset(_start, _val, _len); \
904 * MemSetTest/MemSetLoop are a variant version that allow all the tests in
905 * MemSet to be done at compile time in cases where "val" and "len" are
906 * constants *and* we know the "start" pointer must be word-aligned.
907 * If MemSetTest succeeds, then it is okay to use MemSetLoop, otherwise use
908 * MemSetAligned. Beware of multiple evaluations of the arguments when using
911 #define MemSetTest(val, len) \
912 ( ((len) & LONG_ALIGN_MASK) == 0 && \
913 (len) <= MEMSET_LOOP_LIMIT && \
914 MEMSET_LOOP_LIMIT != 0 && \
917 #define MemSetLoop(start, val, len) \
920 long * _start = (long *) (start); \
921 long * _stop = (long *) ((char *) _start + (Size) (len)); \
923 while (_start < _stop) \
929 * Mark a point as unreachable in a portable fashion. This should preferably
930 * be something that the compiler understands, to aid code generation.
931 * In assert-enabled builds, we prefer abort() for debugging reasons.
933 #if defined(HAVE__BUILTIN_UNREACHABLE) && !defined(USE_ASSERT_CHECKING)
934 #define pg_unreachable() __builtin_unreachable()
935 #elif defined(_MSC_VER) && !defined(USE_ASSERT_CHECKING)
936 #define pg_unreachable() __assume(0)
938 #define pg_unreachable() abort()
943 * Hints to the compiler about the likelihood of a branch. Both likely() and
944 * unlikely() return the boolean value of the contained expression.
946 * These should only be used sparingly, in very hot code paths. It's very easy
947 * to mis-estimate likelihoods.
950 #define likely(x) __builtin_expect((x) != 0, 1)
951 #define unlikely(x) __builtin_expect((x) != 0, 0)
953 #define likely(x) ((x) != 0)
954 #define unlikely(x) ((x) != 0)
958 /* ----------------------------------------------------------------
959 * Section 8: random stuff
960 * ----------------------------------------------------------------
964 #define HIGHBIT (0x80)
965 #define IS_HIGHBIT_SET(ch) ((unsigned char)(ch) & HIGHBIT)
967 #define STATUS_OK (0)
968 #define STATUS_ERROR (-1)
969 #define STATUS_EOF (-2)
970 #define STATUS_FOUND (1)
971 #define STATUS_WAITING (2)
975 * Append PG_USED_FOR_ASSERTS_ONLY to definitions of variables that are only
976 * used in assert-enabled builds, to avoid compiler warnings about unused
977 * variables in assert-disabled builds.
979 #ifdef USE_ASSERT_CHECKING
980 #define PG_USED_FOR_ASSERTS_ONLY
982 #define PG_USED_FOR_ASSERTS_ONLY pg_attribute_unused()
986 /* gettext domain name mangling */
989 * To better support parallel installations of major PostgeSQL
990 * versions as well as parallel installations of major library soname
991 * versions, we mangle the gettext domain name by appending those
992 * version numbers. The coding rule ought to be that wherever the
993 * domain name is mentioned as a literal, it must be wrapped into
994 * PG_TEXTDOMAIN(). The macros below do not work on non-literals; but
995 * that is somewhat intentional because it avoids having to worry
996 * about multiple states of premangling and postmangling as the values
997 * are being passed around.
999 * Make sure this matches the installation rules in nls-global.mk.
1002 /* need a second indirection because we want to stringize the macro value, not the name */
1003 #define CppAsString2(x) CppAsString(x)
1005 #ifdef SO_MAJOR_VERSION
1006 #define PG_TEXTDOMAIN(domain) (domain CppAsString2(SO_MAJOR_VERSION) "-" PG_MAJORVERSION)
1008 #define PG_TEXTDOMAIN(domain) (domain "-" PG_MAJORVERSION)
1012 /* ----------------------------------------------------------------
1013 * Section 9: system-specific hacks
1015 * This should be limited to things that absolutely have to be
1016 * included in every source file. The port-specific header file
1017 * is usually a better place for this sort of thing.
1018 * ----------------------------------------------------------------
1022 * NOTE: this is also used for opening text files.
1023 * WIN32 treats Control-Z as EOF in files opened in text mode.
1024 * Therefore, we open files in binary mode on Win32 so we can read
1025 * literal control-Z. The other affect is that we see CRLF, but
1026 * that is OK because we can already handle those cleanly.
1028 #if defined(WIN32) || defined(__CYGWIN__)
1029 #define PG_BINARY O_BINARY
1030 #define PG_BINARY_A "ab"
1031 #define PG_BINARY_R "rb"
1032 #define PG_BINARY_W "wb"
1035 #define PG_BINARY_A "a"
1036 #define PG_BINARY_R "r"
1037 #define PG_BINARY_W "w"
1041 * Provide prototypes for routines not present in a particular machine's
1042 * standard C library.
1045 #if !HAVE_DECL_SNPRINTF
1046 extern int snprintf(char *str, size_t count, const char *fmt,...) pg_attribute_printf(3, 4);
1049 #if !HAVE_DECL_VSNPRINTF
1050 extern int vsnprintf(char *str, size_t count, const char *fmt, va_list args);
1053 #if !defined(HAVE_MEMMOVE) && !defined(memmove)
1054 #define memmove(d, s, c) bcopy(s, d, c)
1057 /* no special DLL markers on most ports */
1066 * The following is used as the arg list for signal handlers. Any ports
1067 * that take something other than an int argument should override this in
1068 * their pg_config_os.h file. Note that variable names are required
1069 * because it is used in both the prototypes as well as the definitions.
1070 * Note also the long name. We expect that this won't collide with
1071 * other names causing compiler warnings.
1075 #define SIGNAL_ARGS int postgres_signal_arg
1079 * When there is no sigsetjmp, its functionality is provided by plain
1080 * setjmp. Incidentally, nothing provides setjmp's functionality in
1081 * that case. We now support the case only on Windows.
1084 #define sigjmp_buf jmp_buf
1085 #define sigsetjmp(x,y) setjmp(x)
1086 #define siglongjmp longjmp
1089 #if defined(HAVE_FDATASYNC) && !HAVE_DECL_FDATASYNC
1090 extern int fdatasync(int fildes);
1093 /* If strtoq() exists, rename it to the more standard strtoll() */
1094 #if defined(HAVE_LONG_LONG_INT_64) && !defined(HAVE_STRTOLL) && defined(HAVE_STRTOQ)
1095 #define strtoll strtoq
1096 #define HAVE_STRTOLL 1
1099 /* If strtouq() exists, rename it to the more standard strtoull() */
1100 #if defined(HAVE_LONG_LONG_INT_64) && !defined(HAVE_STRTOULL) && defined(HAVE_STRTOUQ)
1101 #define strtoull strtouq
1102 #define HAVE_STRTOULL 1
1106 * We assume if we have these two functions, we have their friends too, and
1107 * can use the wide-character functions.
1109 #if defined(HAVE_WCSTOMBS) && defined(HAVE_TOWLOWER)
1110 #define USE_WIDE_UPPER_LOWER
1113 /* EXEC_BACKEND defines */
1115 #define NON_EXEC_STATIC
1117 #define NON_EXEC_STATIC static
1120 /* /port compatibility functions */