2016-04-01 15:42:24 +02:00
|
|
|
/*-------------------------------------------------------------------------
|
|
|
|
*
|
|
|
|
* bloom.h
|
|
|
|
* Header for bloom index.
|
|
|
|
*
|
2022-01-08 01:04:57 +01:00
|
|
|
* Copyright (c) 2016-2022, PostgreSQL Global Development Group
|
2016-04-01 15:42:24 +02:00
|
|
|
*
|
|
|
|
* IDENTIFICATION
|
|
|
|
* contrib/bloom/bloom.h
|
|
|
|
*
|
|
|
|
*-------------------------------------------------------------------------
|
|
|
|
*/
|
|
|
|
#ifndef _BLOOM_H_
|
|
|
|
#define _BLOOM_H_
|
|
|
|
|
2019-12-27 00:09:00 +01:00
|
|
|
#include "access/amapi.h"
|
2016-04-01 15:42:24 +02:00
|
|
|
#include "access/generic_xlog.h"
|
|
|
|
#include "access/itup.h"
|
|
|
|
#include "access/xlog.h"
|
|
|
|
#include "fmgr.h"
|
2019-11-25 03:38:57 +01:00
|
|
|
#include "nodes/pathnodes.h"
|
2016-04-01 15:42:24 +02:00
|
|
|
|
|
|
|
/* Support procedures numbers */
|
|
|
|
#define BLOOM_HASH_PROC 1
|
Implement operator class parameters
PostgreSQL provides set of template index access methods, where opclasses have
much freedom in the semantics of indexing. These index AMs are GiST, GIN,
SP-GiST and BRIN. There opclasses define representation of keys, operations on
them and supported search strategies. So, it's natural that opclasses may be
faced some tradeoffs, which require user-side decision. This commit implements
opclass parameters allowing users to set some values, which tell opclass how to
index the particular dataset.
This commit doesn't introduce new storage in system catalog. Instead it uses
pg_attribute.attoptions, which is used for table column storage options but
unused for index attributes.
In order to evade changing signature of each opclass support function, we
implement unified way to pass options to opclass support functions. Options
are set to fn_expr as the constant bytea expression. It's possible due to the
fact that opclass support functions are executed outside of expressions, so
fn_expr is unused for them.
This commit comes with some examples of opclass options usage. We parametrize
signature length in GiST. That applies to multiple opclasses: tsvector_ops,
gist__intbig_ops, gist_ltree_ops, gist__ltree_ops, gist_trgm_ops and
gist_hstore_ops. Also we parametrize maximum number of integer ranges for
gist__int_ops. However, the main future usage of this feature is expected
to be json, where users would be able to specify which way to index particular
json parts.
Catversion is bumped.
Discussion: https://postgr.es/m/d22c3a18-31c7-1879-fc11-4c1ce2f5e5af%40postgrespro.ru
Author: Nikita Glukhov, revised by me
Reviwed-by: Nikolay Shaplov, Robert Haas, Tom Lane, Tomas Vondra, Alvaro Herrera
2020-03-30 18:17:11 +02:00
|
|
|
#define BLOOM_OPTIONS_PROC 2
|
|
|
|
#define BLOOM_NPROC 2
|
2016-04-01 15:42:24 +02:00
|
|
|
|
|
|
|
/* Scan strategies */
|
|
|
|
#define BLOOM_EQUAL_STRATEGY 1
|
|
|
|
#define BLOOM_NSTRATEGIES 1
|
|
|
|
|
|
|
|
/* Opaque for bloom pages */
|
|
|
|
typedef struct BloomPageOpaqueData
|
|
|
|
{
|
2016-06-10 00:02:36 +02:00
|
|
|
OffsetNumber maxoff; /* number of index tuples on page */
|
|
|
|
uint16 flags; /* see bit definitions below */
|
|
|
|
uint16 unused; /* placeholder to force maxaligning of size of
|
|
|
|
* BloomPageOpaqueData and to place
|
|
|
|
* bloom_page_id exactly at the end of page */
|
|
|
|
uint16 bloom_page_id; /* for identification of BLOOM indexes */
|
|
|
|
} BloomPageOpaqueData;
|
2016-04-01 15:42:24 +02:00
|
|
|
|
|
|
|
typedef BloomPageOpaqueData *BloomPageOpaque;
|
|
|
|
|
|
|
|
/* Bloom page flags */
|
|
|
|
#define BLOOM_META (1<<0)
|
|
|
|
#define BLOOM_DELETED (2<<0)
|
|
|
|
|
2016-04-12 17:03:01 +02:00
|
|
|
/*
|
|
|
|
* The page ID is for the convenience of pg_filedump and similar utilities,
|
|
|
|
* which otherwise would have a hard time telling pages of different index
|
|
|
|
* types apart. It should be the last 2 bytes on the page. This is more or
|
|
|
|
* less "free" due to alignment considerations.
|
|
|
|
*
|
|
|
|
* See comments above GinPageOpaqueData.
|
|
|
|
*/
|
|
|
|
#define BLOOM_PAGE_ID 0xFF83
|
|
|
|
|
2016-04-01 15:42:24 +02:00
|
|
|
/* Macros for accessing bloom page structures */
|
|
|
|
#define BloomPageGetOpaque(page) ((BloomPageOpaque) PageGetSpecialPointer(page))
|
|
|
|
#define BloomPageGetMaxOffset(page) (BloomPageGetOpaque(page)->maxoff)
|
2016-04-01 19:09:13 +02:00
|
|
|
#define BloomPageIsMeta(page) \
|
|
|
|
((BloomPageGetOpaque(page)->flags & BLOOM_META) != 0)
|
|
|
|
#define BloomPageIsDeleted(page) \
|
|
|
|
((BloomPageGetOpaque(page)->flags & BLOOM_DELETED) != 0)
|
|
|
|
#define BloomPageSetDeleted(page) \
|
|
|
|
(BloomPageGetOpaque(page)->flags |= BLOOM_DELETED)
|
|
|
|
#define BloomPageSetNonDeleted(page) \
|
|
|
|
(BloomPageGetOpaque(page)->flags &= ~BLOOM_DELETED)
|
2016-04-01 15:42:24 +02:00
|
|
|
#define BloomPageGetData(page) ((BloomTuple *)PageGetContents(page))
|
|
|
|
#define BloomPageGetTuple(state, page, offset) \
|
|
|
|
((BloomTuple *)(PageGetContents(page) \
|
|
|
|
+ (state)->sizeOfBloomTuple * ((offset) - 1)))
|
|
|
|
#define BloomPageGetNextTuple(state, tuple) \
|
|
|
|
((BloomTuple *)((Pointer)(tuple) + (state)->sizeOfBloomTuple))
|
|
|
|
|
|
|
|
/* Preserved page numbers */
|
|
|
|
#define BLOOM_METAPAGE_BLKNO (0)
|
Phase 2 of pgindent updates.
Change pg_bsd_indent to follow upstream rules for placement of comments
to the right of code, and remove pgindent hack that caused comments
following #endif to not obey the general rule.
Commit e3860ffa4dd0dad0dd9eea4be9cc1412373a8c89 wasn't actually using
the published version of pg_bsd_indent, but a hacked-up version that
tried to minimize the amount of movement of comments to the right of
code. The situation of interest is where such a comment has to be
moved to the right of its default placement at column 33 because there's
code there. BSD indent has always moved right in units of tab stops
in such cases --- but in the previous incarnation, indent was working
in 8-space tab stops, while now it knows we use 4-space tabs. So the
net result is that in about half the cases, such comments are placed
one tab stop left of before. This is better all around: it leaves
more room on the line for comment text, and it means that in such
cases the comment uniformly starts at the next 4-space tab stop after
the code, rather than sometimes one and sometimes two tabs after.
Also, ensure that comments following #endif are indented the same
as comments following other preprocessor commands such as #else.
That inconsistency turns out to have been self-inflicted damage
from a poorly-thought-through post-indent "fixup" in pgindent.
This patch is much less interesting than the first round of indent
changes, but also bulkier, so I thought it best to separate the effects.
Discussion: https://postgr.es/m/E1dAmxK-0006EE-1r@gemulon.postgresql.org
Discussion: https://postgr.es/m/30527.1495162840@sss.pgh.pa.us
2017-06-21 21:18:54 +02:00
|
|
|
#define BLOOM_HEAD_BLKNO (1) /* first data page */
|
2016-04-01 15:42:24 +02:00
|
|
|
|
2016-04-02 12:47:04 +02:00
|
|
|
/*
|
2016-06-03 16:52:36 +02:00
|
|
|
* We store Bloom signatures as arrays of uint16 words.
|
2016-04-02 12:47:04 +02:00
|
|
|
*/
|
2016-06-03 16:52:36 +02:00
|
|
|
typedef uint16 BloomSignatureWord;
|
|
|
|
|
|
|
|
#define SIGNWORDBITS ((int) (BITS_PER_BYTE * sizeof(BloomSignatureWord)))
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Default and maximum Bloom signature length in bits.
|
|
|
|
*/
|
|
|
|
#define DEFAULT_BLOOM_LENGTH (5 * SIGNWORDBITS)
|
|
|
|
#define MAX_BLOOM_LENGTH (256 * SIGNWORDBITS)
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Default and maximum signature bits generated per index key.
|
|
|
|
*/
|
|
|
|
#define DEFAULT_BLOOM_BITS 2
|
|
|
|
#define MAX_BLOOM_BITS (MAX_BLOOM_LENGTH - 1)
|
2016-04-02 12:47:04 +02:00
|
|
|
|
2016-04-01 15:42:24 +02:00
|
|
|
/* Bloom index options */
|
|
|
|
typedef struct BloomOptions
|
|
|
|
{
|
|
|
|
int32 vl_len_; /* varlena header (do not touch directly!) */
|
2016-06-03 16:52:36 +02:00
|
|
|
int bloomLength; /* length of signature in words (not bits!) */
|
Phase 2 of pgindent updates.
Change pg_bsd_indent to follow upstream rules for placement of comments
to the right of code, and remove pgindent hack that caused comments
following #endif to not obey the general rule.
Commit e3860ffa4dd0dad0dd9eea4be9cc1412373a8c89 wasn't actually using
the published version of pg_bsd_indent, but a hacked-up version that
tried to minimize the amount of movement of comments to the right of
code. The situation of interest is where such a comment has to be
moved to the right of its default placement at column 33 because there's
code there. BSD indent has always moved right in units of tab stops
in such cases --- but in the previous incarnation, indent was working
in 8-space tab stops, while now it knows we use 4-space tabs. So the
net result is that in about half the cases, such comments are placed
one tab stop left of before. This is better all around: it leaves
more room on the line for comment text, and it means that in such
cases the comment uniformly starts at the next 4-space tab stop after
the code, rather than sometimes one and sometimes two tabs after.
Also, ensure that comments following #endif are indented the same
as comments following other preprocessor commands such as #else.
That inconsistency turns out to have been self-inflicted damage
from a poorly-thought-through post-indent "fixup" in pgindent.
This patch is much less interesting than the first round of indent
changes, but also bulkier, so I thought it best to separate the effects.
Discussion: https://postgr.es/m/E1dAmxK-0006EE-1r@gemulon.postgresql.org
Discussion: https://postgr.es/m/30527.1495162840@sss.pgh.pa.us
2017-06-21 21:18:54 +02:00
|
|
|
int bitSize[INDEX_MAX_KEYS]; /* # of bits generated for each
|
|
|
|
* index key */
|
2016-06-10 00:02:36 +02:00
|
|
|
} BloomOptions;
|
2016-04-01 15:42:24 +02:00
|
|
|
|
|
|
|
/*
|
|
|
|
* FreeBlockNumberArray - array of block numbers sized so that metadata fill
|
|
|
|
* all space in metapage.
|
|
|
|
*/
|
|
|
|
typedef BlockNumber FreeBlockNumberArray[
|
|
|
|
MAXALIGN_DOWN(
|
Phase 3 of pgindent updates.
Don't move parenthesized lines to the left, even if that means they
flow past the right margin.
By default, BSD indent lines up statement continuation lines that are
within parentheses so that they start just to the right of the preceding
left parenthesis. However, traditionally, if that resulted in the
continuation line extending to the right of the desired right margin,
then indent would push it left just far enough to not overrun the margin,
if it could do so without making the continuation line start to the left of
the current statement indent. That makes for a weird mix of indentations
unless one has been completely rigid about never violating the 80-column
limit.
This behavior has been pretty universally panned by Postgres developers.
Hence, disable it with indent's new -lpl switch, so that parenthesized
lines are always lined up with the preceding left paren.
This patch is much less interesting than the first round of indent
changes, but also bulkier, so I thought it best to separate the effects.
Discussion: https://postgr.es/m/E1dAmxK-0006EE-1r@gemulon.postgresql.org
Discussion: https://postgr.es/m/30527.1495162840@sss.pgh.pa.us
2017-06-21 21:35:54 +02:00
|
|
|
BLCKSZ - SizeOfPageHeaderData - MAXALIGN(sizeof(BloomPageOpaqueData))
|
|
|
|
- MAXALIGN(sizeof(uint16) * 2 + sizeof(uint32) + sizeof(BloomOptions))
|
2016-04-01 15:42:24 +02:00
|
|
|
) / sizeof(BlockNumber)
|
|
|
|
];
|
|
|
|
|
|
|
|
/* Metadata of bloom index */
|
|
|
|
typedef struct BloomMetaPageData
|
|
|
|
{
|
|
|
|
uint32 magickNumber;
|
|
|
|
uint16 nStart;
|
|
|
|
uint16 nEnd;
|
|
|
|
BloomOptions opts;
|
|
|
|
FreeBlockNumberArray notFullPage;
|
2016-06-10 00:02:36 +02:00
|
|
|
} BloomMetaPageData;
|
2016-04-01 15:42:24 +02:00
|
|
|
|
|
|
|
/* Magic number to distinguish bloom pages among anothers */
|
|
|
|
#define BLOOM_MAGICK_NUMBER (0xDBAC0DED)
|
|
|
|
|
|
|
|
/* Number of blocks numbers fit in BloomMetaPageData */
|
|
|
|
#define BloomMetaBlockN (sizeof(FreeBlockNumberArray) / sizeof(BlockNumber))
|
|
|
|
|
|
|
|
#define BloomPageGetMeta(page) ((BloomMetaPageData *) PageGetContents(page))
|
|
|
|
|
|
|
|
typedef struct BloomState
|
|
|
|
{
|
|
|
|
FmgrInfo hashFn[INDEX_MAX_KEYS];
|
2019-03-22 12:09:32 +01:00
|
|
|
Oid collations[INDEX_MAX_KEYS];
|
2016-04-03 21:16:07 +02:00
|
|
|
BloomOptions opts; /* copy of options on index's metapage */
|
2016-04-01 15:42:24 +02:00
|
|
|
int32 nColumns;
|
|
|
|
|
|
|
|
/*
|
2016-04-03 21:16:07 +02:00
|
|
|
* sizeOfBloomTuple is index-specific, and it depends on reloptions, so
|
2016-04-01 15:42:24 +02:00
|
|
|
* precompute it
|
|
|
|
*/
|
2016-04-03 20:17:20 +02:00
|
|
|
Size sizeOfBloomTuple;
|
2016-06-10 00:02:36 +02:00
|
|
|
} BloomState;
|
2016-04-01 15:42:24 +02:00
|
|
|
|
|
|
|
#define BloomPageGetFreeSpace(state, page) \
|
|
|
|
(BLCKSZ - MAXALIGN(SizeOfPageHeaderData) \
|
|
|
|
- BloomPageGetMaxOffset(page) * (state)->sizeOfBloomTuple \
|
|
|
|
- MAXALIGN(sizeof(BloomPageOpaqueData)))
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Tuples are very different from all other relations
|
|
|
|
*/
|
|
|
|
typedef struct BloomTuple
|
|
|
|
{
|
|
|
|
ItemPointerData heapPtr;
|
2016-06-03 16:52:36 +02:00
|
|
|
BloomSignatureWord sign[FLEXIBLE_ARRAY_MEMBER];
|
2016-06-10 00:02:36 +02:00
|
|
|
} BloomTuple;
|
2016-04-01 15:42:24 +02:00
|
|
|
|
|
|
|
#define BLOOMTUPLEHDRSZ offsetof(BloomTuple, sign)
|
|
|
|
|
|
|
|
/* Opaque data structure for bloom index scan */
|
|
|
|
typedef struct BloomScanOpaqueData
|
|
|
|
{
|
2016-06-10 00:02:36 +02:00
|
|
|
BloomSignatureWord *sign; /* Scan signature */
|
2016-04-01 15:42:24 +02:00
|
|
|
BloomState state;
|
2016-06-10 00:02:36 +02:00
|
|
|
} BloomScanOpaqueData;
|
2016-04-01 15:42:24 +02:00
|
|
|
|
|
|
|
typedef BloomScanOpaqueData *BloomScanOpaque;
|
|
|
|
|
|
|
|
/* blutils.c */
|
2016-06-10 00:02:36 +02:00
|
|
|
extern void initBloomState(BloomState *state, Relation index);
|
2016-05-25 03:04:23 +02:00
|
|
|
extern void BloomFillMetapage(Relation index, Page metaPage);
|
2016-04-01 15:42:24 +02:00
|
|
|
extern void BloomInitMetapage(Relation index);
|
|
|
|
extern void BloomInitPage(Page page, uint16 flags);
|
|
|
|
extern Buffer BloomNewBuffer(Relation index);
|
2016-06-10 00:02:36 +02:00
|
|
|
extern void signValue(BloomState *state, BloomSignatureWord *sign, Datum value, int attno);
|
|
|
|
extern BloomTuple *BloomFormTuple(BloomState *state, ItemPointer iptr, Datum *values, bool *isnull);
|
|
|
|
extern bool BloomPageAddItem(BloomState *state, Page page, BloomTuple *tuple);
|
2016-04-01 15:42:24 +02:00
|
|
|
|
|
|
|
/* blvalidate.c */
|
|
|
|
extern bool blvalidate(Oid opclassoid);
|
|
|
|
|
|
|
|
/* index access method interface functions */
|
|
|
|
extern bool blinsert(Relation index, Datum *values, bool *isnull,
|
2019-05-22 19:04:48 +02:00
|
|
|
ItemPointer ht_ctid, Relation heapRel,
|
|
|
|
IndexUniqueCheck checkUnique,
|
2021-01-13 17:11:00 +01:00
|
|
|
bool indexUnchanged,
|
2019-05-22 19:04:48 +02:00
|
|
|
struct IndexInfo *indexInfo);
|
2016-04-01 15:42:24 +02:00
|
|
|
extern IndexScanDesc blbeginscan(Relation r, int nkeys, int norderbys);
|
|
|
|
extern int64 blgetbitmap(IndexScanDesc scan, TIDBitmap *tbm);
|
|
|
|
extern void blrescan(IndexScanDesc scan, ScanKey scankey, int nscankeys,
|
2019-05-22 19:04:48 +02:00
|
|
|
ScanKey orderbys, int norderbys);
|
2016-04-01 15:42:24 +02:00
|
|
|
extern void blendscan(IndexScanDesc scan);
|
|
|
|
extern IndexBuildResult *blbuild(Relation heap, Relation index,
|
2019-05-22 19:04:48 +02:00
|
|
|
struct IndexInfo *indexInfo);
|
2016-04-01 15:42:24 +02:00
|
|
|
extern void blbuildempty(Relation index);
|
|
|
|
extern IndexBulkDeleteResult *blbulkdelete(IndexVacuumInfo *info,
|
2019-05-22 19:04:48 +02:00
|
|
|
IndexBulkDeleteResult *stats, IndexBulkDeleteCallback callback,
|
|
|
|
void *callback_state);
|
2016-04-01 15:42:24 +02:00
|
|
|
extern IndexBulkDeleteResult *blvacuumcleanup(IndexVacuumInfo *info,
|
2019-05-22 19:04:48 +02:00
|
|
|
IndexBulkDeleteResult *stats);
|
2016-04-01 15:42:24 +02:00
|
|
|
extern bytea *bloptions(Datum reloptions, bool validate);
|
|
|
|
extern void blcostestimate(PlannerInfo *root, IndexPath *path,
|
2019-05-22 19:04:48 +02:00
|
|
|
double loop_count, Cost *indexStartupCost,
|
|
|
|
Cost *indexTotalCost, Selectivity *indexSelectivity,
|
|
|
|
double *indexCorrelation, double *indexPages);
|
2016-04-01 15:42:24 +02:00
|
|
|
|
|
|
|
#endif
|