PostgreSQL Source Code  git master
gistxlog.h File Reference
#include "access/gist.h"
#include "access/xlogreader.h"
#include "lib/stringinfo.h"
Include dependency graph for gistxlog.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  gistxlogPageUpdate
 
struct  gistxlogDelete
 
struct  gistxlogPageSplit
 
struct  gistxlogPageDelete
 
struct  gistxlogPageReuse
 

Macros

#define XLOG_GIST_PAGE_UPDATE   0x00
 
#define XLOG_GIST_DELETE
 
#define XLOG_GIST_PAGE_REUSE
 
#define XLOG_GIST_PAGE_SPLIT   0x30
 
#define XLOG_GIST_PAGE_DELETE   0x60
 
#define XLOG_GIST_ASSIGN_LSN   0x70 /* nop, assign new LSN */
 
#define SizeOfGistxlogDelete   (offsetof(gistxlogDelete, ntodelete) + sizeof(uint16))
 
#define SizeOfGistxlogPageDelete   (offsetof(gistxlogPageDelete, downlinkOffset) + sizeof(OffsetNumber))
 
#define SizeOfGistxlogPageReuse   (offsetof(gistxlogPageReuse, latestRemovedFullXid) + sizeof(FullTransactionId))
 

Typedefs

typedef struct gistxlogPageUpdate gistxlogPageUpdate
 
typedef struct gistxlogDelete gistxlogDelete
 
typedef struct gistxlogPageSplit gistxlogPageSplit
 
typedef struct gistxlogPageDelete gistxlogPageDelete
 
typedef struct gistxlogPageReuse gistxlogPageReuse
 

Functions

void gist_redo (XLogReaderState *record)
 
void gist_desc (StringInfo buf, XLogReaderState *record)
 
const char * gist_identify (uint8 info)
 
void gist_xlog_startup (void)
 
void gist_xlog_cleanup (void)
 
void gist_mask (char *pagedata, BlockNumber blkno)
 

Macro Definition Documentation

◆ SizeOfGistxlogDelete

#define SizeOfGistxlogDelete   (offsetof(gistxlogDelete, ntodelete) + sizeof(uint16))

Definition at line 60 of file gistxlog.h.

Referenced by gistRedoDeleteRecord(), and gistXLogDelete().

◆ SizeOfGistxlogPageDelete

#define SizeOfGistxlogPageDelete   (offsetof(gistxlogPageDelete, downlinkOffset) + sizeof(OffsetNumber))

Definition at line 92 of file gistxlog.h.

Referenced by gistXLogPageDelete().

◆ SizeOfGistxlogPageReuse

#define SizeOfGistxlogPageReuse   (offsetof(gistxlogPageReuse, latestRemovedFullXid) + sizeof(FullTransactionId))

Definition at line 105 of file gistxlog.h.

Referenced by gistXLogPageReuse().

◆ XLOG_GIST_ASSIGN_LSN

#define XLOG_GIST_ASSIGN_LSN   0x70 /* nop, assign new LSN */

Definition at line 29 of file gistxlog.h.

Referenced by gist_desc(), gist_identify(), gist_redo(), and gistXLogAssignLSN().

◆ XLOG_GIST_DELETE

#define XLOG_GIST_DELETE
Value:
0x10 /* delete leaf index tuples for a
* page */

Definition at line 21 of file gistxlog.h.

Referenced by gist_desc(), gist_identify(), gist_redo(), and gistXLogDelete().

◆ XLOG_GIST_PAGE_DELETE

#define XLOG_GIST_PAGE_DELETE   0x60

Definition at line 28 of file gistxlog.h.

Referenced by gist_desc(), gist_identify(), gist_redo(), and gistXLogPageDelete().

◆ XLOG_GIST_PAGE_REUSE

#define XLOG_GIST_PAGE_REUSE
Value:
0x20 /* old page is about to be reused
* from FSM */

Definition at line 23 of file gistxlog.h.

Referenced by gist_desc(), gist_identify(), gist_redo(), and gistXLogPageReuse().

◆ XLOG_GIST_PAGE_SPLIT

#define XLOG_GIST_PAGE_SPLIT   0x30

Definition at line 25 of file gistxlog.h.

Referenced by gist_desc(), gist_identify(), gist_redo(), and gistXLogSplit().

◆ XLOG_GIST_PAGE_UPDATE

#define XLOG_GIST_PAGE_UPDATE   0x00

Definition at line 20 of file gistxlog.h.

Referenced by gist_desc(), gist_identify(), gist_redo(), and gistXLogUpdate().

Typedef Documentation

◆ gistxlogDelete

◆ gistxlogPageDelete

◆ gistxlogPageReuse

◆ gistxlogPageSplit

◆ gistxlogPageUpdate

Function Documentation

◆ gist_desc()

void gist_desc ( StringInfo  buf,
XLogReaderState record 
)

Definition at line 61 of file gistdesc.c.

