IPv6Address.h

Go to the documentation of this file.

//
// Copyright (C) 2005 Wei Yang, Ng
// Copyright (C) 2005 Andras Varga
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this program; if not, see <http://www.gnu.org/licenses/>.
//


#ifndef __IPv6ADDRESS_H
#define __IPv6ADDRESS_H

#include <omnetpp.h>
#include <iostream>
#include <string>
#include "INETDefs.h"

class InterfaceToken;

class INET_API IPv6Address
{
    private:
        // Declare an unsigned 32 bit integer array of size 4.
        // 32x4 = 128 bits, which is the size of an IPv6 Address.
        uint32 d[4];

    protected:
        bool doTryParse(const char *&addr);

    public:
        // FIXME TBD add multicast address scopes!!! rfc 3513, section 2.7
        enum Scope
        {
            UNSPECIFIED,
            LOOPBACK,
            MULTICAST,
            LINK,
            SITE,
            GLOBAL
        };

        static const IPv6Address UNSPECIFIED_ADDRESS;

        static const IPv6Address LOOPBACK_ADDRESS;

        static const IPv6Address ALL_NODES_1;

        static const IPv6Address ALL_NODES_2;

        static const IPv6Address ALL_ROUTERS_1;

        static const IPv6Address ALL_ROUTERS_2;

        static const IPv6Address ALL_ROUTERS_5;

        static const IPv6Address SOLICITED_NODE_PREFIX;

        static const IPv6Address LINKLOCAL_PREFIX;

        IPv6Address()  {
            d[0]=d[1]=d[2]=d[3]=0;
        }

        IPv6Address(uint32 segment0, uint32 segment1, uint32 segment2, uint32 segment3)  {
            d[0] = segment0;
            d[1] = segment1;
            d[2] = segment2;
            d[3] = segment3;
        }

        IPv6Address(const char *addr) {set(addr);}

        bool operator<(const IPv6Address& addr) const {return compare(addr)<0;}
        bool operator>(const IPv6Address& addr) const {return compare(addr)>0;}
        bool operator==(const IPv6Address& addr) const {
            return d[3]==addr.d[3] && d[0]==addr.d[0] && d[1]==addr.d[1] && d[2]==addr.d[2]; // d[3] differs most often, compare it first
        }
        bool operator!=(const IPv6Address& addr) const {return !operator==(addr);}

        int compare(const IPv6Address& addr) const  {
            return d[0]<addr.d[0] ? -1 : d[0]>addr.d[0] ? 1 :
                   d[1]<addr.d[1] ? -1 : d[1]>addr.d[1] ? 1 :
                   d[2]<addr.d[2] ? -1 : d[2]>addr.d[2] ? 1 :
                   d[3]<addr.d[3] ? -1 : d[3]>addr.d[3] ? 1 : 0;
        }

        bool tryParse(const char *addr);

         bool tryParseAddrWithPrefix(const char *addr, int& prefixLen);

        void set(const char *addr);

        std::string str() const;

        void set(uint32 d0, uint32 d1, uint32 d2, uint32 d3) {
            d[0]=d0; d[1]=d1; d[2]=d2; d[3]=d3;
        }

        uint32 *words() {return d;}

        const uint32 *words() const {return d;}

        Scope getScope() const;

        static const char *scopeName(Scope s);

        static void constructMask(int prefixLength, uint32* mask);

        IPv6Address getPrefix(int prefixLength) const;

        IPv6Address getSuffix(int prefixLength) const;

        const IPv6Address& setPrefix(const IPv6Address& fromAddr, int prefixLength);

        const IPv6Address& setSuffix(const IPv6Address& fromAddr, int prefixLength);

        IPv6Address formSolicitedNodeMulticastAddress() const {
            return IPv6Address(*this).setPrefix(SOLICITED_NODE_PREFIX, 104);
        };

        // TODO revise doc, revise function! make static?  (Andras)
        IPv6Address formSubnetRouterAnycastAddress(int prefixLength) const {
            return IPv6Address(*this).setSuffix(UNSPECIFIED_ADDRESS, prefixLength);
        }

        static IPv6Address formLinkLocalAddress(const InterfaceToken& ident);

        bool matches(const IPv6Address& prefix, int prefixLength) const;

        bool isUnspecified() const  {return (d[0]|d[1]|d[2]|d[3])==0;}

        bool isMulticast() const {return getScope()==MULTICAST;}

        bool isUnicast() const {return getScope()!=MULTICAST && getScope()!=UNSPECIFIED;}

        bool isLoopback() const {return getScope()==LOOPBACK;}

        bool isLinkLocal() const {return getScope()==LINK;}

        bool isSiteLocal() const {return getScope()==SITE;}

        bool isGlobal() const {return getScope()==GLOBAL;}

        int getMulticastScope() const;
};

/*
class INET_API IPv6AddressPrefix : public IPv6Address
{
    public:
        char length;
};
*/

inline std::ostream& operator<<(std::ostream& os, const IPv6Address& ip)
{
    return os << ip.str();
}

inline void doPacking(cCommBuffer *buf, const IPv6Address& addr)
{
    buf->pack(addr.words(), 4);
}

inline void doUnpacking(cCommBuffer *buf, IPv6Address& addr)
{
    buf->unpack(addr.words(), 4);
}

#endif