/* Dictionary object implementation using a hash table */

/* The distribution includes a separate file, Objects/dictnotes.txt,

describing explorations into dictionary design and optimization.

It covers typical dictionary use patterns, the parameters for

tuning dictionaries, and several ideas for possible optimizations.

*/

/* PyDictKeysObject

This implements the dictionary's hashtable.

As of Python 3.6, this is compact and ordered. Basic idea is described here:

* https://mail.python.org/pipermail/python-dev/2012-December/123028.html

* https://morepypy.blogspot.com/2015/01/faster-more-memory-efficient-and-more.html

layout:

+---------------+

| dk_refcnt |

| dk_size |

| dk_lookup |

| dk_usable |

| dk_nentries |

+---------------+

| dk_indices |

| |

+---------------+

| dk_entries |

| |

+---------------+

dk_indices is actual hashtable. It holds index in entries, or DKIX_EMPTY(-1)

or DKIX_DUMMY(-2).

Size of indices is dk_size. Type of each index in indices is vary on dk_size:

* int8 for dk_size <= 128

* int16 for 256 <= dk_size <= 2**15

* int32 for 2**16 <= dk_size <= 2**31

* int64 for 2**32 <= dk_size

dk_entries is array of PyDictKeyEntry. Its size is USABLE_FRACTION(dk_size).

DK_ENTRIES(dk) can be used to get pointer to entries.

NOTE: Since negative value is used for DKIX_EMPTY and DKIX_DUMMY, type of

dk_indices entry is signed integer and int16 is used for table which

dk_size == 256.

*/

/*

The DictObject can be in one of two forms.

Either:

A combined table:

ma_values == NULL, dk_refcnt == 1.

Values are stored in the me_value field of the PyDictKeysObject.

Or:

A split table:

ma_values != NULL, dk_refcnt >= 1

Values are stored in the ma_values array.

Only string (unicode) keys are allowed.

All dicts sharing same key must have same insertion order.

There are four kinds of slots in the table (slot is index, and

DK_ENTRIES(keys)[index] if index >= 0):

1. Unused. index == DKIX_EMPTY

Does not hold an active (key, value) pair now and never did. Unused can

transition to Active upon key insertion. This is each slot's initial state.

2. Active. index >= 0, me_key != NULL and me_value != NULL

Holds an active (key, value) pair. Active can transition to Dummy or

Pending upon key deletion (for combined and split tables respectively).

This is the only case in which me_value != NULL.

3. Dummy. index == DKIX_DUMMY (combined only)

Previously held an active (key, value) pair, but that was deleted and an

active pair has not yet overwritten the slot. Dummy can transition to

Active upon key insertion. Dummy slots cannot be made Unused again

else the probe sequence in case of collision would have no way to know

they were once active.

4. Pending. index >= 0, key != NULL, and value == NULL (split only)

Not yet inserted in split-table.

*/

/*

Preserving insertion order

It's simple for combined table. Since dk_entries is mostly append only, we can

get insertion order by just iterating dk_entries.

One exception is .popitem(). It removes last item in dk_entries and decrement

dk_nentries to achieve amortized O(1). Since there are DKIX_DUMMY remains in

dk_indices, we can't increment dk_usable even though dk_nentries is

decremented.

In split table, inserting into pending entry is allowed only for dk_entries[ix]

where ix == mp->ma_used. Inserting into other index and deleting item cause

converting the dict to the combined table.

*/

/* PyDict_MINSIZE is the starting size for any new dict.

* 8 allows dicts with no more than 5 active entries; experiments suggested

* this suffices for the majority of dicts (consisting mostly of usually-small

* dicts created to pass keyword arguments).

* Making this 8, rather than 4 reduces the number of resizes for most

* dictionaries, without any significant extra memory use.

*/

#define PyDict_MINSIZE 8

#include "Python.h"

#include "pycore_object.h"

#include "pycore_pystate.h"

#include "dict-common.h"

#include "stringlib/eq.h" /* to get unicode_eq() */

/*[clinic input]

class dict "PyDictObject *" "&PyDict_Type"

[clinic start generated code]*/

/*[clinic end generated code: output=da39a3ee5e6b4b0d input=f157a5a0ce9589d6]*/

/*

To ensure the lookup algorithm terminates, there must be at least one Unused

slot (NULL key) in the table.

To avoid slowing down lookups on a near-full table, we resize the table when

it's USABLE_FRACTION (currently two-thirds) full.

*/

