1 /*-------------------------------------------------------------------------
4 * POSTGRES heap access method definitions.
7 * Copyright (c) 1994, Regents of the University of California
9 * $Id: heapam.h,v 1.37 1998/09/01 04:34:12 momjian Exp $
11 *-------------------------------------------------------------------------
16 #include <access/tupmacs.h>
17 #include <access/htup.h>
18 #include <access/relscan.h>
19 #include <storage/block.h>
20 #include <utils/rel.h>
21 #include <utils/tqual.h>
23 /* ----------------------------------------------------------------
24 * heap access method statistics
25 * ----------------------------------------------------------------
28 typedef struct HeapAccessStatisticsData
30 time_t init_global_timestamp; /* time global statistics started */
31 time_t local_reset_timestamp; /* last time local reset was done */
32 time_t last_request_timestamp; /* last time stats were requested */
47 int global_BufferGetRelation;
48 int global_RelationIdGetRelation;
49 int global_RelationIdGetRelation_Buf;
50 int global_RelationNameGetRelation;
51 int global_getreldesc;
52 int global_heapgettup;
53 int global_RelationPutHeapTuple;
54 int global_RelationPutLongHeapTuple;
69 int local_BufferGetRelation;
70 int local_RelationIdGetRelation;
71 int local_RelationIdGetRelation_Buf;
72 int local_RelationNameGetRelation;
75 int local_RelationPutHeapTuple;
76 int local_RelationPutLongHeapTuple;
77 } HeapAccessStatisticsData;
79 typedef HeapAccessStatisticsData *HeapAccessStatistics;
81 #define IncrHeapAccessStat(x) \
82 (heap_access_stats == NULL ? 0 : (heap_access_stats->x)++)
87 * This gets called many times, so we macro the cacheable and NULL
88 * lookups, and call noncachegetattr() for the rest.
92 #if !defined(DISABLE_COMPLEX_MACRO)
94 #define fastgetattr(tup, attnum, tupleDesc, isnull) \
96 AssertMacro((attnum) > 0), \
97 ((isnull) ? (*(isnull) = false) : (dummyret)NULL), \
98 HeapTupleNoNulls(tup) ? \
100 ((tupleDesc)->attrs[(attnum)-1]->attcacheoff != -1 || \
103 (Datum)fetchatt(&((tupleDesc)->attrs[(attnum)-1]), \
104 (char *) (tup) + (tup)->t_hoff + \
107 (tupleDesc)->attrs[(attnum)-1]->attcacheoff \
114 nocachegetattr((tup), (attnum), (tupleDesc), (isnull)) \
118 att_isnull((attnum)-1, (tup)->t_bits) ? \
120 ((isnull) ? (*(isnull) = true) : (dummyret)NULL), \
125 nocachegetattr((tup), (attnum), (tupleDesc), (isnull)) \
130 #else /* !defined(DISABLE_COMPLEX_MACRO) */
132 extern Datum nocachegetattr(HeapTuple tup, int attnum,
133 TupleDesc att, bool *isnull);
136 fastgetattr(HeapTuple tup, int attnum, TupleDesc tupleDesc,
142 ((isnull) ? (*(isnull) = false) : (dummyret) NULL),
143 HeapTupleNoNulls(tup) ?
145 ((tupleDesc)->attrs[(attnum) - 1]->attcacheoff != -1 ||
148 (Datum) fetchatt(&((tupleDesc)->attrs[(attnum) - 1]),
149 (char *) (tup) + (tup)->t_hoff +
152 (tupleDesc)->attrs[(attnum) - 1]->attcacheoff
159 nocachegetattr((tup), (attnum), (tupleDesc), (isnull))
163 att_isnull((attnum) - 1, (tup)->t_bits) ?
165 ((isnull) ? (*(isnull) = true) : (dummyret) NULL),
170 nocachegetattr((tup), (attnum), (tupleDesc), (isnull))
186 * Find a particular field in a row represented as a heap tuple.
187 * We return a pointer into that heap tuple, which points to the
188 * first byte of the value of the field in question.
190 * If the field in question has a NULL value, we return a null
191 * pointer and return <*isnull> == true. Otherwise, we return
192 * <*isnull> == false.
194 * <tup> is the pointer to the heap tuple. <attnum> is the attribute
195 * number of the column (field) caller wants. <tupleDesc> is a
196 * pointer to the structure describing the row and all its fields.
198 * Because this macro is often called with constants, it generates
199 * compiler warnings about 'left-hand comma expression has no effect.
203 #define heap_getattr(tup, attnum, tupleDesc, isnull) \
205 AssertMacro((tup) != NULL && \
206 (attnum) > FirstLowInvalidHeapAttributeNumber && \
208 ((attnum) > (int) (tup)->t_natts) ? \
210 ((isnull) ? (*(isnull) = true) : (dummyret)NULL), \
217 fastgetattr((tup), (attnum), (tupleDesc), (isnull)) \
221 ((isnull) ? (*(isnull) = false) : (dummyret)NULL), \
222 ((attnum) == SelfItemPointerAttributeNumber) ? \
224 (Datum)((char *)(tup) + \
225 heap_sysoffset[-SelfItemPointerAttributeNumber-1]) \
229 (Datum)*(unsigned int *) \
230 ((char *)(tup) + heap_sysoffset[-(attnum)-1]) \
236 extern HeapAccessStatistics heap_access_stats; /* in stats.c */
239 * function prototypes for heap access method
242 /* heap_create, heap_creatr, and heap_destroy are declared in catalog/heap.h */
245 extern void doinsert(Relation relation, HeapTuple tup);
247 extern Relation heap_open(Oid relationId);
248 extern Relation heap_openr(char *relationName);
249 extern void heap_close(Relation relation);
250 extern HeapScanDesc heap_beginscan(Relation relation, int atend,
251 Snapshot snapshot, unsigned nkeys, ScanKey key);
252 extern void heap_rescan(HeapScanDesc scan, bool scanFromEnd, ScanKey key);
253 extern void heap_endscan(HeapScanDesc scan);
254 extern HeapTuple heap_getnext(HeapScanDesc scandesc, int backw);
255 extern HeapTuple heap_fetch(Relation relation, Snapshot snapshot, ItemPointer tid, Buffer *userbuf);
256 extern Oid heap_insert(Relation relation, HeapTuple tup);
257 extern int heap_delete(Relation relation, ItemPointer tid);
258 extern int heap_replace(Relation relation, ItemPointer otid,
260 extern void heap_markpos(HeapScanDesc scan);
261 extern void heap_restrpos(HeapScanDesc scan);
263 /* in common/heaptuple.c */
264 extern Size ComputeDataSize(TupleDesc tupleDesc, Datum *value, char *nulls);
265 extern void DataFill(char *data, TupleDesc tupleDesc,
266 Datum *value, char *nulls, uint16 *infomask,
268 extern int heap_attisnull(HeapTuple tup, int attnum);
269 extern int heap_sysattrlen(AttrNumber attno);
270 extern bool heap_sysattrbyval(AttrNumber attno);
271 extern Datum heap_getsysattr(HeapTuple tup, Buffer b, int attnum);
272 extern Datum nocachegetattr(HeapTuple tup, int attnum,
273 TupleDesc att, bool *isnull);
274 extern HeapTuple heap_copytuple(HeapTuple tuple);
275 extern HeapTuple heap_formtuple(TupleDesc tupleDescriptor,
276 Datum *value, char *nulls);
277 extern HeapTuple heap_modifytuple(HeapTuple tuple,
278 Relation relation, Datum *replValue, char *replNull, char *repl);
279 HeapTuple heap_addheader(uint32 natts, int structlen, char *structure);
281 /* in common/heap/stats.c */
282 extern void PrintHeapAccessStatistics(HeapAccessStatistics stats);
283 extern void initam(void);
286 extern void RelationPutHeapTuple(Relation relation, BlockNumber blockIndex,
288 extern void RelationPutHeapTupleAtEnd(Relation relation, HeapTuple tuple);
290 #endif /* HEAPAM_H */