#include "access/attnum.h"
#include "access/htup.h"
#include "catalog/syscache_ids.h"

Include dependency graph for syscache.h:

This graph shows which files directly or indirectly include this file:

Macros
#define	SearchSysCacheCopy1(cacheId, key1) SearchSysCacheCopy(cacheId, key1, 0, 0, 0)

#define	SearchSysCacheCopy2(cacheId, key1, key2) SearchSysCacheCopy(cacheId, key1, key2, 0, 0)

#define	SearchSysCacheCopy3(cacheId, key1, key2, key3) SearchSysCacheCopy(cacheId, key1, key2, key3, 0)

#define	SearchSysCacheCopy4(cacheId, key1, key2, key3, key4) SearchSysCacheCopy(cacheId, key1, key2, key3, key4)

#define	SearchSysCacheExists1(cacheId, key1) SearchSysCacheExists(cacheId, key1, 0, 0, 0)

#define	SearchSysCacheExists2(cacheId, key1, key2) SearchSysCacheExists(cacheId, key1, key2, 0, 0)

#define	SearchSysCacheExists3(cacheId, key1, key2, key3) SearchSysCacheExists(cacheId, key1, key2, key3, 0)

#define	SearchSysCacheExists4(cacheId, key1, key2, key3, key4) SearchSysCacheExists(cacheId, key1, key2, key3, key4)

#define	GetSysCacheOid1(cacheId, oidcol, key1) GetSysCacheOid(cacheId, oidcol, key1, 0, 0, 0)

#define	GetSysCacheOid2(cacheId, oidcol, key1, key2) GetSysCacheOid(cacheId, oidcol, key1, key2, 0, 0)

#define	GetSysCacheOid3(cacheId, oidcol, key1, key2, key3) GetSysCacheOid(cacheId, oidcol, key1, key2, key3, 0)

#define	GetSysCacheOid4(cacheId, oidcol, key1, key2, key3, key4) GetSysCacheOid(cacheId, oidcol, key1, key2, key3, key4)

#define	GetSysCacheHashValue1(cacheId, key1) GetSysCacheHashValue(cacheId, key1, 0, 0, 0)

#define	GetSysCacheHashValue2(cacheId, key1, key2) GetSysCacheHashValue(cacheId, key1, key2, 0, 0)

#define	GetSysCacheHashValue3(cacheId, key1, key2, key3) GetSysCacheHashValue(cacheId, key1, key2, key3, 0)

#define	GetSysCacheHashValue4(cacheId, key1, key2, key3, key4) GetSysCacheHashValue(cacheId, key1, key2, key3, key4)

#define	SearchSysCacheList1(cacheId, key1) SearchSysCacheList(cacheId, 1, key1, 0, 0)

#define	SearchSysCacheList2(cacheId, key1, key2) SearchSysCacheList(cacheId, 2, key1, key2, 0)

#define	SearchSysCacheList3(cacheId, key1, key2, key3) SearchSysCacheList(cacheId, 3, key1, key2, key3)

#define	ReleaseSysCacheList(x) ReleaseCatCacheList(x)

Functions
void	InitCatalogCache (void)

void	InitCatalogCachePhase2 (void)

HeapTuple	SearchSysCache (int cacheId, Datum key1, Datum key2, Datum key3, Datum key4)

HeapTuple	SearchSysCache1 (int cacheId, Datum key1)

HeapTuple	SearchSysCache2 (int cacheId, Datum key1, Datum key2)

HeapTuple	SearchSysCache3 (int cacheId, Datum key1, Datum key2, Datum key3)

HeapTuple	SearchSysCache4 (int cacheId, Datum key1, Datum key2, Datum key3, Datum key4)

void	ReleaseSysCache (HeapTuple tuple)

HeapTuple	SearchSysCacheLocked1 (int cacheId, Datum key1)

HeapTuple	SearchSysCacheCopy (int cacheId, Datum key1, Datum key2, Datum key3, Datum key4)

HeapTuple	SearchSysCacheLockedCopy1 (int cacheId, Datum key1)

bool	SearchSysCacheExists (int cacheId, Datum key1, Datum key2, Datum key3, Datum key4)

Oid	GetSysCacheOid (int cacheId, AttrNumber oidcol, Datum key1, Datum key2, Datum key3, Datum key4)

HeapTuple	SearchSysCacheAttName (Oid relid, const char *attname)

HeapTuple	SearchSysCacheCopyAttName (Oid relid, const char *attname)

bool	SearchSysCacheExistsAttName (Oid relid, const char *attname)

HeapTuple	SearchSysCacheAttNum (Oid relid, int16 attnum)

HeapTuple	SearchSysCacheCopyAttNum (Oid relid, int16 attnum)

Datum	SysCacheGetAttr (int cacheId, HeapTuple tup, AttrNumber attributeNumber, bool *isNull)

Datum	SysCacheGetAttrNotNull (int cacheId, HeapTuple tup, AttrNumber attributeNumber)

uint32	GetSysCacheHashValue (int cacheId, Datum key1, Datum key2, Datum key3, Datum key4)

struct catclist *	SearchSysCacheList (int cacheId, int nkeys, Datum key1, Datum key2, Datum key3)

void	SysCacheInvalidate (int cacheId, uint32 hashValue)

