Merge pull request #1 from kaajalbgupta/hybrid_backend

Introducing the Hybrid Backend

Author: kaajalbgupta

hardware/input_gen/generate_synthetic_trace.cpp

@@ -54,8 +54,9 @@ static constexpr uint32_t ip(uint8_t a, uint8_t b, uint8_t c, uint8_t d) {
 }
 
 int main(int argc, char const* argv[]) {
-  if (argc != 6) {
-    std::cerr << "Usage: " << argv[0] << " NB_PKTS PKT_SIZE NB_SRC NB_DST "
+  if (argc != 7) {
+    std::cerr << "Usage: " << argv[0]
+              << " NB_PKTS PKT_SIZE NB_SRC NB_DST DST_START "
               << "OUTPUT_PCAP" << std::endl;
     exit(1);
   }
@@ -64,7 +65,8 @@ int main(int argc, char const* argv[]) {
   const int pkt_size = std::stoi(argv[2]);
   const int nb_src = std::stoi(argv[3]);
   const int nb_dst = std::stoi(argv[4]);
-  const std::string output_pcap = argv[5];
+  const int dst_start = std::stoi(argv[5]);
+  const std::string output_pcap = argv[6];
 
   // Skip if pcap with same name already exists.
   {
@@ -109,7 +111,7 @@ int main(int argc, char const* argv[]) {
   pkt_hdr.ts = ts;
 
   uint32_t src_ip = ip(192, 168, 0, 0);
-  uint32_t dst_ip = ip(192, 168, 0, 0);
+  uint32_t dst_ip = ip(192, 168, 0, dst_start);
 
   uint32_t mss =
       pkt_size - sizeof(*l2_hdr) - sizeof(*l3_hdr) - sizeof(*l4_hdr) - 4;

meson_options.txt

@@ -6,5 +6,5 @@ option('enso_pipe_size', type: 'integer', min: 0, max: 32768, value: 32768,
        description: 'Buffer size used by each software enso pipe')
 option('latency_opt', type: 'boolean', value: true,
        description: 'Optimize for latency')
-option('dev_backend', type: 'combo', choices: ['intel_fpga', 'software'],
+option('dev_backend', type: 'combo', choices: ['intel_fpga', 'hybrid'],
        value: 'intel_fpga', description: 'Device backend to use')

software/examples/example_helpers.h

@@ -30,8 +30,8 @@
  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef SOFTWARE_EXAMPLES_EXAMPLE_HELPERS_H_
-#define SOFTWARE_EXAMPLES_EXAMPLE_HELPERS_H_
+#ifndef ENSO_SOFTWARE_EXAMPLES_EXAMPLE_HELPERS_H_
+#define ENSO_SOFTWARE_EXAMPLES_EXAMPLE_HELPERS_H_
 
 #include <arpa/inet.h>
 
@@ -41,4 +41,4 @@ const uint32_t kBaseIpAddress = ntohl(inet_addr("192.168.0.0"));
 const uint32_t kDstPort = 80;
 const uint32_t kProtocol = 0x11;
 
-#endif  // SOFTWARE_EXAMPLES_EXAMPLE_HELPERS_H_
+#endif  // ENSO_SOFTWARE_EXAMPLES_EXAMPLE_HELPERS_H_

software/examples/meson.build

@@ -2,17 +2,17 @@
 thread_dep = dependency('threads')
 pcap_dep = dependency('pcap', version : '>=1.0')
 
-executable('echo', 'echo.cpp', dependencies: thread_dep, link_with: enso_lib,
+executable('echo', 'echo.cpp', dependencies: [thread_dep], link_with: enso_lib,
            include_directories: inc)
-executable('echo_event', 'echo_event.cpp', dependencies: thread_dep,
+executable('echo_event', 'echo_event.cpp', dependencies: [thread_dep],
            link_with: enso_lib, include_directories: inc)
-executable('echo_prefetch', 'echo_prefetch.cpp', dependencies: thread_dep,
+executable('echo_prefetch', 'echo_prefetch.cpp', dependencies: [thread_dep],
            link_with: enso_lib, include_directories: inc)
-executable('echo_copy', 'echo_copy.cpp', dependencies: thread_dep,
+executable('echo_copy', 'echo_copy.cpp', dependencies: [thread_dep],
            link_with: enso_lib, include_directories: inc)
 executable('ensogen', 'ensogen.cpp', dependencies: [thread_dep, pcap_dep],
            link_with: enso_lib, include_directories: inc)
 executable('capture', 'capture.cpp', dependencies: [thread_dep, pcap_dep],
            link_with: enso_lib, include_directories: inc)
-executable('l2_forward', 'l2_forward.cpp', dependencies: thread_dep,
+executable('l2_forward', 'l2_forward.cpp', dependencies: [thread_dep],
            link_with: enso_lib, include_directories: inc)

software/include/enso/config.h

@@ -37,8 +37,8 @@
  * @author Hugo Sadok <[email protected]>
  */
 
-#ifndef SOFTWARE_INCLUDE_ENSO_CONFIG_H_
-#define SOFTWARE_INCLUDE_ENSO_CONFIG_H_
+#ifndef ENSO_SOFTWARE_INCLUDE_ENSO_CONFIG_H_
+#define ENSO_SOFTWARE_INCLUDE_ENSO_CONFIG_H_
 
 #include <enso/internals.h>
 
@@ -165,4 +165,4 @@ int update_fallback_queues_config(
 
 }  // namespace enso
 
-#endif  // SOFTWARE_INCLUDE_ENSO_CONFIG_H_
+#endif  // ENSO_SOFTWARE_INCLUDE_ENSO_CONFIG_H_

software/include/enso/consts.h

@@ -38,8 +38,8 @@
  * @author Hugo Sadok <[email protected]>
  */
 
-#ifndef SOFTWARE_INCLUDE_ENSO_CONSTS_H_
-#define SOFTWARE_INCLUDE_ENSO_CONSTS_H_
+#ifndef ENSO_SOFTWARE_INCLUDE_ENSO_CONSTS_H_
+#define ENSO_SOFTWARE_INCLUDE_ENSO_CONSTS_H_
 
 #include <cstdint>
 #include <string>
@@ -87,6 +87,10 @@ static constexpr std::string_view kHugePageRxPipePathPrefix = "_rx_pipe:";
 static constexpr std::string_view kHugePagePathPrefix = "_tx_pipe:";
 static constexpr std::string_view kHugePageNotifBufPathPrefix = "_notif_buf:";
 static constexpr std::string_view kHugePageQueuePathPrefix = "_queue:";
+static constexpr std::string_view kHugePageUthreadsPathPrefix = "_uthread:";
+static constexpr std::string_view kHugePageKthreadsPathPrefix = "_kthread:";
+static constexpr std::string_view kHugePageQueueTailPathPrefix = "_queue_tail";
+static constexpr std::string_view kHugePageQueueHeadPathPrefix = "_queue_head";
 
 // We need this to allow the same huge page to be mapped to adjacent memory
 // regions.
@@ -146,50 +150,79 @@ enum class NotifType : uint8_t {
   kSetRrStatus = 6,
   kGetRrStatus = 7,
   kFreeNotifBuf = 8,
-  kFreePipe = 9
+  kFreePipe = 9,
+  kGetShinkansenNotifBufId = 10,
+  kRegisterKthread = 11,
+  kUthreadWaiting = 12,
+  kKthreadYield = 13
 };
 
 struct MmioNotification {
   NotifType type;
   uint64_t address;
   uint64_t value;
+  uint64_t padding;
 };
 
 struct FallbackNotification {
   NotifType type;
   uint64_t nb_fallback_queues;
   uint64_t result;
+  uint64_t padding;
 };
 
 struct RoundRobinNotification {
   NotifType type;
   uint64_t round_robin;
   uint64_t result;
+  uint64_t padding;
 };
 
 struct NotifBufNotification {
   NotifType type;
   uint64_t notif_buf_id;
+  uint64_t uthread_id;
   uint64_t result;
 };
 
 struct AllocatePipeNotification {
   NotifType type;
   uint64_t fallback;
   uint64_t pipe_id;
+  uint64_t padding;
 };
 
 struct FreePipeNotification {
   NotifType type;
   uint64_t pipe_id;
   uint64_t result;
+  uint64_t padding;
+};
+
+struct ShinkansenNotification {
+  NotifType type;
+  uint64_t notif_queue_id;
+  uint64_t padding[2];
+};
+
+struct KthreadNotification {
+  NotifType type;
+  uint64_t application_id;
+  uint64_t padding[2];
+};
+
+struct YieldNotification {
+  NotifType type;
+  uint64_t notif_buf_id;
+  uint64_t last_rx_notif_head;
+  uint64_t last_tx_consumed_head;
 };
 
 struct PipeNotification {
   NotifType type;
-  uint64_t data[2];
+  uint64_t data[3];
 };
 
 }  // namespace enso
 
-#endif  // SOFTWARE_INCLUDE_ENSO_CONSTS_H_
+#endif  // ENSO_SOFTWARE_INCLUDE_ENSO_CONSTS_H_

software/include/enso/helpers.h

@@ -36,8 +36,8 @@
  * @author Hugo Sadok <[email protected]>
  */
 
-#ifndef SOFTWARE_INCLUDE_ENSO_HELPERS_H_
-#define SOFTWARE_INCLUDE_ENSO_HELPERS_H_
+#ifndef ENSO_SOFTWARE_INCLUDE_ENSO_HELPERS_H_
+#define ENSO_SOFTWARE_INCLUDE_ENSO_HELPERS_H_
 
 #include <endian.h>
 #include <enso/consts.h>
@@ -128,6 +128,20 @@ void print_pkt_header(uint8_t* pkt);
 
 void print_buf(void* buf, const uint32_t nb_cache_lines);
 
+/**
+ * @brief Sets the core ID of current thread using C methods.
+ *
+ * @param core_id the core ID to set the thread to.
+ *
+ * @return Success/failure of sched_setaffinity.
+ */
+int set_self_core_id(int core_id);
+
+/**
+ * @brief Gets the TID of the current thread.
+ */
+pid_t get_tid(void);
+
 int set_core_id(std::thread& thread, int core_id);
 
 void show_stats(const std::vector<stats_t>& thread_stats,
@@ -180,4 +194,4 @@ _enso_always_inline void memcpy_64_align(void* dst, const void* src, size_t n) {
 
 }  // namespace enso
 
-#endif  // SOFTWARE_INCLUDE_ENSO_HELPERS_H_
+#endif  // ENSO_SOFTWARE_INCLUDE_ENSO_HELPERS_H_

software/include/enso/internals.h

@@ -39,8 +39,8 @@
  */
 
 // TODO(sadok): Do not expose this header.
-#ifndef SOFTWARE_INCLUDE_ENSO_INTERNALS_H_
-#define SOFTWARE_INCLUDE_ENSO_INTERNALS_H_
+#ifndef ENSO_SOFTWARE_INCLUDE_ENSO_INTERNALS_H_
+#define ENSO_SOFTWARE_INCLUDE_ENSO_INTERNALS_H_
 
 #include <stdint.h>
 
@@ -83,7 +83,10 @@ struct __attribute__((__packed__)) TxNotification {
 struct NotificationBufPair {
   // First cache line:
   struct RxNotification* rx_buf;
-  enso_pipe_id_t* next_rx_pipe_ids;  // Next pipe ids to consume from rx_buf.
+  struct RxNotification**
+      next_rx_pipe_notifs;  // Next pipe notifications to consume from rx_buf:
+                            // stored in ring buffer by next_rx_ids_head and
+                            // next_rx_ids_tail
   struct TxNotification* tx_buf;
   uint32_t* rx_head_ptr;
   uint32_t* tx_tail_ptr;
@@ -118,8 +121,9 @@ struct RxEnsoPipeInternal {
   uint64_t phys_buf_offset;  // Use to convert between phys and virt address.
   enso_pipe_id_t id;
   std::string huge_page_prefix;
+  void* uio_mmap_bar2_addr;  // UIO mmap address for BAR 2.
 };
 
 }  // namespace enso
 
-#endif  // SOFTWARE_INCLUDE_ENSO_INTERNALS_H_
+#endif  // ENSO_SOFTWARE_INCLUDE_ENSO_INTERNALS_H_

software/include/enso/ixy_helpers.h

@@ -35,8 +35,8 @@
  *        [ixy driver](https://github.com/emmericp/ixy/blob/master/src/memory.c)
  */
 
-#ifndef SOFTWARE_INCLUDE_ENSO_IXY_HELPERS_H_
-#define SOFTWARE_INCLUDE_ENSO_IXY_HELPERS_H_
+#ifndef ENSO_SOFTWARE_INCLUDE_ENSO_IXY_HELPERS_H_
+#define ENSO_SOFTWARE_INCLUDE_ENSO_IXY_HELPERS_H_
 
 #include <cstdint>
 #include <string>
@@ -70,4 +70,4 @@ void* get_huge_page(const std::string& path, size_t size = 0,
 
 }  // namespace enso
 
-#endif  // SOFTWARE_INCLUDE_ENSO_IXY_HELPERS_H_
+#endif  // ENSO_SOFTWARE_INCLUDE_ENSO_IXY_HELPERS_H_

software/include/enso/meson.build

@@ -9,4 +9,4 @@ public_enso_headers = files(
     'socket.h'
 )
 
-install_headers(public_enso_headers, subdir: 'enso')
+install_headers(public_enso_headers, subdir: library_name)