[FEAT] Simulated Transport Implementation

.gitignore

@@ -0,0 +1,5 @@
+.obj/
+client/client
+server/server
+simulation/simulation
+NOTES.md

Makefile

@@ -7,16 +7,6 @@ CXX = g++
 LD = g++
 EXPAND = lib/tmpl/expand
 
-ERPC_PATH= "./third_party/eRPC"
-
-#ERPC_CFLAGS_RAW := -I $(ERPC_PATH)/src -DRAW=true
-#ERPC_LDFLAGS_RAW := -L $(ERPC_PATH)/build -lerpc -lnuma -ldl -lgflags -libverbs
-
-DPDK_LIBS := $(shell pkg-config --libs libdpdk)
-DPDK_CFLAGS := $(shell pkg-config --cflags libdpdk)
-ERPC_CFLAGS_DPDK := -I $(ERPC_PATH)/src -I $(ERPC_PATH)/third_party/asio/include $(DPDK_CFLAGS) -DERPC_DPDK=true -march=native
-ERPC_LDFLAGS_DPDK := -L $(ERPC_PATH)/build -lerpc -lnuma -ldl -lgflags -libverbs -lmlx4 -lmlx5 $(DPDK_LIBS)
-
 CFLAGS_WARNINGS:= -Wno-unused-function -Wno-nested-anon-types -Wno-keyword-macro -Wno-uninitialized
 
 # -fno-omit-frame-pointer is needed to get accurate flame graphs. See [1] for
@@ -27,9 +17,11 @@ CFLAGS := -g -Wall $(CFLAGS_WARNINGS) -iquote.obj/gen -O2 -DNASSERT -fno-omit-fr
 CXXFLAGS := -g -std=c++11
 LDFLAGS := -levent_pthreads -pthread -lboost_fiber -lboost_context -lboost_system -lboost_thread
 
-## Add ERPC flags ##
-CFLAGS += $(ERPC_CFLAGS_DPDK)
-LDFLAGS += $(ERPC_LDFLAGS_DPDK)
+## Add RPC flags ##
+RPC_CFLAGS := 
+RPC_LDFLAGS := -ldl -lgflags -libverbs
+CFLAGS += $(RPC_CFLAGS)
+LDFLAGS += $(RPC_LDFLAGS)
 
 ## Debian package: check ##
 #CHECK_CFLAGS := $(shell pkg-config --cflags check)
@@ -113,6 +105,9 @@ SRCS :=
 # TEST_SRCS is just like SRCS, but these source files will be compiled
 # with testing related flags.
 TEST_SRCS :=
+# SIM_SRCS is just like SRCS, but these source files will be compiled
+# with simulation related flags.
+SIM_SRCS :=
 # GTEST_SRCS is tests that use Google's testing framework
 GTEST_SRCS :=
 
@@ -127,6 +122,12 @@ BINS :=
 # using the appropriate flags.  This is also used as the list of tests
 # to run for the `test' target.
 TEST_BINS :=
+# SIM_BINS is like BINS, but for simulation binaries.  They will be linked
+# using the appropriate flags.  This is also used as the list of tests
+# to run for the `sim` target.
+# It is similar to test that it uses simulated tranpsort, but you can also 
+# provide manual inputs to it, as contrast to test
+SIM_BINS :=
 
 # add-CFLAGS is a utility macro that takes a space-separated list of
 # sources and a set of CFLAGS.  It sets the CFLAGS for each provided
@@ -147,6 +148,7 @@ include debug/Rules.mk
 include network/Rules.mk
 include client/Rules.mk
 include server/Rules.mk
+include simulation/Rules.mk
 #include replication/common/Rules.mk
 #include replication/meerkatir/Rules.mk
 #include replication/leadermeerkatir/Rules.mk
@@ -181,7 +183,7 @@ include server/Rules.mk
 DEPFLAGS = -M -MF ${@:.o=.d} -MP -MT $@ -MG
 
 # $(call add-CFLAGS,$(TEST_SRCS),$(CHECK_CFLAGS))
