feat(db): Add mdbx-rs apache licenced code 55e234 (#132)

Author: rakita

crates/libmdbx-rs/Cargo.toml

@@ -0,0 +1,45 @@
+[package]
+name = "libmdbx"
+version = "0.1.6"
+edition = "2021"
+license = "Apache-2.0"
+description = "Idiomatic and safe MDBX wrapper."
+documentation = "https://docs.rs/libmdbx"
+homepage = "https://github.com/vorot93/libmdbx-rs"
+repository = "https://github.com/vorot93/libmdbx-rs"
+readme = "README.md"
+keywords = ["LMDB", "MDBX", "database", "storage-engine", "bindings"]
+categories = ["database"]
+
+[lib]
+name = "libmdbx"
+
+[workspace]
+members = ["mdbx-sys"]
+
+[dependencies]
+bitflags = "1"
+byteorder = "1"
+derive_more = "0.99"
+indexmap = "1"
+libc = "0.2"
+parking_lot = "0.12"
+thiserror = "1"
+
+ffi = { package = "mdbx-sys", version = "=0.11.8-0", path = "./mdbx-sys" }
+
+lifetimed-bytes = { version = "0.1", optional = true }
+
+[dev-dependencies]
+criterion = "0.3"
+rand = "0.8"
+rand_xorshift = "0.3"
+tempfile = "3"
+
+[[bench]]
+name = "cursor"
+harness = false
+
+[[bench]]
+name = "transaction"
+harness = false

crates/libmdbx-rs/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2014 Dan Burkert
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

crates/libmdbx-rs/README.md

@@ -0,0 +1,21 @@
+# libmdbx-rs
+
+Rust bindings for [libmdbx](https://libmdbx.dqdkfa.ru).
+
+## Updating the libmdbx Version
+
+To update the libmdbx version you must clone it and copy the `dist/` folder in `mdbx-sys/`.
+Make sure to follow the [building steps](https://libmdbx.dqdkfa.ru/usage.html#getting).
+
+```bash
+# clone libmmdbx to a repository outside at specific tag
+git clone https://gitflic.ru/project/erthink/libmdbx.git ../libmdbx --branch v0.7.0
+make -C ../libmdbx dist
+
+# copy the `libmdbx/dist/` folder just created into `mdbx-sys/libmdbx`
+rm -rf mdbx-sys/libmdbx
+cp -R ../libmdbx/dist mdbx-sys/libmdbx
+
+# add the changes to the next commit you will make
+git add mdbx-sys/libmdbx
+```

crates/libmdbx-rs/benches/cursor.rs

@@ -0,0 +1,120 @@
+mod utils;
+
+use criterion::{black_box, criterion_group, criterion_main, Criterion};
+use ffi::*;
+use libmdbx::*;
+use std::ptr;
+use utils::*;
+
+/// Benchmark of iterator sequential read performance.
+fn bench_get_seq_iter(c: &mut Criterion) {
+    let n = 100;
+    let (_dir, env) = setup_bench_db(n);
+    let txn = env.begin_ro_txn().unwrap();
+    let db = txn.open_db(None).unwrap();
+
+    c.bench_function("bench_get_seq_iter", |b| {
+        b.iter(|| {
+            let mut cursor = txn.cursor(&db).unwrap();
+            let mut i = 0;
+            let mut count = 0u32;
+
+            for (key_len, data_len) in cursor
+                .iter::<ObjectLength, ObjectLength>()
+                .map(Result::unwrap)
+            {
+                i = i + *key_len + *data_len;
+                count += 1;
+            }
+            for (key_len, data_len) in cursor
+                .iter::<ObjectLength, ObjectLength>()
+                .filter_map(Result::ok)
+            {
+                i = i + *key_len + *data_len;
+                count += 1;
+            }
+
+            fn iterate<K: TransactionKind>(cursor: &mut Cursor<'_, K>) -> Result<()> {
+                let mut i = 0;
+                for result in cursor.iter::<ObjectLength, ObjectLength>() {
+                    let (key_len, data_len) = result?;
+                    i = i + *key_len + *data_len;
+                }
+                Ok(())
+            }
+            iterate(&mut cursor).unwrap();
+
+            black_box(i);
+            assert_eq!(count, n);
+        })
+    });
+}
+
+/// Benchmark of cursor sequential read performance.
+fn bench_get_seq_cursor(c: &mut Criterion) {
+    let n = 100;
+    let (_dir, env) = setup_bench_db(n);
+    let txn = env.begin_ro_txn().unwrap();
+    let db = txn.open_db(None).unwrap();
+
+    c.bench_function("bench_get_seq_cursor", |b| {
+        b.iter(|| {
+            let (i, count) = txn
+                .cursor(&db)
+                .unwrap()
+                .iter::<ObjectLength, ObjectLength>()
+                .map(Result::unwrap)
+                .fold((0, 0), |(i, count), (key, val)| {
+                    (i + *key + *val, count + 1)
+                });
+
+            black_box(i);
+            assert_eq!(count, n);
+        })
+    });
+}
+
+/// Benchmark of raw MDBX sequential read performance (control).
+fn bench_get_seq_raw(c: &mut Criterion) {
+    let n = 100;
+    let (_dir, env) = setup_bench_db(n);
+
+    let dbi = env.begin_ro_txn().unwrap().open_db(None).unwrap().dbi();
+    let _txn = env.begin_ro_txn().unwrap();
+    let txn = _txn.txn();
+
+    let mut key = MDBX_val {
+        iov_len: 0,
+        iov_base: ptr::null_mut(),
+    };
+    let mut data = MDBX_val {
+        iov_len: 0,
+        iov_base: ptr::null_mut(),
+    };
+    let mut cursor: *mut MDBX_cursor = ptr::null_mut();
+
+    c.bench_function("bench_get_seq_raw", |b| {
+        b.iter(|| unsafe {
+            mdbx_cursor_open(txn, dbi, &mut cursor);
+            let mut i = 0;
+            let mut count = 0u32;
+
+            while mdbx_cursor_get(cursor, &mut key, &mut data, MDBX_NEXT) == 0 {
+                i += key.iov_len + data.iov_len;
+                count += 1;
+            }
+
+            black_box(i);
+            assert_eq!(count, n);
+            mdbx_cursor_close(cursor);
+        })
+    });
+}
+
+criterion_group!(
+    benches,
+    bench_get_seq_iter,
+    bench_get_seq_cursor,
+    bench_get_seq_raw
+);
+criterion_main!(benches);