rel.h File Reference

#include "access/tupdesc.h"
#include "access/xlog.h"
#include "catalog/catalog.h"
#include "catalog/pg_class.h"
#include "catalog/pg_index.h"
#include "catalog/pg_publication.h"
#include "nodes/bitmapset.h"
#include "partitioning/partdefs.h"
#include "rewrite/prs2lock.h"
#include "storage/block.h"
#include "storage/relfilelocator.h"
#include "storage/smgr.h"
#include "utils/relcache.h"
#include "utils/reltrigger.h"

Include dependency graph for rel.h:

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

Go to the source code of this file.

Data Structures
struct	LockRelId
struct	LockInfoData
struct	RelationData
struct	ForeignKeyCacheInfo
struct	AutoVacOpts
struct	StdRdOptions
struct	ViewOptions

Macros
#define	HEAP_MIN_FILLFACTOR   10
#define	HEAP_DEFAULT_FILLFACTOR   100
#define	RelationGetToastTupleTarget(relation, defaulttarg)
#define	RelationGetFillFactor(relation, defaultff)
#define	RelationGetTargetPageUsage(relation, defaultff)    (BLCKSZ * RelationGetFillFactor(relation, defaultff) / 100)
#define	RelationGetTargetPageFreeSpace(relation, defaultff)    (BLCKSZ * (100 - RelationGetFillFactor(relation, defaultff)) / 100)
#define	RelationIsUsedAsCatalogTable(relation)
#define	RelationGetParallelWorkers(relation, defaultpw)
#define	RelationIsSecurityView(relation)
#define	RelationHasSecurityInvoker(relation)
#define	RelationHasCheckOption(relation)
#define	RelationHasLocalCheckOption(relation)
#define	RelationHasCascadedCheckOption(relation)
#define	RelationIsValid(relation)   ((relation) != NULL)
#define	RelationHasReferenceCountZero(relation)    ((bool)((relation)->rd_refcnt == 0))
#define	RelationGetForm(relation)   ((relation)->rd_rel)
#define	RelationGetRelid(relation)   ((relation)->rd_id)
#define	RelationGetNumberOfAttributes(relation)   ((relation)->rd_rel->relnatts)
#define	IndexRelationGetNumberOfAttributes(relation)    ((relation)->rd_index->indnatts)
#define	IndexRelationGetNumberOfKeyAttributes(relation)    ((relation)->rd_index->indnkeyatts)
#define	RelationGetDescr(relation)   ((relation)->rd_att)
#define	RelationGetRelationName(relation)    (NameStr((relation)->rd_rel->relname))
#define	RelationGetNamespace(relation)    ((relation)->rd_rel->relnamespace)
#define	RelationIsMapped(relation)
#define	RelationGetTargetBlock(relation)    ( (relation)->rd_smgr != NULL ? (relation)->rd_smgr->smgr_targblock : InvalidBlockNumber )
#define	RelationSetTargetBlock(relation, targblock)
#define	RelationIsPermanent(relation)    ((relation)->rd_rel->relpersistence == RELPERSISTENCE_PERMANENT)
#define	RelationNeedsWAL(relation)
#define	RelationUsesLocalBuffers(relation)    ((relation)->rd_rel->relpersistence == RELPERSISTENCE_TEMP)
#define	RELATION_IS_LOCAL(relation)
#define	RELATION_IS_OTHER_TEMP(relation)
#define	RelationIsScannable(relation)   ((relation)->rd_rel->relispopulated)
#define	RelationIsPopulated(relation)   ((relation)->rd_rel->relispopulated)
#define	RelationIsAccessibleInLogicalDecoding(relation)
#define	RelationIsLogicallyLogged(relation)

Typedefs
typedef struct LockRelId	LockRelId
typedef struct LockInfoData	LockInfoData
typedef LockInfoData *	LockInfo
typedef struct RelationData	RelationData
typedef struct ForeignKeyCacheInfo	ForeignKeyCacheInfo
typedef struct AutoVacOpts	AutoVacOpts
typedef enum StdRdOptIndexCleanup	StdRdOptIndexCleanup
typedef struct StdRdOptions	StdRdOptions
typedef enum ViewOptCheckOption	ViewOptCheckOption
typedef struct ViewOptions	ViewOptions

