granicus.if.org Git - postgresql/blob - src/include/c.h

   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-2017, 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 /*
  20  *----------------------------------------------------------------
  21  *       TABLE OF CONTENTS
  22  *
  23  *              When adding stuff to this file, please try to put stuff
  24  *              into the relevant section, or add new sections as appropriate.
  25  *
  26  *        section       description
  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
  34  *              6)              assertions
  35  *              7)              widely useful macros
  36  *              8)              random stuff
  37  *              9)              system-specific hacks
  38  *
  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.
  42  *
  43  *----------------------------------------------------------------
  44  */
  45 #ifndef C_H
  46 #define C_H
  47
  48 #include "postgres_ext.h"
  49
  50 /* Must undef pg_config_ext.h symbols before including pg_config.h */
  51 #undef PG_INT64_TYPE
  52
  53 #include "pg_config.h"
  54 #include "pg_config_manual.h"   /* must be after pg_config.h */
  55
  56 /*
  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.
  60  */
  61 #if defined(_WIN32) && !defined(WIN32)
  62 #define WIN32
  63 #endif
  64
  65 #if !defined(WIN32) && !defined(__CYGWIN__)             /* win32 includes further down */
  66 #include "pg_config_os.h"               /* must be before any system header files */
  67 #endif
  68
  69 #if _MSC_VER >= 1400 || defined(HAVE_CRTDEFS_H)
  70 #define errcode __msvc_errcode
  71 #include <crtdefs.h>
  72 #undef errcode
  73 #endif
  74
  75 /*
  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.
  79  */
  80
  81 #include <stdio.h>
  82 #include <stdlib.h>
  83 #include <string.h>
  84 #include <stddef.h>
  85 #include <stdarg.h>
  86 #ifdef HAVE_STRINGS_H
  87 #include <strings.h>
  88 #endif
  89 #ifdef HAVE_STDINT_H
  90 #include <stdint.h>
  91 #endif
  92 #include <sys/types.h>
  93
  94 #include <errno.h>
  95 #if defined(WIN32) || defined(__CYGWIN__)
  96 #include <fcntl.h>                              /* ensure O_BINARY is available */
  97 #endif
  98
  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"
 102 #endif
 103
 104 /*
 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..
 108  *
 109  * This is done early (in slightly the wrong section) as functionality later
 110  * in this file might want to rely on inline functions.
 111  */
 112 #ifdef PG_FORCE_DISABLE_INLINE
 113 #undef inline
 114 #define inline
 115 #endif
 116
 117 /* Must be before gettext() games below */
 118 #include <locale.h>
 119
 120 #define _(x) gettext(x)
 121
 122 #ifdef ENABLE_NLS
 123 #include <libintl.h>
 124 #else
 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))
 129 #endif
 130
 131 /*
 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
 136  *      variables.
 137  *              http://www.gnu.org/software/autoconf/manual/gettext/Special-cases.html
 138  */
 139 #define gettext_noop(x) (x)
 140
 141
 142 /* ----------------------------------------------------------------
 143  *                              Section 1: hacks to cope with non-ANSI C compilers
 144  *
 145  * type prefixes (const, signed, volatile, inline) are handled in pg_config.h.
 146  * ----------------------------------------------------------------
 147  */
 148
 149 /*
 150  * CppAsString
 151  *              Convert the argument to a string, using the C preprocessor.
 152  * CppConcat
 153  *              Concatenate two arguments together, using the C preprocessor.
 154  *
 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.
 158  */
 159 #define CppAsString(identifier) #identifier
 160 #define CppConcat(x, y)                 x##y
 161
 162 /*
 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
 165  */
 166 #ifdef __GNUC__                                 /* GNU cc */
 167 #define dummyret        void
 168 #else
 169 #define dummyret        char
 170 #endif
 171
 172 /* Which __func__ symbol do we have, if any? */
 173 #ifdef HAVE_FUNCNAME__FUNC
 174 #define PG_FUNCNAME_MACRO       __func__
 175 #else
 176 #ifdef HAVE_FUNCNAME__FUNCTION
 177 #define PG_FUNCNAME_MACRO       __FUNCTION__
 178 #else
 179 #define PG_FUNCNAME_MACRO       NULL
 180 #endif
 181 #endif
 182
 183 /* ----------------------------------------------------------------
 184  *                              Section 2:      bool, true, false, TRUE, FALSE, NULL
 185  * ----------------------------------------------------------------
 186  */
 187
 188 /*
 189  * bool
 190  *              Boolean value, either true or false.
 191  *
 192  * XXX for C++ compilers, we assume the compiler has a compatible
 193  * built-in definition of bool.
 194  */
 195
 196 #ifndef __cplusplus
 197
 198 #ifndef bool
 199 typedef char bool;
 200 #endif
 201
 202 #ifndef true
 203 #define true    ((bool) 1)
 204 #endif
 205
 206 #ifndef false
 207 #define false   ((bool) 0)
 208 #endif
 209 #endif   /* not C++ */
 210
 211 typedef bool *BoolPtr;
 212
 213 #ifndef TRUE
 214 #define TRUE    1
 215 #endif
 216
 217 #ifndef FALSE
 218 #define FALSE   0
 219 #endif
 220
 221 /*
 222  * NULL
 223  *              Null pointer.
 224  */
 225 #ifndef NULL
 226 #define NULL    ((void *) 0)
 227 #endif
 228
 229
 230 /* ----------------------------------------------------------------
 231  *                              Section 3:      standard system types
 232  * ----------------------------------------------------------------
 233  */
 234
 235 /*
 236  * Pointer
 237  *              Variable holding address of any memory resident object.
 238  *
 239  *              XXX Pointer arithmetic is done with this, so it can't be void *
 240  *              under "true" ANSI compilers.
 241  */
 242 typedef char *Pointer;
 243
 244 /*
 245  * intN
 246  *              Signed integer, EXACTLY N BITS IN SIZE,
 247  *              used for numerical computations and the
 248  *              frontend/backend protocol.
 249  */
 250 #ifndef HAVE_INT8
 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 */
 255
 256 /*
 257  * uintN
 258  *              Unsigned integer, EXACTLY N BITS IN SIZE,
 259  *              used for numerical computations and the
 260  *              frontend/backend protocol.
 261  */
 262 #ifndef HAVE_UINT8
 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 */
 267
 268 /*
 269  * bitsN
 270  *              Unit of bitwise operation, AT LEAST N BITS IN SIZE.
 271  */
 272 typedef uint8 bits8;                    /* >= 8 bits */
 273 typedef uint16 bits16;                  /* >= 16 bits */
 274 typedef uint32 bits32;                  /* >= 32 bits */
 275
 276 /*
 277  * 64-bit integers
 278  */
 279 #ifdef HAVE_LONG_INT_64
 280 /* Plain "long int" fits, use it */
 281
 282 #ifndef HAVE_INT64
 283 typedef long int int64;
 284 #endif
 285 #ifndef HAVE_UINT64
 286 typedef unsigned long int uint64;
 287 #endif
 288 #elif defined(HAVE_LONG_LONG_INT_64)
 289 /* We have working support for "long long int", use that */
 290
 291 #ifndef HAVE_INT64
 292 typedef long long int int64;
 293 #endif
 294 #ifndef HAVE_UINT64
 295 typedef unsigned long long int uint64;
 296 #endif
 297 #else
 298 /* neither HAVE_LONG_INT_64 nor HAVE_LONG_LONG_INT_64 */
 299 #error must have a working 64-bit integer datatype
 300 #endif
 301
 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)
 306 #else
 307 #define INT64CONST(x)  ((int64) x)
 308 #define UINT64CONST(x) ((uint64) x)
 309 #endif
 310
 311 /* snprintf format strings to use for 64-bit integers */
 312 #define INT64_FORMAT "%" INT64_MODIFIER "d"
 313 #define UINT64_FORMAT "%" INT64_MODIFIER "u"
 314
 315 /*
 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.
 319  */
 320 #if defined(PG_INT128_TYPE)
 321 #define HAVE_INT128
 322 typedef PG_INT128_TYPE int128;
 323 typedef unsigned PG_INT128_TYPE uint128;
 324 #endif
 325
 326 /*
 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.
 329  */
 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)
 342
 343 /* Select timestamp representation (float8 or int64) */
 344 #ifdef USE_INTEGER_DATETIMES
 345 #define HAVE_INT64_TIMESTAMP
 346 #endif
 347
 348 /*
 349  * Size
 350  *              Size of any memory resident object, as returned by sizeof.
 351  */
 352 typedef size_t Size;
 353
 354 /*
 355  * Index
 356  *              Index into any memory resident array.
 357  *
 358  * Note:
 359  *              Indices are non negative.
 360  */
 361 typedef unsigned int Index;
 362
 363 /*
 364  * Offset
 365  *              Offset into any memory resident array.
 366  *
 367  * Note:
 368  *              This differs from an Index in that an Index is always
 369  *              non negative, whereas Offset may be negative.
 370  */
 371 typedef signed int Offset;
 372
 373 /*
 374  * Common Postgres datatype names (as used in the catalogs)
 375  */
 376 typedef float float4;
 377 typedef double float8;
 378
 379 /*
 380  * Oid, RegProcedure, TransactionId, SubTransactionId, MultiXactId,
 381  * CommandId
 382  */
 383
 384 /* typedef Oid is in postgres_ext.h */
 385
 386 /*
 387  * regproc is the type name used in the include/catalog headers, but
 388  * RegProcedure is the preferred name in C code.
 389  */
 390 typedef Oid regproc;
 391 typedef regproc RegProcedure;
 392
 393 typedef uint32 TransactionId;
 394
 395 typedef uint32 LocalTransactionId;
 396
 397 typedef uint32 SubTransactionId;
 398
 399 #define InvalidSubTransactionId         ((SubTransactionId) 0)
 400 #define TopSubTransactionId                     ((SubTransactionId) 1)
 401
 402 /* MultiXactId must be equivalent to TransactionId, to fit in t_xmax */
 403 typedef TransactionId MultiXactId;
 404
 405 typedef uint32 MultiXactOffset;
 406
 407 typedef uint32 CommandId;
 408
 409 #define FirstCommandId  ((CommandId) 0)
 410 #define InvalidCommandId        (~(CommandId)0)
 411
 412 /*
 413  * Array indexing support
 414  */
 415 #define MAXDIM 6
 416 typedef struct
 417 {
 418         int                     indx[MAXDIM];
 419 } IntArray;
 420
 421 /* ----------------
 422  *              Variable-length datatypes all share the 'struct varlena' header.
 423  *
 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.
 432  * ----------------
 433  */
 434 struct varlena
 435 {
 436         char            vl_len_[4];             /* Do not touch this field directly! */
 437         char            vl_dat[FLEXIBLE_ARRAY_MEMBER];  /* Data content is here */
 438 };
 439
 440 #define VARHDRSZ                ((int32) sizeof(int32))
 441
 442 /*
 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.
 446  */
 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) */
 451
 452 /*
 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.
 461  */
 462 typedef struct
 463 {
 464         int32           vl_len_;                /* these fields must match ArrayType! */
 465         int                     ndim;                   /* always 1 for int2vector */
 466         int32           dataoffset;             /* always 0 for int2vector */
 467         Oid                     elemtype;
 468         int                     dim1;
 469         int                     lbound1;
 470         int16           values[FLEXIBLE_ARRAY_MEMBER];
 471 } int2vector;
 472
 473 typedef struct
 474 {
 475         int32           vl_len_;                /* these fields must match ArrayType! */
 476         int                     ndim;                   /* always 1 for oidvector */
 477         int32           dataoffset;             /* always 0 for oidvector */
 478         Oid                     elemtype;
 479         int                     dim1;
 480         int                     lbound1;
 481         Oid                     values[FLEXIBLE_ARRAY_MEMBER];
 482 } oidvector;
 483
 484 /*
 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.
 487  */
 488 typedef struct nameData
 489 {
 490         char            data[NAMEDATALEN];
 491 } NameData;
 492 typedef NameData *Name;
 493
 494 #define NameStr(name)   ((name).data)
 495
 496 /*
 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!
 501  */
 502 #define SQL_STR_DOUBLE(ch, escape_backslash)    \
 503         ((ch) == '\'' || ((ch) == '\\' && (escape_backslash)))
 504
 505 #define ESCAPE_STRING_SYNTAX    'E'
 506
 507 /* ----------------------------------------------------------------
 508  *                              Section 4:      IsValid macros for system types
 509  * ----------------------------------------------------------------
 510  */
 511 /*
 512  * BoolIsValid
 513  *              True iff bool is valid.
 514  */
 515 #define BoolIsValid(boolean)    ((boolean) == false || (boolean) == true)
 516
 517 /*
 518  * PointerIsValid
 519  *              True iff pointer is valid.
 520  */
 521 #define PointerIsValid(pointer) ((const void*)(pointer) != NULL)
 522
 523 /*
 524  * PointerIsAligned
 525  *              True iff pointer is properly aligned to point to the given type.
 526  */
 527 #define PointerIsAligned(pointer, type) \
 528                 (((uintptr_t)(pointer) % (sizeof (type))) == 0)
 529
 530 #define OffsetToPointer(base, offset) \
 531                 ((void *)((char *) base + offset))
 532
 533 #define OidIsValid(objectId)  ((bool) ((objectId) != InvalidOid))
 534
 535 #define RegProcedureIsValid(p)  OidIsValid(p)
 536
 537
 538 /* ----------------------------------------------------------------
 539  *                              Section 5:      offsetof, lengthof, endof, alignment
 540  * ----------------------------------------------------------------
 541  */
 542 /*
 543  * offsetof
 544  *              Offset of a structure/union field within that structure/union.
 545  *
 546  *              XXX This is supposed to be part of stddef.h, but isn't on
 547  *              some systems (like SunOS 4).
 548  */
 549 #ifndef offsetof
 550 #define offsetof(type, field)   ((long) &((type *)0)->field)
 551 #endif   /* offsetof */
 552
 553 /*
 554  * lengthof
 555  *              Number of elements in an array.
 556  */
 557 #define lengthof(array) (sizeof (array) / sizeof ((array)[0]))
 558
 559 /*
 560  * endof
 561  *              Address of the element one past the last in an array.
 562  */
 563 #define endof(array)    (&(array)[lengthof(array)])
 564
 565 /* ----------------
 566  * Alignment macros: align a length or address appropriately for a given type.
 567  * The fooALIGN() macros round up to a multiple of the required alignment,
 568  * while the fooALIGN_DOWN() macros round down.  The latter are more useful
 569  * for problems like "how many X-sized structures will fit in a page?".
 570  *
 571  * NOTE: TYPEALIGN[_DOWN] will not work if ALIGNVAL is not a power of 2.
 572  * That case seems extremely unlikely to be needed in practice, however.
 573  * ----------------
 574  */
 575
 576 #define TYPEALIGN(ALIGNVAL,LEN)  \
 577         (((uintptr_t) (LEN) + ((ALIGNVAL) - 1)) & ~((uintptr_t) ((ALIGNVAL) - 1)))
 578
 579 #define SHORTALIGN(LEN)                 TYPEALIGN(ALIGNOF_SHORT, (LEN))
 580 #define INTALIGN(LEN)                   TYPEALIGN(ALIGNOF_INT, (LEN))
 581 #define LONGALIGN(LEN)                  TYPEALIGN(ALIGNOF_LONG, (LEN))
 582 #define DOUBLEALIGN(LEN)                TYPEALIGN(ALIGNOF_DOUBLE, (LEN))
 583 #define MAXALIGN(LEN)                   TYPEALIGN(MAXIMUM_ALIGNOF, (LEN))
 584 /* MAXALIGN covers only built-in types, not buffers */
 585 #define BUFFERALIGN(LEN)                TYPEALIGN(ALIGNOF_BUFFER, (LEN))
 586 #define CACHELINEALIGN(LEN)             TYPEALIGN(PG_CACHE_LINE_SIZE, (LEN))
 587
 588 #define TYPEALIGN_DOWN(ALIGNVAL,LEN)  \
 589         (((uintptr_t) (LEN)) & ~((uintptr_t) ((ALIGNVAL) - 1)))
 590
 591 #define SHORTALIGN_DOWN(LEN)    TYPEALIGN_DOWN(ALIGNOF_SHORT, (LEN))
 592 #define INTALIGN_DOWN(LEN)              TYPEALIGN_DOWN(ALIGNOF_INT, (LEN))
 593 #define LONGALIGN_DOWN(LEN)             TYPEALIGN_DOWN(ALIGNOF_LONG, (LEN))
 594 #define DOUBLEALIGN_DOWN(LEN)   TYPEALIGN_DOWN(ALIGNOF_DOUBLE, (LEN))
 595 #define MAXALIGN_DOWN(LEN)              TYPEALIGN_DOWN(MAXIMUM_ALIGNOF, (LEN))
 596
 597 /*
 598  * The above macros will not work with types wider than uintptr_t, like with
 599  * uint64 on 32-bit platforms.  That's not problem for the usual use where a
 600  * pointer or a length is aligned, but for the odd case that you need to
 601  * align something (potentially) wider, use TYPEALIGN64.
 602  */
 603 #define TYPEALIGN64(ALIGNVAL,LEN)  \
 604         (((uint64) (LEN) + ((ALIGNVAL) - 1)) & ~((uint64) ((ALIGNVAL) - 1)))
 605
 606 /* we don't currently need wider versions of the other ALIGN macros */
 607 #define MAXALIGN64(LEN)                 TYPEALIGN64(MAXIMUM_ALIGNOF, (LEN))
 608
 609 /* ----------------
 610  * Attribute macros
 611  *
 612  * GCC: https://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html
 613  * GCC: https://gcc.gnu.org/onlinedocs/gcc/Type-Attributes.html
 614  * Sunpro: https://docs.oracle.com/cd/E18659_01/html/821-1384/gjzke.html
 615  * XLC: http://www-01.ibm.com/support/knowledgecenter/SSGH2K_11.1.0/com.ibm.xlc111.aix.doc/language_ref/function_attributes.html
 616  * XLC: http://www-01.ibm.com/support/knowledgecenter/SSGH2K_11.1.0/com.ibm.xlc111.aix.doc/language_ref/type_attrib.html
 617  * ----------------
 618  */
 619
 620 /* only GCC supports the unused attribute */
 621 #ifdef __GNUC__
 622 #define pg_attribute_unused() __attribute__((unused))
 623 #else
 624 #define pg_attribute_unused()
 625 #endif
 626
 627 /* GCC and XLC support format attributes */
 628 #if defined(__GNUC__) || defined(__IBMC__)
 629 #define pg_attribute_format_arg(a) __attribute__((format_arg(a)))
 630 #define pg_attribute_printf(f,a) __attribute__((format(PG_PRINTF_ATTRIBUTE, f, a)))
 631 #else
 632 #define pg_attribute_format_arg(a)
 633 #define pg_attribute_printf(f,a)
 634 #endif
 635
 636 /* GCC, Sunpro and XLC support aligned, packed and noreturn */
 637 #if defined(__GNUC__) || defined(__SUNPRO_C) || defined(__IBMC__)
 638 #define pg_attribute_aligned(a) __attribute__((aligned(a)))
 639 #define pg_attribute_noreturn() __attribute__((noreturn))
 640 #define pg_attribute_packed() __attribute__((packed))
 641 #define HAVE_PG_ATTRIBUTE_NORETURN 1
 642 #else
 643 /*
 644  * NB: aligned and packed are not given default definitions because they
 645  * affect code functionality; they *must* be implemented by the compiler
 646  * if they are to be used.
 647  */
 648 #define pg_attribute_noreturn()
 649 #endif
 650
 651 /* ----------------------------------------------------------------
 652  *                              Section 6:      assertions
 653  * ----------------------------------------------------------------
 654  */
 655
 656 /*
 657  * USE_ASSERT_CHECKING, if defined, turns on all the assertions.
 658  * - plai  9/5/90
 659  *
 660  * It should _NOT_ be defined in releases or in benchmark copies
 661  */
 662
 663 /*
 664  * Assert() can be used in both frontend and backend code. In frontend code it
 665  * just calls the standard assert, if it's available. If use of assertions is
 666  * not configured, it does nothing.
 667  */
 668 #ifndef USE_ASSERT_CHECKING
 669
 670 #define Assert(condition)       ((void)true)
 671 #define AssertMacro(condition)  ((void)true)
 672 #define AssertArg(condition)    ((void)true)
 673 #define AssertState(condition)  ((void)true)
 674 #define AssertPointerAlignment(ptr, bndr)       ((void)true)
 675 #define Trap(condition, errorType)      ((void)true)
 676 #define TrapMacro(condition, errorType) (true)
 677
 678 #elif defined(FRONTEND)
 679
 680 #include <assert.h>
 681 #define Assert(p) assert(p)
 682 #define AssertMacro(p)  ((void) assert(p))
 683 #define AssertArg(condition) assert(condition)
 684 #define AssertState(condition) assert(condition)
 685 #define AssertPointerAlignment(ptr, bndr)       ((void)true)
 686 #else                                                   /* USE_ASSERT_CHECKING && !FRONTEND */
 687
 688 /*
 689  * Trap
 690  *              Generates an exception if the given condition is true.
 691  */
 692 #define Trap(condition, errorType) \
 693         do { \
 694                 if (condition) \
 695                         ExceptionalCondition(CppAsString(condition), (errorType), \
 696                                                                  __FILE__, __LINE__); \
 697         } while (0)
 698
 699 /*
 700  *      TrapMacro is the same as Trap but it's intended for use in macros:
 701  *
 702  *              #define foo(x) (AssertMacro(x != 0), bar(x))
 703  *
 704  *      Isn't CPP fun?
 705  */
 706 #define TrapMacro(condition, errorType) \
 707         ((bool) (! (condition) || \
 708                          (ExceptionalCondition(CppAsString(condition), (errorType), \
 709                                                                    __FILE__, __LINE__), 0)))
 710
 711 #define Assert(condition) \
 712                 Trap(!(condition), "FailedAssertion")
 713
 714 #define AssertMacro(condition) \
 715                 ((void) TrapMacro(!(condition), "FailedAssertion"))
 716
 717 #define AssertArg(condition) \
 718                 Trap(!(condition), "BadArgument")
 719
 720 #define AssertState(condition) \
 721                 Trap(!(condition), "BadState")
 722
 723 /*
 724  * Check that `ptr' is `bndr' aligned.
 725  */
 726 #define AssertPointerAlignment(ptr, bndr) \
 727         Trap(TYPEALIGN(bndr, (uintptr_t)(ptr)) != (uintptr_t)(ptr), \
 728                  "UnalignedPointer")
 729
 730 #endif   /* USE_ASSERT_CHECKING && !FRONTEND */
 731
 732 /*
 733  * Macros to support compile-time assertion checks.
 734  *
 735  * If the "condition" (a compile-time-constant expression) evaluates to false,
 736  * throw a compile error using the "errmessage" (a string literal).
 737  *
 738  * gcc 4.6 and up supports _Static_assert(), but there are bizarre syntactic
 739  * placement restrictions.  These macros make it safe to use as a statement
 740  * or in an expression, respectively.
 741  *
 742  * Otherwise we fall back on a kluge that assumes the compiler will complain
 743  * about a negative width for a struct bit-field.  This will not include a
 744  * helpful error message, but it beats not getting an error at all.
 745  */
 746 #ifdef HAVE__STATIC_ASSERT
 747 #define StaticAssertStmt(condition, errmessage) \
 748         do { _Static_assert(condition, errmessage); } while(0)
 749 #define StaticAssertExpr(condition, errmessage) \
 750         ({ StaticAssertStmt(condition, errmessage); true; })
 751 #else                                                   /* !HAVE__STATIC_ASSERT */
 752 #define StaticAssertStmt(condition, errmessage) \
 753         ((void) sizeof(struct { int static_assert_failure : (condition) ? 1 : -1; }))
 754 #define StaticAssertExpr(condition, errmessage) \
 755         StaticAssertStmt(condition, errmessage)
 756 #endif   /* HAVE__STATIC_ASSERT */
 757
 758
 759 /*
 760  * Compile-time checks that a variable (or expression) has the specified type.
 761  *
 762  * AssertVariableIsOfType() can be used as a statement.
 763  * AssertVariableIsOfTypeMacro() is intended for use in macros, eg
 764  *              #define foo(x) (AssertVariableIsOfTypeMacro(x, int), bar(x))
 765  *
 766  * If we don't have __builtin_types_compatible_p, we can still assert that
 767  * the types have the same size.  This is far from ideal (especially on 32-bit
 768  * platforms) but it provides at least some coverage.
 769  */
 770 #ifdef HAVE__BUILTIN_TYPES_COMPATIBLE_P
 771 #define AssertVariableIsOfType(varname, typename) \
 772         StaticAssertStmt(__builtin_types_compatible_p(__typeof__(varname), typename), \
 773         CppAsString(varname) " does not have type " CppAsString(typename))
 774 #define AssertVariableIsOfTypeMacro(varname, typename) \
 775         ((void) StaticAssertExpr(__builtin_types_compatible_p(__typeof__(varname), typename), \
 776          CppAsString(varname) " does not have type " CppAsString(typename)))
 777 #else                                                   /* !HAVE__BUILTIN_TYPES_COMPATIBLE_P */
 778 #define AssertVariableIsOfType(varname, typename) \
 779         StaticAssertStmt(sizeof(varname) == sizeof(typename), \
 780         CppAsString(varname) " does not have type " CppAsString(typename))
 781 #define AssertVariableIsOfTypeMacro(varname, typename) \
 782         ((void) StaticAssertExpr(sizeof(varname) == sizeof(typename),           \
 783          CppAsString(varname) " does not have type " CppAsString(typename)))
 784 #endif   /* HAVE__BUILTIN_TYPES_COMPATIBLE_P */
 785
 786
 787 /* ----------------------------------------------------------------
 788  *                              Section 7:      widely useful macros
 789  * ----------------------------------------------------------------
 790  */
 791 /*
 792  * Max
 793  *              Return the maximum of two numbers.
 794  */
 795 #define Max(x, y)               ((x) > (y) ? (x) : (y))
 796
 797 /*
 798  * Min
 799  *              Return the minimum of two numbers.
 800  */
 801 #define Min(x, y)               ((x) < (y) ? (x) : (y))
 802
 803 /*
 804  * Abs
 805  *              Return the absolute value of the argument.
 806  */
 807 #define Abs(x)                  ((x) >= 0 ? (x) : -(x))
 808
 809 /*
 810  * StrNCpy
 811  *      Like standard library function strncpy(), except that result string
 812  *      is guaranteed to be null-terminated --- that is, at most N-1 bytes
 813  *      of the source string will be kept.
 814  *      Also, the macro returns no result (too hard to do that without
 815  *      evaluating the arguments multiple times, which seems worse).
 816  *
 817  *      BTW: when you need to copy a non-null-terminated string (like a text
 818  *      datum) and add a null, do not do it with StrNCpy(..., len+1).  That
 819  *      might seem to work, but it fetches one byte more than there is in the
 820  *      text object.  One fine day you'll have a SIGSEGV because there isn't
 821  *      another byte before the end of memory.  Don't laugh, we've had real
 822  *      live bug reports from real live users over exactly this mistake.
 823  *      Do it honestly with "memcpy(dst,src,len); dst[len] = '\0';", instead.
 824  */
 825 #define StrNCpy(dst,src,len) \
 826         do \
 827         { \
 828                 char * _dst = (dst); \
 829                 Size _len = (len); \
 830 \
 831                 if (_len > 0) \
 832                 { \
 833                         strncpy(_dst, (src), _len); \
 834                         _dst[_len-1] = '\0'; \
 835                 } \
 836         } while (0)
 837
 838
 839 /* Get a bit mask of the bits set in non-long aligned addresses */
 840 #define LONG_ALIGN_MASK (sizeof(long) - 1)
 841
 842 /*
 843  * MemSet
 844  *      Exactly the same as standard library function memset(), but considerably
 845  *      faster for zeroing small word-aligned structures (such as parsetree nodes).
 846  *      This has to be a macro because the main point is to avoid function-call
 847  *      overhead.   However, we have also found that the loop is faster than
 848  *      native libc memset() on some platforms, even those with assembler
 849  *      memset() functions.  More research needs to be done, perhaps with
 850  *      MEMSET_LOOP_LIMIT tests in configure.
 851  */
 852 #define MemSet(start, val, len) \
 853         do \
 854         { \
 855                 /* must be void* because we don't know if it is integer aligned yet */ \
 856                 void   *_vstart = (void *) (start); \
 857                 int             _val = (val); \
 858                 Size    _len = (len); \
 859 \
 860                 if ((((uintptr_t) _vstart) & LONG_ALIGN_MASK) == 0 && \
 861                         (_len & LONG_ALIGN_MASK) == 0 && \
 862                         _val == 0 && \
 863                         _len <= MEMSET_LOOP_LIMIT && \
 864                         /* \
 865                          *      If MEMSET_LOOP_LIMIT == 0, optimizer should find \
 866                          *      the whole "if" false at compile time. \
 867                          */ \
 868                         MEMSET_LOOP_LIMIT != 0) \
 869                 { \
 870                         long *_start = (long *) _vstart; \
 871                         long *_stop = (long *) ((char *) _start + _len); \
 872                         while (_start < _stop) \
 873                                 *_start++ = 0; \
 874                 } \
 875                 else \
 876                         memset(_vstart, _val, _len); \
 877         } while (0)
 878
 879 /*
 880  * MemSetAligned is the same as MemSet except it omits the test to see if
 881  * "start" is word-aligned.  This is okay to use if the caller knows a-priori
 882  * that the pointer is suitably aligned (typically, because he just got it
 883  * from palloc(), which always delivers a max-aligned pointer).
 884  */
 885 #define MemSetAligned(start, val, len) \
 886         do \
 887         { \
 888                 long   *_start = (long *) (start); \
 889                 int             _val = (val); \
 890                 Size    _len = (len); \
 891 \
 892                 if ((_len & LONG_ALIGN_MASK) == 0 && \
 893                         _val == 0 && \
 894                         _len <= MEMSET_LOOP_LIMIT && \
 895                         MEMSET_LOOP_LIMIT != 0) \
 896                 { \
 897                         long *_stop = (long *) ((char *) _start + _len); \
 898                         while (_start < _stop) \
 899                                 *_start++ = 0; \
 900                 } \
 901                 else \
 902                         memset(_start, _val, _len); \
 903         } while (0)
 904
 905
 906 /*
 907  * MemSetTest/MemSetLoop are a variant version that allow all the tests in
 908  * MemSet to be done at compile time in cases where "val" and "len" are
 909  * constants *and* we know the "start" pointer must be word-aligned.
 910  * If MemSetTest succeeds, then it is okay to use MemSetLoop, otherwise use
 911  * MemSetAligned.  Beware of multiple evaluations of the arguments when using
 912  * this approach.
 913  */
 914 #define MemSetTest(val, len) \
 915         ( ((len) & LONG_ALIGN_MASK) == 0 && \
 916         (len) <= MEMSET_LOOP_LIMIT && \
 917         MEMSET_LOOP_LIMIT != 0 && \
 918         (val) == 0 )
 919
 920 #define MemSetLoop(start, val, len) \
 921         do \
 922         { \
 923                 long * _start = (long *) (start); \
 924                 long * _stop = (long *) ((char *) _start + (Size) (len)); \
 925         \
 926                 while (_start < _stop) \
 927                         *_start++ = 0; \
 928         } while (0)
 929
 930
 931 /*
 932  * Mark a point as unreachable in a portable fashion.  This should preferably
 933  * be something that the compiler understands, to aid code generation.
 934  * In assert-enabled builds, we prefer abort() for debugging reasons.
 935  */
 936 #if defined(HAVE__BUILTIN_UNREACHABLE) && !defined(USE_ASSERT_CHECKING)
 937 #define pg_unreachable() __builtin_unreachable()
 938 #elif defined(_MSC_VER) && !defined(USE_ASSERT_CHECKING)
 939 #define pg_unreachable() __assume(0)
 940 #else
 941 #define pg_unreachable() abort()
 942 #endif
 943
 944
 945 /*
 946  * Hints to the compiler about the likelihood of a branch. Both likely() and
 947  * unlikely() return the boolean value of the contained expression.
 948  *
 949  * These should only be used sparingly, in very hot code paths. It's very easy
 950  * to mis-estimate likelihoods.
 951  */
 952 #if __GNUC__ >= 3
 953 #define likely(x)       __builtin_expect((x) != 0, 1)
 954 #define unlikely(x) __builtin_expect((x) != 0, 0)
 955 #else
 956 #define likely(x)       ((x) != 0)
 957 #define unlikely(x) ((x) != 0)
 958 #endif
 959
 960
 961 /* ----------------------------------------------------------------
 962  *                              Section 8:      random stuff
 963  * ----------------------------------------------------------------
 964  */
 965
 966 /* msb for char */
 967 #define HIGHBIT                                 (0x80)
 968 #define IS_HIGHBIT_SET(ch)              ((unsigned char)(ch) & HIGHBIT)
 969
 970 #define STATUS_OK                               (0)
 971 #define STATUS_ERROR                    (-1)
 972 #define STATUS_EOF                              (-2)
 973 #define STATUS_FOUND                    (1)
 974 #define STATUS_WAITING                  (2)
 975
 976
 977 /*
 978  * Append PG_USED_FOR_ASSERTS_ONLY to definitions of variables that are only
 979  * used in assert-enabled builds, to avoid compiler warnings about unused
 980  * variables in assert-disabled builds.
 981  */
 982 #ifdef USE_ASSERT_CHECKING
 983 #define PG_USED_FOR_ASSERTS_ONLY
 984 #else
 985 #define PG_USED_FOR_ASSERTS_ONLY pg_attribute_unused()
 986 #endif
 987
 988
 989 /* gettext domain name mangling */
 990
 991 /*
 992  * To better support parallel installations of major PostgeSQL
 993  * versions as well as parallel installations of major library soname
 994  * versions, we mangle the gettext domain name by appending those
 995  * version numbers.  The coding rule ought to be that wherever the
 996  * domain name is mentioned as a literal, it must be wrapped into
 997  * PG_TEXTDOMAIN().  The macros below do not work on non-literals; but
 998  * that is somewhat intentional because it avoids having to worry
 999  * about multiple states of premangling and postmangling as the values
1000  * are being passed around.
1001  *
1002  * Make sure this matches the installation rules in nls-global.mk.
1003  */
1004
1005 /* need a second indirection because we want to stringize the macro value, not the name */
1006 #define CppAsString2(x) CppAsString(x)
1007
1008 #ifdef SO_MAJOR_VERSION
1009 #define PG_TEXTDOMAIN(domain) (domain CppAsString2(SO_MAJOR_VERSION) "-" PG_MAJORVERSION)
1010 #else
1011 #define PG_TEXTDOMAIN(domain) (domain "-" PG_MAJORVERSION)
1012 #endif
1013
1014
1015 /* ----------------------------------------------------------------
1016  *                              Section 9: system-specific hacks
1017  *
1018  *              This should be limited to things that absolutely have to be
1019  *              included in every source file.  The port-specific header file
1020  *              is usually a better place for this sort of thing.
1021  * ----------------------------------------------------------------
1022  */
1023
1024 /*
1025  *      NOTE:  this is also used for opening text files.
1026  *      WIN32 treats Control-Z as EOF in files opened in text mode.
1027  *      Therefore, we open files in binary mode on Win32 so we can read
1028  *      literal control-Z.  The other affect is that we see CRLF, but
1029  *      that is OK because we can already handle those cleanly.
1030  */
1031 #if defined(WIN32) || defined(__CYGWIN__)
1032 #define PG_BINARY       O_BINARY
1033 #define PG_BINARY_A "ab"
1034 #define PG_BINARY_R "rb"
1035 #define PG_BINARY_W "wb"
1036 #else
1037 #define PG_BINARY       0
1038 #define PG_BINARY_A "a"
1039 #define PG_BINARY_R "r"
1040 #define PG_BINARY_W "w"
1041 #endif
1042
1043 /*
1044  * Provide prototypes for routines not present in a particular machine's
1045  * standard C library.
1046  */
1047
1048 #if !HAVE_DECL_SNPRINTF
1049 extern int      snprintf(char *str, size_t count, const char *fmt,...) pg_attribute_printf(3, 4);
1050 #endif
1051
1052 #if !HAVE_DECL_VSNPRINTF
1053 extern int      vsnprintf(char *str, size_t count, const char *fmt, va_list args);
1054 #endif
1055
1056 #if !defined(HAVE_MEMMOVE) && !defined(memmove)
1057 #define memmove(d, s, c)                bcopy(s, d, c)
1058 #endif
1059
1060 /* no special DLL markers on most ports */
1061 #ifndef PGDLLIMPORT
1062 #define PGDLLIMPORT
1063 #endif
1064 #ifndef PGDLLEXPORT
1065 #define PGDLLEXPORT
1066 #endif
1067
1068 /*
1069  * The following is used as the arg list for signal handlers.  Any ports
1070  * that take something other than an int argument should override this in
1071  * their pg_config_os.h file.  Note that variable names are required
1072  * because it is used in both the prototypes as well as the definitions.
1073  * Note also the long name.  We expect that this won't collide with
1074  * other names causing compiler warnings.
1075  */
1076
1077 #ifndef SIGNAL_ARGS
1078 #define SIGNAL_ARGS  int postgres_signal_arg
1079 #endif
1080
1081 /*
1082  * When there is no sigsetjmp, its functionality is provided by plain
1083  * setjmp. Incidentally, nothing provides setjmp's functionality in
1084  * that case.  We now support the case only on Windows.
1085  */
1086 #ifdef WIN32
1087 #define sigjmp_buf jmp_buf
1088 #define sigsetjmp(x,y) setjmp(x)
1089 #define siglongjmp longjmp
1090 #endif
1091
1092 #if defined(HAVE_FDATASYNC) && !HAVE_DECL_FDATASYNC
1093 extern int      fdatasync(int fildes);
1094 #endif
1095
1096 /* If strtoq() exists, rename it to the more standard strtoll() */
1097 #if defined(HAVE_LONG_LONG_INT_64) && !defined(HAVE_STRTOLL) && defined(HAVE_STRTOQ)
1098 #define strtoll strtoq
1099 #define HAVE_STRTOLL 1
1100 #endif
1101
1102 /* If strtouq() exists, rename it to the more standard strtoull() */
1103 #if defined(HAVE_LONG_LONG_INT_64) && !defined(HAVE_STRTOULL) && defined(HAVE_STRTOUQ)
1104 #define strtoull strtouq
1105 #define HAVE_STRTOULL 1
1106 #endif
1107
1108 /*
1109  * We assume if we have these two functions, we have their friends too, and
1110  * can use the wide-character functions.
1111  */
1112 #if defined(HAVE_WCSTOMBS) && defined(HAVE_TOWLOWER)
1113 #define USE_WIDE_UPPER_LOWER
1114 #endif
1115
1116 /* EXEC_BACKEND defines */
1117 #ifdef EXEC_BACKEND
1118 #define NON_EXEC_STATIC
1119 #else
1120 #define NON_EXEC_STATIC static
1121 #endif
1122
1123 /* /port compatibility functions */
1124 #include "port.h"
1125
1126 #endif   /* C_H */