moved platform/implementation specific code to its own file

Author: Moi78

netutils/CMakeLists.txt

@@ -1,10 +1,14 @@
 set(OAN_UTILS_SOURCES
         udp.cpp
         udp.h
-        LowLatSocket.cpp
         LowLatSocket.h
         rt.h
         rt.cpp
+        platforms/lls_linux.h
+        lls_common.h
+        platforms/lls_linux.cpp
+        platforms/lls_zephyr.h
+        platforms/lls_zephyr.cpp
 )
 
 if(EMBEDDED_BUILD)

netutils/LowLatSocket.h

@@ -7,253 +7,9 @@
 #define LOWLATSOCKET_H
 
 #ifdef __linux__
-#include <iostream>
-#endif //__linux__
-
-#include <string>
-#include <cstring>
-#include <cassert>
-#include <optional>
-#include <cstdint>
-#include <memory>
-
-#ifdef __linux__
-#include <linux/if_packet.h>
-#include <linux/if_ether.h>
-#include <netinet/in.h>
-#include <net/if.h>
-#include <unistd.h>
-#include <sys/ioctl.h>
-#else
-
-// Defining linux-like structs for compat
-struct EthernetHeader {
-    uint8_t h_dest[6];
-    uint8_t h_source[6];
-    uint16_t h_proto;
-} __attribute__((packed));
-typedef EthernetHeader ethhdr;
-
-#ifndef __ZEPHYR__
-#define htons(x) ((((x) & 0xFF00) >> 8) | (((x) & 0x00FF) << 8))
-#else
-#include "zephyr/net/net_ip.h"
+#include "platforms/lls_linux.h"
+#elif __ZEPHYR__
+#include "platforms/lls_zephyr.h"
 #endif
 
