/*-------------------------------------------------------------------------
*
- * rel.h--
- * POSTGRES relation descriptor definitions.
+ * rel.h
+ * POSTGRES relation descriptor (a/k/a relcache entry) definitions.
*
*
- * Copyright (c) 1994, Regents of the University of California
+ * Portions Copyright (c) 1996-2006, PostgreSQL Global Development Group
+ * Portions Copyright (c) 1994, Regents of the University of California
*
- * $Id: rel.h,v 1.2 1996/10/19 04:06:48 scrappy Exp $
+ * $PostgreSQL: pgsql/src/include/utils/rel.h,v 1.93 2006/12/23 00:43:13 tgl Exp $
*
*-------------------------------------------------------------------------
*/
-#ifndef REL_H
+#ifndef REL_H
#define REL_H
-#include "storage/fd.h"
+#include "access/tupdesc.h"
#include "catalog/pg_am.h"
#include "catalog/pg_class.h"
+#include "catalog/pg_index.h"
+#include "fmgr.h"
#include "rewrite/prs2lock.h"
-#include "access/strat.h"
-
-typedef struct RelationData {
- File rd_fd; /* open file descriptor */
- int rd_nblocks; /* number of blocks in rel */
- uint16 rd_refcnt; /* reference count */
- bool rd_islocal; /* uses the local buffer mgr */
- bool rd_isnailed; /* rel is nailed in cache */
- Form_pg_am rd_am; /* AM tuple */
- Form_pg_class rd_rel; /* RELATION tuple */
- Oid rd_id; /* relations's object id */
- Pointer lockInfo; /* ptr. to misc. info. */
- TupleDesc rd_att; /* tuple desciptor */
- RuleLock *rd_rules; /* rewrite rules */
- IndexStrategy rd_istrat;
- RegProcedure* rd_support;
-} RelationData;
+#include "storage/block.h"
+#include "storage/relfilenode.h"
-typedef RelationData *Relation;
-/* ----------------
- * RelationPtr is used in the executor to support index scans
- * where we have to keep track of several index relations in an
- * array. -cim 9/10/89
- * ----------------
+/*
+ * LockRelId and LockInfo really belong to lmgr.h, but it's more convenient
+ * to declare them here so we can have a LockInfoData field in a Relation.
*/
-typedef Relation *RelationPtr;
-#define InvalidRelation ((Relation)NULL)
+typedef struct LockRelId
+{
+ Oid relId; /* a relation identifier */
+ Oid dbId; /* a database identifier */
+} LockRelId;
-typedef char ArchiveMode;
+typedef struct LockInfoData
+{
+ LockRelId lockRelId;
+} LockInfoData;
+
+typedef LockInfoData *LockInfo;
/*
- * RelationIsValid --
- * True iff relation descriptor is valid.
+ * Likewise, this struct really belongs to trigger.h, but for convenience
+ * we put it here.
*/
-#define RelationIsValid(relation) PointerIsValid(relation)
+typedef struct Trigger
+{
+ Oid tgoid; /* OID of trigger (pg_trigger row) */
+ /* Remaining fields are copied from pg_trigger, see pg_trigger.h */
+ char *tgname;
+ Oid tgfoid;
+ int16 tgtype;
+ bool tgenabled;
+ bool tgisconstraint;
+ Oid tgconstrrelid;
+ bool tgdeferrable;
+ bool tginitdeferred;
+ int16 tgnargs;
+ int16 tgnattr;
+ int16 *tgattr;
+ char **tgargs;
+} Trigger;
+
+typedef struct TriggerDesc
+{
+ /*
+ * Index data to identify which triggers are which. Since each trigger
+ * can appear in more than one class, for each class we provide a list of
+ * integer indexes into the triggers array.
+ */
+#define TRIGGER_NUM_EVENT_CLASSES 3
+
+ uint16 n_before_statement[TRIGGER_NUM_EVENT_CLASSES];
+ uint16 n_before_row[TRIGGER_NUM_EVENT_CLASSES];
+ uint16 n_after_row[TRIGGER_NUM_EVENT_CLASSES];
+ uint16 n_after_statement[TRIGGER_NUM_EVENT_CLASSES];
+ int *tg_before_statement[TRIGGER_NUM_EVENT_CLASSES];
+ int *tg_before_row[TRIGGER_NUM_EVENT_CLASSES];
+ int *tg_after_row[TRIGGER_NUM_EVENT_CLASSES];
+ int *tg_after_statement[TRIGGER_NUM_EVENT_CLASSES];
+
+ /* The actual array of triggers is here */
+ Trigger *triggers;
+ int numtriggers;
+} TriggerDesc;
+
/*
- * RelationGetSystemPort --
- * Returns system port of a relation.
- *
- * Note:
- * Assumes relation descriptor is valid.
+ * Same for the statistics collector data in Relation and scan data.
*/
-#define RelationGetSystemPort(relation) ((relation)->rd_fd)
+typedef struct PgStat_Info
+{
+ void *tabentry;
+} PgStat_Info;
+
/*
- * RelationGetLockInfo --
- * Returns the lock information structure in the reldesc
- *
+ * Cached lookup information for the index access method functions defined
+ * by the pg_am row associated with an index relation.
*/
-#define RelationGetLockInfo(relation) ((relation)->lockInfo)
+typedef struct RelationAmInfo
+{
+ FmgrInfo aminsert;
+ FmgrInfo ambeginscan;
+ FmgrInfo amgettuple;
+ FmgrInfo amgetmulti;
+ FmgrInfo amrescan;
+ FmgrInfo amendscan;
+ FmgrInfo ammarkpos;
+ FmgrInfo amrestrpos;
+ FmgrInfo ambuild;
+ FmgrInfo ambulkdelete;
+ FmgrInfo amvacuumcleanup;
+ FmgrInfo amcostestimate;
+ FmgrInfo amoptions;
+} RelationAmInfo;
+
/*
- * RelationHasReferenceCountZero --
- * True iff relation reference count is zero.
+ * Here are the contents of a relation cache entry.
+ */
+
+typedef struct RelationData
+{
+ RelFileNode rd_node; /* relation physical identifier */
+ /* use "struct" here to avoid needing to include smgr.h: */
+ struct SMgrRelationData *rd_smgr; /* cached file handle, or NULL */
+ BlockNumber rd_targblock; /* current insertion target block, or
+ * InvalidBlockNumber */
+ int rd_refcnt; /* reference count */
+ bool rd_istemp; /* rel uses the local buffer mgr */
+ bool rd_isnailed; /* rel is nailed in cache */
+ bool rd_isvalid; /* relcache entry is valid */
+ char rd_indexvalid; /* state of rd_indexlist: 0 = not valid, 1 =
+ * valid, 2 = temporarily forced */
+ SubTransactionId rd_createSubid; /* rel was created in current xact */
+
+ /*
+ * rd_createSubid is the ID of the highest subtransaction the rel has
+ * survived into; or zero if the rel was not created in the current top
+ * transaction. This should be relied on only for optimization purposes;
+ * it is possible for new-ness to be "forgotten" (eg, after CLUSTER).
+ */
+ Form_pg_class rd_rel; /* RELATION tuple */
+ TupleDesc rd_att; /* tuple descriptor */
+ Oid rd_id; /* relation's object id */
+ List *rd_indexlist; /* list of OIDs of indexes on relation */
+ Oid rd_oidindex; /* OID of unique index on OID, if any */
+ LockInfoData rd_lockInfo; /* lock mgr's info for locking relation */
+ RuleLock *rd_rules; /* rewrite rules */
+ MemoryContext rd_rulescxt; /* private memory cxt for rd_rules, if any */
+ TriggerDesc *trigdesc; /* Trigger info, or NULL if rel has none */
+
+ /*
+ * rd_options is set whenever rd_rel is loaded into the relcache entry.
+ * Note that you can NOT look into rd_rel for this data. NULL means "use
+ * defaults".
+ */
+ bytea *rd_options; /* parsed pg_class.reloptions */
+
+ /* These are non-NULL only for an index relation: */
+ Form_pg_index rd_index; /* pg_index tuple describing this index */
+ struct HeapTupleData *rd_indextuple; /* all of pg_index tuple */
+ /* "struct HeapTupleData *" avoids need to include htup.h here */
+ Form_pg_am rd_am; /* pg_am tuple for index's AM */
+
+ /*
+ * index access support info (used only for an index relation)
+ *
+ * Note: only default operators and support procs for each opclass are
+ * cached, namely those with lefttype and righttype equal to the opclass's
+ * opcintype. The arrays are indexed by strategy or support number,
+ * which is a sufficient identifier given that restriction.
+ *
+ * Note: rd_amcache is available for index AMs to cache private data about
+ * an index. This must be just a cache since it may get reset at any time
+ * (in particular, it will get reset by a relcache inval message for the
+ * index). If used, it must point to a single memory chunk palloc'd in
+ * rd_indexcxt. A relcache reset will include freeing that chunk and
+ * setting rd_amcache = NULL.
+ */
+ MemoryContext rd_indexcxt; /* private memory cxt for this stuff */
+ RelationAmInfo *rd_aminfo; /* lookup info for funcs found in pg_am */
+ Oid *rd_opfamily; /* OIDs of op families for each index col */
+ Oid *rd_opcintype; /* OIDs of opclass declared input data types */
+ Oid *rd_operator; /* OIDs of index operators */
+ RegProcedure *rd_support; /* OIDs of support procedures */
+ FmgrInfo *rd_supportinfo; /* lookup info for support procedures */
+ List *rd_indexprs; /* index expression trees, if any */
+ List *rd_indpred; /* index predicate tree, if any */
+ void *rd_amcache; /* available for use by index AM */
+
+ /* statistics collection area */
+ PgStat_Info pgstat_info;
+} RelationData;
+
+typedef RelationData *Relation;
+
+
+/* ----------------
+ * RelationPtr is used in the executor to support index scans
+ * where we have to keep track of several index relations in an
+ * array. -cim 9/10/89
+ * ----------------
+ */
+typedef Relation *RelationPtr;
+
+
+/*
+ * StdRdOptions
+ * Standard contents of rd_options for heaps and generic indexes.
*
- * Note:
- * Assumes relation descriptor is valid.
+ * RelationGetFillFactor() and RelationGetTargetPageFreeSpace() can only
+ * be applied to relations that use this format or a superset for
+ * private options data.
*/
-#define RelationHasReferenceCountZero(relation) \
- ((bool)((relation)->rd_refcnt == 0))
+typedef struct StdRdOptions
+{
+ int32 vl_len; /* required to be a bytea */
+ int fillfactor; /* page fill factor in percent (0..100) */
+} StdRdOptions;
+
+#define HEAP_MIN_FILLFACTOR 10
+#define HEAP_DEFAULT_FILLFACTOR 100
/*
- * RelationSetReferenceCount --
- * Sets relation reference count.
+ * RelationGetFillFactor
+ * Returns the relation's fillfactor. Note multiple eval of argument!
*/
-#define RelationSetReferenceCount(relation,count) ((relation)->rd_refcnt = count)
+#define RelationGetFillFactor(relation, defaultff) \
+ ((relation)->rd_options ? \
+ ((StdRdOptions *) (relation)->rd_options)->fillfactor : (defaultff))
/*
- * RelationIncrementReferenceCount --
- * Increments relation reference count.
+ * RelationGetTargetPageUsage
+ * Returns the relation's desired space usage per page in bytes.
*/
-#define RelationIncrementReferenceCount(relation) ((relation)->rd_refcnt += 1);
+#define RelationGetTargetPageUsage(relation, defaultff) \
+ (BLCKSZ * RelationGetFillFactor(relation, defaultff) / 100)
/*
- * RelationDecrementReferenceCount --
- * Decrements relation reference count.
+ * RelationGetTargetPageFreeSpace
+ * Returns the relation's desired freespace per page in bytes.
*/
-#define RelationDecrementReferenceCount(relation) ((relation)->rd_refcnt -= 1)
+#define RelationGetTargetPageFreeSpace(relation, defaultff) \
+ (BLCKSZ * (100 - RelationGetFillFactor(relation, defaultff)) / 100)
/*
- * RelationGetAccessMethodTupleForm --
- * Returns access method attribute values for a relation.
+ * RelationIsValid
+ * True iff relation descriptor is valid.
+ */
+#define RelationIsValid(relation) PointerIsValid(relation)
+
+#define InvalidRelation ((Relation) NULL)
+
+/*
+ * RelationHasReferenceCountZero
+ * True iff relation reference count is zero.
*
* Note:
- * Assumes relation descriptor is valid.
+ * Assumes relation descriptor is valid.
*/
-#define RelationGetAccessMethodTupleForm(relation) ((relation)->rd_am)
+#define RelationHasReferenceCountZero(relation) \
+ ((bool)((relation)->rd_refcnt == 0))
/*
- * RelationGetRelationTupleForm --
- * Returns relation attribute values for a relation.
+ * RelationGetForm
+ * Returns pg_class tuple for a relation.
*
* Note:
- * Assumes relation descriptor is valid.
+ * Assumes relation descriptor is valid.
+ */
+#define RelationGetForm(relation) ((relation)->rd_rel)
+
+/*
+ * RelationGetRelid
+ * Returns the OID of the relation
*/
-#define RelationGetRelationTupleForm(relation) ((relation)->rd_rel)
+#define RelationGetRelid(relation) ((relation)->rd_id)
+/*
+ * RelationGetNumberOfAttributes
+ * Returns the number of attributes in a relation.
+ */
+#define RelationGetNumberOfAttributes(relation) ((relation)->rd_rel->relnatts)
-/*
- * RelationGetRelationId --
- *
- * returns the object id of the relation
- *
+/*
+ * RelationGetDescr
+ * Returns tuple descriptor for a relation.
*/
-#define RelationGetRelationId(relation) ((relation)->rd_id)
+#define RelationGetDescr(relation) ((relation)->rd_att)
/*
- * RelationGetFile --
+ * RelationGetRelationName
+ * Returns the rel's name.
*
- * Returns the open File decscriptor
+ * Note that the name is only unique within the containing namespace.
*/
-#define RelationGetFile(relation) ((relation)->rd_fd)
+#define RelationGetRelationName(relation) \
+ (NameStr((relation)->rd_rel->relname))
+/*
+ * RelationGetNamespace
+ * Returns the rel's namespace OID.
+ */
+#define RelationGetNamespace(relation) \
+ ((relation)->rd_rel->relnamespace)
/*
- * RelationGetRelationName --
- *
- * Returns a Relation Name
+ * RelationOpenSmgr
+ * Open the relation at the smgr level, if not already done.
*/
-#define RelationGetRelationName(relation) (&(relation)->rd_rel->relname)
+#define RelationOpenSmgr(relation) \
+ do { \
+ if ((relation)->rd_smgr == NULL) \
+ smgrsetowner(&((relation)->rd_smgr), smgropen((relation)->rd_node)); \
+ } while (0)
/*
- * RelationGetRelationName --
+ * RelationCloseSmgr
+ * Close the relation at the smgr level, if not already done.
*
- * Returns a the number of attributes.
+ * Note: smgrclose should unhook from owner pointer, hence the Assert.
*/
-#define RelationGetNumberOfAttributes(relation) ((relation)->rd_rel->relnatts)
+#define RelationCloseSmgr(relation) \
+ do { \
+ if ((relation)->rd_smgr != NULL) \
+ { \
+ smgrclose((relation)->rd_smgr); \
+ Assert((relation)->rd_smgr == NULL); \
+ } \
+ } while (0)
/*
- * RelationGetTupleDescriptor --
- * Returns tuple descriptor for a relation.
+ * RELATION_IS_LOCAL
+ * If a rel is either temp or newly created in the current transaction,
+ * it can be assumed to be visible only to the current backend.
*
- * Note:
- * Assumes relation descriptor is valid.
+ * Beware of multiple eval of argument
*/
-#define RelationGetTupleDescriptor(relation) ((relation)->rd_att)
+#define RELATION_IS_LOCAL(relation) \
+ ((relation)->rd_istemp || \
+ (relation)->rd_createSubid != InvalidSubTransactionId)
-extern IndexStrategy RelationGetIndexStrategy(Relation relation);
+/* routines in utils/cache/relcache.c */
+extern void RelationIncrementReferenceCount(Relation rel);
+extern void RelationDecrementReferenceCount(Relation rel);
-extern void RelationSetIndexSupport(Relation relation, IndexStrategy strategy,
- RegProcedure *support);
-#endif /* REL_H */
+#endif /* REL_H */
OSDN Git Service
