pmdk_sys/
obj.rs

1//
2// Copyright (c) 2019 RepliXio Ltd. All rights reserved.
3// Use is subject to license terms.
4//
5
6use libc::{c_char, c_int, c_void, mode_t};
7
8use crate::PMEMoid;
9
10pub enum PMEMobjpool {}
11
12#[allow(non_camel_case_types)]
13pub type pmemobj_constr =
14    unsafe extern "C" fn(pop: *mut PMEMobjpool, ptr: *mut c_void, arg: *mut c_void) -> c_int;
15
16#[link(name = "pmemobj", kind = "static")]
17extern "C" {
18    pub fn pmemobj_open(path: *const c_char, layout: *const c_char) -> *mut PMEMobjpool;
19    pub fn pmemobj_create(
20        path: *const c_char,
21        layout: *const c_char,
22        poolsize: usize,
23        mode: mode_t,
24    ) -> *mut PMEMobjpool;
25    pub fn pmemobj_close(pop: *mut PMEMobjpool);
26
27    // Object
28
29    pub fn pmemobj_alloc(
30        pop: *mut PMEMobjpool,
31        oidp: *mut PMEMoid,
32        size: usize,
33        type_num: u64,
34        constructor: Option<pmemobj_constr>,
35        arg: *mut c_void,
36    ) -> c_int;
37    pub fn pmemobj_alloc_usable_size(oid: PMEMoid) -> usize;
38    pub fn pmemobj_free(oidp: *mut PMEMoid);
39
40    pub fn pmemobj_memcpy_persist(
41        pop: *mut PMEMobjpool,
42        dest: *mut c_void,
43        src: *const c_void,
44        len: usize,
45    );
46    pub fn pmemobj_memset_persist(pop: *mut PMEMobjpool, dest: *mut c_void, c: c_int, len: usize);
47    pub fn pmemobj_persist(pop: *mut PMEMobjpool, addr: *const c_void, len: usize);
48    pub fn pmemobj_flush(pop: *mut PMEMobjpool, addr: *const c_void, len: usize);
49    pub fn pmemobj_drain(pop: *mut PMEMobjpool);
50
51    // Error handling:
52
53    pub fn pmemobj_errormsg() -> *const c_char;
54
55    // translates persistent (pool-id, offset) to transient pointer
56    pub fn pmemobj_direct(oid: PMEMoid) -> *mut c_void;
57
58    // translates pointer to (pool-id, offset)
59    pub fn pmemobj_oid(addr: *const c_void) -> PMEMoid;
60
61    // extra u64 payload per object
62    pub fn pmemobj_type_num(oid: PMEMoid) -> u64;
63
64    // iterator, no gurantee over consitency
65    pub fn pmemobj_first(pop: *const PMEMobjpool) -> PMEMoid;
66    pub fn pmemobj_next(oid: PMEMoid) -> PMEMoid;
67
68    // control memory allocation ect
69    pub fn pmemobj_ctl_exec(pop: *mut PMEMobjpool, name: *const c_char, arg: *mut c_void) -> c_int;
70    pub fn pmemobj_ctl_get(pop: *mut PMEMobjpool, name: *const c_char, arg: *mut c_void) -> c_int;
71    pub fn pmemobj_ctl_set(pop: *mut PMEMobjpool, name: *const c_char, arg: *mut c_void) -> c_int;
72}
73
74// an optimization can be
75// 1. that pool can be loaded to the same memory space
76// 2. if we know that a key belongs to a specific volume, and it owns its pool, than we don't need pool id in key.
77// 3. pointer-to-offset calculation
pmdk_sys/obj.rs

pmdk_sys/
obj.rs