bool	RelationInvalidatesSnapshotsOnly (Oid relid)

bool	RelationHasSysCache (Oid relid)

bool	RelationSupportsSysCache (Oid relid)

Macro Definition Documentation

◆ GetSysCacheHashValue1

#define GetSysCacheHashValue1	(	cacheId,
		key1
	)	GetSysCacheHashValue(cacheId, key1, 0, 0, 0)

Definition at line 118 of file syscache.h.

◆ GetSysCacheHashValue2

#define GetSysCacheHashValue2	(	cacheId,
		key1,
		key2
	)	GetSysCacheHashValue(cacheId, key1, key2, 0, 0)

Definition at line 120 of file syscache.h.

◆ GetSysCacheHashValue3

#define GetSysCacheHashValue3	(	cacheId,
		key1,
		key2,
		key3
	)	GetSysCacheHashValue(cacheId, key1, key2, key3, 0)

Definition at line 122 of file syscache.h.

◆ GetSysCacheHashValue4

#define GetSysCacheHashValue4	(	cacheId,
		key1,
		key2,
		key3,
		key4
	)	GetSysCacheHashValue(cacheId, key1, key2, key3, key4)

Definition at line 124 of file syscache.h.

◆ GetSysCacheOid1

#define GetSysCacheOid1	(	cacheId,
		oidcol,
		key1
	)	GetSysCacheOid(cacheId, oidcol, key1, 0, 0, 0)

Definition at line 109 of file syscache.h.

◆ GetSysCacheOid2

#define GetSysCacheOid2	(	cacheId,
		oidcol,
		key1,
		key2
	)	GetSysCacheOid(cacheId, oidcol, key1, key2, 0, 0)

Definition at line 111 of file syscache.h.

◆ GetSysCacheOid3

#define GetSysCacheOid3	(	cacheId,
		oidcol,
		key1,
		key2,
		key3
	)	GetSysCacheOid(cacheId, oidcol, key1, key2, key3, 0)

Definition at line 113 of file syscache.h.

◆ GetSysCacheOid4

#define GetSysCacheOid4	(	cacheId,
		oidcol,
		key1,
		key2,
		key3,
		key4
	)	GetSysCacheOid(cacheId, oidcol, key1, key2, key3, key4)

Definition at line 115 of file syscache.h.

◆ ReleaseSysCacheList

#define ReleaseSysCacheList ( x ) ReleaseCatCacheList(x)

Definition at line 134 of file syscache.h.

◆ SearchSysCacheCopy1

#define SearchSysCacheCopy1	(	cacheId,
		key1
	)	SearchSysCacheCopy(cacheId, key1, 0, 0, 0)

Definition at line 91 of file syscache.h.

◆ SearchSysCacheCopy2

#define SearchSysCacheCopy2	(	cacheId,
		key1,
		key2
	)	SearchSysCacheCopy(cacheId, key1, key2, 0, 0)

Definition at line 93 of file syscache.h.

◆ SearchSysCacheCopy3

#define SearchSysCacheCopy3	(	cacheId,
		key1,
		key2,
		key3
	)	SearchSysCacheCopy(cacheId, key1, key2, key3, 0)

Definition at line 95 of file syscache.h.

◆ SearchSysCacheCopy4

#define SearchSysCacheCopy4	(	cacheId,
		key1,
		key2,
		key3,
		key4
	)	SearchSysCacheCopy(cacheId, key1, key2, key3, key4)

Definition at line 97 of file syscache.h.

◆ SearchSysCacheExists1

#define SearchSysCacheExists1	(	cacheId,
		key1
	)	SearchSysCacheExists(cacheId, key1, 0, 0, 0)

Definition at line 100 of file syscache.h.

◆ SearchSysCacheExists2

#define SearchSysCacheExists2	(	cacheId,
		key1,
		key2
	)	SearchSysCacheExists(cacheId, key1, key2, 0, 0)

Definition at line 102 of file syscache.h.

◆ SearchSysCacheExists3

#define SearchSysCacheExists3	(	cacheId,
		key1,
		key2,
		key3
	)	SearchSysCacheExists(cacheId, key1, key2, key3, 0)

Definition at line 104 of file syscache.h.

◆ SearchSysCacheExists4

#define SearchSysCacheExists4	(	cacheId,
		key1,
		key2,
		key3,
		key4
	)	SearchSysCacheExists(cacheId, key1, key2, key3, key4)

Definition at line 106 of file syscache.h.

◆ SearchSysCacheList1

#define SearchSysCacheList1	(	cacheId,
		key1
	)	SearchSysCacheList(cacheId, 1, key1, 0, 0)

Definition at line 127 of file syscache.h.

◆ SearchSysCacheList2

#define SearchSysCacheList2	(	cacheId,
		key1,
		key2
	)	SearchSysCacheList(cacheId, 2, key1, key2, 0)

Definition at line 129 of file syscache.h.

◆ SearchSysCacheList3

#define SearchSysCacheList3	(	cacheId,
		key1,
		key2,
		key3
	)	SearchSysCacheList(cacheId, 3, key1, key2, key3)

Definition at line 131 of file syscache.h.

Function Documentation

◆ GetSysCacheHashValue()

uint32 GetSysCacheHashValue	(	int	cacheId,
		Datum	key1,
		Datum	key2,
		Datum	key3,
		Datum	key4
	)

