granicus.if.org Git - postgresql/blob - src/include/executor/hashjoin.h

   1 /*-------------------------------------------------------------------------
   2  *
   3  * hashjoin.h
   4  *        internal structures for hash joins
   5  *
   6  *
   7  * Portions Copyright (c) 1996-2009, PostgreSQL Global Development Group
   8  * Portions Copyright (c) 1994, Regents of the University of California
   9  *
  10  * $PostgreSQL: pgsql/src/include/executor/hashjoin.h,v 1.49 2009/01/01 17:23:59 momjian Exp $
  11  *
  12  *-------------------------------------------------------------------------
  13  */
  14 #ifndef HASHJOIN_H
  15 #define HASHJOIN_H
  16
  17 #include "fmgr.h"
  18 #include "storage/buffile.h"
  19
  20 /* ----------------------------------------------------------------
  21  *                              hash-join hash table structures
  22  *
  23  * Each active hashjoin has a HashJoinTable control block, which is
  24  * palloc'd in the executor's per-query context.  All other storage needed
  25  * for the hashjoin is kept in private memory contexts, two for each hashjoin.
  26  * This makes it easy and fast to release the storage when we don't need it
  27  * anymore.  (Exception: data associated with the temp files lives in the
  28  * per-query context too, since we always call buffile.c in that context.)
  29  *
  30  * The hashtable contexts are made children of the per-query context, ensuring
  31  * that they will be discarded at end of statement even if the join is
  32  * aborted early by an error.  (Likewise, any temporary files we make will
  33  * be cleaned up by the virtual file manager in event of an error.)
  34  *
  35  * Storage that should live through the entire join is allocated from the
  36  * "hashCxt", while storage that is only wanted for the current batch is
  37  * allocated in the "batchCxt".  By resetting the batchCxt at the end of
  38  * each batch, we free all the per-batch storage reliably and without tedium.
  39  *
  40  * During first scan of inner relation, we get its tuples from executor.
  41  * If nbatch > 1 then tuples that don't belong in first batch get saved
  42  * into inner-batch temp files. The same statements apply for the
  43  * first scan of the outer relation, except we write tuples to outer-batch
  44  * temp files.  After finishing the first scan, we do the following for
  45  * each remaining batch:
  46  *      1. Read tuples from inner batch file, load into hash buckets.
  47  *      2. Read tuples from outer batch file, match to hash buckets and output.
  48  *
  49  * It is possible to increase nbatch on the fly if the in-memory hash table
  50  * gets too big.  The hash-value-to-batch computation is arranged so that this
  51  * can only cause a tuple to go into a later batch than previously thought,
  52  * never into an earlier batch.  When we increase nbatch, we rescan the hash
  53  * table and dump out any tuples that are now of a later batch to the correct
  54  * inner batch file.  Subsequently, while reading either inner or outer batch
  55  * files, we might find tuples that no longer belong to the current batch;
  56  * if so, we just dump them out to the correct batch file.
  57  * ----------------------------------------------------------------
  58  */
  59
  60 /* these are in nodes/execnodes.h: */
  61 /* typedef struct HashJoinTupleData *HashJoinTuple; */
  62 /* typedef struct HashJoinTableData *HashJoinTable; */
  63
  64 typedef struct HashJoinTupleData
  65 {
  66         struct HashJoinTupleData *next;         /* link to next tuple in same bucket */
  67         uint32          hashvalue;              /* tuple's hash code */
  68         /* Tuple data, in MinimalTuple format, follows on a MAXALIGN boundary */
  69 } HashJoinTupleData;
  70
  71 #define HJTUPLE_OVERHEAD  MAXALIGN(sizeof(HashJoinTupleData))
  72 #define HJTUPLE_MINTUPLE(hjtup)  \
  73         ((MinimalTuple) ((char *) (hjtup) + HJTUPLE_OVERHEAD))
  74
  75
  76 typedef struct HashJoinTableData
  77 {
  78         int                     nbuckets;               /* # buckets in the in-memory hash table */
  79         int                     log2_nbuckets;  /* its log2 (nbuckets must be a power of 2) */
  80
  81         /* buckets[i] is head of list of tuples in i'th in-memory bucket */
  82         struct HashJoinTupleData **buckets;
  83         /* buckets array is per-batch storage, as are all the tuples */
  84
  85         int                     nbatch;                 /* number of batches */
  86         int                     curbatch;               /* current batch #; 0 during 1st pass */
  87
  88         int                     nbatch_original;        /* nbatch when we started inner scan */
  89         int                     nbatch_outstart;        /* nbatch when we started outer scan */
  90
  91         bool            growEnabled;    /* flag to shut off nbatch increases */
  92
  93         double          totalTuples;    /* # tuples obtained from inner plan */
  94
  95         /*
  96          * These arrays are allocated for the life of the hash join, but only if
  97          * nbatch > 1.  A file is opened only when we first write a tuple into it
  98          * (otherwise its pointer remains NULL).  Note that the zero'th array
  99          * elements never get used, since we will process rather than dump out any
 100          * tuples of batch zero.
 101          */
 102         BufFile   **innerBatchFile; /* buffered virtual temp file per batch */
 103         BufFile   **outerBatchFile; /* buffered virtual temp file per batch */
 104
 105         /*
 106          * Info about the datatype-specific hash functions for the datatypes being
 107          * hashed. These are arrays of the same length as the number of hash join
 108          * clauses (hash keys).
 109          */
 110         FmgrInfo   *outer_hashfunctions;        /* lookup data for hash functions */
 111         FmgrInfo   *inner_hashfunctions;        /* lookup data for hash functions */
 112         bool       *hashStrict;         /* is each hash join operator strict? */
 113
 114         Size            spaceUsed;              /* memory space currently used by tuples */
 115         Size            spaceAllowed;   /* upper limit for space used */
 116
 117         MemoryContext hashCxt;          /* context for whole-hash-join storage */
 118         MemoryContext batchCxt;         /* context for this-batch-only storage */
 119 } HashJoinTableData;
 120
 121 #endif   /* HASHJOIN_H */