#define PERTURB_SHIFT 5

/*

Major subtleties ahead: Most hash schemes depend on having a "good" hash

function, in the sense of simulating randomness. Python doesn't: its most

important hash functions (for ints) are very regular in common

cases:

>>>[hash(i) for i in range(4)]

[0, 1, 2, 3]

This isn't necessarily bad! To the contrary, in a table of size 2**i, taking

the low-order i bits as the initial table index is extremely fast, and there

are no collisions at all for dicts indexed by a contiguous range of ints. So

this gives better-than-random behavior in common cases, and that's very

desirable.

OTOH, when collisions occur, the tendency to fill contiguous slices of the

hash table makes a good collision resolution strategy crucial. Taking only

the last i bits of the hash code is also vulnerable: for example, consider

the list [i << 16 for i in range(20000)] as a set of keys. Since ints are

their own hash codes, and this fits in a dict of size 2**15, the last 15 bits

of every hash code are all 0: they *all* map to the same table index.

But catering to unusual cases should not slow the usual ones, so we just take

the last i bits anyway. It's up to collision resolution to do the rest. If

we *usually* find the key we're looking for on the first try (and, it turns

out, we usually do -- the table load factor is kept under 2/3, so the odds

are solidly in our favor), then it makes best sense to keep the initial index

computation dirt cheap.

The first half of collision resolution is to visit table indices via this

recurrence:

j = ((5*j) + 1) mod 2**i

For any initial j in range(2**i), repeating that 2**i times generates each

int in range(2**i) exactly once (see any text on random-number generation for

proof). By itself, this doesn't help much: like linear probing (setting

j += 1, or j -= 1, on each loop trip), it scans the table entries in a fixed

order. This would be bad, except that's not the only thing we do, and it's

actually *good* in the common cases where hash keys are consecutive. In an

example that's really too small to make this entirely clear, for a table of

size 2**3 the order of indices is:

0 -> 1 -> 6 -> 7 -> 4 -> 5 -> 2 -> 3 -> 0 [and here it's repeating]

If two things come in at index 5, the first place we look after is index 2,

not 6, so if another comes in at index 6 the collision at 5 didn't hurt it.

Linear probing is deadly in this case because there the fixed probe order

is the *same* as the order consecutive keys are likely to arrive. But it's

extremely unlikely hash codes will follow a 5*j+1 recurrence by accident,

and certain that consecutive hash codes do not.

The other half of the strategy is to get the other bits of the hash code

into play. This is done by initializing a (unsigned) vrbl "perturb" to the

full hash code, and changing the recurrence to:

perturb >>= PERTURB_SHIFT;

j = (5*j) + 1 + perturb;

use j % 2**i as the next table index;

Now the probe sequence depends (eventually) on every bit in the hash code,

and the pseudo-scrambling property of recurring on 5*j+1 is more valuable,

because it quickly magnifies small differences in the bits that didn't affect

the initial index. Note that because perturb is unsigned, if the recurrence

is executed often enough perturb eventually becomes and remains 0. At that

point (very rarely reached) the recurrence is on (just) 5*j+1 again, and

that's certain to find an empty slot eventually (since it generates every int

in range(2**i), and we make sure there's always at least one empty slot).

Selecting a good value for PERTURB_SHIFT is a balancing act. You want it

small so that the high bits of the hash code continue to affect the probe

sequence across iterations; but you want it large so that in really bad cases

the high-order hash bits have an effect on early iterations. 5 was "the

best" in minimizing total collisions across experiments Tim Peters ran (on

both normal and pathological cases), but 4 and 6 weren't significantly worse.

Historical: Reimer Behrends contributed the idea of using a polynomial-based

approach, using repeated multiplication by x in GF(2**n) where an irreducible

polynomial for each table size was chosen such that x was a primitive root.

Christian Tismer later extended that to use division by x instead, as an

efficient way to get the high bits of the hash code into play. This scheme

also gave excellent collision statistics, but was more expensive: two

if-tests were required inside the loop; computing "the next" index took about

the same number of operations but without as much potential parallelism

(e.g., computing 5*j can go on at the same time as computing 1+perturb in the

above, and then shifting perturb can be done while the table index is being

masked); and the PyDictObject struct required a member to hold the table's

polynomial. In Tim's experiments the current scheme ran faster, produced

equally good collision statistics, needed less code & used less memory.

*/