Definition at line 661 of file syscache.c.

{
    if (cacheId < 0 || cacheId >= SysCacheSize ||
        !PointerIsValid(SysCache[cacheId]))
        elog(ERROR, "invalid cache ID: %d", cacheId);
 
    return GetCatCacheHashValue(SysCache[cacheId], key1, key2, key3, key4);
}

References elog, ERROR, GetCatCacheHashValue(), PointerIsValid, and SysCache.

◆ GetSysCacheOid()

Oid GetSysCacheOid	(	int	cacheId,
		AttrNumber	oidcol,
		Datum	key1,
		Datum	key2,
		Datum	key3,
		Datum	key4
	)

Definition at line 448 of file syscache.c.

{
    HeapTuple   tuple;
    bool        isNull;
    Oid         result;
 
    tuple = SearchSysCache(cacheId, key1, key2, key3, key4);
    if (!HeapTupleIsValid(tuple))
        return InvalidOid;
    result = heap_getattr(tuple, oidcol,
                          SysCache[cacheId]->cc_tupdesc,
                          &isNull);
    Assert(!isNull);            /* columns used as oids should never be NULL */
    ReleaseSysCache(tuple);
    return result;
}

References Assert(), heap_getattr(), HeapTupleIsValid, InvalidOid, ReleaseSysCache(), SearchSysCache(), and SysCache.

◆ InitCatalogCache()

void InitCatalogCache ( void )

Definition at line 110 of file syscache.c.

{
    int         cacheId;
 
    Assert(!CacheInitialized);
 
    SysCacheRelationOidSize = SysCacheSupportingRelOidSize = 0;
 
    for (cacheId = 0; cacheId < SysCacheSize; cacheId++)
    {
        /*
         * Assert that every enumeration value defined in syscache.h has been
         * populated in the cacheinfo array.
         */
        Assert(OidIsValid(cacheinfo[cacheId].reloid));
        Assert(OidIsValid(cacheinfo[cacheId].indoid));
        /* .nbuckets and .key[] are checked by InitCatCache() */
 
        SysCache[cacheId] = InitCatCache(cacheId,
                                         cacheinfo[cacheId].reloid,
                                         cacheinfo[cacheId].indoid,
                                         cacheinfo[cacheId].nkeys,
                                         cacheinfo[cacheId].key,
                                         cacheinfo[cacheId].nbuckets);
        if (!PointerIsValid(SysCache[cacheId]))
            elog(ERROR, "could not initialize cache %u (%d)",
                 cacheinfo[cacheId].reloid, cacheId);
        /* Accumulate data for OID lists, too */
        SysCacheRelationOid[SysCacheRelationOidSize++] =
            cacheinfo[cacheId].reloid;
        SysCacheSupportingRelOid[SysCacheSupportingRelOidSize++] =
            cacheinfo[cacheId].reloid;
        SysCacheSupportingRelOid[SysCacheSupportingRelOidSize++] =
            cacheinfo[cacheId].indoid;
        /* see comments for RelationInvalidatesSnapshotsOnly */
        Assert(!RelationInvalidatesSnapshotsOnly(cacheinfo[cacheId].reloid));
    }
 
    Assert(SysCacheRelationOidSize <= lengthof(SysCacheRelationOid));
    Assert(SysCacheSupportingRelOidSize <= lengthof(SysCacheSupportingRelOid));
 
    /* Sort and de-dup OID arrays, so we can use binary search. */
    qsort(SysCacheRelationOid, SysCacheRelationOidSize,
          sizeof(Oid), oid_compare);
    SysCacheRelationOidSize =
        qunique(SysCacheRelationOid, SysCacheRelationOidSize, sizeof(Oid),
                oid_compare);
 
    qsort(SysCacheSupportingRelOid, SysCacheSupportingRelOidSize,
          sizeof(Oid), oid_compare);
    SysCacheSupportingRelOidSize =
        qunique(SysCacheSupportingRelOid, SysCacheSupportingRelOidSize,
                sizeof(Oid), oid_compare);
 
    CacheInitialized = true;
}

References Assert(), CacheInitialized, elog, ERROR, InitCatCache(), sort-test::key, lengthof, oid_compare(), OidIsValid, PointerIsValid, qsort, qunique(), RelationInvalidatesSnapshotsOnly(), SysCache, SysCacheRelationOid, SysCacheRelationOidSize, SysCacheSupportingRelOid, and SysCacheSupportingRelOidSize.

Referenced by InitPostgres().

◆ InitCatalogCachePhase2()

void InitCatalogCachePhase2 ( void )

Definition at line 180 of file syscache.c.

{
    int         cacheId;
 
    Assert(CacheInitialized);
 
    for (cacheId = 0; cacheId < SysCacheSize; cacheId++)
        InitCatCachePhase2(SysCache[cacheId], true);
}

References Assert(), CacheInitialized, InitCatCachePhase2(), and SysCache.

Referenced by RelationCacheInitializePhase3().

◆ RelationHasSysCache()

bool RelationHasSysCache ( Oid relid )

Definition at line 745 of file syscache.c.

