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

   1 /*-------------------------------------------------------------------------
   2  *
   3  * htup_details.h
   4  *        POSTGRES heap tuple header definitions.
   5  *
   6  *
   7  * Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group
   8  * Portions Copyright (c) 1994, Regents of the University of California
   9  *
  10  * src/include/access/htup_details.h
  11  *
  12  *-------------------------------------------------------------------------
  13  */
  14 #ifndef HTUP_DETAILS_H
  15 #define HTUP_DETAILS_H
  16
  17 #include "access/htup.h"
  18 #include "access/tupdesc.h"
  19 #include "access/tupmacs.h"
  20 #include "access/transam.h"
  21 #include "storage/bufpage.h"
  22
  23 /*
  24  * MaxTupleAttributeNumber limits the number of (user) columns in a tuple.
  25  * The key limit on this value is that the size of the fixed overhead for
  26  * a tuple, plus the size of the null-values bitmap (at 1 bit per column),
  27  * plus MAXALIGN alignment, must fit into t_hoff which is uint8.  On most
  28  * machines the upper limit without making t_hoff wider would be a little
  29  * over 1700.  We use round numbers here and for MaxHeapAttributeNumber
  30  * so that alterations in HeapTupleHeaderData layout won't change the
  31  * supported max number of columns.
  32  */
  33 #define MaxTupleAttributeNumber 1664    /* 8 * 208 */
  34
  35 /*
  36  * MaxHeapAttributeNumber limits the number of (user) columns in a table.
  37  * This should be somewhat less than MaxTupleAttributeNumber.  It must be
  38  * at least one less, else we will fail to do UPDATEs on a maximal-width
  39  * table (because UPDATE has to form working tuples that include CTID).
  40  * In practice we want some additional daylight so that we can gracefully
  41  * support operations that add hidden "resjunk" columns, for example
  42  * SELECT * FROM wide_table ORDER BY foo, bar, baz.
  43  * In any case, depending on column data types you will likely be running
  44  * into the disk-block-based limit on overall tuple size if you have more
  45  * than a thousand or so columns.  TOAST won't help.
  46  */
  47 #define MaxHeapAttributeNumber  1600    /* 8 * 200 */
  48
  49 /*
  50  * Heap tuple header.  To avoid wasting space, the fields should be
  51  * laid out in such a way as to avoid structure padding.
  52  *
  53  * Datums of composite types (row types) share the same general structure
  54  * as on-disk tuples, so that the same routines can be used to build and
  55  * examine them.  However the requirements are slightly different: a Datum
  56  * does not need any transaction visibility information, and it does need
  57  * a length word and some embedded type information.  We can achieve this
  58  * by overlaying the xmin/cmin/xmax/cmax/xvac fields of a heap tuple
  59  * with the fields needed in the Datum case.  Typically, all tuples built
  60  * in-memory will be initialized with the Datum fields; but when a tuple is
  61  * about to be inserted in a table, the transaction fields will be filled,
  62  * overwriting the datum fields.
  63  *
  64  * The overall structure of a heap tuple looks like:
  65  *                      fixed fields (HeapTupleHeaderData struct)
  66  *                      nulls bitmap (if HEAP_HASNULL is set in t_infomask)
  67  *                      alignment padding (as needed to make user data MAXALIGN'd)
  68  *                      object ID (if HEAP_HASOID is set in t_infomask)
  69  *                      user data fields
  70  *
  71  * We store five "virtual" fields Xmin, Cmin, Xmax, Cmax, and Xvac in three
  72  * physical fields.  Xmin and Xmax are always really stored, but Cmin, Cmax
  73  * and Xvac share a field.  This works because we know that Cmin and Cmax
  74  * are only interesting for the lifetime of the inserting and deleting
  75  * transaction respectively.  If a tuple is inserted and deleted in the same
  76  * transaction, we store a "combo" command id that can be mapped to the real
  77  * cmin and cmax, but only by use of local state within the originating
  78  * backend.  See combocid.c for more details.  Meanwhile, Xvac is only set by
  79  * old-style VACUUM FULL, which does not have any command sub-structure and so
  80  * does not need either Cmin or Cmax.  (This requires that old-style VACUUM
  81  * FULL never try to move a tuple whose Cmin or Cmax is still interesting,
  82  * ie, an insert-in-progress or delete-in-progress tuple.)
  83  *
  84  * A word about t_ctid: whenever a new tuple is stored on disk, its t_ctid
  85  * is initialized with its own TID (location).  If the tuple is ever updated,
  86  * its t_ctid is changed to point to the replacement version of the tuple.
  87  * Thus, a tuple is the latest version of its row iff XMAX is invalid or
  88  * t_ctid points to itself (in which case, if XMAX is valid, the tuple is
  89  * either locked or deleted).  One can follow the chain of t_ctid links
  90  * to find the newest version of the row.  Beware however that VACUUM might
  91  * erase the pointed-to (newer) tuple before erasing the pointing (older)
  92  * tuple.  Hence, when following a t_ctid link, it is necessary to check
  93  * to see if the referenced slot is empty or contains an unrelated tuple.
  94  * Check that the referenced tuple has XMIN equal to the referencing tuple's
  95  * XMAX to verify that it is actually the descendant version and not an
  96  * unrelated tuple stored into a slot recently freed by VACUUM.  If either
  97  * check fails, one may assume that there is no live descendant version.
  98  *
  99  * t_ctid is sometimes used to store a speculative insertion token, instead
 100  * of a real TID.  A speculative token is set on a tuple that's being
 101  * inserted, until the inserter is sure that it wants to go ahead with the
 102  * insertion.  Hence a token should only be seen on a tuple with an XMAX
 103  * that's still in-progress, or invalid/aborted.  The token is replaced with
 104  * the tuple's real TID when the insertion is confirmed.  One should never
 105  * see a speculative insertion token while following a chain of t_ctid links,
 106  * because they are not used on updates, only insertions.
 107  *
 108  * Following the fixed header fields, the nulls bitmap is stored (beginning
 109  * at t_bits).  The bitmap is *not* stored if t_infomask shows that there
 110  * are no nulls in the tuple.  If an OID field is present (as indicated by
 111  * t_infomask), then it is stored just before the user data, which begins at
 112  * the offset shown by t_hoff.  Note that t_hoff must be a multiple of
 113  * MAXALIGN.
 114  */
 115
 116 typedef struct HeapTupleFields
 117 {
 118         TransactionId t_xmin;           /* inserting xact ID */
 119         TransactionId t_xmax;           /* deleting or locking xact ID */
 120
 121         union
 122         {
 123                 CommandId       t_cid;          /* inserting or deleting command ID, or both */
 124                 TransactionId t_xvac;   /* old-style VACUUM FULL xact ID */
 125         }                       t_field3;
 126 } HeapTupleFields;
 127
 128 typedef struct DatumTupleFields
 129 {
 130         int32           datum_len_;             /* varlena header (do not touch directly!) */
 131
 132         int32           datum_typmod;   /* -1, or identifier of a record type */
 133
 134         Oid                     datum_typeid;   /* composite type OID, or RECORDOID */
 135
 136         /*
 137          * datum_typeid cannot be a domain over composite, only plain composite,
 138          * even if the datum is meant as a value of a domain-over-composite type.
 139          * This is in line with the general principle that CoerceToDomain does not
 140          * change the physical representation of the base type value.
 141          *
 142          * Note: field ordering is chosen with thought that Oid might someday
 143          * widen to 64 bits.
 144          */
 145 } DatumTupleFields;
 146
 147 struct HeapTupleHeaderData
 148 {
 149         union
 150         {
 151                 HeapTupleFields t_heap;
 152                 DatumTupleFields t_datum;
 153         }                       t_choice;
 154
 155         ItemPointerData t_ctid;         /* current TID of this or newer tuple (or a
 156                                                                  * speculative insertion token) */
 157
 158         /* Fields below here must match MinimalTupleData! */
 159
 160 #define FIELDNO_HEAPTUPLEHEADERDATA_INFOMASK2 2
 161         uint16          t_infomask2;    /* number of attributes + various flags */
 162
 163 #define FIELDNO_HEAPTUPLEHEADERDATA_INFOMASK 3
 164         uint16          t_infomask;             /* various flag bits, see below */
 165
 166 #define FIELDNO_HEAPTUPLEHEADERDATA_HOFF 4
 167         uint8           t_hoff;                 /* sizeof header incl. bitmap, padding */
 168
 169         /* ^ - 23 bytes - ^ */
 170
 171 #define FIELDNO_HEAPTUPLEHEADERDATA_BITS 5
 172         bits8           t_bits[FLEXIBLE_ARRAY_MEMBER];  /* bitmap of NULLs */
 173
 174         /* MORE DATA FOLLOWS AT END OF STRUCT */
 175 };
 176
 177 /* typedef appears in htup.h */
 178
 179 #define SizeofHeapTupleHeader offsetof(HeapTupleHeaderData, t_bits)
 180
 181 /*
 182  * information stored in t_infomask:
 183  */
 184 #define HEAP_HASNULL                    0x0001  /* has null attribute(s) */
 185 #define HEAP_HASVARWIDTH                0x0002  /* has variable-width attribute(s) */
 186 #define HEAP_HASEXTERNAL                0x0004  /* has external stored attribute(s) */
 187 #define HEAP_HASOID                             0x0008  /* has an object-id field */
 188 #define HEAP_XMAX_KEYSHR_LOCK   0x0010  /* xmax is a key-shared locker */
 189 #define HEAP_COMBOCID                   0x0020  /* t_cid is a combo cid */
 190 #define HEAP_XMAX_EXCL_LOCK             0x0040  /* xmax is exclusive locker */
 191 #define HEAP_XMAX_LOCK_ONLY             0x0080  /* xmax, if valid, is only a locker */
 192
 193  /* xmax is a shared locker */
 194 #define HEAP_XMAX_SHR_LOCK      (HEAP_XMAX_EXCL_LOCK | HEAP_XMAX_KEYSHR_LOCK)
 195
 196 #define HEAP_LOCK_MASK  (HEAP_XMAX_SHR_LOCK | HEAP_XMAX_EXCL_LOCK | \
 197                                                  HEAP_XMAX_KEYSHR_LOCK)
 198 #define HEAP_XMIN_COMMITTED             0x0100  /* t_xmin committed */
 199 #define HEAP_XMIN_INVALID               0x0200  /* t_xmin invalid/aborted */
 200 #define HEAP_XMIN_FROZEN                (HEAP_XMIN_COMMITTED|HEAP_XMIN_INVALID)
 201 #define HEAP_XMAX_COMMITTED             0x0400  /* t_xmax committed */
 202 #define HEAP_XMAX_INVALID               0x0800  /* t_xmax invalid/aborted */
 203 #define HEAP_XMAX_IS_MULTI              0x1000  /* t_xmax is a MultiXactId */
 204 #define HEAP_UPDATED                    0x2000  /* this is UPDATEd version of row */
 205 #define HEAP_MOVED_OFF                  0x4000  /* moved to another place by pre-9.0
 206                                                                                  * VACUUM FULL; kept for binary
 207                                                                                  * upgrade support */
 208 #define HEAP_MOVED_IN                   0x8000  /* moved from another place by pre-9.0
 209                                                                                  * VACUUM FULL; kept for binary
 210                                                                                  * upgrade support */
 211 #define HEAP_MOVED (HEAP_MOVED_OFF | HEAP_MOVED_IN)
 212
 213 #define HEAP_XACT_MASK                  0xFFF0  /* visibility-related bits */
 214
 215 /*
 216  * A tuple is only locked (i.e. not updated by its Xmax) if the
 217  * HEAP_XMAX_LOCK_ONLY bit is set; or, for pg_upgrade's sake, if the Xmax is
 218  * not a multi and the EXCL_LOCK bit is set.
 219  *
 220  * See also HeapTupleHeaderIsOnlyLocked, which also checks for a possible
 221  * aborted updater transaction.
 222  *
 223  * Beware of multiple evaluations of the argument.
 224  */
 225 #define HEAP_XMAX_IS_LOCKED_ONLY(infomask) \
 226         (((infomask) & HEAP_XMAX_LOCK_ONLY) || \
 227          (((infomask) & (HEAP_XMAX_IS_MULTI | HEAP_LOCK_MASK)) == HEAP_XMAX_EXCL_LOCK))
 228
 229 /*
 230  * A tuple that has HEAP_XMAX_IS_MULTI and HEAP_XMAX_LOCK_ONLY but neither of
 231  * XMAX_EXCL_LOCK and XMAX_KEYSHR_LOCK must come from a tuple that was
 232  * share-locked in 9.2 or earlier and then pg_upgrade'd.
 233  *
 234  * In 9.2 and prior, HEAP_XMAX_IS_MULTI was only set when there were multiple
 235  * FOR SHARE lockers of that tuple.  That set HEAP_XMAX_LOCK_ONLY (with a
 236  * different name back then) but neither of HEAP_XMAX_EXCL_LOCK and
 237  * HEAP_XMAX_KEYSHR_LOCK.  That combination is no longer possible in 9.3 and
 238  * up, so if we see that combination we know for certain that the tuple was
 239  * locked in an earlier release; since all such lockers are gone (they cannot
 240  * survive through pg_upgrade), such tuples can safely be considered not
 241  * locked.
 242  *
 243  * We must not resolve such multixacts locally, because the result would be
 244  * bogus, regardless of where they stand with respect to the current valid
 245  * multixact range.
 246  */
 247 #define HEAP_LOCKED_UPGRADED(infomask) \
 248 ( \
 249          ((infomask) & HEAP_XMAX_IS_MULTI) != 0 && \
 250          ((infomask) & HEAP_XMAX_LOCK_ONLY) != 0 && \
 251          (((infomask) & (HEAP_XMAX_EXCL_LOCK | HEAP_XMAX_KEYSHR_LOCK)) == 0) \
 252 )
 253
 254 /*
 255  * Use these to test whether a particular lock is applied to a tuple
 256  */
 257 #define HEAP_XMAX_IS_SHR_LOCKED(infomask) \
 258         (((infomask) & HEAP_LOCK_MASK) == HEAP_XMAX_SHR_LOCK)
 259 #define HEAP_XMAX_IS_EXCL_LOCKED(infomask) \
 260         (((infomask) & HEAP_LOCK_MASK) == HEAP_XMAX_EXCL_LOCK)
 261 #define HEAP_XMAX_IS_KEYSHR_LOCKED(infomask) \
 262         (((infomask) & HEAP_LOCK_MASK) == HEAP_XMAX_KEYSHR_LOCK)
 263
 264 /* turn these all off when Xmax is to change */
 265 #define HEAP_XMAX_BITS (HEAP_XMAX_COMMITTED | HEAP_XMAX_INVALID | \
 266                                                 HEAP_XMAX_IS_MULTI | HEAP_LOCK_MASK | HEAP_XMAX_LOCK_ONLY)
 267
 268 /*
 269  * information stored in t_infomask2:
 270  */
 271 #define HEAP_NATTS_MASK                 0x07FF  /* 11 bits for number of attributes */
 272 /* bits 0x1800 are available */
 273 #define HEAP_KEYS_UPDATED               0x2000  /* tuple was updated and key cols
 274                                                                                  * modified, or tuple deleted */
 275 #define HEAP_HOT_UPDATED                0x4000  /* tuple was HOT-updated */
 276 #define HEAP_ONLY_TUPLE                 0x8000  /* this is heap-only tuple */
 277
 278 #define HEAP2_XACT_MASK                 0xE000  /* visibility-related bits */
 279
 280 /*
 281  * HEAP_TUPLE_HAS_MATCH is a temporary flag used during hash joins.  It is
 282  * only used in tuples that are in the hash table, and those don't need
 283  * any visibility information, so we can overlay it on a visibility flag
 284  * instead of using up a dedicated bit.
 285  */
 286 #define HEAP_TUPLE_HAS_MATCH    HEAP_ONLY_TUPLE /* tuple has a join match */
 287
 288 /*
 289  * Special value used in t_ctid.ip_posid, to indicate that it holds a
 290  * speculative insertion token rather than a real TID.  This must be higher
 291  * than MaxOffsetNumber, so that it can be distinguished from a valid
 292  * offset number in a regular item pointer.
 293  */
 294 #define SpecTokenOffsetNumber           0xfffe
 295
 296 /*
 297  * HeapTupleHeader accessor macros
 298  *
 299  * Note: beware of multiple evaluations of "tup" argument.  But the Set
 300  * macros evaluate their other argument only once.
 301  */
 302
 303 /*
 304  * HeapTupleHeaderGetRawXmin returns the "raw" xmin field, which is the xid
 305  * originally used to insert the tuple.  However, the tuple might actually
 306  * be frozen (via HeapTupleHeaderSetXminFrozen) in which case the tuple's xmin
 307  * is visible to every snapshot.  Prior to PostgreSQL 9.4, we actually changed
 308  * the xmin to FrozenTransactionId, and that value may still be encountered
 309  * on disk.
 310  */
 311 #define HeapTupleHeaderGetRawXmin(tup) \
 312 ( \
 313         (tup)->t_choice.t_heap.t_xmin \
 314 )
 315
 316 #define HeapTupleHeaderGetXmin(tup) \
 317 ( \
 318         HeapTupleHeaderXminFrozen(tup) ? \
 319                 FrozenTransactionId : HeapTupleHeaderGetRawXmin(tup) \
 320 )
 321
 322 #define HeapTupleHeaderSetXmin(tup, xid) \
 323 ( \
 324         (tup)->t_choice.t_heap.t_xmin = (xid) \
 325 )
 326
 327 #define HeapTupleHeaderXminCommitted(tup) \
 328 ( \
 329         ((tup)->t_infomask & HEAP_XMIN_COMMITTED) != 0 \
 330 )
 331
 332 #define HeapTupleHeaderXminInvalid(tup) \
 333 ( \
 334         ((tup)->t_infomask & (HEAP_XMIN_COMMITTED|HEAP_XMIN_INVALID)) == \
 335                 HEAP_XMIN_INVALID \
 336 )
 337
 338 #define HeapTupleHeaderXminFrozen(tup) \
 339 ( \
 340         ((tup)->t_infomask & (HEAP_XMIN_FROZEN)) == HEAP_XMIN_FROZEN \
 341 )
 342
 343 #define HeapTupleHeaderSetXminCommitted(tup) \
 344 ( \
 345         AssertMacro(!HeapTupleHeaderXminInvalid(tup)), \
 346         ((tup)->t_infomask |= HEAP_XMIN_COMMITTED) \
 347 )
 348
 349 #define HeapTupleHeaderSetXminInvalid(tup) \
 350 ( \
 351         AssertMacro(!HeapTupleHeaderXminCommitted(tup)), \
 352         ((tup)->t_infomask |= HEAP_XMIN_INVALID) \
 353 )
 354
 355 #define HeapTupleHeaderSetXminFrozen(tup) \
 356 ( \
 357         AssertMacro(!HeapTupleHeaderXminInvalid(tup)), \
 358         ((tup)->t_infomask |= HEAP_XMIN_FROZEN) \
 359 )
 360
 361 /*
 362  * HeapTupleHeaderGetRawXmax gets you the raw Xmax field.  To find out the Xid
 363  * that updated a tuple, you might need to resolve the MultiXactId if certain
 364  * bits are set.  HeapTupleHeaderGetUpdateXid checks those bits and takes care
 365  * to resolve the MultiXactId if necessary.  This might involve multixact I/O,
 366  * so it should only be used if absolutely necessary.
 367  */
 368 #define HeapTupleHeaderGetUpdateXid(tup) \
 369 ( \
 370         (!((tup)->t_infomask & HEAP_XMAX_INVALID) && \
 371          ((tup)->t_infomask & HEAP_XMAX_IS_MULTI) && \
 372          !((tup)->t_infomask & HEAP_XMAX_LOCK_ONLY)) ? \
 373                 HeapTupleGetUpdateXid(tup) \
 374         : \
 375                 HeapTupleHeaderGetRawXmax(tup) \
 376 )
 377
 378 #define HeapTupleHeaderGetRawXmax(tup) \
 379 ( \
 380         (tup)->t_choice.t_heap.t_xmax \
 381 )
 382
 383 #define HeapTupleHeaderSetXmax(tup, xid) \
 384 ( \
 385         (tup)->t_choice.t_heap.t_xmax = (xid) \
 386 )
 387
 388 /*
 389  * HeapTupleHeaderGetRawCommandId will give you what's in the header whether
 390  * it is useful or not.  Most code should use HeapTupleHeaderGetCmin or
 391  * HeapTupleHeaderGetCmax instead, but note that those Assert that you can
 392  * get a legitimate result, ie you are in the originating transaction!
 393  */
 394 #define HeapTupleHeaderGetRawCommandId(tup) \
 395 ( \
 396         (tup)->t_choice.t_heap.t_field3.t_cid \
 397 )
 398
 399 /* SetCmin is reasonably simple since we never need a combo CID */
 400 #define HeapTupleHeaderSetCmin(tup, cid) \
 401 do { \
 402         Assert(!((tup)->t_infomask & HEAP_MOVED)); \
 403         (tup)->t_choice.t_heap.t_field3.t_cid = (cid); \
 404         (tup)->t_infomask &= ~HEAP_COMBOCID; \
 405 } while (0)
 406
 407 /* SetCmax must be used after HeapTupleHeaderAdjustCmax; see combocid.c */
 408 #define HeapTupleHeaderSetCmax(tup, cid, iscombo) \
 409 do { \
 410         Assert(!((tup)->t_infomask & HEAP_MOVED)); \
 411         (tup)->t_choice.t_heap.t_field3.t_cid = (cid); \
 412         if (iscombo) \
 413                 (tup)->t_infomask |= HEAP_COMBOCID; \
 414         else \
 415                 (tup)->t_infomask &= ~HEAP_COMBOCID; \
 416 } while (0)
 417
 418 #define HeapTupleHeaderGetXvac(tup) \
 419 ( \
 420         ((tup)->t_infomask & HEAP_MOVED) ? \
 421                 (tup)->t_choice.t_heap.t_field3.t_xvac \
 422         : \
 423                 InvalidTransactionId \
 424 )
 425
 426 #define HeapTupleHeaderSetXvac(tup, xid) \
 427 do { \
 428         Assert((tup)->t_infomask & HEAP_MOVED); \
 429         (tup)->t_choice.t_heap.t_field3.t_xvac = (xid); \
 430 } while (0)
 431
 432 #define HeapTupleHeaderIsSpeculative(tup) \
 433 ( \
 434         (ItemPointerGetOffsetNumberNoCheck(&(tup)->t_ctid) == SpecTokenOffsetNumber) \
 435 )
 436
 437 #define HeapTupleHeaderGetSpeculativeToken(tup) \
 438 ( \
 439         AssertMacro(HeapTupleHeaderIsSpeculative(tup)), \
 440         ItemPointerGetBlockNumber(&(tup)->t_ctid) \
 441 )
 442
 443 #define HeapTupleHeaderSetSpeculativeToken(tup, token)  \
 444 ( \
 445         ItemPointerSet(&(tup)->t_ctid, token, SpecTokenOffsetNumber) \
 446 )
 447
 448 #define HeapTupleHeaderGetDatumLength(tup) \
 449         VARSIZE(tup)
 450
 451 #define HeapTupleHeaderSetDatumLength(tup, len) \
 452         SET_VARSIZE(tup, len)
 453
 454 #define HeapTupleHeaderGetTypeId(tup) \
 455 ( \
 456         (tup)->t_choice.t_datum.datum_typeid \
 457 )
 458
 459 #define HeapTupleHeaderSetTypeId(tup, typeid) \
 460 ( \
 461         (tup)->t_choice.t_datum.datum_typeid = (typeid) \
 462 )
 463
 464 #define HeapTupleHeaderGetTypMod(tup) \
 465 ( \
 466         (tup)->t_choice.t_datum.datum_typmod \
 467 )
 468
 469 #define HeapTupleHeaderSetTypMod(tup, typmod) \
 470 ( \
 471         (tup)->t_choice.t_datum.datum_typmod = (typmod) \
 472 )
 473
 474 #define HeapTupleHeaderGetOid(tup) \
 475 ( \
 476         ((tup)->t_infomask & HEAP_HASOID) ? \
 477                 *((Oid *) ((char *)(tup) + (tup)->t_hoff - sizeof(Oid))) \
 478         : \
 479                 InvalidOid \
 480 )
 481
 482 #define HeapTupleHeaderSetOid(tup, oid) \
 483 do { \
 484         Assert((tup)->t_infomask & HEAP_HASOID); \
 485         *((Oid *) ((char *)(tup) + (tup)->t_hoff - sizeof(Oid))) = (oid); \
 486 } while (0)
 487
 488 /*
 489  * Note that we stop considering a tuple HOT-updated as soon as it is known
 490  * aborted or the would-be updating transaction is known aborted.  For best
 491  * efficiency, check tuple visibility before using this macro, so that the
 492  * INVALID bits will be as up to date as possible.
 493  */
 494 #define HeapTupleHeaderIsHotUpdated(tup) \
 495 ( \
 496         ((tup)->t_infomask2 & HEAP_HOT_UPDATED) != 0 && \
 497         ((tup)->t_infomask & HEAP_XMAX_INVALID) == 0 && \
 498         !HeapTupleHeaderXminInvalid(tup) \
 499 )
 500
 501 #define HeapTupleHeaderSetHotUpdated(tup) \
 502 ( \
 503         (tup)->t_infomask2 |= HEAP_HOT_UPDATED \
 504 )
 505
 506 #define HeapTupleHeaderClearHotUpdated(tup) \
 507 ( \
 508         (tup)->t_infomask2 &= ~HEAP_HOT_UPDATED \
 509 )
 510
 511 #define HeapTupleHeaderIsHeapOnly(tup) \
 512 ( \
 513   ((tup)->t_infomask2 & HEAP_ONLY_TUPLE) != 0 \
 514 )
 515
 516 #define HeapTupleHeaderSetHeapOnly(tup) \
 517 ( \
 518   (tup)->t_infomask2 |= HEAP_ONLY_TUPLE \
 519 )
 520
 521 #define HeapTupleHeaderClearHeapOnly(tup) \
 522 ( \
 523   (tup)->t_infomask2 &= ~HEAP_ONLY_TUPLE \
 524 )
 525
 526 #define HeapTupleHeaderHasMatch(tup) \
 527 ( \
 528   ((tup)->t_infomask2 & HEAP_TUPLE_HAS_MATCH) != 0 \
 529 )
 530
 531 #define HeapTupleHeaderSetMatch(tup) \
 532 ( \
 533   (tup)->t_infomask2 |= HEAP_TUPLE_HAS_MATCH \
 534 )
 535
 536 #define HeapTupleHeaderClearMatch(tup) \
 537 ( \
 538   (tup)->t_infomask2 &= ~HEAP_TUPLE_HAS_MATCH \
 539 )
 540
 541 #define HeapTupleHeaderGetNatts(tup) \
 542         ((tup)->t_infomask2 & HEAP_NATTS_MASK)
 543
 544 #define HeapTupleHeaderSetNatts(tup, natts) \
 545 ( \
 546         (tup)->t_infomask2 = ((tup)->t_infomask2 & ~HEAP_NATTS_MASK) | (natts) \
 547 )
 548
 549 #define HeapTupleHeaderHasExternal(tup) \
 550                 (((tup)->t_infomask & HEAP_HASEXTERNAL) != 0)
 551
 552
 553 /*
 554  * BITMAPLEN(NATTS) -
 555  *              Computes size of null bitmap given number of data columns.
 556  */
 557 #define BITMAPLEN(NATTS)        (((int)(NATTS) + 7) / 8)
 558
 559 /*
 560  * MaxHeapTupleSize is the maximum allowed size of a heap tuple, including
 561  * header and MAXALIGN alignment padding.  Basically it's BLCKSZ minus the
 562  * other stuff that has to be on a disk page.  Since heap pages use no
 563  * "special space", there's no deduction for that.
 564  *
 565  * NOTE: we allow for the ItemId that must point to the tuple, ensuring that
 566  * an otherwise-empty page can indeed hold a tuple of this size.  Because
 567  * ItemIds and tuples have different alignment requirements, don't assume that
 568  * you can, say, fit 2 tuples of size MaxHeapTupleSize/2 on the same page.
 569  */
 570 #define MaxHeapTupleSize  (BLCKSZ - MAXALIGN(SizeOfPageHeaderData + sizeof(ItemIdData)))
 571 #define MinHeapTupleSize  MAXALIGN(SizeofHeapTupleHeader)
 572
 573 /*
 574  * MaxHeapTuplesPerPage is an upper bound on the number of tuples that can
 575  * fit on one heap page.  (Note that indexes could have more, because they
 576  * use a smaller tuple header.)  We arrive at the divisor because each tuple
 577  * must be maxaligned, and it must have an associated item pointer.
 578  *
 579  * Note: with HOT, there could theoretically be more line pointers (not actual
 580  * tuples) than this on a heap page.  However we constrain the number of line
 581  * pointers to this anyway, to avoid excessive line-pointer bloat and not
 582  * require increases in the size of work arrays.
 583  */
 584 #define MaxHeapTuplesPerPage    \
 585         ((int) ((BLCKSZ - SizeOfPageHeaderData) / \
 586                         (MAXALIGN(SizeofHeapTupleHeader) + sizeof(ItemIdData))))
 587
 588 /*
 589  * MaxAttrSize is a somewhat arbitrary upper limit on the declared size of
 590  * data fields of char(n) and similar types.  It need not have anything
 591  * directly to do with the *actual* upper limit of varlena values, which
 592  * is currently 1Gb (see TOAST structures in postgres.h).  I've set it
 593  * at 10Mb which seems like a reasonable number --- tgl 8/6/00.
 594  */
 595 #define MaxAttrSize             (10 * 1024 * 1024)
 596
 597
 598 /*
 599  * MinimalTuple is an alternative representation that is used for transient
 600  * tuples inside the executor, in places where transaction status information
 601  * is not required, the tuple rowtype is known, and shaving off a few bytes
 602  * is worthwhile because we need to store many tuples.  The representation
 603  * is chosen so that tuple access routines can work with either full or
 604  * minimal tuples via a HeapTupleData pointer structure.  The access routines
 605  * see no difference, except that they must not access the transaction status
 606  * or t_ctid fields because those aren't there.
 607  *
 608  * For the most part, MinimalTuples should be accessed via TupleTableSlot
 609  * routines.  These routines will prevent access to the "system columns"
 610  * and thereby prevent accidental use of the nonexistent fields.
 611  *
 612  * MinimalTupleData contains a length word, some padding, and fields matching
 613  * HeapTupleHeaderData beginning with t_infomask2. The padding is chosen so
 614  * that offsetof(t_infomask2) is the same modulo MAXIMUM_ALIGNOF in both
 615  * structs.   This makes data alignment rules equivalent in both cases.
 616  *
 617  * When a minimal tuple is accessed via a HeapTupleData pointer, t_data is
 618  * set to point MINIMAL_TUPLE_OFFSET bytes before the actual start of the
 619  * minimal tuple --- that is, where a full tuple matching the minimal tuple's
 620  * data would start.  This trick is what makes the structs seem equivalent.
 621  *
 622  * Note that t_hoff is computed the same as in a full tuple, hence it includes
 623  * the MINIMAL_TUPLE_OFFSET distance.  t_len does not include that, however.
 624  *
 625  * MINIMAL_TUPLE_DATA_OFFSET is the offset to the first useful (non-pad) data
 626  * other than the length word.  tuplesort.c and tuplestore.c use this to avoid
 627  * writing the padding to disk.
 628  */
 629 #define MINIMAL_TUPLE_OFFSET \
 630         ((offsetof(HeapTupleHeaderData, t_infomask2) - sizeof(uint32)) / MAXIMUM_ALIGNOF * MAXIMUM_ALIGNOF)
 631 #define MINIMAL_TUPLE_PADDING \
 632         ((offsetof(HeapTupleHeaderData, t_infomask2) - sizeof(uint32)) % MAXIMUM_ALIGNOF)
 633 #define MINIMAL_TUPLE_DATA_OFFSET \
 634         offsetof(MinimalTupleData, t_infomask2)
 635
 636 struct MinimalTupleData
 637 {
 638         uint32          t_len;                  /* actual length of minimal tuple */
 639
 640         char            mt_padding[MINIMAL_TUPLE_PADDING];
 641
 642         /* Fields below here must match HeapTupleHeaderData! */
 643
 644         uint16          t_infomask2;    /* number of attributes + various flags */
 645
 646         uint16          t_infomask;             /* various flag bits, see below */
 647
 648         uint8           t_hoff;                 /* sizeof header incl. bitmap, padding */
 649
 650         /* ^ - 23 bytes - ^ */
 651
 652         bits8           t_bits[FLEXIBLE_ARRAY_MEMBER];  /* bitmap of NULLs */
 653
 654         /* MORE DATA FOLLOWS AT END OF STRUCT */
 655 };
 656
 657 /* typedef appears in htup.h */
 658
 659 #define SizeofMinimalTupleHeader offsetof(MinimalTupleData, t_bits)
 660
 661
 662 /*
 663  * GETSTRUCT - given a HeapTuple pointer, return address of the user data
 664  */
 665 #define GETSTRUCT(TUP) ((char *) ((TUP)->t_data) + (TUP)->t_data->t_hoff)
 666
 667 /*
 668  * Accessor macros to be used with HeapTuple pointers.
 669  */
 670
 671 #define HeapTupleHasNulls(tuple) \
 672                 (((tuple)->t_data->t_infomask & HEAP_HASNULL) != 0)
 673
 674 #define HeapTupleNoNulls(tuple) \
 675                 (!((tuple)->t_data->t_infomask & HEAP_HASNULL))
 676
 677 #define HeapTupleHasVarWidth(tuple) \
 678                 (((tuple)->t_data->t_infomask & HEAP_HASVARWIDTH) != 0)
 679
 680 #define HeapTupleAllFixed(tuple) \
 681                 (!((tuple)->t_data->t_infomask & HEAP_HASVARWIDTH))
 682
 683 #define HeapTupleHasExternal(tuple) \
 684                 (((tuple)->t_data->t_infomask & HEAP_HASEXTERNAL) != 0)
 685
 686 #define HeapTupleIsHotUpdated(tuple) \
 687                 HeapTupleHeaderIsHotUpdated((tuple)->t_data)
 688
 689 #define HeapTupleSetHotUpdated(tuple) \
 690                 HeapTupleHeaderSetHotUpdated((tuple)->t_data)
 691
 692 #define HeapTupleClearHotUpdated(tuple) \
 693                 HeapTupleHeaderClearHotUpdated((tuple)->t_data)
 694
 695 #define HeapTupleIsHeapOnly(tuple) \
 696                 HeapTupleHeaderIsHeapOnly((tuple)->t_data)
 697
 698 #define HeapTupleSetHeapOnly(tuple) \
 699                 HeapTupleHeaderSetHeapOnly((tuple)->t_data)
 700
 701 #define HeapTupleClearHeapOnly(tuple) \
 702                 HeapTupleHeaderClearHeapOnly((tuple)->t_data)
 703
 704 #define HeapTupleGetOid(tuple) \
 705                 HeapTupleHeaderGetOid((tuple)->t_data)
 706
 707 #define HeapTupleSetOid(tuple, oid) \
 708                 HeapTupleHeaderSetOid((tuple)->t_data, (oid))
 709
 710
 711 /* ----------------
 712  *              fastgetattr
 713  *
 714  *              Fetch a user attribute's value as a Datum (might be either a
 715  *              value, or a pointer into the data area of the tuple).
 716  *
 717  *              This must not be used when a system attribute might be requested.
 718  *              Furthermore, the passed attnum MUST be valid.  Use heap_getattr()
 719  *              instead, if in doubt.
 720  *
 721  *              This gets called many times, so we macro the cacheable and NULL
 722  *              lookups, and call nocachegetattr() for the rest.
 723  * ----------------
 724  */
 725
 726 #if !defined(DISABLE_COMPLEX_MACRO)
 727
 728 #define fastgetattr(tup, attnum, tupleDesc, isnull)                                     \
 729 (                                                                                                                                       \
 730         AssertMacro((attnum) > 0),                                                                              \
 731         (*(isnull) = false),                                                                                    \
 732         HeapTupleNoNulls(tup) ?                                                                                 \
 733         (                                                                                                                               \
 734                 TupleDescAttr((tupleDesc), (attnum)-1)->attcacheoff >= 0 ?      \
 735                 (                                                                                                                       \
 736                         fetchatt(TupleDescAttr((tupleDesc), (attnum)-1),                \
 737                                 (char *) (tup)->t_data + (tup)->t_data->t_hoff +        \
 738                                 TupleDescAttr((tupleDesc), (attnum)-1)->attcacheoff)\
 739                 )                                                                                                                       \
 740                 :                                                                                                                       \
 741                         nocachegetattr((tup), (attnum), (tupleDesc))                    \
 742         )                                                                                                                               \
 743         :                                                                                                                               \
 744         (                                                                                                                               \
 745                 att_isnull((attnum)-1, (tup)->t_data->t_bits) ?                         \
 746                 (                                                                                                                       \
 747                         (*(isnull) = true),                                                                             \
 748                         (Datum)NULL                                                                                             \
 749                 )                                                                                                                       \
 750                 :                                                                                                                       \
 751                 (                                                                                                                       \
 752                         nocachegetattr((tup), (attnum), (tupleDesc))                    \
 753                 )                                                                                                                       \
 754         )                                                                                                                               \
 755 )
 756 #else                                                   /* defined(DISABLE_COMPLEX_MACRO) */
 757
 758 extern Datum fastgetattr(HeapTuple tup, int attnum, TupleDesc tupleDesc,
 759                         bool *isnull);
 760 #endif                                                  /* defined(DISABLE_COMPLEX_MACRO) */
 761
 762
 763 /* ----------------
 764  *              heap_getattr
 765  *
 766  *              Extract an attribute of a heap tuple and return it as a Datum.
 767  *              This works for either system or user attributes.  The given attnum
 768  *              is properly range-checked.
 769  *
 770  *              If the field in question has a NULL value, we return a zero Datum
 771  *              and set *isnull == true.  Otherwise, we set *isnull == false.
 772  *
 773  *              <tup> is the pointer to the heap tuple.  <attnum> is the attribute
 774  *              number of the column (field) caller wants.  <tupleDesc> is a
 775  *              pointer to the structure describing the row and all its fields.
 776  * ----------------
 777  */
 778 #define heap_getattr(tup, attnum, tupleDesc, isnull) \
 779         ( \
 780                 ((attnum) > 0) ? \
 781                 ( \
 782                         ((attnum) > (int) HeapTupleHeaderGetNatts((tup)->t_data)) ? \
 783                         ( \
 784                                 (*(isnull) = true), \
 785                                 (Datum)NULL \
 786                         ) \
 787                         : \
 788                                 fastgetattr((tup), (attnum), (tupleDesc), (isnull)) \
 789                 ) \
 790                 : \
 791                         heap_getsysattr((tup), (attnum), (tupleDesc), (isnull)) \
 792         )
 793
 794
 795 /* prototypes for functions in common/heaptuple.c */
 796 extern Size heap_compute_data_size(TupleDesc tupleDesc,
 797                                            Datum *values, bool *isnull);
 798 extern void heap_fill_tuple(TupleDesc tupleDesc,
 799                                 Datum *values, bool *isnull,
 800                                 char *data, Size data_size,
 801                                 uint16 *infomask, bits8 *bit);
 802 extern bool heap_attisnull(HeapTuple tup, int attnum, TupleDesc tupleDesc);
 803 extern Datum nocachegetattr(HeapTuple tup, int attnum,
 804                            TupleDesc att);
 805 extern Datum heap_getsysattr(HeapTuple tup, int attnum, TupleDesc tupleDesc,
 806                                 bool *isnull);
 807 extern HeapTuple heap_copytuple(HeapTuple tuple);
 808 extern void heap_copytuple_with_tuple(HeapTuple src, HeapTuple dest);
 809 extern Datum heap_copy_tuple_as_datum(HeapTuple tuple, TupleDesc tupleDesc);
 810 extern HeapTuple heap_form_tuple(TupleDesc tupleDescriptor,
 811                                 Datum *values, bool *isnull);
 812 extern HeapTuple heap_modify_tuple(HeapTuple tuple,
 813                                   TupleDesc tupleDesc,
 814                                   Datum *replValues,
 815                                   bool *replIsnull,
 816                                   bool *doReplace);
 817 extern HeapTuple heap_modify_tuple_by_cols(HeapTuple tuple,
 818                                                   TupleDesc tupleDesc,
 819                                                   int nCols,
 820                                                   int *replCols,
 821                                                   Datum *replValues,
 822                                                   bool *replIsnull);
 823 extern void heap_deform_tuple(HeapTuple tuple, TupleDesc tupleDesc,
 824                                   Datum *values, bool *isnull);
 825 extern void heap_freetuple(HeapTuple htup);
 826 extern MinimalTuple heap_form_minimal_tuple(TupleDesc tupleDescriptor,
 827                                                 Datum *values, bool *isnull);
 828 extern void heap_free_minimal_tuple(MinimalTuple mtup);
 829 extern MinimalTuple heap_copy_minimal_tuple(MinimalTuple mtup);
 830 extern HeapTuple heap_tuple_from_minimal_tuple(MinimalTuple mtup);
 831 extern MinimalTuple minimal_tuple_from_heap_tuple(HeapTuple htup);
 832 extern size_t varsize_any(void *p);
 833 extern HeapTuple heap_expand_tuple(HeapTuple sourceTuple, TupleDesc tupleDesc);
 834 extern MinimalTuple minimal_expand_tuple(HeapTuple sourceTuple, TupleDesc tupleDesc);
 835
 836 #endif                                                  /* HTUP_DETAILS_H */