pthash 0.4.0

Rust bindings for PTHash
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289

// Copyright (C) 2024 The Software Heritage developers
// See the AUTHORS file at the top-level directory of this distribution
// License: GNU General Public License version 3, or any later version
// See top-level LICENSE file for more information

//! Structures used when [building a PHF](crate::Phf::build_in_internal_memory_from_bytes`)
//! ([`BuildTimings`] and [`BuildConfiguration`])

use std::path::PathBuf;
use std::pin::Pin;
use std::time::Duration;

use cxx::{let_cxx_string, Exception, UniquePtr};

use crate::hashing::Hash;
use crate::structs::build_timings;

type Result<T> = std::result::Result<T, Exception>;

#[cfg_attr(not(all(feature = "hash64", feature = "hash128")), allow(dead_code))]
#[cxx::bridge]
pub(crate) mod ffi {
    #[namespace = "pthash"]
    unsafe extern "C++" {
        include!("pthash.hpp");

        type build_configuration;
        type build_timings = crate::structs::build_timings;
        type hash64 = crate::structs::hash64;
        type hash128 = crate::structs::hash128;
    }

    #[namespace = "pthash_rs::concrete"]
    unsafe extern "C++" {
        include!("concrete.hpp");
        type internal_memory_builder_single_phf_64;
        type internal_memory_builder_single_phf_128;
        type internal_memory_builder_partitioned_phf_64;
        type internal_memory_builder_partitioned_phf_128;
    }

    #[namespace = "pthash_rs::utils"]
    unsafe extern "C++" {
        include!("pthash.hpp");
        include!("cpp-utils.hpp");

        #[cxx_name = "construct"]
        fn internal_memory_builder_single_phf_64_new(
        ) -> UniquePtr<internal_memory_builder_single_phf_64>;

        unsafe fn build_from_hashes(
            self: Pin<&mut internal_memory_builder_single_phf_64>,
            hashes: *const hash64,
            num_keys: u64,
            config: &build_configuration,
        ) -> Result<build_timings>;

        #[cxx_name = "construct"]
        fn internal_memory_builder_single_phf_128_new(
        ) -> UniquePtr<internal_memory_builder_single_phf_128>;

        unsafe fn build_from_hashes(
            self: Pin<&mut internal_memory_builder_single_phf_128>,
            hashes: *const hash128,
            num_keys: u64,
            config: &build_configuration,
        ) -> Result<build_timings>;

        #[cxx_name = "construct"]
        fn internal_memory_builder_partitioned_phf_64_new(
        ) -> UniquePtr<internal_memory_builder_partitioned_phf_64>;

        unsafe fn build_from_hashes(
            self: Pin<&mut internal_memory_builder_partitioned_phf_64>,
            hashes: *const hash64,
            num_keys: u64,
            config: &build_configuration,
        ) -> Result<build_timings>;

        #[cxx_name = "construct"]
        fn internal_memory_builder_partitioned_phf_128_new(
        ) -> UniquePtr<internal_memory_builder_partitioned_phf_128>;

        unsafe fn build_from_hashes(
            self: Pin<&mut internal_memory_builder_partitioned_phf_128>,
            hashes: *const hash128,
            num_keys: u64,
            config: &build_configuration,
        ) -> Result<build_timings>;
    }

    #[namespace = "pthash_rs::utils"]
    unsafe extern "C++" {
        include!("cpp-utils.hpp");
        #[cxx_name = "construct"]
        fn build_configuration_new() -> UniquePtr<build_configuration>;
    }

    #[namespace = "pthash_rs::accessors"]
    unsafe extern "C++" {
        include!("cpp-utils.hpp");

        #[rust_name = "build_configuration_get_c"]
        fn get_c(conf: &build_configuration) -> f64;
        #[rust_name = "build_configuration_set_c"]
        fn set_c(conf: &mut UniquePtr<build_configuration>, value: f64);

        #[rust_name = "build_configuration_get_alpha"]
        fn get_alpha(conf: &build_configuration) -> f64;
        #[rust_name = "build_configuration_set_alpha"]
        fn set_alpha(conf: &mut UniquePtr<build_configuration>, value: f64);

        #[rust_name = "build_configuration_get_num_partitions"]
        fn get_num_partitions(conf: &build_configuration) -> u64;
        #[rust_name = "build_configuration_set_num_partitions"]
        fn set_num_partitions(conf: &mut UniquePtr<build_configuration>, value: u64);

        #[rust_name = "build_configuration_get_num_buckets"]
        fn get_num_buckets(conf: &build_configuration) -> u64;
        #[rust_name = "build_configuration_set_num_buckets"]
        fn set_num_buckets(conf: &mut UniquePtr<build_configuration>, value: u64);

        #[rust_name = "build_configuration_get_num_threads"]
        fn get_num_threads(conf: &build_configuration) -> u64;
        #[rust_name = "build_configuration_set_num_threads"]
        fn set_num_threads(conf: &mut UniquePtr<build_configuration>, value: u64);

        #[rust_name = "build_configuration_get_seed"]
        fn get_seed(conf: &build_configuration) -> u64;
        #[rust_name = "build_configuration_set_seed"]
        fn set_seed(conf: &mut UniquePtr<build_configuration>, value: u64);

        #[rust_name = "build_configuration_get_ram"]
        fn get_ram(conf: &build_configuration) -> u64;
        #[rust_name = "build_configuration_set_ram"]
        fn set_ram(conf: &mut UniquePtr<build_configuration>, value: u64);

        #[rust_name = "build_configuration_set_tmp_dir"]
        fn set_tmp_dir(conf: &mut UniquePtr<build_configuration>, value: Pin<&mut CxxString>);

        #[rust_name = "build_configuration_set_minimal_output"]
        fn set_minimal_output(conf: &mut UniquePtr<build_configuration>, value: bool);

        #[rust_name = "build_configuration_get_verbose_output"]
        fn get_verbose_output(conf: &build_configuration) -> bool;
        #[rust_name = "build_configuration_set_verbose_output"]
        fn set_verbose_output(conf: &mut UniquePtr<build_configuration>, value: bool);
    }
}
#[cfg(feature = "hash64")]
pub(crate) use ffi::{
    hash64, internal_memory_builder_partitioned_phf_64, internal_memory_builder_single_phf_64,
};

