eth_plugin.h

Go to the documentation of this file.

// Copyright 2024-2025 The Aerospace Corporation.
// This file is a part of SatCat5, licensed under CERN-OHL-W v2 or later.
 
 
#pragma once
 
#include <satcat5/eth_arp.h>
#include <satcat5/eth_header.h>
#include <satcat5/eth_switch.h>
#include <satcat5/ip_core.h>
#include <satcat5/list.h>
#include <satcat5/tcp_core.h>
#include <satcat5/types.h>
#include <satcat5/udp_core.h>
 
namespace satcat5 {
    namespace eth {
        struct PluginPacket {
        public:
            satcat5::io::MultiPacket* pkt;
 
            satcat5::eth::Header hdr;
 
            satcat5::eth::ArpHeader arp;
            satcat5::ip::Header ip;
            satcat5::tcp::Header tcp;
            satcat5::udp::Header udp;
 
            SATCAT5_PMASK_TYPE dst_mask;
 
            u16 hlen;
 
            u16 flags;
 
            constexpr PluginPacket()
                : pkt(nullptr), hdr{}, arp(), ip{}, tcp{}
                , udp(udp::HEADER_EMPTY), dst_mask(0), hlen(0), flags(0) {}
            PluginPacket(const PluginPacket& t) = delete;
            PluginPacket& operator=(const PluginPacket& t) = delete;
 
            bool read_from(satcat5::io::MultiPacket* packet);
 
            void write_to(satcat5::io::Writeable* wr) const;
 
            inline void adjust()
                { flags |= FLAG_HEADER_CHANGE; }
 
            inline void divert()
                { flags |= FLAG_DIVERT; }
 
            inline void drop(u8 reason)
                { dst_mask = 0; flags = u16(reason); }
 
            inline bool is_adjusted() const
                { return !!(flags & FLAG_HEADER_CHANGE); }
            inline bool is_diverted() const
                { return !!(flags & FLAG_DIVERT); }
            inline bool is_ip() const
                { return hdr.type == satcat5::eth::ETYPE_IPV4; }
            inline bool is_arp() const
                { return hdr.type == satcat5::eth::ETYPE_ARP; }
            inline bool is_tcp() const
                { return is_ip() && ip.proto() == satcat5::ip::PROTO_TCP; }
            inline bool is_udp() const
                { return is_ip() && ip.proto() == satcat5::ip::PROTO_UDP; }
            inline unsigned length() const
                { return pkt->m_length; }
            inline SATCAT5_PMASK_TYPE src_mask() const
                { return idx2mask(src_port()); }
            inline unsigned src_port() const
                { return unsigned(pkt->m_user[0]); }
            inline satcat5::eth::VtagPolicy port_vcfg() const
                { return satcat5::eth::VtagPolicy{pkt->m_user[1]}; }
            inline u8 reason() const
                { return u8(flags & 0xFF); }
 
        protected:
            static const u16 FLAG_DIVERT        = (1u << 8);
            static const u16 FLAG_HEADER_CHANGE = (1u << 9);
 
            bool read_internal(satcat5::io::Readable* rd);
        };
 
        class PluginCore {
        public:
            virtual void query(PluginPacket& pkt) = 0;
 
        protected:
            explicit PluginCore(satcat5::eth::SwitchCore* sw);
            ~PluginCore() SATCAT5_OPTIONAL_DTOR;
 
            satcat5::eth::SwitchCore* const m_switch;
 
        private:
            // Linked list for chaining multiple plugins.
            friend satcat5::util::ListCore;
            satcat5::eth::PluginCore* m_next;
        };
 
        class PluginPort {
        public:
            virtual void ingress(PluginPacket& pkt) {}  // GCOVR_EXCL_LINE
 
            virtual void egress(PluginPacket& pkt) {}   // GCOVR_EXCL_LINE
 
        protected:
            explicit PluginPort(satcat5::eth::SwitchPort* port);
            ~PluginPort() SATCAT5_OPTIONAL_DTOR;
 
            satcat5::eth::SwitchPort* const m_port;
 
        private:
            // Linked list for chaining multiple plugins.
            friend satcat5::util::ListCore;
            satcat5::eth::PluginPort* m_next;
        };
    }
}