vlInetAddrUtils.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 1992-2025 MAK Technologies, Inc
** All rights reserved.
*********************************************************************/
#pragma once

#include <vlutil/vlInet.h>
#include <vlutil/vlString.h>

#ifdef DtUSE_UTILITIES_NAMESPACE
namespace DtUSE_UTILITIES_NAMESPACE
{
#endif

class DtInetAddr;

namespace DtInetUtils
{
#define DtUSE_DEFAULT_INET_ADDR 0
#define DtINET_IGMPv4_MGMT_GROUP_ADDR 0xE0000001   // == 224.0.0.1

#define DtInet_IPv4_ADDR_LEN  sizeof( struct in_addr )
#define DtInet_IPv6_ADDR_LEN  sizeof( struct in6_addr )

#define DtNetResLocType_NONE      0
#define DtNetResLocType_PORT      1
#define DtNetResLocType_NETMASK   2
#define DtNetResLocType_PREFIXLEN 3


#define DtINET_IPv4_LINK_LOCAL_MASK 0xa9fe0000  // == 169.254.0.0/16
#define DtINET_IPv4_LOOPBACK_MASK   0x7f000001  // == 127.0.0.1
#define DtINET_IPv6_LINK_LOCAL_MASK 0xfe80      // uppermost 10 bits of address


// NB: The reason these values are not the same as AF_INET and AF_INET6 is
// simply to make it easier to use these enums in log messages that
// identify an address family.
enum DtInetAddrFamily
{
   DtInetAddrFamily_INVALID  = 0,
   DtInetAddrFamily_IPv4     = 4,
   DtInetAddrFamily_IPv6     = 6,
   DtInetAddrFamily_Both     = 99
};


DT_DLL_VLUTIL DtInetAddrFamily addrStringFamily(const DtString& addrString);

DT_DLL_VLUTIL bool isIpv4AddrString(const DtString& addrString);

DT_DLL_VLUTIL bool isIpv6AddrString(const DtString& addrString);

DT_DLL_VLUTIL bool isLoopbackAddrString(const DtString& addrString);

DT_DLL_VLUTIL bool isLocalhostAddrString(const DtString& addrString);

DT_DLL_VLUTIL bool isLinkLocalAddrString(const DtString& addrString);

DT_DLL_VLUTIL bool isMulticastAddrString(const DtString& addrString);

DT_DLL_VLUTIL bool isBroadcastAddrString(const DtString& addrString, const DtString& netmaskString = "");

DT_DLL_VLUTIL DtInetAddrFamily parseNetResLoc(const DtString& nrl, DtString& parsedNrl,
                                DtString& modifier, int& modifierType);

DT_DLL_VLUTIL bool parseIpv4NetResLoc(const DtString& nrl, DtString& parsedNrl,
                        DtString& modifier, int& modifierType);
DT_DLL_VLUTIL bool parseIpv6NetResLoc(const DtString& nrl, DtString& parsedNrl,
                        DtString& modifier, int& modifierType);

DT_DLL_VLUTIL DtU32 prefixLenToIpv4Netmask( DtU32 prefixLen );

DT_DLL_VLUTIL DtU32 netmaskToPrefixLen( DtU32 netmask );

DT_DLL_VLUTIL DtU32 convertStringToNetmask( DtString maskString );

DT_DLL_VLUTIL DtU32 convertStringToPrefixLen( DtString maskString );

DT_DLL_VLUTIL DtInetAddr* getPrimaryBroadcastAddress(bool preferIpv6 = false);

DT_DLL_VLUTIL const char* removeZoneIndex(char* addrStr);


#ifdef _WIN32
inline bool IN6_IS_ADDR_BROADCAST(const struct in6_addr *a)
{
   return ( IN6_IS_ADDR_MC_LINKLOCAL(a) 
         && ((a->s6_bytes[2] & 0xf) == 0) && ((a->s6_bytes[3] & 0xf) == 0)
         && ((a->s6_bytes[4] & 0xf) == 0) && ((a->s6_bytes[5] & 0xf) == 0)
         && ((a->s6_bytes[6] & 0xf) == 0) && ((a->s6_bytes[7] & 0xf) == 0)
         && ((a->s6_bytes[8] & 0xf) == 0) && ((a->s6_bytes[9] & 0xf) == 0)
         && ((a->s6_bytes[10] & 0xf) == 0) && ((a->s6_bytes[11] & 0xf) == 0)
         && ((a->s6_bytes[12] & 0xf) == 0) && ((a->s6_bytes[13] & 0xf) == 0)
         && ((a->s6_bytes[14] & 0xf) == 0) && ((a->s6_bytes[15] & 0xf) == 1) );
}
#else // !_WIN32
inline bool IN6_IS_ADDR_BROADCAST(const struct in6_addr *a)
{
   return ( IN6_IS_ADDR_MC_LINKLOCAL(a) 
         && ((a->s6_addr[2] & 0xf) == 0) && ((a->s6_addr[3] & 0xf) == 0)
         && ((a->s6_addr[4] & 0xf) == 0) && ((a->s6_addr[5] & 0xf) == 0)
         && ((a->s6_addr[6] & 0xf) == 0) && ((a->s6_addr[7] & 0xf) == 0)
         && ((a->s6_addr[8] & 0xf) == 0) && ((a->s6_addr[9] & 0xf) == 0)
         && ((a->s6_addr[10] & 0xf) == 0) && ((a->s6_addr[11] & 0xf) == 0)
         && ((a->s6_addr[12] & 0xf) == 0) && ((a->s6_addr[13] & 0xf) == 0)
         && ((a->s6_addr[14] & 0xf) == 0) && ((a->s6_addr[15] & 0xf) == 1) );
}
#endif

} 

#ifdef DtUSE_UTILITIES_NAMESPACE
} 
#endif