Enumerations
enum	StdRdOptIndexCleanup { STDRD_OPTION_VACUUM_INDEX_CLEANUP_AUTO = 0 , STDRD_OPTION_VACUUM_INDEX_CLEANUP_OFF , STDRD_OPTION_VACUUM_INDEX_CLEANUP_ON }
enum	ViewOptCheckOption { VIEW_OPTION_CHECK_OPTION_NOT_SET , VIEW_OPTION_CHECK_OPTION_LOCAL , VIEW_OPTION_CHECK_OPTION_CASCADED }

Functions
static SMgrRelation	RelationGetSmgr (Relation rel)
static void	RelationCloseSmgr (Relation relation)
void	RelationIncrementReferenceCount (Relation rel)
void	RelationDecrementReferenceCount (Relation rel)

Macro Definition Documentation

HEAP_DEFAULT_FILLFACTOR

#define HEAP_DEFAULT_FILLFACTOR   100

Definition at line 360 of file rel.h.

HEAP_MIN_FILLFACTOR

#define HEAP_MIN_FILLFACTOR   10

Definition at line 359 of file rel.h.

IndexRelationGetNumberOfAttributes

#define IndexRelationGetNumberOfAttributes

(

relation

)

((relation)->rd_index->indnatts)

Definition at line 526 of file rel.h.

{
    if (unlikely(rel->rd_smgr == NULL))
    {
        rel->rd_smgr = smgropen(rel->rd_locator, rel->rd_backend);
        smgrpin(rel->rd_smgr);
    }
    return rel->rd_smgr;
}
 
/*
 * RelationCloseSmgr
 *      Close the relation at the smgr level, if not already done.
 */
static inline void
RelationCloseSmgr(Relation relation)
{
    if (relation->rd_smgr != NULL)
    {
        smgrunpin(relation->rd_smgr);
        smgrclose(relation->rd_smgr);
        relation->rd_smgr = NULL;
    }
}
#endif                          /* !FRONTEND */
 
/*
 * RelationGetTargetBlock
 *      Fetch relation's current insertion target block.
 *
 * Returns InvalidBlockNumber if there is no current target block.  Note
 * that the target block status is discarded on any smgr-level invalidation,
 * so there's no need to re-open the smgr handle if it's not currently open.
 */
#define RelationGetTargetBlock(relation) \
    ( (relation)->rd_smgr != NULL ? (relation)->rd_smgr->smgr_targblock : InvalidBlockNumber )
 
/*
 * RelationSetTargetBlock
 *      Set relation's current insertion target block.
 */
#define RelationSetTargetBlock(relation, targblock) \
    do { \
        RelationGetSmgr(relation)->smgr_targblock = (targblock); \
    } while (0)
 
/*
 * RelationIsPermanent
 *      True if relation is permanent.
 */
#define RelationIsPermanent(relation) \
    ((relation)->rd_rel->relpersistence == RELPERSISTENCE_PERMANENT)
 
/*
 * RelationNeedsWAL
 *      True if relation needs WAL.
 *
 * Returns false if wal_level = minimal and this relation is created or
 * truncated in the current transaction.  See "Skipping WAL for New
 * RelFileLocator" in src/backend/access/transam/README.
 */
#define RelationNeedsWAL(relation)                                      \
    (RelationIsPermanent(relation) && (XLogIsNeeded() ||                \
      (relation->rd_createSubid == InvalidSubTransactionId &&           \
       relation->rd_firstRelfilelocatorSubid == InvalidSubTransactionId)))
 
/*
 * RelationUsesLocalBuffers
 *      True if relation's pages are stored in local buffers.
 */
#define RelationUsesLocalBuffers(relation) \
    ((relation)->rd_rel->relpersistence == RELPERSISTENCE_TEMP)
 
/*
 * RELATION_IS_LOCAL
 *      If a rel is either temp or newly created in the current transaction,
 *      it can be assumed to be accessible only to the current backend.
 *      This is typically used to decide that we can skip acquiring locks.
 *
 * Beware of multiple eval of argument
 */
