icmpv6.c File Reference

ICMPv6 protocol. More...

#include <string.h>
#include <errno.h>
#include <byteswap.h>
#include <ipxe/in.h>
#include <ipxe/iobuf.h>
#include <ipxe/tcpip.h>
#include <ipxe/ping.h>
#include <ipxe/icmpv6.h>

Go to the source code of this file.

Macros
#define	EHOSTUNREACH_ROUTE   __einfo_error ( EINFO_EHOSTUNREACH_ROUTE )
#define	EINFO_EHOSTUNREACH_ROUTE
#define	EHOSTUNREACH_PROHIBITED   __einfo_error ( EINFO_EHOSTUNREACH_PROHIBITED )
#define	EINFO_EHOSTUNREACH_PROHIBITED
#define	EHOSTUNREACH_ADDRESS   __einfo_error ( EINFO_EHOSTUNREACH_ADDRESS )
#define	EINFO_EHOSTUNREACH_ADDRESS
#define	EHOSTUNREACH_PORT   __einfo_error ( EINFO_EHOSTUNREACH_PORT )
#define	EINFO_EHOSTUNREACH_PORT
#define	EHOSTUNREACH_CODE(code)
#define	ETIMEDOUT_HOP   __einfo_error ( EINFO_ETIMEDOUT_HOP )
#define	EINFO_ETIMEDOUT_HOP
#define	ETIMEDOUT_REASSEMBLY   __einfo_error ( EINFO_ETIMEDOUT_REASSEMBLY )
#define	EINFO_ETIMEDOUT_REASSEMBLY
#define	ETIMEDOUT_CODE(code)
#define	EPROTO_BAD_HEADER   __einfo_error ( EINFO_EPROTO_BAD_HEADER )
#define	EINFO_EPROTO_BAD_HEADER
#define	EPROTO_NEXT_HEADER   __einfo_error ( EINFO_EPROTO_NEXT_HEADER )
#define	EINFO_EPROTO_NEXT_HEADER
#define	EPROTO_OPTION   __einfo_error ( EINFO_EPROTO_OPTION )
#define	EINFO_EPROTO_OPTION
#define	EPROTO_CODE(code)

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static int	icmpv6_rx_echo_request (struct io_buffer *iobuf, struct net_device *netdev __unused, struct sockaddr_in6 *sin6_src, struct sockaddr_in6 *sin6_dest __unused)
	Process received ICMPv6 echo request packet.
static int	icmpv6_rx_echo_reply (struct io_buffer *iobuf, struct net_device *netdev __unused, struct sockaddr_in6 *sin6_src, struct sockaddr_in6 *sin6_dest __unused)
	Process received ICMPv6 echo reply packet.
static struct icmpv6_handler *	icmpv6_handler (unsigned int type)
	Identify ICMPv6 handler.
static int	icmpv6_rx (struct io_buffer *iobuf, struct net_device *netdev, struct sockaddr_tcpip *st_src, struct sockaddr_tcpip *st_dest, uint16_t pshdr_csum)
	Process a received packet.

Variables
struct icmp_echo_protocol icmpv6_echo_protocol	__icmp_echo_protocol
	ICMPv6 echo protocol.
struct icmpv6_handler icmpv6_echo_request_handler	__icmpv6_handler
	ICMPv6 echo request handler.
struct tcpip_protocol icmpv6_protocol	__tcpip_protocol
	ICMPv6 TCP/IP protocol.

Detailed Description

ICMPv6 protocol.

Definition in file icmpv6.c.

Macro Definition Documentation

EHOSTUNREACH_ROUTE

#define EHOSTUNREACH_ROUTE   __einfo_error ( EINFO_EHOSTUNREACH_ROUTE )

Definition at line 43 of file icmpv6.c.

#define EHOSTUNREACH_ROUTE                                              \
        __einfo_error ( EINFO_EHOSTUNREACH_ROUTE )

EINFO_EHOSTUNREACH_ROUTE

#define EINFO_EHOSTUNREACH_ROUTE

Value:

