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-2018, 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 32 enum SysCacheIdentifier 33 { 34 AGGFNOID = 0, 35 AMNAME, 36 AMOID, 37 AMOPOPID, 38 AMOPSTRATEGY, 39 AMPROCNUM, 40 ATTNAME, 41 ATTNUM, 42 AUTHMEMMEMROLE, 43 AUTHMEMROLEMEM, 44 AUTHNAME, 45 AUTHOID, 46 CASTSOURCETARGET, 47 CLAAMNAMENSP, 48 CLAOID, 49 COLLNAMEENCNSP, 50 COLLOID, 51 CONDEFAULT, 52 CONNAMENSP, 53 CONSTROID, 54 CONVOID, 55 DATABASEOID, 56 DEFACLROLENSPOBJ, 57 ENUMOID, 58 ENUMTYPOIDNAME, 59 EVENTTRIGGERNAME, 60 EVENTTRIGGEROID, 61 FOREIGNDATAWRAPPERNAME, 62 FOREIGNDATAWRAPPEROID, 63 FOREIGNSERVERNAME, 64 FOREIGNSERVEROID, 65 FOREIGNTABLEREL, 66 INDEXRELID, 67 LANGNAME, 68 LANGOID, 69 NAMESPACENAME, 70 NAMESPACEOID, 71 OPERNAMENSP, 72 OPEROID, 73 OPFAMILYAMNAMENSP, 74 OPFAMILYOID, 75 PARTRELID, 76 PROCNAMEARGSNSP, 77 PROCOID, 78 PUBLICATIONNAME, 79 PUBLICATIONOID, 80 PUBLICATIONREL, 81 PUBLICATIONRELMAP, 82 RANGETYPE, 83 RELNAMENSP, 84 RELOID, 85 REPLORIGIDENT, 86 REPLORIGNAME, 87 RULERELNAME, 88 SEQRELID, 89 STATEXTNAMENSP, 90 STATEXTOID, 91 STATRELATTINH, 92 SUBSCRIPTIONNAME, 93 SUBSCRIPTIONOID, 94 SUBSCRIPTIONRELMAP, 95 TABLESPACEOID, 96 TRFOID, 97 TRFTYPELANG, 98 TSCONFIGMAP, 99 TSCONFIGNAMENSP, 100 TSCONFIGOID, 101 TSDICTNAMENSP, 102 TSDICTOID, 103 TSPARSERNAMENSP, 104 TSPARSEROID, 105 TSTEMPLATENAMENSP, 106 TSTEMPLATEOID, 107 TYPENAMENSP, 108 TYPEOID, 109 USERMAPPINGOID, 110 USERMAPPINGUSERSERVER 111 112 #define SysCacheSize (USERMAPPINGUSERSERVER + 1) 113 }; 114 115 extern void InitCatalogCache(void); 116 extern void InitCatalogCachePhase2(void); 117 118 extern HeapTuple SearchSysCache(int cacheId, 119 Datum key1, Datum key2, Datum key3, Datum key4); 120 121 /* 122 * The use of argument specific numbers is encouraged. They're faster, and 123 * insulates the caller from changes in the maximum number of keys. 124 */ 125 extern HeapTuple SearchSysCache1(int cacheId, 126 Datum key1); 127 extern HeapTuple SearchSysCache2(int cacheId, 128 Datum key1, Datum key2); 129 extern HeapTuple SearchSysCache3(int cacheId, 130 Datum key1, Datum key2, Datum key3); 131 extern HeapTuple SearchSysCache4(int cacheId, 132 Datum key1, Datum key2, Datum key3, Datum key4); 133 134 extern void ReleaseSysCache(HeapTuple tuple); 135 136 /* convenience routines */ 137 extern HeapTuple SearchSysCacheCopy(int cacheId, 138 Datum key1, Datum key2, Datum key3, Datum key4); 139 extern bool SearchSysCacheExists(int cacheId, 140 Datum key1, Datum key2, Datum key3, Datum key4); 141 extern Oid GetSysCacheOid(int cacheId, 142 Datum key1, Datum key2, Datum key3, Datum key4); 143 144 extern HeapTuple SearchSysCacheAttName(Oid relid, const char *attname); 145 extern HeapTuple SearchSysCacheCopyAttName(Oid relid, const char *attname); 146 extern bool SearchSysCacheExistsAttName(Oid relid, const char *attname); 147 148 extern HeapTuple SearchSysCacheAttNum(Oid relid, int16 attnum); 149 extern HeapTuple SearchSysCacheCopyAttNum(Oid relid, int16 attnum); 150 151 extern Datum SysCacheGetAttr(int cacheId, HeapTuple tup, 152 AttrNumber attributeNumber, bool *isNull); 153 154 extern uint32 GetSysCacheHashValue(int cacheId, 155 Datum key1, Datum key2, Datum key3, Datum key4); 156 157 /* list-search interface. Users of this must import catcache.h too */ 158 struct catclist; 159 extern struct catclist *SearchSysCacheList(int cacheId, int nkeys, 160 Datum key1, Datum key2, Datum key3); 161 162 extern void SysCacheInvalidate(int cacheId, uint32 hashValue); 163 164 extern bool RelationInvalidatesSnapshotsOnly(Oid relid); 165 extern bool RelationHasSysCache(Oid relid); 166 extern bool RelationSupportsSysCache(Oid relid); 167 168 /* 169 * The use of the macros below rather than direct calls to the corresponding 170 * functions is encouraged, as it insulates the caller from changes in the 171 * maximum number of keys. 172 */ 173 #define SearchSysCacheCopy1(cacheId, key1) \ 174 SearchSysCacheCopy(cacheId, key1, 0, 0, 0) 175 #define SearchSysCacheCopy2(cacheId, key1, key2) \ 176 SearchSysCacheCopy(cacheId, key1, key2, 0, 0) 177 #define SearchSysCacheCopy3(cacheId, key1, key2, key3) \ 178 SearchSysCacheCopy(cacheId, key1, key2, key3, 0) 179 #define SearchSysCacheCopy4(cacheId, key1, key2, key3, key4) \ 180 SearchSysCacheCopy(cacheId, key1, key2, key3, key4) 181 182 #define SearchSysCacheExists1(cacheId, key1) \ 183 SearchSysCacheExists(cacheId, key1, 0, 0, 0) 184 #define SearchSysCacheExists2(cacheId, key1, key2) \ 185 SearchSysCacheExists(cacheId, key1, key2, 0, 0) 186 #define SearchSysCacheExists3(cacheId, key1, key2, key3) \ 187 SearchSysCacheExists(cacheId, key1, key2, key3, 0) 188 #define SearchSysCacheExists4(cacheId, key1, key2, key3, key4) \ 189 SearchSysCacheExists(cacheId, key1, key2, key3, key4) 190 191 #define GetSysCacheOid1(cacheId, key1) \ 192 GetSysCacheOid(cacheId, key1, 0, 0, 0) 193 #define GetSysCacheOid2(cacheId, key1, key2) \ 194 GetSysCacheOid(cacheId, key1, key2, 0, 0) 195 #define GetSysCacheOid3(cacheId, key1, key2, key3) \ 196 GetSysCacheOid(cacheId, key1, key2, key3, 0) 197 #define GetSysCacheOid4(cacheId, key1, key2, key3, key4) \ 198 GetSysCacheOid(cacheId, key1, key2, key3, key4) 199 200 #define GetSysCacheHashValue1(cacheId, key1) \ 201 GetSysCacheHashValue(cacheId, key1, 0, 0, 0) 202 #define GetSysCacheHashValue2(cacheId, key1, key2) \ 203 GetSysCacheHashValue(cacheId, key1, key2, 0, 0) 204 #define GetSysCacheHashValue3(cacheId, key1, key2, key3) \ 205 GetSysCacheHashValue(cacheId, key1, key2, key3, 0) 206 #define GetSysCacheHashValue4(cacheId, key1, key2, key3, key4) \ 207 GetSysCacheHashValue(cacheId, key1, key2, key3, key4) 208 209 #define SearchSysCacheList1(cacheId, key1) \ 210 SearchSysCacheList(cacheId, 1, key1, 0, 0) 211 #define SearchSysCacheList2(cacheId, key1, key2) \ 212 SearchSysCacheList(cacheId, 2, key1, key2, 0) 213 #define SearchSysCacheList3(cacheId, key1, key2, key3) \ 214 SearchSysCacheList(cacheId, 3, key1, key2, key3) 215 216 #define ReleaseSysCacheList(x) ReleaseCatCacheList(x) 217 218 #endif /* SYSCACHE_H */ 219