IPv6Extensions.hh

Go to the documentation of this file.

//
// Copyright (c) 2020 Fraunhofer Institute for Applied Information Technology (FIT)
//                    Network Research Group (NET)
//                    Schloss Birlinghoven, 53754 Sankt Augustin, GERMANY
//                    Contact: support@wiback.org
//
// This file is part of the SENF code tree.
// It is licensed under the 3-clause BSD License (aka New BSD License).
// See LICENSE.txt in the top level directory for details or visit
// https://opensource.org/licenses/BSD-3-Clause
//


#ifndef HH_SENF_Packets_DefaultBundle_IPv6Extensions_
#define HH_SENF_Packets_DefaultBundle_IPv6Extensions_ 1

// Custom includes
#include "IPv6ExtOptions.hh"
#include "ListOptionTypeParser.hh"
#include "IPv6Packet.hh"

//#include "IPv6Extensions.mpp"
//-/////////////////////////////////////////////////////////////////////////////////////////////////

namespace senf {

    struct IPv6FragmentPacketParser : public PacketParserBase
    {
#       include SENF_FIXED_PARSER()

        SENF_PARSER_FIELD        ( nextHeader, UInt8Parser );
        SENF_PARSER_PRIVATE_FIELD( reserved1,  UInt8Parser );

        SENF_PARSER_BITFIELD        ( fragmentOffset, 13, unsigned );
        SENF_PARSER_PRIVATE_BITFIELD( reserved2,       2, unsigned );
        SENF_PARSER_BITFIELD        ( moreFragments,   1, bool     );

        SENF_PARSER_FIELD( id, UInt32Parser );

        SENF_PARSER_FINALIZE( IPv6FragmentPacketParser );
    };

    struct IPv6FragmentPacketType
        : public PacketTypeBase,
          public PacketTypeMixin<IPv6FragmentPacketType, IPTypes>
    {
        typedef PacketTypeMixin<IPv6FragmentPacketType, IPTypes> mixin;
        typedef ConcretePacket<IPv6FragmentPacketType> packet;
        typedef IPv6FragmentPacketParser parser;

        using mixin::nextPacketRange;
        using mixin::nextPacketType;
        using mixin::initSize;
        using mixin::init;

        static key_t nextPacketKey(packet p)
            { return p->nextHeader(); }

        static void dump(packet p, std::ostream & os);
        static void finalize(packet p);

        static const IPTypes::key_t ipType = 44;
    };

    typedef ConcretePacket<IPv6FragmentPacketType> IPv6FragmentPacket;
    SENF_PACKET_PREVENT_TEMPLATE_INSTANTIATION( IPv6FragmentPacket );

// =====================================================================================================

    struct IPv6RoutingPacketParser : public PacketParserBase
    {
        /*
        The Type 0 Routing header has the following format: (RFC 2460)

        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
        |  Next Header  |  Hdr Ext Len  | Routing Type=0| Segments Left |
        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
        |                            Reserved                           |
        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
        |                                                               |
        +
        |                                                               |
        +                           Address[1]
        |                                                               |
        +
        |                                                               |
        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
        .                               .                               .
        .                               .                               .
        .                               .                               .
        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
        |                                                               |
        +
        |                                                               |
        +                           Address[n]
        |                                                               |
        +
        |                                                               |
        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
        */
#       include SENF_PARSER()

        SENF_PARSER_FIELD   ( nextHeader,   UInt8Parser    );
        SENF_PARSER_FIELD   ( headerLength, UInt8Parser    );
        SENF_PARSER_FIELD   ( routingType,  UInt8Parser    ); //set to Zero for minimal implementation
        SENF_PARSER_FIELD_RO( segmentsLeft, UInt8Parser    );
        SENF_PARSER_FIELD   ( reserved,     UInt32Parser   ); //set to zero by RFC
        SENF_PARSER_VECTOR  ( hopAddresses, segmentsLeft, INet6AddressParser );

        SENF_PARSER_FINALIZE( IPv6RoutingPacketParser );

        //provisionary, since only type 0 is implemented
        SENF_PARSER_INIT() {
            routingType() = 0u;
            reserved() = 0u;
        }
    };

    struct IPv6RoutingPacketType
    :   public PacketTypeBase,
        public PacketTypeMixin<IPv6RoutingPacketType, IPTypes>
    {
        typedef PacketTypeMixin<IPv6RoutingPacketType, IPTypes> mixin;
        typedef ConcretePacket<IPv6RoutingPacketType> packet;
        typedef IPv6RoutingPacketParser parser;

        using mixin::nextPacketRange;
        using mixin::nextPacketType;
        using mixin::init;
        using mixin::initSize;

        static key_t nextPacketKey(packet p)
            { return p->nextHeader(); }

        static void dump(packet p, std::ostream & os);
        static void finalize(packet p);

        static const IPTypes::key_t ipType = 43;
    };