/* forward declarations */

static Py_ssize_t lookdict(PyDictObject *mp, PyObject *key,

Py_hash_t hash, PyObject **value_addr);

static Py_ssize_t lookdict_unicode(PyDictObject *mp, PyObject *key,

Py_hash_t hash, PyObject **value_addr);

static Py_ssize_t

lookdict_unicode_nodummy(PyDictObject *mp, PyObject *key,

Py_hash_t hash, PyObject **value_addr);

static Py_ssize_t lookdict_split(PyDictObject *mp, PyObject *key,

Py_hash_t hash, PyObject **value_addr);

static int dictresize(PyDictObject *mp, Py_ssize_t minused);

static PyObject* dict_iter(PyDictObject *dict);

/*Global counter used to set ma_version_tag field of dictionary.

* It is incremented each time that a dictionary is created and each

* time that a dictionary is modified. */

static uint64_t pydict_global_version = 0;

#define DICT_NEXT_VERSION() (++pydict_global_version)

/* Dictionary reuse scheme to save calls to malloc and free */

#ifndef PyDict_MAXFREELIST

#define PyDict_MAXFREELIST 80

#endif

static PyDictObject *free_list[PyDict_MAXFREELIST];

static int numfree = 0;

static PyDictKeysObject *keys_free_list[PyDict_MAXFREELIST];

static int numfreekeys = 0;

#include "clinic/dictobject.c.h"

int

PyDict_ClearFreeList(void)

{

PyDictObject *op;

int ret = numfree + numfreekeys;

while (numfree) {

op = free_list[--numfree];

assert(PyDict_CheckExact(op));

PyObject_GC_Del(op);

}

while (numfreekeys) {

PyObject_FREE(keys_free_list[--numfreekeys]);

}

return ret;

}

/* Print summary info about the state of the optimized allocator */

void

_PyDict_DebugMallocStats(FILE *out)

{

_PyDebugAllocatorStats(out,

"free PyDictObject", numfree, sizeof(PyDictObject));

}

void

_PyDict_Fini(void)

{

PyDict_ClearFreeList();

}

#define DK_SIZE(dk) ((dk)->dk_size)

#if SIZEOF_VOID_P > 4

#define DK_IXSIZE(dk) \

(DK_SIZE(dk) <= 0xff ? \

1 : DK_SIZE(dk) <= 0xffff ? \

2 : DK_SIZE(dk) <= 0xffffffff ? \

4 : sizeof(int64_t))

#else

#define DK_IXSIZE(dk) \

(DK_SIZE(dk) <= 0xff ? \

1 : DK_SIZE(dk) <= 0xffff ? \

2 : sizeof(int32_t))

#endif

#define DK_ENTRIES(dk) \

((PyDictKeyEntry*)(&((int8_t*)((dk)->dk_indices))[DK_SIZE(dk) * DK_IXSIZE(dk)]))

#define DK_MASK(dk) (((dk)->dk_size)-1)

#define IS_POWER_OF_2(x) (((x) & (x-1)) == 0)

static void free_keys_object(PyDictKeysObject *keys);

static inline void

dictkeys_incref(PyDictKeysObject *dk)

{

_Py_INC_REFTOTAL;

dk->dk_refcnt++;

}

static inline void

dictkeys_decref(PyDictKeysObject *dk)

{

assert(dk->dk_refcnt > 0);

_Py_DEC_REFTOTAL;

if (--dk->dk_refcnt == 0) {

free_keys_object(dk);

}

}

/* lookup indices. returns DKIX_EMPTY, DKIX_DUMMY, or ix >=0 */

static inline Py_ssize_t

dictkeys_get_index(PyDictKeysObject *keys, Py_ssize_t i)

{

Py_ssize_t s = DK_SIZE(keys);

Py_ssize_t ix;

if (s <= 0xff) {

int8_t *indices = (int8_t*)(keys->dk_indices);

ix = indices[i];

}

else if (s <= 0xffff) {

int16_t *indices = (int16_t*)(keys->dk_indices);

ix = indices[i];

}

#if SIZEOF_VOID_P > 4

else if (s > 0xffffffff) {

int64_t *indices = (int64_t*)(keys->dk_indices);

ix = indices[i];

}

#endif

else {

int32_t *indices = (int32_t*)(keys->dk_indices);

ix = indices[i];

}

assert(ix >= DKIX_DUMMY);

return ix;

}

