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

   1 /*-------------------------------------------------------------------------
   2  *
   3  * varbit.h
   4  *        Functions for the SQL datatypes BIT() and BIT VARYING().
   5  *
   6  * Code originally contributed by Adriaan Joubert.
   7  *
   8  * Portions Copyright (c) 1996-2014, PostgreSQL Global Development Group
   9  * Portions Copyright (c) 1994, Regents of the University of California
  10  *
  11  * src/include/utils/varbit.h
  12  *
  13  *-------------------------------------------------------------------------
  14  */
  15 #ifndef VARBIT_H
  16 #define VARBIT_H
  17
  18 #include <limits.h>
  19
  20 #include "fmgr.h"
  21
  22 /*
  23  * Modeled on struct varlena from postgres.h, but data type is bits8.
  24  */
  25 typedef struct
  26 {
  27         int32           vl_len_;                /* varlena header (do not touch directly!) */
  28         int32           bit_len;                /* number of valid bits */
  29         bits8           bit_dat[1];             /* bit string, most sig. byte first */
  30 } VarBit;
  31
  32 /*
  33  * fmgr interface macros
  34  *
  35  * BIT and BIT VARYING are toastable varlena types.  They are the same
  36  * as far as representation goes, so we just have one set of macros.
  37  */
  38 #define DatumGetVarBitP(X)                 ((VarBit *) PG_DETOAST_DATUM(X))
  39 #define DatumGetVarBitPCopy(X)     ((VarBit *) PG_DETOAST_DATUM_COPY(X))
  40 #define VarBitPGetDatum(X)                 PointerGetDatum(X)
  41 #define PG_GETARG_VARBIT_P(n)      DatumGetVarBitP(PG_GETARG_DATUM(n))
  42 #define PG_GETARG_VARBIT_P_COPY(n) DatumGetVarBitPCopy(PG_GETARG_DATUM(n))
  43 #define PG_RETURN_VARBIT_P(x)      return VarBitPGetDatum(x)
  44
  45 /* Header overhead *in addition to* VARHDRSZ */
  46 #define VARBITHDRSZ                     sizeof(int32)
  47 /* Number of bits in this bit string */
  48 #define VARBITLEN(PTR)          (((VarBit *) (PTR))->bit_len)
  49 /* Pointer to the first byte containing bit string data */
  50 #define VARBITS(PTR)            (((VarBit *) (PTR))->bit_dat)
  51 /* Number of bytes in the data section of a bit string */
  52 #define VARBITBYTES(PTR)        (VARSIZE(PTR) - VARHDRSZ - VARBITHDRSZ)
  53 /* Padding of the bit string at the end (in bits) */
  54 #define VARBITPAD(PTR)          (VARBITBYTES(PTR)*BITS_PER_BYTE - VARBITLEN(PTR))
  55 /* Number of bytes needed to store a bit string of a given length */
  56 #define VARBITTOTALLEN(BITLEN)  (((BITLEN) + BITS_PER_BYTE-1)/BITS_PER_BYTE + \
  57                                                                  VARHDRSZ + VARBITHDRSZ)
  58 /*
  59  * Maximum number of bits.  Several code sites assume no overflow from
  60  * computing bitlen + X; VARBITTOTALLEN() has the largest such X.
  61  */
  62 #define VARBITMAXLEN            (INT_MAX - BITS_PER_BYTE + 1)
  63 /* pointer beyond the end of the bit string (like end() in STL containers) */
  64 #define VARBITEND(PTR)          (((bits8 *) (PTR)) + VARSIZE(PTR))
  65 /* Mask that will cover exactly one byte, i.e. BITS_PER_BYTE bits */
  66 #define BITMASK 0xFF
  67
  68
  69 extern Datum bit_in(PG_FUNCTION_ARGS);
  70 extern Datum bit_out(PG_FUNCTION_ARGS);
  71 extern Datum bit_recv(PG_FUNCTION_ARGS);
  72 extern Datum bit_send(PG_FUNCTION_ARGS);
  73 extern Datum bittypmodin(PG_FUNCTION_ARGS);
  74 extern Datum bittypmodout(PG_FUNCTION_ARGS);
  75 extern Datum varbit_in(PG_FUNCTION_ARGS);
  76 extern Datum varbit_out(PG_FUNCTION_ARGS);
  77 extern Datum varbit_recv(PG_FUNCTION_ARGS);
  78 extern Datum varbit_send(PG_FUNCTION_ARGS);
  79 extern Datum varbittypmodin(PG_FUNCTION_ARGS);
  80 extern Datum varbittypmodout(PG_FUNCTION_ARGS);
  81 extern Datum bit(PG_FUNCTION_ARGS);
  82 extern Datum varbit_transform(PG_FUNCTION_ARGS);
  83 extern Datum varbit(PG_FUNCTION_ARGS);
  84 extern Datum biteq(PG_FUNCTION_ARGS);
  85 extern Datum bitne(PG_FUNCTION_ARGS);
  86 extern Datum bitlt(PG_FUNCTION_ARGS);
  87 extern Datum bitle(PG_FUNCTION_ARGS);
  88 extern Datum bitgt(PG_FUNCTION_ARGS);
  89 extern Datum bitge(PG_FUNCTION_ARGS);
  90 extern Datum bitcmp(PG_FUNCTION_ARGS);
  91
  92 /* avoid the names bitand and bitor, since they are C++ keywords */
  93 extern Datum bit_and(PG_FUNCTION_ARGS);
  94 extern Datum bit_or(PG_FUNCTION_ARGS);
  95 extern Datum bitxor(PG_FUNCTION_ARGS);
  96 extern Datum bitnot(PG_FUNCTION_ARGS);
  97 extern Datum bitshiftleft(PG_FUNCTION_ARGS);
  98 extern Datum bitshiftright(PG_FUNCTION_ARGS);
  99 extern Datum bitcat(PG_FUNCTION_ARGS);
 100 extern Datum bitsubstr(PG_FUNCTION_ARGS);
 101 extern Datum bitsubstr_no_len(PG_FUNCTION_ARGS);
 102 extern Datum bitoverlay(PG_FUNCTION_ARGS);
 103 extern Datum bitoverlay_no_len(PG_FUNCTION_ARGS);
 104 extern Datum bitlength(PG_FUNCTION_ARGS);
 105 extern Datum bitoctetlength(PG_FUNCTION_ARGS);
 106 extern Datum bitfromint4(PG_FUNCTION_ARGS);
 107 extern Datum bittoint4(PG_FUNCTION_ARGS);
 108 extern Datum bitfromint8(PG_FUNCTION_ARGS);
 109 extern Datum bittoint8(PG_FUNCTION_ARGS);
 110 extern Datum bitposition(PG_FUNCTION_ARGS);
 111 extern Datum bitsetbit(PG_FUNCTION_ARGS);
 112 extern Datum bitgetbit(PG_FUNCTION_ARGS);
 113
 114 #endif