__einfo_uniqify ( EINFO_EHOSTUNREACH, 0,                        \
                  "No route to destination" )

Definition at line 45 of file icmpv6.c.

#define EINFO_EHOSTUNREACH_ROUTE                                        \
        __einfo_uniqify ( EINFO_EHOSTUNREACH, 0,                        \
                          "No route to destination" )

EHOSTUNREACH_PROHIBITED

#define EHOSTUNREACH_PROHIBITED   __einfo_error ( EINFO_EHOSTUNREACH_PROHIBITED )

Definition at line 48 of file icmpv6.c.

#define EHOSTUNREACH_PROHIBITED                                         \
        __einfo_error ( EINFO_EHOSTUNREACH_PROHIBITED )

EINFO_EHOSTUNREACH_PROHIBITED

#define EINFO_EHOSTUNREACH_PROHIBITED

Value:

__einfo_uniqify ( EINFO_EHOSTUNREACH, 1,                        \
                  "Communication administratively prohibited" )

Definition at line 50 of file icmpv6.c.

#define EINFO_EHOSTUNREACH_PROHIBITED                                   \
        __einfo_uniqify ( EINFO_EHOSTUNREACH, 1,                        \
                          "Communication administratively prohibited" )

EHOSTUNREACH_ADDRESS

#define EHOSTUNREACH_ADDRESS   __einfo_error ( EINFO_EHOSTUNREACH_ADDRESS )

Definition at line 53 of file icmpv6.c.

#define EHOSTUNREACH_ADDRESS                                            \
        __einfo_error ( EINFO_EHOSTUNREACH_ADDRESS )

EINFO_EHOSTUNREACH_ADDRESS

#define EINFO_EHOSTUNREACH_ADDRESS

Value:

__einfo_uniqify ( EINFO_EHOSTUNREACH, 3,                        \
                  "Address unreachable" )

Definition at line 55 of file icmpv6.c.

#define EINFO_EHOSTUNREACH_ADDRESS                                      \
        __einfo_uniqify ( EINFO_EHOSTUNREACH, 3,                        \
                          "Address unreachable" )

EHOSTUNREACH_PORT

#define EHOSTUNREACH_PORT   __einfo_error ( EINFO_EHOSTUNREACH_PORT )

Definition at line 58 of file icmpv6.c.

#define EHOSTUNREACH_PORT                                               \
        __einfo_error ( EINFO_EHOSTUNREACH_PORT )

EINFO_EHOSTUNREACH_PORT

#define EINFO_EHOSTUNREACH_PORT

Value:

__einfo_uniqify ( EINFO_EHOSTUNREACH, 4,                        \
                  "Port unreachable" )

Definition at line 60 of file icmpv6.c.

#define EINFO_EHOSTUNREACH_PORT                                         \
        __einfo_uniqify ( EINFO_EHOSTUNREACH, 4,                        \
                          "Port unreachable" )

EHOSTUNREACH_CODE

#define EHOSTUNREACH_CODE

(

code

)

Value:

EUNIQ ( EINFO_EHOSTUNREACH, ( (code) & 0x1f ),                  \
        EHOSTUNREACH_ROUTE, EHOSTUNREACH_PROHIBITED,            \
        EHOSTUNREACH_ADDRESS, EHOSTUNREACH_PORT )

Definition at line 63 of file icmpv6.c.

#define EHOSTUNREACH_CODE( code )                                       \
        EUNIQ ( EINFO_EHOSTUNREACH, ( (code) & 0x1f ),                  \
                EHOSTUNREACH_ROUTE, EHOSTUNREACH_PROHIBITED,            \
                EHOSTUNREACH_ADDRESS, EHOSTUNREACH_PORT )

Referenced by icmpv6_rx().

ETIMEDOUT_HOP

#define ETIMEDOUT_HOP   __einfo_error ( EINFO_ETIMEDOUT_HOP )

Definition at line 68 of file icmpv6.c.

#define ETIMEDOUT_HOP                                                   \
        __einfo_error ( EINFO_ETIMEDOUT_HOP )

EINFO_ETIMEDOUT_HOP