-OBJS := $(SRCS:%.cpp=.obj/%.o) $(TEST_SRCS:%.cpp=.obj/%.o) $(GTEST_SRCS:%.cpp=.obj/%.o)
+OBJS := $(SRCS:%.cpp=.obj/%.o) $(TEST_SRCS:%.cpp=.obj/%.o) $(GTEST_SRCS:%.cpp=.obj/%.o) $(SIM_SRCS:%.cpp=.obj/%.o)
 
 define compile
 	@mkdir -p $(dir $@)
@@ -223,8 +225,9 @@ $(PROTOOBJS:%.o=%-pic.o): .obj/%-pic.o: .obj/gen/%.pb.cc $(PROTOSRCS)
 #
 
 $(call add-LDFLAGS,$(TEST_BINS),$(CHECK_LDFLAGS))
+$(call add-LDFLAGS,$(SIM_BINS),$(CHECK_LDFLAGS))
 
-$(BINS) $(TEST_BINS): %:
+$(BINS) $(TEST_BINS) $(SIM_BINS): %:
 	$(call trace,LD,$@,$(LD) -o $@ $^ $(LDFLAGS) $(LDFLAGS-$@))
 
 #
@@ -256,7 +259,7 @@ $(GTEST_MAIN) : .obj/gtest/gtest-all.o .obj/gtest/gtest_main.o
 
 .PHONY: clean
 clean:
-	$(call trace,RM,binaries,rm -f $(BINS) $(TEST_BINS))
+	$(call trace,RM,binaries,rm -f $(BINS) $(TEST_BINS) $(SIM_BINS))
 	$(call trace,RM,objects,rm -rf .obj)
 
 #
@@ -270,16 +273,26 @@ print-%:
 #
 
 .PHONY: all
-all: $(BINS)
+all:
+	ERPC_PATH= "./third_party/eRPC"
+	DPDK_LIBS := $(shell pkg-config --libs libdpdk)
+	DPDK_CFLAGS := $(shell pkg-config --cflags libdpdk)
+	RPC_CFLAGS := -I $(ERPC_PATH)/src -I $(ERPC_PATH)/third_party/asio/include $(DPDK_CFLAGS) -DERPC_DPDK=true -march=native
+	RPC_LDFLAGS := -L $(ERPC_PATH)/build -lerpc -lnuma -ldl -lgflags -libverbs -lmlx4 -lmlx5 $(DPDK_LIBS)
+	$(BINS)
 
 $(TEST_BINS:%=run-%): run-%: %
 	$(call trace,RUN,$<,$<)
 
 $(TEST_BINS:%=gdb-%): gdb-%: %
 	$(call trace,GDB,$<,CK_FORK=no gdb $<)
 
+.PHONY: simulation
+simulation: $(SIM_BINS)
+
 .PHONY: test
 test: $(TEST_BINS:%=run-%)
+
 .PHONY: check
 check: test
 

README.md

@@ -1,2 +1,90 @@
 # Be-Tree
 A simple, reference implementation of a B^e-tree