#define RELATION_IS_LOCAL(relation) \
    ((relation)->rd_islocaltemp || \
     (relation)->rd_createSubid != InvalidSubTransactionId)
 
/*
 * RELATION_IS_OTHER_TEMP
 *      Test for a temporary relation that belongs to some other session.
 *
 * Beware of multiple eval of argument
 */
#define RELATION_IS_OTHER_TEMP(relation) \
    ((relation)->rd_rel->relpersistence == RELPERSISTENCE_TEMP && \
     !(relation)->rd_islocaltemp)
 
 
/*
 * RelationIsScannable
 *      Currently can only be false for a materialized view which has not been
 *      populated by its query.  This is likely to get more complicated later,
 *      so use a macro which looks like a function.
 */
#define RelationIsScannable(relation) ((relation)->rd_rel->relispopulated)
 
/*
 * RelationIsPopulated
 *      Currently, we don't physically distinguish the "populated" and
 *      "scannable" properties of matviews, but that may change later.
 *      Hence, use the appropriate one of these macros in code tests.
 */
#define RelationIsPopulated(relation) ((relation)->rd_rel->relispopulated)
 
/*
 * RelationIsAccessibleInLogicalDecoding
 *      True if we need to log enough information to have access via
 *      decoding snapshot.
 */
#define RelationIsAccessibleInLogicalDecoding(relation) \
    (XLogLogicalInfoActive() && \
     RelationNeedsWAL(relation) && \
     (IsCatalogRelation(relation) || RelationIsUsedAsCatalogTable(relation)))
 
/*
 * RelationIsLogicallyLogged
 *      True if we need to log enough information to extract the data from the
 *      WAL stream.
 *
 * We don't log information for unlogged tables (since they don't WAL log
 * anyway), for foreign tables (since they don't WAL log, either),
 * and for system tables (their content is hard to make sense of, and
 * it would complicate decoding slightly for little gain). Note that we *do*
 * log information for user defined catalog tables since they presumably are
 * interesting to the user...
 */
#define RelationIsLogicallyLogged(relation) \
    (XLogLogicalInfoActive() && \
     RelationNeedsWAL(relation) && \
     (relation)->rd_rel->relkind != RELKIND_FOREIGN_TABLE &&    \
     !IsCatalogRelation(relation))
 
/* routines in utils/cache/relcache.c */
extern void RelationIncrementReferenceCount(Relation rel);
extern void RelationDecrementReferenceCount(Relation rel);
 
#endif                          /* REL_H */

IndexRelationGetNumberOfKeyAttributes

#define IndexRelationGetNumberOfKeyAttributes

(

relation

)

((relation)->rd_index->indnkeyatts)

Definition at line 533 of file rel.h.

RELATION_IS_LOCAL

#define RELATION_IS_LOCAL

(

relation

)

Value:

    ((relation)->rd_islocaltemp || \
     (relation)->rd_createSubid != InvalidSubTransactionId)

Definition at line 657 of file rel.h.

RELATION_IS_OTHER_TEMP

#define RELATION_IS_OTHER_TEMP

(

relation

)

Value:

    ((relation)->rd_rel->relpersistence == RELPERSISTENCE_TEMP && \
     !(relation)->rd_islocaltemp)

Definition at line 667 of file rel.h.

RelationGetDescr

#define RelationGetDescr

(

relation

)

((relation)->rd_att)

Definition at line 540 of file rel.h.

RelationGetFillFactor

#define RelationGetFillFactor	(		relation,
			defaultff
	)

Value:

    ((relation)->rd_options ? \
     ((StdRdOptions *) (relation)->rd_options)->fillfactor : (defaultff))

Definition at line 374 of file rel.h.

                                                           : (defaultff))

RelationGetForm

#define RelationGetForm

(

relation

)

((relation)->rd_rel)

Definition at line 508 of file rel.h.

RelationGetNamespace

#define RelationGetNamespace

(

relation

)

((relation)->rd_rel->relnamespace)

Definition at line 555 of file rel.h.

RelationGetNumberOfAttributes

#define RelationGetNumberOfAttributes

(

relation

)

((relation)->rd_rel->relnatts)

Definition at line 520 of file rel.h.

RelationGetParallelWorkers