References out_gistxlogDelete(), out_gistxlogPageDelete(), out_gistxlogPageReuse(), out_gistxlogPageSplit(), out_gistxlogPageUpdate(), XLOG_GIST_ASSIGN_LSN, XLOG_GIST_DELETE, XLOG_GIST_PAGE_DELETE, XLOG_GIST_PAGE_REUSE, XLOG_GIST_PAGE_SPLIT, XLOG_GIST_PAGE_UPDATE, XLogRecGetData, XLogRecGetInfo, and XLR_INFO_MASK.

62 {
63  char *rec = XLogRecGetData(record);
64  uint8 info = XLogRecGetInfo(record) & ~XLR_INFO_MASK;
65 
66  switch (info)
67  {
70  break;
73  break;
74  case XLOG_GIST_DELETE:
75  out_gistxlogDelete(buf, (gistxlogDelete *) rec);
76  break;
79  break;
82  break;
84  /* No details to write out */
85  break;
86  }
87 }
static void out_gistxlogPageSplit(StringInfo buf, gistxlogPageSplit *xlrec)
Definition: gistdesc.c:45
unsigned char uint8
Definition: c.h:373
static void out_gistxlogDelete(StringInfo buf, gistxlogDelete *xlrec)
Definition: gistdesc.c:37
#define XLogRecGetData(decoder)
Definition: xlogreader.h:310
#define XLOG_GIST_PAGE_SPLIT
Definition: gistxlog.h:25
static void out_gistxlogPageUpdate(StringInfo buf, gistxlogPageUpdate *xlrec)
Definition: gistdesc.c:22
static void out_gistxlogPageReuse(StringInfo buf, gistxlogPageReuse *xlrec)
Definition: gistdesc.c:27
#define XLOG_GIST_DELETE
Definition: gistxlog.h:21
#define XLogRecGetInfo(decoder)
Definition: xlogreader.h:305
#define XLOG_GIST_PAGE_REUSE
Definition: gistxlog.h:23
#define XLR_INFO_MASK
Definition: xlogrecord.h:62
#define XLOG_GIST_PAGE_DELETE
Definition: gistxlog.h:28
static void out_gistxlogPageDelete(StringInfo buf, gistxlogPageDelete *xlrec)
Definition: gistdesc.c:52
#define XLOG_GIST_PAGE_UPDATE
Definition: gistxlog.h:20
#define XLOG_GIST_ASSIGN_LSN
Definition: gistxlog.h:29

◆ gist_identify()

const char* gist_identify ( uint8  info)

Definition at line 90 of file gistdesc.c.

References XLOG_GIST_ASSIGN_LSN, XLOG_GIST_DELETE, XLOG_GIST_PAGE_DELETE, XLOG_GIST_PAGE_REUSE, XLOG_GIST_PAGE_SPLIT, XLOG_GIST_PAGE_UPDATE, and XLR_INFO_MASK.

91 {
92  const char *id = NULL;
93 
94  switch (info & ~XLR_INFO_MASK)
95  {
97  id = "PAGE_UPDATE";
98  break;
99  case XLOG_GIST_DELETE:
100  id = "DELETE";
101  break;
103  id = "PAGE_REUSE";
104  break;
106  id = "PAGE_SPLIT";
107  break;
109  id = "PAGE_DELETE";
110  break;
112  id = "ASSIGN_LSN";
113  break;
114  }
115 
116  return id;
117 }
#define XLOG_GIST_PAGE_SPLIT
Definition: gistxlog.h:25
#define XLOG_GIST_DELETE
Definition: gistxlog.h:21
#define XLOG_GIST_PAGE_REUSE
Definition: gistxlog.h:23
#define XLR_INFO_MASK
Definition: xlogrecord.h:62
#define XLOG_GIST_PAGE_DELETE
Definition: gistxlog.h:28
#define XLOG_GIST_PAGE_UPDATE
Definition: gistxlog.h:20
#define XLOG_GIST_ASSIGN_LSN
Definition: gistxlog.h:29

◆ gist_mask()

void gist_mask ( char *  pagedata,
BlockNumber  blkno 
)

Definition at line 478 of file gistxlog.c.

References GistClearPageHasGarbage, GistMarkFollowRight, GistPageIsLeaf, GistPageSetNSN, mask_lp_flags(), MASK_MARKER, mask_page_hint_bits(), mask_page_lsn_and_checksum(), mask_unused_space(), and GistSortedBuildPageState::page.

