postgresql/src/include/access/itup.h

/*-------------------------------------------------------------------------
 *
 * itup.h--
 *	  POSTGRES index tuple definitions.
 *
 *
 * Copyright (c) 1994, Regents of the University of California
 *
 * $Id: itup.h,v 1.13 1998/02/26 04:40:19 momjian Exp $
 *
 *-------------------------------------------------------------------------
 */
#ifndef ITUP_H
#define ITUP_H

#include <access/ibit.h>
#include <access/tupmacs.h>
#include <access/tupdesc.h>
#include <storage/itemptr.h>
#include <utils/memutils.h>

#define MaxIndexAttributeNumber 7

typedef struct IndexTupleData
{
	ItemPointerData t_tid;		/* reference TID to base tuple */

	/*
	 * t_info is layed out in the following fashion:
	 *
	 * 15th (leftmost) bit: "has nulls" bit 14th bit: "has varlenas" bit 13th
	 * bit: "has rules" bit - (removed ay 11/94) bits 12-0 bit: size of
	 * tuple.
	 */

	unsigned short t_info;		/* various info about tuple */

	/*
	 * please make sure sizeof(IndexTupleData) is MAXALIGN'ed. See
	 * IndexInfoFindDataOffset() for the reason.
	 */

} IndexTupleData;				/* MORE DATA FOLLOWS AT END OF STRUCT */

typedef IndexTupleData *IndexTuple;


typedef struct InsertIndexResultData
{
	ItemPointerData pointerData;
} InsertIndexResultData;

typedef InsertIndexResultData *InsertIndexResult;


typedef struct RetrieveIndexResultData
{
	ItemPointerData index_iptr;
	ItemPointerData heap_iptr;
} RetrieveIndexResultData;

typedef RetrieveIndexResultData *RetrieveIndexResult;


/*-----------------
 * PredInfo -
 *	  used for partial indices
 *-----------------
 */
typedef struct PredInfo
{
	Node	   *pred;
	Node	   *oldPred;
} PredInfo;


/* ----------------
 *		externs
 * ----------------
 */

#define INDEX_SIZE_MASK 0x1FFF
#define INDEX_NULL_MASK 0x8000
#define INDEX_VAR_MASK	0x4000

#define IndexTupleSize(itup)	   (((IndexTuple) (itup))->t_info & 0x1FFF)
#define IndexTupleDSize(itup)					   ((itup).t_info & 0x1FFF)
#define IndexTupleNoNulls(itup)  (!(((IndexTuple) (itup))->t_info & 0x8000))
#define IndexTupleAllFixed(itup) (!(((IndexTuple) (itup))->t_info & 0x4000))

#define IndexTupleHasMinHeader(itup) (IndexTupleNoNulls(itup))

/*
 * Takes an infomask as argument (primarily because this needs to be usable
 * at index_formtuple time so enough space is allocated).
 *
 * Change me if adding an attribute to IndexTuples!!!!!!!!!!!
 */
#define IndexInfoFindDataOffset(t_info) \
( \
	(!((unsigned short)(t_info) & INDEX_NULL_MASK)) ? \
	( \
		(Size)sizeof(IndexTupleData) \
	) \
	: \
	( \
		(Size)DOUBLEALIGN(sizeof(IndexTupleData) + sizeof(IndexAttributeBitMapData)) \
	) \
)

/* ----------------
 *		index_getattr
 *
 *		This gets called many times, so we macro the cacheable and NULL
 *		lookups, and call noncachegetattr() for the rest.
 *
 * ----------------
 */
#define index_getattr(tup, attnum, tupleDesc, isnull) \
( \
	AssertMacro(PointerIsValid(isnull) && (attnum) > 0) ? \
	( \
		*(isnull) = false, \
		IndexTupleNoNulls(tup) ? \
		( \
			((tupleDesc)->attrs[(attnum)-1]->attcacheoff != -1 || \
			 (attnum) == 1) ? \
			( \
				(Datum)fetchatt(&((tupleDesc)->attrs[(attnum)-1]), \
					(char *) (tup) + \
					( \
						IndexTupleHasMinHeader(tup) ? \
							sizeof (*(tup)) \
						: \
							IndexInfoFindDataOffset((tup)->t_info) \
					) + \
					( \
						((attnum) != 1) ? \
							(tupleDesc)->attrs[(attnum)-1]->attcacheoff \
						: \
							0 \
					) \
				) \
			) \
			: \
				nocache_index_getattr((tup), (attnum), (tupleDesc), (isnull)) \
		) \
		: \
		( \
			(att_isnull((attnum)-1, (char *)(tup) + sizeof(*(tup)))) ? \
			( \
				*(isnull) = true, \
				(Datum)NULL \
			) \
			: \
			( \
				nocache_index_getattr((tup), (attnum), (tupleDesc), (isnull)) \
			) \
		) \
	) \
	: \
	( \
		 (Datum)NULL \
	) \
)


/* indextuple.h */
extern IndexTuple
index_formtuple(TupleDesc tupleDescriptor,
				Datum value[], char null[]);
extern Datum
nocache_index_getattr(IndexTuple tup, int attnum,
					  TupleDesc tupleDesc, bool *isnull);
extern RetrieveIndexResult
FormRetrieveIndexResult(ItemPointer indexItemPointer,
						ItemPointer heapItemPointer);
extern void CopyIndexTuple(IndexTuple source, IndexTuple *target);


#endif							/* ITUP_H */