pg_query 4.2.1 → 6.1.0

data/ext/pg_query/src_backend_utils_hash_dynahash.c

@@ -1,1116 +0,0 @@
-/*--------------------------------------------------------------------
- * Symbols referenced in this file:
- * - hash_search
- * - hash_search_with_hash_value
- * - has_seq_scans
- * - num_seq_scans
- * - seq_scan_tables
- * - expand_table
- * - dir_realloc
- * - CurrentDynaHashCxt
- * - seg_alloc
- * - calc_bucket
- * - hash_corrupted
- * - DynaHashAlloc
- * - get_hash_entry
- * - element_alloc
- *--------------------------------------------------------------------
- */
-
-/*-------------------------------------------------------------------------
- *
- * dynahash.c
- *	  dynamic chained hash tables
- *
- * dynahash.c supports both local-to-a-backend hash tables and hash tables in
- * shared memory.  For shared hash tables, it is the caller's responsibility
- * to provide appropriate access interlocking.  The simplest convention is
- * that a single LWLock protects the whole hash table.  Searches (HASH_FIND or
- * hash_seq_search) need only shared lock, but any update requires exclusive
- * lock.  For heavily-used shared tables, the single-lock approach creates a
- * concurrency bottleneck, so we also support "partitioned" locking wherein
- * there are multiple LWLocks guarding distinct subsets of the table.  To use
- * a hash table in partitioned mode, the HASH_PARTITION flag must be given
- * to hash_create.  This prevents any attempt to split buckets on-the-fly.
- * Therefore, each hash bucket chain operates independently, and no fields
- * of the hash header change after init except nentries and freeList.
- * (A partitioned table uses multiple copies of those fields, guarded by
- * spinlocks, for additional concurrency.)
- * This lets any subset of the hash buckets be treated as a separately
- * lockable partition.  We expect callers to use the low-order bits of a
- * lookup key's hash value as a partition number --- this will work because
- * of the way calc_bucket() maps hash values to bucket numbers.
- *
- * For hash tables in shared memory, the memory allocator function should
- * match malloc's semantics of returning NULL on failure.  For hash tables
- * in local memory, we typically use palloc() which will throw error on
- * failure.  The code in this file has to cope with both cases.
- *
- * dynahash.c provides support for these types of lookup keys:
- *
- * 1. Null-terminated C strings (truncated if necessary to fit in keysize),
- * compared as though by strcmp().  This is selected by specifying the
- * HASH_STRINGS flag to hash_create.
- *
- * 2. Arbitrary binary data of size keysize, compared as though by memcmp().
- * (Caller must ensure there are no undefined padding bits in the keys!)
- * This is selected by specifying the HASH_BLOBS flag to hash_create.
- *
- * 3. More complex key behavior can be selected by specifying user-supplied
- * hashing, comparison, and/or key-copying functions.  At least a hashing
- * function must be supplied; comparison defaults to memcmp() and key copying
- * to memcpy() when a user-defined hashing function is selected.
- *
- * Compared to simplehash, dynahash has the following benefits:
- *
- * - It supports partitioning, which is useful for shared memory access using
- *   locks.
- * - Shared memory hashes are allocated in a fixed size area at startup and
- *   are discoverable by name from other processes.
- * - Because entries don't need to be moved in the case of hash conflicts,
- *   dynahash has better performance for large entries.
- * - Guarantees stable pointers to entries.
- *
- * Portions Copyright (c) 1996-2022, PostgreSQL Global Development Group
- * Portions Copyright (c) 1994, Regents of the University of California
- *
- *
- * IDENTIFICATION
- *	  src/backend/utils/hash/dynahash.c
- *
- *-------------------------------------------------------------------------
- */
-
-/*
- * Original comments:
- *
- * Dynamic hashing, after CACM April 1988 pp 446-457, by Per-Ake Larson.
- * Coded into C, with minor code improvements, and with hsearch(3) interface,
- * by ejp@ausmelb.oz, Jul 26, 1988: 13:16;
- * also, hcreate/hdestroy routines added to simulate hsearch(3).
- *
- * These routines simulate hsearch(3) and family, with the important
- * difference that the hash table is dynamic - can grow indefinitely
- * beyond its original size (as supplied to hcreate()).
- *
- * Performance appears to be comparable to that of hsearch(3).
- * The 'source-code' options referred to in hsearch(3)'s 'man' page
- * are not implemented; otherwise functionality is identical.
- *
- * Compilation controls:
- * HASH_DEBUG controls some informative traces, mainly for debugging.
- * HASH_STATISTICS causes HashAccesses and HashCollisions to be maintained;
- * when combined with HASH_DEBUG, these are displayed by hdestroy().
- *
- * Problems & fixes to ejp@ausmelb.oz. WARNING: relies on pre-processor
- * concatenation property, in probably unnecessary code 'optimization'.
- *
- * Modified margo@postgres.berkeley.edu February 1990
- *		added multiple table interface
- * Modified by sullivan@postgres.berkeley.edu April 1990
- *		changed ctl structure for shared memory
- */
-
-#include "postgres.h"
-
-#include <limits.h>
-
-#include "access/xact.h"
-#include "common/hashfn.h"
-#include "port/pg_bitutils.h"
-#include "storage/shmem.h"
-#include "storage/spin.h"
-#include "utils/dynahash.h"
-#include "utils/memutils.h"
-
-
-/*
- * Constants
- *
- * A hash table has a top-level "directory", each of whose entries points
- * to a "segment" of ssize bucket headers.  The maximum number of hash
- * buckets is thus dsize * ssize (but dsize may be expansible).  Of course,
- * the number of records in the table can be larger, but we don't want a
- * whole lot of records per bucket or performance goes down.
- *
- * In a hash table allocated in shared memory, the directory cannot be
- * expanded because it must stay at a fixed address.  The directory size
- * should be selected using hash_select_dirsize (and you'd better have
- * a good idea of the maximum number of entries!).  For non-shared hash
- * tables, the initial directory size can be left at the default.
- */
-#define DEF_SEGSIZE			   256
-#define DEF_SEGSIZE_SHIFT	   8	/* must be log2(DEF_SEGSIZE) */
-#define DEF_DIRSIZE			   256
-
-/* Number of freelists to be used for a partitioned hash table. */
-#define NUM_FREELISTS			32
-
-/* A hash bucket is a linked list of HASHELEMENTs */
-typedef HASHELEMENT *HASHBUCKET;
-
-/* A hash segment is an array of bucket headers */
-typedef HASHBUCKET *HASHSEGMENT;
-
-/*
- * Per-freelist data.
- *
- * In a partitioned hash table, each freelist is associated with a specific
- * set of hashcodes, as determined by the FREELIST_IDX() macro below.
- * nentries tracks the number of live hashtable entries having those hashcodes
- * (NOT the number of entries in the freelist, as you might expect).
- *
- * The coverage of a freelist might be more or less than one partition, so it
- * needs its own lock rather than relying on caller locking.  Relying on that
- * wouldn't work even if the coverage was the same, because of the occasional
- * need to "borrow" entries from another freelist; see get_hash_entry().
- *
- * Using an array of FreeListData instead of separate arrays of mutexes,
- * nentries and freeLists helps to reduce sharing of cache lines between
- * different mutexes.
- */
-typedef struct
-{
-	slock_t		mutex;			/* spinlock for this freelist */
-	long		nentries;		/* number of entries in associated buckets */
-	HASHELEMENT *freeList;		/* chain of free elements */
-} FreeListData;
-
-/*
- * Header structure for a hash table --- contains all changeable info
- *
- * In a shared-memory hash table, the HASHHDR is in shared memory, while
- * each backend has a local HTAB struct.  For a non-shared table, there isn't
- * any functional difference between HASHHDR and HTAB, but we separate them
- * anyway to share code between shared and non-shared tables.
- */
-struct HASHHDR
-{
-	/*
-	 * The freelist can become a point of contention in high-concurrency hash
-	 * tables, so we use an array of freelists, each with its own mutex and
-	 * nentries count, instead of just a single one.  Although the freelists
-	 * normally operate independently, we will scavenge entries from freelists
-	 * other than a hashcode's default freelist when necessary.
-	 *
-	 * If the hash table is not partitioned, only freeList[0] is used and its
-	 * spinlock is not used at all; callers' locking is assumed sufficient.
-	 */
-	FreeListData freeList[NUM_FREELISTS];
-
-	/* These fields can change, but not in a partitioned table */
-	/* Also, dsize can't change in a shared table, even if unpartitioned */
-	long		dsize;			/* directory size */
-	long		nsegs;			/* number of allocated segments (<= dsize) */
-	uint32		max_bucket;		/* ID of maximum bucket in use */
-	uint32		high_mask;		/* mask to modulo into entire table */
-	uint32		low_mask;		/* mask to modulo into lower half of table */
-
-	/* These fields are fixed at hashtable creation */
-	Size		keysize;		/* hash key length in bytes */
-	Size		entrysize;		/* total user element size in bytes */
-	long		num_partitions; /* # partitions (must be power of 2), or 0 */
-	long		max_dsize;		/* 'dsize' limit if directory is fixed size */
-	long		ssize;			/* segment size --- must be power of 2 */
-	int			sshift;			/* segment shift = log2(ssize) */
-	int			nelem_alloc;	/* number of entries to allocate at once */
-
-#ifdef HASH_STATISTICS
-
-	/*
-	 * Count statistics here.  NB: stats code doesn't bother with mutex, so
-	 * counts could be corrupted a bit in a partitioned table.
-	 */
-	long		accesses;
-	long		collisions;
-#endif
-};
-
-#define IS_PARTITIONED(hctl)  ((hctl)->num_partitions != 0)
-
-#define FREELIST_IDX(hctl, hashcode) \
-	(IS_PARTITIONED(hctl) ? (hashcode) % NUM_FREELISTS : 0)
-
-/*
- * Top control structure for a hashtable --- in a shared table, each backend
- * has its own copy (OK since no fields change at runtime)
- */
-struct HTAB
-{
-	HASHHDR    *hctl;			/* => shared control information */
-	HASHSEGMENT *dir;			/* directory of segment starts */
-	HashValueFunc hash;			/* hash function */
-	HashCompareFunc match;		/* key comparison function */
-	HashCopyFunc keycopy;		/* key copying function */
-	HashAllocFunc alloc;		/* memory allocator */
-	MemoryContext hcxt;			/* memory context if default allocator used */
-	char	   *tabname;		/* table name (for error messages) */
-	bool		isshared;		/* true if table is in shared memory */
-	bool		isfixed;		/* if true, don't enlarge */
-
-	/* freezing a shared table isn't allowed, so we can keep state here */
-	bool		frozen;			/* true = no more inserts allowed */
-
-	/* We keep local copies of these fixed values to reduce contention */
-	Size		keysize;		/* hash key length in bytes */
-	long		ssize;			/* segment size --- must be power of 2 */
-	int			sshift;			/* segment shift = log2(ssize) */
-};
-
-/*
- * Key (also entry) part of a HASHELEMENT
- */
-#define ELEMENTKEY(helem)  (((char *)(helem)) + MAXALIGN(sizeof(HASHELEMENT)))
-
-/*
- * Obtain element pointer given pointer to key
- */
-#define ELEMENT_FROM_KEY(key)  \
-	((HASHELEMENT *) (((char *) (key)) - MAXALIGN(sizeof(HASHELEMENT))))
-
-/*
- * Fast MOD arithmetic, assuming that y is a power of 2 !
- */
-#define MOD(x,y)			   ((x) & ((y)-1))
-
-#ifdef HASH_STATISTICS
-static long hash_accesses,
-			hash_collisions,
-			hash_expansions;
-#endif
-
-/*
- * Private function prototypes
- */
-static void *DynaHashAlloc(Size size);
-static HASHSEGMENT seg_alloc(HTAB *hashp);
-static bool element_alloc(HTAB *hashp, int nelem, int freelist_idx);
-static bool dir_realloc(HTAB *hashp);
-static bool expand_table(HTAB *hashp);
-static HASHBUCKET get_hash_entry(HTAB *hashp, int freelist_idx);
-static void hdefault(HTAB *hashp);
-static int	choose_nelem_alloc(Size entrysize);
-static bool init_htab(HTAB *hashp, long nelem);
-static void hash_corrupted(HTAB *hashp);
-static long next_pow2_long(long num);
-static int	next_pow2_int(long num);
-static void register_seq_scan(HTAB *hashp);
-static void deregister_seq_scan(HTAB *hashp);
-static bool has_seq_scans(HTAB *hashp);
-
-
-/*
- * memory allocation support
- */
-static __thread MemoryContext CurrentDynaHashCxt = NULL;
-
-
-static void *
-DynaHashAlloc(Size size)
-{
-	Assert(MemoryContextIsValid(CurrentDynaHashCxt));
-	return MemoryContextAlloc(CurrentDynaHashCxt, size);
-}
-
-
-/*
- * HashCompareFunc for string keys
- *
- * Because we copy keys with strlcpy(), they will be truncated at keysize-1
- * bytes, so we can only compare that many ... hence strncmp is almost but
- * not quite the right thing.
- */
-
-
-
-/************************** CREATE ROUTINES **********************/
-
-/*
- * hash_create -- create a new dynamic hash table
- *
- *	tabname: a name for the table (for debugging purposes)
- *	nelem: maximum number of elements expected
- *	*info: additional table parameters, as indicated by flags
- *	flags: bitmask indicating which parameters to take from *info
- *
- * The flags value *must* include HASH_ELEM.  (Formerly, this was nominally
- * optional, but the default keysize and entrysize values were useless.)
- * The flags value must also include exactly one of HASH_STRINGS, HASH_BLOBS,
- * or HASH_FUNCTION, to define the key hashing semantics (C strings,
- * binary blobs, or custom, respectively).  Callers specifying a custom
- * hash function will likely also want to use HASH_COMPARE, and perhaps
- * also HASH_KEYCOPY, to control key comparison and copying.
- * Another often-used flag is HASH_CONTEXT, to allocate the hash table
- * under info->hcxt rather than under TopMemoryContext; the default
- * behavior is only suitable for session-lifespan hash tables.
- * Other flags bits are special-purpose and seldom used, except for those
- * associated with shared-memory hash tables, for which see ShmemInitHash().
- *
- * Fields in *info are read only when the associated flags bit is set.
- * It is not necessary to initialize other fields of *info.
- * Neither tabname nor *info need persist after the hash_create() call.
- *
- * Note: It is deprecated for callers of hash_create() to explicitly specify
- * string_hash, tag_hash, uint32_hash, or oid_hash.  Just set HASH_STRINGS or
- * HASH_BLOBS.  Use HASH_FUNCTION only when you want something other than
- * one of these.
- *
- * Note: for a shared-memory hashtable, nelem needs to be a pretty good
- * estimate, since we can't expand the table on the fly.  But an unshared
- * hashtable can be expanded on-the-fly, so it's better for nelem to be
- * on the small side and let the table grow if it's exceeded.  An overly
- * large nelem will penalize hash_seq_search speed without buying much.
- */
-
-
-/*
- * Set default HASHHDR parameters.
- */
-#ifdef HASH_STATISTICS
-#endif
-
-/*
- * Given the user-specified entry size, choose nelem_alloc, ie, how many
- * elements to add to the hash table when we need more.
- */
-
-
-/*
- * Compute derived fields of hctl and build the initial directory/segment
- * arrays
- */
-#ifdef HASH_DEBUG
-#endif
-
-/*
- * Estimate the space needed for a hashtable containing the given number
- * of entries of given size.
- * NOTE: this is used to estimate the footprint of hashtables in shared
- * memory; therefore it does not count HTAB which is in local memory.
- * NB: assumes that all hash structure parameters have default values!
- */
-
-
-/*
- * Select an appropriate directory size for a hashtable with the given
- * maximum number of entries.
- * This is only needed for hashtables in shared memory, whose directories
- * cannot be expanded dynamically.
- * NB: assumes that all hash structure parameters have default values!
- *
- * XXX this had better agree with the behavior of init_htab()...
- */
-
-
-/*
- * Compute the required initial memory allocation for a shared-memory
- * hashtable with the given parameters.  We need space for the HASHHDR
- * and for the (non expansible) directory.
- */
-
-
-
-/********************** DESTROY ROUTINES ************************/
-
-
-
-#ifdef HASH_STATISTICS
-#endif
-
-/*******************************SEARCH ROUTINES *****************************/
-
-
-/*
- * get_hash_value -- exported routine to calculate a key's hash value
- *
- * We export this because for partitioned tables, callers need to compute
- * the partition number (from the low-order bits of the hash value) before
- * searching.
- */
-
-
-/* Convert a hash value to a bucket number */
-static inline uint32
-calc_bucket(HASHHDR *hctl, uint32 hash_val)
-{
-	uint32		bucket;
-
-	bucket = hash_val & hctl->high_mask;
-	if (bucket > hctl->max_bucket)
-		bucket = bucket & hctl->low_mask;
-
-	return bucket;
-}
-
-/*
- * hash_search -- look up key in table and perform action
- * hash_search_with_hash_value -- same, with key's hash value already computed
- *
- * action is one of:
- *		HASH_FIND: look up key in table
- *		HASH_ENTER: look up key in table, creating entry if not present
- *		HASH_ENTER_NULL: same, but return NULL if out of memory
- *		HASH_REMOVE: look up key in table, remove entry if present
- *
- * Return value is a pointer to the element found/entered/removed if any,
- * or NULL if no match was found.  (NB: in the case of the REMOVE action,
- * the result is a dangling pointer that shouldn't be dereferenced!)
- *
- * HASH_ENTER will normally ereport a generic "out of memory" error if
- * it is unable to create a new entry.  The HASH_ENTER_NULL operation is
- * the same except it will return NULL if out of memory.  Note that
- * HASH_ENTER_NULL cannot be used with the default palloc-based allocator,
- * since palloc internally ereports on out-of-memory.
- *
- * If foundPtr isn't NULL, then *foundPtr is set true if we found an
- * existing entry in the table, false otherwise.  This is needed in the
- * HASH_ENTER case, but is redundant with the return value otherwise.
- *
- * For hash_search_with_hash_value, the hashvalue parameter must have been
- * calculated with get_hash_value().
- */
-void *
-hash_search(HTAB *hashp,
-			const void *keyPtr,
-			HASHACTION action,
-			bool *foundPtr)
-{
-	return hash_search_with_hash_value(hashp,
-									   keyPtr,
-									   hashp->hash(keyPtr, hashp->keysize),
-									   action,
-									   foundPtr);
-}
-
-void *
-hash_search_with_hash_value(HTAB *hashp,
-							const void *keyPtr,
-							uint32 hashvalue,
-							HASHACTION action,
-							bool *foundPtr)
-{
-	HASHHDR    *hctl = hashp->hctl;
-	int			freelist_idx = FREELIST_IDX(hctl, hashvalue);
-	Size		keysize;
-	uint32		bucket;
-	long		segment_num;
-	long		segment_ndx;
-	HASHSEGMENT segp;
-	HASHBUCKET	currBucket;
-	HASHBUCKET *prevBucketPtr;
-	HashCompareFunc match;
-
-#ifdef HASH_STATISTICS
-	hash_accesses++;
-	hctl->accesses++;
-#endif
-
-	/*
-	 * If inserting, check if it is time to split a bucket.
-	 *
-	 * NOTE: failure to expand table is not a fatal error, it just means we
-	 * have to run at higher fill factor than we wanted.  However, if we're
-	 * using the palloc allocator then it will throw error anyway on
-	 * out-of-memory, so we must do this before modifying the table.
-	 */
-	if (action == HASH_ENTER || action == HASH_ENTER_NULL)
-	{
-		/*
-		 * Can't split if running in partitioned mode, nor if frozen, nor if
-		 * table is the subject of any active hash_seq_search scans.
-		 */
-		if (hctl->freeList[0].nentries > (long) hctl->max_bucket &&
-			!IS_PARTITIONED(hctl) && !hashp->frozen &&
-			!has_seq_scans(hashp))
-			(void) expand_table(hashp);
-	}
-
-	/*
-	 * Do the initial lookup
-	 */
-	bucket = calc_bucket(hctl, hashvalue);
-
-	segment_num = bucket >> hashp->sshift;
-	segment_ndx = MOD(bucket, hashp->ssize);
-
-	segp = hashp->dir[segment_num];
-
-	if (segp == NULL)
-		hash_corrupted(hashp);
-
-	prevBucketPtr = &segp[segment_ndx];
-	currBucket = *prevBucketPtr;
-
-	/*
-	 * Follow collision chain looking for matching key
-	 */
-	match = hashp->match;		/* save one fetch in inner loop */
-	keysize = hashp->keysize;	/* ditto */
-
-	while (currBucket != NULL)
-	{
-		if (currBucket->hashvalue == hashvalue &&
-			match(ELEMENTKEY(currBucket), keyPtr, keysize) == 0)
-			break;
-		prevBucketPtr = &(currBucket->link);
-		currBucket = *prevBucketPtr;
-#ifdef HASH_STATISTICS
-		hash_collisions++;
-		hctl->collisions++;
-#endif
-	}
-
-	if (foundPtr)
-		*foundPtr = (bool) (currBucket != NULL);
-
-	/*
-	 * OK, now what?
-	 */
-	switch (action)
-	{
-		case HASH_FIND:
-			if (currBucket != NULL)
-				return (void *) ELEMENTKEY(currBucket);
-			return NULL;
-
-		case HASH_REMOVE:
-			if (currBucket != NULL)
-			{
-				/* if partitioned, must lock to touch nentries and freeList */
-				if (IS_PARTITIONED(hctl))
-					SpinLockAcquire(&(hctl->freeList[freelist_idx].mutex));
-
-				/* delete the record from the appropriate nentries counter. */
-				Assert(hctl->freeList[freelist_idx].nentries > 0);
-				hctl->freeList[freelist_idx].nentries--;
-
-				/* remove record from hash bucket's chain. */
-				*prevBucketPtr = currBucket->link;
-
-				/* add the record to the appropriate freelist. */
-				currBucket->link = hctl->freeList[freelist_idx].freeList;
-				hctl->freeList[freelist_idx].freeList = currBucket;
-
-				if (IS_PARTITIONED(hctl))
-					SpinLockRelease(&hctl->freeList[freelist_idx].mutex);
-
-				/*
-				 * better hope the caller is synchronizing access to this
-				 * element, because someone else is going to reuse it the next
-				 * time something is added to the table
-				 */
-				return (void *) ELEMENTKEY(currBucket);
-			}
-			return NULL;
-
-		case HASH_ENTER_NULL:
-			/* ENTER_NULL does not work with palloc-based allocator */
-			Assert(hashp->alloc != DynaHashAlloc);
-			/* FALL THRU */
-
-		case HASH_ENTER:
-			/* Return existing element if found, else create one */
-			if (currBucket != NULL)
-				return (void *) ELEMENTKEY(currBucket);
-
-			/* disallow inserts if frozen */
-			if (hashp->frozen)
-				elog(ERROR, "cannot insert into frozen hashtable \"%s\"",
-					 hashp->tabname);
-
-			currBucket = get_hash_entry(hashp, freelist_idx);
-			if (currBucket == NULL)
-			{
-				/* out of memory */
-				if (action == HASH_ENTER_NULL)
-					return NULL;
-				/* report a generic message */
-				if (hashp->isshared)
-					ereport(ERROR,
-							(errcode(ERRCODE_OUT_OF_MEMORY),
-							 errmsg("out of shared memory")));
-				else
-					ereport(ERROR,
-							(errcode(ERRCODE_OUT_OF_MEMORY),
-							 errmsg("out of memory")));
-			}
-
-			/* link into hashbucket chain */
-			*prevBucketPtr = currBucket;
-			currBucket->link = NULL;
-
-			/* copy key into record */
-			currBucket->hashvalue = hashvalue;
-			hashp->keycopy(ELEMENTKEY(currBucket), keyPtr, keysize);
-
-			/*
-			 * Caller is expected to fill the data field on return.  DO NOT
-			 * insert any code that could possibly throw error here, as doing
-			 * so would leave the table entry incomplete and hence corrupt the
-			 * caller's data structure.
-			 */
-
-			return (void *) ELEMENTKEY(currBucket);
-	}
-
-	elog(ERROR, "unrecognized hash action code: %d", (int) action);
-
-	return NULL;				/* keep compiler quiet */
-}
-
-/*
- * hash_update_hash_key -- change the hash key of an existing table entry
- *
- * This is equivalent to removing the entry, making a new entry, and copying
- * over its data, except that the entry never goes to the table's freelist.
- * Therefore this cannot suffer an out-of-memory failure, even if there are
- * other processes operating in other partitions of the hashtable.
- *
- * Returns true if successful, false if the requested new hash key is already
- * present.  Throws error if the specified entry pointer isn't actually a
- * table member.
- *
- * NB: currently, there is no special case for old and new hash keys being
- * identical, which means we'll report false for that situation.  This is
- * preferable for existing uses.
- *
- * NB: for a partitioned hashtable, caller must hold lock on both relevant
- * partitions, if the new hash key would belong to a different partition.
- */
-#ifdef HASH_STATISTICS
-#endif
-#ifdef HASH_STATISTICS
-#endif
-
-/*
- * Allocate a new hashtable entry if possible; return NULL if out of memory.
- * (Or, if the underlying space allocator throws error for out-of-memory,
- * we won't return at all.)
- */
-static HASHBUCKET
-get_hash_entry(HTAB *hashp, int freelist_idx)
-{
-	HASHHDR    *hctl = hashp->hctl;
-	HASHBUCKET	newElement;
-
-	for (;;)
-	{
-		/* if partitioned, must lock to touch nentries and freeList */
-		if (IS_PARTITIONED(hctl))
-			SpinLockAcquire(&hctl->freeList[freelist_idx].mutex);
-
-		/* try to get an entry from the freelist */
-		newElement = hctl->freeList[freelist_idx].freeList;
-
-		if (newElement != NULL)
-			break;
-
-		if (IS_PARTITIONED(hctl))
-			SpinLockRelease(&hctl->freeList[freelist_idx].mutex);
-
-		/*
-		 * No free elements in this freelist.  In a partitioned table, there
-		 * might be entries in other freelists, but to reduce contention we
-		 * prefer to first try to get another chunk of buckets from the main
-		 * shmem allocator.  If that fails, though, we *MUST* root through all
-		 * the other freelists before giving up.  There are multiple callers
-		 * that assume that they can allocate every element in the initially
-		 * requested table size, or that deleting an element guarantees they
-		 * can insert a new element, even if shared memory is entirely full.
-		 * Failing because the needed element is in a different freelist is
-		 * not acceptable.
-		 */
-		if (!element_alloc(hashp, hctl->nelem_alloc, freelist_idx))
-		{
-			int			borrow_from_idx;
-
-			if (!IS_PARTITIONED(hctl))
-				return NULL;	/* out of memory */
-
-			/* try to borrow element from another freelist */
-			borrow_from_idx = freelist_idx;
-			for (;;)
-			{
-				borrow_from_idx = (borrow_from_idx + 1) % NUM_FREELISTS;
-				if (borrow_from_idx == freelist_idx)
-					break;		/* examined all freelists, fail */
-
-				SpinLockAcquire(&(hctl->freeList[borrow_from_idx].mutex));
-				newElement = hctl->freeList[borrow_from_idx].freeList;
-
-				if (newElement != NULL)
-				{
-					hctl->freeList[borrow_from_idx].freeList = newElement->link;
-					SpinLockRelease(&(hctl->freeList[borrow_from_idx].mutex));
-
-					/* careful: count the new element in its proper freelist */
-					SpinLockAcquire(&hctl->freeList[freelist_idx].mutex);
-					hctl->freeList[freelist_idx].nentries++;
-					SpinLockRelease(&hctl->freeList[freelist_idx].mutex);
-
-					return newElement;
-				}
-
-				SpinLockRelease(&(hctl->freeList[borrow_from_idx].mutex));
-			}
-
-			/* no elements available to borrow either, so out of memory */
-			return NULL;
-		}
-	}
-
-	/* remove entry from freelist, bump nentries */
-	hctl->freeList[freelist_idx].freeList = newElement->link;
-	hctl->freeList[freelist_idx].nentries++;
-
-	if (IS_PARTITIONED(hctl))
-		SpinLockRelease(&hctl->freeList[freelist_idx].mutex);
-
-	return newElement;
-}
-
-/*
- * hash_get_num_entries -- get the number of entries in a hashtable
- */
-
-
-/*
- * hash_seq_init/_search/_term
- *			Sequentially search through hash table and return
- *			all the elements one by one, return NULL when no more.
- *
- * hash_seq_term should be called if and only if the scan is abandoned before
- * completion; if hash_seq_search returns NULL then it has already done the
- * end-of-scan cleanup.
- *
- * NOTE: caller may delete the returned element before continuing the scan.
- * However, deleting any other element while the scan is in progress is
- * UNDEFINED (it might be the one that curIndex is pointing at!).  Also,
- * if elements are added to the table while the scan is in progress, it is
- * unspecified whether they will be visited by the scan or not.
- *
- * NOTE: it is possible to use hash_seq_init/hash_seq_search without any
- * worry about hash_seq_term cleanup, if the hashtable is first locked against
- * further insertions by calling hash_freeze.
- *
- * NOTE: to use this with a partitioned hashtable, caller had better hold
- * at least shared lock on all partitions of the table throughout the scan!
- * We can cope with insertions or deletions by our own backend, but *not*
- * with concurrent insertions or deletions by another.
- */
-
-
-
-
-
-
-/*
- * hash_freeze
- *			Freeze a hashtable against future insertions (deletions are
- *			still allowed)
- *
- * The reason for doing this is that by preventing any more bucket splits,
- * we no longer need to worry about registering hash_seq_search scans,
- * and thus caller need not be careful about ensuring hash_seq_term gets
- * called at the right times.
- *
- * Multiple calls to hash_freeze() are allowed, but you can't freeze a table
- * with active scans (since hash_seq_term would then do the wrong thing).
- */
-
-
-
-/********************************* UTILITIES ************************/
-
-/*
- * Expand the table by adding one more hash bucket.
- */
-static bool
-expand_table(HTAB *hashp)
-{
-	HASHHDR    *hctl = hashp->hctl;
-	HASHSEGMENT old_seg,
-				new_seg;
-	long		old_bucket,
-				new_bucket;
-	long		new_segnum,
-				new_segndx;
-	long		old_segnum,
-				old_segndx;
-	HASHBUCKET *oldlink,
-			   *newlink;
-	HASHBUCKET	currElement,
-				nextElement;
-
-	Assert(!IS_PARTITIONED(hctl));
-
-#ifdef HASH_STATISTICS
-	hash_expansions++;
-#endif
-
-	new_bucket = hctl->max_bucket + 1;
-	new_segnum = new_bucket >> hashp->sshift;
-	new_segndx = MOD(new_bucket, hashp->ssize);
-
-	if (new_segnum >= hctl->nsegs)
-	{
-		/* Allocate new segment if necessary -- could fail if dir full */
-		if (new_segnum >= hctl->dsize)
-			if (!dir_realloc(hashp))
-				return false;
-		if (!(hashp->dir[new_segnum] = seg_alloc(hashp)))
-			return false;
-		hctl->nsegs++;
-	}
-
-	/* OK, we created a new bucket */
-	hctl->max_bucket++;
-
-	/*
-	 * *Before* changing masks, find old bucket corresponding to same hash
-	 * values; values in that bucket may need to be relocated to new bucket.
-	 * Note that new_bucket is certainly larger than low_mask at this point,
-	 * so we can skip the first step of the regular hash mask calc.
-	 */
-	old_bucket = (new_bucket & hctl->low_mask);
-
-	/*
-	 * If we crossed a power of 2, readjust masks.
-	 */
-	if ((uint32) new_bucket > hctl->high_mask)
-	{
-		hctl->low_mask = hctl->high_mask;
-		hctl->high_mask = (uint32) new_bucket | hctl->low_mask;
-	}
-
-	/*
-	 * Relocate records to the new bucket.  NOTE: because of the way the hash
-	 * masking is done in calc_bucket, only one old bucket can need to be
-	 * split at this point.  With a different way of reducing the hash value,
-	 * that might not be true!
-	 */
-	old_segnum = old_bucket >> hashp->sshift;
-	old_segndx = MOD(old_bucket, hashp->ssize);
-
-	old_seg = hashp->dir[old_segnum];
-	new_seg = hashp->dir[new_segnum];
-
-	oldlink = &old_seg[old_segndx];
-	newlink = &new_seg[new_segndx];
-
-	for (currElement = *oldlink;
-		 currElement != NULL;
-		 currElement = nextElement)
-	{
-		nextElement = currElement->link;
-		if ((long) calc_bucket(hctl, currElement->hashvalue) == old_bucket)
-		{
-			*oldlink = currElement;
-			oldlink = &currElement->link;
-		}
-		else
-		{
-			*newlink = currElement;
-			newlink = &currElement->link;
-		}
-	}
-	/* don't forget to terminate the rebuilt hash chains... */
-	*oldlink = NULL;
-	*newlink = NULL;
-
-	return true;
-}
-
-
-static bool
-dir_realloc(HTAB *hashp)
-{
-	HASHSEGMENT *p;
-	HASHSEGMENT *old_p;
-	long		new_dsize;
-	long		old_dirsize;
-	long		new_dirsize;
-
-	if (hashp->hctl->max_dsize != NO_MAX_DSIZE)
-		return false;
-
-	/* Reallocate directory */
-	new_dsize = hashp->hctl->dsize << 1;
-	old_dirsize = hashp->hctl->dsize * sizeof(HASHSEGMENT);
-	new_dirsize = new_dsize * sizeof(HASHSEGMENT);
-
-	old_p = hashp->dir;
-	CurrentDynaHashCxt = hashp->hcxt;
-	p = (HASHSEGMENT *) hashp->alloc((Size) new_dirsize);
-
-	if (p != NULL)
-	{
-		memcpy(p, old_p, old_dirsize);
-		MemSet(((char *) p) + old_dirsize, 0, new_dirsize - old_dirsize);
-		hashp->dir = p;
-		hashp->hctl->dsize = new_dsize;
-
-		/* XXX assume the allocator is palloc, so we know how to free */
-		Assert(hashp->alloc == DynaHashAlloc);
-		pfree(old_p);
-
-		return true;
-	}
-
-	return false;
-}
-
-
-static HASHSEGMENT
-seg_alloc(HTAB *hashp)
-{
-	HASHSEGMENT segp;
-
-	CurrentDynaHashCxt = hashp->hcxt;
-	segp = (HASHSEGMENT) hashp->alloc(sizeof(HASHBUCKET) * hashp->ssize);
-
-	if (!segp)
-		return NULL;
-
-	MemSet(segp, 0, sizeof(HASHBUCKET) * hashp->ssize);
-
-	return segp;
-}
-
-/*
- * allocate some new elements and link them into the indicated free list
- */
-static bool
-element_alloc(HTAB *hashp, int nelem, int freelist_idx)
-{
-	HASHHDR    *hctl = hashp->hctl;
-	Size		elementSize;
-	HASHELEMENT *firstElement;
-	HASHELEMENT *tmpElement;
-	HASHELEMENT *prevElement;
-	int			i;
-
-	if (hashp->isfixed)
-		return false;
-
-	/* Each element has a HASHELEMENT header plus user data. */
-	elementSize = MAXALIGN(sizeof(HASHELEMENT)) + MAXALIGN(hctl->entrysize);
-
-	CurrentDynaHashCxt = hashp->hcxt;
-	firstElement = (HASHELEMENT *) hashp->alloc(nelem * elementSize);
-
-	if (!firstElement)
-		return false;
-
-	/* prepare to link all the new entries into the freelist */
-	prevElement = NULL;
-	tmpElement = firstElement;
-	for (i = 0; i < nelem; i++)
-	{
-		tmpElement->link = prevElement;
-		prevElement = tmpElement;
-		tmpElement = (HASHELEMENT *) (((char *) tmpElement) + elementSize);
-	}
-
-	/* if partitioned, must lock to touch freeList */
-	if (IS_PARTITIONED(hctl))
-		SpinLockAcquire(&hctl->freeList[freelist_idx].mutex);
-
-	/* freelist could be nonempty if two backends did this concurrently */
-	firstElement->link = hctl->freeList[freelist_idx].freeList;
-	hctl->freeList[freelist_idx].freeList = prevElement;
-
-	if (IS_PARTITIONED(hctl))
-		SpinLockRelease(&hctl->freeList[freelist_idx].mutex);
-
-	return true;
-}
-
-/* complain when we have detected a corrupted hashtable */
-static void
-hash_corrupted(HTAB *hashp)
-{
-	/*
-	 * If the corruption is in a shared hashtable, we'd better force a
-	 * systemwide restart.  Otherwise, just shut down this one backend.
-	 */
-	if (hashp->isshared)
-		elog(PANIC, "hash table \"%s\" corrupted", hashp->tabname);
-	else
-		elog(FATAL, "hash table \"%s\" corrupted", hashp->tabname);
-}
-
-/* calculate ceil(log base 2) of num */
-#if SIZEOF_LONG < 8
-#else
-#endif
-
-/* calculate first power of 2 >= num, bounded to what will fit in a long */
-
-
-/* calculate first power of 2 >= num, bounded to what will fit in an int */
-
-
-
-/************************* SEQ SCAN TRACKING ************************/
-
-/*
- * We track active hash_seq_search scans here.  The need for this mechanism
- * comes from the fact that a scan will get confused if a bucket split occurs
- * while it's in progress: it might visit entries twice, or even miss some
- * entirely (if it's partway through the same bucket that splits).  Hence
- * we want to inhibit bucket splits if there are any active scans on the
- * table being inserted into.  This is a fairly rare case in current usage,
- * so just postponing the split until the next insertion seems sufficient.
- *
- * Given present usages of the function, only a few scans are likely to be
- * open concurrently; so a finite-size stack of open scans seems sufficient,
- * and we don't worry that linear search is too slow.  Note that we do
- * allow multiple scans of the same hashtable to be open concurrently.
- *
- * This mechanism can support concurrent scan and insertion in a shared
- * hashtable if it's the same backend doing both.  It would fail otherwise,
- * but locking reasons seem to preclude any such scenario anyway, so we don't
- * worry.
- *
- * This arrangement is reasonably robust if a transient hashtable is deleted
- * without notifying us.  The absolute worst case is we might inhibit splits
- * in another table created later at exactly the same address.  We will give
- * a warning at transaction end for reference leaks, so any bugs leading to
- * lack of notification should be easy to catch.
- */
-
-#define MAX_SEQ_SCANS 100
-
-static __thread HTAB *seq_scan_tables[MAX_SEQ_SCANS];
-	/* tables being scanned */
-	/* subtransaction nest level */
-static __thread int	num_seq_scans = 0;
-
-
-
-/* Register a table as having an active hash_seq_search scan */
-
-
-/* Deregister an active scan */
-
-
-/* Check if a table has any active scan */
-static bool
-has_seq_scans(HTAB *hashp)
-{
-	int			i;
-
-	for (i = 0; i < num_seq_scans; i++)
-	{
-		if (seq_scan_tables[i] == hashp)
-			return true;
-	}
-	return false;
-}
-
-/* Clean up any open scans at end of transaction */
-
-
-/* Clean up any open scans at end of subtransaction */
-