netinterface.h

Go to the documentation of this file.

/*NB_REVISION*/
 
/*NB_COPYRIGHT*/
 
#ifndef _NB_NETIF_H
#define _NB_NETIF_H
 
#include <predef.h>
#include <autoip.h>
#include <config_netobj.h>
#include <config_obj.h>
#include <dhcpclient.h>
#include <discoveryservlet.h>
#include <mDNS.h>
#include <nettypes.h>
#include <buffers.h>
 
 
/*------------------------------------------------------------------------------
 * Definitions
 *------------------------------------------------------------------------------*/
 
//  PPP Interface Identifier
#define ARP_PPP_INTERFACE (255)
 
/*-------------------------------------------------------------------------------
 *
 * MAC Address for second and subsequent interfaces
 *    For a second and subsequent NICs the MSB(it) of the 5th octet is XOR'ed
 *    with 1 to support prior released tools.
 *
 *                               6 bytes
 *   <--------------------------------------------------------------------->
 *        0           1           2           3           4           5
 *   -----------------------------------------------------------------------
 *  | 6th byte  | 5th byte  | 4th byte  | 3rd byte  | 2nd byte  | 1st byte  |
 *  | 1st octet | 2nd octet | 3rd octet | 4th octet | 5th octet | 6th octet |
 *   -----------------------------------------------------------------------
 *
 *                 3 bytes                             3 bytes
 *   <---------------------------------> <--------------------------------->
 *   -----------------------------------------------------------------------
 *  | Organizationally Unique Identifier |   Network Interface Controller    |
 *  |           |   (OUI)   |           |           |  (NIC)    |           |
 *  |    0x00   |    0x03   |   0xF4    |    0xYX   |   0xZX    |   0xXX    |
 *   -----------------------------------------------------------------------
 *  |            \   OUI is NetBurner's      Y is IIXX XXXX binary
 *  |             \                          I is the interface defined as
 *  |              \                            bits in NB_MAX_NIC... below
 *  |               |                                     Z is WXXX binary
 *  V               V                                       W ix XOR'd bit
 *  |1|2|3|4|5|6|7|8| (7) 0 global, 1 local, (8) 0 unicast, 1 multicast (IEE)
 *
 * Notes:
 *    0-5 are C language offsets, 6th byte through 1st byte is Ethernet
 *    transmission order and octet notation is from IEEE 802 MAC-48 address.
 *    Derivation is needed if the NIC does not have a non-volatile MAC address.
 *
 *-------------------------------------------------------------------------------*/
#ifndef NB_MAC_ADDRESS
#define NB_MAC_ADDRESS
 
/* 4th Octet */
#define NB_MAC_NIC_INTERFACE        (0x00)
#define NB_MAC_NIC_SECOND_INTERFACE (0x80)
#define NB_MAC_NIC_THIRD_INTERFACE  (0x40)
#define NB_MAC_NIC_FOURTH_INTERFACE (0xC0)
#define NB_MAC_NIC_SECOND_INTERFACE_MASK \
    (NB_MAC_NIC_INTERFACE | NB_MAC_NIC_SECOND_INTERFACE | NB_MAC_NIC_THIRD_INTERFACE | NB_MAC_NIC_FOURTH_INTERFACE)
#define NB_MAC_OCTET_4      (3)
#define NB_MAC_OCTET_5      (4)
#define NB_MAC_OCTET_5_XOR  (0x80)
 
#endif /* NB_MAC_ADDRESS */
 
 
/*-----------------------------------------------------------------------------
 * Callback Function Prototypes
 *-----------------------------------------------------------------------------*/
 
/*
 ******************************************************************************
 
   Process Internet Protocol Packet (IP)
 
   Parameters:
      poolPtr           - Packet from pool
      ethernetFramePtr  - Ethernet frame
      checksum          - IP frame checksum
 
   Return:
      None
 
   Notes;
      Called for every IP packet received and meets this criteria.
         1)The packet is an IP packet.
         2)The IP header checksum is valid.
         3)The packet was addressed to us or to a broadcast address.
      Before the callback is called the flags member of the buffer is setup to
      indicate physical broadcast etc....
 
 ******************************************************************************
 */