{
    int         low = 0,
                high = SysCacheRelationOidSize - 1;
 
    while (low <= high)
    {
        int         middle = low + (high - low) / 2;
 
        if (SysCacheRelationOid[middle] == relid)
            return true;
        if (SysCacheRelationOid[middle] < relid)
            low = middle + 1;
        else
            high = middle - 1;
    }
 
    return false;
}

References SysCacheRelationOid, and SysCacheRelationOidSize.

Referenced by GetNonHistoricCatalogSnapshot().

◆ RelationInvalidatesSnapshotsOnly()

bool RelationInvalidatesSnapshotsOnly ( Oid relid )

Definition at line 722 of file syscache.c.

{
    switch (relid)
    {
        case DbRoleSettingRelationId:
        case DependRelationId:
        case SharedDependRelationId:
        case DescriptionRelationId:
        case SharedDescriptionRelationId:
        case SecLabelRelationId:
        case SharedSecLabelRelationId:
            return true;
        default:
            break;
    }
 
    return false;
}

Referenced by CacheInvalidateHeapTupleCommon(), GetNonHistoricCatalogSnapshot(), and InitCatalogCache().

◆ RelationSupportsSysCache()

bool RelationSupportsSysCache ( Oid relid )

Definition at line 770 of file syscache.c.

{
    int         low = 0,
                high = SysCacheSupportingRelOidSize - 1;
 
    while (low <= high)
    {
        int         middle = low + (high - low) / 2;
 
        if (SysCacheSupportingRelOid[middle] == relid)
            return true;
        if (SysCacheSupportingRelOid[middle] < relid)
            low = middle + 1;
        else
            high = middle - 1;
    }
 
    return false;
}

References SysCacheSupportingRelOid, and SysCacheSupportingRelOidSize.

Referenced by heap_update(), and RelationIdIsInInitFile().

◆ ReleaseSysCache()

void ReleaseSysCache ( HeapTuple tuple )

Definition at line 269 of file syscache.c.

{
    ReleaseCatCache(tuple);
}

References ReleaseCatCache().

◆ SearchSysCache()

HeapTuple SearchSysCache	(	int	cacheId,
		Datum	key1,
		Datum	key2,
		Datum	key3,
		Datum	key4
	)

Definition at line 208 of file syscache.c.

{
    Assert(cacheId >= 0 && cacheId < SysCacheSize &&
           PointerIsValid(SysCache[cacheId]));
 
    return SearchCatCache(SysCache[cacheId], key1, key2, key3, key4);
}

References Assert(), PointerIsValid, SearchCatCache(), and SysCache.

Referenced by GetSysCacheOid(), SearchSysCacheCopy(), and SearchSysCacheExists().

◆ SearchSysCache1()

HeapTuple SearchSysCache1	(	int	cacheId,
		Datum	key1
	)

Definition at line 221 of file syscache.c.

{
    Assert(cacheId >= 0 && cacheId < SysCacheSize &&
           PointerIsValid(SysCache[cacheId]));
    Assert(SysCache[cacheId]->cc_nkeys == 1);
 
    return SearchCatCache1(SysCache[cacheId], key1);
}

References Assert(), PointerIsValid, SearchCatCache1(), and SysCache.

◆ SearchSysCache2()

HeapTuple SearchSysCache2	(	int	cacheId,
		Datum	key1,
		Datum	key2
	)

Definition at line 232 of file syscache.c.

{
    Assert(cacheId >= 0 && cacheId < SysCacheSize &&
           PointerIsValid(SysCache[cacheId]));
    Assert(SysCache[cacheId]->cc_nkeys == 2);
 
    return SearchCatCache2(SysCache[cacheId], key1, key2);
}

References Assert(), PointerIsValid, SearchCatCache2(), and SysCache.

Referenced by AddEnumLabel(), AlterPublicationOptions(), AlterPublicationSchemas(), AlterPublicationTables(), CastCreate(), check_and_fetch_column_list(), check_for_column_name_collision(), convert_column_name(), CreateTransform(), DropSubscription(), enum_in(), enum_recv(), examine_attribute(), ExecGrant_Attribute(), expand_all_col_privileges(), find_coercion_pathway(), find_typmod_coercion_function(), fixup_whole_row_references(), get_attgenerated(), get_attname(), get_attoptions(), get_attr_stat_type(), get_attribute_options(), get_atttype(), get_atttypetypmodcoll(), get_object_address_usermapping(), get_relation_statistics_worker(), get_rewrite_oid(), get_rte_attribute_is_dropped(), get_transform_fromsql(), get_transform_tosql(), GetForeignColumnOptions(), GetSubscriptionRelState(), GetUserMapping(), index_check_primary_key(), index_concurrently_create_copy(), InsertRule(), IsBinaryCoercibleWithCast(), pg_attribute_aclcheck_all_ext(), pg_attribute_aclmask_ext(), pgoutput_row_filter_init(), pub_rf_contains_invalid_column(), recordExtObjInitPriv(), RelationClearMissing(), removeExtObjInitPriv(), RemoveStatisticsDataById(), SearchSysCacheAttName(), SearchSysCacheAttNum(), statext_dependencies_load(), statext_expressions_load(), statext_mcv_load(), statext_ndistinct_load(), and StoreAttrMissingVal().

◆ SearchSysCache3()

HeapTuple SearchSysCache3	(	int	cacheId,
		Datum	key1,
		Datum	key2,
		Datum	key3
	)