#define EINFO_ETIMEDOUT_HOP

Value:

__einfo_uniqify ( EINFO_ETIMEDOUT, 0,                           \
                  "Hop limit exceeded in transit" )

Definition at line 70 of file icmpv6.c.

#define EINFO_ETIMEDOUT_HOP                                             \
        __einfo_uniqify ( EINFO_ETIMEDOUT, 0,                           \
                          "Hop limit exceeded in transit" )

ETIMEDOUT_REASSEMBLY

#define ETIMEDOUT_REASSEMBLY   __einfo_error ( EINFO_ETIMEDOUT_REASSEMBLY )

Definition at line 73 of file icmpv6.c.

#define ETIMEDOUT_REASSEMBLY                                            \
        __einfo_error ( EINFO_ETIMEDOUT_REASSEMBLY )

EINFO_ETIMEDOUT_REASSEMBLY

#define EINFO_ETIMEDOUT_REASSEMBLY

Value:

__einfo_uniqify ( EINFO_ETIMEDOUT, 1,                           \
                  "Fragment reassembly time exceeded" )

Definition at line 75 of file icmpv6.c.

#define EINFO_ETIMEDOUT_REASSEMBLY                                      \
        __einfo_uniqify ( EINFO_ETIMEDOUT, 1,                           \
                          "Fragment reassembly time exceeded" )

ETIMEDOUT_CODE

#define ETIMEDOUT_CODE

(

code

)

Value:

EUNIQ ( EINFO_ETIMEDOUT, ( (code) & 0x1f ),                     \
        ETIMEDOUT_HOP, ETIMEDOUT_REASSEMBLY )

Definition at line 78 of file icmpv6.c.

#define ETIMEDOUT_CODE( code )                                          \
        EUNIQ ( EINFO_ETIMEDOUT, ( (code) & 0x1f ),                     \
                ETIMEDOUT_HOP, ETIMEDOUT_REASSEMBLY )

Referenced by icmpv6_rx().

EPROTO_BAD_HEADER

#define EPROTO_BAD_HEADER   __einfo_error ( EINFO_EPROTO_BAD_HEADER )

Definition at line 82 of file icmpv6.c.

#define EPROTO_BAD_HEADER                                               \
        __einfo_error ( EINFO_EPROTO_BAD_HEADER )

EINFO_EPROTO_BAD_HEADER

#define EINFO_EPROTO_BAD_HEADER

Value:

__einfo_uniqify ( EINFO_EPROTO, 0,                              \
                  "Erroneous header field" )

Definition at line 84 of file icmpv6.c.

#define EINFO_EPROTO_BAD_HEADER                                         \
        __einfo_uniqify ( EINFO_EPROTO, 0,                              \
                          "Erroneous header field" )

EPROTO_NEXT_HEADER

#define EPROTO_NEXT_HEADER   __einfo_error ( EINFO_EPROTO_NEXT_HEADER )

Definition at line 87 of file icmpv6.c.

#define EPROTO_NEXT_HEADER                                              \
        __einfo_error ( EINFO_EPROTO_NEXT_HEADER )

EINFO_EPROTO_NEXT_HEADER

#define EINFO_EPROTO_NEXT_HEADER

Value:

__einfo_uniqify ( EINFO_EPROTO, 1,                              \
                  "Unrecognised next header type" )

Definition at line 89 of file icmpv6.c.

#define EINFO_EPROTO_NEXT_HEADER                                        \
        __einfo_uniqify ( EINFO_EPROTO, 1,                              \
                          "Unrecognised next header type" )

EPROTO_OPTION

#define EPROTO_OPTION   __einfo_error ( EINFO_EPROTO_OPTION )

Definition at line 92 of file icmpv6.c.

#define EPROTO_OPTION                                                   \
        __einfo_error ( EINFO_EPROTO_OPTION )

EINFO_EPROTO_OPTION

#define EINFO_EPROTO_OPTION

Value:

__einfo_uniqify ( EINFO_EPROTO, 2,                              \
                  "Unrecognised IPv6 option" )

Definition at line 94 of file icmpv6.c.