typedef void(ProcessPacketFunc)(PoolPtr poolPtr, PEFRAME ethernetFramePtr, uint16_t checksum);
 
/*
 ******************************************************************************
 
   Process Address Resolution Packet (ARP)
 
   Parameters:
      poolPtr           - Packet from pool
      ethernetFramePtr  - Ethernet frame
 
   Return:
      None
 
   Notes;
      Called for every ARP packet received. Before the callback is called the
      flags member of the buffer is setup to indicate physical broadcast etc...
 
 ******************************************************************************
 */
typedef void(ProcessArpFunc)(PoolPtr poolPtr, PEFRAME ethernetFramePtr);
 
/*
 ******************************************************************************
 
   Process Address LLDP
 
   Parameters:
      poolPtr           - Packet from pool
      ethernetFramePtr  - Ethernet frame
 
   Return:
      None
 
   Notes;
      If filled in called for every LLDP frame
      flags member of the buffer is setup to indicate physical broadcast etc...
 
 ******************************************************************************
 */
typedef void (*ProcessLLDPptr)(PoolPtr poolPtr);
 
extern ProcessLLDPptr pProcessLLDP;
 
/*
 ******************************************************************************
 
   Returns current link active status
 
   Parameters:
      None
 
   Return:
      TRUE active, FALSE all else.
 
   Notes:
      Interface driver must minimize latency.
 
 ******************************************************************************
 */
typedef BOOL(LinkActiveFunc)(void);
 
 
/*
 ******************************************************************************
 *
 * Data Structures
 *
 ******************************************************************************
 */
 
#define INTF_CSUM_IP    (0x01)
#define INTF_CSUM_ICMP  (0x02)
#define INTF_CSUM_UDP   (0x04)
#define INTF_CSUM_TCP   (0x08)
#define INTF_CSUM_IP6   (0x10)
#define INTF_CSUM_ICMP6 (0x20)
#define INTF_CSUM_UDP6  (0x40)
#define INTF_CSUM_TCP6  (0x80)
 
#define INTF_CSUM_ALL4 (INTF_CSUM_IP | INTF_CSUM_ICMP | INTF_CSUM_UDP | INTF_CSUM_TCP)
#define INTF_CSUM_ALL6 (INTF_CSUM_IP6 | INTF_CSUM_ICMP6 | INTF_CSUM_UDP6 | INTF_CSUM_TCP6)
 
 
class InterfaceBlock : public config_obj
{
   public:
    I4Record ip4{"IPv4"};   // The IPv4 configuration for "this" interface, see config_netobj.h for details
#ifdef IPV6
    I6Record ip6{"IPv6"};   // The IPv6 configuration for "this" interface, see config_netobj.h for details
#endif
    config_MACADR MAC{"00:00:00:00:00:00", "MAC"};   // Interface MAC address. May be 0/null for interfaces such as PPP
    config_string device_name{"", "DeviceName"};     // Name of interface. Used to register for DNS and NetBIOS
    config_int    dhcp_discover_secs{1, "DhcpDiscoverSec"};   // How long to wait after boot before sending a DHCP Discover message
    config_string discovery_server{"discover.netburner.com/DevicePost", "DiscoveryReportUrl"};   // NetBurner discover server name
    config_int    discovery_interval{(15 * 60), "DiscoveryReportInterval"};   // How often to report to NetBurner discover server
    config_bool   obfuscate_discovery{true, "DiscoveryObfuscate", "Should discovery obfuscate data"};
    config_bool   supress_default_responses{false, "SupressDefault", "Supress ping and udp Echo ports"};
    config_int    vlan_tag_value{0, "VlanTag"};
 
    ConfigEndMarker;   // Marker for end of configuration structure
 