Definition at line 243 of file syscache.c.

{
    Assert(cacheId >= 0 && cacheId < SysCacheSize &&
           PointerIsValid(SysCache[cacheId]));
    Assert(SysCache[cacheId]->cc_nkeys == 3);
 
    return SearchCatCache3(SysCache[cacheId], key1, key2, key3);
}

References Assert(), PointerIsValid, SearchCatCache3(), and SysCache.

Referenced by AddRoleMems(), attribute_statistics_update(), brincostestimate(), DefineOpClass(), delete_pg_statistic(), examine_indexcol_variable(), examine_simple_variable(), examine_variable(), ExecHashBuildSkewHash(), get_attavgwidth(), get_default_acl_internal(), get_object_address_defacl(), get_op_opfamily_properties(), get_op_opfamily_sortfamily(), get_op_opfamily_strategy(), lookup_collation(), OpClassCacheLookup(), OpFamilyCacheLookup(), ProcedureCreate(), ResolveOpClass(), SetDefaultACL(), and update_attstats().

◆ SearchSysCache4()

HeapTuple SearchSysCache4	(	int	cacheId,
		Datum	key1,
		Datum	key2,
		Datum	key3,
		Datum	key4
	)

Definition at line 254 of file syscache.c.

{
    Assert(cacheId >= 0 && cacheId < SysCacheSize &&
           PointerIsValid(SysCache[cacheId]));
    Assert(SysCache[cacheId]->cc_nkeys == 4);
 
    return SearchCatCache4(SysCache[cacheId], key1, key2, key3, key4);
}

References Assert(), PointerIsValid, SearchCatCache4(), and SysCache.

Referenced by get_object_address_opf_member(), get_opfamily_member(), get_opfamily_proc(), inclusion_get_strategy_procinfo(), minmax_get_strategy_procinfo(), minmax_multi_get_strategy_procinfo(), OperatorGet(), and OpernameGetOprid().

◆ SearchSysCacheAttName()

HeapTuple SearchSysCacheAttName	(	Oid	relid,
		const char *	attname
	)

Definition at line 480 of file syscache.c.

{
    HeapTuple   tuple;
 
    tuple = SearchSysCache2(ATTNAME,
                            ObjectIdGetDatum(relid),
                            CStringGetDatum(attname));
    if (!HeapTupleIsValid(tuple))
        return NULL;
    if (((Form_pg_attribute) GETSTRUCT(tuple))->attisdropped)
    {
        ReleaseSysCache(tuple);
        return NULL;
    }
    return tuple;
}

References attname, CStringGetDatum(), GETSTRUCT(), HeapTupleIsValid, ObjectIdGetDatum(), ReleaseSysCache(), and SearchSysCache2().

Referenced by ATExecAlterColumnGenericOptions(), ATExecDropColumn(), ATExecSetExpression(), ATExecSetOptions(), ATExecSetStatistics(), ATPrepAlterColumnType(), ComputeIndexAttrs(), ComputePartitionAttrs(), CreateStatistics(), get_attnum(), make_inh_translation_list(), pg_nextoid(), plpgsql_parse_cwordtype(), SearchSysCacheCopyAttName(), SearchSysCacheExistsAttName(), SetAttrMissing(), and transformColumnNameList().

◆ SearchSysCacheAttNum()

HeapTuple SearchSysCacheAttNum	(	Oid	relid,
		int16	attnum
	)

Definition at line 543 of file syscache.c.

{
    HeapTuple   tuple;
 
    tuple = SearchSysCache2(ATTNUM,
                            ObjectIdGetDatum(relid),
                            Int16GetDatum(attnum));
    if (!HeapTupleIsValid(tuple))
        return NULL;
    if (((Form_pg_attribute) GETSTRUCT(tuple))->attisdropped)
    {
        ReleaseSysCache(tuple);
        return NULL;
    }
    return tuple;
}

References attnum, GETSTRUCT(), HeapTupleIsValid, Int16GetDatum(), ObjectIdGetDatum(), ReleaseSysCache(), and SearchSysCache2().

Referenced by ATExecSetStatistics(), and SearchSysCacheCopyAttNum().

◆ SearchSysCacheCopy()

HeapTuple SearchSysCacheCopy	(	int	cacheId,
		Datum	key1,
		Datum	key2,
		Datum	key3,
		Datum	key4
	)

Definition at line 379 of file syscache.c.

{
    HeapTuple   tuple,
                newtuple;
 
    tuple = SearchSysCache(cacheId, key1, key2, key3, key4);
    if (!HeapTupleIsValid(tuple))
        return tuple;
    newtuple = heap_copytuple(tuple);
    ReleaseSysCache(tuple);
    return newtuple;
}

References heap_copytuple(), HeapTupleIsValid, ReleaseSysCache(), and SearchSysCache().

◆ SearchSysCacheCopyAttName()

HeapTuple SearchSysCacheCopyAttName	(	Oid	relid,
		const char *	attname
	)

Definition at line 503 of file syscache.c.

{
    HeapTuple   tuple,
                newtuple;
 
    tuple = SearchSysCacheAttName(relid, attname);
    if (!HeapTupleIsValid(tuple))
        return tuple;
    newtuple = heap_copytuple(tuple);
    ReleaseSysCache(tuple);
    return newtuple;
}