#define RelationGetParallelWorkers	(		relation,
			defaultpw
	)

Value:

    ((relation)->rd_options ? \
     ((StdRdOptions *) (relation)->rd_options)->parallel_workers : (defaultpw))

Definition at line 408 of file rel.h.

                                                                 : (defaultpw))

RelationGetRelationName

#define RelationGetRelationName

(

relation

)

(NameStr((relation)->rd_rel->relname))

Definition at line 548 of file rel.h.

RelationGetRelid

#define RelationGetRelid

(

relation

)

((relation)->rd_id)

Definition at line 514 of file rel.h.

RelationGetTargetBlock

#define RelationGetTargetBlock

(

relation

)

( (relation)->rd_smgr != NULL ? (relation)->rd_smgr->smgr_targblock : InvalidBlockNumber )

Definition at line 610 of file rel.h.

                                                                        : InvalidBlockNumber )

RelationGetTargetPageFreeSpace

#define RelationGetTargetPageFreeSpace	(		relation,
			defaultff
	)		(BLCKSZ * (100 - RelationGetFillFactor(relation, defaultff)) / 100)

Definition at line 389 of file rel.h.

RelationGetTargetPageUsage

#define RelationGetTargetPageUsage	(		relation,
			defaultff
	)		(BLCKSZ * RelationGetFillFactor(relation, defaultff) / 100)

Definition at line 382 of file rel.h.

RelationGetToastTupleTarget

#define RelationGetToastTupleTarget	(		relation,
			defaulttarg
	)

Value:

    ((relation)->rd_options ? \
     ((StdRdOptions *) (relation)->rd_options)->toast_tuple_target : (defaulttarg))

Definition at line 366 of file rel.h.

                                                                   : (defaulttarg))

RelationHasCascadedCheckOption

#define RelationHasCascadedCheckOption

(

relation

)

Value:

    (AssertMacro(relation->rd_rel->relkind == RELKIND_VIEW),                \
     (relation)->rd_options &&                                              \
     ((ViewOptions *) (relation)->rd_options)->check_option ==              \
      VIEW_OPTION_CHECK_OPTION_CASCADED)

Definition at line 479 of file rel.h.

RelationHasCheckOption

#define RelationHasCheckOption

(

relation

)

Value:

    (AssertMacro(relation->rd_rel->relkind == RELKIND_VIEW),                \
     (relation)->rd_options &&                                              \
     ((ViewOptions *) (relation)->rd_options)->check_option !=              \
     VIEW_OPTION_CHECK_OPTION_NOT_SET)

Definition at line 457 of file rel.h.

RelationHasLocalCheckOption

#define RelationHasLocalCheckOption

(

relation

)

Value:

    (AssertMacro(relation->rd_rel->relkind == RELKIND_VIEW),                \
     (relation)->rd_options &&                                              \
     ((ViewOptions *) (relation)->rd_options)->check_option ==              \
     VIEW_OPTION_CHECK_OPTION_LOCAL)

Definition at line 468 of file rel.h.

RelationHasReferenceCountZero

#define RelationHasReferenceCountZero

(

relation

)

((bool)((relation)->rd_refcnt == 0))

Definition at line 498 of file rel.h.

RelationHasSecurityInvoker

#define RelationHasSecurityInvoker

(

relation

)

Value:

    (AssertMacro(relation->rd_rel->relkind == RELKIND_VIEW),                \
     (relation)->rd_options ?                                               \
      ((ViewOptions *) (relation)->rd_options)->security_invoker : false)

Definition at line 447 of file rel.h.

                                                                 : false)

RelationIsAccessibleInLogicalDecoding

#define RelationIsAccessibleInLogicalDecoding

(

relation

)

Value:

    (XLogLogicalInfoActive() && \
	 RelationNeedsWAL(relation) && \
     (IsCatalogRelation(relation) || RelationIsUsedAsCatalogTable(relation)))

Definition at line 693 of file rel.h.

RelationIsLogicallyLogged

#define RelationIsLogicallyLogged

(

relation

)

Value:

    (XLogLogicalInfoActive() && \
	 RelationNeedsWAL(relation) && \
     (relation)->rd_rel->relkind != RELKIND_FOREIGN_TABLE &&    \
     !IsCatalogRelation(relation))