479 {
480  Page page = (Page) pagedata;
481 
483 
484  mask_page_hint_bits(page);
485  mask_unused_space(page);
486 
487  /*
488  * NSN is nothing but a special purpose LSN. Hence, mask it for the same
489  * reason as mask_page_lsn_and_checksum.
490  */
491  GistPageSetNSN(page, (uint64) MASK_MARKER);
492 
493  /*
494  * We update F_FOLLOW_RIGHT flag on the left child after writing WAL
495  * record. Hence, mask this flag. See gistplacetopage() for details.
496  */
497  GistMarkFollowRight(page);
498 
499  if (GistPageIsLeaf(page))
500  {
501  /*
502  * In gist leaf pages, it is possible to modify the LP_FLAGS without
503  * emitting any WAL record. Hence, mask the line pointer flags. See
504  * gistkillitems() for details.
505  */
506  mask_lp_flags(page);
507  }
508 
509  /*
510  * During gist redo, we never mark a page as garbage. Hence, mask it to
511  * ignore any differences.
512  */
514 }
#define GistClearPageHasGarbage(page)
Definition: gist.h:172
void mask_page_hint_bits(Page page)
Definition: bufmask.c:46
#define GistPageSetNSN(page, val)
Definition: gist.h:179
void mask_unused_space(Page page)
Definition: bufmask.c:71
#define MASK_MARKER
Definition: bufmask.h:24
#define GistPageIsLeaf(page)
Definition: gist.h:161
void mask_page_lsn_and_checksum(Page page)
Definition: bufmask.c:31
#define GistMarkFollowRight(page)
Definition: gist.h:175
void mask_lp_flags(Page page)
Definition: bufmask.c:95
Pointer Page
Definition: bufpage.h:78

◆ gist_redo()

void gist_redo ( XLogReaderState record)

Definition at line 422 of file gistxlog.c.

References elog, gistRedoDeleteRecord(), gistRedoPageDelete(), gistRedoPageReuse(), gistRedoPageSplitRecord(), gistRedoPageUpdateRecord(), MemoryContextReset(), MemoryContextSwitchTo(), PANIC, XLOG_GIST_ASSIGN_LSN, XLOG_GIST_DELETE, XLOG_GIST_PAGE_DELETE, XLOG_GIST_PAGE_REUSE, XLOG_GIST_PAGE_SPLIT, XLOG_GIST_PAGE_UPDATE, XLogRecGetInfo, and XLR_INFO_MASK.

423 {
424  uint8 info = XLogRecGetInfo(record) & ~XLR_INFO_MASK;
425  MemoryContext oldCxt;
426 
427  /*
428  * GiST indexes do not require any conflict processing. NB: If we ever
429  * implement a similar optimization we have in b-tree, and remove killed
430  * tuples outside VACUUM, we'll need to handle that here.
431  */
432 
433  oldCxt = MemoryContextSwitchTo(opCtx);
434  switch (info)
435  {
437  gistRedoPageUpdateRecord(record);
438  break;
439  case XLOG_GIST_DELETE:
440  gistRedoDeleteRecord(record);
441  break;
443  gistRedoPageReuse(record);
444  break;
446  gistRedoPageSplitRecord(record);
447  break;
449  gistRedoPageDelete(record);
450  break;
452  /* nop. See gistGetFakeLSN(). */
453  break;
454  default:
455  elog(PANIC, "gist_redo: unknown op code %u", info);
456  }
457 
458  MemoryContextSwitchTo(oldCxt);
460 }
static void gistRedoPageUpdateRecord(XLogReaderState *record)
Definition: gistxlog.c:72
static void gistRedoPageReuse(XLogReaderState *record)
Definition: gistxlog.c:382
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
unsigned char uint8
Definition: c.h:373
void MemoryContextReset(MemoryContext context)
Definition: mcxt.c:137
#define PANIC
Definition: elog.h:53
static void gistRedoPageDelete(XLogReaderState *record)
Definition: gistxlog.c:348
#define XLOG_GIST_PAGE_SPLIT
Definition: gistxlog.h:25
static void gistRedoPageSplitRecord(XLogReaderState *record)
Definition: gistxlog.c:253
#define XLOG_GIST_DELETE
Definition: gistxlog.h:21
#define XLogRecGetInfo(decoder)
Definition: xlogreader.h:305
#define XLOG_GIST_PAGE_REUSE
Definition: gistxlog.h:23
#define XLR_INFO_MASK
Definition: xlogrecord.h:62
#define XLOG_GIST_PAGE_DELETE
Definition: gistxlog.h:28
static void gistRedoDeleteRecord(XLogReaderState *record)
Definition: gistxlog.c:174
#define elog(elevel,...)
Definition: elog.h:214
static MemoryContext opCtx
Definition: gistxlog.c:28
#define XLOG_GIST_PAGE_UPDATE
Definition: gistxlog.h:20
#define XLOG_GIST_ASSIGN_LSN
Definition: gistxlog.h:29

◆ gist_xlog_cleanup()

void gist_xlog_cleanup ( void  )

Definition at line 469 of file gistxlog.c.

References MemoryContextDelete().

470 {
472 }
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:212
static MemoryContext opCtx
Definition: gistxlog.c:28

◆ gist_xlog_startup()

void gist_xlog_startup ( void  )

Definition at line 463 of file gistxlog.c.

References createTempGistContext().

464 {
466 }
MemoryContext createTempGistContext(void)
Definition: gist.c:119
static MemoryContext opCtx
Definition: gistxlog.c:28