From d2ed2c114a138866b05cfcefb3034581a650b9c5 Mon Sep 17 00:00:00 2001 From: svaderia Date: Mon, 24 Mar 2025 19:08:45 -0600 Subject: [PATCH] (chore) Added some steps into the README --- README.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/README.md b/README.md index c742c34..0ee7752 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,42 @@ A repository exploring the cost-benefit of sorting accesses to a bloom filter for high-selectivity filtering workloads + +## Enable huge pages on linux +```bash +# First check if you have huge page support and how many huge pages are available +# meminfo also has other interesting information +grep -i hugepages /proc/meminfo + +# The output may look something like below +# AnonHugePages: 0 kB +# ShmemHugePages: 0 kB +# FileHugePages: 0 kB +# HugePages_Total: 200 +# HugePages_Free: 200 +# HugePages_Rsvd: 0 +# HugePages_Surp: 0 +# Hugepagesize: 2048 kB + +# If you see HugePages_Total is zero then it means you don't have huge pages you +# could use. +# Do following to add more new pages for yourself. You might need sudo +echo 200 > /proc/sys/vm/nr_hugepages +``` + +## Building + +```bash +# Building rust codebase +cargo build --release + +# Run the binary +./target/release/sortbloom + + +# building c code base +cd hashtest_cxx +make + +./bloomtest +```