/* write to indices. */

static inline void

dictkeys_set_index(PyDictKeysObject *keys, Py_ssize_t i, Py_ssize_t ix)

{

Py_ssize_t s = DK_SIZE(keys);

assert(ix >= DKIX_DUMMY);

if (s <= 0xff) {

int8_t *indices = (int8_t*)(keys->dk_indices);

assert(ix <= 0x7f);

indices[i] = (char)ix;

}

else if (s <= 0xffff) {

int16_t *indices = (int16_t*)(keys->dk_indices);

assert(ix <= 0x7fff);

indices[i] = (int16_t)ix;

}

#if SIZEOF_VOID_P > 4

else if (s > 0xffffffff) {

int64_t *indices = (int64_t*)(keys->dk_indices);

indices[i] = ix;

}

#endif

else {

int32_t *indices = (int32_t*)(keys->dk_indices);

assert(ix <= 0x7fffffff);

indices[i] = (int32_t)ix;

}

}

/* USABLE_FRACTION is the maximum dictionary load.

* Increasing this ratio makes dictionaries more dense resulting in more

* collisions. Decreasing it improves sparseness at the expense of spreading

* indices over more cache lines and at the cost of total memory consumed.

*

* USABLE_FRACTION must obey the following:

* (0 < USABLE_FRACTION(n) < n) for all n >= 2

*

* USABLE_FRACTION should be quick to calculate.

* Fractions around 1/2 to 2/3 seem to work well in practice.

*/

#define USABLE_FRACTION(n) (((n) << 1)/3)

/* ESTIMATE_SIZE is reverse function of USABLE_FRACTION.

* This can be used to reserve enough size to insert n entries without

* resizing.

*/

#define ESTIMATE_SIZE(n) (((n)*3+1) >> 1)

/* Alternative fraction that is otherwise close enough to 2n/3 to make

* little difference. 8 * 2/3 == 8 * 5/8 == 5. 16 * 2/3 == 16 * 5/8 == 10.

* 32 * 2/3 = 21, 32 * 5/8 = 20.

* Its advantage is that it is faster to compute on machines with slow division.

* #define USABLE_FRACTION(n) (((n) >> 1) + ((n) >> 2) - ((n) >> 3))

*/

/* GROWTH_RATE. Growth rate upon hitting maximum load.

* Currently set to used*3.

* This means that dicts double in size when growing without deletions,

* but have more head room when the number of deletions is on a par with the

* number of insertions. See also bpo-17563 and bpo-33205.

*

* GROWTH_RATE was set to used*4 up to version 3.2.

* GROWTH_RATE was set to used*2 in version 3.3.0

* GROWTH_RATE was set to used*2 + capacity/2 in 3.4.0-3.6.0.

*/

#define GROWTH_RATE(d) ((d)->ma_used*3)

#define ENSURE_ALLOWS_DELETIONS(d) \

if ((d)->ma_keys->dk_lookup == lookdict_unicode_nodummy) { \

(d)->ma_keys->dk_lookup = lookdict_unicode; \

}

/* This immutable, empty PyDictKeysObject is used for PyDict_Clear()

* (which cannot fail and thus can do no allocation).

*/

static PyDictKeysObject empty_keys_struct = {

1, /* dk_refcnt */

1, /* dk_size */

lookdict_split, /* dk_lookup */

0, /* dk_usable (immutable) */

0, /* dk_nentries */

{DKIX_EMPTY, DKIX_EMPTY, DKIX_EMPTY, DKIX_EMPTY,

DKIX_EMPTY, DKIX_EMPTY, DKIX_EMPTY, DKIX_EMPTY}, /* dk_indices */

};

static PyObject *empty_values[1] = { NULL };

#define Py_EMPTY_KEYS &empty_keys_struct

/* Uncomment to check the dict content in _PyDict_CheckConsistency() */

/* #define DEBUG_PYDICT */

#ifdef DEBUG_PYDICT

# define ASSERT_CONSISTENT(op) assert(_PyDict_CheckConsistency((PyObject *)(op), 1))

#else

# define ASSERT_CONSISTENT(op) assert(_PyDict_CheckConsistency((PyObject *)(op), 0))

#endif

int

_PyDict_CheckConsistency(PyObject *op, int check_content)

