PostgreSQL Source Code  git master
heap_surgery.c File Reference
#include "postgres.h"
#include "access/heapam.h"
#include "access/visibilitymap.h"
#include "access/xloginsert.h"
#include "catalog/pg_am_d.h"
#include "catalog/pg_proc_d.h"
#include "miscadmin.h"
#include "storage/bufmgr.h"
#include "utils/acl.h"
#include "utils/array.h"
#include "utils/rel.h"
Include dependency graph for heap_surgery.c:

Go to the source code of this file.

Typedefs

typedef enum HeapTupleForceOption HeapTupleForceOption
 

Enumerations

enum  HeapTupleForceOption { HEAP_FORCE_KILL , HEAP_FORCE_FREEZE }
 

Functions

 PG_FUNCTION_INFO_V1 (heap_force_kill)
 
 PG_FUNCTION_INFO_V1 (heap_force_freeze)
 
static int32 tidcmp (const void *a, const void *b)
 
static Datum heap_force_common (FunctionCallInfo fcinfo, HeapTupleForceOption heap_force_opt)
 
static void sanity_check_tid_array (ArrayType *ta, int *ntids)
 
static BlockNumber find_tids_one_page (ItemPointer tids, int ntids, OffsetNumber *next_start_ptr)
 
Datum heap_force_kill (PG_FUNCTION_ARGS)
 
Datum heap_force_freeze (PG_FUNCTION_ARGS)
 

Variables

 PG_MODULE_MAGIC
 

Typedef Documentation

◆ HeapTupleForceOption

Enumeration Type Documentation

◆ HeapTupleForceOption

Enumerator
HEAP_FORCE_KILL 
HEAP_FORCE_FREEZE 

Definition at line 29 of file heap_surgery.c.

