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-2006, 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.92 2006/10/04 00:30:10 momjian 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 trigger
  71          * can appear in more than one class, for each class we provide a list of
  72          * 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         FmgrInfo        amoptions;
 119 } RelationAmInfo;
 120
 121
 122 /*
 123  * Here are the contents of a relation cache entry.
 124  */
 125
 126 typedef struct RelationData
 127 {
 128         RelFileNode rd_node;            /* relation physical identifier */
 129         /* use "struct" here to avoid needing to include smgr.h: */
 130         struct SMgrRelationData *rd_smgr;       /* cached file handle, or NULL */
 131         BlockNumber rd_targblock;       /* current insertion target block, or
 132                                                                  * InvalidBlockNumber */
 133         int                     rd_refcnt;              /* reference count */
 134         bool            rd_istemp;              /* rel uses the local buffer mgr */
 135         bool            rd_isnailed;    /* rel is nailed in cache */
 136         bool            rd_isvalid;             /* relcache entry is valid */
 137         char            rd_indexvalid;  /* state of rd_indexlist: 0 = not valid, 1 =
 138                                                                  * valid, 2 = temporarily forced */
 139         SubTransactionId rd_createSubid;        /* rel was created in current xact */
 140
 141         /*
 142          * rd_createSubid is the ID of the highest subtransaction the rel has
 143          * survived into; or zero if the rel was not created in the current top
 144          * transaction.  This should be relied on only for optimization purposes;
 145          * it is possible for new-ness to be "forgotten" (eg, after 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         /*
 158          * rd_options is set whenever rd_rel is loaded into the relcache entry.
 159          * Note that you can NOT look into rd_rel for this data.  NULL means "use
 160          * defaults".
 161          */
 162         bytea      *rd_options;         /* parsed pg_class.reloptions */
 163
 164         /* These are non-NULL only for an index relation: */
 165         Form_pg_index rd_index;         /* pg_index tuple describing this index */
 166         struct HeapTupleData *rd_indextuple;            /* all of pg_index tuple */
 167         /* "struct HeapTupleData *" avoids need to include htup.h here  */
 168         oidvector  *rd_indclass;        /* extracted pointer to rd_index field */
 169         Form_pg_am      rd_am;                  /* pg_am tuple for index's AM */
 170
 171         /*
 172          * index access support info (used only for an index relation)
 173          *
 174          * Note: only default operators and support procs for each opclass are
 175          * cached, namely those with subtype zero.      The arrays are indexed by
 176          * strategy or support number, which is a sufficient identifier given that
 177          * restriction.
 178          *
 179          * Note: rd_amcache is available for index AMs to cache private data about
 180          * an index.  This must be just a cache since it may get reset at any time
 181          * (in particular, it will get reset by a relcache inval message for the
 182          * index).      If used, it must point to a single memory chunk palloc'd in
 183          * rd_indexcxt.  A relcache reset will include freeing that chunk and
 184          * setting rd_amcache = NULL.
 185          */
 186         MemoryContext rd_indexcxt;      /* private memory cxt for this stuff */
 187         RelationAmInfo *rd_aminfo;      /* lookup info for funcs found in pg_am */
 188         Oid                *rd_operator;        /* OIDs of index operators */
 189         RegProcedure *rd_support;       /* OIDs of support procedures */
 190         FmgrInfo   *rd_supportinfo; /* lookup info for support procedures */
 191         List       *rd_indexprs;        /* index expression trees, if any */
 192         List       *rd_indpred;         /* index predicate tree, if any */
 193         void       *rd_amcache;         /* available for use by index AM */
 194
 195         /* statistics collection area */
 196         PgStat_Info pgstat_info;
 197 } RelationData;
 198
 199 typedef RelationData *Relation;
 200
 201
 202 /* ----------------
 203  *              RelationPtr is used in the executor to support index scans
 204  *              where we have to keep track of several index relations in an
 205  *              array.  -cim 9/10/89
 206  * ----------------
 207  */
 208 typedef Relation *RelationPtr;
 209
 210
 211 /*
 212  * StdRdOptions
 213  *              Standard contents of rd_options for heaps and generic indexes.
 214  *
 215  * RelationGetFillFactor() and RelationGetTargetPageFreeSpace() can only
 216  * be applied to relations that use this format or a superset for
 217  * private options data.
 218  */
 219 typedef struct StdRdOptions
 220 {
 221         int32           vl_len;                 /* required to be a bytea */
 222         int                     fillfactor;             /* page fill factor in percent (0..100) */
 223 } StdRdOptions;
 224
 225 #define HEAP_MIN_FILLFACTOR                     10
 226 #define HEAP_DEFAULT_FILLFACTOR         100
 227
 228 /*
 229  * RelationGetFillFactor
 230  *              Returns the relation's fillfactor.  Note multiple eval of argument!
 231  */
 232 #define RelationGetFillFactor(relation, defaultff) \
 233         ((relation)->rd_options ? \
 234          ((StdRdOptions *) (relation)->rd_options)->fillfactor : (defaultff))
 235
 236 /*
 237  * RelationGetTargetPageUsage
 238  *              Returns the relation's desired space usage per page in bytes.
 239  */
 240 #define RelationGetTargetPageUsage(relation, defaultff) \
 241         (BLCKSZ * RelationGetFillFactor(relation, defaultff) / 100)
 242
 243 /*
 244  * RelationGetTargetPageFreeSpace
 245  *              Returns the relation's desired freespace per page in bytes.
 246  */
 247 #define RelationGetTargetPageFreeSpace(relation, defaultff) \
 248         (BLCKSZ * (100 - RelationGetFillFactor(relation, defaultff)) / 100)
 249
 250 /*
 251  * RelationIsValid
 252  *              True iff relation descriptor is valid.
 253  */
 254 #define RelationIsValid(relation) PointerIsValid(relation)
 255
 256 #define InvalidRelation ((Relation) NULL)
 257
 258 /*
 259  * RelationHasReferenceCountZero
 260  *              True iff relation reference count is zero.
 261  *
 262  * Note:
 263  *              Assumes relation descriptor is valid.
 264  */
 265 #define RelationHasReferenceCountZero(relation) \
 266                 ((bool)((relation)->rd_refcnt == 0))
 267
 268 /*
 269  * RelationGetForm
 270  *              Returns pg_class tuple for a relation.
 271  *
 272  * Note:
 273  *              Assumes relation descriptor is valid.
 274  */
 275 #define RelationGetForm(relation) ((relation)->rd_rel)
 276
 277 /*
 278  * RelationGetRelid
 279  *              Returns the OID of the relation
 280  */
 281 #define RelationGetRelid(relation) ((relation)->rd_id)
 282
 283 /*
 284  * RelationGetNumberOfAttributes
 285  *              Returns the number of attributes in a relation.
 286  */
 287 #define RelationGetNumberOfAttributes(relation) ((relation)->rd_rel->relnatts)
 288
 289 /*
 290  * RelationGetDescr
 291  *              Returns tuple descriptor for a relation.
 292  */
 293 #define RelationGetDescr(relation) ((relation)->rd_att)
 294
 295 /*
 296  * RelationGetRelationName
 297  *              Returns the rel's name.
 298  *
 299  * Note that the name is only unique within the containing namespace.
 300  */
 301 #define RelationGetRelationName(relation) \
 302         (NameStr((relation)->rd_rel->relname))
 303
 304 /*
 305  * RelationGetNamespace
 306  *              Returns the rel's namespace OID.
 307  */
 308 #define RelationGetNamespace(relation) \
 309         ((relation)->rd_rel->relnamespace)
 310
 311 /*
 312  * RelationOpenSmgr
 313  *              Open the relation at the smgr level, if not already done.
 314  */
 315 #define RelationOpenSmgr(relation) \
 316         do { \
 317                 if ((relation)->rd_smgr == NULL) \
 318                         smgrsetowner(&((relation)->rd_smgr), smgropen((relation)->rd_node)); \
 319         } while (0)
 320
 321 /*
 322  * RelationCloseSmgr
 323  *              Close the relation at the smgr level, if not already done.
 324  *
 325  * Note: smgrclose should unhook from owner pointer, hence the Assert.
 326  */
 327 #define RelationCloseSmgr(relation) \
 328         do { \
 329                 if ((relation)->rd_smgr != NULL) \
 330                 { \
 331                         smgrclose((relation)->rd_smgr); \
 332                         Assert((relation)->rd_smgr == NULL); \
 333                 } \
 334         } while (0)
 335
 336 /*
 337  * RELATION_IS_LOCAL
 338  *              If a rel is either temp or newly created in the current transaction,
 339  *              it can be assumed to be visible only to the current backend.
 340  *
 341  * Beware of multiple eval of argument
 342  */
 343 #define RELATION_IS_LOCAL(relation) \
 344         ((relation)->rd_istemp || \
 345          (relation)->rd_createSubid != InvalidSubTransactionId)
 346
 347 /* routines in utils/cache/relcache.c */
 348 extern void RelationIncrementReferenceCount(Relation rel);
 349 extern void RelationDecrementReferenceCount(Relation rel);
 350
 351 #endif   /* REL_H */