+
+## Environments
+There are 3 different environments to run the implementation:
+* Production
+* Simulation
+* Testing
+
+### Production Environment
+The production environment is used on production. The RPC implementation of this envrionment uses eRPC. To be able to run on this environment, you need to build the eRPC, that is located under `third_party/eRPC` directory. 
+
+**Ubuntu Prerequisites**
+1. This implementation is tested and supported on Ubuntu OS. 
+2. Install the necessary Ubuntu packages to be able to run the implementation
+```
+sudo apt install make
+sudo apt install cmake
+sudo apt install libssl-dev
+sudo apt install libevent-dev
+sudo apt install libboost-all-dev
+sudo apt install libgtest-dev
+sudo apt-get install libgflags-dev
+sudo apt-get install libgoogle-glog-dev
+sudo apt install g++
+sudo apt-get install -y pkg-config
+```
+
+**Setup**
+1. Setup and do the necessary installations of the Ubuntu environment as specified above
+2. Build eRPC. For instructions to build eRPC, refer to the `third_party/eRPC` directory. 
+2. Do `make` to compile and build the code
+3. Do `./client/client` for the client machine to run the client code
+4. Do `./server/server --configFile==<config file name> --serverIndex==<intended index of the server>`
+    * An example configuration file is the file `config.txt` in the root directory. In this configuration file, there are 1 server spawned on one machine. In this example file, 
+        * Server index 0 indicates that this server instance will occupy the port 38450
+5. Enter the file system operations from the client side as needed. 
+
+### Simulation Environment
+The simulation environment tries to simulate the production environment and hence is similar to the production environment. The interactivity and custom input ability of file system operations should be maintained for this environment. 
+
+**Implementation Details**
+
+The main difference between this environment and the production environment is that it does not use the eRPC library, it simulates the transportation of message between the client and the server using a 'simulated transportation'.
+
+In the 'simulated transportation' implementation, there is a single transport object that is shared between the client and the server. Since the client and the server is actually located in the same runtime environment, the transport object is shared using variable sharing. 
+
+The image below illustrates the difference between the production and simulation environment. 
+
+![](assets/environment-comparison.png)
+
+In this environment, 
+* the number of server threads
+* the number of client threads
+* all requests from all clients will always be directed to one of the server threads throughout the whole simulation. Hence, there is actually no need to spawn more than one server threads. 
+* all requests from all clients will be handled one-by-one by that single server thread. Hence, it is not suitable for benchmarking.
+
+**Ubuntu Prerequisites**
+
+1. This implementation is tested and supported on Ubuntu OS. 
+2. Install the necessary Ubuntu packages to be able to run the implementation
+```
+sudo apt install make
+sudo apt install cmake
+sudo apt install libssl-dev
+sudo apt install libevent-dev
+sudo apt install libboost-all-dev
+sudo apt install libgtest-dev
+sudo apt-get install libgflags-dev
+sudo apt-get install libgoogle-glog-dev
+sudo apt install g++
+sudo apt-get install -y pkg-config
+```
+
+**Setup**
+
+1. Do `make simulation` to compile and build the simulation code. 
+2. Do `./simulation/simulation [--numClientThreadsSim=<number of client threads intended> --numServerThreadsSim=<number of server threads intended>` to run both the server and the client code.
+    * You can optionally specify the number of server threads or number of client threads to be spawned in this simulation environment. If these are not specified, its value will be defaulted to 1.
+3. Enter the file system operation as needed.
+
+### Testing Environment 
+The testing environment is for the purpose of testing the correctness of the implementation. There is no user input expected as the file system operations and its expected output has been defined beforehand.
+
+This environment is not yet implemented at the moment.
+
+## APIs
+The APIs that are currently supported by the server are:
+* `GetNodeId` 
+    * This returns the ID of the node of the server applications in the server that it resides. A single server can have multiple sever applications

client/storage_client.cpp

@@ -7,6 +7,7 @@
 //#include <sys/time.h>
 //#include <math.h>
 
+#include <cstring>
 #include <random>
 using namespace std;
 

client/storage_client.hpp

@@ -2,8 +2,8 @@
 #ifndef _STORAGE_CLIENT_H_
 #define _STORAGE_CLIENT_H_
 
-#include "network/fasttransport.hpp"
 #include "network/configuration.hpp"