References attname, heap_copytuple(), HeapTupleIsValid, ReleaseSysCache(), and SearchSysCacheAttName().

Referenced by ATExecAddColumn(), ATExecAddIdentity(), ATExecAlterColumnType(), ATExecDropColumn(), ATExecDropExpression(), ATExecDropIdentity(), ATExecDropNotNull(), ATExecSetCompression(), ATExecSetIdentity(), ATExecSetStorage(), ATPrepDropExpression(), MergeAttributesIntoExisting(), and renameatt_internal().

◆ SearchSysCacheCopyAttNum()

HeapTuple SearchSysCacheCopyAttNum	(	Oid	relid,
		int16	attnum
	)

Definition at line 566 of file syscache.c.

{
    HeapTuple   tuple,
                newtuple;
 
    tuple = SearchSysCacheAttNum(relid, attnum);
    if (!HeapTupleIsValid(tuple))
        return NULL;
    newtuple = heap_copytuple(tuple);
    ReleaseSysCache(tuple);
    return newtuple;
}

References attnum, heap_copytuple(), HeapTupleIsValid, ReleaseSysCache(), and SearchSysCacheAttNum().

Referenced by dropconstraint_internal(), pg_get_acl(), set_attnotnull(), and SetIndexStorageProperties().

◆ SearchSysCacheExists()

bool SearchSysCacheExists	(	int	cacheId,
		Datum	key1,
		Datum	key2,
		Datum	key3,
		Datum	key4
	)

Definition at line 425 of file syscache.c.

{
    HeapTuple   tuple;
 
    tuple = SearchSysCache(cacheId, key1, key2, key3, key4);
    if (!HeapTupleIsValid(tuple))
        return false;
    ReleaseSysCache(tuple);
    return true;
}

References HeapTupleIsValid, ReleaseSysCache(), and SearchSysCache().

◆ SearchSysCacheExistsAttName()

bool SearchSysCacheExistsAttName	(	Oid	relid,
		const char *	attname
	)

Definition at line 522 of file syscache.c.

{
    HeapTuple   tuple;
 
    tuple = SearchSysCacheAttName(relid, attname);
    if (!HeapTupleIsValid(tuple))
        return false;
    ReleaseSysCache(tuple);
    return true;
}

References attname, HeapTupleIsValid, ReleaseSysCache(), and SearchSysCacheAttName().

Referenced by attribute_statistics_update(), and RemoveInheritance().

◆ SearchSysCacheList()

struct catclist * SearchSysCacheList	(	int	cacheId,
		int	nkeys,
		Datum	key1,
		Datum	key2,
		Datum	key3
	)

Definition at line 678 of file syscache.c.

{
    if (cacheId < 0 || cacheId >= SysCacheSize ||
        !PointerIsValid(SysCache[cacheId]))
        elog(ERROR, "invalid cache ID: %d", cacheId);
 
    return SearchCatCacheList(SysCache[cacheId], nkeys,
                              key1, key2, key3);
}

References elog, ERROR, catclist::nkeys, PointerIsValid, SearchCatCacheList(), and SysCache.

◆ SearchSysCacheLocked1()

HeapTuple SearchSysCacheLocked1	(	int	cacheId,
		Datum	key1
	)

Definition at line 287 of file syscache.c.

{
    CatCache   *cache = SysCache[cacheId];
    ItemPointerData tid;
    LOCKTAG     tag;
 
    /*----------
     * Since inplace updates may happen just before our LockTuple(), we must
     * return content acquired after LockTuple() of the TID we return.  If we
     * just fetched twice instead of looping, the following sequence would
     * defeat our locking:
     *
     * GRANT:   SearchSysCache1() = TID (1,5)
     * GRANT:   LockTuple(pg_class, (1,5))
     * [no more inplace update of (1,5) until we release the lock]
     * CLUSTER: SearchSysCache1() = TID (1,5)
     * CLUSTER: heap_update() = TID (1,8)
     * CLUSTER: COMMIT
     * GRANT:   SearchSysCache1() = TID (1,8)
     * GRANT:   return (1,8) from SearchSysCacheLocked1()
     * VACUUM:  SearchSysCache1() = TID (1,8)
     * VACUUM:  LockTuple(pg_class, (1,8))  # two TIDs now locked for one rel
     * VACUUM:  inplace update
     * GRANT:   heap_update() = (1,9)  # lose inplace update
     *
     * In the happy case, this takes two fetches, one to determine the TID to
     * lock and another to get the content and confirm the TID didn't change.
     *
     * This is valid even if the row gets updated to a new TID, the old TID
     * becomes LP_UNUSED, and the row gets updated back to its old TID.  We'd
     * still hold the right LOCKTAG_TUPLE and a copy of the row captured after
     * the LOCKTAG_TUPLE.
     */
    ItemPointerSetInvalid(&tid);
    for (;;)
    {
        HeapTuple   tuple;
        LOCKMODE    lockmode = InplaceUpdateTupleLock;
 
        tuple = SearchSysCache1(cacheId, key1);
        if (ItemPointerIsValid(&tid))
        {
            if (!HeapTupleIsValid(tuple))
            {
                LockRelease(&tag, lockmode, false);
                return tuple;
            }
            if (ItemPointerEquals(&tid, &tuple->t_self))
                return tuple;
            LockRelease(&tag, lockmode, false);
        }
        else if (!HeapTupleIsValid(tuple))
            return tuple;
 
        tid = tuple->t_self;
        ReleaseSysCache(tuple);
 
        /*
         * Do like LockTuple(rel, &tid, lockmode).  While cc_relisshared won't
         * change from one iteration to another, it may have been a temporary
         * "false" until our first SearchSysCache1().
         */
        SET_LOCKTAG_TUPLE(tag,
                          cache->cc_relisshared ? InvalidOid : MyDatabaseId,
                          cache->cc_reloid,
                          ItemPointerGetBlockNumber(&tid),
                          ItemPointerGetOffsetNumber(&tid));
        (void) LockAcquire(&tag, lockmode, false, false);
 
        /*
         * If an inplace update just finished, ensure we process the syscache
         * inval.
         *
         * If a heap_update() call just released its LOCKTAG_TUPLE, we'll
         * probably find the old tuple and reach "tuple concurrently updated".
         * If that heap_update() aborts, our LOCKTAG_TUPLE blocks inplace
         * updates while our caller works.
         */
        AcceptInvalidationMessages();
    }
}