{

#define CHECK(expr) \

do { if (!(expr)) { _PyObject_ASSERT_FAILED_MSG(op, Py_STRINGIFY(expr)); } } while (0)

assert(op != NULL);

CHECK(PyDict_Check(op));

PyDictObject *mp = (PyDictObject *)op;

PyDictKeysObject *keys = mp->ma_keys;

int splitted = _PyDict_HasSplitTable(mp);

Py_ssize_t usable = USABLE_FRACTION(keys->dk_size);

CHECK(0 <= mp->ma_used && mp->ma_used <= usable);

CHECK(IS_POWER_OF_2(keys->dk_size));

CHECK(0 <= keys->dk_usable && keys->dk_usable <= usable);

CHECK(0 <= keys->dk_nentries && keys->dk_nentries <= usable);

CHECK(keys->dk_usable + keys->dk_nentries <= usable);

if (!splitted) {

/* combined table */

CHECK(keys->dk_refcnt == 1);

}

if (check_content) {

PyDictKeyEntry *entries = DK_ENTRIES(keys);

Py_ssize_t i;

for (i=0; i < keys->dk_size; i++) {

Py_ssize_t ix = dictkeys_get_index(keys, i);

CHECK(DKIX_DUMMY <= ix && ix <= usable);

}

for (i=0; i < usable; i++) {

PyDictKeyEntry *entry = &entries[i];

PyObject *key = entry->me_key;

if (key != NULL) {

if (PyUnicode_CheckExact(key)) {

Py_hash_t hash = ((PyASCIIObject *)key)->hash;

CHECK(hash != -1);

CHECK(entry->me_hash == hash);

}

else {

/* test_dict fails if PyObject_Hash() is called again */

CHECK(entry->me_hash != -1);

}

if (!splitted) {

CHECK(entry->me_value != NULL);

}

}

if (splitted) {

CHECK(entry->me_value == NULL);

}

}

if (splitted) {

/* splitted table */

for (i=0; i < mp->ma_used; i++) {

CHECK(mp->ma_values[i] != NULL);

}

}

}

return 1;

#undef CHECK

}

static PyDictKeysObject *new_keys_object(Py_ssize_t size)

{

PyDictKeysObject *dk;

Py_ssize_t es, usable;

assert(size >= PyDict_MINSIZE);

assert(IS_POWER_OF_2(size));

usable = USABLE_FRACTION(size);

if (size <= 0xff) {

es = 1;

}

else if (size <= 0xffff) {

es = 2;

}

#if SIZEOF_VOID_P > 4

else if (size <= 0xffffffff) {

es = 4;

}

#endif

else {

es = sizeof(Py_ssize_t);

}

if (size == PyDict_MINSIZE && numfreekeys > 0) {

dk = keys_free_list[--numfreekeys];

}

else {

dk = PyObject_MALLOC(sizeof(PyDictKeysObject)

+ es * size

+ sizeof(PyDictKeyEntry) * usable);

if (dk == NULL) {

PyErr_NoMemory();

return NULL;

}

}

_Py_INC_REFTOTAL;

dk->dk_refcnt = 1;

dk->dk_size = size;

dk->dk_usable = usable;

dk->dk_lookup = lookdict_unicode_nodummy;

dk->dk_nentries = 0;

memset(&dk->dk_indices[0], 0xff, es * size);

memset(DK_ENTRIES(dk), 0, sizeof(PyDictKeyEntry) * usable);

return dk;

}

static void

free_keys_object(PyDictKeysObject *keys)

{

PyDictKeyEntry *entries = DK_ENTRIES(keys);

Py_ssize_t i, n;

for (i = 0, n = keys->dk_nentries; i < n; i++) {

Py_XDECREF(entries[i].me_key);

Py_XDECREF(entries[i].me_value);

}

if (keys->dk_size == PyDict_MINSIZE && numfreekeys < PyDict_MAXFREELIST) {

keys_free_list[numfreekeys++] = keys;

return;

}

PyObject_FREE(keys);

}

#define new_values(size) PyMem_NEW(PyObject *, size)

#define free_values(values) PyMem_FREE(values)

/* Consumes a reference to the keys object */

static PyObject *

new_dict(PyDictKeysObject *keys, PyObject **values)

