PostgreSQL Source Code  git master
syscache.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * syscache.h
4  * System catalog cache definitions.
5  *
6  * See also lsyscache.h, which provides convenience routines for
7  * common cache-lookup operations.
8  *
9  * Portions Copyright (c) 1996-2021, PostgreSQL Global Development Group
10  * Portions Copyright (c) 1994, Regents of the University of California
11  *
12  * src/include/utils/syscache.h
13  *
14  *-------------------------------------------------------------------------
15  */
16 #ifndef SYSCACHE_H
17 #define SYSCACHE_H
18 
19 #include "access/attnum.h"
20 #include "access/htup.h"
21 /* we intentionally do not include utils/catcache.h here */
22 
23 /*
24  * SysCache identifiers.
25  *
26  * The order of these identifiers must match the order
27  * of the entries in the array cacheinfo[] in syscache.c.
28  * Keep them in alphabetical order (renumbering only costs a
29  * backend rebuild).
30  */
31 
33 {
34  AGGFNOID = 0,
112  USERMAPPINGUSERSERVER
113 
114 #define SysCacheSize (USERMAPPINGUSERSERVER + 1)
115 };
116 
117 extern void InitCatalogCache(void);
118 extern void InitCatalogCachePhase2(void);
119 
120 extern HeapTuple SearchSysCache(int cacheId,
121  Datum key1, Datum key2, Datum key3, Datum key4);
122 
123 /*
124  * The use of argument specific numbers is encouraged. They're faster, and
125  * insulates the caller from changes in the maximum number of keys.
126  */
127 extern HeapTuple SearchSysCache1(int cacheId,
128  Datum key1);
129 extern HeapTuple SearchSysCache2(int cacheId,
130  Datum key1, Datum key2);
131 extern HeapTuple SearchSysCache3(int cacheId,
132  Datum key1, Datum key2, Datum key3);
133 extern HeapTuple SearchSysCache4(int cacheId,
134  Datum key1, Datum key2, Datum key3, Datum key4);
135 
136 extern void ReleaseSysCache(HeapTuple tuple);
137 
138 /* convenience routines */
139 extern HeapTuple SearchSysCacheCopy(int cacheId,
140  Datum key1, Datum key2, Datum key3, Datum key4);
141 extern bool SearchSysCacheExists(int cacheId,
142  Datum key1, Datum key2, Datum key3, Datum key4);
143 extern Oid GetSysCacheOid(int cacheId, AttrNumber oidcol,
144  Datum key1, Datum key2, Datum key3, Datum key4);
145 
146 extern HeapTuple SearchSysCacheAttName(Oid relid, const char *attname);
147 extern HeapTuple SearchSysCacheCopyAttName(Oid relid, const char *attname);
148 extern bool SearchSysCacheExistsAttName(Oid relid, const char *attname);
149 
152 
153 extern Datum SysCacheGetAttr(int cacheId, HeapTuple tup,
154  AttrNumber attributeNumber, bool *isNull);
155 
156 extern uint32 GetSysCacheHashValue(int cacheId,
157  Datum key1, Datum key2, Datum key3, Datum key4);
158 
159 /* list-search interface. Users of this must import catcache.h too */
160 struct catclist;
161 extern struct catclist *SearchSysCacheList(int cacheId, int nkeys,
162  Datum key1, Datum key2, Datum key3);
163 
164 extern void SysCacheInvalidate(int cacheId, uint32 hashValue);
165 
166 extern bool RelationInvalidatesSnapshotsOnly(Oid relid);
167 extern bool RelationHasSysCache(Oid relid);
168 extern bool RelationSupportsSysCache(Oid relid);
169 
170 /*
171  * The use of the macros below rather than direct calls to the corresponding
172  * functions is encouraged, as it insulates the caller from changes in the
173  * maximum number of keys.
174  */
175 #define SearchSysCacheCopy1(cacheId, key1) \
176  SearchSysCacheCopy(cacheId, key1, 0, 0, 0)
177 #define SearchSysCacheCopy2(cacheId, key1, key2) \
178  SearchSysCacheCopy(cacheId, key1, key2, 0, 0)
179 #define SearchSysCacheCopy3(cacheId, key1, key2, key3) \
180  SearchSysCacheCopy(cacheId, key1, key2, key3, 0)
181 #define SearchSysCacheCopy4(cacheId, key1, key2, key3, key4) \
182  SearchSysCacheCopy(cacheId, key1, key2, key3, key4)
183 
184 #define SearchSysCacheExists1(cacheId, key1) \
185  SearchSysCacheExists(cacheId, key1, 0, 0, 0)
186 #define SearchSysCacheExists2(cacheId, key1, key2) \
187  SearchSysCacheExists(cacheId, key1, key2, 0, 0)
188 #define SearchSysCacheExists3(cacheId, key1, key2, key3) \
189  SearchSysCacheExists(cacheId, key1, key2, key3, 0)
190 #define SearchSysCacheExists4(cacheId, key1, key2, key3, key4) \
191  SearchSysCacheExists(cacheId, key1, key2, key3, key4)
192 
193 #define GetSysCacheOid1(cacheId, oidcol, key1) \
194  GetSysCacheOid(cacheId, oidcol, key1, 0, 0, 0)
195 #define GetSysCacheOid2(cacheId, oidcol, key1, key2) \
196  GetSysCacheOid(cacheId, oidcol, key1, key2, 0, 0)
197 #define GetSysCacheOid3(cacheId, oidcol, key1, key2, key3) \
198  GetSysCacheOid(cacheId, oidcol, key1, key2, key3, 0)
199 #define GetSysCacheOid4(cacheId, oidcol, key1, key2, key3, key4) \
200  GetSysCacheOid(cacheId, oidcol, key1, key2, key3, key4)
201 
202 #define GetSysCacheHashValue1(cacheId, key1) \
203  GetSysCacheHashValue(cacheId, key1, 0, 0, 0)
204 #define GetSysCacheHashValue2(cacheId, key1, key2) \
205  GetSysCacheHashValue(cacheId, key1, key2, 0, 0)
206 #define GetSysCacheHashValue3(cacheId, key1, key2, key3) \
207  GetSysCacheHashValue(cacheId, key1, key2, key3, 0)
208 #define GetSysCacheHashValue4(cacheId, key1, key2, key3, key4) \
209  GetSysCacheHashValue(cacheId, key1, key2, key3, key4)
210 
211 #define SearchSysCacheList1(cacheId, key1) \
212  SearchSysCacheList(cacheId, 1, key1, 0, 0)
213 #define SearchSysCacheList2(cacheId, key1, key2) \
214  SearchSysCacheList(cacheId, 2, key1, key2, 0)
215 #define SearchSysCacheList3(cacheId, key1, key2, key3) \
216  SearchSysCacheList(cacheId, 3, key1, key2, key3)
217 
218 #define ReleaseSysCacheList(x) ReleaseCatCacheList(x)
219 
220 #endif /* SYSCACHE_H */
signed short int16
Definition: c.h:416
void SysCacheInvalidate(int cacheId, uint32 hashValue)
Definition: syscache.c:1460
Definition: syscache.h:36
void InitCatalogCache(void)
Definition: syscache.c:1021
HeapTuple SearchSysCache(int cacheId, Datum key1, Datum key2, Datum key3, Datum key4)
Definition: syscache.c:1114
HeapTuple SearchSysCache4(int cacheId, Datum key1, Datum key2, Datum key3, Datum key4)
Definition: syscache.c:1160
uint32 GetSysCacheHashValue(int cacheId, Datum key1, Datum key2, Datum key3, Datum key4)
Definition: syscache.c:1423
bool RelationHasSysCache(Oid relid)
Definition: syscache.c:1507
HeapTuple SearchSysCacheCopyAttName(Oid relid, const char *attname)
Definition: syscache.c:1291
HeapTuple SearchSysCacheCopyAttNum(Oid relid, int16 attnum)
Definition: syscache.c:1354
HeapTuple SearchSysCacheCopy(int cacheId, Datum key1, Datum key2, Datum key3, Datum key4)
Definition: syscache.c:1189
unsigned int Oid
Definition: postgres_ext.h:31
Datum SysCacheGetAttr(int cacheId, HeapTuple tup, AttrNumber attributeNumber, bool *isNull)
Definition: syscache.c:1388
short nkeys
Definition: catcache.h:175
bool SearchSysCacheExists(int cacheId, Datum key1, Datum key2, Datum key3, Datum key4)
Definition: syscache.c:1213
SysCacheIdentifier
Definition: syscache.h:32
NameData attname
Definition: pg_attribute.h:40
struct catclist * SearchSysCacheList(int cacheId, int nkeys, Datum key1, Datum key2, Datum key3)
Definition: syscache.c:1440
HeapTuple SearchSysCache2(int cacheId, Datum key1, Datum key2)
Definition: syscache.c:1138
bool RelationInvalidatesSnapshotsOnly(Oid relid)
Definition: syscache.c:1484
unsigned int uint32
Definition: c.h:429
Oid GetSysCacheOid(int cacheId, AttrNumber oidcol, Datum key1, Datum key2, Datum key3, Datum key4)
Definition: syscache.c:1236
uintptr_t Datum
Definition: postgres.h:367
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:1175
int16 attnum
Definition: pg_attribute.h:79
HeapTuple SearchSysCacheAttName(Oid relid, const char *attname)
Definition: syscache.c:1268
void InitCatalogCachePhase2(void)
Definition: syscache.c:1086
HeapTuple SearchSysCacheAttNum(Oid relid, int16 attnum)
Definition: syscache.c:1331
bool RelationSupportsSysCache(Oid relid)
Definition: syscache.c:1532
HeapTuple SearchSysCache3(int cacheId, Datum key1, Datum key2, Datum key3)
Definition: syscache.c:1149
HeapTuple SearchSysCache1(int cacheId, Datum key1)
Definition: syscache.c:1127
bool SearchSysCacheExistsAttName(Oid relid, const char *attname)
Definition: syscache.c:1310
int16 AttrNumber
Definition: attnum.h:21