References AcceptInvalidationMessages(), catcache::cc_relisshared, catcache::cc_reloid, HeapTupleIsValid, InplaceUpdateTupleLock, InvalidOid, ItemPointerEquals(), ItemPointerGetBlockNumber(), ItemPointerGetOffsetNumber(), ItemPointerIsValid(), ItemPointerSetInvalid(), LockAcquire(), LockRelease(), MyDatabaseId, ReleaseSysCache(), SearchSysCache1(), SET_LOCKTAG_TUPLE, SysCache, and HeapTupleData::t_self.

Referenced by ATExecSetRelOptions(), ExecGrant_common(), ExecGrant_Relation(), and SearchSysCacheLockedCopy1().

◆ SearchSysCacheLockedCopy1()

HeapTuple SearchSysCacheLockedCopy1	(	int	cacheId,
		Datum	key1
	)

Definition at line 404 of file syscache.c.

{
    HeapTuple   tuple,
                newtuple;
 
    tuple = SearchSysCacheLocked1(cacheId, key1);
    if (!HeapTupleIsValid(tuple))
        return tuple;
    newtuple = heap_copytuple(tuple);
    ReleaseSysCache(tuple);
    return newtuple;
}

References heap_copytuple(), HeapTupleIsValid, ReleaseSysCache(), and SearchSysCacheLocked1().

Referenced by AlterRelationNamespaceInternal(), get_catalog_object_by_oid_extended(), RelationSetNewRelfilenumber(), RenameDatabase(), RenameRelationInternal(), SetDatabaseHasLoginEventTriggers(), SetRelationTableSpace(), and update_relispartition().

◆ SysCacheGetAttr()

Datum SysCacheGetAttr	(	int	cacheId,
		HeapTuple	tup,
		AttrNumber	attributeNumber,
		bool *	isNull
	)

Definition at line 600 of file syscache.c.

{
    /*
     * We just need to get the TupleDesc out of the cache entry, and then we
     * can apply heap_getattr().  Normally the cache control data is already
     * valid (because the caller recently fetched the tuple via this same
     * cache), but there are cases where we have to initialize the cache here.
     */
    if (cacheId < 0 || cacheId >= SysCacheSize ||
        !PointerIsValid(SysCache[cacheId]))
        elog(ERROR, "invalid cache ID: %d", cacheId);
    if (!PointerIsValid(SysCache[cacheId]->cc_tupdesc))
    {
        InitCatCachePhase2(SysCache[cacheId], false);
        Assert(PointerIsValid(SysCache[cacheId]->cc_tupdesc));
    }
 
    return heap_getattr(tup, attributeNumber,
                        SysCache[cacheId]->cc_tupdesc,
                        isNull);
}

References Assert(), elog, ERROR, heap_getattr(), InitCatCachePhase2(), PointerIsValid, and SysCache.

