Tue, 28 Mar 2023 21:00:33 +0200
allow NULL for allocator and comparator
universe@563 | 1 | /* |
universe@563 | 2 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. |
universe@563 | 3 | * |
universe@563 | 4 | * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved. |
universe@563 | 5 | * |
universe@563 | 6 | * Redistribution and use in source and binary forms, with or without |
universe@563 | 7 | * modification, are permitted provided that the following conditions are met: |
universe@563 | 8 | * |
universe@563 | 9 | * 1. Redistributions of source code must retain the above copyright |
universe@563 | 10 | * notice, this list of conditions and the following disclaimer. |
universe@563 | 11 | * |
universe@563 | 12 | * 2. Redistributions in binary form must reproduce the above copyright |
universe@563 | 13 | * notice, this list of conditions and the following disclaimer in the |
universe@563 | 14 | * documentation and/or other materials provided with the distribution. |
universe@563 | 15 | * |
universe@563 | 16 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
universe@563 | 17 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
universe@563 | 18 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
universe@563 | 19 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
universe@563 | 20 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
universe@563 | 21 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
universe@563 | 22 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
universe@563 | 23 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
universe@563 | 24 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
universe@563 | 25 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
universe@563 | 26 | * POSSIBILITY OF SUCH DAMAGE. |
universe@563 | 27 | */ |
universe@563 | 28 | /** |
universe@563 | 29 | * \file hash_key.h |
universe@563 | 30 | * \brief Interface for map implementations. |
universe@563 | 31 | * \author Mike Becker |
universe@563 | 32 | * \author Olaf Wintermann |
universe@563 | 33 | * \version 3.0 |
universe@563 | 34 | * \copyright 2-Clause BSD License |
universe@563 | 35 | */ |
universe@563 | 36 | |
universe@563 | 37 | |
universe@563 | 38 | #ifndef UCX_HASH_KEY_H |
universe@563 | 39 | #define UCX_HASH_KEY_H |
universe@563 | 40 | |
universe@563 | 41 | #include "stddef.h" |
universe@563 | 42 | |
universe@563 | 43 | #ifdef __cplusplus |
universe@563 | 44 | extern "C" { |
universe@563 | 45 | #endif |
universe@563 | 46 | |
universe@563 | 47 | /** Internal structure for a key within a hash map. */ |
universe@563 | 48 | struct cx_hash_key_s { |
universe@563 | 49 | /** The key data. */ |
universe@563 | 50 | union { |
universe@563 | 51 | unsigned char *bytes; |
universe@563 | 52 | unsigned char const *cbytes; |
universe@603 | 53 | char *str; |
universe@563 | 54 | char const *cstr; |
universe@563 | 55 | void *obj; |
universe@603 | 56 | void const *cobj; |
universe@563 | 57 | } data; |
universe@563 | 58 | /** |
universe@563 | 59 | * The key data length. |
universe@563 | 60 | */ |
universe@563 | 61 | size_t len; |
universe@563 | 62 | /** The hash value of the key data. */ |
universe@563 | 63 | unsigned hash; |
universe@563 | 64 | }; |
universe@563 | 65 | |
universe@563 | 66 | /** |
universe@563 | 67 | * Type for a hash key. |
universe@563 | 68 | */ |
universe@563 | 69 | typedef struct cx_hash_key_s CxHashKey; |
universe@563 | 70 | |
universe@563 | 71 | /** |
universe@604 | 72 | * Computes a murmur2 32 bit hash. |
universe@563 | 73 | * |
universe@604 | 74 | * You need to initialize \c data and \c len in the key struct. |
universe@563 | 75 | * The hash is then directly written to that struct. |
universe@563 | 76 | * |
universe@604 | 77 | * \note If \c data is \c NULL, the hash is defined as 1574210520. |
universe@604 | 78 | * |
universe@563 | 79 | * @param key the key, the hash shall be computed for |
universe@563 | 80 | */ |
universe@563 | 81 | void cx_hash_murmur(CxHashKey *key); |
universe@563 | 82 | |
universe@563 | 83 | /** |
universe@563 | 84 | * Computes a hash key from a string. |
universe@563 | 85 | * |
universe@563 | 86 | * The string needs to be zero-terminated. |
universe@563 | 87 | * |
universe@563 | 88 | * @param str the string |
universe@563 | 89 | * @return the hash key |
universe@563 | 90 | */ |
universe@563 | 91 | __attribute__((__warn_unused_result__)) |
universe@563 | 92 | CxHashKey cx_hash_key_str(char const *str); |
universe@563 | 93 | |
universe@563 | 94 | /** |
universe@563 | 95 | * Computes a hash key from a byte array. |
universe@563 | 96 | * |
universe@563 | 97 | * @param bytes the array |
universe@563 | 98 | * @param len the length |
universe@563 | 99 | * @return the hash key |
universe@563 | 100 | */ |
universe@563 | 101 | __attribute__((__warn_unused_result__)) |
universe@563 | 102 | CxHashKey cx_hash_key_bytes( |
universe@563 | 103 | unsigned char const *bytes, |
universe@563 | 104 | size_t len |
universe@563 | 105 | ); |
universe@563 | 106 | |
universe@563 | 107 | /** |
universe@563 | 108 | * Computes a hash key for an arbitrary object. |
universe@563 | 109 | * |
universe@563 | 110 | * The computation uses the in-memory representation that might not be |
universe@563 | 111 | * the same on different platforms. Therefore, this hash should not be |
universe@563 | 112 | * used for data exchange with different machines. |
universe@563 | 113 | * |
universe@563 | 114 | * @param obj a pointer to an arbitrary object |
universe@563 | 115 | * @param len the length of object in memory |
universe@563 | 116 | * @return the hash key |
universe@563 | 117 | */ |
universe@563 | 118 | __attribute__((__warn_unused_result__)) |
universe@563 | 119 | CxHashKey cx_hash_key( |
universe@603 | 120 | void const *obj, |
universe@563 | 121 | size_t len |
universe@563 | 122 | ); |
universe@563 | 123 | |
universe@663 | 124 | /** |
universe@663 | 125 | * Computes a hash key from a UCX string. |
universe@663 | 126 | * |
universe@663 | 127 | * @param str the string |
universe@663 | 128 | * @return the hash key |
universe@663 | 129 | */ |
universe@663 | 130 | #define cx_hash_key_cxstr(str) cx_hash_key((void*)(str).ptr, (str).length) |
universe@663 | 131 | |
universe@563 | 132 | #ifdef __cplusplus |
universe@563 | 133 | } // extern "C" |
universe@563 | 134 | #endif |
universe@563 | 135 | |
universe@628 | 136 | #endif // UCX_HASH_KEY_H |