{

PyDictObject *mp;

assert(keys != NULL);

if (numfree) {

mp = free_list[--numfree];

assert (mp != NULL);

assert (Py_TYPE(mp) == &PyDict_Type);

_Py_NewReference((PyObject *)mp);

}

else {

mp = PyObject_GC_New(PyDictObject, &PyDict_Type);

if (mp == NULL) {

dictkeys_decref(keys);

if (values != empty_values) {

free_values(values);

}

return NULL;

}

}

mp->ma_keys = keys;

mp->ma_values = values;

mp->ma_used = 0;

mp->ma_version_tag = DICT_NEXT_VERSION();

ASSERT_CONSISTENT(mp);

return (PyObject *)mp;

}

/* Consumes a reference to the keys object */

static PyObject *

new_dict_with_shared_keys(PyDictKeysObject *keys)

{

PyObject **values;

Py_ssize_t i, size;

size = USABLE_FRACTION(DK_SIZE(keys));

values = new_values(size);

if (values == NULL) {

dictkeys_decref(keys);

return PyErr_NoMemory();

}

for (i = 0; i < size; i++) {

values[i] = NULL;

}

return new_dict(keys, values);

}

static PyObject *

clone_combined_dict(PyDictObject *orig)

{

assert(PyDict_CheckExact(orig));

assert(orig->ma_values == NULL);

assert(orig->ma_keys->dk_refcnt == 1);

Py_ssize_t keys_size = _PyDict_KeysSize(orig->ma_keys);

PyDictKeysObject *keys = PyObject_Malloc(keys_size);

if (keys == NULL) {

PyErr_NoMemory();

return NULL;

}

memcpy(keys, orig->ma_keys, keys_size);

/* After copying key/value pairs, we need to incref all

keys and values and they are about to be co-owned by a

new dict object. */

PyDictKeyEntry *ep0 = DK_ENTRIES(keys);

Py_ssize_t n = keys->dk_nentries;

for (Py_ssize_t i = 0; i < n; i++) {

PyDictKeyEntry *entry = &ep0[i];

PyObject *value = entry->me_value;

if (value != NULL) {

Py_INCREF(value);

Py_INCREF(entry->me_key);

}

}

PyDictObject *new = (PyDictObject *)new_dict(keys, NULL);

if (new == NULL) {

/* In case of an error, `new_dict()` takes care of

cleaning up `keys`. */

return NULL;

}

new->ma_used = orig->ma_used;

ASSERT_CONSISTENT(new);

if (_PyObject_GC_IS_TRACKED(orig)) {

/* Maintain tracking. */

_PyObject_GC_TRACK(new);

}

/* Since we copied the keys table we now have an extra reference

in the system. Manually call _Py_INC_REFTOTAL to signal that

we have it now; calling dictkeys_incref would be an error as

keys->dk_refcnt is already set to 1 (after memcpy). */

_Py_INC_REFTOTAL;

return (PyObject *)new;

}

PyObject *

PyDict_New(void)

{

dictkeys_incref(Py_EMPTY_KEYS);

return new_dict(Py_EMPTY_KEYS, empty_values);

}

/* Search index of hash table from offset of entry table */

static Py_ssize_t

lookdict_index(PyDictKeysObject *k, Py_hash_t hash, Py_ssize_t index)

{

size_t mask = DK_MASK(k);

size_t perturb = (size_t)hash;

size_t i = (size_t)hash & mask;

for (;;) {

Py_ssize_t ix = dictkeys_get_index(k, i);

if (ix == index) {

return i;

}

if (ix == DKIX_EMPTY) {

return DKIX_EMPTY;

}

perturb >>= PERTURB_SHIFT;

i = mask & (i*5 + perturb + 1);

}

Py_UNREACHABLE();

}

/*

The basic lookup function used by all operations.

This is based on Algorithm D from Knuth Vol. 3, Sec. 6.4.

Open addressing is preferred over chaining since the link overhead for

chaining would be substantial (100% with typical malloc overhead).

The initial probe index is computed as hash mod the table size. Subsequent

probe indices are computed as explained earlier.

All arithmetic on hash should ignore overflow.

The details in this version are due to Tim Peters, building on many past

contributions by Reimer Behrends, Jyrki Alakuijala, Vladimir Marangozov and

Christian Tismer.

lookdict() is general-purpose, and may return DKIX_ERROR if (and only if) a

comparison raises an exception.

lookdict_unicode() below is specialized to string keys, comparison of which can

never raise an exception; that function can never return DKIX_ERROR when key

is string. Otherwise, it falls back to lookdict().

lookdict_unicode_nodummy is further specialized for string keys that cannot be

the <dummy> value.

For both, when the key isn't found a DKIX_EMPTY is returned.

*/

