Added int2int/str2int memory-mappable hashmap based on 3rd pty Ankerl Hashmap (#222)

Author: weiliw-amz

THIRD-PARTY-LICENSES.txt

@@ -121,3 +121,27 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+
+------
+
+** ankerl; version 4.0.0 -- https://github.com/martinus/unordered_dense
+Copyright © 2022-2023 Martin Leitner-Ankerl. The code is licensed under the MIT
+License.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pecos/core/base.py

@@ -25,6 +25,7 @@
     c_int32,
     c_uint32,
     c_uint64,
+    c_size_t,
     c_void_p,
     cast,
 )
@@ -531,6 +532,7 @@ def __init__(self, dirname, soname, forced_rebuild=False):
         self.link_clustering()
         self.link_tfidf_vectorizer()
         self.link_ann_hnsw_methods()
+        self.link_mmap_hashmap_methods()
 
     def link_xlinear_methods(self):
         """
@@ -1699,5 +1701,84 @@ def ann_hnsw_init(self, data_type, metric_type):
             )
         return self.ann_hnsw_fn_dict[data_type, metric_type]
 
+    def link_mmap_hashmap_methods(self):
+        """
+        Specify C-lib's Memory-mappable Hashmap methods arguments and return types.
+        """
+        fn_prefix = "mmap_hashmap"
+        map_type_list = ["str2int", "int2int"]
+        key_args_dict = {
+            "str2int": [
+                c_char_p,  # pointer of key string
+                c_uint32,  # length of key string
+            ],
+            "int2int": [
+                c_uint64,  # key int64
+            ],
+        }
+        self.mmap_map_fn_dict = {}
+
+        for map_type in map_type_list:
+            local_fn_dict = {}
+
+            fn_name = "new"
+            local_fn_dict[fn_name] = getattr(self.clib_float32, f"{fn_prefix}_{fn_name}_{map_type}")
+            corelib.fillprototype(local_fn_dict[fn_name], c_void_p, None)
+
+            fn_name = "destruct"
+            local_fn_dict[fn_name] = getattr(self.clib_float32, f"{fn_prefix}_{fn_name}_{map_type}")
+            corelib.fillprototype(local_fn_dict[fn_name], None, [c_void_p])
+
+            fn_name = "save"
+            local_fn_dict[fn_name] = getattr(self.clib_float32, f"{fn_prefix}_{fn_name}_{map_type}")
+            corelib.fillprototype(local_fn_dict[fn_name], None, [c_void_p, c_char_p])
+
+            fn_name = "load"
+            local_fn_dict[fn_name] = getattr(self.clib_float32, f"{fn_prefix}_{fn_name}_{map_type}")
+            corelib.fillprototype(local_fn_dict[fn_name], c_void_p, [c_char_p, c_bool])
+
+            fn_name = "size"
+            local_fn_dict[fn_name] = getattr(self.clib_float32, f"{fn_prefix}_{fn_name}_{map_type}")
+            corelib.fillprototype(local_fn_dict[fn_name], c_size_t, [c_void_p])
+
+            # Fill insert & get
+            fn_name = "insert"
+            local_fn_dict[fn_name] = getattr(self.clib_float32, f"{fn_prefix}_{fn_name}_{map_type}")
+            corelib.fillprototype(
+                local_fn_dict[fn_name], None, [c_void_p] + key_args_dict[map_type] + [c_uint64]
+            )
+
+            fn_name = "get"
+            local_fn_dict[fn_name] = getattr(self.clib_float32, f"{fn_prefix}_{fn_name}_{map_type}")
+            corelib.fillprototype(
+                local_fn_dict[fn_name], c_uint64, [c_void_p] + key_args_dict[map_type]
+            )
+
+            fn_name = "get_w_default"
+            local_fn_dict[fn_name] = getattr(self.clib_float32, f"{fn_prefix}_{fn_name}_{map_type}")
+            corelib.fillprototype(
+                local_fn_dict[fn_name], c_uint64, [c_void_p] + key_args_dict[map_type] + [c_uint64]
+            )
+
+            fn_name = "contains"
+            local_fn_dict[fn_name] = getattr(self.clib_float32, f"{fn_prefix}_{fn_name}_{map_type}")
+            corelib.fillprototype(
+                local_fn_dict[fn_name], c_bool, [c_void_p] + key_args_dict[map_type]
+            )
+
+            self.mmap_map_fn_dict[map_type] = local_fn_dict
+
+    def mmap_hashmap_init(self, map_type):
+        """Python to C/C++ interface for Memory-mappable Hashmap initialization
+        Args:
+            map_type (string): Type of Hashmap.
+        Returns:
+            mmap_map_fn_dict (dict): a dictionary that holds clib's C/C++ functions for Python to call
+        """
+
+        if map_type not in self.mmap_map_fn_dict:
+            raise NotImplementedError(f"map_type={map_type} is not implemented.")
+        return self.mmap_map_fn_dict[map_type]
+
 
 clib = corelib(os.path.join(os.path.dirname(os.path.abspath(pecos.__file__)), "core"), "libpecos")

pecos/core/libpecos.cpp

@@ -13,6 +13,7 @@
 
 #include "utils/clustering.hpp"
 #include "utils/matrix.hpp"
+#include "utils/mmap_hashmap.hpp"
 #include "utils/tfidf.hpp"
 #include "utils/parallel.hpp"
 #include "xmc/inference.hpp"
@@ -474,4 +475,73 @@ extern "C" {
     C_ANN_HNSW_PREDICT(_csr_ip_f32, ScipyCsrF32, pecos::csr_t, hnsw_csr_ip_t)
     C_ANN_HNSW_PREDICT(_csr_l2_f32, ScipyCsrF32, pecos::csr_t, hnsw_csr_l2_t)
 
+    // ==== C Interface of Memory-mappable Hashmap ====
+
+    typedef pecos::mmap_hashmap::Str2IntMap mmap_hashmap_str2int;
+    typedef pecos::mmap_hashmap::Int2IntMap mmap_hashmap_int2int;
+
+    // New
+    #define MMAP_MAP_NEW(SUFFIX) \
+    void* mmap_hashmap_new_ ## SUFFIX () { \
+    return static_cast<void*>(new mmap_hashmap_ ## SUFFIX()); }
+    MMAP_MAP_NEW(str2int)
+    MMAP_MAP_NEW(int2int)
+
+    // Destruct
+    #define MMAP_MAP_DESTRUCT(SUFFIX) \
+    void mmap_hashmap_destruct_ ## SUFFIX (void* map_ptr) { \
+    delete static_cast<mmap_hashmap_ ## SUFFIX *>(map_ptr); }
+    MMAP_MAP_DESTRUCT(str2int)
+    MMAP_MAP_DESTRUCT(int2int)
+
+    // Save
+    #define MMAP_MAP_SAVE(SUFFIX) \
+    void mmap_hashmap_save_ ## SUFFIX (void* map_ptr, const char* map_dir) { \
+    static_cast<mmap_hashmap_ ## SUFFIX *>(map_ptr)->save(map_dir); }
+    MMAP_MAP_SAVE(str2int)
+    MMAP_MAP_SAVE(int2int)
+
+    // Load
+    #define MMAP_MAP_LOAD(SUFFIX) \
+    void* mmap_hashmap_load_ ## SUFFIX (const char* map_dir, const bool lazy_load) { \
+    mmap_hashmap_ ## SUFFIX * map_ptr = new mmap_hashmap_ ## SUFFIX(); \
+    map_ptr->load(map_dir, lazy_load); \
+    return static_cast<void *>(map_ptr); }
+    MMAP_MAP_LOAD(str2int)
+    MMAP_MAP_LOAD(int2int)
+
+    // Size
+    #define MMAP_MAP_SIZE(SUFFIX) \
+    size_t mmap_hashmap_size_ ## SUFFIX (void* map_ptr) { \
+    return static_cast<mmap_hashmap_ ## SUFFIX *>(map_ptr)->size(); }
+    MMAP_MAP_SIZE(str2int)
+    MMAP_MAP_SIZE(int2int)
+
+    // Insert
+    #define KEY_SINGLE_ARG(A,B) A,B
+    #define MMAP_MAP_INSERT(SUFFIX, KEY, FUNC_CALL_KEY) \
+    void mmap_hashmap_insert_  ## SUFFIX (void* map_ptr, KEY, uint64_t val) { \
+        static_cast<mmap_hashmap_ ## SUFFIX *>(map_ptr)->insert(FUNC_CALL_KEY, val); }
+    MMAP_MAP_INSERT(str2int, KEY_SINGLE_ARG(const char* key, uint32_t key_len), KEY_SINGLE_ARG(key, key_len))
+    MMAP_MAP_INSERT(int2int, uint64_t key, key)
+
+    // Get
+    #define MMAP_MAP_GET(SUFFIX, KEY, FUNC_CALL_KEY) \
+    uint64_t mmap_hashmap_get_  ## SUFFIX (void* map_ptr, KEY) { \
+        return static_cast<mmap_hashmap_ ## SUFFIX *>(map_ptr)->get(FUNC_CALL_KEY); }
+    MMAP_MAP_GET(str2int, KEY_SINGLE_ARG(const char* key, uint32_t key_len), KEY_SINGLE_ARG(key, key_len))
+    MMAP_MAP_GET(int2int, uint64_t key, key)
+
+    #define MMAP_MAP_GET_W_DEFAULT(SUFFIX, KEY, FUNC_CALL_KEY) \
+    uint64_t mmap_hashmap_get_w_default_  ## SUFFIX (void* map_ptr, KEY, uint64_t def_val) { \
+        return static_cast<mmap_hashmap_ ## SUFFIX *>(map_ptr)->get_w_default(FUNC_CALL_KEY, def_val); }
+    MMAP_MAP_GET_W_DEFAULT(str2int, KEY_SINGLE_ARG(const char* key, uint32_t key_len), KEY_SINGLE_ARG(key, key_len))
+    MMAP_MAP_GET_W_DEFAULT(int2int, uint64_t key, key)
+
+    // Contains
+    #define MMAP_MAP_CONTAINS(SUFFIX, KEY, FUNC_CALL_KEY) \
+    bool mmap_hashmap_contains_  ## SUFFIX (void* map_ptr, KEY) { \
+        return static_cast<mmap_hashmap_ ## SUFFIX *>(map_ptr)->contains(FUNC_CALL_KEY); }
+    MMAP_MAP_CONTAINS(str2int, KEY_SINGLE_ARG(const char* key, uint32_t key_len), KEY_SINGLE_ARG(key, key_len))
+    MMAP_MAP_CONTAINS(int2int, uint64_t key, key)
 }