30 {
HeapTupleForceOption
Definition: heap_surgery.c:30
@ HEAP_FORCE_KILL
Definition: heap_surgery.c:31
@ HEAP_FORCE_FREEZE
Definition: heap_surgery.c:32

Function Documentation

◆ find_tids_one_page()

static BlockNumber find_tids_one_page ( ItemPointer  tids,
int  ntids,
OffsetNumber next_start_ptr 
)
static

Definition at line 395 of file heap_surgery.c.

396 {
397  int i;
398  BlockNumber prev_blkno,
399  blkno;
400 
401  prev_blkno = blkno = InvalidBlockNumber;
402 
403  for (i = *next_start_ptr; i < ntids; i++)
404  {
405  ItemPointerData tid = tids[i];
406 
407  blkno = ItemPointerGetBlockNumberNoCheck(&tid);
408 
409  if (i == *next_start_ptr)
410  prev_blkno = blkno;
411 
412  if (prev_blkno != blkno)
413  break;
414  }
415 
416  *next_start_ptr = i;
417  return prev_blkno;
418 }
uint32 BlockNumber
Definition: block.h:31
#define InvalidBlockNumber
Definition: block.h:33
int i
Definition: isn.c:73
static BlockNumber ItemPointerGetBlockNumberNoCheck(const ItemPointerData *pointer)
Definition: itemptr.h:93

References i, InvalidBlockNumber, and ItemPointerGetBlockNumberNoCheck().

Referenced by heap_force_common().

◆ heap_force_common()

static Datum heap_force_common ( FunctionCallInfo  fcinfo,
HeapTupleForceOption  heap_force_opt 
)
static

Definition at line 82 of file heap_surgery.c.

83 {
84  Oid relid = PG_GETARG_OID(0);
86  ItemPointer tids;
87  int ntids,
88  nblocks;
89  Relation rel;
90  OffsetNumber curr_start_ptr,
91  next_start_ptr;
92  bool include_this_tid[MaxHeapTuplesPerPage];
93 
94  if (RecoveryInProgress())
95  ereport(ERROR,
96  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
97  errmsg("recovery is in progress"),
98  errhint("heap surgery functions cannot be executed during recovery.")));
99 
100  /* Check inputs. */
101  sanity_check_tid_array(ta, &ntids);
102 
103  rel = relation_open(relid, RowExclusiveLock);
104 
105  /*
106  * Check target relation.
107  */
108  if (!RELKIND_HAS_TABLE_AM(rel->rd_rel->relkind))
109  ereport(ERROR,
110  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
111  errmsg("cannot operate on relation \"%s\"",
113  errdetail_relkind_not_supported(rel->rd_rel->relkind)));
114 
115  if (rel->rd_rel->relam != HEAP_TABLE_AM_OID)
116  ereport(ERROR,
117  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
118  errmsg("only heap AM is supported")));
119 
120  /* Must be owner of the table or superuser. */
121  if (!object_ownercheck(RelationRelationId, RelationGetRelid(rel), GetUserId()))
123  get_relkind_objtype(rel->rd_rel->relkind),
125 
126  tids = ((ItemPointer) ARR_DATA_PTR(ta));
127 
128  /*
129  * If there is more than one TID in the array, sort them so that we can
130  * easily fetch all the TIDs belonging to one particular page from the
131  * array.
132  */
133  if (ntids > 1)
134  qsort((void *) tids, ntids, sizeof(ItemPointerData), tidcmp);
135 
136  curr_start_ptr = next_start_ptr = 0;
137  nblocks = RelationGetNumberOfBlocks(rel);
138 
139  /*
140  * Loop, performing the necessary actions for each block.
141  */
142  while (next_start_ptr != ntids)
143  {
144  Buffer buf;
145  Buffer vmbuf = InvalidBuffer;
146  Page page;
147  BlockNumber blkno;
148  OffsetNumber curoff;
149  OffsetNumber maxoffset;
150  int i;
151  bool did_modify_page = false;
152  bool did_modify_vm = false;
153 
155 
156  /*
157  * Find all the TIDs belonging to one particular page starting from
158  * next_start_ptr and process them one by one.
159  */
160  blkno = find_tids_one_page(tids, ntids, &next_start_ptr);
161 
162  /* Check whether the block number is valid. */
163  if (blkno >= nblocks)
164  {
165  /* Update the current_start_ptr before moving to the next page. */
166  curr_start_ptr = next_start_ptr;
167 
168  ereport(NOTICE,
169  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
170  errmsg("skipping block %u for relation \"%s\" because the block number is out of range",
171  blkno, RelationGetRelationName(rel))));
172  continue;
173  }
174 
175  buf = ReadBuffer(rel, blkno);
177 
178  page = BufferGetPage(buf);
179 
180  maxoffset = PageGetMaxOffsetNumber(page);
181 
182  /*
183  * Figure out which TIDs we are going to process and which ones we are
184  * going to skip.
185  */
186  memset(include_this_tid, 0, sizeof(include_this_tid));
187  for (i = curr_start_ptr; i < next_start_ptr; i++)
188  {
190  ItemId itemid;
191 
192  /* Check whether the offset number is valid. */
193  if (offno == InvalidOffsetNumber || offno > maxoffset)
194  {
195  ereport(NOTICE,
196  errmsg("skipping tid (%u, %u) for relation \"%s\" because the item number is out of range",
197  blkno, offno, RelationGetRelationName(rel)));
198  continue;
199  }
200 
201  itemid = PageGetItemId(page, offno);
202 
203  /* Only accept an item ID that is used. */
204  if (ItemIdIsRedirected(itemid))
205  {
206  ereport(NOTICE,
207  errmsg("skipping tid (%u, %u) for relation \"%s\" because it redirects to item %u",
208  blkno, offno, RelationGetRelationName(rel),
209  ItemIdGetRedirect(itemid)));
210  continue;
211  }
212  else if (ItemIdIsDead(itemid))
213  {
214  ereport(NOTICE,
215  (errmsg("skipping tid (%u, %u) for relation \"%s\" because it is marked dead",
216  blkno, offno, RelationGetRelationName(rel))));
217  continue;
218  }
219  else if (!ItemIdIsUsed(itemid))
220  {
221  ereport(NOTICE,
222  (errmsg("skipping tid (%u, %u) for relation \"%s\" because it is marked unused",
223  blkno, offno, RelationGetRelationName(rel))));
224  continue;
225  }
226 
227  /* Mark it for processing. */
228  Assert(offno < MaxHeapTuplesPerPage);
229  include_this_tid[offno] = true;
230  }
231 
232  /*
233  * Before entering the critical section, pin the visibility map page
234  * if it appears to be necessary.
235  */
236  if (heap_force_opt == HEAP_FORCE_KILL && PageIsAllVisible(page))
237  visibilitymap_pin(rel, blkno, &vmbuf);
238 
239  /* No ereport(ERROR) from here until all the changes are logged. */
241 
242  for (curoff = FirstOffsetNumber; curoff <= maxoffset;
243  curoff = OffsetNumberNext(curoff))
244  {
245  ItemId itemid;
246 
247  if (!include_this_tid[curoff])
248  continue;
249 
250  itemid = PageGetItemId(page, curoff);
251  Assert(ItemIdIsNormal(itemid));
252 
253  did_modify_page = true;
254 
255  if (heap_force_opt == HEAP_FORCE_KILL)
256  {
257  ItemIdSetDead(itemid);
258 
259  /*
260  * If the page is marked all-visible, we must clear
261  * PD_ALL_VISIBLE flag on the page header and an all-visible
262  * bit on the visibility map corresponding to the page.
263  */
264  if (PageIsAllVisible(page))
265  {
266  PageClearAllVisible(page);
267  visibilitymap_clear(rel, blkno, vmbuf,
269  did_modify_vm = true;
270  }
271  }
272  else
273  {
274  HeapTupleHeader htup;
275 
276  Assert(heap_force_opt == HEAP_FORCE_FREEZE);
277 
278  htup = (HeapTupleHeader) PageGetItem(page, itemid);
279 
280  /*
281  * Reset all visibility-related fields of the tuple. This
282  * logic should mimic heap_execute_freeze_tuple(), but we
283  * choose to reset xmin and ctid just to be sure that no
284  * potentially-garbled data is left behind.
285  */
286  ItemPointerSet(&htup->t_ctid, blkno, curoff);
289  if (htup->t_infomask & HEAP_MOVED)
290  {
291  if (htup->t_infomask & HEAP_MOVED_OFF)
293  else
295  }
296 
297  /*
298  * Clear all the visibility-related bits of this tuple and
299  * mark it as frozen. Also, get rid of HOT_UPDATED and
300  * KEYS_UPDATES bits.
301  */
302  htup->t_infomask &= ~HEAP_XACT_MASK;
304  htup->t_infomask2 &= ~HEAP_HOT_UPDATED;
305  htup->t_infomask2 &= ~HEAP_KEYS_UPDATED;
306  }
307  }
308 
309  /*
310  * If the page was modified, only then, we mark the buffer dirty or do
311  * the WAL logging.
312  */
313  if (did_modify_page)
314  {
315  /* Mark buffer dirty before we write WAL. */
317 
318  /* XLOG stuff */
319  if (RelationNeedsWAL(rel))
320  log_newpage_buffer(buf, true);
321  }
322 
323  /* WAL log the VM page if it was modified. */
324  if (did_modify_vm && RelationNeedsWAL(rel))
325  log_newpage_buffer(vmbuf, false);
326 
328 
330 
331  if (vmbuf != InvalidBuffer)
332  ReleaseBuffer(vmbuf);
333 
334  /* Update the current_start_ptr before moving to the next page. */
335  curr_start_ptr = next_start_ptr;
336  }
337 
339 
340  pfree(ta);
341 
342  PG_RETURN_VOID();
343 }
@ ACLCHECK_NOT_OWNER
Definition: acl.h:186
void aclcheck_error(AclResult aclerr, ObjectType objtype, const char *objectname)
Definition: aclchk.c:3485
bool object_ownercheck(Oid classid, Oid objectid, Oid roleid)
Definition: aclchk.c:4799
#define PG_GETARG_ARRAYTYPE_P_COPY(n)
Definition: array.h:257
#define ARR_DATA_PTR(a)
Definition: array.h:315
int Buffer
Definition: buf.h:23
#define InvalidBuffer
Definition: buf.h:25
void ReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3931
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3954
void MarkBufferDirty(Buffer buffer)
Definition: bufmgr.c:1583
void LockBufferForCleanup(Buffer buffer)
Definition: bufmgr.c:4229
Buffer ReadBuffer(Relation reln, BlockNumber blockNum)
Definition: bufmgr.c:712
#define RelationGetNumberOfBlocks(reln)
Definition: bufmgr.h:156
static Page BufferGetPage(Buffer buffer)
Definition: bufmgr.h:280
Pointer Page
Definition: bufpage.h:78
static Item PageGetItem(Page page, ItemId itemId)
Definition: bufpage.h:351
static void PageClearAllVisible(Page page)
Definition: bufpage.h:436
static ItemId PageGetItemId(Page page, OffsetNumber offsetNumber)
Definition: bufpage.h:240
static bool PageIsAllVisible(Page page)
Definition: bufpage.h:426
static OffsetNumber PageGetMaxOffsetNumber(Page page)
Definition: bufpage.h:369
int errhint(const char *fmt,...)
Definition: elog.c:1153
int errcode(int sqlerrcode)
Definition: elog.c:695
int errmsg(const char *fmt,...)
Definition: elog.c:906
#define ERROR
Definition: elog.h:35
#define NOTICE
Definition: elog.h:31
#define ereport(elevel,...)
Definition: elog.h:145
#define PG_RETURN_VOID()
Definition: fmgr.h:349
#define PG_GETARG_OID(n)
Definition: fmgr.h:275
static int32 tidcmp(const void *a, const void *b)
Definition: heap_surgery.c:354
static BlockNumber find_tids_one_page(ItemPointer tids, int ntids, OffsetNumber *next_start_ptr)
Definition: heap_surgery.c:395
static void sanity_check_tid_array(ArrayType *ta, int *ntids)
Definition: heap_surgery.c:370
HeapTupleHeaderData * HeapTupleHeader
Definition: htup.h:23
#define HEAP_MOVED_OFF
Definition: htup_details.h:210
#define HEAP_XMIN_FROZEN
Definition: htup_details.h:205
#define HEAP_KEYS_UPDATED
Definition: htup_details.h:274
#define HEAP_HOT_UPDATED
Definition: htup_details.h:275
#define HeapTupleHeaderSetXmin(tup, xid)
Definition: htup_details.h:314
#define HeapTupleHeaderSetXmax(tup, xid)
Definition: htup_details.h:375
#define HeapTupleHeaderSetXvac(tup, xid)
Definition: htup_details.h:418
#define HEAP_MOVED
Definition: htup_details.h:212
#define HEAP_XACT_MASK
Definition: htup_details.h:214
#define HEAP_XMAX_INVALID
Definition: htup_details.h:207
#define MaxHeapTuplesPerPage
Definition: htup_details.h:568
#define ItemIdIsNormal(itemId)
Definition: itemid.h:99
#define ItemIdGetRedirect(itemId)
Definition: itemid.h:78
#define ItemIdIsDead(itemId)
Definition: itemid.h:113
#define ItemIdSetDead(itemId)
Definition: itemid.h:164
#define ItemIdIsUsed(itemId)
Definition: itemid.h:92
#define ItemIdIsRedirected(itemId)
Definition: itemid.h:106
static void ItemPointerSet(ItemPointerData *pointer, BlockNumber blockNumber, OffsetNumber offNum)
Definition: itemptr.h:135
static OffsetNumber ItemPointerGetOffsetNumberNoCheck(const ItemPointerData *pointer)
Definition: itemptr.h:114
ItemPointerData * ItemPointer
Definition: itemptr.h:49
Assert(fmt[strlen(fmt) - 1] !='\n')
#define RowExclusiveLock
Definition: lockdefs.h:38
void pfree(void *pointer)
Definition: mcxt.c:1306
#define START_CRIT_SECTION()
Definition: miscadmin.h:148
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:121
#define END_CRIT_SECTION()
Definition: miscadmin.h:150
Oid GetUserId(void)
Definition: miscinit.c:497
ObjectType get_relkind_objtype(char relkind)
#define InvalidOffsetNumber
Definition: off.h:26
#define OffsetNumberNext(offsetNumber)
Definition: off.h:52
uint16 OffsetNumber
Definition: off.h:24
#define FirstOffsetNumber
Definition: off.h:27
int errdetail_relkind_not_supported(char relkind)
Definition: pg_class.c:24
static char * buf
Definition: pg_test_fsync.c:67
#define qsort(a, b, c, d)
Definition: port.h:445
unsigned int Oid
Definition: postgres_ext.h:31
#define RelationGetRelid(relation)
Definition: rel.h:501
#define RelationGetRelationName(relation)
Definition: rel.h:535
#define RelationNeedsWAL(relation)
Definition: rel.h:626
void relation_close(Relation relation, LOCKMODE lockmode)
Definition: relation.c:206
Relation relation_open(Oid relationId, LOCKMODE lockmode)
Definition: relation.c:48
ItemPointerData t_ctid
Definition: htup_details.h:160
Form_pg_class rd_rel
Definition: rel.h:110
#define FrozenTransactionId
Definition: transam.h:33
#define InvalidTransactionId
Definition: transam.h:31
bool visibilitymap_clear(Relation rel, BlockNumber heapBlk, Buffer vmbuf, uint8 flags)
void visibilitymap_pin(Relation rel, BlockNumber heapBlk, Buffer *vmbuf)
#define VISIBILITYMAP_VALID_BITS
bool RecoveryInProgress(void)
Definition: xlog.c:5912
XLogRecPtr log_newpage_buffer(Buffer buffer, bool page_std)
Definition: xloginsert.c:1191