    int32_t    root_if;             // Root interface number. If multihomed, the interface would be a child of the root interface
    int32_t    my_ifnum;            // This interface number
    uint16_t   netMss;              // Network max segment size for this interface
    uint8_t    checksumOffload;     // Non-zero if hardware interface support offloading checksum calculation
    bool       bHaveSeenLink;       // Have seen a link at once before
    DhcpObject dhcpClient{this};    // DHCP client support
    discover_servlet disco_servlet{this};   // the servlet that runs the NetBurner discovery server process
    void (*MCastLinkNotify)(InterfaceBlock *pBlock, bool bLink);   // A funciton pointer called when link changes for multicast.
 
    IPADDR4 previous_addr;
    IPADDR4 previous_mask;
    IPADDR4 previous_gate;
 
#ifdef AUTOIP                  // if not defined don't compile anything...
    AutoIPClient AutoClient;   // AutoIP client object for this interface
#endif
 
#if defined MULTIHOME
    BOOL bMultiHome;          // True if this is a multihomed interface
    InterfaceBlock *pChild;   // Parrent points to list, children are linked list of pchilds.
#endif
 
    InterfaceBlock(const char *name, const char *desc = NULL);
 
    InterfaceBlock(config_obj &owner, const char *name, const char *desc = NULL);
 
    void RegisterInterface();
 
    virtual void send_func(PoolPtr poolPtr) = 0;
    virtual void kill_if();
 
    virtual void EnableMulticast(MACADR macAddress, BOOL addAddress) = 0;
 
    virtual bool LinkActive() = 0;
 
    virtual int LinkSpeed() = 0;
 
    virtual bool LinkDuplex() = 0;
 
    void InterfaceLinkChange(bool link);
 
    virtual const char *GetInterfaceName();
 
    int GetInterfaceNumber() { return my_ifnum; }
 
    inline bool IsRootInterface() { return root_if == 0; }
 
    // Move values from the IPV4 settings to cur stuff.
    // Starts /Shutdowns DHCP if necessary
    // Stores previous values in  previous_addr,_mask,_gate;
    // Returns true if the address changed.
    bool ProcessIPConfigChange(uint16_t ticks_to_wait);
 
    //Used if the web page changes IP values to swap so one can complete socket.
    void SwapOldAndCurrentAddr();
 
    virtual bool bNeedsArp() { return true; };
    void fdShowInterfaceValues(int fd);
    inline void ShowInterfaceValues() { fdShowInterfaceValues(1); };
    void SetDefaultFlags();
    // Called by DHCP client when we get new settings...
    void DHCPNotify();
 
#if defined MULTIHOME
    int RegisterMultiHomeInterface(InterfaceBlock &UnderBlock);
#endif
};
 
 
 
// Adds additional features to an InterfaceBlock. Defaults to most features disabled
class EtherLikeInterface : public InterfaceBlock
{
   public:
    ConfigEndMarker;
    EtherLikeInterface(const char *name, const char *desc = NULL) : InterfaceBlock(name, desc)
    {
        ip4.SetFlag(fConfigHidden);
#ifdef IPV6
        ip6.SetFlag(fConfigHidden);
#endif
        MAC.SetFlag(fConfigHidden);
        SetFlag(fConfigHidden);
    }
 
    EtherLikeInterface(config_obj &owner, const char *name, const char *desc = NULL) : InterfaceBlock(owner, name, desc)
    {
        ip4.SetFlag(fConfigHidden);
#ifdef IPV6
        ip6.SetFlag(fConfigHidden);
#endif
        MAC.SetFlag(fConfigHidden);
        SetFlag(fConfigHidden);
    }
 
    virtual void Enable()
    {
        ClrFlag(fConfigHidden);
        ip4.ClrFlag(fConfigHidden);
#ifdef IPV6
        ip6.ClrFlag(fConfigHidden);
#endif
        MAC.ClrFlag(fConfigHidden);
        MAC.SetFlag(fConfigReadOnly);
    }
};
 
/* Global receive processing definition */
int NetDoRX(PoolPtr pp, uint16_t count, int if_num);
 
/*
 ******************************************************************************
 *
 * External Definitions
 *
 ******************************************************************************
 */
