ip.h

Go to the documentation of this file.

/*NB_REVISION*/
 
/*NB_COPYRIGHT*/
 
#ifndef _NB_IP_H
#define _NB_IP_H
 
// NB Definitions
#include <predef.h>
 
#ifndef NB_NET_TYPES_H
#include "nettypes.h"
#endif
 
#ifndef _NB_BUFFERS_H
#include "buffers.h"
#endif
// #define IP_DEBUG              ( 0 )
 
/* Definitions */
 
#define IP_VERSION_MASK (0xF0) 
#define IP_VERSION_IPv4 (0x40) 
#define IP_VERSION_IPv6 (0x60) 
#define IP_HEADER_LENGTH_MASK (0x0F) 
#define IP_HEADER_LENGTH_NO_OPTIONS (0x05) 
#define IP_FLAGS_MASK (0xE000) 
#define IP_FRAGMENT_OFFSET_MASK (0x1FFF) 
#define IP_PROTOCOL_ICMP (0x01) 
#define IP_PROTOCOL_IGMP (0x02) 
#define IP_PROTOCOL_INTERNET (0x04) 
#define IP_PROTOCOL_TCP (0x06) 
#define IP_PROTOCOL_UDP (0x11) 
#define ICMP_TYPE_ECHO_REPLY (0) 
#define ICMP_CODE_ECHO_REPLY (0) 
#define ICMP_TYPE_DEST_UNREACHABLE (3) 
#define ICMP_CODE_PORT_UNREACHABLE (3) 
#define ICMP_TYPE_SOURCE_QUENCH (4) 
#define ICMP_CODE_SOURCE_QUENCH (0) 
#define ICMP_TYPE_REDIRECT_MESSAGE (5) 
#define ICMP_TYPE_ECHO_REQUEST (8) 
#define ICMP_CODE_ECHO_REQUEST (0) 
#define IANA_ECHO_PORT (7) 
#define IANA_DISCARD_PORT (9) 
#define IANA_SSH_PORT (22) 
#define IANA_TELNET_PORT (23) 
//#define IANA_TFTP_PORT (69) /**< @b */
#define IANA_NETBIOS_NAME_SERVICE_PORT (137) 
#define ICMP_PING_DATA_SIZE (32) 
/* Data Structures */
 
typedef struct _IpHeaderIPv4
{
    uint8_t versionNLength; 
    uint8_t diffServNEcn; 
    beuint16_t totalLength; 
    beuint16_t identification; 
    beuint16_t flagsNFragmentOffset; 
    uint8_t timeToLive; 
    uint8_t protocol; 
    beuint16_t headerChecksum;
    beuint32_t sourceAddress; 
    beuint32_t destinationAddress; 
} __attribute__((packed)) IpHeaderIPv4;
 
typedef struct
{
    uint8_t bVerHdrLen; 
    uint8_t bTos; 
    beuint16_t wLength; 
    beuint16_t wpktId; 
    beuint16_t wFlags_Frag; 
    uint8_t bTTL; 
    uint8_t proto; 
    uint16_t hCSum;
    IPADDR4 ipSrc; 
    IPADDR4 ipDst; 
    uint8_t DATA[]; 
} __attribute__((packed)) IPPKT;
 
typedef IPPKT *PIPPKT;
 
typedef struct
{
    beuint16_t srcPort; 
    beuint16_t dstPort; 
    beuint16_t UdpLen; 
    uint16_t UdpCSum;
    uint8_t DATA[]; 
} __attribute__((packed)) UDPPKT;
typedef UDPPKT *PUDPPKT;
 
typedef struct
{
    beuint16_t proto; 
    beuint16_t len; 
    IPADDR4 srcip; 
    IPADDR4 dstip; 
} PsudeoHeader;
typedef PsudeoHeader *PPSUH;
 
extern uint8_t bTTL_Default; 
extern uint16_t wArpLifetime; 
extern BOOL bQuietStart; 
/* "C" Internal Functions */
 