References aclcheck_error(), ACLCHECK_NOT_OWNER, ARR_DATA_PTR, Assert(), buf, BufferGetPage(), CHECK_FOR_INTERRUPTS, END_CRIT_SECTION, ereport, errcode(), errdetail_relkind_not_supported(), errhint(), errmsg(), ERROR, find_tids_one_page(), FirstOffsetNumber, FrozenTransactionId, get_relkind_objtype(), GetUserId(), HEAP_FORCE_FREEZE, HEAP_FORCE_KILL, HEAP_HOT_UPDATED, HEAP_KEYS_UPDATED, HEAP_MOVED, HEAP_MOVED_OFF, HEAP_XACT_MASK, HEAP_XMAX_INVALID, HEAP_XMIN_FROZEN, HeapTupleHeaderSetXmax, HeapTupleHeaderSetXmin, HeapTupleHeaderSetXvac, i, InvalidBuffer, InvalidOffsetNumber, InvalidTransactionId, ItemIdGetRedirect, ItemIdIsDead, ItemIdIsNormal, ItemIdIsRedirected, ItemIdIsUsed, ItemIdSetDead, ItemPointerGetOffsetNumberNoCheck(), ItemPointerSet(), LockBufferForCleanup(), log_newpage_buffer(), MarkBufferDirty(), MaxHeapTuplesPerPage, NOTICE, object_ownercheck(), OffsetNumberNext, PageClearAllVisible(), PageGetItem(), PageGetItemId(), PageGetMaxOffsetNumber(), PageIsAllVisible(), pfree(), PG_GETARG_ARRAYTYPE_P_COPY, PG_GETARG_OID, PG_RETURN_VOID, qsort, RelationData::rd_rel, ReadBuffer(), RecoveryInProgress(), relation_close(), relation_open(), RelationGetNumberOfBlocks, RelationGetRelationName, RelationGetRelid, RelationNeedsWAL, ReleaseBuffer(), RowExclusiveLock, sanity_check_tid_array(), START_CRIT_SECTION, HeapTupleHeaderData::t_ctid, HeapTupleHeaderData::t_infomask, HeapTupleHeaderData::t_infomask2, tidcmp(), UnlockReleaseBuffer(), visibilitymap_clear(), visibilitymap_pin(), and VISIBILITYMAP_VALID_BITS.

