PostgreSQL Source Code  git master
dummy_index_am.c
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * dummy_index_am.c
4  * Index AM template main file.
5  *
6  * Portions Copyright (c) 1996-2020, PostgreSQL Global Development Group
7  * Portions Copyright (c) 1994, Regents of the University of California
8  *
9  * IDENTIFICATION
10  * src/test/modules/dummy_index_am/dummy_index_am.c
11  *
12  *-------------------------------------------------------------------------
13  */
14 #include "postgres.h"
15 
16 #include "access/amapi.h"
17 #include "access/reloptions.h"
18 #include "catalog/index.h"
19 #include "commands/vacuum.h"
20 #include "nodes/pathnodes.h"
21 #include "utils/guc.h"
22 #include "utils/rel.h"
23 
25 
26 void _PG_init(void);
27 
28 /* parse table for fillRelOptions */
30 
31 /* Kind of relation options for dummy index */
33 
34 typedef enum DummyAmEnum {
37 } DummyAmEnum;
38 
39 /* Dummy index options */
40 typedef struct DummyIndexOptions
41 {
42  int32 vl_len_; /* varlena header (do not touch directly!) */
44  double option_real;
50 
52 {
53  {"one", DUMMY_AM_ENUM_ONE},
54  {"two", DUMMY_AM_ENUM_TWO},
55  {(const char *)NULL} /* list terminator */
56 };
57 
58 /* Handler for index AM */
60 
61 /*
62  * Validation function for string relation options.
63  */
64 static void
66 {
68  (errmsg("new option value for string parameter %s",
69  value ? value : "NULL")));
70 }
71 
72 /*
73  * This function creates a full set of relation option types,
74  * with various patterns.
75  */
76 static void
78 {
80 
81  add_int_reloption(di_relopt_kind, "option_int",
82  "Integer option for dummy_index_am",
83  10, -10, 100, AccessExclusiveLock);
84  di_relopt_tab[0].optname = "option_int";
85  di_relopt_tab[0].opttype = RELOPT_TYPE_INT;
86  di_relopt_tab[0].offset = offsetof(DummyIndexOptions, option_int);
87 
88  add_real_reloption(di_relopt_kind, "option_real",
89  "Real option for dummy_index_am",
90  3.1415, -10, 100, AccessExclusiveLock);
91  di_relopt_tab[1].optname = "option_real";
92  di_relopt_tab[1].opttype = RELOPT_TYPE_REAL;
93  di_relopt_tab[1].offset = offsetof(DummyIndexOptions, option_real);
94 
95  add_bool_reloption(di_relopt_kind, "option_bool",
96  "Boolean option for dummy_index_am",
97  true, AccessExclusiveLock);
98  di_relopt_tab[2].optname = "option_bool";
99  di_relopt_tab[2].opttype = RELOPT_TYPE_BOOL;
100  di_relopt_tab[2].offset = offsetof(DummyIndexOptions, option_bool);
101 
102  add_enum_reloption(di_relopt_kind, "option_enum",
103  "Enum option for dummy_index_am",
104  dummyAmEnumValues,
106  "Valid values are \"one\" and \"two\".",
108  di_relopt_tab[3].optname = "option_enum";
109  di_relopt_tab[3].opttype = RELOPT_TYPE_ENUM;
110  di_relopt_tab[3].offset = offsetof(DummyIndexOptions, option_enum);
111 
112  add_string_reloption(di_relopt_kind, "option_string_val",
113  "String option for dummy_index_am with non-NULL default",
114  "DefaultValue", &validate_string_option,
116  di_relopt_tab[4].optname = "option_string_val";
117  di_relopt_tab[4].opttype = RELOPT_TYPE_STRING;
118  di_relopt_tab[4].offset = offsetof(DummyIndexOptions,
120 
121  /*
122  * String option for dummy_index_am with NULL default, and without
123  * description.
124  */
125  add_string_reloption(di_relopt_kind, "option_string_null",
126  NULL, /* description */
127  NULL, &validate_string_option,
129  di_relopt_tab[5].optname = "option_string_null";
130  di_relopt_tab[5].opttype = RELOPT_TYPE_STRING;
131  di_relopt_tab[5].offset = offsetof(DummyIndexOptions,
133 }
134 
135 
136 /*
137  * Build a new index.
138  */
139 static IndexBuildResult *
141 {
142  IndexBuildResult *result;
143 
144  result = (IndexBuildResult *) palloc(sizeof(IndexBuildResult));
145 
146  /* let's pretend that no tuples were scanned */
147  result->heap_tuples = 0;
148  /* and no index tuples were created (that is true) */
149  result->index_tuples = 0;
150 
151  return result;
152 }
153 
154 /*
155  * Build an empty index for the initialiation fork.
156  */
157 static void
159 {
160  /* No need to build an init fork for a dummy index */
161 }
162 
163 /*
164  * Insert new tuple to index AM.
165  */
166 static bool
168  ItemPointer ht_ctid, Relation heapRel,
169  IndexUniqueCheck checkUnique,
170  IndexInfo *indexInfo)
171 {
172  /* nothing to do */
173  return false;
174 }
175 
176 /*
177  * Bulk deletion of all index entries pointing to a set of table tuples.
178  */
179 static IndexBulkDeleteResult *
181  IndexBulkDeleteCallback callback, void *callback_state)
182 {
183  /*
184  * There is nothing to delete. Return NULL as there is nothing to pass to
185  * amvacuumcleanup.
186  */
187  return NULL;
188 }
189 
190 /*
191  * Post-VACUUM cleanup for index AM.
192  */
193 static IndexBulkDeleteResult *
195 {
196  /* Index has not been modified, so returning NULL is fine */
197  return NULL;
198 }
199 
200 /*
201  * Estimate cost of index AM.
202  */
203 static void
204 dicostestimate(PlannerInfo *root, IndexPath *path, double loop_count,
205  Cost *indexStartupCost, Cost *indexTotalCost,
206  Selectivity *indexSelectivity, double *indexCorrelation,
207  double *indexPages)
208 {
209  /* Tell planner to never use this index! */
210  *indexStartupCost = 1.0e10;
211  *indexTotalCost = 1.0e10;
212 
213  /* Do not care about the rest */
214  *indexSelectivity = 1;
215  *indexCorrelation = 0;
216  *indexPages = 1;
217 }
218 
219 /*
220  * Parse relation options for index AM, returning a DummyIndexOptions
221  * structure filled with option values.
222  */
223 static bytea *
224 dioptions(Datum reloptions, bool validate)
225 {
226  return (bytea *) build_reloptions(reloptions, validate,
228  sizeof(DummyIndexOptions),
229  di_relopt_tab, lengthof(di_relopt_tab));
230 }
231 
232 /*
233  * Validator for index AM.
234  */
235 static bool
236 divalidate(Oid opclassoid)
237 {
238  /* Index is dummy so we are happy with any opclass */
239  return true;
240 }
241 
242 /*
243  * Begin scan of index AM.
244  */
245 static IndexScanDesc
246 dibeginscan(Relation r, int nkeys, int norderbys)
247 {
248  IndexScanDesc scan;
249 
250  /* Let's pretend we are doing something */
251  scan = RelationGetIndexScan(r, nkeys, norderbys);
252  return scan;
253 }
254 
255 /*
256  * Rescan of index AM.
257  */
258 static void
259 direscan(IndexScanDesc scan, ScanKey scankey, int nscankeys,
260  ScanKey orderbys, int norderbys)
261 {
262  /* nothing to do */
263 }
264 
265 /*
266  * End scan of index AM.
267  */
268 static void
270 {
271  /* nothing to do */
272 }
273 
274 /*
275  * Index AM handler function: returns IndexAmRoutine with access method
276  * parameters and callbacks.
277  */
278 Datum
280 {
281  IndexAmRoutine *amroutine = makeNode(IndexAmRoutine);
282 
283  amroutine->amstrategies = 0;
284  amroutine->amsupport = 1;
285  amroutine->amcanorder = false;
286  amroutine->amcanorderbyop = false;
287  amroutine->amcanbackward = false;
288  amroutine->amcanunique = false;
289  amroutine->amcanmulticol = false;
290  amroutine->amoptionalkey = false;
291  amroutine->amsearcharray = false;
292  amroutine->amsearchnulls = false;
293  amroutine->amstorage = false;
294  amroutine->amclusterable = false;
295  amroutine->ampredlocks = false;
296  amroutine->amcanparallel = false;
297  amroutine->amcaninclude = false;
298  amroutine->amusemaintenanceworkmem = false;
300  amroutine->amkeytype = InvalidOid;
301 
302  amroutine->ambuild = dibuild;
303  amroutine->ambuildempty = dibuildempty;
304  amroutine->aminsert = diinsert;
305  amroutine->ambulkdelete = dibulkdelete;
306  amroutine->amvacuumcleanup = divacuumcleanup;
307  amroutine->amcanreturn = NULL;
308  amroutine->amcostestimate = dicostestimate;
309  amroutine->amoptions = dioptions;
310  amroutine->amproperty = NULL;
311  amroutine->ambuildphasename = NULL;
312  amroutine->amvalidate = divalidate;
313  amroutine->ambeginscan = dibeginscan;
314  amroutine->amrescan = direscan;
315  amroutine->amgettuple = NULL;
316  amroutine->amgetbitmap = NULL;
317  amroutine->amendscan = diendscan;
318  amroutine->ammarkpos = NULL;
319  amroutine->amrestrpos = NULL;
320  amroutine->amestimateparallelscan = NULL;
321  amroutine->aminitparallelscan = NULL;
322  amroutine->amparallelrescan = NULL;
323 
324  PG_RETURN_POINTER(amroutine);
325 }
326 
327 void
328 _PG_init(void)
329 {
331 }
ambeginscan_function ambeginscan
Definition: amapi.h:225
uint8 amparallelvacuumoptions
Definition: amapi.h:203
#define PG_RETURN_POINTER(x)
Definition: fmgr.h:351
ambulkdelete_function ambulkdelete
Definition: amapi.h:217
relopt_type opttype
Definition: reloptions.h:147
bool amcanmulticol
Definition: amapi.h:183
uint16 amsupport
Definition: amapi.h:173
DummyAmEnum option_enum
amgettuple_function amgettuple
Definition: amapi.h:227
bool amcanorderbyop
Definition: amapi.h:177
amproperty_function amproperty
Definition: amapi.h:222
DummyAmEnum
static IndexBuildResult * dibuild(Relation heap, Relation index, IndexInfo *indexInfo)
static IndexScanDesc dibeginscan(Relation r, int nkeys, int norderbys)
amparallelrescan_function amparallelrescan
Definition: amapi.h:236
bool amstorage
Definition: amapi.h:191
static IndexBulkDeleteResult * dibulkdelete(IndexVacuumInfo *info, IndexBulkDeleteResult *stats, IndexBulkDeleteCallback callback, void *callback_state)
static struct @145 value
bool ampredlocks
Definition: amapi.h:195
aminsert_function aminsert
Definition: amapi.h:216
double Selectivity
Definition: nodes.h:658
#define lengthof(array)
Definition: c.h:658
unsigned int Oid
Definition: postgres_ext.h:31
void add_int_reloption(bits32 kinds, const char *name, const char *desc, int default_val, int min_val, int max_val, LOCKMODE lockmode)
Definition: reloptions.c:739
Oid amkeytype
Definition: amapi.h:205
static IndexBulkDeleteResult * divacuumcleanup(IndexVacuumInfo *info, IndexBulkDeleteResult *stats)
bool amoptionalkey
Definition: amapi.h:185
amvalidate_function amvalidate
Definition: amapi.h:224
signed int int32
Definition: c.h:345
void * build_reloptions(Datum reloptions, bool validate, relopt_kind kind, Size relopt_struct_size, const relopt_parse_elt *relopt_elems, int num_relopt_elems)
Definition: reloptions.c:1552
static void diendscan(IndexScanDesc scan)
Definition: type.h:89
IndexUniqueCheck
Definition: genam.h:112
amgetbitmap_function amgetbitmap
Definition: amapi.h:228
static bool divalidate(Oid opclassoid)
ambuild_function ambuild
Definition: amapi.h:214
amoptions_function amoptions
Definition: amapi.h:221
static void callback(struct sockaddr *addr, struct sockaddr *mask, void *unused)
Definition: test_ifaddrs.c:48
bool amcaninclude
Definition: amapi.h:199
struct DummyIndexOptions DummyIndexOptions
void _PG_init(void)
amcostestimate_function amcostestimate
Definition: amapi.h:220
bool amcanunique
Definition: amapi.h:181
relopt_enum_elt_def dummyAmEnumValues[]
amvacuumcleanup_function amvacuumcleanup
Definition: amapi.h:218
amendscan_function amendscan
Definition: amapi.h:229
bool amcanbackward
Definition: amapi.h:179
PG_FUNCTION_INFO_V1(dihandler)
static void direscan(IndexScanDesc scan, ScanKey scankey, int nscankeys, ScanKey orderbys, int norderbys)
#define ereport(elevel, rest)
Definition: elog.h:141
amrescan_function amrescan
Definition: amapi.h:226
bool amcanparallel
Definition: amapi.h:197
#define VACUUM_OPTION_NO_PARALLEL
Definition: vacuum.h:39
static void create_reloptions_table(void)
bool amsearchnulls
Definition: amapi.h:189
uintptr_t Datum
Definition: postgres.h:367
static bool diinsert(Relation index, Datum *values, bool *isnull, ItemPointer ht_ctid, Relation heapRel, IndexUniqueCheck checkUnique, IndexInfo *indexInfo)
static void dicostestimate(PlannerInfo *root, IndexPath *path, double loop_count, Cost *indexStartupCost, Cost *indexTotalCost, Selectivity *indexSelectivity, double *indexCorrelation, double *indexPages)
bool amclusterable
Definition: amapi.h:193
const char * optname
Definition: reloptions.h:146
bool amsearcharray
Definition: amapi.h:187
#define InvalidOid
Definition: postgres_ext.h:36
bool amusemaintenanceworkmem
Definition: amapi.h:201
#define NOTICE
Definition: elog.h:37
#define makeNode(_type_)
Definition: nodes.h:573
static void validate_string_option(const char *value)
void add_real_reloption(bits32 kinds, const char *name, const char *desc, double default_val, double min_val, double max_val, LOCKMODE lockmode)
Definition: reloptions.c:758
ammarkpos_function ammarkpos
Definition: amapi.h:230
bool amcanorder
Definition: amapi.h:175
ambuildphasename_function ambuildphasename
Definition: amapi.h:223
amestimateparallelscan_function amestimateparallelscan
Definition: amapi.h:234
relopt_kind add_reloption_kind(void)
Definition: reloptions.c:618
relopt_kind di_relopt_kind
uint16 amstrategies
Definition: amapi.h:171
static Datum values[MAXATTR]
Definition: bootstrap.c:167
#define AccessExclusiveLock
Definition: lockdefs.h:45
PG_MODULE_MAGIC
relopt_parse_elt di_relopt_tab[6]
void * palloc(Size size)
Definition: mcxt.c:949
int errmsg(const char *fmt,...)
Definition: elog.c:822
void add_string_reloption(bits32 kinds, const char *name, const char *desc, const char *default_val, validate_string_relopt validator, LOCKMODE lockmode)
Definition: reloptions.c:810
relopt_kind
Definition: reloptions.h:39
ambuildempty_function ambuildempty
Definition: amapi.h:215
IndexScanDesc RelationGetIndexScan(Relation indexRelation, int nkeys, int norderbys)
Definition: genam.c:80
Definition: c.h:545
#define PG_FUNCTION_ARGS
Definition: fmgr.h:188
static bytea * dioptions(Datum reloptions, bool validate)
Datum dihandler(PG_FUNCTION_ARGS)
void add_enum_reloption(bits32 kinds, const char *name, const char *desc, relopt_enum_elt_def *members, int default_val, const char *detailmsg, LOCKMODE lockmode)
Definition: reloptions.c:785
void add_bool_reloption(bits32 kinds, const char *name, const char *desc, bool default_val, LOCKMODE lockmode)
Definition: reloptions.c:722
amcanreturn_function amcanreturn
Definition: amapi.h:219
double Cost
Definition: nodes.h:659
#define offsetof(type, field)
Definition: c.h:651
double index_tuples
Definition: genam.h:33
bool(* IndexBulkDeleteCallback)(ItemPointer itemptr, void *state)
Definition: genam.h:84
aminitparallelscan_function aminitparallelscan
Definition: amapi.h:235
double heap_tuples
Definition: genam.h:32
static void dibuildempty(Relation index)
amrestrpos_function amrestrpos
Definition: amapi.h:231