void IpProcessEthernetPacket(PoolPtr poolPtr, uint16_t packetSizeInBytes);
 
extern "C"
{
    uint16_t GetSum(puint16_t addr, uint16_t count); 
    uint16_t GetSum20(puint32_t addr); 
    uint16_t GetSumHdr(PsudeoHeader &hdr, puint16_t addr, uint16_t count); 
}
 
BOOL IsMyIp4(IPADDR4 ip, int ifc = -1); 
IPADDR4 GetSrcIp4(IPADDR4 dst); 
IPADDR4 GetSrcIpwIf4(int ifn, const IPADDR4 dst); 
#ifdef IPV6
BOOL IsMyIp6(const IPADDR &ip, int ifc = -1);
inline BOOL IsMyIp(const IPADDR &ip, int ifc = -1)
{
    return IsMyIp6(ip, ifc);
};
 
IPADDR GetSrcIp6(const IPADDR &dst);
inline IPADDR GetSrcIp(const IPADDR &dst)
{
    return GetSrcIp6(dst);
};
 
IPADDR GetSrcIp6wIf(int ifn, const IPADDR &dst);
inline IPADDR GetSrcIpwIf(int ifn, const IPADDR &dst)
{
    return GetSrcIp6wIf(ifn, dst);
};
 
#else
inline BOOL IsMyIp(IPADDR4 ip, int ifc = -1)
{
    return IsMyIp4(ip, ifc);
};
inline IPADDR4 GetSrcIp(IPADDR4 dst)
{
    return GetSrcIp4(dst);
};
inline IPADDR4 GetSrcIpwIf(int ifn, IPADDR4 dst)
{
    return GetSrcIpwIf4(ifn, dst);
};
 
#endif
 
/* "C++" Internal Functions */
 
void SendICMPError(PoolPtr pBadPacket, uint8_t type, uint8_t code); 
void FixHeaderAndSend(PoolPtr p, PIPPKT pIp); 
void FixHeaderAndSendViaInterface(PoolPtr p, PIPPKT pIp, int Interface); 
inline PIPPKT GetIpPkt(PoolPtr p)
{
    return (p == NULL) ? NULL : (PIPPKT)(p->pData + 14);
};
 
inline PIPPKT GetIpPkt(PEFRAME pFrame)
{
    return (PIPPKT)(pFrame->pData);
};
 
inline PIPPKT GetIpPkt(PVLEFRAME pFrame)
{
    return (PIPPKT)(pFrame->pData);
};
 
inline PUDPPKT GetUdpPkt(PIPPKT pIp)
{
    if (pIp == NULL) { return NULL; }
    if (pIp->bVerHdrLen == 0x45) { return (PUDPPKT)pIp->DATA; }
    return (PUDPPKT)(pIp->DATA + (((pIp->bVerHdrLen & 0XF) * 4) - 20));
}
 
/* "C++" Runtime Library Functions */
 
void InitializeStack();
 
/*
 *******************************************************************************
 *
 * UPD fragment packet pointer for user defined function.
 *
 *    Parameters:
 *       pp             - Packet pointer from network buffer pool
 *
 *    Return:
 *       None
 *
 *    Notes:
 *       This is only called for packets with the fragmentation flag set
 *
 *******************************************************************************
 */
typedef void(FragmentProcessFunction)(PoolPtr pp);
extern FragmentProcessFunction *pFragFunc;
 
/*
 *******************************************************************************
 *
 * Promiscuous packet pointer for user defined function.
 *
 *    Parameters:
 *       pp             - Packet pointer from network buffer pool
 *
 *    Return:
 *       None
 *
 *    Notes:
 *       This is only called for packets that fail the IP address == my address.
 *       This function must free the buffers it receives!
 *
 *******************************************************************************
 */
typedef void(PromisciousPacketFunc)(PoolPtr pp);
extern PromisciousPacketFunc *pPromisciousPacketFunc;
 
/*
 *******************************************************************************
 *
 * UDP task packet function pointer
 *
 *    Parameters:
 *       pkt            - UDP packet
 *       ifn            - Interface number
 *
 *    Return:
 *       None
 *
 *    Notes:
 *       None
 *
 *******************************************************************************
 */