static Py_ssize_t _Py_HOT_FUNCTION

lookdict(PyDictObject *mp, PyObject *key,

Py_hash_t hash, PyObject **value_addr)

{

size_t i, mask, perturb;

PyDictKeysObject *dk;

PyDictKeyEntry *ep0;

top:

dk = mp->ma_keys;

ep0 = DK_ENTRIES(dk);

mask = DK_MASK(dk);

perturb = hash;

i = (size_t)hash & mask;

for (;;) {

Py_ssize_t ix = dictkeys_get_index(dk, i);

if (ix == DKIX_EMPTY) {

*value_addr = NULL;

return ix;

}

if (ix >= 0) {

PyDictKeyEntry *ep = &ep0[ix];

assert(ep->me_key != NULL);

if (ep->me_key == key) {

*value_addr = ep->me_value;

return ix;

}

if (ep->me_hash == hash) {

PyObject *startkey = ep->me_key;

Py_INCREF(startkey);

int cmp = PyObject_RichCompareBool(startkey, key, Py_EQ);

Py_DECREF(startkey);

if (cmp < 0) {

*value_addr = NULL;

return DKIX_ERROR;

}

if (dk == mp->ma_keys && ep->me_key == startkey) {

if (cmp > 0) {

*value_addr = ep->me_value;

return ix;

}

}

else {

/* The dict was mutated, restart */

goto top;

}

}

}

perturb >>= PERTURB_SHIFT;

i = (i*5 + perturb + 1) & mask;

}

Py_UNREACHABLE();

}

/* Specialized version for string-only keys */

static Py_ssize_t _Py_HOT_FUNCTION

lookdict_unicode(PyDictObject *mp, PyObject *key,

Py_hash_t hash, PyObject **value_addr)

{

assert(mp->ma_values == NULL);

/* Make sure this function doesn't have to handle non-unicode keys,

including subclasses of str; e.g., one reason to subclass

unicodes is to override __eq__, and for speed we don't cater to

that here. */

if (!PyUnicode_CheckExact(key)) {

mp->ma_keys->dk_lookup = lookdict;

return lookdict(mp, key, hash, value_addr);

}

PyDictKeyEntry *ep0 = DK_ENTRIES(mp->ma_keys);

size_t mask = DK_MASK(mp->ma_keys);

size_t perturb = (size_t)hash;

size_t i = (size_t)hash & mask;

for (;;) {

Py_ssize_t ix = dictkeys_get_index(mp->ma_keys, i);

if (ix == DKIX_EMPTY) {

*value_addr = NULL;

return DKIX_EMPTY;

}

if (ix >= 0) {

PyDictKeyEntry *ep = &ep0[ix];

assert(ep->me_key != NULL);

assert(PyUnicode_CheckExact(ep->me_key));

if (ep->me_key == key ||

(ep->me_hash == hash && unicode_eq(ep->me_key, key))) {

*value_addr = ep->me_value;

return ix;

}

}

perturb >>= PERTURB_SHIFT;

i = mask & (i*5 + perturb + 1);

}

Py_UNREACHABLE();

}

/* Faster version of lookdict_unicode when it is known that no <dummy> keys

* will be present. */

static Py_ssize_t _Py_HOT_FUNCTION

lookdict_unicode_nodummy(PyDictObject *mp, PyObject *key,

Py_hash_t hash, PyObject **value_addr)

{

assert(mp->ma_values == NULL);

/* Make sure this function doesn't have to handle non-unicode keys,

including subclasses of str; e.g., one reason to subclass

unicodes is to override __eq__, and for speed we don't cater to

that here. */

if (!PyUnicode_CheckExact(key)) {

mp->ma_keys->dk_lookup = lookdict;

return lookdict(mp, key, hash, value_addr);

}

PyDictKeyEntry *ep0 = DK_ENTRIES(mp->ma_keys);

size_t mask = DK_MASK(mp->ma_keys);

size_t perturb = (size_t)hash;

size_t i = (size_t)hash & mask;

for (;;) {

Py_ssize_t ix = dictkeys_get_index(mp->ma_keys, i);

assert (ix != DKIX_DUMMY);

if (ix == DKIX_EMPTY) {

*value_addr = NULL;

return DKIX_EMPTY;

}

PyDictKeyEntry *ep = &ep0[ix];

assert(ep->me_key != NULL);

assert(PyUnicode_CheckExact(ep->me_key));

if (ep->me_key == key ||

(ep->me_hash == hash && unicode_eq(ep->me_key, key))) {

*value_addr = ep->me_value;

return ix;

}

perturb >>= PERTURB_SHIFT;

i = mask & (i*5 + perturb + 1);

}

Py_UNREACHABLE();

}

