icmp6.hpp

Go to the documentation of this file.

/*
 *  Copyright (c) 2016, The OpenThread Authors.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *  3. Neither the name of the copyright holder nor the
 *     names of its contributors may be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef ICMP6_HPP_
#define ICMP6_HPP_

#include "openthread-core-config.h"

#include <openthread/icmp6.h>

#include "common/encoding.hpp"
#include "common/locator.hpp"
#include "net/ip6_headers.hpp"

using ot::Encoding::BigEndian::HostSwap16;

namespace ot {
namespace Ip6 {

/*
 * This class implements ICMPv6 header generation and parsing.
 *
 */
OT_TOOL_PACKED_BEGIN
class IcmpHeader: public otIcmp6Header
{
public:
    void Init(void) { mType = 0; mCode = 0; mChecksum = 0; mData.m32[0] = 0; }

    enum Type
    {
        kTypeDstUnreach  = OT_ICMP6_TYPE_DST_UNREACH,   
        kTypeEchoRequest = OT_ICMP6_TYPE_ECHO_REQUEST,  
        kTypeEchoReply   = OT_ICMP6_TYPE_ECHO_REPLY,    
    };

    enum Code
    {
        kCodeDstUnreachNoRoute = OT_ICMP6_CODE_DST_UNREACH_NO_ROUTE,  
    };

    Type GetType(void) const { return static_cast<Type>(mType); }

    void SetType(Type aType) { mType = static_cast<uint8_t>(aType); }

    Code GetCode(void) const { return static_cast<Code>(mCode); }

    void SetCode(Code aCode) { mCode = static_cast<uint8_t>(aCode); }

    uint16_t GetChecksum(void) const { return HostSwap16(mChecksum); }

    void SetChecksum(uint16_t aChecksum) { mChecksum = HostSwap16(aChecksum); }

    uint16_t GetId(void) const { return HostSwap16(mData.m16[0]); }

    void SetId(uint16_t aId) { mData.m16[0] = HostSwap16(aId); }

    uint16_t GetSequence(void) const { return HostSwap16(mData.m16[1]); }

    void SetSequence(uint16_t aSequence) { mData.m16[1] = HostSwap16(aSequence); }

    static uint8_t GetChecksumOffset(void) { return offsetof(otIcmp6Header, mChecksum); }

    static uint8_t GetDataOffset(void) { return offsetof(otIcmp6Header, mData); }

} OT_TOOL_PACKED_END;

class IcmpHandler : public otIcmp6Handler
{
    friend class Icmp;

public:
    IcmpHandler(otIcmp6ReceiveCallback aCallback, void *aContext) {
        mReceiveCallback = aCallback;
        mContext         = aContext;
        mNext            = NULL;
    }

private:
    void HandleReceiveMessage(Message &aMessage, const MessageInfo &aMessageInfo, const IcmpHeader &aIcmp6Header) {
        mReceiveCallback(mContext, &aMessage, &aMessageInfo, &aIcmp6Header);
    }

    IcmpHandler *GetNext(void) { return static_cast<IcmpHandler *>(mNext); }
};

class Icmp: public InstanceLocator
{
public:
    Icmp(otInstance &aInstance);

    Message *NewMessage(uint16_t aReserved);

    otError RegisterHandler(IcmpHandler &aHandler);

    otError SendEchoRequest(Message &aMessage, const MessageInfo &aMessageInfo, uint16_t aIdentifier);

    otError SendError(IcmpHeader::Type aType, IcmpHeader::Code aCode, const MessageInfo &aMessageInfo,
                      const Header &aHeader);

    otError HandleMessage(Message &aMessage, MessageInfo &aMessageInfo);

    otError UpdateChecksum(Message &aMessage, uint16_t aPseudoHeaderChecksum);

    bool IsEchoEnabled(void) { return mIsEchoEnabled; }

    void SetEchoEnabled(bool aEnabled) { mIsEchoEnabled = aEnabled; }

private:
    otError HandleEchoRequest(Message &aMessage, const MessageInfo &aMessageInfo);

    IcmpHandler *mHandlers;

    uint16_t mEchoSequence;
    bool mIsEchoEnabled;
};

}  // namespace Ip6
}  // namespace ot

#endif  // NET_ICMP6_HPP_