PostgreSQL Source Code  git master
brin.h File Reference
#include "nodes/execnodes.h"
#include "storage/shm_toc.h"
#include "utils/relcache.h"
Include dependency graph for brin.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  BrinOptions
 
struct  BrinStatsData
 

Macros

#define BRIN_DEFAULT_PAGES_PER_RANGE   128
 
#define BrinGetPagesPerRange(relation)
 
#define BrinGetAutoSummarize(relation)
 

Typedefs

typedef struct BrinOptions BrinOptions
 
typedef struct BrinStatsData BrinStatsData
 

Functions

void brinGetStats (Relation index, BrinStatsData *stats)
 
void _brin_parallel_build_main (dsm_segment *seg, shm_toc *toc)
 

Macro Definition Documentation

◆ BRIN_DEFAULT_PAGES_PER_RANGE

#define BRIN_DEFAULT_PAGES_PER_RANGE   128

Definition at line 39 of file brin.h.

◆ BrinGetAutoSummarize

#define BrinGetAutoSummarize (   relation)
Value:
(AssertMacro(relation->rd_rel->relkind == RELKIND_INDEX && \
relation->rd_rel->relam == BRIN_AM_OID), \
(relation)->rd_options ? \
((BrinOptions *) (relation)->rd_options)->autosummarize : \
false)
#define AssertMacro(condition)
Definition: c.h:859

Definition at line 46 of file brin.h.

◆ BrinGetPagesPerRange

#define BrinGetPagesPerRange (   relation)
Value:
(AssertMacro(relation->rd_rel->relkind == RELKIND_INDEX && \
relation->rd_rel->relam == BRIN_AM_OID), \
(relation)->rd_options ? \
((BrinOptions *) (relation)->rd_options)->pagesPerRange : \
BRIN_DEFAULT_PAGES_PER_RANGE)

Definition at line 40 of file brin.h.

Typedef Documentation

◆ BrinOptions

typedef struct BrinOptions BrinOptions

◆ BrinStatsData

typedef struct BrinStatsData BrinStatsData

Function Documentation

◆ _brin_parallel_build_main()

void _brin_parallel_build_main ( dsm_segment seg,
shm_toc toc 
)

Definition at line 2851 of file brin.c.