Definition at line 710 of file rel.h.

RelationIsMapped

#define RelationIsMapped

(

relation

)

Value:

    (RELKIND_HAS_STORAGE((relation)->rd_rel->relkind) && \
     ((relation)->rd_rel->relfilenode == InvalidRelFileNumber))

Definition at line 563 of file rel.h.

RelationIsPermanent

#define RelationIsPermanent

(

relation

)

((relation)->rd_rel->relpersistence == RELPERSISTENCE_PERMANENT)

Definition at line 626 of file rel.h.

RelationIsPopulated

#define RelationIsPopulated

(

relation

)

((relation)->rd_rel->relispopulated)

Definition at line 686 of file rel.h.

RelationIsScannable

#define RelationIsScannable

(

relation

)

((relation)->rd_rel->relispopulated)

Definition at line 678 of file rel.h.

RelationIsSecurityView

#define RelationIsSecurityView

(

relation

)

Value:

    (AssertMacro(relation->rd_rel->relkind == RELKIND_VIEW),                \
     (relation)->rd_options ?                                               \
      ((ViewOptions *) (relation)->rd_options)->security_barrier : false)

Definition at line 437 of file rel.h.

                                                                 : false)

RelationIsUsedAsCatalogTable

#define RelationIsUsedAsCatalogTable

(

relation

)

Value:

    ((relation)->rd_options && \
     ((relation)->rd_rel->relkind == RELKIND_RELATION || \
      (relation)->rd_rel->relkind == RELKIND_MATVIEW) ? \
     ((StdRdOptions *) (relation)->rd_options)->user_catalog_table : false)

Definition at line 397 of file rel.h.

                                                                   : false)

RelationIsValid

#define RelationIsValid

(

relation

)

((relation) != NULL)

Definition at line 489 of file rel.h.

RelationNeedsWAL

#define RelationNeedsWAL

(

relation

)

Value:

    (RelationIsPermanent(relation) && (XLogIsNeeded() ||                \
      (relation->rd_createSubid == InvalidSubTransactionId &&           \
       relation->rd_firstRelfilelocatorSubid == InvalidSubTransactionId)))

Definition at line 637 of file rel.h.

RelationSetTargetBlock

#define RelationSetTargetBlock	(		relation,
			targblock
	)

Value:

    do { \
		RelationGetSmgr(relation)->smgr_targblock = (targblock); \
    } while (0)

Definition at line 617 of file rel.h.

       { \
		RelationGetSmgr(relation)->smgr_targblock = (targblock); \
    } while (0)

RelationUsesLocalBuffers

#define RelationUsesLocalBuffers

(

relation

)

((relation)->rd_rel->relpersistence == RELPERSISTENCE_TEMP)

Definition at line 646 of file rel.h.

Typedef Documentation

AutoVacOpts

typedef struct AutoVacOpts AutoVacOpts

ForeignKeyCacheInfo

typedef struct ForeignKeyCacheInfo ForeignKeyCacheInfo

LockInfo

typedef LockInfoData* LockInfo

Definition at line 49 of file rel.h.

LockInfoData

typedef struct LockInfoData LockInfoData

LockRelId

typedef struct LockRelId LockRelId

RelationData

typedef struct RelationData RelationData

StdRdOptIndexCleanup

typedef enum StdRdOptIndexCleanup StdRdOptIndexCleanup

StdRdOptions

typedef struct StdRdOptions StdRdOptions

ViewOptCheckOption

typedef enum ViewOptCheckOption ViewOptCheckOption

ViewOptions

typedef struct ViewOptions ViewOptions

Enumeration Type Documentation

StdRdOptIndexCleanup

enum StdRdOptIndexCleanup

Enumerator
STDRD_OPTION_VACUUM_INDEX_CLEANUP_AUTO
STDRD_OPTION_VACUUM_INDEX_CLEANUP_OFF
STDRD_OPTION_VACUUM_INDEX_CLEANUP_ON

Definition at line 334 of file rel.h.

