Merge pull request #1070 from JanDorniak99/fix_radix_benchmark

add readme to benchmarks and fix dividing by zero in radix bench

Author: igchor

benchmarks/concurrent_hash_map/insert_open.cpp

@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: BSD-3-Clause
-/* Copyright 2020, Intel Corporation */
+/* Copyright 2020-2021, Intel Corporation */
 
 /*
- * insert_open.cpp -- this simple benchmarks is used to measure time of
+ * insert_open.cpp -- this simple benchmark is used to measure time of
  * inserting specified number of elements and time of runtime_initialize().
  */
 

benchmarks/radix/radix_tree.cpp

@@ -51,6 +51,11 @@ print_time_per_element(std::string msg,
 		       std::chrono::nanoseconds::rep total_time,
 		       size_t n_elements)
 {
+	if (n_elements == 0) {
+		throw std::invalid_argument(
+			"Benchmark failed, wrong params passed.");
+	}
+
 	std::cout << msg << static_cast<size_t>(total_time) / n_elements << "ns"
 		  << std::endl;
 }
@@ -200,12 +205,28 @@ main(int argc, char *argv[])
 	}
 
 	const char *path = argv[1];
-	if (argc > 2)
+	if (argc > 2) {
 		params.count = std::stoul(argv[2]);
-	if (argc > 3)
+		if (params.count == 0) {
+			std::cerr << "Number of the elements must be > 0"
+				  << std::endl;
+			return 1;
+		}
+	}
+	if (argc > 3) {
 		params.batch_size = std::stoul(argv[3]);
-	if (argc > 4)
+		if (params.batch_size == 0) {
+			std::cerr << "Batch size must be > 0" << std::endl;
+			return 1;
+		}
+	}
+	if (argc > 4) {
 		params.sample_size = std::stoul(argv[4]);
+		if (params.sample_size == 0) {
+			std::cerr << "Sample size must be > 0" << std::endl;
+			return 1;
+		}
+	}
 
 	std::cout << "Radix benchmark, count: " << params.count
 		  << ", batch_size: " << params.batch_size

benchmarks/readme.md

@@ -0,0 +1,39 @@
+# Benchmarks
+
+These benchmarks allow measuring some operations in the libpmemobj-cpp.
+
+Currently following benchmarks are available:
+- **concurrent_hash_map_insert_open**: this benchmark is used to measure time of inserting specified number of elements and time of `runtime_initialize()` in concurrent hash map.
+- **radix_tree**: this benchmark is used to compare times of basic operations in radix_tree and std::map.
+- **self_relative_pointer_assignment**: this benchmark is used to measure time of the assignment operator and the swap function for persistent_ptr and self_relative_ptr.
+- **self_relative_pointer_get**: this benchmark is used to measure time of accessing and changing a specified number of elements from a persistent array using self_relative_ptr and persistent_ptr.
+
+## Compiling
+
+Follow build steps for your OS (as described in top-level README), just make sure that the BUILD_BENCHMARKS option is ON.
+
+To build all benchmarks (when you are in a build dir):
+```sh
+$ cd benchmarks
+$ make
+```
+
+To build a certain benchmark (when you are in a build dir):
+```sh
+$ cd benchmarks
+$ make benchmark-<name_of_benchmark>
+```
+
+## Running
+
+**Warning:**
+>These benchmarks shouldn't be run in a production environment, because they can remove/modify existing data in the tested containers.
+
+Each benchmark can require various input parameters. If you want to see the usage of a certain benchmark, just run this benchmark's binary without any parameters, e.g.
+```sh
+$ ./benchmark-radix_tree
+```
+For example radix_tree benchmark needs following parameters: file_name \[count] \[batch_size] \[sample_size]. Example execution:
+```sh
+$ ./benchmark-radix_tree my_pool 20000 200 2000
+```

benchmarks/self_relative_pointer/assignment.cpp

@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: BSD-3-Clause
-/* Copyright 2020, Intel Corporation */
+/* Copyright 2020-2021, Intel Corporation */
 
 /*
- * assignment.cpp -- this benchmarks is used to measure time of
+ * assignment.cpp -- this benchmark is used to measure time of
  * the assignment operator and the swap function for persistent_ptr and
  * self_relative_ptr
  */