+#include "network/transport.hpp"
 
 struct nodeid_t {
     uint32_t serverIdx;

common/gflags.hpp

@@ -5,6 +5,8 @@
 
 // Defines all the command line flags shared between both
 // severs and clients
+DEFINE_uint32(numServerThreadsSim, 1, "The number of server threads in the simulation environment");
+DEFINE_uint32(numClientThreadsSim, 1, "The number of client threads in the simulation environment");
 DEFINE_string(configFile, "", "Path to the configuration file");
 DEFINE_string(backingStoreDir, "", "Path to the backing store directory");
 DEFINE_string(benchmark, "", "Benchmark mode (benchmark-<mode>, mode = upserts|queries)");

network/Rules.mk

@@ -1,9 +1,11 @@
 d := $(dir $(lastword $(MAKEFILE_LIST)))
 
-SRCS += $(addprefix $(d), transport.cpp fasttransport.cpp configuration.cpp)
+SRCS += $(addprefix $(d), transport.cpp simtransport.cpp fasttransport.cpp configuration.cpp)
 
 LIB-configuration := $(o)configuration.o $(LIB-debug)
 
 LIB-transport := $(o)transport.o $(LIB-configuration) $(LIB-debug)
 
 LIB-fasttransport := $(o)fasttransport.o $(LIB-transport) $(LIB-debug)
+
+LIB-simtransport := $(LIB-transport) $(LIB-debug) $(o)simtransport.o

network/app_mem_pool.cpp

@@ -0,0 +1,29 @@
+// A basic mempool for preallocated objects of type T. eRPC has a faster,
+// hugepage-backed one.
+template <class T> class AppMemPool {
+    public:
+        size_t num_to_alloc = 1;
+        std::vector<T *> backing_ptr_vec;
+        std::vector<T *> pool;
+
+    void extend_pool() {
+        T *backing_ptr = new T[num_to_alloc];
+        for (size_t i = 0; i < num_to_alloc; i++) pool.push_back(&backing_ptr[i]);
+        backing_ptr_vec.push_back(backing_ptr);
+        num_to_alloc *= 2;
+    }
+
+    T *alloc() {
+        if (pool.empty()) extend_pool();
+        T *ret = pool.back();
+        pool.pop_back();
+        return ret;
+    }
+
+    void free(T *t) { pool.push_back(t); }
+
+    AppMemPool() {}
+    ~AppMemPool() {
+        for (T *ptr : backing_ptr_vec) delete[] ptr;
+    }
+};

network/configuration.cpp

@@ -27,6 +27,11 @@ ServerAddress::operator<(const ServerAddress &other) const {
     return this_t < other_t;
 }
 
+Configuration::Configuration() {
+    multicastAddress = new ServerAddress("", "");
+    n = 1;
+}
+
 Configuration::Configuration(const Configuration &c)
     : n(c.n), servers(c.servers), hasMulticast(c.hasMulticast)
 {

network/configuration.hpp

@@ -38,6 +38,10 @@ struct ServerAddress
 class Configuration
 {
 public:
+    /* Empty constructor for dummy configuration in simulation environment */
+    Configuration();
+
+    /* Non-empty constructors for real configuration */
     Configuration(const Configuration &c);
     Configuration(int n,
 //                  int f,

network/fasttransport.hpp

@@ -56,36 +56,6 @@ struct req_tag_t {
     TransportReceiver *src;
 };
 
-// A basic mempool for preallocated objects of type T. eRPC has a faster,
-// hugepage-backed one.
-template <class T> class AppMemPool {
-    public:
-        size_t num_to_alloc = 1;
-        std::vector<T *> backing_ptr_vec;
-        std::vector<T *> pool;
-
-    void extend_pool() {
-        T *backing_ptr = new T[num_to_alloc];
-        for (size_t i = 0; i < num_to_alloc; i++) pool.push_back(&backing_ptr[i]);
-        backing_ptr_vec.push_back(backing_ptr);
-        num_to_alloc *= 2;
-    }
-
-    T *alloc() {
-        if (pool.empty()) extend_pool();
-        T *ret = pool.back();
-        pool.pop_back();
-        return ret;
-    }
-
-    void free(T *t) { pool.push_back(t); }
-
-    AppMemPool() {}
-    ~AppMemPool() {
-        for (T *ptr : backing_ptr_vec) delete[] ptr;
-    }
-};
-
 // eRPC context passed between request and responses
 class AppContext {
     public:
@@ -118,6 +88,7 @@ class AppContext {
 class FastTransport : public Transport
 {
 public:
+    // TODO: I think we can remove the ip and phy_port argument here since we can get it from config?
     FastTransport(const network::Configuration &config,
                   std::string &ip,
                   int nthreads,