#define EINFO_EPROTO_OPTION                                             \
        __einfo_uniqify ( EINFO_EPROTO, 2,                              \
                          "Unrecognised IPv6 option" )

EPROTO_CODE

#define EPROTO_CODE

(

code

)

Value:

EUNIQ ( EINFO_EPROTO, ( (code) & 0x1f ),                        \
        EPROTO_BAD_HEADER, EPROTO_NEXT_HEADER, EPROTO_OPTION )

Definition at line 97 of file icmpv6.c.

#define EPROTO_CODE( code )                                             \
        EUNIQ ( EINFO_EPROTO, ( (code) & 0x1f ),                        \
                EPROTO_BAD_HEADER, EPROTO_NEXT_HEADER, EPROTO_OPTION )

Referenced by icmpv6_rx().

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

icmpv6_rx_echo_request()

int icmpv6_rx_echo_request ( struct io_buffer * iobuf, struct net_device *netdev __unused, struct sockaddr_in6 * sin6_src, struct sockaddr_in6 *sin6_dest __unused )

static

Process received ICMPv6 echo request packet.

Parameters

iobuf	I/O buffer
netdev	Network device
sin6_src	Source socket address
sin6_dest	Destination socket address

Return values

rc	Return status code

Definition at line 112 of file icmpv6.c.

                                                                              {
        struct sockaddr_tcpip *st_src =
                ( ( struct sockaddr_tcpip * ) sin6_src );
 
        return icmp_rx_echo_request ( iobuf, st_src, &icmpv6_echo_protocol );
}

References __unused, icmp_rx_echo_request(), and netdev.

icmpv6_rx_echo_reply()

int icmpv6_rx_echo_reply ( struct io_buffer * iobuf, struct net_device *netdev __unused, struct sockaddr_in6 * sin6_src, struct sockaddr_in6 *sin6_dest __unused )

static

Process received ICMPv6 echo reply packet.

Parameters

iobuf	I/O buffer
netdev	Network device
sin6_src	Source socket address
sin6_dest	Destination socket address

Return values

rc	Return status code

Definition at line 137 of file icmpv6.c.

                                                                            {
        struct sockaddr_tcpip *st_src =
                ( ( struct sockaddr_tcpip * ) sin6_src );
 
        return icmp_rx_echo_reply ( iobuf, st_src );
}

References __unused, icmp_rx_echo_reply(), and netdev.

icmpv6_handler()

struct icmpv6_handler * icmpv6_handler ( unsigned int type )

static

Identify ICMPv6 handler.

Parameters

type	ICMPv6 type

Return values

handler

ICMPv6 handler, or NULL if not found

Definition at line 159 of file icmpv6.c.

                                                                    {
        struct icmpv6_handler *handler;
 
        for_each_table_entry ( handler, ICMPV6_HANDLERS ) {
                if ( handler->type == type )
                        return handler;
        }
        return NULL;
}

References for_each_table_entry, ICMPV6_HANDLERS, NULL, icmpv6_handler::type, and type.

Referenced by icmpv6_rx().

icmpv6_rx()

int icmpv6_rx ( struct io_buffer * iobuf, struct net_device * netdev, struct sockaddr_tcpip * st_src, struct sockaddr_tcpip * st_dest, uint16_t pshdr_csum )

static

Process a received packet.

Parameters

iobuf	I/O buffer
netdev	Network device
st_src	Partially-filled source address
st_dest	Partially-filled destination address
pshdr_csum	Pseudo-header checksum

Return values

rc	Return status code

