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-2001, PostgreSQL Global Development Group
   8  * Portions Copyright (c) 1994, Regents of the University of California
   9  *
  10  * $Id: rel.h,v 1.59 2002/04/01 22:36:13 tgl Exp $
  11  *
  12  *-------------------------------------------------------------------------
  13  */
  14 #ifndef REL_H
  15 #define REL_H
  16
  17 #include "access/strat.h"
  18 #include "access/tupdesc.h"
  19 #include "catalog/pg_am.h"
  20 #include "catalog/pg_class.h"
  21 #include "catalog/pg_index.h"
  22 #include "rewrite/prs2lock.h"
  23 #include "storage/block.h"
  24 #include "storage/fd.h"
  25 #include "storage/relfilenode.h"
  26
  27
  28 /*
  29  * LockRelId and LockInfo really belong to lmgr.h, but it's more convenient
  30  * to declare them here so we can have a LockInfoData field in a Relation.
  31  */
  32
  33 typedef struct LockRelId
  34 {
  35         Oid                     relId;                  /* a relation identifier */
  36         Oid                     dbId;                   /* a database identifier */
  37 } LockRelId;
  38
  39 typedef struct LockInfoData
  40 {
  41         LockRelId       lockRelId;
  42 } LockInfoData;
  43
  44 typedef LockInfoData *LockInfo;
  45
  46 /*
  47  * Likewise, this struct really belongs to trigger.h, but for convenience
  48  * we put it here.
  49  */
  50 typedef struct Trigger
  51 {
  52         Oid                     tgoid;                  /* OID of trigger (pg_trigger row) */
  53         /* Remaining fields are copied from pg_trigger, see pg_trigger.h */
  54         char       *tgname;
  55         Oid                     tgfoid;
  56         int16           tgtype;
  57         bool            tgenabled;
  58         bool            tgisconstraint;
  59         Oid                     tgconstrrelid;
  60         bool            tgdeferrable;
  61         bool            tginitdeferred;
  62         int16           tgnargs;
  63         int16           tgattr[FUNC_MAX_ARGS];
  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  4
  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  */
  95 typedef struct PgStat_Info
  96 {
  97         void       *tabentry;
  98         bool            no_stats;
  99         bool            heap_scan_counted;
 100         bool            index_scan_counted;
 101 } PgStat_Info;
 102
 103 /*
 104  * Here are the contents of a relation cache entry.
 105  */
 106
 107 typedef struct RelationData
 108 {
 109         File            rd_fd;                  /* open file descriptor, or -1 if none */
 110         RelFileNode rd_node;            /* file node (physical identifier) */
 111         BlockNumber rd_nblocks;         /* number of blocks in rel */
 112         BlockNumber rd_targblock;       /* current insertion target block, or
 113                                                                  * InvalidBlockNumber */
 114         int                     rd_refcnt;              /* reference count */
 115         bool            rd_myxactonly;  /* rel uses the local buffer mgr */
 116         bool            rd_isnailed;    /* rel is nailed in cache */
 117         bool            rd_indexfound;  /* true if rd_indexlist is valid */
 118         bool            rd_uniqueindex; /* true if rel is a UNIQUE index */
 119         Form_pg_class rd_rel;           /* RELATION tuple */
 120         TupleDesc       rd_att;                 /* tuple descriptor */
 121         Oid                     rd_id;                  /* relation's object id */
 122         List       *rd_indexlist;       /* list of OIDs of indexes on relation */
 123         LockInfoData rd_lockInfo;       /* lock mgr's info for locking relation */
 124         RuleLock   *rd_rules;           /* rewrite rules */
 125         MemoryContext rd_rulescxt;      /* private memory cxt for rd_rules, if any */
 126         TriggerDesc *trigdesc;          /* Trigger info, or NULL if rel has none */
 127
 128         /* These are non-NULL only for an index relation: */
 129         Form_pg_index rd_index;         /* pg_index tuple describing this index */
 130         Form_pg_am      rd_am;                  /* pg_am tuple for index's AM */
 131
 132         /* index access support info (used only for an index relation) */
 133         MemoryContext rd_indexcxt;      /* private memory cxt for this stuff */
 134         IndexStrategy rd_istrat;        /* operator strategy map */
 135         Oid                *rd_operator;        /* OIDs of index operators */
 136         RegProcedure *rd_support;       /* OIDs of support procedures */
 137         struct FmgrInfo *rd_supportinfo;        /* lookup info for support
 138                                                                                  * procedures */
 139         /* "struct FmgrInfo" avoids need to include fmgr.h here */
 140
 141         /* statistics collection area */
 142         PgStat_Info pgstat_info;
 143 } RelationData;
 144
 145 typedef RelationData *Relation;
 146
 147
 148 /* ----------------
 149  *              RelationPtr is used in the executor to support index scans
 150  *              where we have to keep track of several index relations in an
 151  *              array.  -cim 9/10/89
 152  * ----------------
 153  */
 154 typedef Relation *RelationPtr;
 155
 156
 157 /*
 158  * RelationIsValid
 159  *              True iff relation descriptor is valid.
 160  */
 161 #define RelationIsValid(relation) PointerIsValid(relation)
 162
 163 #define InvalidRelation ((Relation) NULL)
 164
 165 /*
 166  * RelationHasReferenceCountZero
 167  *              True iff relation reference count is zero.
 168  *
 169  * Note:
 170  *              Assumes relation descriptor is valid.
 171  */
 172 #define RelationHasReferenceCountZero(relation) \
 173                 ((bool)((relation)->rd_refcnt == 0))
 174
 175 /*
 176  * RelationSetReferenceCount
 177  *              Sets relation reference count.
 178  */
 179 #define RelationSetReferenceCount(relation,count) \
 180         ((relation)->rd_refcnt = (count))
 181
 182 /*
 183  * RelationIncrementReferenceCount
 184  *              Increments relation reference count.
 185  */
 186 #define RelationIncrementReferenceCount(relation) \
 187         ((relation)->rd_refcnt += 1)
 188
 189 /*
 190  * RelationDecrementReferenceCount
 191  *              Decrements relation reference count.
 192  */
 193 #define RelationDecrementReferenceCount(relation) \
 194         (AssertMacro((relation)->rd_refcnt > 0), \
 195          (relation)->rd_refcnt -= 1)
 196
 197 /*
 198  * RelationGetForm
 199  *              Returns pg_class tuple for a relation.
 200  *
 201  * Note:
 202  *              Assumes relation descriptor is valid.
 203  */
 204 #define RelationGetForm(relation) ((relation)->rd_rel)
 205
 206 /*
 207  * RelationGetRelid
 208  *
 209  *      returns the OID of the relation
 210  */
 211 #define RelationGetRelid(relation) ((relation)->rd_id)
 212
 213 /*
 214  * RelationGetFile
 215  *
 216  *        Returns the open file descriptor for the rel
 217  */
 218 #define RelationGetFile(relation) ((relation)->rd_fd)
 219
 220 /*
 221  * RelationGetNumberOfAttributes
 222  *
 223  *        Returns the number of attributes.
 224  */
 225 #define RelationGetNumberOfAttributes(relation) ((relation)->rd_rel->relnatts)
 226
 227 /*
 228  * RelationGetDescr
 229  *              Returns tuple descriptor for a relation.
 230  */
 231 #define RelationGetDescr(relation) ((relation)->rd_att)
 232
 233 /*
 234  * RelationGetIndexStrategy
 235  *              Returns index strategy for a relation.
 236  *
 237  * Note:
 238  *              Assumes relation descriptor is valid.
 239  *              Assumes relation descriptor is for an index relation.
 240  */
 241 #define RelationGetIndexStrategy(relation) ((relation)->rd_istrat)
 242
 243 /*
 244  * RelationGetRelationName
 245  *
 246  *        Returns the rel's name.
 247  *
 248  * Note that the name is only unique within the containing namespace.
 249  */
 250 #define RelationGetRelationName(relation) \
 251         (NameStr((relation)->rd_rel->relname))
 252
 253 /*
 254  * RelationGetNamespace
 255  *
 256  *        Returns the rel's namespace OID.
 257  */
 258 #define RelationGetNamespace(relation) \
 259         ((relation)->rd_rel->relnamespace)
 260
 261 #endif   /* REL_H */