-#endif //__linux__
-
-/**
- * @enum EthProtocol
- * @brief Enum containing different values for the Ethernet protocol field, corresponding to different OAN stream types.
- */
-enum EthProtocol : uint16_t {
-    ETH_PROTO_OANAUDIO = 0x0681,
-    ETH_PROTO_OANDISCO = 0x0682,
-    ETH_PROTO_OANCONTROL = 0x0683,
-    ETH_PROTO_OANSYNC = 0x0684
-};
-
-/**
- * @struct LowLatHeader
- * @brief This header contains the layer 2 header of the protocol
- */
-struct LowLatHeader {
-    uint16_t sender_uid;    /**< Sender device UID */
-    uint16_t dest_uid;      /**< Receiver device UID */
-    uint16_t psize;         /**< Packet size */
-} __attribute__((packed));
-
-/**
- * @struct LowLatPacket
- * @brief Layer 2 packet containing ethernet and addressing headers plus encapsulated data
- * @tparam T Type of the encapsulated data
- */
-template<class T>
-struct LowLatPacket {
-    ethhdr eth_header;  /**< Ethernet header, linux kernel structure */
-    LowLatHeader llhdr; /**< LowLatHeader header, custom addressing scheme */
-    T payload;          /**< Encapsulated data */
-} __attribute__((packed));
-
-/**
- * @struct INT_LLP
- * @brief Custom-sized LowLatPacket with no raw data for encapsulated data. For internal use only
- * @tparam payload_size__ Custom size
- */
-template<int payload_size__>
-struct INT_LLP : public LowLatPacket<char[payload_size__]> {};
-
-/**
- * @struct IfaceMeta
- * @brief This struct stores physical network interface info.
- */
-struct IfaceMeta {
-    char mac[6];   /**< MAC Address */
-    int idx;       /**< Interface ID (kernel parameter) */
-};
-
-/**
- * Function to retreive a given network interface infos.
- * @param name Interface name
- * @return Interface infos if found. All zeros if not found.
- */
-IfaceMeta get_iface_meta(const std::string& name);
-
-class NetworkMapper;
-
-/**
- * @class LowLatSocket
- * @brief Wrapper for raw sockets that implements a layer 2 addressing protocol.
- */
-class LowLatSocket {
-public:
-    /**
-     * Constructor
-     * @param self_uid Host UID
-     * @param mapper Local OAN network mapper
-     */
-    LowLatSocket(uint16_t self_uid, std::shared_ptr<NetworkMapper> mapper);
-    ~LowLatSocket();
-
-    /**
-     * Initializes the socket
-     * @param interface Physical network interface name to attach the socket to
-     * @param proto Ethernet protocol used. @see EthProtocol
-     * @return true if initialization succeeds
-     */
-    bool init_socket(std::string interface, EthProtocol proto);
-
-    /**
-     * Format a given packet assuming it is a LowLatPacket<T> without sending it with the socket interface
-     * @param packet_buffer Packet buffer
-     * @param dest_uid Packet receiver UID
-     * @return true if successfully filled the header
-     */
-    bool format_packet_header(uint8_t* packet_buffer, uint16_t dest_uid, size_t packet_size);
-
-    /**
-     * Write in a given packet assuming it is a LowLatPacket<T>
-     * @param packet_buffer Packet buffer
-     * @param dest_uid Packet receiver UID
-     * @return true if successfully found MAC addr and wrote it to packet
-     */
-    bool write_packet_mac_addr(uint8_t* packet_buffer, uint16_t dest_uid);
-
-    /**
-     * Sends some data on the network
-     * @tparam T Sent data type
-     * @param data Pointer to the data
-     * @param dest_uid Package receiver UID
-     * @return Sent byte count. Less than 0 if error.
-     */
-    template<class T>
-    int send_data(const T& data, uint16_t dest_uid) {
-        INT_LLP<sizeof(T)> llpck;
-        format_packet_header((uint8_t*)&llpck, dest_uid, sizeof(T));
-        memcpy(llpck.payload, &data, sizeof(T));
-
-        if (dest_uid != 0) {
-            auto mac = get_mac(dest_uid);
-            if (mac.has_value()) {
-                uint64_t& v = mac.value();
-                memcpy(llpck.eth_header.h_dest, &v, 6);
-            } else {
-                //std::cerr << "Trying to send data to unknown UID (" << (int)dest_uid << ")." << std::endl;
-                return 0;
-            }
-        }
-
-#ifdef __linux__
-        return sendto(
-            m_socket,
-            &llpck, sizeof(llpck),
-            MSG_DONTWAIT,
-            (sockaddr*)&m_iface_addr,
-            sizeof(m_iface_addr)
-        );
-#else
-        return send_data_internal((uint8_t*)&llpck, sizeof(INT_LLP<sizeof(T)>));
-#endif // __linux__
-    }
-
-    /**
-     * Receive some data
-     * @tparam T Data type received
-     * @param data Pointer to the data buffer
-     * @param async This flag set the call as non-blocking if set to true
-     * @return Received byte count
-     */
-    template<class T>
-    int receive_data(T* data, bool async = true) {
-#ifdef __linux__
-        return recv(m_socket, data, sizeof(T), async ? MSG_DONTWAIT : 0);
-#else
-        return recv_data_internal((uint8_t*)data, sizeof(T));
-#endif // __linux__
-    }
-
-    /**
-     * Receive raw data. @see LowLatSocket::receive_data
-     * @param data Pointer to the data buffer
-     * @param size Amount of data expected
-     * @param async This flag set the call as non-blocking if set to true
-     * @return Received byte count
-     */
-    int receive_data_raw(char* data, size_t size, bool async = true) const {
-#ifdef __linux__
-        return recv(m_socket, data, size, async ? MSG_DONTWAIT : 0);
-#else
-        return recv_data_internal((uint8_t*)data, size);
-#endif // __linux__
-    }
-
-    /**
-     * Send raw packet on wiore without further processing
-     * @param data Packet data
-     * @param size Packet size
-     * @return Number of byte sent
-     */
-    int send_data_raw(char* data, size_t size) {
-        #ifdef __linux__
-            return sendto(
-                m_socket,
-                data, size,
-                MSG_DONTWAIT,
-                (sockaddr*)&m_iface_addr,
-                sizeof(m_iface_addr)
-            );
-        #else
-            return send_data_internal((uint8_t*)data, size);
-        #endif // __linux__
-    }
-
-private:
-    /**
-     * Finds a device MAC address based on its ID.
-     * @param id ID to search for
-     * @return If found, the corresponding MAC address
-     */
-    std::optional<uint64_t> get_mac(uint16_t id);
-
-#ifndef __linux__
-    int send_data_internal(uint8_t* data, size_t size);
-    int recv_data_internal(uint8_t* data, size_t size) const;
-#endif // __linux__
-
-#ifdef __linux__
-    sockaddr_ll m_iface_addr{};
-#else
-    uint8_t m_iface_addr[6];
-#endif // __linux__
-    ethhdr m_hdr{};
-
-    int m_socket;
-    uint16_t m_self_uid;
-    EthProtocol m_self_proto;
-
-    std::shared_ptr<NetworkMapper> m_mapper;
-};
-
-
-
 #endif //LOWLATSOCKET_H