Definition at line 179 of file icmpv6.c.

                                                                             {
        struct sockaddr_in6 *sin6_src = ( ( struct sockaddr_in6 * ) st_src );
        struct sockaddr_in6 *sin6_dest = ( ( struct sockaddr_in6 * ) st_dest );
        struct icmp_header *icmp;
        size_t len = iob_len ( iobuf );
        struct icmpv6_handler *handler;
        unsigned int csum;
        int rc;
 
        /* Sanity check */
        if ( len < sizeof ( *icmp ) ) {
                DBGC ( netdev, "ICMPv6 packet too short at %zd bytes (min %zd "
                       "bytes)\n", len, sizeof ( *icmp ) );
                rc = -EINVAL;
                goto done;
        }
        icmp = iobuf->data;
 
        /* Verify checksum */
        csum = tcpip_continue_chksum ( pshdr_csum, icmp, len );
        if ( csum != 0 ) {
                DBGC ( netdev, "ICMPv6 checksum incorrect (is %04x, should be "
                       "0000)\n", csum );
                DBGC_HDA ( netdev, 0, icmp, len );
                rc = -EINVAL;
                goto done;
        }
 
        /* Identify handler */
        handler = icmpv6_handler ( icmp->type );
        if ( ! handler ) {
                switch ( icmp->type ) {
                case ICMPV6_DESTINATION_UNREACHABLE:
                        rc = -EHOSTUNREACH_CODE ( icmp->code );
                        break;
                case ICMPV6_PACKET_TOO_BIG:
                        rc = -ERANGE;
                        break;
                case ICMPV6_TIME_EXCEEDED:
                        rc = -ETIMEDOUT_CODE ( icmp->code );
                        break;
                case ICMPV6_PARAMETER_PROBLEM:
                        rc = -EPROTO_CODE ( icmp->code );
                        break;
                default:
                        DBGC ( netdev, "ICMPv6 unrecognised type %d code %d\n",
                               icmp->type, icmp->code );
                        rc = -ENOTSUP;
                        break;
                };
                goto done;
        }
 
        /* Pass to handler */
        if ( ( rc = handler->rx ( iob_disown ( iobuf ), netdev, sin6_src,
                                  sin6_dest ) ) != 0 ) {
                DBGC ( netdev, "ICMPv6 could not handle type %d: %s\n",
                       icmp->type, strerror ( rc ) );
                goto done;
        }
 
 done:
        free_iob ( iobuf );
        return rc;
}

References icmp_header::code, io_buffer::data, DBGC, DBGC_HDA, done, EHOSTUNREACH_CODE, EINVAL, ENOTSUP, EPROTO_CODE, ERANGE, ETIMEDOUT_CODE, free_iob(), ICMPV6_DESTINATION_UNREACHABLE, icmpv6_handler(), ICMPV6_PACKET_TOO_BIG, ICMPV6_PARAMETER_PROBLEM, ICMPV6_TIME_EXCEEDED, iob_disown, iob_len(), len, netdev, rc, icmpv6_handler::rx, strerror(), tcpip_continue_chksum(), and icmp_header::type.

Variable Documentation

__icmp_echo_protocol

struct icmp_echo_protocol icmpv6_echo_protocol __icmp_echo_protocol

Initial value:

                        = {
        .family = AF_INET6,
        .request = ICMPV6_ECHO_REQUEST,
        .reply = ICMPV6_ECHO_REPLY,
        .tcpip_protocol = &icmpv6_protocol,
        .net_checksum = 1,
}

ICMPv6 echo protocol.

Definition at line 101 of file icmpv6.c.

__icmpv6_handler

struct icmpv6_handler icmpv6_echo_reply_handler __icmpv6_handler

Initial value:

                    = {
        .type = ICMPV6_ECHO_REQUEST,
        .rx = icmpv6_rx_echo_request,
}

ICMPv6 echo request handler.

ICMPv6 echo reply handler.

Definition at line 123 of file icmpv6.c.

                                                                   {
        .type = ICMPV6_ECHO_REQUEST,
        .rx = icmpv6_rx_echo_request,
};

__tcpip_protocol

struct tcpip_protocol icmpv6_protocol __tcpip_protocol

Initial value:

                    = {
        .name = "ICMPv6",
        .rx = icmpv6_rx,
        .tcpip_proto = IP_ICMP6,
}

ICMPv6 TCP/IP protocol.

ICMPv4 TCP/IP protocol.

Definition at line 248 of file icmpv6.c.

                                                       {
        .name = "ICMPv6",
        .rx = icmpv6_rx,
        .tcpip_proto = IP_ICMP6,
};