Referenced by AlterCollation(), AlterForeignDataWrapper(), AlterForeignServer(), AlterFunction(), AlterPublicationTables(), AlterRole(), AlterSchemaOwner_internal(), AlterTSDictionary(), AlterUserMapping(), ATExecAlterColumnGenericOptions(), ATExecChangeOwner(), ATExecGenericOptions(), ATExecSetOptions(), ATExecSetRelOptions(), build_function_result_tupdesc_t(), check_and_fetch_column_list(), CheckMyDatabase(), compile_plperl_function(), create_pg_locale(), create_pg_locale_icu(), DeconstructFkConstraintRow(), DefineCollation(), DefineDomain(), DropSubscription(), examine_attribute(), ExecGrant_Attribute(), ExecGrant_common(), ExecGrant_Parameter(), ExecGrant_Relation(), ExecInitAgg(), expand_function_arguments(), fetch_statentries_for_relation(), flatten_reloptions(), fmgr_security_definer(), fmgr_sql_validator(), FuncnameGetCandidates(), generate_partition_qual(), generateClonedExtStatsStmt(), generateClonedIndexStmt(), get_attoptions(), get_attribute_options(), get_db_info(), get_default_acl_internal(), get_func_arg_info(), get_func_trftypes(), get_relation_statistics(), get_role_password(), get_tablespace(), get_typdefault(), GetForeignColumnOptions(), GetForeignDataWrapperExtended(), GetForeignServerExtended(), GetForeignTable(), GetSubscription(), GetSubscriptionRelations(), GetSubscriptionRelState(), GetUserMapping(), index_concurrently_create_copy(), initialize_peragg(), inline_function(), inline_set_returning_function(), lookup_ts_dictionary_cache(), make_new_heap(), MatchNamedCall(), object_aclmask_ext(), pg_attribute_aclcheck_all_ext(), pg_attribute_aclmask_ext(), pg_class_aclmask_ext(), pg_get_acl(), pg_get_constraintdef_worker(), pg_get_function_arg_default(), pg_get_function_sqlbody(), pg_get_functiondef(), pg_get_publication_tables(), pg_namespace_aclmask_ext(), pg_parameter_acl_aclmask(), pg_parameter_aclmask(), pg_type_aclmask_ext(), pgoutput_row_filter_init(), plsample_func_handler(), plsample_trigger_handler(), PLy_procedure_create(), prepare_sql_fn_parse_info(), preprocess_aggref(), print_function_arguments(), ProcedureCreate(), pub_rf_contains_invalid_column(), recordExtObjInitPriv(), RelationBuildPartitionDesc(), RelationBuildPartitionKey(), SetDefaultACL(), sql_compile_callback(), statext_dependencies_load(), statext_expressions_load(), statext_mcv_load(), statext_ndistinct_load(), StorePartitionBound(), SysCacheGetAttrNotNull(), and transformCallStmt().

◆ SysCacheGetAttrNotNull()

Datum SysCacheGetAttrNotNull	(	int	cacheId,
		HeapTuple	tup,
		AttrNumber	attributeNumber
	)

Definition at line 631 of file syscache.c.

{
    bool        isnull;
    Datum       attr;
 
    attr = SysCacheGetAttr(cacheId, tup, attributeNumber, &isnull);
 
    if (isnull)
    {
        elog(ERROR,
             "unexpected null value in cached tuple for catalog %s column %s",
             get_rel_name(cacheinfo[cacheId].reloid),
             NameStr(TupleDescAttr(SysCache[cacheId]->cc_tupdesc, attributeNumber - 1)->attname));
    }
 
    return attr;
}

References attname, elog, ERROR, get_rel_name(), NameStr, SysCache, SysCacheGetAttr(), and TupleDescAttr().

Referenced by AlterCollation(), AlterDomainValidateConstraint(), build_function_result_tupdesc_t(), build_replindex_scan_key(), CheckIndexCompatible(), CheckMyDatabase(), compile_plperl_function(), compile_pltcl_function(), create_pg_locale(), create_pg_locale_builtin(), create_pg_locale_icu(), create_pg_locale_libc(), DeconstructFkConstraintRow(), DropSubscription(), ExecGrant_common(), ExecGrant_Parameter(), extractNotNullColumn(), fetch_function_defaults(), fetch_statentries_for_relation(), fmgr_c_validator(), fmgr_info_C_lang(), fmgr_info_cxt_security(), fmgr_internal_validator(), fmgr_sql_validator(), fmgr_symbol(), func_get_detail(), generateClonedExtStatsStmt(), generateClonedIndexStmt(), get_attstatsslot(), get_db_info(), get_func_result_name(), get_index_column_opclass(), get_object_namespace(), get_qual_for_range(), getObjectDescription(), getObjectIdentityParts(), GetSubscription(), inclusion_get_strategy_procinfo(), index_concurrently_create_copy(), index_opclass_options(), inline_function(), inline_set_returning_function(), IsIndexUsableForReplicaIdentityFull(), minmax_get_strategy_procinfo(), minmax_multi_get_strategy_procinfo(), object_aclmask_ext(), object_ownercheck(), pg_collation_actual_version(), pg_database_collation_actual_version(), pg_get_constraintdef_worker(), pg_get_functiondef(), pg_get_indexdef_worker(), pg_get_partkeydef_worker(), pg_get_statisticsobj_worker(), pg_get_statisticsobjdef_expressions(), plpgsql_compile_callback(), PLy_procedure_create(), print_function_sqlbody(), ProcedureCreate(), QueueCheckConstraintValidation(), refresh_by_match_merge(), RelationBuildPartitionKey(), RemoveRoleFromInitPriv(), sql_compile_callback(), test_indoption(), transformFkeyCheckAttrs(), transformFkeyGetPrimaryKey(), transformIndexConstraint(), and TryReuseForeignKey().

◆ SysCacheInvalidate()

void SysCacheInvalidate	(	int	cacheId,
		uint32	hashValue
	)

Definition at line 698 of file syscache.c.

{
    if (cacheId < 0 || cacheId >= SysCacheSize)
        elog(ERROR, "invalid cache ID: %d", cacheId);
 
    /* if this cache isn't initialized yet, no need to do anything */
    if (!PointerIsValid(SysCache[cacheId]))
        return;
 
    CatCacheInvalidate(SysCache[cacheId], hashValue);
}

References CatCacheInvalidate(), elog, ERROR, PointerIsValid, and SysCache.

Referenced by LocalExecuteInvalidationMessage().

Macros

Functions