PostgreSQL Source Code  git master
heapfuncs.c File Reference
#include "postgres.h"
#include "access/htup_details.h"
#include "access/relation.h"
#include "catalog/pg_am_d.h"
#include "catalog/pg_type.h"
#include "funcapi.h"
#include "mb/pg_wchar.h"
#include "miscadmin.h"
#include "pageinspect.h"
#include "port/pg_bitutils.h"
#include "utils/array.h"
#include "utils/builtins.h"
#include "utils/rel.h"
Include dependency graph for heapfuncs.c:

Go to the source code of this file.

Data Structures

struct  heap_page_items_state
 

Macros

#define HeapTupleHeaderGetOidOld(tup)
 
#define HEAP_TUPLE_INFOMASK_COLS   2
 

Typedefs

typedef struct heap_page_items_state heap_page_items_state
 

Functions

static char * bits_to_text (bits8 *bits, int len)
 
static bits8text_to_bits (char *str, int len)
 
 PG_FUNCTION_INFO_V1 (heap_page_items)
 
Datum heap_page_items (PG_FUNCTION_ARGS)
 
static Datum tuple_data_split_internal (Oid relid, char *tupdata, uint16 tupdata_len, uint16 t_infomask, uint16 t_infomask2, bits8 *t_bits, bool do_detoast)
 
 PG_FUNCTION_INFO_V1 (tuple_data_split)
 
Datum tuple_data_split (PG_FUNCTION_ARGS)
 
 PG_FUNCTION_INFO_V1 (heap_tuple_infomask_flags)
 
Datum heap_tuple_infomask_flags (PG_FUNCTION_ARGS)
 

Macro Definition Documentation

◆ HEAP_TUPLE_INFOMASK_COLS

#define HEAP_TUPLE_INFOMASK_COLS   2

◆ HeapTupleHeaderGetOidOld

#define HeapTupleHeaderGetOidOld (   tup)
Value:
( \
((tup)->t_infomask & HEAP_HASOID_OLD) ? \
*((Oid *) ((char *)(tup) + (tup)->t_hoff - sizeof(Oid))) \
: \
)
#define HEAP_HASOID_OLD
Definition: htup_details.h:193
#define InvalidOid
Definition: postgres_ext.h:36
unsigned int Oid
Definition: postgres_ext.h:31

Definition at line 46 of file heapfuncs.c.

Typedef Documentation

◆ heap_page_items_state

Function Documentation

◆ bits_to_text()

static char* bits_to_text ( bits8 bits,
int  len 
)
static

Definition at line 62 of file heapfuncs.c.

63 {
64  int i;
65  char *str;
66 
67  str = palloc(len + 1);
68 
69  for (i = 0; i < len; i++)
70  str[i] = (bits[(i / 8)] & (1 << (i % 8))) ? '1' : '0';
71 
72  str[i] = '\0';
73 
74  return str;
75 }
const char * str
int i
Definition: isn.c:73
void * palloc(Size size)
Definition: mcxt.c:1317
const void size_t len

References i, len, palloc(), and str.

Referenced by heap_page_items().

◆ heap_page_items()

Datum heap_page_items ( PG_FUNCTION_ARGS  )

Definition at line 130 of file heapfuncs.c.