2852 {
2853  char *sharedquery;
2854  BrinShared *brinshared;
2855  Sharedsort *sharedsort;
2856  BrinBuildState *buildstate;
2857  Relation heapRel;
2858  Relation indexRel;
2859  LOCKMODE heapLockmode;
2860  LOCKMODE indexLockmode;
2861  WalUsage *walusage;
2862  BufferUsage *bufferusage;
2863  int sortmem;
2864 
2865  /*
2866  * The only possible status flag that can be set to the parallel worker is
2867  * PROC_IN_SAFE_IC.
2868  */
2869  Assert((MyProc->statusFlags == 0) ||
2871 
2872  /* Set debug_query_string for individual workers first */
2873  sharedquery = shm_toc_lookup(toc, PARALLEL_KEY_QUERY_TEXT, true);
2874  debug_query_string = sharedquery;
2875 
2876  /* Report the query string from leader */
2878 
2879  /* Look up brin shared state */
2880  brinshared = shm_toc_lookup(toc, PARALLEL_KEY_BRIN_SHARED, false);
2881 
2882  /* Open relations using lock modes known to be obtained by index.c */
2883  if (!brinshared->isconcurrent)
2884  {
2885  heapLockmode = ShareLock;
2886  indexLockmode = AccessExclusiveLock;
2887  }
2888  else
2889  {
2890  heapLockmode = ShareUpdateExclusiveLock;
2891  indexLockmode = RowExclusiveLock;
2892  }
2893 
2894  /* Open relations within worker */
2895  heapRel = table_open(brinshared->heaprelid, heapLockmode);
2896  indexRel = index_open(brinshared->indexrelid, indexLockmode);
2897 
2898  buildstate = initialize_brin_buildstate(indexRel, NULL,
2899  brinshared->pagesPerRange,
2901 
2902  /* Look up shared state private to tuplesort.c */
2903  sharedsort = shm_toc_lookup(toc, PARALLEL_KEY_TUPLESORT, false);
2904  tuplesort_attach_shared(sharedsort, seg);
2905 
2906  /* Prepare to track buffer usage during parallel execution */
2908 
2909  /*
2910  * Might as well use reliable figure when doling out maintenance_work_mem
2911  * (when requested number of workers were not launched, this will be
2912  * somewhat higher than it is for other workers).
2913  */
2914  sortmem = maintenance_work_mem / brinshared->scantuplesortstates;
2915 
2916  _brin_parallel_scan_and_build(buildstate, brinshared, sharedsort,
2917  heapRel, indexRel, sortmem, false);
2918 
2919  /* Report WAL/buffer usage during parallel execution */
2920  bufferusage = shm_toc_lookup(toc, PARALLEL_KEY_BUFFER_USAGE, false);
2921  walusage = shm_toc_lookup(toc, PARALLEL_KEY_WAL_USAGE, false);
2923  &walusage[ParallelWorkerNumber]);
2924 
2925  index_close(indexRel, indexLockmode);
2926  table_close(heapRel, heapLockmode);
2927 }
int ParallelWorkerNumber
Definition: parallel.c:112
void pgstat_report_activity(BackendState state, const char *cmd_str)
@ STATE_RUNNING
#define InvalidBlockNumber
Definition: block.h:33
#define PARALLEL_KEY_BUFFER_USAGE
Definition: brin.c:51
#define PARALLEL_KEY_BRIN_SHARED
Definition: brin.c:47
static BrinBuildState * initialize_brin_buildstate(Relation idxRel, BrinRevmap *revmap, BlockNumber pagesPerRange, BlockNumber tablePages)
Definition: brin.c:1658
static void _brin_parallel_scan_and_build(BrinBuildState *buildstate, BrinShared *brinshared, Sharedsort *sharedsort, Relation heap, Relation index, int sortmem, bool progress)
Definition: brin.c:2794
#define PARALLEL_KEY_TUPLESORT
Definition: brin.c:48
#define PARALLEL_KEY_QUERY_TEXT
Definition: brin.c:49
#define PARALLEL_KEY_WAL_USAGE
Definition: brin.c:50
#define Assert(condition)
Definition: c.h:858
int maintenance_work_mem
Definition: globals.c:130
void index_close(Relation relation, LOCKMODE lockmode)
Definition: indexam.c:177
Relation index_open(Oid relationId, LOCKMODE lockmode)
Definition: indexam.c:133
void InstrEndParallelQuery(BufferUsage *bufusage, WalUsage *walusage)
Definition: instrument.c:208
void InstrStartParallelQuery(void)
Definition: instrument.c:200
int LOCKMODE
Definition: lockdefs.h:26
#define AccessExclusiveLock
Definition: lockdefs.h:43
#define ShareUpdateExclusiveLock
Definition: lockdefs.h:39
#define ShareLock
Definition: lockdefs.h:40
#define RowExclusiveLock
Definition: lockdefs.h:38
const char * debug_query_string
Definition: postgres.c:87
#define PROC_IN_SAFE_IC
Definition: proc.h:59
void * shm_toc_lookup(shm_toc *toc, uint64 key, bool noError)
Definition: shm_toc.c:232
PGPROC * MyProc
Definition: proc.c:66
int scantuplesortstates
Definition: brin.c:68
Oid heaprelid
Definition: brin.c:64
BlockNumber pagesPerRange
Definition: brin.c:67
Oid indexrelid
Definition: brin.c:65
bool isconcurrent
Definition: brin.c:66
uint8 statusFlags
Definition: proc.h:238
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:126
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:40
void tuplesort_attach_shared(Sharedsort *shared, dsm_segment *seg)
Definition: tuplesort.c:2999

References _brin_parallel_scan_and_build(), AccessExclusiveLock, Assert, debug_query_string, BrinShared::heaprelid, index_close(), index_open(), BrinShared::indexrelid, initialize_brin_buildstate(), InstrEndParallelQuery(), InstrStartParallelQuery(), InvalidBlockNumber, BrinShared::isconcurrent, maintenance_work_mem, MyProc, BrinShared::pagesPerRange, PARALLEL_KEY_BRIN_SHARED, PARALLEL_KEY_BUFFER_USAGE, PARALLEL_KEY_QUERY_TEXT, PARALLEL_KEY_TUPLESORT, PARALLEL_KEY_WAL_USAGE, ParallelWorkerNumber, pgstat_report_activity(), PROC_IN_SAFE_IC, RowExclusiveLock, BrinShared::scantuplesortstates, ShareLock, ShareUpdateExclusiveLock, shm_toc_lookup(), STATE_RUNNING, PGPROC::statusFlags, table_close(), table_open(), and tuplesort_attach_shared().

◆ brinGetStats()

void brinGetStats ( Relation  index,
BrinStatsData stats 
)

Definition at line 1637 of file brin.c.

1638 {
1639  Buffer metabuffer;
1640  Page metapage;
1641  BrinMetaPageData *metadata;
1642 
1643  metabuffer = ReadBuffer(index, BRIN_METAPAGE_BLKNO);
1644  LockBuffer(metabuffer, BUFFER_LOCK_SHARE);
1645  metapage = BufferGetPage(metabuffer);
1646  metadata = (BrinMetaPageData *) PageGetContents(metapage);
1647 
1648  stats->pagesPerRange = metadata->pagesPerRange;
1649  stats->revmapNumPages = metadata->lastRevmapPage - 1;
1650 
1651  UnlockReleaseBuffer(metabuffer);
1652 }
#define BRIN_METAPAGE_BLKNO
Definition: brin_page.h:75
int Buffer
Definition: buf.h:23
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:4867
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:5085
Buffer ReadBuffer(Relation reln, BlockNumber blockNum)
Definition: bufmgr.c:745
#define BUFFER_LOCK_SHARE
Definition: bufmgr.h:194
static Page BufferGetPage(Buffer buffer)
Definition: bufmgr.h:404
static char * PageGetContents(Page page)
Definition: bufpage.h:254
Pointer Page
Definition: bufpage.h:78
BlockNumber lastRevmapPage
Definition: brin_page.h:69
BlockNumber pagesPerRange
Definition: brin_page.h:68
BlockNumber revmapNumPages
Definition: brin.h:35
BlockNumber pagesPerRange
Definition: brin.h:34
Definition: type.h:95

References BRIN_METAPAGE_BLKNO, BUFFER_LOCK_SHARE, BufferGetPage(), BrinMetaPageData::lastRevmapPage, LockBuffer(), PageGetContents(), BrinStatsData::pagesPerRange, BrinMetaPageData::pagesPerRange, ReadBuffer(), BrinStatsData::revmapNumPages, and UnlockReleaseBuffer().

Referenced by brincostestimate().