Blame view

RIOT/sys/include/net/gnrc/icmpv6/error.h 4.75 KB
a752c7ab   elopes   add first test an...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
  /*
   * Copyright (C) 2015 Martine Lenders <mlenders@inf.fu-berlin.de>
   *
   * This file is subject to the terms and conditions of the GNU Lesser
   * General Public License v2.1. See the file LICENSE in the top level
   * directory for more details.
   */
  
  /**
   * @defgroup    net_gnrc_icmpv6_error ICMPv6 error messages
   * @ingroup     net_gnrc_icmpv6
   * @brief       ICMPv6 error message handling and creation
   * @{
   *
   * @file
   * @brief   ICMPv6 error message definitions
   *
   * @author  Martine Lenders <mlenders@inf.fu-berlin.de>
   */
  #ifndef NET_GNRC_ICMPV6_ERROR_H
  #define NET_GNRC_ICMPV6_ERROR_H
  
  #include <errno.h>
  #include <stdint.h>
  
  #include "net/icmpv6.h"
  #include "net/ipv6/hdr.h"
  #include "net/gnrc/ipv6.h"
  #include "net/gnrc/netapi.h"
  #include "net/gnrc/pkt.h"
  
  #ifdef __cplusplus
  extern "C" {
  #endif
  
  /**
   * @brief   Builds an ICMPv6 destination unreachable message for sending.
   *
   * @param[in] code      The code for the message @see net/icmpv6.h.
   * @param[in] orig_pkt  The invoking packet.
   *
   * @return  The destination unreachable message on success.
   * @return  NULL, on failure.
   */
  gnrc_pktsnip_t *gnrc_icmpv6_error_dst_unr_build(uint8_t code, gnrc_pktsnip_t *orig_pkt);
  
  /**
   * @brief   Builds an ICMPv6 packet too big message for sending.
   *
   * @param[in] mtu       The maximum transission unit of the next-hop link.
   * @param[in] orig_pkt  The invoking packet.
   *
   * @return  The packet too big message on success.
   * @return  NULL, on failure.
   */
  gnrc_pktsnip_t *gnrc_icmpv6_error_pkt_too_big_build(uint32_t mtu, gnrc_pktsnip_t *orig_pkt);
  
  /**
   * @brief   Builds an ICMPv6 time exceeded message for sending.
   *
   * @param[in] code      The code for the message @see net/icmpv6.h.
   * @param[in] orig_pkt  The invoking packet.
   *
   * @return  The time exceeded message on success.
   * @return  NULL, on failure.
   */
  gnrc_pktsnip_t *gnrc_icmpv6_error_time_exc_build(uint8_t code, gnrc_pktsnip_t *orig_pkt);
  
  /**
   * @brief   Builds an ICMPv6 parameter problem message for sending.
   *
   * @param[in] code      The code for the message @see net/icmpv6.h.
   * @param[in] ptr       Pointer to the errorneous octet in @p orig_pkt.
   * @param[in] orig_pkt  The invoking packet.
   *
   * @return  The parameter problem message on success.
   * @return  NULL, on failure.
   */
  gnrc_pktsnip_t *gnrc_icmpv6_error_param_prob_build(uint8_t code, void *ptr,
                                                     gnrc_pktsnip_t *orig_pkt);
  
  /**
   * @brief   Sends an ICMPv6 destination unreachable message for sending.
   *
   * @param[in] code      The code for the message @see net/icmpv6.h.
   * @param[in] orig_pkt  The invoking packet.
   */
  static inline void gnrc_icmpv6_error_dst_unr_send(uint8_t code, gnrc_pktsnip_t *orig_pkt)
  {
      gnrc_pktsnip_t *pkt = gnrc_icmpv6_error_dst_unr_build(code, orig_pkt);
  
      if (pkt != NULL) {
          gnrc_netapi_send(gnrc_ipv6_pid, pkt);
      }
  #ifdef MODULE_GNRC_PKTBUF
      gnrc_pktbuf_release_error(orig_pkt, EHOSTUNREACH);
  #else
      (void)orig_pkt;
  #endif
  }
  
  /**
   * @brief   Sends an ICMPv6 packet too big message for sending.
   *
   * @param[in] mtu       The maximum transission unit of the next-hop link.
   * @param[in] orig_pkt  The invoking packet.
   */
  static inline void gnrc_icmpv6_error_pkt_too_big_send(uint32_t mtu, gnrc_pktsnip_t *orig_pkt)
  {
      gnrc_pktsnip_t *pkt = gnrc_icmpv6_error_pkt_too_big_build(mtu, orig_pkt);
  
      if (pkt != NULL) {
          gnrc_netapi_send(gnrc_ipv6_pid, pkt);
      }
  #ifdef MODULE_GNRC_PKTBUF
      gnrc_pktbuf_release_error(orig_pkt, EMSGSIZE);
  #else
      (void)orig_pkt;
  #endif
  }
  
  /**
   * @brief   Sends an ICMPv6 time exceeded message for sending.
   *
   * @param[in] code      The code for the message @see net/icmpv6.h.
   * @param[in] orig_pkt  The invoking packet.
   */
  static inline void gnrc_icmpv6_error_time_exc_send(uint8_t code, gnrc_pktsnip_t *orig_pkt)
  {
      gnrc_pktsnip_t *pkt = gnrc_icmpv6_error_time_exc_build(code, orig_pkt);
  
      if (pkt != NULL) {
          gnrc_netapi_send(gnrc_ipv6_pid, pkt);
      }
  #ifdef MODULE_GNRC_PKTBUF
      gnrc_pktbuf_release_error(orig_pkt, ETIMEDOUT);
  #else
      (void)orig_pkt;
  #endif
  }
  
  /**
   * @brief   Sends an ICMPv6 parameter problem message for sending.
   *
   * @param[in] code      The code for the message @see net/icmpv6.h.
   * @param[in] ptr       Pointer to the errorneous octet in @p orig_pkt.
   * @param[in] orig_pkt  The invoking packet.
   */
  static inline void gnrc_icmpv6_error_param_prob_send(uint8_t code, void *ptr,
                                                       gnrc_pktsnip_t *orig_pkt)
  {
      gnrc_pktsnip_t *pkt = gnrc_icmpv6_error_param_prob_build(code, ptr, orig_pkt);
  
      if (pkt != NULL) {
          gnrc_netapi_send(gnrc_ipv6_pid, pkt);
      }
  #ifdef MODULE_GNRC_PKTBUF
      gnrc_pktbuf_release_error(orig_pkt, EINVAL);
  #else
      (void)orig_pkt;
  #endif
  }
  
  #ifdef __cplusplus
  }
  #endif
  
  #endif /* NET_GNRC_ICMPV6_ERROR_H */
  /** @} */