/* Version of lookdict for split tables.

* All split tables and only split tables use this lookup function.

* Split tables only contain unicode keys and no dummy keys,

* so algorithm is the same as lookdict_unicode_nodummy.

*/

static Py_ssize_t _Py_HOT_FUNCTION

lookdict_split(PyDictObject *mp, PyObject *key,

Py_hash_t hash, PyObject **value_addr)

{

/* mp must split table */

assert(mp->ma_values != NULL);

if (!PyUnicode_CheckExact(key)) {

Py_ssize_t ix = lookdict(mp, key, hash, value_addr);

if (ix >= 0) {

*value_addr = mp->ma_values[ix];

}

return ix;

}

PyDictKeyEntry *ep0 = DK_ENTRIES(mp->ma_keys);

size_t mask = DK_MASK(mp->ma_keys);

size_t perturb = (size_t)hash;

size_t i = (size_t)hash & mask;

for (;;) {

Py_ssize_t ix = dictkeys_get_index(mp->ma_keys, i);

assert (ix != DKIX_DUMMY);

if (ix == DKIX_EMPTY) {

*value_addr = NULL;

return DKIX_EMPTY;

}

PyDictKeyEntry *ep = &ep0[ix];

assert(ep->me_key != NULL);

assert(PyUnicode_CheckExact(ep->me_key));

if (ep->me_key == key ||

(ep->me_hash == hash && unicode_eq(ep->me_key, key))) {

*value_addr = mp->ma_values[ix];

return ix;

}

perturb >>= PERTURB_SHIFT;

i = mask & (i*5 + perturb + 1);

}

Py_UNREACHABLE();

}

int

_PyDict_HasOnlyStringKeys(PyObject *dict)

{

Py_ssize_t pos = 0;

PyObject *key, *value;

assert(PyDict_Check(dict));

/* Shortcut */

if (((PyDictObject *)dict)->ma_keys->dk_lookup != lookdict)

return 1;

while (PyDict_Next(dict, &pos, &key, &value))

if (!PyUnicode_Check(key))

return 0;

return 1;

}

#define MAINTAIN_TRACKING(mp, key, value) \

do { \

if (!_PyObject_GC_IS_TRACKED(mp)) { \

if (_PyObject_GC_MAY_BE_TRACKED(key) || \

_PyObject_GC_MAY_BE_TRACKED(value)) { \

_PyObject_GC_TRACK(mp); \

} \

} \

} while(0)

void

_PyDict_MaybeUntrack(PyObject *op)

{

PyDictObject *mp;

PyObject *value;

Py_ssize_t i, numentries;

PyDictKeyEntry *ep0;

if (!PyDict_CheckExact(op) || !_PyObject_GC_IS_TRACKED(op))

return;

mp = (PyDictObject *) op;

ep0 = DK_ENTRIES(mp->ma_keys);

numentries = mp->ma_keys->dk_nentries;

if (_PyDict_HasSplitTable(mp)) {

for (i = 0; i < numentries; i++) {

if ((value = mp->ma_values[i]) == NULL)

continue;

if (_PyObject_GC_MAY_BE_TRACKED(value)) {

assert(!_PyObject_GC_MAY_BE_TRACKED(ep0[i].me_key));

return;

}

}

}

else {

for (i = 0; i < numentries; i++) {

if ((value = ep0[i].me_value) == NULL)

continue;

if (_PyObject_GC_MAY_BE_TRACKED(value) ||

_PyObject_GC_MAY_BE_TRACKED(ep0[i].me_key))

return;

}

}

_PyObject_GC_UNTRACK(op);

}

/* Internal function to find slot for an item from its hash

when it is known that the key is not present in the dict.

The dict must be combined. */

static Py_ssize_t