Referenced by heap_force_freeze(), and heap_force_kill().

◆ heap_force_freeze()

Datum heap_force_freeze ( PG_FUNCTION_ARGS  )

Definition at line 70 of file heap_surgery.c.

71 {
73 }
#define PG_RETURN_DATUM(x)
Definition: fmgr.h:353
static Datum heap_force_common(FunctionCallInfo fcinfo, HeapTupleForceOption heap_force_opt)
Definition: heap_surgery.c:82

References heap_force_common(), HEAP_FORCE_FREEZE, and PG_RETURN_DATUM.

◆ heap_force_kill()

Datum heap_force_kill ( PG_FUNCTION_ARGS  )

Definition at line 55 of file heap_surgery.c.

56 {
58 }

References heap_force_common(), HEAP_FORCE_KILL, and PG_RETURN_DATUM.

◆ PG_FUNCTION_INFO_V1() [1/2]

PG_FUNCTION_INFO_V1 ( heap_force_freeze  )

◆ PG_FUNCTION_INFO_V1() [2/2]

PG_FUNCTION_INFO_V1 ( heap_force_kill  )

◆ sanity_check_tid_array()

static void sanity_check_tid_array ( ArrayType ta,
int *  ntids 
)
static

Definition at line 370 of file heap_surgery.c.

