1 /*-------------------------------------------------------------------------
4 * Fundamental C definitions. This is included by every .c file in
5 * PostgreSQL (via either postgres.h or postgres_fe.h, as appropriate).
7 * Note that the definitions here are not intended to be exposed to clients
8 * of the frontend interface libraries --- so we don't worry much about
9 * polluting the namespace with lots of stuff...
12 * Portions Copyright (c) 1996-2006, PostgreSQL Global Development Group
13 * Portions Copyright (c) 1994, Regents of the University of California
15 * $PostgreSQL: pgsql/src/include/c.h,v 1.213 2006/10/03 20:33:20 tgl Exp $
17 *-------------------------------------------------------------------------
20 *----------------------------------------------------------------
23 * When adding stuff to this file, please try to put stuff
24 * into the relevant section, or add new sections as appropriate.
27 * ------- ------------------------------------------------
28 * 0) pg_config.h and standard system headers
29 * 1) hacks to cope with non-ANSI C compilers
30 * 2) bool, true, false, TRUE, FALSE, NULL
31 * 3) standard system types
32 * 4) IsValid macros for system types
33 * 5) offsetof, lengthof, endof, alignment
34 * 6) widely useful macros
36 * 8) system-specific hacks
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.
42 *----------------------------------------------------------------
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.
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 down */
56 #include "pg_config_os.h" /* must be before any system header files */
58 #include "postgres_ext.h"
61 #if defined(__BORLANDC__) || (_MSC_VER >= 1400)
62 #define errcode __msvc_errcode
75 #include <sys/types.h>
78 #if defined(WIN32) || defined(__CYGWIN__)
79 #include <fcntl.h> /* ensure O_BINARY is available */
81 #ifdef HAVE_SUPPORTDEFS_H
82 #include <SupportDefs.h>
85 #if defined(WIN32) || defined(__CYGWIN__)
86 /* We have to redefine some system functions after they are included above. */
87 #include "pg_config_os.h"
90 /* Must be before gettext() games below */
93 #define _(x) gettext((x))
98 #define gettext(x) (x)
102 * Use this to mark strings to be translated by gettext, in places where
103 * you don't want an actual function call to occur (eg, constant tables).
105 #define gettext_noop(x) (x)
108 /* ----------------------------------------------------------------
109 * Section 1: hacks to cope with non-ANSI C compilers
111 * type prefixes (const, signed, volatile, inline) are handled in pg_config.h.
112 * ----------------------------------------------------------------
117 * Convert the argument to a string, using the C preprocessor.
119 * Concatenate two arguments together, using the C preprocessor.
121 * Note: the standard Autoconf macro AC_C_STRINGIZE actually only checks
122 * whether #identifier works, but if we have that we likely have ## too.
124 #if defined(HAVE_STRINGIZE)
126 #define CppAsString(identifier) #identifier
127 #define CppConcat(x, y) x##y
128 #else /* !HAVE_STRINGIZE */
130 #define CppAsString(identifier) "identifier"
133 * CppIdentity -- On Reiser based cpp's this is used to concatenate
134 * two tokens. That is
135 * CppIdentity(A)B ==> AB
136 * We renamed it to _private_CppIdentity because it should not
137 * be referenced outside this file. On other cpp's it
140 #define _priv_CppIdentity(x)x
141 #define CppConcat(x, y) _priv_CppIdentity(x)y
142 #endif /* !HAVE_STRINGIZE */
145 * dummyret is used to set return values in macros that use ?: to make
146 * assignments. gcc wants these to be void, other compilers like char
148 #ifdef __GNUC__ /* GNU cc */
149 #define dummyret void
151 #define dummyret char
155 #define __attribute__(_arg_)
158 /* ----------------------------------------------------------------
159 * Section 2: bool, true, false, TRUE, FALSE, NULL
160 * ----------------------------------------------------------------
165 * Boolean value, either true or false.
167 * XXX for C++ compilers, we assume the compiler has a compatible
168 * built-in definition of bool.
178 #define true ((bool) 1)
182 #define false ((bool) 0)
186 typedef bool *BoolPtr;
201 #define NULL ((void *) 0)
205 /* ----------------------------------------------------------------
206 * Section 3: standard system types
207 * ----------------------------------------------------------------
212 * Variable holding address of any memory resident object.
214 * XXX Pointer arithmetic is done with this, so it can't be void *
215 * under "true" ANSI compilers.
217 typedef char *Pointer;
221 * Signed integer, EXACTLY N BITS IN SIZE,
222 * used for numerical computations and the
223 * frontend/backend protocol.
226 typedef signed char int8; /* == 8 bits */
227 typedef signed short int16; /* == 16 bits */
228 typedef signed int int32; /* == 32 bits */
229 #endif /* not HAVE_INT8 */
233 * Unsigned integer, EXACTLY N BITS IN SIZE,
234 * used for numerical computations and the
235 * frontend/backend protocol.
238 typedef unsigned char uint8; /* == 8 bits */
239 typedef unsigned short uint16; /* == 16 bits */
240 typedef unsigned int uint32; /* == 32 bits */
241 #endif /* not HAVE_UINT8 */
245 * Unit of bitwise operation, AT LEAST N BITS IN SIZE.
247 typedef uint8 bits8; /* >= 8 bits */
248 typedef uint16 bits16; /* >= 16 bits */
249 typedef uint32 bits32; /* >= 32 bits */
253 * Floating point number, AT LEAST N BITS IN SIZE,
254 * used for numerical computations.
256 * Since sizeof(floatN) may be > sizeof(char *), always pass
257 * floatN by reference.
259 * XXX: these typedefs are now deprecated in favor of float4 and float8.
260 * They will eventually go away.
262 typedef float float32data;
263 typedef double float64data;
264 typedef float *float32;
265 typedef double *float64;
270 #ifdef HAVE_LONG_INT_64
271 /* Plain "long int" fits, use it */
274 typedef long int int64;
277 typedef unsigned long int uint64;
279 #elif defined(HAVE_LONG_LONG_INT_64)
280 /* We have working support for "long long int", use that */
283 typedef long long int int64;
286 typedef unsigned long long int uint64;
288 #else /* not HAVE_LONG_INT_64 and not
289 * HAVE_LONG_LONG_INT_64 */
291 /* Won't actually work, but fall back to long int so that code compiles */
293 typedef long int int64;
296 typedef unsigned long int uint64;
299 #define INT64_IS_BUSTED
300 #endif /* not HAVE_LONG_INT_64 and not
301 * HAVE_LONG_LONG_INT_64 */
303 /* Decide if we need to decorate 64-bit constants */
304 #ifdef HAVE_LL_CONSTANTS
305 #define INT64CONST(x) ((int64) x##LL)
306 #define UINT64CONST(x) ((uint64) x##ULL)
308 #define INT64CONST(x) ((int64) x)
309 #define UINT64CONST(x) ((uint64) x)
313 /* Select timestamp representation (float8 or int64) */
314 #if defined(USE_INTEGER_DATETIMES) && !defined(INT64_IS_BUSTED)
315 #define HAVE_INT64_TIMESTAMP
318 /* sig_atomic_t is required by ANSI C, but may be missing on old platforms */
319 #ifndef HAVE_SIG_ATOMIC_T
320 typedef int sig_atomic_t;
325 * Size of any memory resident object, as returned by sizeof.
331 * Index into any memory resident array.
334 * Indices are non negative.
336 typedef unsigned int Index;
340 * Offset into any memory resident array.
343 * This differs from an Index in that an Index is always
344 * non negative, whereas Offset may be negative.
346 typedef signed int Offset;
349 * Common Postgres datatype names (as used in the catalogs)
353 typedef float float4;
354 typedef double float8;
357 * Oid, RegProcedure, TransactionId, SubTransactionId, MultiXactId,
361 /* typedef Oid is in postgres_ext.h */
364 * regproc is the type name used in the include/catalog headers, but
365 * RegProcedure is the preferred name in C code.
368 typedef regproc RegProcedure;
370 typedef uint32 TransactionId;
372 typedef uint32 SubTransactionId;
374 #define InvalidSubTransactionId ((SubTransactionId) 0)
375 #define TopSubTransactionId ((SubTransactionId) 1)
377 /* MultiXactId must be equivalent to TransactionId, to fit in t_xmax */
378 typedef TransactionId MultiXactId;
380 typedef uint32 MultiXactOffset;
382 typedef uint32 CommandId;
384 #define FirstCommandId ((CommandId) 0)
387 * Array indexing support
396 * Variable-length datatypes all share the 'struct varlena' header.
398 * NOTE: for TOASTable types, this is an oversimplification, since the value
399 * may be compressed or moved out-of-line. However datatype-specific routines
400 * are mostly content to deal with de-TOASTed values only, and of course
401 * client-side routines should never see a TOASTed value. See postgres.h for
402 * details of the TOASTed form.
411 #define VARHDRSZ ((int32) sizeof(int32))
414 * These widely-used datatypes are just a varlena header and the data bytes.
415 * There is no terminating null or anything like that --- the data length is
416 * always VARSIZE(ptr) - VARHDRSZ.
418 typedef struct varlena bytea;
419 typedef struct varlena text;
420 typedef struct varlena BpChar; /* blank-padded char, ie SQL char(n) */
421 typedef struct varlena VarChar; /* var-length char, ie SQL varchar(n) */
424 * Specialized array types. These are physically laid out just the same
425 * as regular arrays (so that the regular array subscripting code works
426 * with them). They exist as distinct types mostly for historical reasons:
427 * they have nonstandard I/O behavior which we don't want to change for fear
428 * of breaking applications that look at the system catalogs. There is also
429 * an implementation issue for oidvector: it's part of the primary key for
430 * pg_proc, and we can't use the normal btree array support routines for that
431 * without circularity.
435 int32 size; /* these fields must match ArrayType! */
436 int ndim; /* always 1 for int2vector */
437 int32 dataoffset; /* always 0 for int2vector */
441 int2 values[1]; /* VARIABLE LENGTH ARRAY */
442 } int2vector; /* VARIABLE LENGTH STRUCT */
446 int32 size; /* these fields must match ArrayType! */
447 int ndim; /* always 1 for oidvector */
448 int32 dataoffset; /* always 0 for oidvector */
452 Oid values[1]; /* VARIABLE LENGTH ARRAY */
453 } oidvector; /* VARIABLE LENGTH STRUCT */
456 * We want NameData to have length NAMEDATALEN and int alignment,
457 * because that's how the data type 'name' is defined in pg_type.
458 * Use a union to make sure the compiler agrees. Note that NAMEDATALEN
459 * must be a multiple of sizeof(int), else sizeof(NameData) will probably
460 * not come out equal to NAMEDATALEN.
462 typedef union nameData
464 char data[NAMEDATALEN];
467 typedef NameData *Name;
469 #define NameStr(name) ((name).data)
472 * Support macros for escaping strings. escape_backslash should be TRUE
473 * if generating a non-standard-conforming string. Prefixing a string
474 * with ESCAPE_STRING_SYNTAX guarantees it is non-standard-conforming.
475 * Beware of multiple evaluation of the "ch" argument!
477 #define SQL_STR_DOUBLE(ch, escape_backslash) \
478 ((ch) == '\'' || ((ch) == '\\' && (escape_backslash)))
480 #define ESCAPE_STRING_SYNTAX 'E'
482 /* ----------------------------------------------------------------
483 * Section 4: IsValid macros for system types
484 * ----------------------------------------------------------------
488 * True iff bool is valid.
490 #define BoolIsValid(boolean) ((boolean) == false || (boolean) == true)
494 * True iff pointer is valid.
496 #define PointerIsValid(pointer) ((void*)(pointer) != NULL)
500 * True iff pointer is properly aligned to point to the given type.
502 #define PointerIsAligned(pointer, type) \
503 (((long)(pointer) % (sizeof (type))) == 0)
505 #define OidIsValid(objectId) ((bool) ((objectId) != InvalidOid))
507 #define RegProcedureIsValid(p) OidIsValid(p)
510 /* ----------------------------------------------------------------
511 * Section 5: offsetof, lengthof, endof, alignment
512 * ----------------------------------------------------------------
516 * Offset of a structure/union field within that structure/union.
518 * XXX This is supposed to be part of stddef.h, but isn't on
519 * some systems (like SunOS 4).
522 #define offsetof(type, field) ((long) &((type *)0)->field)
523 #endif /* offsetof */
527 * Number of elements in an array.
529 #define lengthof(array) (sizeof (array) / sizeof ((array)[0]))
533 * Address of the element one past the last in an array.
535 #define endof(array) (&(array)[lengthof(array)])
538 * Alignment macros: align a length or address appropriately for a given type.
540 * There used to be some incredibly crufty platform-dependent hackery here,
541 * but now we rely on the configure script to get the info for us. Much nicer.
543 * NOTE: TYPEALIGN will not work if ALIGNVAL is not a power of 2.
544 * That case seems extremely unlikely to occur in practice, however.
548 #define TYPEALIGN(ALIGNVAL,LEN) \
549 (((long) (LEN) + ((ALIGNVAL) - 1)) & ~((long) ((ALIGNVAL) - 1)))
551 #define SHORTALIGN(LEN) TYPEALIGN(ALIGNOF_SHORT, (LEN))
552 #define INTALIGN(LEN) TYPEALIGN(ALIGNOF_INT, (LEN))
553 #define LONGALIGN(LEN) TYPEALIGN(ALIGNOF_LONG, (LEN))
554 #define DOUBLEALIGN(LEN) TYPEALIGN(ALIGNOF_DOUBLE, (LEN))
555 #define MAXALIGN(LEN) TYPEALIGN(MAXIMUM_ALIGNOF, (LEN))
556 /* MAXALIGN covers only built-in types, not buffers */
557 #define BUFFERALIGN(LEN) TYPEALIGN(ALIGNOF_BUFFER, (LEN))
560 /* ----------------------------------------------------------------
561 * Section 6: widely useful macros
562 * ----------------------------------------------------------------
566 * Return the maximum of two numbers.
568 #define Max(x, y) ((x) > (y) ? (x) : (y))
572 * Return the minimum of two numbers.
574 #define Min(x, y) ((x) < (y) ? (x) : (y))
578 * Return the absolute value of the argument.
580 #define Abs(x) ((x) >= 0 ? (x) : -(x))
584 * Like standard library function strncpy(), except that result string
585 * is guaranteed to be null-terminated --- that is, at most N-1 bytes
586 * of the source string will be kept.
587 * Also, the macro returns no result (too hard to do that without
588 * evaluating the arguments multiple times, which seems worse).
590 * BTW: when you need to copy a non-null-terminated string (like a text
591 * datum) and add a null, do not do it with StrNCpy(..., len+1). That
592 * might seem to work, but it fetches one byte more than there is in the
593 * text object. One fine day you'll have a SIGSEGV because there isn't
594 * another byte before the end of memory. Don't laugh, we've had real
595 * live bug reports from real live users over exactly this mistake.
596 * Do it honestly with "memcpy(dst,src,len); dst[len] = '\0';", instead.
598 #define StrNCpy(dst,src,len) \
601 char * _dst = (dst); \
606 strncpy(_dst, (src), _len); \
607 _dst[_len-1] = '\0'; \
612 /* Get a bit mask of the bits set in non-long aligned addresses */
613 #define LONG_ALIGN_MASK (sizeof(long) - 1)
617 * Exactly the same as standard library function memset(), but considerably
618 * faster for zeroing small word-aligned structures (such as parsetree nodes).
619 * This has to be a macro because the main point is to avoid function-call
620 * overhead. However, we have also found that the loop is faster than
621 * native libc memset() on some platforms, even those with assembler
622 * memset() functions. More research needs to be done, perhaps with
623 * MEMSET_LOOP_LIMIT tests in configure.
625 #define MemSet(start, val, len) \
628 /* must be void* because we don't know if it is integer aligned yet */ \
629 void *_vstart = (void *) (start); \
633 if ((((long) _vstart) & LONG_ALIGN_MASK) == 0 && \
634 (_len & LONG_ALIGN_MASK) == 0 && \
636 _len <= MEMSET_LOOP_LIMIT && \
638 * If MEMSET_LOOP_LIMIT == 0, optimizer should find \
639 * the whole "if" false at compile time. \
641 MEMSET_LOOP_LIMIT != 0) \
643 long *_start = (long *) _vstart; \
644 long *_stop = (long *) ((char *) _start + _len); \
645 while (_start < _stop) \
649 memset(_vstart, _val, _len); \
653 * MemSetAligned is the same as MemSet except it omits the test to see if
654 * "start" is word-aligned. This is okay to use if the caller knows a-priori
655 * that the pointer is suitably aligned (typically, because he just got it
656 * from palloc(), which always delivers a max-aligned pointer).
658 #define MemSetAligned(start, val, len) \
661 long *_start = (long *) (start); \
665 if ((_len & LONG_ALIGN_MASK) == 0 && \
667 _len <= MEMSET_LOOP_LIMIT && \
668 MEMSET_LOOP_LIMIT != 0) \
670 long *_stop = (long *) ((char *) _start + _len); \
671 while (_start < _stop) \
675 memset(_start, _val, _len); \
680 * MemSetTest/MemSetLoop are a variant version that allow all the tests in
681 * MemSet to be done at compile time in cases where "val" and "len" are
682 * constants *and* we know the "start" pointer must be word-aligned.
683 * If MemSetTest succeeds, then it is okay to use MemSetLoop, otherwise use
684 * MemSetAligned. Beware of multiple evaluations of the arguments when using
687 #define MemSetTest(val, len) \
688 ( ((len) & LONG_ALIGN_MASK) == 0 && \
689 (len) <= MEMSET_LOOP_LIMIT && \
690 MEMSET_LOOP_LIMIT != 0 && \
693 #define MemSetLoop(start, val, len) \
696 long * _start = (long *) (start); \
697 long * _stop = (long *) ((char *) _start + (Size) (len)); \
699 while (_start < _stop) \
704 /* ----------------------------------------------------------------
705 * Section 7: random stuff
706 * ----------------------------------------------------------------
710 #define HIGHBIT (0x80)
711 #define IS_HIGHBIT_SET(ch) ((unsigned char)(ch) & HIGHBIT)
713 #define STATUS_OK (0)
714 #define STATUS_ERROR (-1)
715 #define STATUS_EOF (-2)
716 #define STATUS_FOUND (1)
717 #define STATUS_WAITING (2)
720 /* ----------------------------------------------------------------
721 * Section 8: system-specific hacks
723 * This should be limited to things that absolutely have to be
724 * included in every source file. The port-specific header file
725 * is usually a better place for this sort of thing.
726 * ----------------------------------------------------------------
730 * NOTE: this is also used for opening text files.
731 * WIN32 treats Control-Z as EOF in files opened in text mode.
732 * Therefore, we open files in binary mode on Win32 so we can read
733 * literal control-Z. The other affect is that we see CRLF, but
734 * that is OK because we can already handle those cleanly.
736 #if defined(WIN32) || defined(__CYGWIN__)
737 #define PG_BINARY O_BINARY
738 #define PG_BINARY_R "rb"
739 #define PG_BINARY_W "wb"
742 #define PG_BINARY_R "r"
743 #define PG_BINARY_W "w"
746 #if defined(sun) && defined(__sparc__) && !defined(__SVR4)
750 /* These are for things that are one way on Unix and another on NT */
751 #define NULL_DEV "/dev/null"
754 * Provide prototypes for routines not present in a particular machine's
755 * standard C library.
758 #if !HAVE_DECL_SNPRINTF
760 snprintf(char *str, size_t count, const char *fmt,...)
761 /* This extension allows gcc to check the format string */
762 __attribute__((format(printf, 3, 4)));
765 #if !HAVE_DECL_VSNPRINTF
766 extern int vsnprintf(char *str, size_t count, const char *fmt, va_list args);
769 #if !defined(HAVE_MEMMOVE) && !defined(memmove)
770 #define memmove(d, s, c) bcopy(s, d, c)
774 #define DLLIMPORT /* no special DLL markers on most ports */
778 * The following is used as the arg list for signal handlers. Any ports
779 * that take something other than an int argument should override this in
780 * their pg_config_os.h file. Note that variable names are required
781 * because it is used in both the prototypes as well as the definitions.
782 * Note also the long name. We expect that this won't collide with
783 * other names causing compiler warnings.
787 #define SIGNAL_ARGS int postgres_signal_arg
791 * When there is no sigsetjmp, its functionality is provided by plain
792 * setjmp. Incidentally, nothing provides setjmp's functionality in
795 #ifndef HAVE_SIGSETJMP
796 #define sigjmp_buf jmp_buf
797 #define sigsetjmp(x,y) setjmp(x)
798 #define siglongjmp longjmp
801 #if defined(HAVE_FDATASYNC) && !HAVE_DECL_FDATASYNC
802 extern int fdatasync(int fildes);
805 /* If strtoq() exists, rename it to the more standard strtoll() */
806 #if defined(HAVE_LONG_LONG_INT_64) && !defined(HAVE_STRTOLL) && defined(HAVE_STRTOQ)
807 #define strtoll strtoq
808 #define HAVE_STRTOLL 1
811 /* If strtouq() exists, rename it to the more standard strtoull() */
812 #if defined(HAVE_LONG_LONG_INT_64) && !defined(HAVE_STRTOULL) && defined(HAVE_STRTOUQ)
813 #define strtoull strtouq
814 #define HAVE_STRTOULL 1
817 /* EXEC_BACKEND defines */
819 #define NON_EXEC_STATIC
821 #define NON_EXEC_STATIC static
824 /* /port compatibility functions */