131 {
132  bytea *raw_page = PG_GETARG_BYTEA_P(0);
133  heap_page_items_state *inter_call_data = NULL;
134  FuncCallContext *fctx;
135  int raw_page_size;
136 
137  if (!superuser())
138  ereport(ERROR,
139  (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
140  errmsg("must be superuser to use raw page functions")));
141 
142  raw_page_size = VARSIZE(raw_page) - VARHDRSZ;
143 
144  if (SRF_IS_FIRSTCALL())
145  {
146  TupleDesc tupdesc;
147  MemoryContext mctx;
148 
149  if (raw_page_size < SizeOfPageHeaderData)
150  ereport(ERROR,
151  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
152  errmsg("input page too small (%d bytes)", raw_page_size)));
153 
154  fctx = SRF_FIRSTCALL_INIT();
156 
157  inter_call_data = palloc(sizeof(heap_page_items_state));
158 
159  /* Build a tuple descriptor for our result type */
160  if (get_call_result_type(fcinfo, NULL, &tupdesc) != TYPEFUNC_COMPOSITE)
161  elog(ERROR, "return type must be a row type");
162 
163  inter_call_data->tupd = tupdesc;
164 
165  inter_call_data->offset = FirstOffsetNumber;
166  inter_call_data->page = VARDATA(raw_page);
167 
168  fctx->max_calls = PageGetMaxOffsetNumber(inter_call_data->page);
169  fctx->user_fctx = inter_call_data;
170 
171  MemoryContextSwitchTo(mctx);
172  }
173 
174  fctx = SRF_PERCALL_SETUP();
175  inter_call_data = fctx->user_fctx;
176 
177  if (fctx->call_cntr < fctx->max_calls)
178  {
179  Page page = inter_call_data->page;
180  HeapTuple resultTuple;
181  Datum result;
182  ItemId id;
183  Datum values[14];
184  bool nulls[14];
185  uint16 lp_offset;
186  uint16 lp_flags;
187  uint16 lp_len;
188 
189  memset(nulls, 0, sizeof(nulls));
190 
191  /* Extract information from the line pointer */
192 
193  id = PageGetItemId(page, inter_call_data->offset);
194 
195  lp_offset = ItemIdGetOffset(id);
196  lp_flags = ItemIdGetFlags(id);
197  lp_len = ItemIdGetLength(id);
198 
199  values[0] = UInt16GetDatum(inter_call_data->offset);
200  values[1] = UInt16GetDatum(lp_offset);
201  values[2] = UInt16GetDatum(lp_flags);
202  values[3] = UInt16GetDatum(lp_len);
203 
204  /*
205  * We do just enough validity checking to make sure we don't reference
206  * data outside the page passed to us. The page could be corrupt in
207  * many other ways, but at least we won't crash.
208  */
209  if (ItemIdHasStorage(id) &&
210  lp_len >= MinHeapTupleSize &&
211  lp_offset == MAXALIGN(lp_offset) &&
212  lp_offset + lp_len <= raw_page_size)
213  {
214  HeapTupleHeader tuphdr;
215  bytea *tuple_data_bytea;
216  int tuple_data_len;
217 
218  /* Extract information from the tuple header */
219 
220  tuphdr = (HeapTupleHeader) PageGetItem(page, id);
221 
224  /* shared with xvac */
226  values[7] = PointerGetDatum(&tuphdr->t_ctid);
227  values[8] = UInt32GetDatum(tuphdr->t_infomask2);
228  values[9] = UInt32GetDatum(tuphdr->t_infomask);
229  values[10] = UInt8GetDatum(tuphdr->t_hoff);
230 
231  /* Copy raw tuple data into bytea attribute */
232  tuple_data_len = lp_len - tuphdr->t_hoff;
233  tuple_data_bytea = (bytea *) palloc(tuple_data_len + VARHDRSZ);
234  SET_VARSIZE(tuple_data_bytea, tuple_data_len + VARHDRSZ);
235  memcpy(VARDATA(tuple_data_bytea), (char *) tuphdr + tuphdr->t_hoff,
236  tuple_data_len);
237  values[13] = PointerGetDatum(tuple_data_bytea);
238 
239  /*
240  * We already checked that the item is completely within the raw
241  * page passed to us, with the length given in the line pointer.
242  * Let's check that t_hoff doesn't point over lp_len, before using
243  * it to access t_bits and oid.
244  */
245  if (tuphdr->t_hoff >= SizeofHeapTupleHeader &&
246  tuphdr->t_hoff <= lp_len &&
247  tuphdr->t_hoff == MAXALIGN(tuphdr->t_hoff))
248  {
249  if (tuphdr->t_infomask & HEAP_HASNULL)
250  {
251  int bits_len;
252 
253  bits_len =
255  values[11] = CStringGetTextDatum(bits_to_text(tuphdr->t_bits, bits_len));
256  }
257  else
258  nulls[11] = true;
259 
260  if (tuphdr->t_infomask & HEAP_HASOID_OLD)
261  values[12] = HeapTupleHeaderGetOidOld(tuphdr);
262  else
263  nulls[12] = true;
264  }
265  else
266  {
267  nulls[11] = true;
268  nulls[12] = true;
269  }
270  }
271  else
272  {
273  /*
274  * The line pointer is not used, or it's invalid. Set the rest of
275  * the fields to NULL
276  */
277  int i;
278 
279  for (i = 4; i <= 13; i++)
280  nulls[i] = true;
281  }
282 
283  /* Build and return the result tuple. */
284  resultTuple = heap_form_tuple(inter_call_data->tupd, values, nulls);
285  result = HeapTupleGetDatum(resultTuple);
286 
287  inter_call_data->offset++;
288 
289  SRF_RETURN_NEXT(fctx, result);
290  }
291  else
292  SRF_RETURN_DONE(fctx);
293 }
static Datum values[MAXATTR]
Definition: bootstrap.c:150
Pointer Page
Definition: bufpage.h:81
static Item PageGetItem(Page page, ItemId itemId)
Definition: bufpage.h:354
#define SizeOfPageHeaderData
Definition: bufpage.h:216
static ItemId PageGetItemId(Page page, OffsetNumber offsetNumber)
Definition: bufpage.h:243
static OffsetNumber PageGetMaxOffsetNumber(Page page)
Definition: bufpage.h:372
#define CStringGetTextDatum(s)
Definition: builtins.h:97
unsigned short uint16
Definition: c.h:508
#define MAXALIGN(LEN)
Definition: c.h:814
#define VARHDRSZ
Definition: c.h:695
int errcode(int sqlerrcode)
Definition: elog.c:853
int errmsg(const char *fmt,...)
Definition: elog.c:1070
#define ERROR
Definition: elog.h:39
#define elog(elevel,...)
Definition: elog.h:225
#define ereport(elevel,...)
Definition: elog.h:149
#define PG_GETARG_BYTEA_P(n)
Definition: fmgr.h:335
TypeFuncClass get_call_result_type(FunctionCallInfo fcinfo, Oid *resultTypeId, TupleDesc *resultTupleDesc)
Definition: funcapi.c:276
#define SRF_IS_FIRSTCALL()
Definition: funcapi.h:304
#define SRF_PERCALL_SETUP()
Definition: funcapi.h:308
@ TYPEFUNC_COMPOSITE
Definition: funcapi.h:149
#define SRF_RETURN_NEXT(_funcctx, _result)
Definition: funcapi.h:310
#define SRF_FIRSTCALL_INIT()
Definition: funcapi.h:306
static Datum HeapTupleGetDatum(const HeapTupleData *tuple)
Definition: funcapi.h:230
#define SRF_RETURN_DONE(_funcctx)
Definition: funcapi.h:328
#define HeapTupleHeaderGetOidOld(tup)
Definition: heapfuncs.c:46
static char * bits_to_text(bits8 *bits, int len)
Definition: heapfuncs.c:62
HeapTuple heap_form_tuple(TupleDesc tupleDescriptor, const Datum *values, const bool *isnull)
Definition: heaptuple.c:1116
HeapTupleHeaderData * HeapTupleHeader
Definition: htup.h:23
#define HeapTupleHeaderGetNatts(tup)
Definition: htup_details.h:529
#define SizeofHeapTupleHeader
Definition: htup_details.h:185
#define MinHeapTupleSize
Definition: htup_details.h:559
#define HEAP_HASNULL
Definition: htup_details.h:190
#define BITMAPLEN(NATTS)
Definition: htup_details.h:545
#define HeapTupleHeaderGetRawXmin(tup)
Definition: htup_details.h:304
#define HeapTupleHeaderGetRawXmax(tup)
Definition: htup_details.h:371
#define HeapTupleHeaderGetRawCommandId(tup)
Definition: htup_details.h:387
#define ItemIdGetLength(itemId)
Definition: itemid.h:59
#define ItemIdGetOffset(itemId)
Definition: itemid.h:65
#define ItemIdGetFlags(itemId)
Definition: itemid.h:71
#define ItemIdHasStorage(itemId)
Definition: itemid.h:120
#define FirstOffsetNumber
Definition: off.h:27
#define BITS_PER_BYTE
static Datum PointerGetDatum(const void *X)
Definition: postgres.h:322
uintptr_t Datum
Definition: postgres.h:64
static Datum UInt16GetDatum(uint16 X)
Definition: postgres.h:192
static Datum UInt8GetDatum(uint8 X)
Definition: postgres.h:152
static Datum UInt32GetDatum(uint32 X)
Definition: postgres.h:232
MemoryContextSwitchTo(old_ctx)
void * user_fctx
Definition: funcapi.h:82
uint64 max_calls
Definition: funcapi.h:74
uint64 call_cntr
Definition: funcapi.h:65
MemoryContext multi_call_memory_ctx
Definition: funcapi.h:101
ItemPointerData t_ctid
Definition: htup_details.h:161
bits8 t_bits[FLEXIBLE_ARRAY_MEMBER]
Definition: htup_details.h:178
Definition: c.h:690
bool superuser(void)
Definition: superuser.c:46
#define VARDATA(PTR)
Definition: varatt.h:278
#define SET_VARSIZE(PTR, len)
Definition: varatt.h:305
#define VARSIZE(PTR)
Definition: varatt.h:279

