vlInetDevice.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 1992-2010 VT MAK
** All rights reserved.
*********************************************************************/
#pragma once

#include <vlutil/vlInet.h>
#include <vlutil/vlInetAddr.h>
#include <vlutil/vlString.h>
#include <vlutil/vlSmartPointers.h>
#include <vector>
#ifndef _WIN32
#include <net/if.h> // for IFNAMSIZ
#endif

#ifdef DtUSE_UTILITIES_NAMESPACE
namespace DtUSE_UTILITIES_NAMESPACE
{
#endif

#ifdef _WIN32
// Different physical network connection types have different physical address
// structures. Allow for more than just an Ethernet MAC address.
#define DtInet_MAX_PHYSADDR_LEN MAX_ADAPTER_ADDRESS_LENGTH
#define DtMAX_DEVICE_NAME_LEN 128 // Windows is ???? so be safe
#define DtInet_INITIAL_IFCONF_BUFF_SIZE sizeof(IP_ADAPTER_ADDRESSES)

#define DtInet_IFSTATE_UP       IfOperStatusUp
#define DtInet_IFSTATE_DOWN     IfOperStatusDown
#define DtInet_IFSTATE_ACTIVE   IfOperStatusUp
#define DtInet_IFSTATE_UNKNOWN  IfOperStatusUnknown

#else
// Different physical network connection types have different physical address
// structures. Allow for more than just an Ethernet MAC address.
#define DtInet_MAX_PHYSADDR_LEN 8
#define DtMAX_DEVICE_NAME_LEN IFNAMSIZ // typically 16
#define DtInet_INITIAL_IFCONF_BUFF_SIZE sizeof(struct ifreq)
#ifdef __solaris__
#define DtInet_INITIAL_LIFCONF_BUFF_SIZE sizeof(struct lifreq)
#endif

#define DtInet_IFSTATE_UP       IFF_UP
#define DtInet_IFSTATE_DOWN     0
#define DtInet_IFSTATE_ACTIVE   IFF_RUNNING
#define DtInet_IFSTATE_UNKNOWN  0

//#define DtInet_IF_ETHERNET ARPHRD_ETHER
//#define DtInet_IF_FDDI     ARPHRD_FDDI
//#define DtInet_IF_IEEE1394 ARPHRD_IEEE1394
//#define DtInet_IF_WIFI     ARPHRD_IEEE80211
//#define DtInet_IF_LOOPBACK ARPHRD_LOOPBACK
//#define DtInet_IF_OTHER    ARPHRD_VOID

#endif
typedef DtU8 DtInetMacAddr[DtInet_MAX_PHYSADDR_LEN];

// The standard ifreq structure does not support IPv6 addresses (sockaddr_in6)
// so we have to define our own. In stark contrast to the standard ifreq struct
// this one stores all the information in a single structure.
struct ifinfo_in6
{
   struct  sockaddr_in6 ifinfo_addr;
   struct  sockaddr_in6 ifinfo_dstaddr;
   struct  sockaddr_in6 ifinfo_broadaddr;
   unsigned long        ifinfo_flags;
   unsigned long        ifinfo_prefix;
   unsigned long        ifinfo_scope;
   u_short              ifinfo_site6;     // currently not used
   unsigned long        ifinfo_mtu;       // currently not used
};

struct ifreq_in6
{
   char ifr6_name[DtMAX_DEVICE_NAME_LEN];
   union
   {
      struct ifinfo_in6   ifru_info_in6;
      caddr_t             ifru_data;
   } ifr6_ifru_in6;
#define ifr6_info_in6   ifr6_ifru_in6.ifru_info_in6
#define ifr6_data       ifr6_ifru_in6.ifru_data
};

enum DtInetIfLinkType
{
   DtInet_IF_ETHERNET,
   DtInet_IF_FDDI,
   DtInet_IF_IEEE1394,
   DtInet_IF_WIFI,
   DtInet_IF_LOOPBACK,
   DtInet_IF_OTHER
};

class DtInetDevice;
typedef DtBoost::shared_ptr<DtInetDevice> DtInetDeviceSP;

class DT_DLL_VLUTIL DtInetDevice
{
public:

   DtInetDevice( const DtInetAddr& addr );
   DtInetDevice( const DtString& deviceName,
      DtInetUtils::DtInetAddrFamily fam = DtInetUtils::DtInetAddrFamily_IPv4 );

#ifdef _WIN32
   DtInetDevice( PIP_ADAPTER_ADDRESSES devInfo,
      DtInetUtils::DtInetAddrFamily fam = DtInetUtils::DtInetAddrFamily_IPv4 );
#else
// DEBUG -- DAA what struct does SOLARIS use for IPv4 devices?
#ifdef __solaris__
   DtInetDevice( int sock, struct lifreq* devInfo,
                 struct ifreq_in6* ipv6DevInfo,
      DtInetUtils::DtInetAddrFamily fam = DtInetUtils::DtInetAddrFamily_IPv4 );
#else
   DtInetDevice( int sock, struct ifreq* devInfo,
                 struct ifreq_in6* ipv6DevInfo,
      DtInetUtils::DtInetAddrFamily fam = DtInetUtils::DtInetAddrFamily_IPv4 );
#endif
#endif

   DtInetDevice( const DtInetDevice& orig );

   DtInetDevice& operator=(const DtInetDevice & orig);

   virtual ~DtInetDevice();

   virtual const DtString& deviceName() const;

   virtual const DtInetAddr* addr() const;

   virtual const DtInetAddr* broadcastAddr() const;

   virtual const DtInetAddr* ipv4Addr() const;

   virtual const DtInetAddr* ipv4Netmask() const;

   virtual const DtInetAddr* ipv4BroadcastAddr() const;

   virtual const DtInetAddr* ipv6Addr() const;

   virtual const DtInetAddr* ipv6BroadcastAddr() const;

   virtual unsigned int macAddr(DtInetMacAddr& mac) const ;

   virtual const DtString& macAddrString() const;

   virtual DtInetIfLinkType type() const;

   virtual unsigned int mtu() const;

   virtual unsigned int linkState() const;

   virtual DtInetIpv6Scope linkScope() const;

   virtual bool isUp() const;     // UP means enabled, not necessarily active
   virtual bool isActive() const; // implies link is enabled (UP)
   virtual bool isBroadcastCapable() const;
   virtual bool isMulticastCapable() const;
   virtual bool hasIpv4Addr() const;
   virtual bool hasIpv6Addr() const;

   virtual unsigned int interfaceIndex() const;

   virtual bool isOk() const;

   virtual const DtString& getLastErrorString() const;

   friend DT_DLL_VLUTIL bool operator==(const DtInetDevice& dev1, const DtInetDevice& dev2);
//   virtual bool operator==(const DtInetDevice &);

protected:
   void scanDeviceByName( const DtString& deviceName );   
   void initMACAddrString();

#ifdef _WIN32
   void init( PIP_ADAPTER_ADDRESSES devInfo );
#else
#ifdef __solaris__
   void init( int sockFd, struct lifreq* devInfo,
              struct ifreq_in6* ipv6DevInfo );
#else
   void init( int sockFd, struct ifreq* devInfo,
              struct ifreq_in6* ipv6DevInfo );

#endif
#endif

protected:
   DtString myDeviceName;

   DtInetMacAddr   myMACAddr;
   unsigned int    myMACAddrLen;
   DtString        myMACAddrString;
   DtInetAddr*     myIpv4Addr;
   DtInetAddr*     myIpv4Netmask;
   DtInetAddr*     myIpv6Addr;
   DtInetIpv6Scope myLinkScope;
   bool            myBroadcastEnabled;
   DtInetAddr*     myIpv4BroadcastAddr;
   DtInetAddr*     myIpv6BroadcastAddr;

   DtInetUtils::DtInetAddrFamily myDefaultAddrFam;

   bool                     myMulticastEnabled;
   std::vector<DtInetAddr*> myIpv4McastAddrList;
   std::vector<DtInetAddr*> myIpv6McastAddrList;

   unsigned int      myMtu;
   unsigned int      myLinkState;
   DtInetIfLinkType  myLinkHwType;

   // Interface indexes may change if the network is restarted (Linux) or an
   // interface changes state (Windows) so it is not to be used except during
   // initialization.
   unsigned int myIfIndex;

   bool     myDeviceError;
   DtString myLastErrorString;

   // These two members are used by the *nix version of fetchDeviceInfo to
   // cache the last values used during a successful scan of device interfaces
   // so the next time a scan is requested it can use the buffer size as a
   // starting point and adjust from there if necessary, rather than starting
   // each scan from scratch.
   unsigned int myIfconfBufferSize;
   unsigned int myIfconfResizeFactor;

};
// end of class DtInetDevice

#ifdef DtUSE_UTILITIES_NAMESPACE
} 
#endif