/*
   System ARP Process Function
*/
extern ProcessArpFunc *pArpFunc;
 
#ifdef IPV6
 
/*
 ******************************************************************************
 
   IP6  Network Packet
 
   Parameters:
      poolPtr           - Packet from pool
 
   Return:
      None
 
 ******************************************************************************
 */
typedef void(ProcessIp6Func)(PoolPtr poolPtr);
 
extern ProcessIp6Func *pIp6Func;
 
#endif
 
/*
   System IP Packet Process Function
*/
extern ProcessPacketFunc *pPacketfunc;
 
/*
 ******************************************************************************
 *
 * Routine Prototypes
 *
 ******************************************************************************
 */
 
/*
 ******************************************************************************
 
   Selects Packet Transmission for the Interface
 
   Parameters:
      poolPtr        - Packet from pool
      interface      - Interface number
 
 
   Return:
      None
 
   Notes:
      Frees buffer if interface is not valid
 
 ******************************************************************************
 */
void TransmitBuffer(PoolPtr poolPtr, int interface);
 
/*
 ******************************************************************************
 
   Extracts Data (Ethernet Frame) Pointer from Pool Packet
 
   Parameters:
      poolPtr        - Packet from pool
 
 
   Return:
      Pointer to data segment (ethernet frame) of pool packet.
 
   Notes:
      Does not check for validity
 
 ******************************************************************************
 */
inline PEFRAME GetEframe(PoolPtr pp)
{
    return (PEFRAME)pp->pData;
}
 
inline PVLEFRAME GetVLEframe(PoolPtr pp)
{
    return (PVLEFRAME)pp->pData;
}
 
 
int Removeinterface(int interface);
 
 
void EnableMulticast(MACADR macAddress, int interface = 0);
 
void DisableMulticast(MACADR macAddress, int interface = 0);
 
 
InterfaceBlock *GetInterfaceBlock(int interface = 0);
 
 
int32_t GetFirstInterface(void);
 
 
int32_t GetNextInterface(int lastInterface);
 
 
int32_t GetInterfaceNumber(InterfaceBlock *pifb);
 
 
int32_t GetInterfaceForMyAddress4(IPADDR4 ip);
 
 
bool GetInterfaceLink(int ifn);
 
 
/*
 ******************************************************************************
 *
 * Runtime Libraries Routine Prototypes
 *
 ******************************************************************************
 */
 
/*
 ******************************************************************************
 
   Initialize the first Ethernet Interface
 
   Parameters:
      processPacketFuncPtr    - IP Packet process function
      processArpFuncPtr       - ARP Packet process function
 
 
   Return:
      TRUE success, else problems
 
   Notes:
      Should be called once in the system to create first interface.
 
 ******************************************************************************
 */
BOOL InitializeNetwork(ProcessPacketFunc *processPacketFuncPtr, ProcessArpFunc *processArpFuncPtr);
 
/*
 ******************************************************************************
 
   Disables network.
 
   Parameters:
      None
 
   Return:
      None
 
   Notes:
      None
 
 ******************************************************************************
 */
void StopNetworks(void);
 
/*
 ******************************************************************************
 
   Get current network settings.
 
   Parameters:
      interface      - Interface number
 
   Return:
      Specific setting requested for the interface, 0 if invalid interface.
 
   Notes:
      None
 
 ******************************************************************************
 */
 
MACADR InterfaceMAC(int interface);
 
bool InterfaceLinkActive(int interface);
 
 
int InterfaceLinkSpeed(int interface);
 
 
bool InterfaceLinkDuplex(int interface);
 
const char *InterfaceName(int interface);
 
 
void UnWrapVlan(PoolPtr pp, int len);
 
 
 
 
IPADDR4 InterfaceIP(int interface);
 
IPADDR4 InterfaceAutoIP(int interface);
 
IPADDR4 InterfaceDNS(int interface);
 
IPADDR4 InterfaceDNS2(int interface);
 
IPADDR4 InterfaceMASK(int interface);
 
IPADDR4 InterfaceGate(int interface);
 
#endif /* _NB_NETIF_H */