References BITMAPLEN, BITS_PER_BYTE, bits_to_text(), FuncCallContext::call_cntr, CStringGetTextDatum, elog, ereport, errcode(), errmsg(), ERROR, FirstOffsetNumber, get_call_result_type(), heap_form_tuple(), HEAP_HASNULL, HEAP_HASOID_OLD, HeapTupleGetDatum(), HeapTupleHeaderGetNatts, HeapTupleHeaderGetOidOld, HeapTupleHeaderGetRawCommandId, HeapTupleHeaderGetRawXmax, HeapTupleHeaderGetRawXmin, i, ItemIdGetFlags, ItemIdGetLength, ItemIdGetOffset, ItemIdHasStorage, FuncCallContext::max_calls, MAXALIGN, MemoryContextSwitchTo(), MinHeapTupleSize, FuncCallContext::multi_call_memory_ctx, heap_page_items_state::offset, heap_page_items_state::page, PageGetItem(), PageGetItemId(), PageGetMaxOffsetNumber(), palloc(), PG_GETARG_BYTEA_P, PointerGetDatum(), SET_VARSIZE, SizeofHeapTupleHeader, SizeOfPageHeaderData, SRF_FIRSTCALL_INIT, SRF_IS_FIRSTCALL, SRF_PERCALL_SETUP, SRF_RETURN_DONE, SRF_RETURN_NEXT, superuser(), HeapTupleHeaderData::t_bits, HeapTupleHeaderData::t_ctid, HeapTupleHeaderData::t_hoff, HeapTupleHeaderData::t_infomask, HeapTupleHeaderData::t_infomask2, heap_page_items_state::tupd, TYPEFUNC_COMPOSITE, UInt16GetDatum(), UInt32GetDatum(), UInt8GetDatum(), FuncCallContext::user_fctx, values, VARDATA, VARHDRSZ, and VARSIZE.

◆ heap_tuple_infomask_flags()

Datum heap_tuple_infomask_flags ( PG_FUNCTION_ARGS  )

Definition at line 511 of file heapfuncs.c.

512 {
513 #define HEAP_TUPLE_INFOMASK_COLS 2
515  bool nulls[HEAP_TUPLE_INFOMASK_COLS] = {0};
516  uint16 t_infomask = PG_GETARG_INT16(0);
517  uint16 t_infomask2 = PG_GETARG_INT16(1);
518  int cnt = 0;
519  ArrayType *a;
520  int bitcnt;
521  Datum *flags;
522  TupleDesc tupdesc;
523  HeapTuple tuple;
524 
525  if (!superuser())
526  ereport(ERROR,
527  (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
528  errmsg("must be superuser to use raw page functions")));
529 
530  /* Build a tuple descriptor for our result type */
531  if (get_call_result_type(fcinfo, NULL, &tupdesc) != TYPEFUNC_COMPOSITE)
532  elog(ERROR, "return type must be a row type");
533 
534  bitcnt = pg_popcount((const char *) &t_infomask, sizeof(uint16)) +
535  pg_popcount((const char *) &t_infomask2, sizeof(uint16));
536 
537  /* If no flags, return a set of empty arrays */
538  if (bitcnt <= 0)
539  {
542  tuple = heap_form_tuple(tupdesc, values, nulls);
544  }
545 
546  /* build set of raw flags */
547  flags = (Datum *) palloc0(sizeof(Datum) * bitcnt);
548 
549  /* decode t_infomask */
550  if ((t_infomask & HEAP_HASNULL) != 0)
551  flags[cnt++] = CStringGetTextDatum("HEAP_HASNULL");
552  if ((t_infomask & HEAP_HASVARWIDTH) != 0)
553  flags[cnt++] = CStringGetTextDatum("HEAP_HASVARWIDTH");
554  if ((t_infomask & HEAP_HASEXTERNAL) != 0)
555  flags[cnt++] = CStringGetTextDatum("HEAP_HASEXTERNAL");
556  if ((t_infomask & HEAP_HASOID_OLD) != 0)
557  flags[cnt++] = CStringGetTextDatum("HEAP_HASOID_OLD");
558  if ((t_infomask & HEAP_XMAX_KEYSHR_LOCK) != 0)
559  flags[cnt++] = CStringGetTextDatum("HEAP_XMAX_KEYSHR_LOCK");
560  if ((t_infomask & HEAP_COMBOCID) != 0)
561  flags[cnt++] = CStringGetTextDatum("HEAP_COMBOCID");
562  if ((t_infomask & HEAP_XMAX_EXCL_LOCK) != 0)
563  flags[cnt++] = CStringGetTextDatum("HEAP_XMAX_EXCL_LOCK");
564  if ((t_infomask & HEAP_XMAX_LOCK_ONLY) != 0)
565  flags[cnt++] = CStringGetTextDatum("HEAP_XMAX_LOCK_ONLY");
566  if ((t_infomask & HEAP_XMIN_COMMITTED) != 0)
567  flags[cnt++] = CStringGetTextDatum("HEAP_XMIN_COMMITTED");
568  if ((t_infomask & HEAP_XMIN_INVALID) != 0)
569  flags[cnt++] = CStringGetTextDatum("HEAP_XMIN_INVALID");
570  if ((t_infomask & HEAP_XMAX_COMMITTED) != 0)
571  flags[cnt++] = CStringGetTextDatum("HEAP_XMAX_COMMITTED");
572  if ((t_infomask & HEAP_XMAX_INVALID) != 0)
573  flags[cnt++] = CStringGetTextDatum("HEAP_XMAX_INVALID");
574  if ((t_infomask & HEAP_XMAX_IS_MULTI) != 0)
575  flags[cnt++] = CStringGetTextDatum("HEAP_XMAX_IS_MULTI");
576  if ((t_infomask & HEAP_UPDATED) != 0)
577  flags[cnt++] = CStringGetTextDatum("HEAP_UPDATED");
578  if ((t_infomask & HEAP_MOVED_OFF) != 0)
579  flags[cnt++] = CStringGetTextDatum("HEAP_MOVED_OFF");
580  if ((t_infomask & HEAP_MOVED_IN) != 0)
581  flags[cnt++] = CStringGetTextDatum("HEAP_MOVED_IN");
582 
583  /* decode t_infomask2 */
584  if ((t_infomask2 & HEAP_KEYS_UPDATED) != 0)
585  flags[cnt++] = CStringGetTextDatum("HEAP_KEYS_UPDATED");
586  if ((t_infomask2 & HEAP_HOT_UPDATED) != 0)
587  flags[cnt++] = CStringGetTextDatum("HEAP_HOT_UPDATED");
588  if ((t_infomask2 & HEAP_ONLY_TUPLE) != 0)
589  flags[cnt++] = CStringGetTextDatum("HEAP_ONLY_TUPLE");
590 
591  /* build value */
592  Assert(cnt <= bitcnt);
593  a = construct_array_builtin(flags, cnt, TEXTOID);
594  values[0] = PointerGetDatum(a);
595 
596  /*
597  * Build set of combined flags. Use the same array as previously, this
598  * keeps the code simple.
599  */
600  cnt = 0;
601  MemSet(flags, 0, sizeof(Datum) * bitcnt);
602 
603  /* decode combined masks of t_infomask */
604  if ((t_infomask & HEAP_XMAX_SHR_LOCK) == HEAP_XMAX_SHR_LOCK)
605  flags[cnt++] = CStringGetTextDatum("HEAP_XMAX_SHR_LOCK");
606  if ((t_infomask & HEAP_XMIN_FROZEN) == HEAP_XMIN_FROZEN)
607  flags[cnt++] = CStringGetTextDatum("HEAP_XMIN_FROZEN");
608  if ((t_infomask & HEAP_MOVED) == HEAP_MOVED)
609  flags[cnt++] = CStringGetTextDatum("HEAP_MOVED");
610 
611  /* Build an empty array if there are no combined flags */
612  if (cnt == 0)
613  a = construct_empty_array(TEXTOID);
614  else
615  a = construct_array_builtin(flags, cnt, TEXTOID);
616  pfree(flags);
617  values[1] = PointerGetDatum(a);
618 
619  /* Returns the record as Datum */
620  tuple = heap_form_tuple(tupdesc, values, nulls);
622 }
ArrayType * construct_array_builtin(Datum *elems, int nelems, Oid elmtype)
Definition: arrayfuncs.c:3381
ArrayType * construct_empty_array(Oid elmtype)
Definition: arrayfuncs.c:3568
#define Assert(condition)
Definition: c.h:861
#define MemSet(start, val, len)
Definition: c.h:1023
#define PG_RETURN_DATUM(x)
Definition: fmgr.h:353
#define PG_GETARG_INT16(n)
Definition: fmgr.h:271
#define HEAP_TUPLE_INFOMASK_COLS
#define HEAP_HASVARWIDTH
Definition: htup_details.h:191
#define HEAP_MOVED_OFF
Definition: htup_details.h:211
#define HEAP_XMAX_SHR_LOCK
Definition: htup_details.h:200
#define HEAP_XMIN_FROZEN
Definition: htup_details.h:206
#define HEAP_XMIN_COMMITTED
Definition: htup_details.h:204
#define HEAP_KEYS_UPDATED
Definition: htup_details.h:275
#define HEAP_HOT_UPDATED
Definition: htup_details.h:276
#define HEAP_XMAX_LOCK_ONLY
Definition: htup_details.h:197
#define HEAP_MOVED_IN
Definition: htup_details.h:212
#define HEAP_MOVED
Definition: htup_details.h:213
#define HEAP_XMAX_IS_MULTI
Definition: htup_details.h:209
#define HEAP_XMAX_COMMITTED
Definition: htup_details.h:207
#define HEAP_COMBOCID
Definition: htup_details.h:195
#define HEAP_XMIN_INVALID
Definition: htup_details.h:205
#define HEAP_HASEXTERNAL
Definition: htup_details.h:192
#define HEAP_XMAX_EXCL_LOCK
Definition: htup_details.h:196
#define HEAP_XMAX_INVALID
Definition: htup_details.h:208
#define HEAP_UPDATED
Definition: htup_details.h:210
#define HEAP_XMAX_KEYSHR_LOCK
Definition: htup_details.h:194
#define HEAP_ONLY_TUPLE
Definition: htup_details.h:277
int a
Definition: isn.c:69
void pfree(void *pointer)
Definition: mcxt.c:1521
void * palloc0(Size size)
Definition: mcxt.c:1347
static uint64 pg_popcount(const char *buf, int bytes)
Definition: pg_bitutils.h:339

References a, Assert, construct_array_builtin(), construct_empty_array(), CStringGetTextDatum, elog, ereport, errcode(), errmsg(), ERROR, get_call_result_type(), HEAP_COMBOCID, heap_form_tuple(), HEAP_HASEXTERNAL, HEAP_HASNULL, HEAP_HASOID_OLD, HEAP_HASVARWIDTH, HEAP_HOT_UPDATED, HEAP_KEYS_UPDATED, HEAP_MOVED, HEAP_MOVED_IN, HEAP_MOVED_OFF, HEAP_ONLY_TUPLE, HEAP_TUPLE_INFOMASK_COLS, HEAP_UPDATED, HEAP_XMAX_COMMITTED, HEAP_XMAX_EXCL_LOCK, HEAP_XMAX_INVALID, HEAP_XMAX_IS_MULTI, HEAP_XMAX_KEYSHR_LOCK, HEAP_XMAX_LOCK_ONLY, HEAP_XMAX_SHR_LOCK, HEAP_XMIN_COMMITTED, HEAP_XMIN_FROZEN, HEAP_XMIN_INVALID, HeapTupleGetDatum(), MemSet, palloc0(), pfree(), PG_GETARG_INT16, pg_popcount(), PG_RETURN_DATUM, PointerGetDatum(), superuser(), TYPEFUNC_COMPOSITE, and values.

◆ PG_FUNCTION_INFO_V1() [1/3]

PG_FUNCTION_INFO_V1 ( heap_page_items  )

◆ PG_FUNCTION_INFO_V1() [2/3]

PG_FUNCTION_INFO_V1 ( heap_tuple_infomask_flags  )

◆ PG_FUNCTION_INFO_V1() [3/3]

PG_FUNCTION_INFO_V1 ( tuple_data_split  )

◆ text_to_bits()

static bits8* text_to_bits ( char *  str,
int  len 
)
static

Definition at line 85 of file heapfuncs.c.

86 {
87  bits8 *bits;
88  int off = 0;
89  char byte = 0;
90 
91  bits = palloc(len + 1);
92 
93  while (off < len)
94  {
95  if (off % 8 == 0)
96  byte = 0;
97 
98  if ((str[off] == '0') || (str[off] == '1'))
99  byte = byte | ((str[off] - '0') << off % 8);
100  else
101  ereport(ERROR,
103  errmsg("invalid character \"%.*s\" in t_bits string",
104  pg_mblen(str + off), str + off)));
105 
106  if (off % 8 == 7)
107  bits[off / 8] = byte;
108 
109  off++;
110  }
111 
112  return bits;
113 }
uint8 bits8
Definition: c.h:516
int pg_mblen(const char *mbstr)
Definition: mbutils.c:1023
#define ERRCODE_DATA_CORRUPTED
Definition: pg_basebackup.c:41

References ereport, errcode(), ERRCODE_DATA_CORRUPTED, errmsg(), ERROR, len, palloc(), pg_mblen(), and str.

Referenced by tuple_data_split().

◆ tuple_data_split()

Datum tuple_data_split ( PG_FUNCTION_ARGS  )

Definition at line 427 of file heapfuncs.c.

428 {
429  Oid relid;
430  bytea *raw_data;
431  uint16 t_infomask;
432  uint16 t_infomask2;
433  char *t_bits_str;
434  bool do_detoast = false;
435  bits8 *t_bits = NULL;
436  Datum res;
437 
438  relid = PG_GETARG_OID(0);
439  raw_data = PG_ARGISNULL(1) ? NULL : PG_GETARG_BYTEA_P(1);
440  t_infomask = PG_GETARG_INT16(2);
441  t_infomask2 = PG_GETARG_INT16(3);
442  t_bits_str = PG_ARGISNULL(4) ? NULL :
444 
445  if (PG_NARGS() >= 6)
446  do_detoast = PG_GETARG_BOOL(5);
447 
448  if (!superuser())
449  ereport(ERROR,
450  (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
451  errmsg("must be superuser to use raw page functions")));
452 
453  if (!raw_data)
454  PG_RETURN_NULL();
455 
456  /*
457  * Convert t_bits string back to the bits8 array as represented in the
458  * tuple header.
459  */
460  if (t_infomask & HEAP_HASNULL)
461  {
462  size_t bits_str_len;
463  size_t bits_len;
464 
465  bits_len = BITMAPLEN(t_infomask2 & HEAP_NATTS_MASK) * BITS_PER_BYTE;
466  if (!t_bits_str)
467  ereport(ERROR,
469  errmsg("t_bits string must not be NULL")));
470 
471  bits_str_len = strlen(t_bits_str);
472  if (bits_len != bits_str_len)
473  ereport(ERROR,
475  errmsg("unexpected length of t_bits string: %zu, expected %zu",
476  bits_str_len, bits_len)));
477 
478  /* do the conversion */
479  t_bits = text_to_bits(t_bits_str, bits_str_len);
480  }
481  else
482  {
483  if (t_bits_str)
484  ereport(ERROR,
486  errmsg("t_bits string is expected to be NULL, but instead it is %zu bytes long",
487  strlen(t_bits_str))));
488  }
489 
490  /* Split tuple data */
491  res = tuple_data_split_internal(relid, (char *) raw_data + VARHDRSZ,
492  VARSIZE(raw_data) - VARHDRSZ,
493  t_infomask, t_infomask2, t_bits,
494  do_detoast);
495 
496  if (t_bits)
497  pfree(t_bits);
498 
500 }
#define PG_GETARG_OID(n)
Definition: fmgr.h:275
#define PG_GETARG_TEXT_PP(n)
Definition: fmgr.h:309
#define PG_ARGISNULL(n)
Definition: fmgr.h:209
#define PG_NARGS()
Definition: fmgr.h:203
#define PG_RETURN_NULL()
Definition: fmgr.h:345
#define PG_GETARG_BOOL(n)
Definition: fmgr.h:274
static bits8 * text_to_bits(char *str, int len)
Definition: heapfuncs.c:85
static Datum tuple_data_split_internal(Oid relid, char *tupdata, uint16 tupdata_len, uint16 t_infomask, uint16 t_infomask2, bits8 *t_bits, bool do_detoast)
Definition: heapfuncs.c:304
#define HEAP_NATTS_MASK
Definition: htup_details.h:273
char * text_to_cstring(const text *t)
Definition: varlena.c:217

References BITMAPLEN, BITS_PER_BYTE, ereport, errcode(), ERRCODE_DATA_CORRUPTED, errmsg(), ERROR, HEAP_HASNULL, HEAP_NATTS_MASK, pfree(), PG_ARGISNULL, PG_GETARG_BOOL, PG_GETARG_BYTEA_P, PG_GETARG_INT16, PG_GETARG_OID, PG_GETARG_TEXT_PP, PG_NARGS, PG_RETURN_DATUM, PG_RETURN_NULL, res, superuser(), text_to_bits(), text_to_cstring(), tuple_data_split_internal(), VARHDRSZ, and VARSIZE.

◆ tuple_data_split_internal()

static Datum tuple_data_split_internal ( Oid  relid,
char *  tupdata,
uint16  tupdata_len,
uint16  t_infomask,
uint16  t_infomask2,
bits8 t_bits,
bool  do_detoast 
)
static

Definition at line 304 of file heapfuncs.c.

308 {
309  ArrayBuildState *raw_attrs;
310  int nattrs;
311  int i;
312  int off = 0;
313  Relation rel;
314  TupleDesc tupdesc;
315 
316  /* Get tuple descriptor from relation OID */
317  rel = relation_open(relid, AccessShareLock);
318  tupdesc = RelationGetDescr(rel);
319 
320  raw_attrs = initArrayResult(BYTEAOID, CurrentMemoryContext, false);
321  nattrs = tupdesc->natts;
322 
323  /*
324  * Sequences always use heap AM, but they don't show that in the catalogs.
325  */
326  if (rel->rd_rel->relkind != RELKIND_SEQUENCE &&
327  rel->rd_rel->relam != HEAP_TABLE_AM_OID)
328  ereport(ERROR, (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
329  errmsg("only heap AM is supported")));
330 
331  if (nattrs < (t_infomask2 & HEAP_NATTS_MASK))
332  ereport(ERROR,
334  errmsg("number of attributes in tuple header is greater than number of attributes in tuple descriptor")));
335 
336  for (i = 0; i < nattrs; i++)
337  {
338  Form_pg_attribute attr;
339  bool is_null;
340  bytea *attr_data = NULL;
341 
342  attr = TupleDescAttr(tupdesc, i);
343 
344  /*
345  * Tuple header can specify fewer attributes than tuple descriptor as
346  * ALTER TABLE ADD COLUMN without DEFAULT keyword does not actually
347  * change tuples in pages, so attributes with numbers greater than
348  * (t_infomask2 & HEAP_NATTS_MASK) should be treated as NULL.
349  */
350  if (i >= (t_infomask2 & HEAP_NATTS_MASK))
351  is_null = true;
352  else
353  is_null = (t_infomask & HEAP_HASNULL) && att_isnull(i, t_bits);
354 
355  if (!is_null)
356  {
357  int len;
358 
359  if (attr->attlen == -1)
360  {
361  off = att_align_pointer(off, attr->attalign, -1,
362  tupdata + off);
363 
364  /*
365  * As VARSIZE_ANY throws an exception if it can't properly
366  * detect the type of external storage in macros VARTAG_SIZE,
367  * this check is repeated to have a nicer error handling.
368  */
369  if (VARATT_IS_EXTERNAL(tupdata + off) &&
370  !VARATT_IS_EXTERNAL_ONDISK(tupdata + off) &&
371  !VARATT_IS_EXTERNAL_INDIRECT(tupdata + off))
372  ereport(ERROR,
374  errmsg("first byte of varlena attribute is incorrect for attribute %d", i)));
375 
376  len = VARSIZE_ANY(tupdata + off);
377  }
378  else
379  {
380  off = att_align_nominal(off, attr->attalign);
381  len = attr->attlen;
382  }
383 
384  if (tupdata_len < off + len)
385  ereport(ERROR,
387  errmsg("unexpected end of tuple data")));
388 
389  if (attr->attlen == -1 && do_detoast)
390  attr_data = pg_detoast_datum_copy((struct varlena *) (tupdata + off));
391  else
392  {
393  attr_data = (bytea *) palloc(len + VARHDRSZ);
394  SET_VARSIZE(attr_data, len + VARHDRSZ);
395  memcpy(VARDATA(attr_data), tupdata + off, len);
396  }
397 
398  off = att_addlength_pointer(off, attr->attlen,
399  tupdata + off);
400  }
401 
402  raw_attrs = accumArrayResult(raw_attrs, PointerGetDatum(attr_data),
403  is_null, BYTEAOID, CurrentMemoryContext);
404  if (attr_data)
405  pfree(attr_data);
406  }
407 
408  if (tupdata_len != off)
409  ereport(ERROR,
411  errmsg("end of tuple reached without looking at all its data")));
412 
414 
415  return makeArrayResult(raw_attrs, CurrentMemoryContext);
416 }
ArrayBuildState * accumArrayResult(ArrayBuildState *astate, Datum dvalue, bool disnull, Oid element_type, MemoryContext rcontext)
Definition: arrayfuncs.c:5338
ArrayBuildState * initArrayResult(Oid element_type, MemoryContext rcontext, bool subcontext)
Definition: arrayfuncs.c:5281
Datum makeArrayResult(ArrayBuildState *astate, MemoryContext rcontext)
Definition: arrayfuncs.c:5408
struct varlena * pg_detoast_datum_copy(struct varlena *datum)
Definition: fmgr.c:1841
#define AccessShareLock
Definition: lockdefs.h:36
MemoryContext CurrentMemoryContext
Definition: mcxt.c:143
FormData_pg_attribute * Form_pg_attribute
Definition: pg_attribute.h:209
#define RelationGetDescr(relation)
Definition: rel.h:531
void relation_close(Relation relation, LOCKMODE lockmode)
Definition: relation.c:205
Relation relation_open(Oid relationId, LOCKMODE lockmode)
Definition: relation.c:47
Form_pg_class rd_rel
Definition: rel.h:111
#define TupleDescAttr(tupdesc, i)
Definition: tupdesc.h:92
#define att_align_pointer(cur_offset, attalign, attlen, attptr)
Definition: tupmacs.h:107
#define att_align_nominal(cur_offset, attalign)
Definition: tupmacs.h:129
static bool att_isnull(int ATT, const bits8 *BITS)
Definition: tupmacs.h:26
#define att_addlength_pointer(cur_offset, attlen, attptr)
Definition: tupmacs.h:157
#define VARATT_IS_EXTERNAL_ONDISK(PTR)
Definition: varatt.h:290
#define VARATT_IS_EXTERNAL_INDIRECT(PTR)
Definition: varatt.h:292
#define VARSIZE_ANY(PTR)
Definition: varatt.h:311
#define VARATT_IS_EXTERNAL(PTR)
Definition: varatt.h:289

References AccessShareLock, accumArrayResult(), att_addlength_pointer, att_align_nominal, att_align_pointer, att_isnull(), CurrentMemoryContext, ereport, errcode(), ERRCODE_DATA_CORRUPTED, errmsg(), ERROR, HEAP_HASNULL, HEAP_NATTS_MASK, i, initArrayResult(), len, makeArrayResult(), TupleDescData::natts, palloc(), pfree(), pg_detoast_datum_copy(), PointerGetDatum(), RelationData::rd_rel, relation_close(), relation_open(), RelationGetDescr, SET_VARSIZE, TupleDescAttr, VARATT_IS_EXTERNAL, VARATT_IS_EXTERNAL_INDIRECT, VARATT_IS_EXTERNAL_ONDISK, VARDATA, VARHDRSZ, and VARSIZE_ANY.

Referenced by tuple_data_split().