    typedef ConcretePacket<IPv6RoutingPacketType> IPv6RoutingPacket;
    SENF_PACKET_PREVENT_TEMPLATE_INSTANTIATION( IPv6RoutingPacket );


// =====================================================================================================

    struct IPv6HopByHopOptionsPacketParser : public PacketParserBase
    {
        typedef detail::FixedAuxParserPolicy<UInt8Parser, 1u> ListOptionTypeAuxPolicy;
        typedef detail::ListOptionTypeParser_Policy<
            IPv6GenericOptionParser, ListOptionTypeAuxPolicy> ListOptionTypePolicy;
        typedef ListParser<ListOptionTypePolicy> ListOptionTypeParser;

#       include SENF_PARSER()

        SENF_PARSER_FIELD   ( nextHeader,   UInt8Parser          );
        SENF_PARSER_FIELD_RO( headerLength, UInt8Parser          );
        SENF_PARSER_FIELD   ( options,      ListOptionTypeParser );

        SENF_PARSER_FINALIZE( IPv6HopByHopOptionsPacketParser );
    };

    struct IPv6HopByHopOptionsPacketType
    :   public PacketTypeBase,
        public PacketTypeMixin<IPv6HopByHopOptionsPacketType, IPTypes>
    {
        typedef PacketTypeMixin<IPv6HopByHopOptionsPacketType, IPTypes> mixin;
        typedef ConcretePacket<IPv6HopByHopOptionsPacketType> packet;
        typedef IPv6HopByHopOptionsPacketParser parser;

        using mixin::nextPacketRange;
        using mixin::nextPacketType;
        using mixin::init;
        using mixin::initSize;

        static key_t nextPacketKey(packet p) {
            return p->nextHeader(); }

        static void dump(packet p, std::ostream & os);
        static void finalize(packet p);

        static const IPTypes::key_t ipType = 0;
    };

    typedef ConcretePacket<IPv6HopByHopOptionsPacketType> IPv6HopByHopOptionsPacket;
    SENF_PACKET_PREVENT_TEMPLATE_INSTANTIATION( IPv6HopByHopOptionsPacket );

// =====================================================================================================

    struct IPv6DestinationOptionsPacketParser : public PacketParserBase
    {
        typedef detail::FixedAuxParserPolicy<UInt8Parser, 1u> ListOptionTypeAuxPolicy;
        typedef detail::ListOptionTypeParser_Policy<
            IPv6GenericOptionParser, ListOptionTypeAuxPolicy> ListOptionTypePolicy;
        typedef ListParser<ListOptionTypePolicy> ListOptionTypeParser;

#       include SENF_PARSER()

        SENF_PARSER_FIELD   ( nextHeader,   UInt8Parser          );
        SENF_PARSER_FIELD_RO( headerLength, UInt8Parser          );
        SENF_PARSER_FIELD   ( options,      ListOptionTypeParser );

        SENF_PARSER_FINALIZE( IPv6DestinationOptionsPacketParser );
    };

    struct IPv6DestinationOptionsPacketType
    :   public PacketTypeBase,
        public PacketTypeMixin<IPv6DestinationOptionsPacketType, IPTypes>
    {
        typedef PacketTypeMixin<IPv6DestinationOptionsPacketType, IPTypes> mixin;
        typedef ConcretePacket<IPv6DestinationOptionsPacketType> packet;
        typedef IPv6DestinationOptionsPacketParser parser;

        using mixin::nextPacketRange;
        using mixin::nextPacketType;
        using mixin::init;
        using mixin::initSize;

        static key_t nextPacketKey(packet p)
        { return p->nextHeader(); }
        static void dump(packet p, std::ostream & os);
        static void finalize(packet p);

        static const IPTypes::key_t ipType = 60u;
    };

    typedef ConcretePacket<IPv6DestinationOptionsPacketType> IPv6DestinationOptionsPacket;
    SENF_PACKET_PREVENT_TEMPLATE_INSTANTIATION( IPv6DestinationOptionsPacket );

}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
//#include "IPv6Extensions.cci"
//#include "IPv6Extensions.ct"
//#include "IPv6Extensions.cti"
#endif


// Local Variables:
// mode: c++
// fill-column: 100
// c-file-style: "senf"
// indent-tabs-mode: nil
// ispell-local-dictionary: "american"
// compile-command: "scons -u test"
// comment-column: 40
// End: