src/include/utils/rel.h

   1 /*-------------------------------------------------------------------------
   2  *
   3  * rel.h
   4  *        POSTGRES relation descriptor (a/k/a relcache entry) definitions.
   5  *
   6  *
   7  * Portions Copyright (c) 1996-2005, PostgreSQL Global Development Group
   8  * Portions Copyright (c) 1994, Regents of the University of California
   9  *
  10  * $PostgreSQL: pgsql/src/include/utils/rel.h,v 1.86 2005/10/06 02:29:21 tgl Exp $
  11  *
  12  *-------------------------------------------------------------------------
  13  */
  14 #ifndef REL_H
  15 #define REL_H
  16
  17 #include "access/tupdesc.h"
  18 #include "catalog/pg_am.h"
  19 #include "catalog/pg_class.h"
  20 #include "catalog/pg_index.h"
  21 #include "fmgr.h"
  22 #include "rewrite/prs2lock.h"
  23 #include "storage/block.h"
  24 #include "storage/relfilenode.h"
  25
  26
  27 /*
  28  * LockRelId and LockInfo really belong to lmgr.h, but it's more convenient
  29  * to declare them here so we can have a LockInfoData field in a Relation.
  30  */
  31
  32 typedef struct LockRelId
  33 {
  34         Oid                     relId;                  /* a relation identifier */
  35         Oid                     dbId;                   /* a database identifier */
  36 } LockRelId;
  37
  38 typedef struct LockInfoData
  39 {
  40         LockRelId       lockRelId;
  41 } LockInfoData;
  42
  43 typedef LockInfoData *LockInfo;
  44
  45 /*
  46  * Likewise, this struct really belongs to trigger.h, but for convenience
  47  * we put it here.
  48  */
  49 typedef struct Trigger
  50 {
  51         Oid                     tgoid;                  /* OID of trigger (pg_trigger row) */
  52         /* Remaining fields are copied from pg_trigger, see pg_trigger.h */
  53         char       *tgname;
  54         Oid                     tgfoid;
  55         int16           tgtype;
  56         bool            tgenabled;
  57         bool            tgisconstraint;
  58         Oid                     tgconstrrelid;
  59         bool            tgdeferrable;
  60         bool            tginitdeferred;
  61         int16           tgnargs;
  62         int16           tgnattr;
  63         int16      *tgattr;
  64         char      **tgargs;
  65 } Trigger;
  66
  67 typedef struct TriggerDesc
  68 {
  69         /*
  70          * Index data to identify which triggers are which.  Since each
  71          * trigger can appear in more than one class, for each class we
  72          * provide a list of integer indexes into the triggers array.
  73          */
  74 #define TRIGGER_NUM_EVENT_CLASSES  3
  75
  76         uint16          n_before_statement[TRIGGER_NUM_EVENT_CLASSES];
  77         uint16          n_before_row[TRIGGER_NUM_EVENT_CLASSES];
  78         uint16          n_after_row[TRIGGER_NUM_EVENT_CLASSES];
  79         uint16          n_after_statement[TRIGGER_NUM_EVENT_CLASSES];
  80         int                *tg_before_statement[TRIGGER_NUM_EVENT_CLASSES];
  81         int                *tg_before_row[TRIGGER_NUM_EVENT_CLASSES];
  82         int                *tg_after_row[TRIGGER_NUM_EVENT_CLASSES];
  83         int                *tg_after_statement[TRIGGER_NUM_EVENT_CLASSES];
  84
  85         /* The actual array of triggers is here */
  86         Trigger    *triggers;
  87         int                     numtriggers;
  88 } TriggerDesc;
  89
  90
  91 /*
  92  * Same for the statistics collector data in Relation and scan data.
  93  */
  94 typedef struct PgStat_Info
  95 {
  96         void       *tabentry;
  97 } PgStat_Info;
  98
  99
 100 /*
 101  * Cached lookup information for the index access method functions defined
 102  * by the pg_am row associated with an index relation.
 103  */
 104 typedef struct RelationAmInfo
 105 {
 106         FmgrInfo        aminsert;
 107         FmgrInfo        ambeginscan;
 108         FmgrInfo        amgettuple;
 109         FmgrInfo        amgetmulti;
 110         FmgrInfo        amrescan;
 111         FmgrInfo        amendscan;
 112         FmgrInfo        ammarkpos;
 113         FmgrInfo        amrestrpos;
 114         FmgrInfo        ambuild;
 115         FmgrInfo        ambulkdelete;
 116         FmgrInfo        amvacuumcleanup;
 117         FmgrInfo        amcostestimate;
 118 } RelationAmInfo;
 119
 120
 121 /*
 122  * Here are the contents of a relation cache entry.
 123  */
 124
 125 typedef struct RelationData
 126 {
 127         RelFileNode rd_node;            /* relation physical identifier */
 128         /* use "struct" here to avoid needing to include smgr.h: */
 129         struct SMgrRelationData *rd_smgr;       /* cached file handle, or NULL */
 130         BlockNumber rd_targblock;       /* current insertion target block, or
 131                                                                  * InvalidBlockNumber */
 132         int                     rd_refcnt;              /* reference count */
 133         bool            rd_istemp;              /* rel uses the local buffer mgr */
 134         bool            rd_isnailed;    /* rel is nailed in cache */
 135         bool            rd_isvalid;             /* relcache entry is valid */
 136         char            rd_indexvalid;  /* state of rd_indexlist: 0 = not valid,
 137                                                                  * 1 = valid, 2 = temporarily forced */
 138         SubTransactionId rd_createSubid;        /* rel was created in current xact */
 139
 140         /*
 141          * rd_createSubid is the ID of the highest subtransaction the rel has
 142          * survived into; or zero if the rel was not created in the current
 143          * top transaction.  This should be relied on only for optimization
 144          * purposes; it is possible for new-ness to be "forgotten" (eg, after
 145          * CLUSTER).
 146          */
 147         Form_pg_class rd_rel;           /* RELATION tuple */
 148         TupleDesc       rd_att;                 /* tuple descriptor */
 149         Oid                     rd_id;                  /* relation's object id */
 150         List       *rd_indexlist;       /* list of OIDs of indexes on relation */
 151         Oid                     rd_oidindex;    /* OID of unique index on OID, if any */
 152         LockInfoData rd_lockInfo;       /* lock mgr's info for locking relation */
 153         RuleLock   *rd_rules;           /* rewrite rules */
 154         MemoryContext rd_rulescxt;      /* private memory cxt for rd_rules, if any */
 155         TriggerDesc *trigdesc;          /* Trigger info, or NULL if rel has none */
 156
 157         /* These are non-NULL only for an index relation: */
 158         Form_pg_index rd_index;         /* pg_index tuple describing this index */
 159         struct HeapTupleData *rd_indextuple;            /* all of pg_index tuple */
 160         /* "struct HeapTupleData *" avoids need to include htup.h here  */
 161         oidvector  *rd_indclass;        /* extracted pointer to rd_index field */
 162         Form_pg_am      rd_am;                  /* pg_am tuple for index's AM */
 163
 164         /*
 165          * index access support info (used only for an index relation)
 166          *
 167          * Note: only default operators and support procs for each opclass are
 168          * cached, namely those with subtype zero.      The arrays are indexed by
 169          * strategy or support number, which is a sufficient identifier given
 170          * that restriction.
 171          */
 172         MemoryContext rd_indexcxt;      /* private memory cxt for this stuff */
 173         RelationAmInfo *rd_aminfo;      /* lookup info for funcs found in pg_am */
 174         Oid                *rd_operator;        /* OIDs of index operators */
 175         RegProcedure *rd_support;       /* OIDs of support procedures */
 176         FmgrInfo   *rd_supportinfo;     /* lookup info for support procedures */
 177         List       *rd_indexprs;        /* index expression trees, if any */
 178         List       *rd_indpred;         /* index predicate tree, if any */
 179
 180         /* statistics collection area */
 181         PgStat_Info pgstat_info;
 182 } RelationData;
 183
 184 typedef RelationData *Relation;
 185
 186
 187 /* ----------------
 188  *              RelationPtr is used in the executor to support index scans
 189  *              where we have to keep track of several index relations in an
 190  *              array.  -cim 9/10/89
 191  * ----------------
 192  */
 193 typedef Relation *RelationPtr;
 194
 195
 196 /*
 197  * RelationIsValid
 198  *              True iff relation descriptor is valid.
 199  */
 200 #define RelationIsValid(relation) PointerIsValid(relation)
 201
 202 #define InvalidRelation ((Relation) NULL)
 203
 204 /*
 205  * RelationHasReferenceCountZero
 206  *              True iff relation reference count is zero.
 207  *
 208  * Note:
 209  *              Assumes relation descriptor is valid.
 210  */
 211 #define RelationHasReferenceCountZero(relation) \
 212                 ((bool)((relation)->rd_refcnt == 0))
 213
 214 /*
 215  * RelationGetForm
 216  *              Returns pg_class tuple for a relation.
 217  *
 218  * Note:
 219  *              Assumes relation descriptor is valid.
 220  */
 221 #define RelationGetForm(relation) ((relation)->rd_rel)
 222
 223 /*
 224  * RelationGetRelid
 225  *              Returns the OID of the relation
 226  */
 227 #define RelationGetRelid(relation) ((relation)->rd_id)
 228
 229 /*
 230  * RelationGetNumberOfAttributes
 231  *              Returns the number of attributes in a relation.
 232  */
 233 #define RelationGetNumberOfAttributes(relation) ((relation)->rd_rel->relnatts)
 234
 235 /*
 236  * RelationGetDescr
 237  *              Returns tuple descriptor for a relation.
 238  */
 239 #define RelationGetDescr(relation) ((relation)->rd_att)
 240
 241 /*
 242  * RelationGetRelationName
 243  *              Returns the rel's name.
 244  *
 245  * Note that the name is only unique within the containing namespace.
 246  */
 247 #define RelationGetRelationName(relation) \
 248         (NameStr((relation)->rd_rel->relname))
 249
 250 /*
 251  * RelationGetNamespace
 252  *              Returns the rel's namespace OID.
 253  */
 254 #define RelationGetNamespace(relation) \
 255         ((relation)->rd_rel->relnamespace)
 256
 257 /*
 258  * RelationOpenSmgr
 259  *              Open the relation at the smgr level, if not already done.
 260  */
 261 #define RelationOpenSmgr(relation) \
 262         do { \
 263                 if ((relation)->rd_smgr == NULL) \
 264                         smgrsetowner(&((relation)->rd_smgr), smgropen((relation)->rd_node)); \
 265         } while (0)
 266
 267 /*
 268  * RelationCloseSmgr
 269  *              Close the relation at the smgr level, if not already done.
 270  *
 271  * Note: smgrclose should unhook from owner pointer, hence the Assert.
 272  */
 273 #define RelationCloseSmgr(relation) \
 274         do { \
 275                 if ((relation)->rd_smgr != NULL) \
 276                 { \
 277                         smgrclose((relation)->rd_smgr); \
 278                         Assert((relation)->rd_smgr == NULL); \
 279                 } \
 280         } while (0)
 281
 282 /*
 283  * RELATION_IS_LOCAL
 284  *              If a rel is either temp or newly created in the current transaction,
 285  *              it can be assumed to be visible only to the current backend.
 286  *
 287  * Beware of multiple eval of argument
 288  */
 289 #define RELATION_IS_LOCAL(relation) \
 290         ((relation)->rd_istemp || \
 291          (relation)->rd_createSubid != InvalidSubTransactionId)
 292
 293 /* routines in utils/cache/relcache.c */
 294 extern void RelationIncrementReferenceCount(Relation rel);
 295 extern void RelationDecrementReferenceCount(Relation rel);
 296
 297 #endif   /* REL_H */