# icmp.h

Go to the documentation of this file.

    00001 /*
    00002  * Copyright (c) 2001, Swedish Institute of Computer Science.
    00003  * All rights reserved.
    00004  *
    00005  * Redistribution and use in source and binary forms, with or without
    00006  * modification, are permitted provided that the following conditions
    00007  * are met:
    00008  * 1. Redistributions of source code must retain the above copyright
    00009  *    notice, this list of conditions and the following disclaimer.
    00010  * 2. Redistributions in binary form must reproduce the above copyright
    00011  *    notice, this list of conditions and the following disclaimer in the
    00012  *    documentation and/or other materials provided with the distribution.
    00013  * 3. Neither the name of the Institute nor the names of its contributors
    00014  *    may be used to endorse or promote products derived from this software
    00015  *    without specific prior written permission.
    00016  *
    00017  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
    00018  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    00019  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    00020  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
    00021  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    00022  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
    00023  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    00024  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    00025  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
    00026  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    00027  * SUCH DAMAGE.
    00028  *
    00029  * This file is part of the lwIP TCP/IP stack.
    00030  *
    00031  * Author: Adam Dunkels <adam@sics.se>
    00032  *
    00033  * $Id: ipv4_2icmp_8h-source.html 88 2016-01-12 00:11:29Z reddawg $
    00034  */
    00035 #ifndef __LWIP_ICMP_H__
    00036 #define __LWIP_ICMP_H__
    00037
    00038 #include "net/arch.h"
    00039
    00040 #include "net/opt.h"
    00041 #include "net/pbuf.h"
    00042
    00043 #include "net/netif.h"
    00044
    00045 #define ICMP_ER 0      /* echo reply */
    00046 #define ICMP_DUR 3     /* destination unreachable */
    00047 #define ICMP_SQ 4      /* source quench */
    00048 #define ICMP_RD 5      /* redirect */
    00049 #define ICMP_ECHO 8    /* echo */
    00050 #define ICMP_TE 11     /* time exceeded */
    00051 #define ICMP_PP 12     /* parameter problem */
    00052 #define ICMP_TS 13     /* timestamp */
    00053 #define ICMP_TSR 14    /* timestamp reply */
    00054 #define ICMP_IRQ 15    /* information request */
    00055 #define ICMP_IR 16     /* information reply */
    00056
    00057 enum icmp_dur_type {
    00058   ICMP_DUR_NET = 0,    /* net unreachable */
    00059   ICMP_DUR_HOST = 1,   /* host unreachable */
    00060   ICMP_DUR_PROTO = 2,  /* protocol unreachable */
    00061   ICMP_DUR_PORT = 3,   /* port unreachable */
    00062   ICMP_DUR_FRAG = 4,   /* fragmentation needed and DF set */
    00063   ICMP_DUR_SR = 5      /* source route failed */
    00064 };
    00065
    00066 enum icmp_te_type {
    00067   ICMP_TE_TTL = 0,     /* time to live exceeded in transit */
    00068   ICMP_TE_FRAG = 1     /* fragment reassembly time exceeded */
    00069 };
    00070
    00071 void icmp_input(struct pbuf *p, struct netif *inp);
    00072
    00073 void icmp_dest_unreach(struct pbuf *p, enum icmp_dur_type t);
    00074 void icmp_time_exceeded(struct pbuf *p, enum icmp_te_type t);
    00075
    00076 struct icmp_echo_hdr {
    00077   PACK_STRUCT_FIELD(uInt16 _type_code);
    00078   PACK_STRUCT_FIELD(uInt16 chksum);
    00079   PACK_STRUCT_FIELD(uInt16 id);
    00080   PACK_STRUCT_FIELD(uInt16 seqno);
    00081 } PACK_STRUCT_STRUCT;
    00082
    00083
    00084
    00085 struct icmp_dur_hdr {
    00086   PACK_STRUCT_FIELD(uInt16 _type_code);
    00087   PACK_STRUCT_FIELD(uInt16 chksum);
    00088   PACK_STRUCT_FIELD(uInt32 unused);
    00089 } PACK_STRUCT_STRUCT;
    00090
    00091 struct icmp_te_hdr {
    00092   PACK_STRUCT_FIELD(uInt16 _type_code);
    00093   PACK_STRUCT_FIELD(uInt16 chksum);
    00094   PACK_STRUCT_FIELD(uInt32 unused);
    00095 } PACK_STRUCT_STRUCT;
    00096
    00097 #define ICMPH_TYPE(hdr) (NTOHS((hdr)->_type_code) >> 8)
    00098 #define ICMPH_CODE(hdr) (NTOHS((hdr)->_type_code) & 0xff)
    00099
    00100 #define ICMPH_TYPE_SET(hdr, type) ((hdr)->_type_code = HTONS(ICMPH_CODE(hdr) | ((type) << 8)))
    00101 #define ICMPH_CODE_SET(hdr, code) ((hdr)->_type_code = HTONS((code) | (ICMPH_TYPE(hdr) << 8)))
    00102
    00103 #endif /* __LWIP_ICMP_H__ */
    00104