371 {
372  if (ARR_HASNULL(ta) && array_contains_nulls(ta))
373  ereport(ERROR,
374  (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
375  errmsg("array must not contain nulls")));
376 
377  if (ARR_NDIM(ta) > 1)
378  ereport(ERROR,
379  (errcode(ERRCODE_DATA_EXCEPTION),
380  errmsg("argument must be empty or one-dimensional array")));
381 
382  *ntids = ArrayGetNItems(ARR_NDIM(ta), ARR_DIMS(ta));
383 }
#define ARR_NDIM(a)
Definition: array.h:283
#define ARR_DIMS(a)
Definition: array.h:287
#define ARR_HASNULL(a)
Definition: array.h:284
bool array_contains_nulls(ArrayType *array)
Definition: arrayfuncs.c:3712
int ArrayGetNItems(int ndim, const int *dims)
Definition: arrayutils.c:76

References ARR_DIMS, ARR_HASNULL, ARR_NDIM, array_contains_nulls(), ArrayGetNItems(), ereport, errcode(), errmsg(), and ERROR.

Referenced by heap_force_common().

◆ tidcmp()

static int32 tidcmp ( const void *  a,
const void *  b 
)
static

Definition at line 354 of file heap_surgery.c.

355 {
356  ItemPointer iptr1 = ((const ItemPointer) a);
357  ItemPointer iptr2 = ((const ItemPointer) b);
358 
359  return ItemPointerCompare(iptr1, iptr2);
360 }
int b
Definition: isn.c:70
int a
Definition: isn.c:69
int32 ItemPointerCompare(ItemPointer arg1, ItemPointer arg2)
Definition: itemptr.c:52

References a, b, and ItemPointerCompare().

Referenced by heap_force_common().

Variable Documentation

◆ PG_MODULE_MAGIC

PG_MODULE_MAGIC

Definition at line 26 of file heap_surgery.c.