class UDPPacket;
typedef int(TaskPacketFunc)(UDPPacket &pkt, int ifn);
extern TaskPacketFunc *pTaskPacketFunc;
 
/*
 *******************************************************************************
 *
 * Display buffer for diagnostic purposes
 *
 *    Parameters:
 *       rp             - Packet pointer from network buffer pool
 *
 *    Return:
 *       None
 *
 *    Notes:
 *       Uses iprintf
 *
 *******************************************************************************
 */
void ShowIPBuffer(PoolPtr rp);
 
/*
 *******************************************************************************
 *
 * Sends a "ping" packet and waits the specified timeout for a response.
 *
 *    Ping uses the primary network interface (usually the Ethernet)
 *    PingViaInterface allows the selection of network interface
 *    SendPing does not wait for a response.
 *
 *    Parameters:
 *       to             - Destination address
 *       id             - Identifier
 *       seq            - Sequence number
 *       maxwaitticks   - Wait time in ticks
 *
 *    Return:
 *       >=0   Ticks wait for the response
 *       -1    Timeout
 *       -2    Error other than timeout.
 *    Notes:
 *       Sends ICMP echo request with specified identifier, sequence number and
 *       32 bytes of ASCII data ('a' (0x61) through 0xFF ).
 *       Expects echo reply with same data
 *
 *******************************************************************************
 */
int Ping4(IPADDR4 to, uint16_t id, uint16_t seq, uint16_t maxwaitticks);
int Ping4ViaInterface(IPADDR4 to, uint16_t id, uint16_t seq, uint16_t wait, int interface);
 
#ifdef IPV6
int Ping6(const IPADDR &to, uint16_t id, uint16_t seq, uint16_t maxwaitticks, int size = 32);
int Ping6ViaInterface(const IPADDR &to, uint16_t id, uint16_t seq, uint16_t wait, int interface, int size = 32);
inline int Ping(const IPADDR &to, uint16_t id, uint16_t seq, uint16_t maxwaitticks, int size = 32)
{
    return Ping6(to, id, seq, maxwaitticks, size);
};
inline int PingViaInterface(const IPADDR &to, uint16_t id, uint16_t seq, uint16_t wait, int interface, int size = 32)
{
    return Ping6ViaInterface(to, id, seq, wait, interface, size);
};
#else
inline int Ping(IPADDR4 to, uint16_t id, uint16_t seq, uint16_t maxwaitticks)
{
    return Ping4(to, id, seq, maxwaitticks);
};
inline int PingViaInterface(IPADDR4 to, uint16_t id, uint16_t seq, uint16_t wait, int interface)
{
    return Ping4ViaInterface(to, id, seq, wait, interface);
};
#endif
 
BOOL IsLocal4(IPADDR4 ip, int ifc);
int GetProperInterface4(IPADDR4 dst);
 
#if defined MULTIHOME || defined AUTOIP
int AddInterface(IPADDR4 addr, IPADDR4 mask, IPADDR4 gateway, int root_if);
int GetMultiHomeInterface(IPADDR4 ipa, int norgif);
int GetLocalIPInterface4(IPADDR4 ipa);
#ifdef IPV6
int GetLocalIPInterface6(const IPADDR &ipa);
inline int GetLocalIPInterface(const IPADDR &ipa)
{
    return GetLocalIPInterface6(ipa);
};
#else
inline int GetLocalIPInterface(IPADDR4 ipa)
{
    return GetLocalIPInterface4(ipa);
};
#endif
#endif
 
    /*
     *******************************************************************************
     *
     * Deprecated and Backward Compatibility Runtime Library Functions
     *
     *******************************************************************************
     */
 
#ifndef IPV6
#ifndef IPV4ONLY
#error Got to pick an IP version
#endif
#endif
 
// Get a random port value for random return port values
uint16_t GetEphemeralPort();
 
#endif /* #ifndef _NB_IP_H */