icmp.h 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115
  1. /*
  2. * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  3. * All rights reserved.
  4. *
  5. * Redistribution and use in source and binary forms, with or without modification,
  6. * are permitted provided that the following conditions are met:
  7. *
  8. * 1. Redistributions of source code must retain the above copyright notice,
  9. * this list of conditions and the following disclaimer.
  10. * 2. Redistributions in binary form must reproduce the above copyright notice,
  11. * this list of conditions and the following disclaimer in the documentation
  12. * and/or other materials provided with the distribution.
  13. * 3. The name of the author may not be used to endorse or promote products
  14. * derived from this software without specific prior written permission.
  15. *
  16. * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
  17. * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  18. * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
  19. * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  20. * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
  21. * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  22. * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  23. * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  24. * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
  25. * OF SUCH DAMAGE.
  26. *
  27. * This file is part of the lwIP TCP/IP stack.
  28. *
  29. * Author: Adam Dunkels <adam@sics.se>
  30. *
  31. */
  32. #ifndef __LWIP_ICMP_H__
  33. #define __LWIP_ICMP_H__
  34. #include "lwip/opt.h"
  35. #include "lwip/pbuf.h"
  36. #include "lwip/ip_addr.h"
  37. #include "lwip/netif.h"
  38. #ifdef __cplusplus
  39. extern "C" {
  40. #endif
  41. #define ICMP_ER 0 /* echo reply */
  42. #define ICMP_DUR 3 /* destination unreachable */
  43. #define ICMP_SQ 4 /* source quench */
  44. #define ICMP_RD 5 /* redirect */
  45. #define ICMP_ECHO 8 /* echo */
  46. #define ICMP_TE 11 /* time exceeded */
  47. #define ICMP_PP 12 /* parameter problem */
  48. #define ICMP_TS 13 /* timestamp */
  49. #define ICMP_TSR 14 /* timestamp reply */
  50. #define ICMP_IRQ 15 /* information request */
  51. #define ICMP_IR 16 /* information reply */
  52. enum icmp_dur_type {
  53. ICMP_DUR_NET = 0, /* net unreachable */
  54. ICMP_DUR_HOST = 1, /* host unreachable */
  55. ICMP_DUR_PROTO = 2, /* protocol unreachable */
  56. ICMP_DUR_PORT = 3, /* port unreachable */
  57. ICMP_DUR_FRAG = 4, /* fragmentation needed and DF set */
  58. ICMP_DUR_SR = 5 /* source route failed */
  59. };
  60. enum icmp_te_type {
  61. ICMP_TE_TTL = 0, /* time to live exceeded in transit */
  62. ICMP_TE_FRAG = 1 /* fragment reassembly time exceeded */
  63. };
  64. #ifdef PACK_STRUCT_USE_INCLUDES
  65. # include "arch/bpstruct.h"
  66. #endif
  67. /** This is the standard ICMP header only that the u32_t data
  68. * is splitted to two u16_t like ICMP echo needs it.
  69. * This header is also used for other ICMP types that do not
  70. * use the data part.
  71. * 定义ICMP回送请求报文首部结构,
  72. * 由于所有ICMP报文首部有很大相似性,
  73. * 该结构同样适用于其它ICMP报文。
  74. */
  75. PACK_STRUCT_BEGIN
  76. struct icmp_echo_hdr {
  77. PACK_STRUCT_FIELD(u8_t type);
  78. PACK_STRUCT_FIELD(u8_t code);
  79. PACK_STRUCT_FIELD(u16_t chksum);
  80. PACK_STRUCT_FIELD(u16_t id);
  81. PACK_STRUCT_FIELD(u16_t seqno);
  82. } PACK_STRUCT_STRUCT;
  83. PACK_STRUCT_END
  84. #ifdef PACK_STRUCT_USE_INCLUDES
  85. # include "arch/epstruct.h"
  86. #endif
  87. //读取ICMP首部中字段
  88. #define ICMPH_TYPE(hdr) ((hdr)->type)
  89. #define ICMPH_CODE(hdr) ((hdr)->code)
  90. /** Combines type and code to an u16_t 向ICMP报文首部字段中写入相应值*/
  91. #define ICMPH_TYPE_SET(hdr, t) ((hdr)->type = (t))
  92. #define ICMPH_CODE_SET(hdr, c) ((hdr)->code = (c))
  93. #if LWIP_ICMP /* don't build if not configured for use in lwipopts.h */
  94. void icmp_input(struct pbuf *p, struct netif *inp)ICACHE_FLASH_ATTR;
  95. void icmp_dest_unreach(struct pbuf *p, enum icmp_dur_type t)ICACHE_FLASH_ATTR;
  96. void icmp_time_exceeded(struct pbuf *p, enum icmp_te_type t)ICACHE_FLASH_ATTR;
  97. #endif /* LWIP_ICMP */
  98. #ifdef __cplusplus
  99. }
  100. #endif
  101. #endif /* __LWIP_ICMP_H__ */