{
    STDRD_OPTION_VACUUM_INDEX_CLEANUP_AUTO = 0,
    STDRD_OPTION_VACUUM_INDEX_CLEANUP_OFF,
    STDRD_OPTION_VACUUM_INDEX_CLEANUP_ON,
} StdRdOptIndexCleanup;

ViewOptCheckOption

enum ViewOptCheckOption

Enumerator
VIEW_OPTION_CHECK_OPTION_NOT_SET
VIEW_OPTION_CHECK_OPTION_LOCAL
VIEW_OPTION_CHECK_OPTION_CASCADED

Definition at line 413 of file rel.h.

{
    VIEW_OPTION_CHECK_OPTION_NOT_SET,
    VIEW_OPTION_CHECK_OPTION_LOCAL,
    VIEW_OPTION_CHECK_OPTION_CASCADED,
} ViewOptCheckOption;

Function Documentation

RelationCloseSmgr()

static void RelationCloseSmgr ( Relation  relation )

inlinestatic

Definition at line 591 of file rel.h.

{
    if (relation->rd_smgr != NULL)
    {
        smgrunpin(relation->rd_smgr);
        smgrclose(relation->rd_smgr);
        relation->rd_smgr = NULL;
    }
}

References fb(), RelationData::rd_smgr, smgrclose(), and smgrunpin().

Referenced by RelationCacheInvalidate(), RelationDestroyRelation(), RelationDropStorage(), and RelationInvalidateRelation().

RelationDecrementReferenceCount()

void RelationDecrementReferenceCount ( Relation  rel )

extern

Definition at line 2195 of file relcache.c.

{
    Assert(rel->rd_refcnt > 0);
    rel->rd_refcnt -= 1;
    if (!IsBootstrapProcessingMode())
        ResourceOwnerForgetRelationRef(CurrentResourceOwner, rel);
}

References Assert, CurrentResourceOwner, IsBootstrapProcessingMode, RelationData::rd_refcnt, and ResourceOwnerForgetRelationRef().

Referenced by DestroyPartitionDirectory(), heap_endscan(), index_endscan(), RelationCacheInitializePhase3(), RelationClose(), and RelationFlushRelation().

RelationGetSmgr()

static SMgrRelation RelationGetSmgr ( Relation  rel )

inlinestatic

Definition at line 576 of file rel.h.

{
    if (unlikely(rel->rd_smgr == NULL))
    {
        rel->rd_smgr = smgropen(rel->rd_locator, rel->rd_backend);
        smgrpin(rel->rd_smgr);
    }
    return rel->rd_smgr;
}

References fb(), RelationData::rd_backend, RelationData::rd_locator, RelationData::rd_smgr, smgropen(), smgrpin(), and unlikely.

Referenced by _hash_alloc_buckets(), autoprewarm_database_main(), bt_index_check_callback(), FlushRelationBuffers(), FreeSpaceMapPrepareTruncateRel(), fsm_does_block_exist(), fsm_readbuf(), gistBuildCallback(), heapam_relation_copy_data(), index_build(), index_copy_data(), modify_rel_block(), pg_prewarm(), pg_truncate_visibility_map(), PrefetchBuffer(), read_rel_block_ll(), read_stream_begin_relation(), ReadBufferExtended(), RelationGetNumberOfBlocksInFork(), RelationPreTruncate(), RelationTruncate(), smgr_bulk_start_rel(), table_block_relation_size(), visibilitymap_prepare_truncate(), vm_extend(), and vm_readbuf().

RelationIncrementReferenceCount()

void RelationIncrementReferenceCount ( Relation  rel )

extern

Definition at line 2182 of file relcache.c.

{
    ResourceOwnerEnlarge(CurrentResourceOwner);
    rel->rd_refcnt += 1;
    if (!IsBootstrapProcessingMode())
        ResourceOwnerRememberRelationRef(CurrentResourceOwner, rel);
}

References CurrentResourceOwner, IsBootstrapProcessingMode, RelationData::rd_refcnt, ResourceOwnerEnlarge(), and ResourceOwnerRememberRelationRef().

Referenced by heap_beginscan(), index_beginscan_internal(), PartitionDirectoryLookup(), RelationBuildLocalRelation(), RelationCacheInitializePhase3(), RelationFlushRelation(), and RelationIdGetRelation().