Line data Source code
1 : /*-------------------------------------------------------------------------
2 : *
3 : * catcache.c
4 : * System catalog cache for tuples matching a key.
5 : *
6 : * Portions Copyright (c) 1996-2024, PostgreSQL Global Development Group
7 : * Portions Copyright (c) 1994, Regents of the University of California
8 : *
9 : *
10 : * IDENTIFICATION
11 : * src/backend/utils/cache/catcache.c
12 : *
13 : *-------------------------------------------------------------------------
14 : */
15 : #include "postgres.h"
16 :
17 : #include "access/genam.h"
18 : #include "access/heaptoast.h"
19 : #include "access/relscan.h"
20 : #include "access/table.h"
21 : #include "access/xact.h"
22 : #include "catalog/catalog.h"
23 : #include "catalog/pg_collation.h"
24 : #include "catalog/pg_type.h"
25 : #include "common/hashfn.h"
26 : #include "common/pg_prng.h"
27 : #include "miscadmin.h"
28 : #include "port/pg_bitutils.h"
29 : #ifdef CATCACHE_STATS
30 : #include "storage/ipc.h" /* for on_proc_exit */
31 : #endif
32 : #include "storage/lmgr.h"
33 : #include "utils/builtins.h"
34 : #include "utils/catcache.h"
35 : #include "utils/datum.h"
36 : #include "utils/fmgroids.h"
37 : #include "utils/inval.h"
38 : #include "utils/memutils.h"
39 : #include "utils/rel.h"
40 : #include "utils/resowner.h"
41 : #include "utils/syscache.h"
42 :
43 :
44 : /* #define CACHEDEBUG */ /* turns DEBUG elogs on */
45 :
46 : /*
47 : * Given a hash value and the size of the hash table, find the bucket
48 : * in which the hash value belongs. Since the hash table must contain
49 : * a power-of-2 number of elements, this is a simple bitmask.
50 : */
51 : #define HASH_INDEX(h, sz) ((Index) ((h) & ((sz) - 1)))
52 :
53 :
54 : /*
55 : * variables, macros and other stuff
56 : */
57 :
58 : #ifdef CACHEDEBUG
59 : #define CACHE_elog(...) elog(__VA_ARGS__)
60 : #else
61 : #define CACHE_elog(...)
62 : #endif
63 :
64 : /* Cache management header --- pointer is NULL until created */
65 : static CatCacheHeader *CacheHdr = NULL;
66 :
67 : static inline HeapTuple SearchCatCacheInternal(CatCache *cache,
68 : int nkeys,
69 : Datum v1, Datum v2,
70 : Datum v3, Datum v4);
71 :
72 : static pg_noinline HeapTuple SearchCatCacheMiss(CatCache *cache,
73 : int nkeys,
74 : uint32 hashValue,
75 : Index hashIndex,
76 : Datum v1, Datum v2,
77 : Datum v3, Datum v4);
78 :
79 : static uint32 CatalogCacheComputeHashValue(CatCache *cache, int nkeys,
80 : Datum v1, Datum v2, Datum v3, Datum v4);
81 : static uint32 CatalogCacheComputeTupleHashValue(CatCache *cache, int nkeys,
82 : HeapTuple tuple);
83 : static inline bool CatalogCacheCompareTuple(const CatCache *cache, int nkeys,
84 : const Datum *cachekeys,
85 : const Datum *searchkeys);
86 :
87 : #ifdef CATCACHE_STATS
88 : static void CatCachePrintStats(int code, Datum arg);
89 : #endif
90 : static void CatCacheRemoveCTup(CatCache *cache, CatCTup *ct);
91 : static void CatCacheRemoveCList(CatCache *cache, CatCList *cl);
92 : static void RehashCatCache(CatCache *cp);
93 : static void RehashCatCacheLists(CatCache *cp);
94 : static void CatalogCacheInitializeCache(CatCache *cache);
95 : static CatCTup *CatalogCacheCreateEntry(CatCache *cache,
96 : HeapTuple ntp, SysScanDesc scandesc,
97 : Datum *arguments,
98 : uint32 hashValue, Index hashIndex);
99 :
100 : static void ReleaseCatCacheWithOwner(HeapTuple tuple, ResourceOwner resowner);
101 : static void ReleaseCatCacheListWithOwner(CatCList *list, ResourceOwner resowner);
102 : static void CatCacheFreeKeys(TupleDesc tupdesc, int nkeys, int *attnos,
103 : Datum *keys);
104 : static void CatCacheCopyKeys(TupleDesc tupdesc, int nkeys, int *attnos,
105 : Datum *srckeys, Datum *dstkeys);
106 :
107 :
108 : /*
109 : * internal support functions
110 : */
111 :
112 : /* ResourceOwner callbacks to hold catcache references */
113 :
114 : static void ResOwnerReleaseCatCache(Datum res);
115 : static char *ResOwnerPrintCatCache(Datum res);
116 : static void ResOwnerReleaseCatCacheList(Datum res);
117 : static char *ResOwnerPrintCatCacheList(Datum res);
118 :
119 : static const ResourceOwnerDesc catcache_resowner_desc =
120 : {
121 : /* catcache references */
122 : .name = "catcache reference",
123 : .release_phase = RESOURCE_RELEASE_AFTER_LOCKS,
124 : .release_priority = RELEASE_PRIO_CATCACHE_REFS,
125 : .ReleaseResource = ResOwnerReleaseCatCache,
126 : .DebugPrint = ResOwnerPrintCatCache
127 : };
128 :
129 : static const ResourceOwnerDesc catlistref_resowner_desc =
130 : {
131 : /* catcache-list pins */
132 : .name = "catcache list reference",
133 : .release_phase = RESOURCE_RELEASE_AFTER_LOCKS,
134 : .release_priority = RELEASE_PRIO_CATCACHE_LIST_REFS,
135 : .ReleaseResource = ResOwnerReleaseCatCacheList,
136 : .DebugPrint = ResOwnerPrintCatCacheList
137 : };
138 :
139 : /* Convenience wrappers over ResourceOwnerRemember/Forget */
140 : static inline void
141 75420112 : ResourceOwnerRememberCatCacheRef(ResourceOwner owner, HeapTuple tuple)
142 : {
143 75420112 : ResourceOwnerRemember(owner, PointerGetDatum(tuple), &catcache_resowner_desc);
144 75420112 : }
145 : static inline void
146 75409880 : ResourceOwnerForgetCatCacheRef(ResourceOwner owner, HeapTuple tuple)
147 : {
148 75409880 : ResourceOwnerForget(owner, PointerGetDatum(tuple), &catcache_resowner_desc);
149 75409880 : }
150 : static inline void
151 3305142 : ResourceOwnerRememberCatCacheListRef(ResourceOwner owner, CatCList *list)
152 : {
153 3305142 : ResourceOwnerRemember(owner, PointerGetDatum(list), &catlistref_resowner_desc);
154 3305142 : }
155 : static inline void
156 3305106 : ResourceOwnerForgetCatCacheListRef(ResourceOwner owner, CatCList *list)
157 : {
158 3305106 : ResourceOwnerForget(owner, PointerGetDatum(list), &catlistref_resowner_desc);
159 3305106 : }
160 :
161 :
162 : /*
163 : * Hash and equality functions for system types that are used as cache key
164 : * fields. In some cases, we just call the regular SQL-callable functions for
165 : * the appropriate data type, but that tends to be a little slow, and the
166 : * speed of these functions is performance-critical. Therefore, for data
167 : * types that frequently occur as catcache keys, we hard-code the logic here.
168 : * Avoiding the overhead of DirectFunctionCallN(...) is a substantial win, and
169 : * in certain cases (like int4) we can adopt a faster hash algorithm as well.
170 : */
171 :
172 : static bool
173 4796624 : chareqfast(Datum a, Datum b)
174 : {
175 4796624 : return DatumGetChar(a) == DatumGetChar(b);
176 : }
177 :
178 : static uint32
179 5466236 : charhashfast(Datum datum)
180 : {
181 5466236 : return murmurhash32((int32) DatumGetChar(datum));
182 : }
183 :
184 : static bool
185 3604344 : nameeqfast(Datum a, Datum b)
186 : {
187 3604344 : char *ca = NameStr(*DatumGetName(a));
188 3604344 : char *cb = NameStr(*DatumGetName(b));
189 :
190 3604344 : return strncmp(ca, cb, NAMEDATALEN) == 0;
191 : }
192 :
193 : static uint32
194 8135716 : namehashfast(Datum datum)
195 : {
196 8135716 : char *key = NameStr(*DatumGetName(datum));
197 :
198 8135716 : return hash_any((unsigned char *) key, strlen(key));
199 : }
200 :
201 : static bool
202 7706198 : int2eqfast(Datum a, Datum b)
203 : {
204 7706198 : return DatumGetInt16(a) == DatumGetInt16(b);
205 : }
206 :
207 : static uint32
208 10586716 : int2hashfast(Datum datum)
209 : {
210 10586716 : return murmurhash32((int32) DatumGetInt16(datum));
211 : }
212 :
213 : static bool
214 88610982 : int4eqfast(Datum a, Datum b)
215 : {
216 88610982 : return DatumGetInt32(a) == DatumGetInt32(b);
217 : }
218 :
219 : static uint32
220 103777708 : int4hashfast(Datum datum)
221 : {
222 103777708 : return murmurhash32((int32) DatumGetInt32(datum));
223 : }
224 :
225 : static bool
226 166 : texteqfast(Datum a, Datum b)
227 : {
228 : /*
229 : * The use of DEFAULT_COLLATION_OID is fairly arbitrary here. We just
230 : * want to take the fast "deterministic" path in texteq().
231 : */
232 166 : return DatumGetBool(DirectFunctionCall2Coll(texteq, DEFAULT_COLLATION_OID, a, b));
233 : }
234 :
235 : static uint32
236 3406 : texthashfast(Datum datum)
237 : {
238 : /* analogously here as in texteqfast() */
239 3406 : return DatumGetInt32(DirectFunctionCall1Coll(hashtext, DEFAULT_COLLATION_OID, datum));
240 : }
241 :
242 : static bool
243 2792 : oidvectoreqfast(Datum a, Datum b)
244 : {
245 2792 : return DatumGetBool(DirectFunctionCall2(oidvectoreq, a, b));
246 : }
247 :
248 : static uint32
249 355750 : oidvectorhashfast(Datum datum)
250 : {
251 355750 : return DatumGetInt32(DirectFunctionCall1(hashoidvector, datum));
252 : }
253 :
254 : /* Lookup support functions for a type. */
255 : static void
256 1005054 : GetCCHashEqFuncs(Oid keytype, CCHashFN *hashfunc, RegProcedure *eqfunc, CCFastEqualFN *fasteqfunc)
257 : {
258 1005054 : switch (keytype)
259 : {
260 13336 : case BOOLOID:
261 13336 : *hashfunc = charhashfast;
262 13336 : *fasteqfunc = chareqfast;
263 13336 : *eqfunc = F_BOOLEQ;
264 13336 : break;
265 17808 : case CHAROID:
266 17808 : *hashfunc = charhashfast;
267 17808 : *fasteqfunc = chareqfast;
268 17808 : *eqfunc = F_CHAREQ;
269 17808 : break;
270 188766 : case NAMEOID:
271 188766 : *hashfunc = namehashfast;
272 188766 : *fasteqfunc = nameeqfast;
273 188766 : *eqfunc = F_NAMEEQ;
274 188766 : break;
275 58116 : case INT2OID:
276 58116 : *hashfunc = int2hashfast;
277 58116 : *fasteqfunc = int2eqfast;
278 58116 : *eqfunc = F_INT2EQ;
279 58116 : break;
280 14776 : case INT4OID:
281 14776 : *hashfunc = int4hashfast;
282 14776 : *fasteqfunc = int4eqfast;
283 14776 : *eqfunc = F_INT4EQ;
284 14776 : break;
285 6608 : case TEXTOID:
286 6608 : *hashfunc = texthashfast;
287 6608 : *fasteqfunc = texteqfast;
288 6608 : *eqfunc = F_TEXTEQ;
289 6608 : break;
290 691510 : case OIDOID:
291 : case REGPROCOID:
292 : case REGPROCEDUREOID:
293 : case REGOPEROID:
294 : case REGOPERATOROID:
295 : case REGCLASSOID:
296 : case REGTYPEOID:
297 : case REGCOLLATIONOID:
298 : case REGCONFIGOID:
299 : case REGDICTIONARYOID:
300 : case REGROLEOID:
301 : case REGNAMESPACEOID:
302 691510 : *hashfunc = int4hashfast;
303 691510 : *fasteqfunc = int4eqfast;
304 691510 : *eqfunc = F_OIDEQ;
305 691510 : break;
306 14134 : case OIDVECTOROID:
307 14134 : *hashfunc = oidvectorhashfast;
308 14134 : *fasteqfunc = oidvectoreqfast;
309 14134 : *eqfunc = F_OIDVECTOREQ;
310 14134 : break;
311 0 : default:
312 0 : elog(FATAL, "type %u not supported as catcache key", keytype);
313 : *hashfunc = NULL; /* keep compiler quiet */
314 :
315 : *eqfunc = InvalidOid;
316 : break;
317 : }
318 1005054 : }
319 :
320 : /*
321 : * CatalogCacheComputeHashValue
322 : *
323 : * Compute the hash value associated with a given set of lookup keys
324 : */
325 : static uint32
326 91523898 : CatalogCacheComputeHashValue(CatCache *cache, int nkeys,
327 : Datum v1, Datum v2, Datum v3, Datum v4)
328 : {
329 91523898 : uint32 hashValue = 0;
330 : uint32 oneHash;
331 91523898 : CCHashFN *cc_hashfunc = cache->cc_hashfunc;
332 :
333 : CACHE_elog(DEBUG2, "CatalogCacheComputeHashValue %s %d %p",
334 : cache->cc_relname, nkeys, cache);
335 :
336 91523898 : switch (nkeys)
337 : {
338 4291502 : case 4:
339 4291502 : oneHash = (cc_hashfunc[3]) (v4);
340 4291502 : hashValue ^= pg_rotate_left32(oneHash, 24);
341 : /* FALLTHROUGH */
342 10502722 : case 3:
343 10502722 : oneHash = (cc_hashfunc[2]) (v3);
344 10502722 : hashValue ^= pg_rotate_left32(oneHash, 16);
345 : /* FALLTHROUGH */
346 22007410 : case 2:
347 22007410 : oneHash = (cc_hashfunc[1]) (v2);
348 22007410 : hashValue ^= pg_rotate_left32(oneHash, 8);
349 : /* FALLTHROUGH */
350 91523898 : case 1:
351 91523898 : oneHash = (cc_hashfunc[0]) (v1);
352 91523898 : hashValue ^= oneHash;
353 91523898 : break;
354 0 : default:
355 0 : elog(FATAL, "wrong number of hash keys: %d", nkeys);
356 : break;
357 : }
358 :
359 91523898 : return hashValue;
360 : }
361 :
362 : /*
363 : * CatalogCacheComputeTupleHashValue
364 : *
365 : * Compute the hash value associated with a given tuple to be cached
366 : */
367 : static uint32
368 6510082 : CatalogCacheComputeTupleHashValue(CatCache *cache, int nkeys, HeapTuple tuple)
369 : {
370 6510082 : Datum v1 = 0,
371 6510082 : v2 = 0,
372 6510082 : v3 = 0,
373 6510082 : v4 = 0;
374 6510082 : bool isNull = false;
375 6510082 : int *cc_keyno = cache->cc_keyno;
376 6510082 : TupleDesc cc_tupdesc = cache->cc_tupdesc;
377 :
378 : /* Now extract key fields from tuple, insert into scankey */
379 6510082 : switch (nkeys)
380 : {
381 395884 : case 4:
382 395884 : v4 = fastgetattr(tuple,
383 395884 : cc_keyno[3],
384 : cc_tupdesc,
385 : &isNull);
386 : Assert(!isNull);
387 : /* FALLTHROUGH */
388 1127060 : case 3:
389 1127060 : v3 = fastgetattr(tuple,
390 1127060 : cc_keyno[2],
391 : cc_tupdesc,
392 : &isNull);
393 : Assert(!isNull);
394 : /* FALLTHROUGH */
395 4739436 : case 2:
396 4739436 : v2 = fastgetattr(tuple,
397 4739436 : cc_keyno[1],
398 : cc_tupdesc,
399 : &isNull);
400 : Assert(!isNull);
401 : /* FALLTHROUGH */
402 6510082 : case 1:
403 6510082 : v1 = fastgetattr(tuple,
404 : cc_keyno[0],
405 : cc_tupdesc,
406 : &isNull);
407 : Assert(!isNull);
408 6510082 : break;
409 0 : default:
410 0 : elog(FATAL, "wrong number of hash keys: %d", nkeys);
411 : break;
412 : }
413 :
414 6510082 : return CatalogCacheComputeHashValue(cache, nkeys, v1, v2, v3, v4);
415 : }
416 :
417 : /*
418 : * CatalogCacheCompareTuple
419 : *
420 : * Compare a tuple to the passed arguments.
421 : */
422 : static inline bool
423 78524304 : CatalogCacheCompareTuple(const CatCache *cache, int nkeys,
424 : const Datum *cachekeys,
425 : const Datum *searchkeys)
426 : {
427 78524304 : const CCFastEqualFN *cc_fastequal = cache->cc_fastequal;
428 : int i;
429 :
430 183245410 : for (i = 0; i < nkeys; i++)
431 : {
432 104721106 : if (!(cc_fastequal[i]) (cachekeys[i], searchkeys[i]))
433 0 : return false;
434 : }
435 78524304 : return true;
436 : }
437 :
438 :
439 : #ifdef CATCACHE_STATS
440 :
441 : static void
442 : CatCachePrintStats(int code, Datum arg)
443 : {
444 : slist_iter iter;
445 : long cc_searches = 0;
446 : long cc_hits = 0;
447 : long cc_neg_hits = 0;
448 : long cc_newloads = 0;
449 : long cc_invals = 0;
450 : long cc_nlists = 0;
451 : long cc_lsearches = 0;
452 : long cc_lhits = 0;
453 :
454 : slist_foreach(iter, &CacheHdr->ch_caches)
455 : {
456 : CatCache *cache = slist_container(CatCache, cc_next, iter.cur);
457 :
458 : if (cache->cc_ntup == 0 && cache->cc_searches == 0)
459 : continue; /* don't print unused caches */
460 : elog(DEBUG2, "catcache %s/%u: %d tup, %ld srch, %ld+%ld=%ld hits, %ld+%ld=%ld loads, %ld invals, %d lists, %ld lsrch, %ld lhits",
461 : cache->cc_relname,
462 : cache->cc_indexoid,
463 : cache->cc_ntup,
464 : cache->cc_searches,
465 : cache->cc_hits,
466 : cache->cc_neg_hits,
467 : cache->cc_hits + cache->cc_neg_hits,
468 : cache->cc_newloads,
469 : cache->cc_searches - cache->cc_hits - cache->cc_neg_hits - cache->cc_newloads,
470 : cache->cc_searches - cache->cc_hits - cache->cc_neg_hits,
471 : cache->cc_invals,
472 : cache->cc_nlist,
473 : cache->cc_lsearches,
474 : cache->cc_lhits);
475 : cc_searches += cache->cc_searches;
476 : cc_hits += cache->cc_hits;
477 : cc_neg_hits += cache->cc_neg_hits;
478 : cc_newloads += cache->cc_newloads;
479 : cc_invals += cache->cc_invals;
480 : cc_nlists += cache->cc_nlist;
481 : cc_lsearches += cache->cc_lsearches;
482 : cc_lhits += cache->cc_lhits;
483 : }
484 : elog(DEBUG2, "catcache totals: %d tup, %ld srch, %ld+%ld=%ld hits, %ld+%ld=%ld loads, %ld invals, %ld lists, %ld lsrch, %ld lhits",
485 : CacheHdr->ch_ntup,
486 : cc_searches,
487 : cc_hits,
488 : cc_neg_hits,
489 : cc_hits + cc_neg_hits,
490 : cc_newloads,
491 : cc_searches - cc_hits - cc_neg_hits - cc_newloads,
492 : cc_searches - cc_hits - cc_neg_hits,
493 : cc_invals,
494 : cc_nlists,
495 : cc_lsearches,
496 : cc_lhits);
497 : }
498 : #endif /* CATCACHE_STATS */
499 :
500 :
501 : /*
502 : * CatCacheRemoveCTup
503 : *
504 : * Unlink and delete the given cache entry
505 : *
506 : * NB: if it is a member of a CatCList, the CatCList is deleted too.
507 : * Both the cache entry and the list had better have zero refcount.
508 : */
509 : static void
510 1432860 : CatCacheRemoveCTup(CatCache *cache, CatCTup *ct)
511 : {
512 : Assert(ct->refcount == 0);
513 : Assert(ct->my_cache == cache);
514 :
515 1432860 : if (ct->c_list)
516 : {
517 : /*
518 : * The cleanest way to handle this is to call CatCacheRemoveCList,
519 : * which will recurse back to me, and the recursive call will do the
520 : * work. Set the "dead" flag to make sure it does recurse.
521 : */
522 0 : ct->dead = true;
523 0 : CatCacheRemoveCList(cache, ct->c_list);
524 0 : return; /* nothing left to do */
525 : }
526 :
527 : /* delink from linked list */
528 1432860 : dlist_delete(&ct->cache_elem);
529 :
530 : /*
531 : * Free keys when we're dealing with a negative entry, normal entries just
532 : * point into tuple, allocated together with the CatCTup.
533 : */
534 1432860 : if (ct->negative)
535 413962 : CatCacheFreeKeys(cache->cc_tupdesc, cache->cc_nkeys,
536 413962 : cache->cc_keyno, ct->keys);
537 :
538 1432860 : pfree(ct);
539 :
540 1432860 : --cache->cc_ntup;
541 1432860 : --CacheHdr->ch_ntup;
542 : }
543 :
544 : /*
545 : * CatCacheRemoveCList
546 : *
547 : * Unlink and delete the given cache list entry
548 : *
549 : * NB: any dead member entries that become unreferenced are deleted too.
550 : */
551 : static void
552 118024 : CatCacheRemoveCList(CatCache *cache, CatCList *cl)
553 : {
554 : int i;
555 :
556 : Assert(cl->refcount == 0);
557 : Assert(cl->my_cache == cache);
558 :
559 : /* delink from member tuples */
560 397960 : for (i = cl->n_members; --i >= 0;)
561 : {
562 279936 : CatCTup *ct = cl->members[i];
563 :
564 : Assert(ct->c_list == cl);
565 279936 : ct->c_list = NULL;
566 : /* if the member is dead and now has no references, remove it */
567 279936 : if (
568 : #ifndef CATCACHE_FORCE_RELEASE
569 279936 : ct->dead &&
570 : #endif
571 144 : ct->refcount == 0)
572 144 : CatCacheRemoveCTup(cache, ct);
573 : }
574 :
575 : /* delink from linked list */
576 118024 : dlist_delete(&cl->cache_elem);
577 :
578 : /* free associated column data */
579 118024 : CatCacheFreeKeys(cache->cc_tupdesc, cl->nkeys,
580 118024 : cache->cc_keyno, cl->keys);
581 :
582 118024 : pfree(cl);
583 :
584 118024 : --cache->cc_nlist;
585 118024 : }
586 :
587 :
588 : /*
589 : * CatCacheInvalidate
590 : *
591 : * Invalidate entries in the specified cache, given a hash value.
592 : *
593 : * We delete cache entries that match the hash value, whether positive
594 : * or negative. We don't care whether the invalidation is the result
595 : * of a tuple insertion or a deletion.
596 : *
597 : * We used to try to match positive cache entries by TID, but that is
598 : * unsafe after a VACUUM FULL on a system catalog: an inval event could
599 : * be queued before VACUUM FULL, and then processed afterwards, when the
600 : * target tuple that has to be invalidated has a different TID than it
601 : * did when the event was created. So now we just compare hash values and
602 : * accept the small risk of unnecessary invalidations due to false matches.
603 : *
604 : * This routine is only quasi-public: it should only be used by inval.c.
605 : */
606 : void
607 19361328 : CatCacheInvalidate(CatCache *cache, uint32 hashValue)
608 : {
609 : Index hashIndex;
610 : dlist_mutable_iter iter;
611 :
612 : CACHE_elog(DEBUG2, "CatCacheInvalidate: called");
613 :
614 : /*
615 : * We don't bother to check whether the cache has finished initialization
616 : * yet; if not, there will be no entries in it so no problem.
617 : */
618 :
619 : /*
620 : * Invalidate *all* CatCLists in this cache; it's too hard to tell which
621 : * searches might still be correct, so just zap 'em all.
622 : */
623 22866800 : for (int i = 0; i < cache->cc_nlbuckets; i++)
624 : {
625 3505472 : dlist_head *bucket = &cache->cc_lbucket[i];
626 :
627 3618836 : dlist_foreach_modify(iter, bucket)
628 : {
629 113364 : CatCList *cl = dlist_container(CatCList, cache_elem, iter.cur);
630 :
631 113364 : if (cl->refcount > 0)
632 146 : cl->dead = true;
633 : else
634 113218 : CatCacheRemoveCList(cache, cl);
635 : }
636 : }
637 :
638 : /*
639 : * inspect the proper hash bucket for tuple matches
640 : */
641 19361328 : hashIndex = HASH_INDEX(hashValue, cache->cc_nbuckets);
642 26230948 : dlist_foreach_modify(iter, &cache->cc_bucket[hashIndex])
643 : {
644 6869620 : CatCTup *ct = dlist_container(CatCTup, cache_elem, iter.cur);
645 :
646 6869620 : if (hashValue == ct->hash_value)
647 : {
648 1259620 : if (ct->refcount > 0 ||
649 1258324 : (ct->c_list && ct->c_list->refcount > 0))
650 : {
651 1440 : ct->dead = true;
652 : /* list, if any, was marked dead above */
653 1440 : Assert(ct->c_list == NULL || ct->c_list->dead);
654 : }
655 : else
656 1258180 : CatCacheRemoveCTup(cache, ct);
657 : CACHE_elog(DEBUG2, "CatCacheInvalidate: invalidated");
658 : #ifdef CATCACHE_STATS
659 : cache->cc_invals++;
660 : #endif
661 : /* could be multiple matches, so keep looking! */
662 : }
663 : }
664 19361328 : }
665 :
666 : /* ----------------------------------------------------------------
667 : * public functions
668 : * ----------------------------------------------------------------
669 : */
670 :
671 :
672 : /*
673 : * Standard routine for creating cache context if it doesn't exist yet
674 : *
675 : * There are a lot of places (probably far more than necessary) that check
676 : * whether CacheMemoryContext exists yet and want to create it if not.
677 : * We centralize knowledge of exactly how to create it here.
678 : */
679 : void
680 28528 : CreateCacheMemoryContext(void)
681 : {
682 : /*
683 : * Purely for paranoia, check that context doesn't exist; caller probably
684 : * did so already.
685 : */
686 28528 : if (!CacheMemoryContext)
687 28528 : CacheMemoryContext = AllocSetContextCreate(TopMemoryContext,
688 : "CacheMemoryContext",
689 : ALLOCSET_DEFAULT_SIZES);
690 28528 : }
691 :
692 :
693 : /*
694 : * ResetCatalogCache
695 : *
696 : * Reset one catalog cache to empty.
697 : *
698 : * This is not very efficient if the target cache is nearly empty.
699 : * However, it shouldn't need to be efficient; we don't invoke it often.
700 : */
701 : static void
702 347590 : ResetCatalogCache(CatCache *cache)
703 : {
704 : dlist_mutable_iter iter;
705 : int i;
706 :
707 : /* Remove each list in this cache, or at least mark it dead */
708 390118 : for (i = 0; i < cache->cc_nlbuckets; i++)
709 : {
710 42528 : dlist_head *bucket = &cache->cc_lbucket[i];
711 :
712 47326 : dlist_foreach_modify(iter, bucket)
713 : {
714 4798 : CatCList *cl = dlist_container(CatCList, cache_elem, iter.cur);
715 :
716 4798 : if (cl->refcount > 0)
717 0 : cl->dead = true;
718 : else
719 4798 : CatCacheRemoveCList(cache, cl);
720 : }
721 : }
722 :
723 : /* Remove each tuple in this cache, or at least mark it dead */
724 10402518 : for (i = 0; i < cache->cc_nbuckets; i++)
725 : {
726 10054928 : dlist_head *bucket = &cache->cc_bucket[i];
727 :
728 10228174 : dlist_foreach_modify(iter, bucket)
729 : {
730 173246 : CatCTup *ct = dlist_container(CatCTup, cache_elem, iter.cur);
731 :
732 173246 : if (ct->refcount > 0 ||
733 173238 : (ct->c_list && ct->c_list->refcount > 0))
734 : {
735 8 : ct->dead = true;
736 : /* list, if any, was marked dead above */
737 8 : Assert(ct->c_list == NULL || ct->c_list->dead);
738 : }
739 : else
740 173238 : CatCacheRemoveCTup(cache, ct);
741 : #ifdef CATCACHE_STATS
742 : cache->cc_invals++;
743 : #endif
744 : }
745 : }
746 347590 : }
747 :
748 : /*
749 : * ResetCatalogCaches
750 : *
751 : * Reset all caches when a shared cache inval event forces it
752 : */
753 : void
754 4078 : ResetCatalogCaches(void)
755 : {
756 : slist_iter iter;
757 :
758 : CACHE_elog(DEBUG2, "ResetCatalogCaches called");
759 :
760 350708 : slist_foreach(iter, &CacheHdr->ch_caches)
761 : {
762 346630 : CatCache *cache = slist_container(CatCache, cc_next, iter.cur);
763 :
764 346630 : ResetCatalogCache(cache);
765 : }
766 :
767 : CACHE_elog(DEBUG2, "end of ResetCatalogCaches call");
768 4078 : }
769 :
770 : /*
771 : * CatalogCacheFlushCatalog
772 : *
773 : * Flush all catcache entries that came from the specified system catalog.
774 : * This is needed after VACUUM FULL/CLUSTER on the catalog, since the
775 : * tuples very likely now have different TIDs than before. (At one point
776 : * we also tried to force re-execution of CatalogCacheInitializeCache for
777 : * the cache(s) on that catalog. This is a bad idea since it leads to all
778 : * kinds of trouble if a cache flush occurs while loading cache entries.
779 : * We now avoid the need to do it by copying cc_tupdesc out of the relcache,
780 : * rather than relying on the relcache to keep a tupdesc for us. Of course
781 : * this assumes the tupdesc of a cachable system table will not change...)
782 : */
783 : void
784 734 : CatalogCacheFlushCatalog(Oid catId)
785 : {
786 : slist_iter iter;
787 :
788 : CACHE_elog(DEBUG2, "CatalogCacheFlushCatalog called for %u", catId);
789 :
790 63124 : slist_foreach(iter, &CacheHdr->ch_caches)
791 : {
792 62390 : CatCache *cache = slist_container(CatCache, cc_next, iter.cur);
793 :
794 : /* Does this cache store tuples of the target catalog? */
795 62390 : if (cache->cc_reloid == catId)
796 : {
797 : /* Yes, so flush all its contents */
798 960 : ResetCatalogCache(cache);
799 :
800 : /* Tell inval.c to call syscache callbacks for this cache */
801 960 : CallSyscacheCallbacks(cache->id, 0);
802 : }
803 : }
804 :
805 : CACHE_elog(DEBUG2, "end of CatalogCacheFlushCatalog call");
806 734 : }
807 :
808 : /*
809 : * InitCatCache
810 : *
811 : * This allocates and initializes a cache for a system catalog relation.
812 : * Actually, the cache is only partially initialized to avoid opening the
813 : * relation. The relation will be opened and the rest of the cache
814 : * structure initialized on the first access.
815 : */
816 : #ifdef CACHEDEBUG
817 : #define InitCatCache_DEBUG2 \
818 : do { \
819 : elog(DEBUG2, "InitCatCache: rel=%u ind=%u id=%d nkeys=%d size=%d", \
820 : cp->cc_reloid, cp->cc_indexoid, cp->id, \
821 : cp->cc_nkeys, cp->cc_nbuckets); \
822 : } while(0)
823 : #else
824 : #define InitCatCache_DEBUG2
825 : #endif
826 :
827 : CatCache *
828 2424880 : InitCatCache(int id,
829 : Oid reloid,
830 : Oid indexoid,
831 : int nkeys,
832 : const int *key,
833 : int nbuckets)
834 : {
835 : CatCache *cp;
836 : MemoryContext oldcxt;
837 : int i;
838 :
839 : /*
840 : * nbuckets is the initial number of hash buckets to use in this catcache.
841 : * It will be enlarged later if it becomes too full.
842 : *
843 : * nbuckets must be a power of two. We check this via Assert rather than
844 : * a full runtime check because the values will be coming from constant
845 : * tables.
846 : *
847 : * If you're confused by the power-of-two check, see comments in
848 : * bitmapset.c for an explanation.
849 : */
850 : Assert(nbuckets > 0 && (nbuckets & -nbuckets) == nbuckets);
851 :
852 : /*
853 : * first switch to the cache context so our allocations do not vanish at
854 : * the end of a transaction
855 : */
856 2424880 : if (!CacheMemoryContext)
857 0 : CreateCacheMemoryContext();
858 :
859 2424880 : oldcxt = MemoryContextSwitchTo(CacheMemoryContext);
860 :
861 : /*
862 : * if first time through, initialize the cache group header
863 : */
864 2424880 : if (CacheHdr == NULL)
865 : {
866 28528 : CacheHdr = (CatCacheHeader *) palloc(sizeof(CatCacheHeader));
867 28528 : slist_init(&CacheHdr->ch_caches);
868 28528 : CacheHdr->ch_ntup = 0;
869 : #ifdef CATCACHE_STATS
870 : /* set up to dump stats at backend exit */
871 : on_proc_exit(CatCachePrintStats, 0);
872 : #endif
873 : }
874 :
875 : /*
876 : * Allocate a new cache structure, aligning to a cacheline boundary
877 : *
878 : * Note: we rely on zeroing to initialize all the dlist headers correctly
879 : */
880 2424880 : cp = (CatCache *) palloc_aligned(sizeof(CatCache), PG_CACHE_LINE_SIZE,
881 : MCXT_ALLOC_ZERO);
882 2424880 : cp->cc_bucket = palloc0(nbuckets * sizeof(dlist_head));
883 :
884 : /*
885 : * Many catcaches never receive any list searches. Therefore, we don't
886 : * allocate the cc_lbuckets till we get a list search.
887 : */
888 2424880 : cp->cc_lbucket = NULL;
889 :
890 : /*
891 : * initialize the cache's relation information for the relation
892 : * corresponding to this cache, and initialize some of the new cache's
893 : * other internal fields. But don't open the relation yet.
894 : */
895 2424880 : cp->id = id;
896 2424880 : cp->cc_relname = "(not known yet)";
897 2424880 : cp->cc_reloid = reloid;
898 2424880 : cp->cc_indexoid = indexoid;
899 2424880 : cp->cc_relisshared = false; /* temporary */
900 2424880 : cp->cc_tupdesc = (TupleDesc) NULL;
901 2424880 : cp->cc_ntup = 0;
902 2424880 : cp->cc_nlist = 0;
903 2424880 : cp->cc_nbuckets = nbuckets;
904 2424880 : cp->cc_nlbuckets = 0;
905 2424880 : cp->cc_nkeys = nkeys;
906 6333216 : for (i = 0; i < nkeys; ++i)
907 : {
908 : Assert(AttributeNumberIsValid(key[i]));
909 3908336 : cp->cc_keyno[i] = key[i];
910 : }
911 :
912 : /*
913 : * new cache is initialized as far as we can go for now. print some
914 : * debugging information, if appropriate.
915 : */
916 : InitCatCache_DEBUG2;
917 :
918 : /*
919 : * add completed cache to top of group header's list
920 : */
921 2424880 : slist_push_head(&CacheHdr->ch_caches, &cp->cc_next);
922 :
923 : /*
924 : * back to the old context before we return...
925 : */
926 2424880 : MemoryContextSwitchTo(oldcxt);
927 :
928 2424880 : return cp;
929 : }
930 :
931 : /*
932 : * Enlarge a catcache, doubling the number of buckets.
933 : */
934 : static void
935 5574 : RehashCatCache(CatCache *cp)
936 : {
937 : dlist_head *newbucket;
938 : int newnbuckets;
939 : int i;
940 :
941 5574 : elog(DEBUG1, "rehashing catalog cache id %d for %s; %d tups, %d buckets",
942 : cp->id, cp->cc_relname, cp->cc_ntup, cp->cc_nbuckets);
943 :
944 : /* Allocate a new, larger, hash table. */
945 5574 : newnbuckets = cp->cc_nbuckets * 2;
946 5574 : newbucket = (dlist_head *) MemoryContextAllocZero(CacheMemoryContext, newnbuckets * sizeof(dlist_head));
947 :
948 : /* Move all entries from old hash table to new. */
949 468190 : for (i = 0; i < cp->cc_nbuckets; i++)
950 : {
951 : dlist_mutable_iter iter;
952 :
953 1393422 : dlist_foreach_modify(iter, &cp->cc_bucket[i])
954 : {
955 930806 : CatCTup *ct = dlist_container(CatCTup, cache_elem, iter.cur);
956 930806 : int hashIndex = HASH_INDEX(ct->hash_value, newnbuckets);
957 :
958 930806 : dlist_delete(iter.cur);
959 930806 : dlist_push_head(&newbucket[hashIndex], &ct->cache_elem);
960 : }
961 : }
962 :
963 : /* Switch to the new array. */
964 5574 : pfree(cp->cc_bucket);
965 5574 : cp->cc_nbuckets = newnbuckets;
966 5574 : cp->cc_bucket = newbucket;
967 5574 : }
968 :
969 : /*
970 : * Enlarge a catcache's list storage, doubling the number of buckets.
971 : */
972 : static void
973 1110 : RehashCatCacheLists(CatCache *cp)
974 : {
975 : dlist_head *newbucket;
976 : int newnbuckets;
977 : int i;
978 :
979 1110 : elog(DEBUG1, "rehashing catalog cache id %d for %s; %d lists, %d buckets",
980 : cp->id, cp->cc_relname, cp->cc_nlist, cp->cc_nlbuckets);
981 :
982 : /* Allocate a new, larger, hash table. */
983 1110 : newnbuckets = cp->cc_nlbuckets * 2;
984 1110 : newbucket = (dlist_head *) MemoryContextAllocZero(CacheMemoryContext, newnbuckets * sizeof(dlist_head));
985 :
986 : /* Move all entries from old hash table to new. */
987 43286 : for (i = 0; i < cp->cc_nlbuckets; i++)
988 : {
989 : dlist_mutable_iter iter;
990 :
991 127638 : dlist_foreach_modify(iter, &cp->cc_lbucket[i])
992 : {
993 85462 : CatCList *cl = dlist_container(CatCList, cache_elem, iter.cur);
994 85462 : int hashIndex = HASH_INDEX(cl->hash_value, newnbuckets);
995 :
996 85462 : dlist_delete(iter.cur);
997 85462 : dlist_push_head(&newbucket[hashIndex], &cl->cache_elem);
998 : }
999 : }
1000 :
1001 : /* Switch to the new array. */
1002 1110 : pfree(cp->cc_lbucket);
1003 1110 : cp->cc_nlbuckets = newnbuckets;
1004 1110 : cp->cc_lbucket = newbucket;
1005 1110 : }
1006 :
1007 : /*
1008 : * CatalogCacheInitializeCache
1009 : *
1010 : * This function does final initialization of a catcache: obtain the tuple
1011 : * descriptor and set up the hash and equality function links. We assume
1012 : * that the relcache entry can be opened at this point!
1013 : */
1014 : #ifdef CACHEDEBUG
1015 : #define CatalogCacheInitializeCache_DEBUG1 \
1016 : elog(DEBUG2, "CatalogCacheInitializeCache: cache @%p rel=%u", cache, \
1017 : cache->cc_reloid)
1018 :
1019 : #define CatalogCacheInitializeCache_DEBUG2 \
1020 : do { \
1021 : if (cache->cc_keyno[i] > 0) { \
1022 : elog(DEBUG2, "CatalogCacheInitializeCache: load %d/%d w/%d, %u", \
1023 : i+1, cache->cc_nkeys, cache->cc_keyno[i], \
1024 : TupleDescAttr(tupdesc, cache->cc_keyno[i] - 1)->atttypid); \
1025 : } else { \
1026 : elog(DEBUG2, "CatalogCacheInitializeCache: load %d/%d w/%d", \
1027 : i+1, cache->cc_nkeys, cache->cc_keyno[i]); \
1028 : } \
1029 : } while(0)
1030 : #else
1031 : #define CatalogCacheInitializeCache_DEBUG1
1032 : #define CatalogCacheInitializeCache_DEBUG2
1033 : #endif
1034 :
1035 : static void
1036 633032 : CatalogCacheInitializeCache(CatCache *cache)
1037 : {
1038 : Relation relation;
1039 : MemoryContext oldcxt;
1040 : TupleDesc tupdesc;
1041 : int i;
1042 :
1043 : CatalogCacheInitializeCache_DEBUG1;
1044 :
1045 633032 : relation = table_open(cache->cc_reloid, AccessShareLock);
1046 :
1047 : /*
1048 : * switch to the cache context so our allocations do not vanish at the end
1049 : * of a transaction
1050 : */
1051 : Assert(CacheMemoryContext != NULL);
1052 :
1053 633028 : oldcxt = MemoryContextSwitchTo(CacheMemoryContext);
1054 :
1055 : /*
1056 : * copy the relcache's tuple descriptor to permanent cache storage
1057 : */
1058 633028 : tupdesc = CreateTupleDescCopyConstr(RelationGetDescr(relation));
1059 :
1060 : /*
1061 : * save the relation's name and relisshared flag, too (cc_relname is used
1062 : * only for debugging purposes)
1063 : */
1064 633028 : cache->cc_relname = pstrdup(RelationGetRelationName(relation));
1065 633028 : cache->cc_relisshared = RelationGetForm(relation)->relisshared;
1066 :
1067 : /*
1068 : * return to the caller's memory context and close the rel
1069 : */
1070 633028 : MemoryContextSwitchTo(oldcxt);
1071 :
1072 633028 : table_close(relation, AccessShareLock);
1073 :
1074 : CACHE_elog(DEBUG2, "CatalogCacheInitializeCache: %s, %d keys",
1075 : cache->cc_relname, cache->cc_nkeys);
1076 :
1077 : /*
1078 : * initialize cache's key information
1079 : */
1080 1638082 : for (i = 0; i < cache->cc_nkeys; ++i)
1081 : {
1082 : Oid keytype;
1083 : RegProcedure eqfunc;
1084 :
1085 : CatalogCacheInitializeCache_DEBUG2;
1086 :
1087 1005054 : if (cache->cc_keyno[i] > 0)
1088 : {
1089 1005054 : Form_pg_attribute attr = TupleDescAttr(tupdesc,
1090 : cache->cc_keyno[i] - 1);
1091 :
1092 1005054 : keytype = attr->atttypid;
1093 : /* cache key columns should always be NOT NULL */
1094 : Assert(attr->attnotnull);
1095 : }
1096 : else
1097 : {
1098 0 : if (cache->cc_keyno[i] < 0)
1099 0 : elog(FATAL, "sys attributes are not supported in caches");
1100 0 : keytype = OIDOID;
1101 : }
1102 :
1103 1005054 : GetCCHashEqFuncs(keytype,
1104 : &cache->cc_hashfunc[i],
1105 : &eqfunc,
1106 : &cache->cc_fastequal[i]);
1107 :
1108 : /*
1109 : * Do equality-function lookup (we assume this won't need a catalog
1110 : * lookup for any supported type)
1111 : */
1112 1005054 : fmgr_info_cxt(eqfunc,
1113 : &cache->cc_skey[i].sk_func,
1114 : CacheMemoryContext);
1115 :
1116 : /* Initialize sk_attno suitably for HeapKeyTest() and heap scans */
1117 1005054 : cache->cc_skey[i].sk_attno = cache->cc_keyno[i];
1118 :
1119 : /* Fill in sk_strategy as well --- always standard equality */
1120 1005054 : cache->cc_skey[i].sk_strategy = BTEqualStrategyNumber;
1121 1005054 : cache->cc_skey[i].sk_subtype = InvalidOid;
1122 : /* If a catcache key requires a collation, it must be C collation */
1123 1005054 : cache->cc_skey[i].sk_collation = C_COLLATION_OID;
1124 :
1125 : CACHE_elog(DEBUG2, "CatalogCacheInitializeCache %s %d %p",
1126 : cache->cc_relname, i, cache);
1127 : }
1128 :
1129 : /*
1130 : * mark this cache fully initialized
1131 : */
1132 633028 : cache->cc_tupdesc = tupdesc;
1133 633028 : }
1134 :
1135 : /*
1136 : * InitCatCachePhase2 -- external interface for CatalogCacheInitializeCache
1137 : *
1138 : * One reason to call this routine is to ensure that the relcache has
1139 : * created entries for all the catalogs and indexes referenced by catcaches.
1140 : * Therefore, provide an option to open the index as well as fixing the
1141 : * cache itself. An exception is the indexes on pg_am, which we don't use
1142 : * (cf. IndexScanOK).
1143 : */
1144 : void
1145 262466 : InitCatCachePhase2(CatCache *cache, bool touch_index)
1146 : {
1147 262466 : if (cache->cc_tupdesc == NULL)
1148 244078 : CatalogCacheInitializeCache(cache);
1149 :
1150 262464 : if (touch_index &&
1151 235412 : cache->id != AMOID &&
1152 232642 : cache->id != AMNAME)
1153 : {
1154 : Relation idesc;
1155 :
1156 : /*
1157 : * We must lock the underlying catalog before opening the index to
1158 : * avoid deadlock, since index_open could possibly result in reading
1159 : * this same catalog, and if anyone else is exclusive-locking this
1160 : * catalog and index they'll be doing it in that order.
1161 : */
1162 229872 : LockRelationOid(cache->cc_reloid, AccessShareLock);
1163 229872 : idesc = index_open(cache->cc_indexoid, AccessShareLock);
1164 :
1165 : /*
1166 : * While we've got the index open, let's check that it's unique (and
1167 : * not just deferrable-unique, thank you very much). This is just to
1168 : * catch thinkos in definitions of new catcaches, so we don't worry
1169 : * about the pg_am indexes not getting tested.
1170 : */
1171 : Assert(idesc->rd_index->indisunique &&
1172 : idesc->rd_index->indimmediate);
1173 :
1174 229872 : index_close(idesc, AccessShareLock);
1175 229872 : UnlockRelationOid(cache->cc_reloid, AccessShareLock);
1176 : }
1177 262464 : }
1178 :
1179 :
1180 : /*
1181 : * IndexScanOK
1182 : *
1183 : * This function checks for tuples that will be fetched by
1184 : * IndexSupportInitialize() during relcache initialization for
1185 : * certain system indexes that support critical syscaches.
1186 : * We can't use an indexscan to fetch these, else we'll get into
1187 : * infinite recursion. A plain heap scan will work, however.
1188 : * Once we have completed relcache initialization (signaled by
1189 : * criticalRelcachesBuilt), we don't have to worry anymore.
1190 : *
1191 : * Similarly, during backend startup we have to be able to use the
1192 : * pg_authid, pg_auth_members and pg_database syscaches for
1193 : * authentication even if we don't yet have relcache entries for those
1194 : * catalogs' indexes.
1195 : */
1196 : static bool
1197 5503434 : IndexScanOK(CatCache *cache)
1198 : {
1199 5503434 : switch (cache->id)
1200 : {
1201 532068 : case INDEXRELID:
1202 :
1203 : /*
1204 : * Rather than tracking exactly which indexes have to be loaded
1205 : * before we can use indexscans (which changes from time to time),
1206 : * just force all pg_index searches to be heap scans until we've
1207 : * built the critical relcaches.
1208 : */
1209 532068 : if (!criticalRelcachesBuilt)
1210 32152 : return false;
1211 499916 : break;
1212 :
1213 52032 : case AMOID:
1214 : case AMNAME:
1215 :
1216 : /*
1217 : * Always do heap scans in pg_am, because it's so small there's
1218 : * not much point in an indexscan anyway. We *must* do this when
1219 : * initially building critical relcache entries, but we might as
1220 : * well just always do it.
1221 : */
1222 52032 : return false;
1223 :
1224 94604 : case AUTHNAME:
1225 : case AUTHOID:
1226 : case AUTHMEMMEMROLE:
1227 : case DATABASEOID:
1228 :
1229 : /*
1230 : * Protect authentication lookups occurring before relcache has
1231 : * collected entries for shared indexes.
1232 : */
1233 94604 : if (!criticalSharedRelcachesBuilt)
1234 3974 : return false;
1235 90630 : break;
1236 :
1237 4824730 : default:
1238 4824730 : break;
1239 : }
1240 :
1241 : /* Normal case, allow index scan */
1242 5415276 : return true;
1243 : }
1244 :
1245 : /*
1246 : * SearchCatCache
1247 : *
1248 : * This call searches a system cache for a tuple, opening the relation
1249 : * if necessary (on the first access to a particular cache).
1250 : *
1251 : * The result is NULL if not found, or a pointer to a HeapTuple in
1252 : * the cache. The caller must not modify the tuple, and must call
1253 : * ReleaseCatCache() when done with it.
1254 : *
1255 : * The search key values should be expressed as Datums of the key columns'
1256 : * datatype(s). (Pass zeroes for any unused parameters.) As a special
1257 : * exception, the passed-in key for a NAME column can be just a C string;
1258 : * the caller need not go to the trouble of converting it to a fully
1259 : * null-padded NAME.
1260 : */
1261 : HeapTuple
1262 5049558 : SearchCatCache(CatCache *cache,
1263 : Datum v1,
1264 : Datum v2,
1265 : Datum v3,
1266 : Datum v4)
1267 : {
1268 5049558 : return SearchCatCacheInternal(cache, cache->cc_nkeys, v1, v2, v3, v4);
1269 : }
1270 :
1271 :
1272 : /*
1273 : * SearchCatCacheN() are SearchCatCache() versions for a specific number of
1274 : * arguments. The compiler can inline the body and unroll loops, making them a
1275 : * bit faster than SearchCatCache().
1276 : */
1277 :
1278 : HeapTuple
1279 62068306 : SearchCatCache1(CatCache *cache,
1280 : Datum v1)
1281 : {
1282 62068306 : return SearchCatCacheInternal(cache, 1, v1, 0, 0, 0);
1283 : }
1284 :
1285 :
1286 : HeapTuple
1287 4981830 : SearchCatCache2(CatCache *cache,
1288 : Datum v1, Datum v2)
1289 : {
1290 4981830 : return SearchCatCacheInternal(cache, 2, v1, v2, 0, 0);
1291 : }
1292 :
1293 :
1294 : HeapTuple
1295 4728196 : SearchCatCache3(CatCache *cache,
1296 : Datum v1, Datum v2, Datum v3)
1297 : {
1298 4728196 : return SearchCatCacheInternal(cache, 3, v1, v2, v3, 0);
1299 : }
1300 :
1301 :
1302 : HeapTuple
1303 3894708 : SearchCatCache4(CatCache *cache,
1304 : Datum v1, Datum v2, Datum v3, Datum v4)
1305 : {
1306 3894708 : return SearchCatCacheInternal(cache, 4, v1, v2, v3, v4);
1307 : }
1308 :
1309 : /*
1310 : * Work-horse for SearchCatCache/SearchCatCacheN.
1311 : */
1312 : static inline HeapTuple
1313 80722598 : SearchCatCacheInternal(CatCache *cache,
1314 : int nkeys,
1315 : Datum v1,
1316 : Datum v2,
1317 : Datum v3,
1318 : Datum v4)
1319 : {
1320 : Datum arguments[CATCACHE_MAXKEYS];
1321 : uint32 hashValue;
1322 : Index hashIndex;
1323 : dlist_iter iter;
1324 : dlist_head *bucket;
1325 : CatCTup *ct;
1326 :
1327 : /* Make sure we're in an xact, even if this ends up being a cache hit */
1328 : Assert(IsTransactionState());
1329 :
1330 : Assert(cache->cc_nkeys == nkeys);
1331 :
1332 : /*
1333 : * one-time startup overhead for each cache
1334 : */
1335 80722598 : if (unlikely(cache->cc_tupdesc == NULL))
1336 325124 : CatalogCacheInitializeCache(cache);
1337 :
1338 : #ifdef CATCACHE_STATS
1339 : cache->cc_searches++;
1340 : #endif
1341 :
1342 : /* Initialize local parameter array */
1343 80722596 : arguments[0] = v1;
1344 80722596 : arguments[1] = v2;
1345 80722596 : arguments[2] = v3;
1346 80722596 : arguments[3] = v4;
1347 :
1348 : /*
1349 : * find the hash bucket in which to look for the tuple
1350 : */
1351 80722596 : hashValue = CatalogCacheComputeHashValue(cache, nkeys, v1, v2, v3, v4);
1352 80722596 : hashIndex = HASH_INDEX(hashValue, cache->cc_nbuckets);
1353 :
1354 : /*
1355 : * scan the hash bucket until we find a match or exhaust our tuples
1356 : *
1357 : * Note: it's okay to use dlist_foreach here, even though we modify the
1358 : * dlist within the loop, because we don't continue the loop afterwards.
1359 : */
1360 80722596 : bucket = &cache->cc_bucket[hashIndex];
1361 86035738 : dlist_foreach(iter, bucket)
1362 : {
1363 80808832 : ct = dlist_container(CatCTup, cache_elem, iter.cur);
1364 :
1365 80808832 : if (ct->dead)
1366 2 : continue; /* ignore dead entries */
1367 :
1368 80808830 : if (ct->hash_value != hashValue)
1369 5313140 : continue; /* quickly skip entry if wrong hash val */
1370 :
1371 75495690 : if (!CatalogCacheCompareTuple(cache, nkeys, ct->keys, arguments))
1372 0 : continue;
1373 :
1374 : /*
1375 : * We found a match in the cache. Move it to the front of the list
1376 : * for its hashbucket, in order to speed subsequent searches. (The
1377 : * most frequently accessed elements in any hashbucket will tend to be
1378 : * near the front of the hashbucket's list.)
1379 : */
1380 75495690 : dlist_move_head(bucket, &ct->cache_elem);
1381 :
1382 : /*
1383 : * If it's a positive entry, bump its refcount and return it. If it's
1384 : * negative, we can report failure to the caller.
1385 : */
1386 75495690 : if (!ct->negative)
1387 : {
1388 71722524 : ResourceOwnerEnlarge(CurrentResourceOwner);
1389 71722524 : ct->refcount++;
1390 71722524 : ResourceOwnerRememberCatCacheRef(CurrentResourceOwner, &ct->tuple);
1391 :
1392 : CACHE_elog(DEBUG2, "SearchCatCache(%s): found in bucket %d",
1393 : cache->cc_relname, hashIndex);
1394 :
1395 : #ifdef CATCACHE_STATS
1396 : cache->cc_hits++;
1397 : #endif
1398 :
1399 71722524 : return &ct->tuple;
1400 : }
1401 : else
1402 : {
1403 : CACHE_elog(DEBUG2, "SearchCatCache(%s): found neg entry in bucket %d",
1404 : cache->cc_relname, hashIndex);
1405 :
1406 : #ifdef CATCACHE_STATS
1407 : cache->cc_neg_hits++;
1408 : #endif
1409 :
1410 3773166 : return NULL;
1411 : }
1412 : }
1413 :
1414 5226906 : return SearchCatCacheMiss(cache, nkeys, hashValue, hashIndex, v1, v2, v3, v4);
1415 : }
1416 :
1417 : /*
1418 : * Search the actual catalogs, rather than the cache.
1419 : *
1420 : * This is kept separate from SearchCatCacheInternal() to keep the fast-path
1421 : * as small as possible. To avoid that effort being undone by a helpful
1422 : * compiler, try to explicitly forbid inlining.
1423 : */
1424 : static pg_noinline HeapTuple
1425 5226906 : SearchCatCacheMiss(CatCache *cache,
1426 : int nkeys,
1427 : uint32 hashValue,
1428 : Index hashIndex,
1429 : Datum v1,
1430 : Datum v2,
1431 : Datum v3,
1432 : Datum v4)
1433 : {
1434 : ScanKeyData cur_skey[CATCACHE_MAXKEYS];
1435 : Relation relation;
1436 : SysScanDesc scandesc;
1437 : HeapTuple ntp;
1438 : CatCTup *ct;
1439 : bool stale;
1440 : Datum arguments[CATCACHE_MAXKEYS];
1441 :
1442 : /* Initialize local parameter array */
1443 5226906 : arguments[0] = v1;
1444 5226906 : arguments[1] = v2;
1445 5226906 : arguments[2] = v3;
1446 5226906 : arguments[3] = v4;
1447 :
1448 : /*
1449 : * Tuple was not found in cache, so we have to try to retrieve it directly
1450 : * from the relation. If found, we will add it to the cache; if not
1451 : * found, we will add a negative cache entry instead.
1452 : *
1453 : * NOTE: it is possible for recursive cache lookups to occur while reading
1454 : * the relation --- for example, due to shared-cache-inval messages being
1455 : * processed during table_open(). This is OK. It's even possible for one
1456 : * of those lookups to find and enter the very same tuple we are trying to
1457 : * fetch here. If that happens, we will enter a second copy of the tuple
1458 : * into the cache. The first copy will never be referenced again, and
1459 : * will eventually age out of the cache, so there's no functional problem.
1460 : * This case is rare enough that it's not worth expending extra cycles to
1461 : * detect.
1462 : *
1463 : * Another case, which we *must* handle, is that the tuple could become
1464 : * outdated during CatalogCacheCreateEntry's attempt to detoast it (since
1465 : * AcceptInvalidationMessages can run during TOAST table access). We do
1466 : * not want to return already-stale catcache entries, so we loop around
1467 : * and do the table scan again if that happens.
1468 : */
1469 5226906 : relation = table_open(cache->cc_reloid, AccessShareLock);
1470 :
1471 : /*
1472 : * Ok, need to make a lookup in the relation, copy the scankey and fill
1473 : * out any per-call fields.
1474 : */
1475 5226906 : memcpy(cur_skey, cache->cc_skey, sizeof(ScanKeyData) * nkeys);
1476 5226906 : cur_skey[0].sk_argument = v1;
1477 5226906 : cur_skey[1].sk_argument = v2;
1478 5226906 : cur_skey[2].sk_argument = v3;
1479 5226906 : cur_skey[3].sk_argument = v4;
1480 :
1481 : do
1482 : {
1483 5226906 : scandesc = systable_beginscan(relation,
1484 : cache->cc_indexoid,
1485 5226906 : IndexScanOK(cache),
1486 : NULL,
1487 : nkeys,
1488 : cur_skey);
1489 :
1490 5226906 : ct = NULL;
1491 5226906 : stale = false;
1492 :
1493 5226906 : while (HeapTupleIsValid(ntp = systable_getnext(scandesc)))
1494 : {
1495 3697588 : ct = CatalogCacheCreateEntry(cache, ntp, scandesc, NULL,
1496 : hashValue, hashIndex);
1497 : /* upon failure, we must start the scan over */
1498 3697588 : if (ct == NULL)
1499 : {
1500 0 : stale = true;
1501 0 : break;
1502 : }
1503 : /* immediately set the refcount to 1 */
1504 3697588 : ResourceOwnerEnlarge(CurrentResourceOwner);
1505 3697588 : ct->refcount++;
1506 3697588 : ResourceOwnerRememberCatCacheRef(CurrentResourceOwner, &ct->tuple);
1507 3697588 : break; /* assume only one match */
1508 : }
1509 :
1510 5226904 : systable_endscan(scandesc);
1511 5226904 : } while (stale);
1512 :
1513 5226904 : table_close(relation, AccessShareLock);
1514 :
1515 : /*
1516 : * If tuple was not found, we need to build a negative cache entry
1517 : * containing a fake tuple. The fake tuple has the correct key columns,
1518 : * but nulls everywhere else.
1519 : *
1520 : * In bootstrap mode, we don't build negative entries, because the cache
1521 : * invalidation mechanism isn't alive and can't clear them if the tuple
1522 : * gets created later. (Bootstrap doesn't do UPDATEs, so it doesn't need
1523 : * cache inval for that.)
1524 : */
1525 5226904 : if (ct == NULL)
1526 : {
1527 1529316 : if (IsBootstrapProcessingMode())
1528 48870 : return NULL;
1529 :
1530 1480446 : ct = CatalogCacheCreateEntry(cache, NULL, NULL, arguments,
1531 : hashValue, hashIndex);
1532 :
1533 : /* Creating a negative cache entry shouldn't fail */
1534 : Assert(ct != NULL);
1535 :
1536 : CACHE_elog(DEBUG2, "SearchCatCache(%s): Contains %d/%d tuples",
1537 : cache->cc_relname, cache->cc_ntup, CacheHdr->ch_ntup);
1538 : CACHE_elog(DEBUG2, "SearchCatCache(%s): put neg entry in bucket %d",
1539 : cache->cc_relname, hashIndex);
1540 :
1541 : /*
1542 : * We are not returning the negative entry to the caller, so leave its
1543 : * refcount zero.
1544 : */
1545 :
1546 1480446 : return NULL;
1547 : }
1548 :
1549 : CACHE_elog(DEBUG2, "SearchCatCache(%s): Contains %d/%d tuples",
1550 : cache->cc_relname, cache->cc_ntup, CacheHdr->ch_ntup);
1551 : CACHE_elog(DEBUG2, "SearchCatCache(%s): put in bucket %d",
1552 : cache->cc_relname, hashIndex);
1553 :
1554 : #ifdef CATCACHE_STATS
1555 : cache->cc_newloads++;
1556 : #endif
1557 :
1558 3697588 : return &ct->tuple;
1559 : }
1560 :
1561 : /*
1562 : * ReleaseCatCache
1563 : *
1564 : * Decrement the reference count of a catcache entry (releasing the
1565 : * hold grabbed by a successful SearchCatCache).
1566 : *
1567 : * NOTE: if compiled with -DCATCACHE_FORCE_RELEASE then catcache entries
1568 : * will be freed as soon as their refcount goes to zero. In combination
1569 : * with aset.c's CLOBBER_FREED_MEMORY option, this provides a good test
1570 : * to catch references to already-released catcache entries.
1571 : */
1572 : void
1573 75409880 : ReleaseCatCache(HeapTuple tuple)
1574 : {
1575 75409880 : ReleaseCatCacheWithOwner(tuple, CurrentResourceOwner);
1576 75409880 : }
1577 :
1578 : static void
1579 75420112 : ReleaseCatCacheWithOwner(HeapTuple tuple, ResourceOwner resowner)
1580 : {
1581 75420112 : CatCTup *ct = (CatCTup *) (((char *) tuple) -
1582 : offsetof(CatCTup, tuple));
1583 :
1584 : /* Safety checks to ensure we were handed a cache entry */
1585 : Assert(ct->ct_magic == CT_MAGIC);
1586 : Assert(ct->refcount > 0);
1587 :
1588 75420112 : ct->refcount--;
1589 75420112 : if (resowner)
1590 75409880 : ResourceOwnerForgetCatCacheRef(CurrentResourceOwner, &ct->tuple);
1591 :
1592 75420112 : if (
1593 : #ifndef CATCACHE_FORCE_RELEASE
1594 75420112 : ct->dead &&
1595 : #endif
1596 1410 : ct->refcount == 0 &&
1597 1298 : (ct->c_list == NULL || ct->c_list->refcount == 0))
1598 1298 : CatCacheRemoveCTup(ct->my_cache, ct);
1599 75420112 : }
1600 :
1601 :
1602 : /*
1603 : * GetCatCacheHashValue
1604 : *
1605 : * Compute the hash value for a given set of search keys.
1606 : *
1607 : * The reason for exposing this as part of the API is that the hash value is
1608 : * exposed in cache invalidation operations, so there are places outside the
1609 : * catcache code that need to be able to compute the hash values.
1610 : */
1611 : uint32
1612 986078 : GetCatCacheHashValue(CatCache *cache,
1613 : Datum v1,
1614 : Datum v2,
1615 : Datum v3,
1616 : Datum v4)
1617 : {
1618 : /*
1619 : * one-time startup overhead for each cache
1620 : */
1621 986078 : if (cache->cc_tupdesc == NULL)
1622 23534 : CatalogCacheInitializeCache(cache);
1623 :
1624 : /*
1625 : * calculate the hash value
1626 : */
1627 986078 : return CatalogCacheComputeHashValue(cache, cache->cc_nkeys, v1, v2, v3, v4);
1628 : }
1629 :
1630 :
1631 : /*
1632 : * SearchCatCacheList
1633 : *
1634 : * Generate a list of all tuples matching a partial key (that is,
1635 : * a key specifying just the first K of the cache's N key columns).
1636 : *
1637 : * It doesn't make any sense to specify all of the cache's key columns
1638 : * here: since the key is unique, there could be at most one match, so
1639 : * you ought to use SearchCatCache() instead. Hence this function takes
1640 : * one fewer Datum argument than SearchCatCache() does.
1641 : *
1642 : * The caller must not modify the list object or the pointed-to tuples,
1643 : * and must call ReleaseCatCacheList() when done with the list.
1644 : */
1645 : CatCList *
1646 3305142 : SearchCatCacheList(CatCache *cache,
1647 : int nkeys,
1648 : Datum v1,
1649 : Datum v2,
1650 : Datum v3)
1651 : {
1652 3305142 : Datum v4 = 0; /* dummy last-column value */
1653 : Datum arguments[CATCACHE_MAXKEYS];
1654 : uint32 lHashValue;
1655 : Index lHashIndex;
1656 : dlist_iter iter;
1657 : dlist_head *lbucket;
1658 : CatCList *cl;
1659 : CatCTup *ct;
1660 : List *volatile ctlist;
1661 : ListCell *ctlist_item;
1662 : int nmembers;
1663 : bool ordered;
1664 : HeapTuple ntp;
1665 : MemoryContext oldcxt;
1666 : int i;
1667 :
1668 : /*
1669 : * one-time startup overhead for each cache
1670 : */
1671 3305142 : if (unlikely(cache->cc_tupdesc == NULL))
1672 31714 : CatalogCacheInitializeCache(cache);
1673 :
1674 : Assert(nkeys > 0 && nkeys < cache->cc_nkeys);
1675 :
1676 : #ifdef CATCACHE_STATS
1677 : cache->cc_lsearches++;
1678 : #endif
1679 :
1680 : /* Initialize local parameter array */
1681 3305142 : arguments[0] = v1;
1682 3305142 : arguments[1] = v2;
1683 3305142 : arguments[2] = v3;
1684 3305142 : arguments[3] = v4;
1685 :
1686 : /*
1687 : * If we haven't previously done a list search in this cache, create the
1688 : * bucket header array; otherwise, consider whether it's time to enlarge
1689 : * it.
1690 : */
1691 3305142 : if (cache->cc_lbucket == NULL)
1692 : {
1693 : /* Arbitrary initial size --- must be a power of 2 */
1694 35702 : int nbuckets = 16;
1695 :
1696 35702 : cache->cc_lbucket = (dlist_head *)
1697 35702 : MemoryContextAllocZero(CacheMemoryContext,
1698 : nbuckets * sizeof(dlist_head));
1699 : /* Don't set cc_nlbuckets if we get OOM allocating cc_lbucket */
1700 35702 : cache->cc_nlbuckets = nbuckets;
1701 : }
1702 : else
1703 : {
1704 : /*
1705 : * If the hash table has become too full, enlarge the buckets array.
1706 : * Quite arbitrarily, we enlarge when fill factor > 2.
1707 : */
1708 3269440 : if (cache->cc_nlist > cache->cc_nlbuckets * 2)
1709 1110 : RehashCatCacheLists(cache);
1710 : }
1711 :
1712 : /*
1713 : * Find the hash bucket in which to look for the CatCList.
1714 : */
1715 3305142 : lHashValue = CatalogCacheComputeHashValue(cache, nkeys, v1, v2, v3, v4);
1716 3305142 : lHashIndex = HASH_INDEX(lHashValue, cache->cc_nlbuckets);
1717 :
1718 : /*
1719 : * scan the items until we find a match or exhaust our list
1720 : *
1721 : * Note: it's okay to use dlist_foreach here, even though we modify the
1722 : * dlist within the loop, because we don't continue the loop afterwards.
1723 : */
1724 3305142 : lbucket = &cache->cc_lbucket[lHashIndex];
1725 3648540 : dlist_foreach(iter, lbucket)
1726 : {
1727 3372012 : cl = dlist_container(CatCList, cache_elem, iter.cur);
1728 :
1729 3372012 : if (cl->dead)
1730 0 : continue; /* ignore dead entries */
1731 :
1732 3372012 : if (cl->hash_value != lHashValue)
1733 343398 : continue; /* quickly skip entry if wrong hash val */
1734 :
1735 : /*
1736 : * see if the cached list matches our key.
1737 : */
1738 3028614 : if (cl->nkeys != nkeys)
1739 0 : continue;
1740 :
1741 3028614 : if (!CatalogCacheCompareTuple(cache, nkeys, cl->keys, arguments))
1742 0 : continue;
1743 :
1744 : /*
1745 : * We found a matching list. Move the list to the front of the list
1746 : * for its hashbucket, so as to speed subsequent searches. (We do not
1747 : * move the members to the fronts of their hashbucket lists, however,
1748 : * since there's no point in that unless they are searched for
1749 : * individually.)
1750 : */
1751 3028614 : dlist_move_head(lbucket, &cl->cache_elem);
1752 :
1753 : /* Bump the list's refcount and return it */
1754 3028614 : ResourceOwnerEnlarge(CurrentResourceOwner);
1755 3028614 : cl->refcount++;
1756 3028614 : ResourceOwnerRememberCatCacheListRef(CurrentResourceOwner, cl);
1757 :
1758 : CACHE_elog(DEBUG2, "SearchCatCacheList(%s): found list",
1759 : cache->cc_relname);
1760 :
1761 : #ifdef CATCACHE_STATS
1762 : cache->cc_lhits++;
1763 : #endif
1764 :
1765 3028614 : return cl;
1766 : }
1767 :
1768 : /*
1769 : * List was not found in cache, so we have to build it by reading the
1770 : * relation. For each matching tuple found in the relation, use an
1771 : * existing cache entry if possible, else build a new one.
1772 : *
1773 : * We have to bump the member refcounts temporarily to ensure they won't
1774 : * get dropped from the cache while loading other members. We use a PG_TRY
1775 : * block to ensure we can undo those refcounts if we get an error before
1776 : * we finish constructing the CatCList. ctlist must be valid throughout
1777 : * the PG_TRY block.
1778 : */
1779 276528 : ctlist = NIL;
1780 :
1781 276528 : PG_TRY();
1782 : {
1783 : ScanKeyData cur_skey[CATCACHE_MAXKEYS];
1784 : Relation relation;
1785 : SysScanDesc scandesc;
1786 : bool stale;
1787 :
1788 276528 : relation = table_open(cache->cc_reloid, AccessShareLock);
1789 :
1790 : /*
1791 : * Ok, need to make a lookup in the relation, copy the scankey and
1792 : * fill out any per-call fields.
1793 : */
1794 276528 : memcpy(cur_skey, cache->cc_skey, sizeof(ScanKeyData) * cache->cc_nkeys);
1795 276528 : cur_skey[0].sk_argument = v1;
1796 276528 : cur_skey[1].sk_argument = v2;
1797 276528 : cur_skey[2].sk_argument = v3;
1798 276528 : cur_skey[3].sk_argument = v4;
1799 :
1800 : do
1801 : {
1802 553056 : scandesc = systable_beginscan(relation,
1803 : cache->cc_indexoid,
1804 276528 : IndexScanOK(cache),
1805 : NULL,
1806 : nkeys,
1807 : cur_skey);
1808 :
1809 : /* The list will be ordered iff we are doing an index scan */
1810 276528 : ordered = (scandesc->irel != NULL);
1811 :
1812 276528 : stale = false;
1813 :
1814 1116882 : while (HeapTupleIsValid(ntp = systable_getnext(scandesc)))
1815 : {
1816 : uint32 hashValue;
1817 : Index hashIndex;
1818 840354 : bool found = false;
1819 : dlist_head *bucket;
1820 :
1821 : /*
1822 : * See if there's an entry for this tuple already.
1823 : */
1824 840354 : ct = NULL;
1825 840354 : hashValue = CatalogCacheComputeTupleHashValue(cache, cache->cc_nkeys, ntp);
1826 840354 : hashIndex = HASH_INDEX(hashValue, cache->cc_nbuckets);
1827 :
1828 840354 : bucket = &cache->cc_bucket[hashIndex];
1829 1171680 : dlist_foreach(iter, bucket)
1830 : {
1831 460900 : ct = dlist_container(CatCTup, cache_elem, iter.cur);
1832 :
1833 460900 : if (ct->dead || ct->negative)
1834 838 : continue; /* ignore dead and negative entries */
1835 :
1836 460062 : if (ct->hash_value != hashValue)
1837 313814 : continue; /* quickly skip entry if wrong hash val */
1838 :
1839 146248 : if (!ItemPointerEquals(&(ct->tuple.t_self), &(ntp->t_self)))
1840 0 : continue; /* not same tuple */
1841 :
1842 : /*
1843 : * Found a match, but can't use it if it belongs to
1844 : * another list already
1845 : */
1846 146248 : if (ct->c_list)
1847 16674 : continue;
1848 :
1849 129574 : found = true;
1850 129574 : break; /* A-OK */
1851 : }
1852 :
1853 840354 : if (!found)
1854 : {
1855 : /* We didn't find a usable entry, so make a new one */
1856 710780 : ct = CatalogCacheCreateEntry(cache, ntp, scandesc, NULL,
1857 : hashValue, hashIndex);
1858 : /* upon failure, we must start the scan over */
1859 710780 : if (ct == NULL)
1860 : {
1861 : /*
1862 : * Release refcounts on any items we already had. We
1863 : * dare not try to free them if they're now
1864 : * unreferenced, since an error while doing that would
1865 : * result in the PG_CATCH below doing extra refcount
1866 : * decrements. Besides, we'll likely re-adopt those
1867 : * items in the next iteration, so it's not worth
1868 : * complicating matters to try to get rid of them.
1869 : */
1870 0 : foreach(ctlist_item, ctlist)
1871 : {
1872 0 : ct = (CatCTup *) lfirst(ctlist_item);
1873 : Assert(ct->c_list == NULL);
1874 : Assert(ct->refcount > 0);
1875 0 : ct->refcount--;
1876 : }
1877 : /* Reset ctlist in preparation for new try */
1878 0 : ctlist = NIL;
1879 0 : stale = true;
1880 0 : break;
1881 : }
1882 : }
1883 :
1884 : /* Careful here: add entry to ctlist, then bump its refcount */
1885 : /* This way leaves state correct if lappend runs out of memory */
1886 840354 : ctlist = lappend(ctlist, ct);
1887 840354 : ct->refcount++;
1888 : }
1889 :
1890 276528 : systable_endscan(scandesc);
1891 276528 : } while (stale);
1892 :
1893 276528 : table_close(relation, AccessShareLock);
1894 :
1895 : /* Make sure the resource owner has room to remember this entry. */
1896 276528 : ResourceOwnerEnlarge(CurrentResourceOwner);
1897 :
1898 : /* Now we can build the CatCList entry. */
1899 276528 : oldcxt = MemoryContextSwitchTo(CacheMemoryContext);
1900 276528 : nmembers = list_length(ctlist);
1901 : cl = (CatCList *)
1902 276528 : palloc(offsetof(CatCList, members) + nmembers * sizeof(CatCTup *));
1903 :
1904 : /* Extract key values */
1905 276528 : CatCacheCopyKeys(cache->cc_tupdesc, nkeys, cache->cc_keyno,
1906 276528 : arguments, cl->keys);
1907 276528 : MemoryContextSwitchTo(oldcxt);
1908 :
1909 : /*
1910 : * We are now past the last thing that could trigger an elog before we
1911 : * have finished building the CatCList and remembering it in the
1912 : * resource owner. So it's OK to fall out of the PG_TRY, and indeed
1913 : * we'd better do so before we start marking the members as belonging
1914 : * to the list.
1915 : */
1916 : }
1917 0 : PG_CATCH();
1918 : {
1919 0 : foreach(ctlist_item, ctlist)
1920 : {
1921 0 : ct = (CatCTup *) lfirst(ctlist_item);
1922 : Assert(ct->c_list == NULL);
1923 : Assert(ct->refcount > 0);
1924 0 : ct->refcount--;
1925 0 : if (
1926 : #ifndef CATCACHE_FORCE_RELEASE
1927 0 : ct->dead &&
1928 : #endif
1929 0 : ct->refcount == 0 &&
1930 0 : (ct->c_list == NULL || ct->c_list->refcount == 0))
1931 0 : CatCacheRemoveCTup(cache, ct);
1932 : }
1933 :
1934 0 : PG_RE_THROW();
1935 : }
1936 276528 : PG_END_TRY();
1937 :
1938 276528 : cl->cl_magic = CL_MAGIC;
1939 276528 : cl->my_cache = cache;
1940 276528 : cl->refcount = 0; /* for the moment */
1941 276528 : cl->dead = false;
1942 276528 : cl->ordered = ordered;
1943 276528 : cl->nkeys = nkeys;
1944 276528 : cl->hash_value = lHashValue;
1945 276528 : cl->n_members = nmembers;
1946 :
1947 276528 : i = 0;
1948 1116882 : foreach(ctlist_item, ctlist)
1949 : {
1950 840354 : cl->members[i++] = ct = (CatCTup *) lfirst(ctlist_item);
1951 : Assert(ct->c_list == NULL);
1952 840354 : ct->c_list = cl;
1953 : /* release the temporary refcount on the member */
1954 : Assert(ct->refcount > 0);
1955 840354 : ct->refcount--;
1956 : /* mark list dead if any members already dead */
1957 840354 : if (ct->dead)
1958 0 : cl->dead = true;
1959 : }
1960 : Assert(i == nmembers);
1961 :
1962 : /*
1963 : * Add the CatCList to the appropriate bucket, and count it.
1964 : */
1965 276528 : dlist_push_head(lbucket, &cl->cache_elem);
1966 :
1967 276528 : cache->cc_nlist++;
1968 :
1969 : /* Finally, bump the list's refcount and return it */
1970 276528 : cl->refcount++;
1971 276528 : ResourceOwnerRememberCatCacheListRef(CurrentResourceOwner, cl);
1972 :
1973 : CACHE_elog(DEBUG2, "SearchCatCacheList(%s): made list of %d members",
1974 : cache->cc_relname, nmembers);
1975 :
1976 276528 : return cl;
1977 : }
1978 :
1979 : /*
1980 : * ReleaseCatCacheList
1981 : *
1982 : * Decrement the reference count of a catcache list.
1983 : */
1984 : void
1985 3305106 : ReleaseCatCacheList(CatCList *list)
1986 : {
1987 3305106 : ReleaseCatCacheListWithOwner(list, CurrentResourceOwner);
1988 3305106 : }
1989 :
1990 : static void
1991 3305142 : ReleaseCatCacheListWithOwner(CatCList *list, ResourceOwner resowner)
1992 : {
1993 : /* Safety checks to ensure we were handed a cache entry */
1994 : Assert(list->cl_magic == CL_MAGIC);
1995 : Assert(list->refcount > 0);
1996 3305142 : list->refcount--;
1997 3305142 : if (resowner)
1998 3305106 : ResourceOwnerForgetCatCacheListRef(CurrentResourceOwner, list);
1999 :
2000 3305142 : if (
2001 : #ifndef CATCACHE_FORCE_RELEASE
2002 3305142 : list->dead &&
2003 : #endif
2004 8 : list->refcount == 0)
2005 8 : CatCacheRemoveCList(list->my_cache, list);
2006 3305142 : }
2007 :
2008 :
2009 : /*
2010 : * equalTuple
2011 : * Are these tuples memcmp()-equal?
2012 : */
2013 : static bool
2014 6 : equalTuple(HeapTuple a, HeapTuple b)
2015 : {
2016 : uint32 alen;
2017 : uint32 blen;
2018 :
2019 6 : alen = a->t_len;
2020 6 : blen = b->t_len;
2021 12 : return (alen == blen &&
2022 6 : memcmp((char *) a->t_data,
2023 6 : (char *) b->t_data, blen) == 0);
2024 : }
2025 :
2026 : /*
2027 : * CatalogCacheCreateEntry
2028 : * Create a new CatCTup entry, copying the given HeapTuple and other
2029 : * supplied data into it. The new entry initially has refcount 0.
2030 : *
2031 : * To create a normal cache entry, ntp must be the HeapTuple just fetched
2032 : * from scandesc, and "arguments" is not used. To create a negative cache
2033 : * entry, pass NULL for ntp and scandesc; then "arguments" is the cache
2034 : * keys to use. In either case, hashValue/hashIndex are the hash values
2035 : * computed from the cache keys.
2036 : *
2037 : * Returns NULL if we attempt to detoast the tuple and observe that it
2038 : * became stale. (This cannot happen for a negative entry.) Caller must
2039 : * retry the tuple lookup in that case.
2040 : */
2041 : static CatCTup *
2042 5888814 : CatalogCacheCreateEntry(CatCache *cache, HeapTuple ntp, SysScanDesc scandesc,
2043 : Datum *arguments,
2044 : uint32 hashValue, Index hashIndex)
2045 : {
2046 : CatCTup *ct;
2047 : HeapTuple dtp;
2048 : MemoryContext oldcxt;
2049 :
2050 5888814 : if (ntp)
2051 : {
2052 : int i;
2053 :
2054 : /*
2055 : * The visibility recheck below essentially never fails during our
2056 : * regression tests, and there's no easy way to force it to fail for
2057 : * testing purposes. To ensure we have test coverage for the retry
2058 : * paths in our callers, make debug builds randomly fail about 0.1% of
2059 : * the times through this code path, even when there's no toasted
2060 : * fields.
2061 : */
2062 : #ifdef USE_ASSERT_CHECKING
2063 : if (pg_prng_uint32(&pg_global_prng_state) <= (PG_UINT32_MAX / 1000))
2064 : return NULL;
2065 : #endif
2066 :
2067 : /*
2068 : * If there are any out-of-line toasted fields in the tuple, expand
2069 : * them in-line. This saves cycles during later use of the catcache
2070 : * entry, and also protects us against the possibility of the toast
2071 : * tuples being freed before we attempt to fetch them, in case of
2072 : * something using a slightly stale catcache entry.
2073 : */
2074 4408368 : if (HeapTupleHasExternal(ntp))
2075 : {
2076 3352 : bool need_cmp = IsInplaceUpdateOid(cache->cc_reloid);
2077 3352 : HeapTuple before = NULL;
2078 3352 : bool matches = true;
2079 :
2080 3352 : if (need_cmp)
2081 6 : before = heap_copytuple(ntp);
2082 3352 : dtp = toast_flatten_tuple(ntp, cache->cc_tupdesc);
2083 :
2084 : /*
2085 : * The tuple could become stale while we are doing toast table
2086 : * access (since AcceptInvalidationMessages can run then).
2087 : * equalTuple() detects staleness from inplace updates, while
2088 : * systable_recheck_tuple() detects staleness from normal updates.
2089 : *
2090 : * While this equalTuple() follows the usual rule of reading with
2091 : * a pin and no buffer lock, it warrants suspicion since an
2092 : * inplace update could appear at any moment. It's safe because
2093 : * the inplace update sends an invalidation that can't reorder
2094 : * before the inplace heap change. If the heap change reaches
2095 : * this process just after equalTuple() looks, we've not missed
2096 : * its inval.
2097 : */
2098 3352 : if (need_cmp)
2099 : {
2100 6 : matches = equalTuple(before, ntp);
2101 6 : heap_freetuple(before);
2102 : }
2103 3352 : if (!matches || !systable_recheck_tuple(scandesc, ntp))
2104 : {
2105 0 : heap_freetuple(dtp);
2106 0 : return NULL;
2107 : }
2108 : }
2109 : else
2110 4405016 : dtp = ntp;
2111 :
2112 : /* Allocate memory for CatCTup and the cached tuple in one go */
2113 4408368 : oldcxt = MemoryContextSwitchTo(CacheMemoryContext);
2114 :
2115 4408368 : ct = (CatCTup *) palloc(sizeof(CatCTup) +
2116 4408368 : MAXIMUM_ALIGNOF + dtp->t_len);
2117 4408368 : ct->tuple.t_len = dtp->t_len;
2118 4408368 : ct->tuple.t_self = dtp->t_self;
2119 4408368 : ct->tuple.t_tableOid = dtp->t_tableOid;
2120 4408368 : ct->tuple.t_data = (HeapTupleHeader)
2121 4408368 : MAXALIGN(((char *) ct) + sizeof(CatCTup));
2122 : /* copy tuple contents */
2123 4408368 : memcpy((char *) ct->tuple.t_data,
2124 4408368 : (const char *) dtp->t_data,
2125 4408368 : dtp->t_len);
2126 4408368 : MemoryContextSwitchTo(oldcxt);
2127 :
2128 4408368 : if (dtp != ntp)
2129 3352 : heap_freetuple(dtp);
2130 :
2131 : /* extract keys - they'll point into the tuple if not by-value */
2132 12762094 : for (i = 0; i < cache->cc_nkeys; i++)
2133 : {
2134 : Datum atp;
2135 : bool isnull;
2136 :
2137 8353726 : atp = heap_getattr(&ct->tuple,
2138 : cache->cc_keyno[i],
2139 : cache->cc_tupdesc,
2140 : &isnull);
2141 : Assert(!isnull);
2142 8353726 : ct->keys[i] = atp;
2143 : }
2144 : }
2145 : else
2146 : {
2147 : /* Set up keys for a negative cache entry */
2148 1480446 : oldcxt = MemoryContextSwitchTo(CacheMemoryContext);
2149 1480446 : ct = (CatCTup *) palloc(sizeof(CatCTup));
2150 :
2151 : /*
2152 : * Store keys - they'll point into separately allocated memory if not
2153 : * by-value.
2154 : */
2155 1480446 : CatCacheCopyKeys(cache->cc_tupdesc, cache->cc_nkeys, cache->cc_keyno,
2156 1480446 : arguments, ct->keys);
2157 1480446 : MemoryContextSwitchTo(oldcxt);
2158 : }
2159 :
2160 : /*
2161 : * Finish initializing the CatCTup header, and add it to the cache's
2162 : * linked list and counts.
2163 : */
2164 5888814 : ct->ct_magic = CT_MAGIC;
2165 5888814 : ct->my_cache = cache;
2166 5888814 : ct->c_list = NULL;
2167 5888814 : ct->refcount = 0; /* for the moment */
2168 5888814 : ct->dead = false;
2169 5888814 : ct->negative = (ntp == NULL);
2170 5888814 : ct->hash_value = hashValue;
2171 :
2172 5888814 : dlist_push_head(&cache->cc_bucket[hashIndex], &ct->cache_elem);
2173 :
2174 5888814 : cache->cc_ntup++;
2175 5888814 : CacheHdr->ch_ntup++;
2176 :
2177 : /*
2178 : * If the hash table has become too full, enlarge the buckets array. Quite
2179 : * arbitrarily, we enlarge when fill factor > 2.
2180 : */
2181 5888814 : if (cache->cc_ntup > cache->cc_nbuckets * 2)
2182 5574 : RehashCatCache(cache);
2183 :
2184 5888814 : return ct;
2185 : }
2186 :
2187 : /*
2188 : * Helper routine that frees keys stored in the keys array.
2189 : */
2190 : static void
2191 531986 : CatCacheFreeKeys(TupleDesc tupdesc, int nkeys, int *attnos, Datum *keys)
2192 : {
2193 : int i;
2194 :
2195 1637628 : for (i = 0; i < nkeys; i++)
2196 : {
2197 1105642 : int attnum = attnos[i];
2198 : Form_pg_attribute att;
2199 :
2200 : /* system attribute are not supported in caches */
2201 : Assert(attnum > 0);
2202 :
2203 1105642 : att = TupleDescAttr(tupdesc, attnum - 1);
2204 :
2205 1105642 : if (!att->attbyval)
2206 467782 : pfree(DatumGetPointer(keys[i]));
2207 : }
2208 531986 : }
2209 :
2210 : /*
2211 : * Helper routine that copies the keys in the srckeys array into the dstkeys
2212 : * one, guaranteeing that the datums are fully allocated in the current memory
2213 : * context.
2214 : */
2215 : static void
2216 1756974 : CatCacheCopyKeys(TupleDesc tupdesc, int nkeys, int *attnos,
2217 : Datum *srckeys, Datum *dstkeys)
2218 : {
2219 : int i;
2220 :
2221 : /*
2222 : * XXX: memory and lookup performance could possibly be improved by
2223 : * storing all keys in one allocation.
2224 : */
2225 :
2226 5492786 : for (i = 0; i < nkeys; i++)
2227 : {
2228 3735812 : int attnum = attnos[i];
2229 3735812 : Form_pg_attribute att = TupleDescAttr(tupdesc, attnum - 1);
2230 3735812 : Datum src = srckeys[i];
2231 : NameData srcname;
2232 :
2233 : /*
2234 : * Must be careful in case the caller passed a C string where a NAME
2235 : * is wanted: convert the given argument to a correctly padded NAME.
2236 : * Otherwise the memcpy() done by datumCopy() could fall off the end
2237 : * of memory.
2238 : */
2239 3735812 : if (att->atttypid == NAMEOID)
2240 : {
2241 774756 : namestrcpy(&srcname, DatumGetCString(src));
2242 774756 : src = NameGetDatum(&srcname);
2243 : }
2244 :
2245 3735812 : dstkeys[i] = datumCopy(src,
2246 3735812 : att->attbyval,
2247 3735812 : att->attlen);
2248 : }
2249 1756974 : }
2250 :
2251 : /*
2252 : * PrepareToInvalidateCacheTuple()
2253 : *
2254 : * This is part of a rather subtle chain of events, so pay attention:
2255 : *
2256 : * When a tuple is inserted or deleted, it cannot be flushed from the
2257 : * catcaches immediately, for reasons explained at the top of cache/inval.c.
2258 : * Instead we have to add entry(s) for the tuple to a list of pending tuple
2259 : * invalidations that will be done at the end of the command or transaction.
2260 : *
2261 : * The lists of tuples that need to be flushed are kept by inval.c. This
2262 : * routine is a helper routine for inval.c. Given a tuple belonging to
2263 : * the specified relation, find all catcaches it could be in, compute the
2264 : * correct hash value for each such catcache, and call the specified
2265 : * function to record the cache id and hash value in inval.c's lists.
2266 : * SysCacheInvalidate will be called later, if appropriate,
2267 : * using the recorded information.
2268 : *
2269 : * For an insert or delete, tuple is the target tuple and newtuple is NULL.
2270 : * For an update, we are called just once, with tuple being the old tuple
2271 : * version and newtuple the new version. We should make two list entries
2272 : * if the tuple's hash value changed, but only one if it didn't.
2273 : *
2274 : * Note that it is irrelevant whether the given tuple is actually loaded
2275 : * into the catcache at the moment. Even if it's not there now, it might
2276 : * be by the end of the command, or there might be a matching negative entry
2277 : * to flush --- or other backends' caches might have such entries --- so
2278 : * we have to make list entries to flush it later.
2279 : *
2280 : * Also note that it's not an error if there are no catcaches for the
2281 : * specified relation. inval.c doesn't know exactly which rels have
2282 : * catcaches --- it will call this routine for any tuple that's in a
2283 : * system relation.
2284 : */
2285 : void
2286 2904194 : PrepareToInvalidateCacheTuple(Relation relation,
2287 : HeapTuple tuple,
2288 : HeapTuple newtuple,
2289 : void (*function) (int, uint32, Oid, void *),
2290 : void *context)
2291 : {
2292 : slist_iter iter;
2293 : Oid reloid;
2294 :
2295 : CACHE_elog(DEBUG2, "PrepareToInvalidateCacheTuple: called");
2296 :
2297 : /*
2298 : * sanity checks
2299 : */
2300 : Assert(RelationIsValid(relation));
2301 : Assert(HeapTupleIsValid(tuple));
2302 : Assert(PointerIsValid(function));
2303 : Assert(CacheHdr != NULL);
2304 :
2305 2904194 : reloid = RelationGetRelid(relation);
2306 :
2307 : /* ----------------
2308 : * for each cache
2309 : * if the cache contains tuples from the specified relation
2310 : * compute the tuple's hash value(s) in this cache,
2311 : * and call the passed function to register the information.
2312 : * ----------------
2313 : */
2314 :
2315 249760684 : slist_foreach(iter, &CacheHdr->ch_caches)
2316 : {
2317 246856490 : CatCache *ccp = slist_container(CatCache, cc_next, iter.cur);
2318 : uint32 hashvalue;
2319 : Oid dbid;
2320 :
2321 246856490 : if (ccp->cc_reloid != reloid)
2322 241554620 : continue;
2323 :
2324 : /* Just in case cache hasn't finished initialization yet... */
2325 5301870 : if (ccp->cc_tupdesc == NULL)
2326 8582 : CatalogCacheInitializeCache(ccp);
2327 :
2328 5301870 : hashvalue = CatalogCacheComputeTupleHashValue(ccp, ccp->cc_nkeys, tuple);
2329 5301870 : dbid = ccp->cc_relisshared ? (Oid) 0 : MyDatabaseId;
2330 :
2331 5301870 : (*function) (ccp->id, hashvalue, dbid, context);
2332 :
2333 5301870 : if (newtuple)
2334 : {
2335 : uint32 newhashvalue;
2336 :
2337 367858 : newhashvalue = CatalogCacheComputeTupleHashValue(ccp, ccp->cc_nkeys, newtuple);
2338 :
2339 367858 : if (newhashvalue != hashvalue)
2340 6018 : (*function) (ccp->id, newhashvalue, dbid, context);
2341 : }
2342 : }
2343 2904194 : }
2344 :
2345 : /* ResourceOwner callbacks */
2346 :
2347 : static void
2348 10232 : ResOwnerReleaseCatCache(Datum res)
2349 : {
2350 10232 : ReleaseCatCacheWithOwner((HeapTuple) DatumGetPointer(res), NULL);
2351 10232 : }
2352 :
2353 : static char *
2354 0 : ResOwnerPrintCatCache(Datum res)
2355 : {
2356 0 : HeapTuple tuple = (HeapTuple) DatumGetPointer(res);
2357 0 : CatCTup *ct = (CatCTup *) (((char *) tuple) -
2358 : offsetof(CatCTup, tuple));
2359 :
2360 : /* Safety check to ensure we were handed a cache entry */
2361 : Assert(ct->ct_magic == CT_MAGIC);
2362 :
2363 0 : return psprintf("cache %s (%d), tuple %u/%u has count %d",
2364 0 : ct->my_cache->cc_relname, ct->my_cache->id,
2365 0 : ItemPointerGetBlockNumber(&(tuple->t_self)),
2366 0 : ItemPointerGetOffsetNumber(&(tuple->t_self)),
2367 : ct->refcount);
2368 : }
2369 :
2370 : static void
2371 36 : ResOwnerReleaseCatCacheList(Datum res)
2372 : {
2373 36 : ReleaseCatCacheListWithOwner((CatCList *) DatumGetPointer(res), NULL);
2374 36 : }
2375 :
2376 : static char *
2377 0 : ResOwnerPrintCatCacheList(Datum res)
2378 : {
2379 0 : CatCList *list = (CatCList *) DatumGetPointer(res);
2380 :
2381 0 : return psprintf("cache %s (%d), list %p has count %d",
2382 0 : list->my_cache->cc_relname, list->my_cache->id,
2383 : list, list->refcount);
2384 : }
|