#[cfg(feature = "hash128")]
pub(crate) use ffi::{
    hash128, internal_memory_builder_partitioned_phf_128, internal_memory_builder_single_phf_128,
};

pub(crate) trait Builder: Sized + cxx::memory::UniquePtrTarget {
    type Hash: Hash;

    fn new() -> UniquePtr<Self>;

    unsafe fn build_from_hashes(
        self: Pin<&mut Self>,
        hashes: *const Self::Hash,
        num_keys: u64,
        config: &ffi::build_configuration,
    ) -> Result<build_timings>;
}

macro_rules! impl_builder {
    ($type:ty, $hash:ty, $new:path,) => {
        impl Builder for $type {
            type Hash = $hash;

            fn new() -> UniquePtr<Self> {
                $new()
            }
            unsafe fn build_from_hashes(
                self: Pin<&mut Self>,
                hashes: *const Self::Hash,
                num_keys: u64,
                config: &ffi::build_configuration,
            ) -> Result<build_timings> {
                <$type>::build_from_hashes(self, hashes, num_keys, config)
            }
        }
    };
}

#[cfg(feature = "hash64")]
impl_builder!(
    internal_memory_builder_single_phf_64,
    hash64,
    ffi::internal_memory_builder_single_phf_64_new,
);

#[cfg(feature = "hash128")]
impl_builder!(
    internal_memory_builder_single_phf_128,
    hash128,
    ffi::internal_memory_builder_single_phf_128_new,
);

#[cfg(feature = "hash64")]
impl_builder!(
    internal_memory_builder_partitioned_phf_64,
    hash64,
    ffi::internal_memory_builder_partitioned_phf_64_new,
);

#[cfg(feature = "hash128")]
impl_builder!(
    internal_memory_builder_partitioned_phf_128,
    hash128,
    ffi::internal_memory_builder_partitioned_phf_128_new,
);

/// Parameter of
/// [`build_in_internal_memory_from_bytes`](crate::Phf::build_in_internal_memory_from_bytes)
#[derive(Clone, Debug, PartialEq)]
pub struct BuildConfiguration {
    pub c: f64,
    pub alpha: f64,
    pub num_partitions: u64,
    pub num_buckets: u64,
    pub num_threads: u64,
    pub seed: u64,
    pub ram: u64,
    pub tmp_dir: PathBuf,
    pub verbose_output: bool,
}

impl BuildConfiguration {
    pub fn new(tmp_dir: PathBuf) -> BuildConfiguration {
        let defaults = ffi::build_configuration_new();
        BuildConfiguration {
            c: ffi::build_configuration_get_c(&defaults),
            alpha: ffi::build_configuration_get_alpha(&defaults),
            num_partitions: ffi::build_configuration_get_num_partitions(&defaults),
            num_buckets: ffi::build_configuration_get_num_buckets(&defaults),
            num_threads: ffi::build_configuration_get_num_threads(&defaults),
            seed: ffi::build_configuration_get_seed(&defaults),
            ram: ffi::build_configuration_get_ram(&defaults),
            tmp_dir,
            verbose_output: ffi::build_configuration_get_verbose_output(&defaults),
        }
    }

    /// Returns pthash's native [`build_configuration`]
    pub(crate) fn to_ffi(&self, minimal_output: bool) -> UniquePtr<ffi::build_configuration> {
        let mut conf = ffi::build_configuration_new();
        ffi::build_configuration_set_c(&mut conf, self.c);
        ffi::build_configuration_set_alpha(&mut conf, self.alpha);
        ffi::build_configuration_set_num_partitions(&mut conf, self.num_partitions);
        ffi::build_configuration_set_num_buckets(&mut conf, self.num_buckets);
        ffi::build_configuration_set_num_threads(&mut conf, self.num_threads);
        ffi::build_configuration_set_seed(&mut conf, self.seed);
        ffi::build_configuration_set_ram(&mut conf, self.ram);
        let_cxx_string!(tmp_dir = self.tmp_dir.as_os_str().as_encoded_bytes());
        ffi::build_configuration_set_tmp_dir(&mut conf, tmp_dir);
        ffi::build_configuration_set_minimal_output(&mut conf, minimal_output);
        ffi::build_configuration_set_verbose_output(&mut conf, self.verbose_output);
        conf
    }
}

/// Result of
/// [`build_in_internal_memory_from_bytes`](crate::Phf::build_in_internal_memory_from_bytes)
#[derive(Clone, Debug, PartialEq)]
pub struct BuildTimings {
    pub partitioning_seconds: Duration,
    pub mapping_ordering_seconds: Duration,
    pub searching_seconds: Duration,
    pub encoding_seconds: Duration,
}

impl BuildTimings {
    pub(crate) fn from_ffi(timings: &build_timings) -> Self {
        BuildTimings {
            partitioning_seconds: Duration::from_secs_f64(timings.partitioning_seconds),
            mapping_ordering_seconds: Duration::from_secs_f64(timings.mapping_ordering_seconds),
            searching_seconds: Duration::from_secs_f64(timings.searching_seconds),
            encoding_seconds: Duration::from_secs_f64(timings.encoding_seconds),
        }
    }
}