NICA: memcached AFU

Based on 3d78b50

Author: haggaie

CMakeLists.txt

@@ -53,6 +53,7 @@ find_package(Threads REQUIRED)
 link_directories(../googletest/googlemock/gtest)
 
 if(BUILD_SOFTWARE)
+    add_subdirectory(libnica)
     add_subdirectory(baseline)
 endif()
 
@@ -71,7 +72,7 @@ function(hls_target proj hls_target_name sources testbench_sources top_function)
         COMMAND bash -c ${cmd} > ${proj}.tcl
         DEPENDS ${CMAKE_SOURCE_DIR}/ikernels/ikernel.tcl.in
     )
-    add_custom_target(${hls_target_name}
+    add_custom_target(${hls_target_name}-hls
         COMMAND env PATH=${TCPDUMP_PATH}:$$PATH GTEST_ROOT=${GTEST_ROOT}
             NUM_IKERNELS=${NUM_IKERNELS}
             NUM_TC=${NUM_TC}
@@ -80,7 +81,7 @@ function(hls_target proj hls_target_name sources testbench_sources top_function)
             MEMCACHED_VALUE_SIZE=${MEMCACHED_VALUE_SIZE}
             ${XILINX_VIVADO_HLS}/bin/vivado_hls
             ${proj}.tcl
-        DEPENDS ${proj}_tests ${proj}.tcl ${CMAKE_SOURCE_DIR}/nica/ikernel.tcl nica-hls
+        DEPENDS ${proj}_tests ${proj}.tcl ${CMAKE_SOURCE_DIR}/nica/ikernel.tcl nica-csim
     )
     add_custom_target(${hls_target_name}-sim
         COMMAND env PATH=${TCPDUMP_PATH}:$$PATH GTEST_ROOT=${GTEST_ROOT}
@@ -91,15 +92,15 @@ function(hls_target proj hls_target_name sources testbench_sources top_function)
             MEMCACHED_VALUE_SIZE=${MEMCACHED_VALUE_SIZE}
             SIMULATION_BUILD=1
             ${XILINX_VIVADO_HLS}/bin/vivado_hls ${proj}.tcl
-        DEPENDS ${proj}_tests ${proj}.tcl ${CMAKE_SOURCE_DIR}/nica/ikernel.tcl nica-hls
+        DEPENDS ${proj}_tests ${proj}.tcl ${CMAKE_SOURCE_DIR}/nica/ikernel.tcl nica-csim
     )
 endfunction(hls_target)
 
 function(add_gtest name)
     target_link_libraries(${name}_tests ${GTEST_LIBRARIES} ${UUID_LIBRARIES})
     target_compile_features(${name}_tests PRIVATE cxx_lambdas)
     target_link_libraries(${name}_tests Threads::Threads)
-    target_link_libraries(${name}_tests nica-hls)
+    target_link_libraries(${name}_tests nica-csim)
 endfunction(add_gtest)
 
 ### Adds a new ikernel.

Jenkinsfile

@@ -38,7 +38,7 @@ properties ([parameters([
 ])])
 
 def build_hls_project(build_dir, project, simulation) {
-    def target = simulation ? "${project}-sim" : "${project}"
+    def target = simulation ? "${project}-sim" : "${project}-hls"
     if (simulation) {
         echo "Running HLS RTL/C cosimulation for project ${project}."
     } else {
@@ -98,12 +98,6 @@ node {
             // Pull request build
             checkout scm
         }
-        dir ('libvma') {
-            // libvma is needed to build the host apps
-            git credentialsId: '336fdc5e-b4a2-47dc-adde-ce4343484399', url:
-            '[email protected]:haggai_e/libvma.git', branch: 'nica'
-        }
-
         dir ('googletest') {
             // Google test for the HLS ikernel tests and NICA tests
             git 'https://github.com/google/googletest'
@@ -112,24 +106,12 @@ node {
             $CMAKE -DBUILD_GMOCK=OFF -DBUILD_GTEST=ON .
             make -j"""
         }
-        dir('libvma') {
-            // Build libvma, pointing it to the HLS repository for its headers
-            withEnv(["ACLOCAL_PATH=/usr/share/aclocal"]) {
-                sh '''
-                ./autogen.sh
-                ./configure IKERNEL_PATH=`pwd`/../nica
-                make -j
-                '''
-            }
-        }
         dir('nica/build') {
             // Build the HLS repository (host part only)
             // One ikernel
             sh """
             rm -f CMakeCache.txt
             $CMAKE \
-                -DNICA_DIR=`pwd`/../../libvma/src/nica \
-                -DVMA_DIR=`pwd`/../../libvma/src \
                 -DGTEST_ROOT=${GTEST_ROOT} \
                 -DXILINX_VIVADO_VERSION=${params.VIVADO_VERSION} \
                 -DNUM_IKERNELS=1 \
@@ -146,8 +128,6 @@ node {
         //    // Two ikernels
         //    sh """
         //    $CMAKE \
-        //        -DNICA_DIR=`pwd`/../../libvma/src/nica \
-        //        -DVMA_DIR=`pwd`/../../libvma/src \
         //        -DGTEST_ROOT=${GTEST_ROOT} \
         //        -DNUM_IKERNELS=2 \
         //        ..
@@ -182,6 +162,11 @@ node {
     ]
     currentBuild.result = 'SUCCESS'
     parallel branches
+
+    // cleanup
+    dir('nica/build') {
+        sh "find -maxdepth 4 -name .autopilot -exec rm -r '{}' ';'"
+    }
 }
 
 // Choose the ikernel to build based on the branch name
@@ -191,6 +176,7 @@ def getBuildIkernel(branchName) {
         'pktgen': 'pktgen',
         'memcached-cr': 'memcached',
         'memcached-ddr': 'memcached',
+        'async-memory': 'memcached',
         'echo': 'echo'
     ].withDefault { key -> 'threshold' }
 

README.md

@@ -43,34 +43,22 @@ It is also possible to build NICA building the `nica` target, and run an RTL/C
 co-simulation for that project by building the `nica-sim` target. Other
 ikernel targets are listed below.
 
-| ikernel     | target        | RTL/C co-simulation |
-| ----------- | ------------- | -----------------   |
-| Passthrough | `passthrough` | `passthrough-sim`   |
-| Threshold   | `threshold`   | `threshold-sim`     |
-| pktgen      | `pktgen`      | `pktgen-sim`        |
-| echo        | `echo`        | `echo-sim`          |
-| Top-K       | `cms`         | `cms-sim`           |
-| memcached   | `memcached`   | `memcached-sim`     |
+| ikernel     | target            | RTL/C co-simulation |
+| ----------- | ----------------- | -----------------   |
+| Passthrough | `passthrough-hls` | `passthrough-sim`   |
+| Threshold   | `threshold-hls`   | `threshold-sim`     |
+| pktgen      | `pktgen-hls`      | `pktgen-sim`        |
+| echo        | `echo-hls`        | `echo-sim`          |
+| Top-K       | `cms-hls`         | `cms-sim`           |
+| memcached   | `memcached-hls`   | `memcached-sim`     |
 
 ## Building host software
 
-The host software depends on `libnica`, which is part of a modified
-[libvma](https://bitbucket.org/haggai_e/libvma.git) repository:
-
-```shell
-cd ~/workspace
-git clone [email protected]:haggai_e/libvma.git
-ACLOCAL_PATH=/usr/share/aclocal ./autogen.sh
-./configure IKERNEL_PATH=~/workspace/nica/nica/hls
-make -j
-```
-
 Now this repository can be configured to build the software as well:
 
 ```shell
 cd ~/workspace/nica/build
-cmake -DGTEST_ROOT=~/workspace/googletest/googletest -DNUM_IKERNELS=1 -DBUILD_SOFTWARE=ON \
-    -DNICA_DIR=~/workspace/libvma/src/nica -DVMA_DIR=~/workspace/libvma/src ..
+cmake -DGTEST_ROOT=~/workspace/googletest/googletest -DNUM_IKERNELS=1 -DBUILD_SOFTWARE=ON ..
 make -j
 ```
 

baseline/CMakeLists.txt

@@ -2,21 +2,6 @@ cmake_minimum_required(VERSION 3.1)
 find_package(Boost COMPONENTS system program_options REQUIRED)
 find_package(ibverbs REQUIRED)
 
-find_path(NICA_DIR nica.h
-    HINTS
-        ~/workspace/libvma/src/nica
-)
-
-find_path(VMA_DIR vma/vma_extra.h
-    HINTS
-        ~/workspace/libvma/src
-)
-
-find_library(LIBNICA nica
-    HINTS
-        ${NICA_DIR}/.libs
-)
-
 find_path(NICA_HLS_DIR nica-top.hpp
     HINTS
         ../nica/hls/
@@ -30,8 +15,8 @@ find_path(THRESHOLD_IKERNEL_DIR threshold.hpp
 include(FindPkgConfig)
 pkg_check_modules(UUID REQUIRED uuid)
 
-include_directories(${UDP_INCLUDE_DIR} ${THRESHOLD_IKERNEL_DIR} ${NICA_HLS_DIR} ${NICA_DIR}
-    ${VMA_DIR} ${UUID_INCLUDE_DIRS} ${XILINX_VIVADO_HLS} ${IBVERBS_INCLUDE_DIRS})
+include_directories(${UDP_INCLUDE_DIR} ${THRESHOLD_IKERNEL_DIR} ${NICA_HLS_DIR}
+    ${UUID_INCLUDE_DIRS} ${XILINX_VIVADO_HLS} ${IBVERBS_INCLUDE_DIRS} ../libnica)
 
 set(THREADS_PREFER_PTHREAD_FLAG ON)
 find_package(Threads REQUIRED)
@@ -48,7 +33,7 @@ add_executable(client RunnableUdpClient.cpp UdpClient.cpp)
 foreach(executable threshold_server cms_server echo_server client)
 	target_link_libraries(${executable} Threads::Threads)
 	target_link_libraries(${executable} ${Boost_SYSTEM_LIBRARY} ${Boost_PROGRAM_OPTIONS_LIBRARY})
-	target_link_libraries(${executable} ${LIBNICA})
+	target_link_libraries(${executable} nica)
 	target_link_libraries(${executable} ${UUID_LIBRARIES})
 	target_link_libraries(${executable} ${IBVERBS_LIBRARIES})
 	target_compile_features(${executable} PRIVATE cxx_rvalue_references cxx_generalized_initializers)

baseline/CmsServerMain.cpp

@@ -26,7 +26,6 @@
 #include "RunnableServerBase.hpp"
 #include "CmsUdpServer.hpp"
 #include "cms-ikernel.hpp"
-#include <vma/vma_extra.h>
 
 #include <sstream>
 #include <future>

baseline/EchoServerMain.cpp

@@ -27,7 +27,7 @@
 #include "RunnableServerBase.hpp"
 #include "passthrough.hpp"
 #include "echo.hpp"
-#include <vma/vma_extra.h>
+#include <uuid.h>
 
 #include <future>
 

baseline/ThresholdServerMain.cpp

@@ -26,8 +26,8 @@
 #include "StatisticsUdpServer.hpp"
 #include "RunnableServerBase.hpp"
 #include "threshold.hpp"
-#include <vma/vma_extra.h>
 #include <future>
+#include <uuid.h>
 
 class threshold_main : public RunnableServerBase {
 public:

emulation/CMakeLists.txt

@@ -1,7 +1,7 @@
 # Emulation library
 add_library(nica-emu SHARED emu-top.cpp)
 include_directories(../nica/hls ../ikernels/hls)
-target_link_libraries(nica-emu nica-hls)
+target_link_libraries(nica-emu nica-csim)
 set(ikernels threshold passthrough pktgen memcached)
 foreach(ikernel ${ikernels})
 	target_link_libraries(nica-emu ${ikernel}-emu)

emulation/emu-top.cpp

@@ -99,10 +99,13 @@ namespace emulation {
 
     struct ikernel_wrapper {
         hls_ik::ports ports;
+        hls_ik::tc_ikernel_data_counts tc;
         hls_ik::ikernel_id id;
         virt_gateway_wrapper gateway;
         hls_ik::virt_gateway_registers gateway_regs;
-        using ikernel_top_func = std::function<void(hls_ik::ports&, hls_ik::ikernel_id&, hls_ik::virt_gateway_registers&)>;
+        using ikernel_top_func = std::function<void(hls_ik::ports&,
+            hls_ik::ikernel_id&, hls_ik::virt_gateway_registers&,
+            hls_ik::tc_ikernel_data_counts&)>;
         ikernel_top_func func;
 
         ikernel_wrapper() :
@@ -125,12 +128,12 @@ namespace emulation {
             else
                 throw std::exception();
 
-            hls_ik::init(ports);
+            hls_ik::init(tc);
         }
 
         void step() 
         {
-            func(ports, id, gateway.gateway);
+            func(ports, id, gateway.gateway, tc);
         }
 
         void reg_access(uint32_t address, uint32_t* value, bool read)
@@ -269,7 +272,7 @@ namespace emulation {
             flit.set_data(pkt->data + i, cur_len);
             flit.last = i + cur_len == pkt->len;
 
-            mlx::axi4s mlx_flit(flit, 1, 1);
+            mlx::axi4s mlx_flit(flit, 0, 1);
 
             if (pkt->dir == Net)
                 prt_nw2sbu.write(mlx_flit);

ikernels/CMakeLists.txt

@@ -8,16 +8,17 @@ include_directories(hls ../nica/hls)
 foreach(pcap_file udp_rr.pcap
         memcached-requests.pcap memcached-responses.pcap
         memcached-all-responses.pcap
-		memcached-requests-16.pcap memcached-responses-16.pcap
-		memcached-all-responses-16.pcap
+        memcached-requests-16.pcap memcached-responses-16.pcap
+        memcached-all-responses-16.pcap
+        memcached-set-16.pcap
         ping.pcap pong.pcap
 )
     add_custom_target(${pcap_file}
         DEPENDS ${CMAKE_SOURCE_DIR}/ikernels/hls/tests/${pcap_file}
         COMMAND cp ${CMAKE_SOURCE_DIR}/ikernels/hls/tests/${pcap_file} ${pcap_file})
 endforeach(pcap_file)
 
-foreach(f pong)
+foreach(f pong memcached-set-16)
     add_custom_target(${f}-padded.pcap
             COMMAND python ${CMAKE_SOURCE_DIR}/nica/hls/tests/pad_small_packets.py ${f}.pcap ${f}-padded.pcap
             DEPENDS ${f}.pcap ${CMAKE_SOURCE_DIR}/nica/hls/tests/pad_small_packets.py)
@@ -47,7 +48,7 @@ add_ikernel(pktgen "hls/pktgen.cpp;hls/passthrough.cpp" "hls/tests/pktgen_tests.
 
 ### Memcached
 add_ikernel(memcached "hls/memcached.cpp;hls/passthrough.cpp" "hls/tests/memcached_tests.cpp;../nica/hls/tests/tb.cpp" memcached memcached_top
-         "memcached-requests.pcap;memcached-responses.pcap;memcached-all-responses.pcap;memcached-requests-16.pcap;memcached-responses-16.pcap;memcached-all-responses-16.pcap")
+         "memcached-requests.pcap;memcached-responses.pcap;memcached-all-responses.pcap;memcached-requests-16.pcap;memcached-responses-16.pcap;memcached-all-responses-16.pcap;memcached-set-16.pcap;memcached-set-16-padded.pcap")
 set(MEMCACHED_CACHE_SIZE "4096" CACHE STRING
     "Cache size in entries for the memcached ikernel")
 set(MEMCACHED_KEY_SIZE "16" CACHE STRING

ikernels/hls/cms-ikernel.cpp

@@ -151,7 +151,7 @@ void cms::read_heap(hls::stream<value_and_frequency>& heap_out, ap_uint<32> k_va
 	}
 }
 
-void cms::step(hls_ik::ports& p)
+void cms::step(hls_ik::ports& p, hls_ik::tc_ikernel_data_counts& tc)
 {
 #pragma HLS inline
     pass_packets(p.host);
@@ -163,7 +163,8 @@ void cms::step(hls_ik::ports& p)
 static cms cms_inst;
 void cms_ikernel(hls_ik::ports& ik, hls_ik::ikernel_id& uuid,
 	hls_ik::virt_gateway_registers& gateway, value_and_frequency& to_heap,
-	hls::stream<value_and_frequency>& heap_out, ap_uint<32> k_value)
+	hls::stream<value_and_frequency>& heap_out, ap_uint<32> k_value,
+        hls_ik::tc_ikernel_data_counts& tc)
 {
 	DO_PRAGMA(HLS dataflow)
 	DO_PRAGMA(HLS ARRAY_RESHAPE variable=uuid.uuid complete dim=1)
@@ -179,7 +180,7 @@ void cms_ikernel(hls_ik::ports& ik, hls_ik::ikernel_id& uuid,
 
 	using namespace hls_ik;
     static const ikernel_id __constant_uuid = { CMS_UUID };
-    cms_inst.step(ik);
+    cms_inst.step(ik, tc);
     cms_inst.write_to_heap(to_heap);
     cms_inst.read_heap(heap_out, k_value);
     cms_inst.gateway(&cms_inst, gateway);

ikernels/hls/cms-ikernel.hpp

@@ -45,13 +45,17 @@ struct value_and_frequency {
     value frequency;
 };
 
-void cms_ikernel(hls_ik::ports& ik, hls_ik::ikernel_id& uuid, hls_ik::virt_gateway_registers& gateway,
-	     value_and_frequency& to_heap, hls::stream<value_and_frequency>& heap_out, ap_uint<32> k_value);
+void cms_ikernel(hls_ik::ports& ik, hls_ik::ikernel_id& uuid,
+                 hls_ik::virt_gateway_registers& gateway,
+                 value_and_frequency& to_heap,
+                 hls::stream<value_and_frequency>& heap_out,
+                 ap_uint<32> k_value,
+                 hls_ik::tc_ikernel_data_counts& tc);
 
 class cms : public hls_ik::ikernel, public hls_ik::virt_gateway_impl<cms> {
 public:
 
-    virtual void step(hls_ik::ports& ports);
+    virtual void step(hls_ik::ports& ports, hls_ik::tc_ikernel_data_counts& tc);
     virtual int reg_write(int address, int value, hls_ik::ikernel_id_t ikernel_id);
     virtual int reg_read(int address, int* value, hls_ik::ikernel_id_t ikernel_id);
 

ikernels/hls/echo-impl.hpp

@@ -36,13 +36,13 @@ class echo : public hls_ik::ikernel, public hls_ik::virt_gateway_impl<echo> {
 public:
     echo();
 
-    virtual void step(hls_ik::ports& p);
+    virtual void step(hls_ik::ports& p, hls_ik::tc_ikernel_data_counts& tc);
 
     virtual int reg_write(int address, int value, hls_ik::ikernel_id_t ikernel_id);
     virtual int reg_read(int address, int* value, hls_ik::ikernel_id_t ikernel_id);
 
 private:
-    void echo_pipeline(hls_ik::ports& p);
+    void echo_pipeline(hls_ik::ports& p, hls_ik::tc_ikernel_data_counts& tc);
 
     enum { METADATA, DATA } state;
     /* First data word */
@@ -52,8 +52,7 @@ class echo : public hls_ik::ikernel, public hls_ik::virt_gateway_impl<echo> {
     /* Metadata of the current packet */
     hls_ik::metadata metadata;
 
-    bool dummy, dummy_cache;
-    hls::stream<bool> dummy_update;
+    hls::stream<bool> port_dummy_update;
 
     /* By default, respond to all packets. When true, respond to sockperf
      * packets with "pong" requests. */