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-2007, PostgreSQL Global Development Group
  13  * Portions Copyright (c) 1994, Regents of the University of California
  14  *
  15  * $PostgreSQL: pgsql/src/include/c.h,v 1.215 2007/01/05 22:19:50 momjian Exp $
  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)              widely useful macros
  35  *              7)              random stuff
  36  *              8)              system-specific hacks
  37  *
  38  * NOTE: since this file is included by both frontend and backend modules, it's
  39  * almost certainly wrong to put an "extern" declaration here.  typedefs and
  40  * macros are the kind of thing that might go here.
  41  *
  42  *----------------------------------------------------------------
  43  */
  44 #ifndef C_H
  45 #define C_H
  46
  47 /*
  48  * We have to include stdlib.h here because it defines many of these macros
  49  * on some platforms, and we only want our definitions used if stdlib.h doesn't
  50  * have its own.  The same goes for stddef and stdarg if present.
  51  */
  52
  53 #include "pg_config.h"
  54 #include "pg_config_manual.h"   /* must be after pg_config.h */
  55 #if !defined(WIN32) && !defined(__CYGWIN__)             /* win32 will include further
  56                                                                                                  * down */
  57 #include "pg_config_os.h"               /* must be before any system header files */
  58 #endif
  59 #include "postgres_ext.h"
  60 #include "pg_trace.h"
  61
  62 #if defined(__BORLANDC__) || (_MSC_VER >= 1400)
  63 #define errcode __msvc_errcode
  64 #include <crtdefs.h>
  65 #undef errcode
  66 #endif
  67
  68 #include <stdio.h>
  69 #include <stdlib.h>
  70 #include <string.h>
  71 #include <stddef.h>
  72 #include <stdarg.h>
  73 #ifdef HAVE_STRINGS_H
  74 #include <strings.h>
  75 #endif
  76 #include <sys/types.h>
  77
  78 #include <errno.h>
  79 #if defined(WIN32) || defined(__CYGWIN__)
  80 #include <fcntl.h>                              /* ensure O_BINARY is available */
  81 #endif
  82 #ifdef HAVE_SUPPORTDEFS_H
  83 #include <SupportDefs.h>
  84 #endif
  85
  86 #if defined(WIN32) || defined(__CYGWIN__)
  87 /* We have to redefine some system functions after they are included above. */
  88 #include "pg_config_os.h"
  89 #endif
  90
  91 /* Must be before gettext() games below */
  92 #include <locale.h>
  93
  94 #define _(x) gettext((x))
  95
  96 #ifdef ENABLE_NLS
  97 #include <libintl.h>
  98 #else
  99 #define gettext(x) (x)
 100 #endif
 101
 102 /*
 103  *      Use this to mark strings to be translated by gettext, in places where
 104  *      you don't want an actual function call to occur (eg, constant tables).
 105  */
 106 #define gettext_noop(x) (x)
 107
 108
 109 /* ----------------------------------------------------------------
 110  *                              Section 1: hacks to cope with non-ANSI C compilers
 111  *
 112  * type prefixes (const, signed, volatile, inline) are handled in pg_config.h.
 113  * ----------------------------------------------------------------
 114  */
 115
 116 /*
 117  * CppAsString
 118  *              Convert the argument to a string, using the C preprocessor.
 119  * CppConcat
 120  *              Concatenate two arguments together, using the C preprocessor.
 121  *
 122  * Note: the standard Autoconf macro AC_C_STRINGIZE actually only checks
 123  * whether #identifier works, but if we have that we likely have ## too.
 124  */
 125 #if defined(HAVE_STRINGIZE)
 126
 127 #define CppAsString(identifier) #identifier
 128 #define CppConcat(x, y)                 x##y
 129 #else                                                   /* !HAVE_STRINGIZE */
 130
 131 #define CppAsString(identifier) "identifier"
 132
 133 /*
 134  * CppIdentity -- On Reiser based cpp's this is used to concatenate
 135  *              two tokens.  That is
 136  *                              CppIdentity(A)B ==> AB
 137  *              We renamed it to _private_CppIdentity because it should not
 138  *              be referenced outside this file.  On other cpp's it
 139  *              produces  A  B.
 140  */
 141 #define _priv_CppIdentity(x)x
 142 #define CppConcat(x, y)                 _priv_CppIdentity(x)y
 143 #endif   /* !HAVE_STRINGIZE */
 144
 145 /*
 146  * dummyret is used to set return values in macros that use ?: to make
 147  * assignments.  gcc wants these to be void, other compilers like char
 148  */
 149 #ifdef __GNUC__                                 /* GNU cc */
 150 #define dummyret        void
 151 #else
 152 #define dummyret        char
 153 #endif
 154
 155 #ifndef __GNUC__
 156 #define __attribute__(_arg_)
 157 #endif
 158
 159 /* ----------------------------------------------------------------
 160  *                              Section 2:      bool, true, false, TRUE, FALSE, NULL
 161  * ----------------------------------------------------------------
 162  */
 163
 164 /*
 165  * bool
 166  *              Boolean value, either true or false.
 167  *
 168  * XXX for C++ compilers, we assume the compiler has a compatible
 169  * built-in definition of bool.
 170  */
 171
 172 #ifndef __cplusplus
 173
 174 #ifndef bool
 175 typedef char bool;
 176 #endif
 177
 178 #ifndef true
 179 #define true    ((bool) 1)
 180 #endif
 181
 182 #ifndef false
 183 #define false   ((bool) 0)
 184 #endif
 185 #endif   /* not C++ */
 186
 187 typedef bool *BoolPtr;
 188
 189 #ifndef TRUE
 190 #define TRUE    1
 191 #endif
 192
 193 #ifndef FALSE
 194 #define FALSE   0
 195 #endif
 196
 197 /*
 198  * NULL
 199  *              Null pointer.
 200  */
 201 #ifndef NULL
 202 #define NULL    ((void *) 0)
 203 #endif
 204
 205
 206 /* ----------------------------------------------------------------
 207  *                              Section 3:      standard system types
 208  * ----------------------------------------------------------------
 209  */
 210
 211 /*
 212  * Pointer
 213  *              Variable holding address of any memory resident object.
 214  *
 215  *              XXX Pointer arithmetic is done with this, so it can't be void *
 216  *              under "true" ANSI compilers.
 217  */
 218 typedef char *Pointer;
 219
 220 /*
 221  * intN
 222  *              Signed integer, EXACTLY N BITS IN SIZE,
 223  *              used for numerical computations and the
 224  *              frontend/backend protocol.
 225  */
 226 #ifndef HAVE_INT8
 227 typedef signed char int8;               /* == 8 bits */
 228 typedef signed short int16;             /* == 16 bits */
 229 typedef signed int int32;               /* == 32 bits */
 230 #endif   /* not HAVE_INT8 */
 231
 232 /*
 233  * uintN
 234  *              Unsigned integer, EXACTLY N BITS IN SIZE,
 235  *              used for numerical computations and the
 236  *              frontend/backend protocol.
 237  */
 238 #ifndef HAVE_UINT8
 239 typedef unsigned char uint8;    /* == 8 bits */
 240 typedef unsigned short uint16;  /* == 16 bits */
 241 typedef unsigned int uint32;    /* == 32 bits */
 242 #endif   /* not HAVE_UINT8 */
 243
 244 /*
 245  * bitsN
 246  *              Unit of bitwise operation, AT LEAST N BITS IN SIZE.
 247  */
 248 typedef uint8 bits8;                    /* >= 8 bits */
 249 typedef uint16 bits16;                  /* >= 16 bits */
 250 typedef uint32 bits32;                  /* >= 32 bits */
 251
 252 /*
 253  * floatN
 254  *              Floating point number, AT LEAST N BITS IN SIZE,
 255  *              used for numerical computations.
 256  *
 257  *              Since sizeof(floatN) may be > sizeof(char *), always pass
 258  *              floatN by reference.
 259  *
 260  * XXX: these typedefs are now deprecated in favor of float4 and float8.
 261  * They will eventually go away.
 262  */
 263 typedef float float32data;
 264 typedef double float64data;
 265 typedef float *float32;
 266 typedef double *float64;
 267
 268 /*
 269  * 64-bit integers
 270  */
 271 #ifdef HAVE_LONG_INT_64
 272 /* Plain "long int" fits, use it */
 273
 274 #ifndef HAVE_INT64
 275 typedef long int int64;
 276 #endif
 277 #ifndef HAVE_UINT64
 278 typedef unsigned long int uint64;
 279 #endif
 280 #elif defined(HAVE_LONG_LONG_INT_64)
 281 /* We have working support for "long long int", use that */
 282
 283 #ifndef HAVE_INT64
 284 typedef long long int int64;
 285 #endif
 286 #ifndef HAVE_UINT64
 287 typedef unsigned long long int uint64;
 288 #endif
 289 #else                                                   /* not HAVE_LONG_INT_64 and not
 290                                                                  * HAVE_LONG_LONG_INT_64 */
 291
 292 /* Won't actually work, but fall back to long int so that code compiles */
 293 #ifndef HAVE_INT64
 294 typedef long int int64;
 295 #endif
 296 #ifndef HAVE_UINT64
 297 typedef unsigned long int uint64;
 298 #endif
 299
 300 #define INT64_IS_BUSTED
 301 #endif   /* not HAVE_LONG_INT_64 and not
 302                                                                  * HAVE_LONG_LONG_INT_64 */
 303
 304 /* Decide if we need to decorate 64-bit constants */
 305 #ifdef HAVE_LL_CONSTANTS
 306 #define INT64CONST(x)  ((int64) x##LL)
 307 #define UINT64CONST(x) ((uint64) x##ULL)
 308 #else
 309 #define INT64CONST(x)  ((int64) x)
 310 #define UINT64CONST(x) ((uint64) x)
 311 #endif
 312
 313
 314 /* Select timestamp representation (float8 or int64) */
 315 #if defined(USE_INTEGER_DATETIMES) && !defined(INT64_IS_BUSTED)
 316 #define HAVE_INT64_TIMESTAMP
 317 #endif
 318
 319 /* sig_atomic_t is required by ANSI C, but may be missing on old platforms */
 320 #ifndef HAVE_SIG_ATOMIC_T
 321 typedef int sig_atomic_t;
 322 #endif
 323
 324 /*
 325  * Size
 326  *              Size of any memory resident object, as returned by sizeof.
 327  */
 328 typedef size_t Size;
 329
 330 /*
 331  * Index
 332  *              Index into any memory resident array.
 333  *
 334  * Note:
 335  *              Indices are non negative.
 336  */
 337 typedef unsigned int Index;
 338
 339 /*
 340  * Offset
 341  *              Offset into any memory resident array.
 342  *
 343  * Note:
 344  *              This differs from an Index in that an Index is always
 345  *              non negative, whereas Offset may be negative.
 346  */
 347 typedef signed int Offset;
 348
 349 /*
 350  * Common Postgres datatype names (as used in the catalogs)
 351  */
 352 typedef int16 int2;
 353 typedef int32 int4;
 354 typedef float float4;
 355 typedef double float8;
 356
 357 /*
 358  * Oid, RegProcedure, TransactionId, SubTransactionId, MultiXactId,
 359  * CommandId
 360  */
 361
 362 /* typedef Oid is in postgres_ext.h */
 363
 364 /*
 365  * regproc is the type name used in the include/catalog headers, but
 366  * RegProcedure is the preferred name in C code.
 367  */
 368 typedef Oid regproc;
 369 typedef regproc RegProcedure;
 370
 371 typedef uint32 TransactionId;
 372
 373 typedef uint32 SubTransactionId;
 374
 375 #define InvalidSubTransactionId         ((SubTransactionId) 0)
 376 #define TopSubTransactionId                     ((SubTransactionId) 1)
 377
 378 /* MultiXactId must be equivalent to TransactionId, to fit in t_xmax */
 379 typedef TransactionId MultiXactId;
 380
 381 typedef uint32 MultiXactOffset;
 382
 383 typedef uint32 CommandId;
 384
 385 #define FirstCommandId  ((CommandId) 0)
 386
 387 /*
 388  * Array indexing support
 389  */
 390 #define MAXDIM 6
 391 typedef struct
 392 {
 393         int                     indx[MAXDIM];
 394 } IntArray;
 395
 396 /* ----------------
 397  *              Variable-length datatypes all share the 'struct varlena' header.
 398  *
 399  * NOTE: for TOASTable types, this is an oversimplification, since the value
 400  * may be compressed or moved out-of-line.      However datatype-specific routines
 401  * are mostly content to deal with de-TOASTed values only, and of course
 402  * client-side routines should never see a TOASTed value.  See postgres.h for
 403  * details of the TOASTed form.
 404  * ----------------
 405  */
 406 struct varlena
 407 {
 408         int32           vl_len;
 409         char            vl_dat[1];
 410 };
 411
 412 #define VARHDRSZ                ((int32) sizeof(int32))
 413
 414 /*
 415  * These widely-used datatypes are just a varlena header and the data bytes.
 416  * There is no terminating null or anything like that --- the data length is
 417  * always VARSIZE(ptr) - VARHDRSZ.
 418  */
 419 typedef struct varlena bytea;
 420 typedef struct varlena text;
 421 typedef struct varlena BpChar;  /* blank-padded char, ie SQL char(n) */
 422 typedef struct varlena VarChar; /* var-length char, ie SQL varchar(n) */
 423
 424 /*
 425  * Specialized array types.  These are physically laid out just the same
 426  * as regular arrays (so that the regular array subscripting code works
 427  * with them).  They exist as distinct types mostly for historical reasons:
 428  * they have nonstandard I/O behavior which we don't want to change for fear
 429  * of breaking applications that look at the system catalogs.  There is also
 430  * an implementation issue for oidvector: it's part of the primary key for
 431  * pg_proc, and we can't use the normal btree array support routines for that
 432  * without circularity.
 433  */
 434 typedef struct
 435 {
 436         int32           size;                   /* these fields must match ArrayType! */
 437         int                     ndim;                   /* always 1 for int2vector */
 438         int32           dataoffset;             /* always 0 for int2vector */
 439         Oid                     elemtype;
 440         int                     dim1;
 441         int                     lbound1;
 442         int2            values[1];              /* VARIABLE LENGTH ARRAY */
 443 } int2vector;                                   /* VARIABLE LENGTH STRUCT */
 444
 445 typedef struct
 446 {
 447         int32           size;                   /* these fields must match ArrayType! */
 448         int                     ndim;                   /* always 1 for oidvector */
 449         int32           dataoffset;             /* always 0 for oidvector */
 450         Oid                     elemtype;
 451         int                     dim1;
 452         int                     lbound1;
 453         Oid                     values[1];              /* VARIABLE LENGTH ARRAY */
 454 } oidvector;                                    /* VARIABLE LENGTH STRUCT */
 455
 456 /*
 457  * We want NameData to have length NAMEDATALEN and int alignment,
 458  * because that's how the data type 'name' is defined in pg_type.
 459  * Use a union to make sure the compiler agrees.  Note that NAMEDATALEN
 460  * must be a multiple of sizeof(int), else sizeof(NameData) will probably
 461  * not come out equal to NAMEDATALEN.
 462  */
 463 typedef union nameData
 464 {
 465         char            data[NAMEDATALEN];
 466         int                     alignmentDummy;
 467 } NameData;
 468 typedef NameData *Name;
 469
 470 #define NameStr(name)   ((name).data)
 471
 472 /*
 473  * Support macros for escaping strings.  escape_backslash should be TRUE
 474  * if generating a non-standard-conforming string.      Prefixing a string
 475  * with ESCAPE_STRING_SYNTAX guarantees it is non-standard-conforming.
 476  * Beware of multiple evaluation of the "ch" argument!
 477  */
 478 #define SQL_STR_DOUBLE(ch, escape_backslash)    \
 479         ((ch) == '\'' || ((ch) == '\\' && (escape_backslash)))
 480
 481 #define ESCAPE_STRING_SYNTAX    'E'
 482
 483 /* ----------------------------------------------------------------
 484  *                              Section 4:      IsValid macros for system types
 485  * ----------------------------------------------------------------
 486  */
 487 /*
 488  * BoolIsValid
 489  *              True iff bool is valid.
 490  */
 491 #define BoolIsValid(boolean)    ((boolean) == false || (boolean) == true)
 492
 493 /*
 494  * PointerIsValid
 495  *              True iff pointer is valid.
 496  */
 497 #define PointerIsValid(pointer) ((void*)(pointer) != NULL)
 498
 499 /*
 500  * PointerIsAligned
 501  *              True iff pointer is properly aligned to point to the given type.
 502  */
 503 #define PointerIsAligned(pointer, type) \
 504                 (((long)(pointer) % (sizeof (type))) == 0)
 505
 506 #define OidIsValid(objectId)  ((bool) ((objectId) != InvalidOid))
 507
 508 #define RegProcedureIsValid(p)  OidIsValid(p)
 509
 510
 511 /* ----------------------------------------------------------------
 512  *                              Section 5:      offsetof, lengthof, endof, alignment
 513  * ----------------------------------------------------------------
 514  */
 515 /*
 516  * offsetof
 517  *              Offset of a structure/union field within that structure/union.
 518  *
 519  *              XXX This is supposed to be part of stddef.h, but isn't on
 520  *              some systems (like SunOS 4).
 521  */
 522 #ifndef offsetof
 523 #define offsetof(type, field)   ((long) &((type *)0)->field)
 524 #endif   /* offsetof */
 525
 526 /*
 527  * lengthof
 528  *              Number of elements in an array.
 529  */
 530 #define lengthof(array) (sizeof (array) / sizeof ((array)[0]))
 531
 532 /*
 533  * endof
 534  *              Address of the element one past the last in an array.
 535  */
 536 #define endof(array)    (&(array)[lengthof(array)])
 537
 538 /* ----------------
 539  * Alignment macros: align a length or address appropriately for a given type.
 540  *
 541  * There used to be some incredibly crufty platform-dependent hackery here,
 542  * but now we rely on the configure script to get the info for us. Much nicer.
 543  *
 544  * NOTE: TYPEALIGN will not work if ALIGNVAL is not a power of 2.
 545  * That case seems extremely unlikely to occur in practice, however.
 546  * ----------------
 547  */
 548
 549 #define TYPEALIGN(ALIGNVAL,LEN)  \
 550         (((long) (LEN) + ((ALIGNVAL) - 1)) & ~((long) ((ALIGNVAL) - 1)))
 551
 552 #define SHORTALIGN(LEN)                 TYPEALIGN(ALIGNOF_SHORT, (LEN))
 553 #define INTALIGN(LEN)                   TYPEALIGN(ALIGNOF_INT, (LEN))
 554 #define LONGALIGN(LEN)                  TYPEALIGN(ALIGNOF_LONG, (LEN))
 555 #define DOUBLEALIGN(LEN)                TYPEALIGN(ALIGNOF_DOUBLE, (LEN))
 556 #define MAXALIGN(LEN)                   TYPEALIGN(MAXIMUM_ALIGNOF, (LEN))
 557 /* MAXALIGN covers only built-in types, not buffers */
 558 #define BUFFERALIGN(LEN)                TYPEALIGN(ALIGNOF_BUFFER, (LEN))
 559
 560
 561 /* ----------------------------------------------------------------
 562  *                              Section 6:      widely useful macros
 563  * ----------------------------------------------------------------
 564  */
 565 /*
 566  * Max
 567  *              Return the maximum of two numbers.
 568  */
 569 #define Max(x, y)               ((x) > (y) ? (x) : (y))
 570
 571 /*
 572  * Min
 573  *              Return the minimum of two numbers.
 574  */
 575 #define Min(x, y)               ((x) < (y) ? (x) : (y))
 576
 577 /*
 578  * Abs
 579  *              Return the absolute value of the argument.
 580  */
 581 #define Abs(x)                  ((x) >= 0 ? (x) : -(x))
 582
 583 /*
 584  * StrNCpy
 585  *      Like standard library function strncpy(), except that result string
 586  *      is guaranteed to be null-terminated --- that is, at most N-1 bytes
 587  *      of the source string will be kept.
 588  *      Also, the macro returns no result (too hard to do that without
 589  *      evaluating the arguments multiple times, which seems worse).
 590  *
 591  *      BTW: when you need to copy a non-null-terminated string (like a text
 592  *      datum) and add a null, do not do it with StrNCpy(..., len+1).  That
 593  *      might seem to work, but it fetches one byte more than there is in the
 594  *      text object.  One fine day you'll have a SIGSEGV because there isn't
 595  *      another byte before the end of memory.  Don't laugh, we've had real
 596  *      live bug reports from real live users over exactly this mistake.
 597  *      Do it honestly with "memcpy(dst,src,len); dst[len] = '\0';", instead.
 598  */
 599 #define StrNCpy(dst,src,len) \
 600         do \
 601         { \
 602                 char * _dst = (dst); \
 603                 Size _len = (len); \
 604 \
 605                 if (_len > 0) \
 606                 { \
 607                         strncpy(_dst, (src), _len); \
 608                         _dst[_len-1] = '\0'; \
 609                 } \
 610         } while (0)
 611
 612
 613 /* Get a bit mask of the bits set in non-long aligned addresses */
 614 #define LONG_ALIGN_MASK (sizeof(long) - 1)
 615
 616 /*
 617  * MemSet
 618  *      Exactly the same as standard library function memset(), but considerably
 619  *      faster for zeroing small word-aligned structures (such as parsetree nodes).
 620  *      This has to be a macro because the main point is to avoid function-call
 621  *      overhead.       However, we have also found that the loop is faster than
 622  *      native libc memset() on some platforms, even those with assembler
 623  *      memset() functions.  More research needs to be done, perhaps with
 624  *      MEMSET_LOOP_LIMIT tests in configure.
 625  */
 626 #define MemSet(start, val, len) \
 627         do \
 628         { \
 629                 /* must be void* because we don't know if it is integer aligned yet */ \
 630                 void   *_vstart = (void *) (start); \
 631                 int             _val = (val); \
 632                 Size    _len = (len); \
 633 \
 634                 if ((((long) _vstart) & LONG_ALIGN_MASK) == 0 && \
 635                         (_len & LONG_ALIGN_MASK) == 0 && \
 636                         _val == 0 && \
 637                         _len <= MEMSET_LOOP_LIMIT && \
 638                         /* \
 639                          *      If MEMSET_LOOP_LIMIT == 0, optimizer should find \
 640                          *      the whole "if" false at compile time. \
 641                          */ \
 642                         MEMSET_LOOP_LIMIT != 0) \
 643                 { \
 644                         long *_start = (long *) _vstart; \
 645                         long *_stop = (long *) ((char *) _start + _len); \
 646                         while (_start < _stop) \
 647                                 *_start++ = 0; \
 648                 } \
 649                 else \
 650                         memset(_vstart, _val, _len); \
 651         } while (0)
 652
 653 /*
 654  * MemSetAligned is the same as MemSet except it omits the test to see if
 655  * "start" is word-aligned.  This is okay to use if the caller knows a-priori
 656  * that the pointer is suitably aligned (typically, because he just got it
 657  * from palloc(), which always delivers a max-aligned pointer).
 658  */
 659 #define MemSetAligned(start, val, len) \
 660         do \
 661         { \
 662                 long   *_start = (long *) (start); \
 663                 int             _val = (val); \
 664                 Size    _len = (len); \
 665 \
 666                 if ((_len & LONG_ALIGN_MASK) == 0 && \
 667                         _val == 0 && \
 668                         _len <= MEMSET_LOOP_LIMIT && \
 669                         MEMSET_LOOP_LIMIT != 0) \
 670                 { \
 671                         long *_stop = (long *) ((char *) _start + _len); \
 672                         while (_start < _stop) \
 673                                 *_start++ = 0; \
 674                 } \
 675                 else \
 676                         memset(_start, _val, _len); \
 677         } while (0)
 678
 679
 680 /*
 681  * MemSetTest/MemSetLoop are a variant version that allow all the tests in
 682  * MemSet to be done at compile time in cases where "val" and "len" are
 683  * constants *and* we know the "start" pointer must be word-aligned.
 684  * If MemSetTest succeeds, then it is okay to use MemSetLoop, otherwise use
 685  * MemSetAligned.  Beware of multiple evaluations of the arguments when using
 686  * this approach.
 687  */
 688 #define MemSetTest(val, len) \
 689         ( ((len) & LONG_ALIGN_MASK) == 0 && \
 690         (len) <= MEMSET_LOOP_LIMIT && \
 691         MEMSET_LOOP_LIMIT != 0 && \
 692         (val) == 0 )
 693
 694 #define MemSetLoop(start, val, len) \
 695         do \
 696         { \
 697                 long * _start = (long *) (start); \
 698                 long * _stop = (long *) ((char *) _start + (Size) (len)); \
 699         \
 700                 while (_start < _stop) \
 701                         *_start++ = 0; \
 702         } while (0)
 703
 704
 705 /* ----------------------------------------------------------------
 706  *                              Section 7:      random stuff
 707  * ----------------------------------------------------------------
 708  */
 709
 710 /* msb for char */
 711 #define HIGHBIT                                 (0x80)
 712 #define IS_HIGHBIT_SET(ch)              ((unsigned char)(ch) & HIGHBIT)
 713
 714 #define STATUS_OK                               (0)
 715 #define STATUS_ERROR                    (-1)
 716 #define STATUS_EOF                              (-2)
 717 #define STATUS_FOUND                    (1)
 718 #define STATUS_WAITING                  (2)
 719
 720
 721 /* ----------------------------------------------------------------
 722  *                              Section 8: system-specific hacks
 723  *
 724  *              This should be limited to things that absolutely have to be
 725  *              included in every source file.  The port-specific header file
 726  *              is usually a better place for this sort of thing.
 727  * ----------------------------------------------------------------
 728  */
 729
 730 /*
 731  *      NOTE:  this is also used for opening text files.
 732  *      WIN32 treats Control-Z as EOF in files opened in text mode.
 733  *      Therefore, we open files in binary mode on Win32 so we can read
 734  *      literal control-Z.      The other affect is that we see CRLF, but
 735  *      that is OK because we can already handle those cleanly.
 736  */
 737 #if defined(WIN32) || defined(__CYGWIN__)
 738 #define PG_BINARY       O_BINARY
 739 #define PG_BINARY_R "rb"
 740 #define PG_BINARY_W "wb"
 741 #else
 742 #define PG_BINARY       0
 743 #define PG_BINARY_R "r"
 744 #define PG_BINARY_W "w"
 745 #endif
 746
 747 #if defined(sun) && defined(__sparc__) && !defined(__SVR4)
 748 #include <unistd.h>
 749 #endif
 750
 751 /* These are for things that are one way on Unix and another on NT */
 752 #define NULL_DEV                "/dev/null"
 753
 754 /*
 755  * Provide prototypes for routines not present in a particular machine's
 756  * standard C library.
 757  */
 758
 759 #if !HAVE_DECL_SNPRINTF
 760 extern int
 761 snprintf(char *str, size_t count, const char *fmt,...)
 762 /* This extension allows gcc to check the format string */
 763 __attribute__((format(printf, 3, 4)));
 764 #endif
 765
 766 #if !HAVE_DECL_VSNPRINTF
 767 extern int      vsnprintf(char *str, size_t count, const char *fmt, va_list args);
 768 #endif
 769
 770 #if !defined(HAVE_MEMMOVE) && !defined(memmove)
 771 #define memmove(d, s, c)                bcopy(s, d, c)
 772 #endif
 773
 774 #ifndef DLLIMPORT
 775 #define DLLIMPORT                               /* no special DLL markers on most ports */
 776 #endif
 777
 778 /*
 779  * The following is used as the arg list for signal handlers.  Any ports
 780  * that take something other than an int argument should override this in
 781  * their pg_config_os.h file.  Note that variable names are required
 782  * because it is used in both the prototypes as well as the definitions.
 783  * Note also the long name.  We expect that this won't collide with
 784  * other names causing compiler warnings.
 785  */
 786
 787 #ifndef SIGNAL_ARGS
 788 #define SIGNAL_ARGS  int postgres_signal_arg
 789 #endif
 790
 791 /*
 792  * When there is no sigsetjmp, its functionality is provided by plain
 793  * setjmp. Incidentally, nothing provides setjmp's functionality in
 794  * that case.
 795  */
 796 #ifndef HAVE_SIGSETJMP
 797 #define sigjmp_buf jmp_buf
 798 #define sigsetjmp(x,y) setjmp(x)
 799 #define siglongjmp longjmp
 800 #endif
 801
 802 #if defined(HAVE_FDATASYNC) && !HAVE_DECL_FDATASYNC
 803 extern int      fdatasync(int fildes);
 804 #endif
 805
 806 /* If strtoq() exists, rename it to the more standard strtoll() */
 807 #if defined(HAVE_LONG_LONG_INT_64) && !defined(HAVE_STRTOLL) && defined(HAVE_STRTOQ)
 808 #define strtoll strtoq
 809 #define HAVE_STRTOLL 1
 810 #endif
 811
 812 /* If strtouq() exists, rename it to the more standard strtoull() */
 813 #if defined(HAVE_LONG_LONG_INT_64) && !defined(HAVE_STRTOULL) && defined(HAVE_STRTOUQ)
 814 #define strtoull strtouq
 815 #define HAVE_STRTOULL 1
 816 #endif
 817
 818 /* EXEC_BACKEND defines */
 819 #ifdef EXEC_BACKEND
 820 #define NON_EXEC_STATIC
 821 #else
 822 #define NON_EXEC_STATIC static
 823 #endif
 824
 825 /* /port compatibility functions */
 826 #include "port.h"
 827
 828 #endif   /* C_H */