netutils/lls_common.h

@@ -0,0 +1,74 @@
+// This file is part of the Open Audio Live System project, a live audio environment
+// Copyright (c) 2026 - Mathis DELGADO
+//
+// This project is distributed under the Creative Commons CC-BY-NC-SA licence. https://creativecommons.org/licenses/by-nc-sa/4.0
+
+#ifndef LLSCOMMON_H
+#define LLSCOMMON_H
+
+#include <cstdint>
+
+#ifndef __linux__
+// Defining linux-like structs for compat
+struct EthernetHeader {
+    uint8_t h_dest[6];
+    uint8_t h_source[6];
+    uint16_t h_proto;
+} __attribute__((packed));
+typedef EthernetHeader ethhdr;
+#else
+#include <linux/if_ether.h>
+#endif // __linux__
+
+
+/**
+ * @enum EthProtocol
+ * @brief Enum containing different values for the Ethernet protocol field, corresponding to different OAN stream types.
+ */
+enum EthProtocol : uint16_t {
+    ETH_PROTO_OANAUDIO = 0x0681,
+    ETH_PROTO_OANDISCO = 0x0682,
+    ETH_PROTO_OANCONTROL = 0x0683,
+    ETH_PROTO_OANSYNC = 0x0684
+};
+
+/**
+ * @struct LowLatHeader
+ * @brief This header contains the layer 2 header of the protocol
+ */
+struct LowLatHeader {
+    uint16_t sender_uid;    /**< Sender device UID */
+    uint16_t dest_uid;      /**< Receiver device UID */
+    uint16_t psize;         /**< Packet size */
+} __attribute__((packed));
+
+/**
+ * @struct LowLatPacket
+ * @brief Layer 2 packet containing ethernet and addressing headers plus encapsulated data
+ * @tparam T Type of the encapsulated data
+ */
+template<class T>
+struct LowLatPacket {
+    ethhdr eth_header;  /**< Ethernet header, linux kernel structure */
+    LowLatHeader llhdr; /**< LowLatHeader header, custom addressing scheme */
+    T payload;          /**< Encapsulated data */
+} __attribute__((packed));
+
+/**
+ * @struct INT_LLP
+ * @brief Custom-sized LowLatPacket with no raw data for encapsulated data. For internal use only
+ * @tparam payload_size__ Custom size
+ */
+template<int payload_size__>
+struct INT_LLP : public LowLatPacket<char[payload_size__]> {};
+
+/**
+ * @struct IfaceMeta
+ * @brief This struct stores physical network interface info.
+ */
+struct IfaceMeta {
+    char mac[6];   /**< MAC Address */
+    int idx;       /**< Interface ID (kernel parameter) */
+};
+
+#endif // LLSCOMMON_H

netutils/LowLatSocket.cpp netutils/platforms/lls_linux.cppnetutils/LowLatSocket.cpp renamed to netutils/platforms/lls_linux.cpp

@@ -3,13 +3,10 @@
 //
 // This project is distributed under the Creative Commons CC-BY-NC-SA licence. https://creativecommons.org/licenses/by-nc-sa/4.0
 
-#include "LowLatSocket.h"
+#include "lls_linux.h"
 #include "common/NetworkMapper.h"
 
-#ifndef __linux__
-extern "C" int _send_data(uint8_t* data, size_t data_len);
-extern "C" int _recv_data(uint8_t* data_out, size_t data_size, EthProtocol filt_proto);
-#endif // __linux__
+#ifdef __linux__
 
 std::optional<uint64_t> LowLatSocket::get_mac(uint16_t id) {
     return m_mapper->get_mac_by_uid(id);
@@ -152,3 +149,5 @@ bool LowLatSocket::write_packet_mac_addr(uint8_t *packet_buffer, uint16_t dest_u
         return false;
     }
 }
+
+#endif // __linux__