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  * CppAsString2
 153  *              Convert the argument to a string, after one round of macro expansion.
 154  * CppConcat
 155  *              Concatenate two arguments together, using the C preprocessor.
 156  *
 157  * Note: There used to be support here for pre-ANSI C compilers that didn't
 158  * support # and ##.  Nowadays, these macros are just for clarity and/or
 159  * backward compatibility with existing PostgreSQL code.
 160  */
 161 #define CppAsString(identifier) #identifier
 162 #define CppAsString2(x)                 CppAsString(x)
 163 #define CppConcat(x, y)                 x##y
 164
 165 /*
 166  * dummyret is used to set return values in macros that use ?: to make
 167  * assignments.  gcc wants these to be void, other compilers like char
 168  */
 169 #ifdef __GNUC__                                 /* GNU cc */
 170 #define dummyret        void
 171 #else
 172 #define dummyret        char
 173 #endif
 174
 175 /* Which __func__ symbol do we have, if any? */
 176 #ifdef HAVE_FUNCNAME__FUNC
 177 #define PG_FUNCNAME_MACRO       __func__
 178 #else
 179 #ifdef HAVE_FUNCNAME__FUNCTION
 180 #define PG_FUNCNAME_MACRO       __FUNCTION__
 181 #else
 182 #define PG_FUNCNAME_MACRO       NULL
 183 #endif
 184 #endif
 185
 186 /* ----------------------------------------------------------------
 187  *                              Section 2:      bool, true, false, TRUE, FALSE, NULL
 188  * ----------------------------------------------------------------
 189  */
 190
 191 /*
 192  * bool
 193  *              Boolean value, either true or false.
 194  *
 195  * XXX for C++ compilers, we assume the compiler has a compatible
 196  * built-in definition of bool.
 197  */
 198
 199 #ifndef __cplusplus
 200
 201 #ifndef bool
 202 typedef char bool;
 203 #endif
 204
 205 #ifndef true
 206 #define true    ((bool) 1)
 207 #endif
 208
 209 #ifndef false
 210 #define false   ((bool) 0)
 211 #endif
 212 #endif   /* not C++ */
 213
 214 typedef bool *BoolPtr;
 215
 216 #ifndef TRUE
 217 #define TRUE    1
 218 #endif
 219
 220 #ifndef FALSE
 221 #define FALSE   0
 222 #endif
 223
 224 /*
 225  * NULL
 226  *              Null pointer.
 227  */
 228 #ifndef NULL
 229 #define NULL    ((void *) 0)
 230 #endif
 231
 232
 233 /* ----------------------------------------------------------------
 234  *                              Section 3:      standard system types
 235  * ----------------------------------------------------------------
 236  */
 237
 238 /*
 239  * Pointer
 240  *              Variable holding address of any memory resident object.
 241  *
 242  *              XXX Pointer arithmetic is done with this, so it can't be void *
 243  *              under "true" ANSI compilers.
 244  */
 245 typedef char *Pointer;
 246
 247 /*
 248  * intN
 249  *              Signed integer, EXACTLY N BITS IN SIZE,
 250  *              used for numerical computations and the
 251  *              frontend/backend protocol.
 252  */
 253 #ifndef HAVE_INT8
 254 typedef signed char int8;               /* == 8 bits */
 255 typedef signed short int16;             /* == 16 bits */
 256 typedef signed int int32;               /* == 32 bits */
 257 #endif   /* not HAVE_INT8 */
 258
 259 /*
 260  * uintN
 261  *              Unsigned integer, EXACTLY N BITS IN SIZE,
 262  *              used for numerical computations and the
 263  *              frontend/backend protocol.
 264  */
 265 #ifndef HAVE_UINT8
 266 typedef unsigned char uint8;    /* == 8 bits */
 267 typedef unsigned short uint16;  /* == 16 bits */
 268 typedef unsigned int uint32;    /* == 32 bits */
 269 #endif   /* not HAVE_UINT8 */
 270
 271 /*
 272  * bitsN
 273  *              Unit of bitwise operation, AT LEAST N BITS IN SIZE.
 274  */
 275 typedef uint8 bits8;                    /* >= 8 bits */
 276 typedef uint16 bits16;                  /* >= 16 bits */
 277 typedef uint32 bits32;                  /* >= 32 bits */
 278
 279 /*
 280  * 64-bit integers
 281  */
 282 #ifdef HAVE_LONG_INT_64
 283 /* Plain "long int" fits, use it */
 284
 285 #ifndef HAVE_INT64
 286 typedef long int int64;
 287 #endif
 288 #ifndef HAVE_UINT64
 289 typedef unsigned long int uint64;
 290 #endif
 291 #elif defined(HAVE_LONG_LONG_INT_64)
 292 /* We have working support for "long long int", use that */
 293
 294 #ifndef HAVE_INT64
 295 typedef long long int int64;
 296 #endif
 297 #ifndef HAVE_UINT64
 298 typedef unsigned long long int uint64;
 299 #endif
 300 #else
 301 /* neither HAVE_LONG_INT_64 nor HAVE_LONG_LONG_INT_64 */
 302 #error must have a working 64-bit integer datatype
 303 #endif
 304
 305 /* Decide if we need to decorate 64-bit constants */
 306 #ifdef HAVE_LL_CONSTANTS
 307 #define INT64CONST(x)  ((int64) x##LL)
 308 #define UINT64CONST(x) ((uint64) x##ULL)
 309 #else
 310 #define INT64CONST(x)  ((int64) x)
 311 #define UINT64CONST(x) ((uint64) x)
 312 #endif
 313
 314 /* snprintf format strings to use for 64-bit integers */
 315 #define INT64_FORMAT "%" INT64_MODIFIER "d"
 316 #define UINT64_FORMAT "%" INT64_MODIFIER "u"
 317
 318 /*
 319  * 128-bit signed and unsigned integers
 320  *              There currently is only a limited support for the type. E.g. 128bit
 321  *              literals and snprintf are not supported; but math is.
 322  */
 323 #if defined(PG_INT128_TYPE)
 324 #define HAVE_INT128
 325 typedef PG_INT128_TYPE int128;
 326 typedef unsigned PG_INT128_TYPE uint128;
 327 #endif
 328
 329 /*
 330  * stdint.h limits aren't guaranteed to be present and aren't guaranteed to
 331  * have compatible types with our fixed width types. So just define our own.
 332  */
 333 #define PG_INT8_MIN             (-0x7F-1)
 334 #define PG_INT8_MAX             (0x7F)
 335 #define PG_UINT8_MAX    (0xFF)
 336 #define PG_INT16_MIN    (-0x7FFF-1)
 337 #define PG_INT16_MAX    (0x7FFF)
 338 #define PG_UINT16_MAX   (0xFFFF)
 339 #define PG_INT32_MIN    (-0x7FFFFFFF-1)
 340 #define PG_INT32_MAX    (0x7FFFFFFF)
 341 #define PG_UINT32_MAX   (0xFFFFFFFF)
 342 #define PG_INT64_MIN    (-INT64CONST(0x7FFFFFFFFFFFFFFF) - 1)
 343 #define PG_INT64_MAX    INT64CONST(0x7FFFFFFFFFFFFFFF)
 344 #define PG_UINT64_MAX   UINT64CONST(0xFFFFFFFFFFFFFFFF)
 345
 346 /*
 347  * We now always use int64 timestamps, but keep this symbol defined for the
 348  * benefit of external code that might test it.
 349  */
 350 #define HAVE_INT64_TIMESTAMP
 351
 352 /*
 353  * Size
 354  *              Size of any memory resident object, as returned by sizeof.
 355  */
 356 typedef size_t Size;
 357
 358 /*
 359  * Index
 360  *              Index into any memory resident array.
 361  *
 362  * Note:
 363  *              Indices are non negative.
 364  */
 365 typedef unsigned int Index;
 366
 367 /*
 368  * Offset
 369  *              Offset into any memory resident array.
 370  *
 371  * Note:
 372  *              This differs from an Index in that an Index is always
 373  *              non negative, whereas Offset may be negative.
 374  */
 375 typedef signed int Offset;
 376
 377 /*
 378  * Common Postgres datatype names (as used in the catalogs)
 379  */
 380 typedef float float4;
 381 typedef double float8;
 382
 383 /*
 384  * Oid, RegProcedure, TransactionId, SubTransactionId, MultiXactId,
 385  * CommandId
 386  */
 387
 388 /* typedef Oid is in postgres_ext.h */
 389
 390 /*
 391  * regproc is the type name used in the include/catalog headers, but
 392  * RegProcedure is the preferred name in C code.
 393  */
 394 typedef Oid regproc;
 395 typedef regproc RegProcedure;
 396
 397 typedef uint32 TransactionId;
 398
 399 typedef uint32 LocalTransactionId;
 400
 401 typedef uint32 SubTransactionId;
 402
 403 #define InvalidSubTransactionId         ((SubTransactionId) 0)
 404 #define TopSubTransactionId                     ((SubTransactionId) 1)
 405
 406 /* MultiXactId must be equivalent to TransactionId, to fit in t_xmax */
 407 typedef TransactionId MultiXactId;
 408
 409 typedef uint32 MultiXactOffset;
 410
 411 typedef uint32 CommandId;
 412
 413 #define FirstCommandId  ((CommandId) 0)
 414 #define InvalidCommandId        (~(CommandId)0)
 415
 416 /*
 417  * Array indexing support
 418  */
 419 #define MAXDIM 6
 420 typedef struct
 421 {
 422         int                     indx[MAXDIM];
 423 } IntArray;
 424
 425 /* ----------------
 426  *              Variable-length datatypes all share the 'struct varlena' header.
 427  *
 428  * NOTE: for TOASTable types, this is an oversimplification, since the value
 429  * may be compressed or moved out-of-line.  However datatype-specific routines
 430  * are mostly content to deal with de-TOASTed values only, and of course
 431  * client-side routines should never see a TOASTed value.  But even in a
 432  * de-TOASTed value, beware of touching vl_len_ directly, as its representation
 433  * is no longer convenient.  It's recommended that code always use the VARDATA,
 434  * VARSIZE, and SET_VARSIZE macros instead of relying on direct mentions of
 435  * the struct fields.  See postgres.h for details of the TOASTed form.
 436  * ----------------
 437  */
 438 struct varlena
 439 {
 440         char            vl_len_[4];             /* Do not touch this field directly! */
 441         char            vl_dat[FLEXIBLE_ARRAY_MEMBER];  /* Data content is here */
 442 };
 443
 444 #define VARHDRSZ                ((int32) sizeof(int32))
 445
 446 /*
 447  * These widely-used datatypes are just a varlena header and the data bytes.
 448  * There is no terminating null or anything like that --- the data length is
 449  * always VARSIZE(ptr) - VARHDRSZ.
 450  */
 451 typedef struct varlena bytea;
 452 typedef struct varlena text;
 453 typedef struct varlena BpChar;  /* blank-padded char, ie SQL char(n) */
 454 typedef struct varlena VarChar; /* var-length char, ie SQL varchar(n) */
 455
 456 /*
 457  * Specialized array types.  These are physically laid out just the same
 458  * as regular arrays (so that the regular array subscripting code works
 459  * with them).  They exist as distinct types mostly for historical reasons:
 460  * they have nonstandard I/O behavior which we don't want to change for fear
 461  * of breaking applications that look at the system catalogs.  There is also
 462  * an implementation issue for oidvector: it's part of the primary key for
 463  * pg_proc, and we can't use the normal btree array support routines for that
 464  * without circularity.
 465  */
 466 typedef struct
 467 {
 468         int32           vl_len_;                /* these fields must match ArrayType! */
 469         int                     ndim;                   /* always 1 for int2vector */
 470         int32           dataoffset;             /* always 0 for int2vector */
 471         Oid                     elemtype;
 472         int                     dim1;
 473         int                     lbound1;
 474         int16           values[FLEXIBLE_ARRAY_MEMBER];
 475 } int2vector;
 476
 477 typedef struct
 478 {
 479         int32           vl_len_;                /* these fields must match ArrayType! */
 480         int                     ndim;                   /* always 1 for oidvector */
 481         int32           dataoffset;             /* always 0 for oidvector */
 482         Oid                     elemtype;
 483         int                     dim1;
 484         int                     lbound1;
 485         Oid                     values[FLEXIBLE_ARRAY_MEMBER];
 486 } oidvector;
 487
 488 /*
 489  * Representation of a Name: effectively just a C string, but null-padded to
 490  * exactly NAMEDATALEN bytes.  The use of a struct is historical.
 491  */
 492 typedef struct nameData
 493 {
 494         char            data[NAMEDATALEN];
 495 } NameData;
 496 typedef NameData *Name;
 497
 498 #define NameStr(name)   ((name).data)
 499
 500 /*
 501  * Support macros for escaping strings.  escape_backslash should be TRUE
 502  * if generating a non-standard-conforming string.  Prefixing a string
 503  * with ESCAPE_STRING_SYNTAX guarantees it is non-standard-conforming.
 504  * Beware of multiple evaluation of the "ch" argument!
 505  */
 506 #define SQL_STR_DOUBLE(ch, escape_backslash)    \
 507         ((ch) == '\'' || ((ch) == '\\' && (escape_backslash)))
 508
 509 #define ESCAPE_STRING_SYNTAX    'E'
 510
 511 /* ----------------------------------------------------------------
 512  *                              Section 4:      IsValid macros for system types
 513  * ----------------------------------------------------------------
 514  */
 515 /*
 516  * BoolIsValid
 517  *              True iff bool is valid.
 518  */
 519 #define BoolIsValid(boolean)    ((boolean) == false || (boolean) == true)
 520
 521 /*
 522  * PointerIsValid
 523  *              True iff pointer is valid.
 524  */
 525 #define PointerIsValid(pointer) ((const void*)(pointer) != NULL)
 526
 527 /*
 528  * PointerIsAligned
 529  *              True iff pointer is properly aligned to point to the given type.
 530  */
 531 #define PointerIsAligned(pointer, type) \
 532                 (((uintptr_t)(pointer) % (sizeof (type))) == 0)
 533
 534 #define OffsetToPointer(base, offset) \
 535                 ((void *)((char *) base + offset))
 536
 537 #define OidIsValid(objectId)  ((bool) ((objectId) != InvalidOid))
 538
 539 #define RegProcedureIsValid(p)  OidIsValid(p)
 540
 541
 542 /* ----------------------------------------------------------------
 543  *                              Section 5:      offsetof, lengthof, endof, alignment
 544  * ----------------------------------------------------------------
 545  */
 546 /*
 547  * offsetof
 548  *              Offset of a structure/union field within that structure/union.
 549  *
 550  *              XXX This is supposed to be part of stddef.h, but isn't on
 551  *              some systems (like SunOS 4).
 552  */
 553 #ifndef offsetof
 554 #define offsetof(type, field)   ((long) &((type *)0)->field)
 555 #endif   /* offsetof */
 556
 557 /*
 558  * lengthof
 559  *              Number of elements in an array.
 560  */
 561 #define lengthof(array) (sizeof (array) / sizeof ((array)[0]))
 562
 563 /*
 564  * endof
 565  *              Address of the element one past the last in an array.
 566  */
 567 #define endof(array)    (&(array)[lengthof(array)])
 568
 569 /* ----------------
 570  * Alignment macros: align a length or address appropriately for a given type.
 571  * The fooALIGN() macros round up to a multiple of the required alignment,
 572  * while the fooALIGN_DOWN() macros round down.  The latter are more useful
 573  * for problems like "how many X-sized structures will fit in a page?".
 574  *
 575  * NOTE: TYPEALIGN[_DOWN] will not work if ALIGNVAL is not a power of 2.
 576  * That case seems extremely unlikely to be needed in practice, however.
 577  * ----------------
 578  */
 579
 580 #define TYPEALIGN(ALIGNVAL,LEN)  \
 581         (((uintptr_t) (LEN) + ((ALIGNVAL) - 1)) & ~((uintptr_t) ((ALIGNVAL) - 1)))
 582
 583 #define SHORTALIGN(LEN)                 TYPEALIGN(ALIGNOF_SHORT, (LEN))
 584 #define INTALIGN(LEN)                   TYPEALIGN(ALIGNOF_INT, (LEN))
 585 #define LONGALIGN(LEN)                  TYPEALIGN(ALIGNOF_LONG, (LEN))
 586 #define DOUBLEALIGN(LEN)                TYPEALIGN(ALIGNOF_DOUBLE, (LEN))
 587 #define MAXALIGN(LEN)                   TYPEALIGN(MAXIMUM_ALIGNOF, (LEN))
 588 /* MAXALIGN covers only built-in types, not buffers */
 589 #define BUFFERALIGN(LEN)                TYPEALIGN(ALIGNOF_BUFFER, (LEN))
 590 #define CACHELINEALIGN(LEN)             TYPEALIGN(PG_CACHE_LINE_SIZE, (LEN))
 591
 592 #define TYPEALIGN_DOWN(ALIGNVAL,LEN)  \
 593         (((uintptr_t) (LEN)) & ~((uintptr_t) ((ALIGNVAL) - 1)))
 594
 595 #define SHORTALIGN_DOWN(LEN)    TYPEALIGN_DOWN(ALIGNOF_SHORT, (LEN))
 596 #define INTALIGN_DOWN(LEN)              TYPEALIGN_DOWN(ALIGNOF_INT, (LEN))
 597 #define LONGALIGN_DOWN(LEN)             TYPEALIGN_DOWN(ALIGNOF_LONG, (LEN))
 598 #define DOUBLEALIGN_DOWN(LEN)   TYPEALIGN_DOWN(ALIGNOF_DOUBLE, (LEN))
 599 #define MAXALIGN_DOWN(LEN)              TYPEALIGN_DOWN(MAXIMUM_ALIGNOF, (LEN))
 600
 601 /*
 602  * The above macros will not work with types wider than uintptr_t, like with
 603  * uint64 on 32-bit platforms.  That's not problem for the usual use where a
 604  * pointer or a length is aligned, but for the odd case that you need to
 605  * align something (potentially) wider, use TYPEALIGN64.
 606  */
 607 #define TYPEALIGN64(ALIGNVAL,LEN)  \
 608         (((uint64) (LEN) + ((ALIGNVAL) - 1)) & ~((uint64) ((ALIGNVAL) - 1)))
 609
 610 /* we don't currently need wider versions of the other ALIGN macros */
 611 #define MAXALIGN64(LEN)                 TYPEALIGN64(MAXIMUM_ALIGNOF, (LEN))
 612
 613 /* ----------------
 614  * Attribute macros
 615  *
 616  * GCC: https://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html
 617  * GCC: https://gcc.gnu.org/onlinedocs/gcc/Type-Attributes.html
 618  * Sunpro: https://docs.oracle.com/cd/E18659_01/html/821-1384/gjzke.html
 619  * XLC: http://www-01.ibm.com/support/knowledgecenter/SSGH2K_11.1.0/com.ibm.xlc111.aix.doc/language_ref/function_attributes.html
 620  * XLC: http://www-01.ibm.com/support/knowledgecenter/SSGH2K_11.1.0/com.ibm.xlc111.aix.doc/language_ref/type_attrib.html
 621  * ----------------
 622  */
 623
 624 /* only GCC supports the unused attribute */
 625 #ifdef __GNUC__
 626 #define pg_attribute_unused() __attribute__((unused))
 627 #else
 628 #define pg_attribute_unused()
 629 #endif
 630
 631 /* GCC and XLC support format attributes */
 632 #if defined(__GNUC__) || defined(__IBMC__)
 633 #define pg_attribute_format_arg(a) __attribute__((format_arg(a)))
 634 #define pg_attribute_printf(f,a) __attribute__((format(PG_PRINTF_ATTRIBUTE, f, a)))
 635 #else
 636 #define pg_attribute_format_arg(a)
 637 #define pg_attribute_printf(f,a)
 638 #endif
 639
 640 /* GCC, Sunpro and XLC support aligned, packed and noreturn */
 641 #if defined(__GNUC__) || defined(__SUNPRO_C) || defined(__IBMC__)
 642 #define pg_attribute_aligned(a) __attribute__((aligned(a)))
 643 #define pg_attribute_noreturn() __attribute__((noreturn))
 644 #define pg_attribute_packed() __attribute__((packed))
 645 #define HAVE_PG_ATTRIBUTE_NORETURN 1
 646 #else
 647 /*
 648  * NB: aligned and packed are not given default definitions because they
 649  * affect code functionality; they *must* be implemented by the compiler
 650  * if they are to be used.
 651  */
 652 #define pg_attribute_noreturn()
 653 #endif
 654
 655 /* ----------------------------------------------------------------
 656  *                              Section 6:      assertions
 657  * ----------------------------------------------------------------
 658  */
 659
 660 /*
 661  * USE_ASSERT_CHECKING, if defined, turns on all the assertions.
 662  * - plai  9/5/90
 663  *
 664  * It should _NOT_ be defined in releases or in benchmark copies
 665  */
 666
 667 /*
 668  * Assert() can be used in both frontend and backend code. In frontend code it
 669  * just calls the standard assert, if it's available. If use of assertions is
 670  * not configured, it does nothing.
 671  */
 672 #ifndef USE_ASSERT_CHECKING
 673
 674 #define Assert(condition)       ((void)true)
 675 #define AssertMacro(condition)  ((void)true)
 676 #define AssertArg(condition)    ((void)true)
 677 #define AssertState(condition)  ((void)true)
 678 #define AssertPointerAlignment(ptr, bndr)       ((void)true)
 679 #define Trap(condition, errorType)      ((void)true)
 680 #define TrapMacro(condition, errorType) (true)
 681
 682 #elif defined(FRONTEND)
 683
 684 #include <assert.h>
 685 #define Assert(p) assert(p)
 686 #define AssertMacro(p)  ((void) assert(p))
 687 #define AssertArg(condition) assert(condition)
 688 #define AssertState(condition) assert(condition)
 689 #define AssertPointerAlignment(ptr, bndr)       ((void)true)
 690 #else                                                   /* USE_ASSERT_CHECKING && !FRONTEND */
 691
 692 /*
 693  * Trap
 694  *              Generates an exception if the given condition is true.
 695  */
 696 #define Trap(condition, errorType) \
 697         do { \
 698                 if (condition) \
 699                         ExceptionalCondition(CppAsString(condition), (errorType), \
 700                                                                  __FILE__, __LINE__); \
 701         } while (0)
 702
 703 /*
 704  *      TrapMacro is the same as Trap but it's intended for use in macros:
 705  *
 706  *              #define foo(x) (AssertMacro(x != 0), bar(x))
 707  *
 708  *      Isn't CPP fun?
 709  */
 710 #define TrapMacro(condition, errorType) \
 711         ((bool) (! (condition) || \
 712                          (ExceptionalCondition(CppAsString(condition), (errorType), \
 713                                                                    __FILE__, __LINE__), 0)))
 714
 715 #define Assert(condition) \
 716                 Trap(!(condition), "FailedAssertion")
 717
 718 #define AssertMacro(condition) \
 719                 ((void) TrapMacro(!(condition), "FailedAssertion"))
 720
 721 #define AssertArg(condition) \
 722                 Trap(!(condition), "BadArgument")
 723
 724 #define AssertState(condition) \
 725                 Trap(!(condition), "BadState")
 726
 727 /*
 728  * Check that `ptr' is `bndr' aligned.
 729  */
 730 #define AssertPointerAlignment(ptr, bndr) \
 731         Trap(TYPEALIGN(bndr, (uintptr_t)(ptr)) != (uintptr_t)(ptr), \
 732                  "UnalignedPointer")
 733
 734 #endif   /* USE_ASSERT_CHECKING && !FRONTEND */
 735
 736 /*
 737  * Macros to support compile-time assertion checks.
 738  *
 739  * If the "condition" (a compile-time-constant expression) evaluates to false,
 740  * throw a compile error using the "errmessage" (a string literal).
 741  *
 742  * gcc 4.6 and up supports _Static_assert(), but there are bizarre syntactic
 743  * placement restrictions.  These macros make it safe to use as a statement
 744  * or in an expression, respectively.
 745  *
 746  * Otherwise we fall back on a kluge that assumes the compiler will complain
 747  * about a negative width for a struct bit-field.  This will not include a
 748  * helpful error message, but it beats not getting an error at all.
 749  */
 750 #ifdef HAVE__STATIC_ASSERT
 751 #define StaticAssertStmt(condition, errmessage) \
 752         do { _Static_assert(condition, errmessage); } while(0)
 753 #define StaticAssertExpr(condition, errmessage) \
 754         ({ StaticAssertStmt(condition, errmessage); true; })
 755 #else                                                   /* !HAVE__STATIC_ASSERT */
 756 #define StaticAssertStmt(condition, errmessage) \
 757         ((void) sizeof(struct { int static_assert_failure : (condition) ? 1 : -1; }))
 758 #define StaticAssertExpr(condition, errmessage) \
 759         StaticAssertStmt(condition, errmessage)
 760 #endif   /* HAVE__STATIC_ASSERT */
 761
 762
 763 /*
 764  * Compile-time checks that a variable (or expression) has the specified type.
 765  *
 766  * AssertVariableIsOfType() can be used as a statement.
 767  * AssertVariableIsOfTypeMacro() is intended for use in macros, eg
 768  *              #define foo(x) (AssertVariableIsOfTypeMacro(x, int), bar(x))
 769  *
 770  * If we don't have __builtin_types_compatible_p, we can still assert that
 771  * the types have the same size.  This is far from ideal (especially on 32-bit
 772  * platforms) but it provides at least some coverage.
 773  */
 774 #ifdef HAVE__BUILTIN_TYPES_COMPATIBLE_P
 775 #define AssertVariableIsOfType(varname, typename) \
 776         StaticAssertStmt(__builtin_types_compatible_p(__typeof__(varname), typename), \
 777         CppAsString(varname) " does not have type " CppAsString(typename))
 778 #define AssertVariableIsOfTypeMacro(varname, typename) \
 779         ((void) StaticAssertExpr(__builtin_types_compatible_p(__typeof__(varname), typename), \
 780          CppAsString(varname) " does not have type " CppAsString(typename)))
 781 #else                                                   /* !HAVE__BUILTIN_TYPES_COMPATIBLE_P */
 782 #define AssertVariableIsOfType(varname, typename) \
 783         StaticAssertStmt(sizeof(varname) == sizeof(typename), \
 784         CppAsString(varname) " does not have type " CppAsString(typename))
 785 #define AssertVariableIsOfTypeMacro(varname, typename) \
 786         ((void) StaticAssertExpr(sizeof(varname) == sizeof(typename),           \
 787          CppAsString(varname) " does not have type " CppAsString(typename)))
 788 #endif   /* HAVE__BUILTIN_TYPES_COMPATIBLE_P */
 789
 790
 791 /* ----------------------------------------------------------------
 792  *                              Section 7:      widely useful macros
 793  * ----------------------------------------------------------------
 794  */
 795 /*
 796  * Max
 797  *              Return the maximum of two numbers.
 798  */
 799 #define Max(x, y)               ((x) > (y) ? (x) : (y))
 800
 801 /*
 802  * Min
 803  *              Return the minimum of two numbers.
 804  */
 805 #define Min(x, y)               ((x) < (y) ? (x) : (y))
 806
 807 /*
 808  * Abs
 809  *              Return the absolute value of the argument.
 810  */
 811 #define Abs(x)                  ((x) >= 0 ? (x) : -(x))
 812
 813 /*
 814  * StrNCpy
 815  *      Like standard library function strncpy(), except that result string
 816  *      is guaranteed to be null-terminated --- that is, at most N-1 bytes
 817  *      of the source string will be kept.
 818  *      Also, the macro returns no result (too hard to do that without
 819  *      evaluating the arguments multiple times, which seems worse).
 820  *
 821  *      BTW: when you need to copy a non-null-terminated string (like a text
 822  *      datum) and add a null, do not do it with StrNCpy(..., len+1).  That
 823  *      might seem to work, but it fetches one byte more than there is in the
 824  *      text object.  One fine day you'll have a SIGSEGV because there isn't
 825  *      another byte before the end of memory.  Don't laugh, we've had real
 826  *      live bug reports from real live users over exactly this mistake.
 827  *      Do it honestly with "memcpy(dst,src,len); dst[len] = '\0';", instead.
 828  */
 829 #define StrNCpy(dst,src,len) \
 830         do \
 831         { \
 832                 char * _dst = (dst); \
 833                 Size _len = (len); \
 834 \
 835                 if (_len > 0) \
 836                 { \
 837                         strncpy(_dst, (src), _len); \
 838                         _dst[_len-1] = '\0'; \
 839                 } \
 840         } while (0)
 841
 842
 843 /* Get a bit mask of the bits set in non-long aligned addresses */
 844 #define LONG_ALIGN_MASK (sizeof(long) - 1)
 845
 846 /*
 847  * MemSet
 848  *      Exactly the same as standard library function memset(), but considerably
 849  *      faster for zeroing small word-aligned structures (such as parsetree nodes).
 850  *      This has to be a macro because the main point is to avoid function-call
 851  *      overhead.   However, we have also found that the loop is faster than
 852  *      native libc memset() on some platforms, even those with assembler
 853  *      memset() functions.  More research needs to be done, perhaps with
 854  *      MEMSET_LOOP_LIMIT tests in configure.
 855  */
 856 #define MemSet(start, val, len) \
 857         do \
 858         { \
 859                 /* must be void* because we don't know if it is integer aligned yet */ \
 860                 void   *_vstart = (void *) (start); \
 861                 int             _val = (val); \
 862                 Size    _len = (len); \
 863 \
 864                 if ((((uintptr_t) _vstart) & LONG_ALIGN_MASK) == 0 && \
 865                         (_len & LONG_ALIGN_MASK) == 0 && \
 866                         _val == 0 && \
 867                         _len <= MEMSET_LOOP_LIMIT && \
 868                         /* \
 869                          *      If MEMSET_LOOP_LIMIT == 0, optimizer should find \
 870                          *      the whole "if" false at compile time. \
 871                          */ \
 872                         MEMSET_LOOP_LIMIT != 0) \
 873                 { \
 874                         long *_start = (long *) _vstart; \
 875                         long *_stop = (long *) ((char *) _start + _len); \
 876                         while (_start < _stop) \
 877                                 *_start++ = 0; \
 878                 } \
 879                 else \
 880                         memset(_vstart, _val, _len); \
 881         } while (0)
 882
 883 /*
 884  * MemSetAligned is the same as MemSet except it omits the test to see if
 885  * "start" is word-aligned.  This is okay to use if the caller knows a-priori
 886  * that the pointer is suitably aligned (typically, because he just got it
 887  * from palloc(), which always delivers a max-aligned pointer).
 888  */
 889 #define MemSetAligned(start, val, len) \
 890         do \
 891         { \
 892                 long   *_start = (long *) (start); \
 893                 int             _val = (val); \
 894                 Size    _len = (len); \
 895 \
 896                 if ((_len & LONG_ALIGN_MASK) == 0 && \
 897                         _val == 0 && \
 898                         _len <= MEMSET_LOOP_LIMIT && \
 899                         MEMSET_LOOP_LIMIT != 0) \
 900                 { \
 901                         long *_stop = (long *) ((char *) _start + _len); \
 902                         while (_start < _stop) \
 903                                 *_start++ = 0; \
 904                 } \
 905                 else \
 906                         memset(_start, _val, _len); \
 907         } while (0)
 908
 909
 910 /*
 911  * MemSetTest/MemSetLoop are a variant version that allow all the tests in
 912  * MemSet to be done at compile time in cases where "val" and "len" are
 913  * constants *and* we know the "start" pointer must be word-aligned.
 914  * If MemSetTest succeeds, then it is okay to use MemSetLoop, otherwise use
 915  * MemSetAligned.  Beware of multiple evaluations of the arguments when using
 916  * this approach.
 917  */
 918 #define MemSetTest(val, len) \
 919         ( ((len) & LONG_ALIGN_MASK) == 0 && \
 920         (len) <= MEMSET_LOOP_LIMIT && \
 921         MEMSET_LOOP_LIMIT != 0 && \
 922         (val) == 0 )
 923
 924 #define MemSetLoop(start, val, len) \
 925         do \
 926         { \
 927                 long * _start = (long *) (start); \
 928                 long * _stop = (long *) ((char *) _start + (Size) (len)); \
 929         \
 930                 while (_start < _stop) \
 931                         *_start++ = 0; \
 932         } while (0)
 933
 934
 935 /*
 936  * Mark a point as unreachable in a portable fashion.  This should preferably
 937  * be something that the compiler understands, to aid code generation.
 938  * In assert-enabled builds, we prefer abort() for debugging reasons.
 939  */
 940 #if defined(HAVE__BUILTIN_UNREACHABLE) && !defined(USE_ASSERT_CHECKING)
 941 #define pg_unreachable() __builtin_unreachable()
 942 #elif defined(_MSC_VER) && !defined(USE_ASSERT_CHECKING)
 943 #define pg_unreachable() __assume(0)
 944 #else
 945 #define pg_unreachable() abort()
 946 #endif
 947
 948
 949 /*
 950  * Hints to the compiler about the likelihood of a branch. Both likely() and
 951  * unlikely() return the boolean value of the contained expression.
 952  *
 953  * These should only be used sparingly, in very hot code paths. It's very easy
 954  * to mis-estimate likelihoods.
 955  */
 956 #if __GNUC__ >= 3
 957 #define likely(x)       __builtin_expect((x) != 0, 1)
 958 #define unlikely(x) __builtin_expect((x) != 0, 0)
 959 #else
 960 #define likely(x)       ((x) != 0)
 961 #define unlikely(x) ((x) != 0)
 962 #endif
 963
 964
 965 /* ----------------------------------------------------------------
 966  *                              Section 8:      random stuff
 967  * ----------------------------------------------------------------
 968  */
 969
 970 /* msb for char */
 971 #define HIGHBIT                                 (0x80)
 972 #define IS_HIGHBIT_SET(ch)              ((unsigned char)(ch) & HIGHBIT)
 973
 974 #define STATUS_OK                               (0)
 975 #define STATUS_ERROR                    (-1)
 976 #define STATUS_EOF                              (-2)
 977 #define STATUS_FOUND                    (1)
 978 #define STATUS_WAITING                  (2)
 979
 980
 981 /*
 982  * Append PG_USED_FOR_ASSERTS_ONLY to definitions of variables that are only
 983  * used in assert-enabled builds, to avoid compiler warnings about unused
 984  * variables in assert-disabled builds.
 985  */
 986 #ifdef USE_ASSERT_CHECKING
 987 #define PG_USED_FOR_ASSERTS_ONLY
 988 #else
 989 #define PG_USED_FOR_ASSERTS_ONLY pg_attribute_unused()
 990 #endif
 991
 992
 993 /* gettext domain name mangling */
 994
 995 /*
 996  * To better support parallel installations of major PostgreSQL
 997  * versions as well as parallel installations of major library soname
 998  * versions, we mangle the gettext domain name by appending those
 999  * version numbers.  The coding rule ought to be that wherever the
1000  * domain name is mentioned as a literal, it must be wrapped into
1001  * PG_TEXTDOMAIN().  The macros below do not work on non-literals; but
1002  * that is somewhat intentional because it avoids having to worry
1003  * about multiple states of premangling and postmangling as the values
1004  * are being passed around.
1005  *
1006  * Make sure this matches the installation rules in nls-global.mk.
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 */