Contiki 2.5
uip-ds6.h
Go to the documentation of this file.
1 /**
2  * \addtogroup uip6
3  * @{
4  */
5 
6 /**
7  * \file
8  * Network interface and stateless autoconfiguration (RFC 4862)
9  * \author Mathilde Durvy <mdurvy@cisco.com>
10  * \author Julien Abeille <jabeille@cisco.com>
11  *
12  */
13 /*
14  *
15  * Redistribution and use in source and binary forms, with or without
16  * modification, are permitted provided that the following conditions
17  * are met:
18  * 1. Redistributions of source code must retain the above copyright
19  * notice, this list of conditions and the following disclaimer.
20  * 2. Redistributions in binary form must reproduce the above copyright
21  * notice, this list of conditions and the following disclaimer in the
22  * documentation and/or other materials provided with the distribution.
23  * 3. Neither the name of the Institute nor the names of its contributors
24  * may be used to endorse or promote products derived from this software
25  * without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30  * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37  * SUCH DAMAGE.
38  *
39  *
40  */
41 
42 #ifndef __UIP_DS6_H__
43 #define __UIP_DS6_H__
44 
45 #include "net/uip.h"
46 #include "sys/stimer.h"
47 
48 /*--------------------------------------------------*/
49 /** Configuration. For all tables (Neighbor cache, Prefix List, Routing Table,
50  * Default Router List, Unicast address list, multicast address list, anycast address list),
51  * we define:
52  * - the number of elements requested by the user in contiki configuration (name suffixed by _NBU)
53  * - the number of elements assigned by the system (name suffixed by _NBS)
54  * - the total number of elements is the sum (name suffixed by _NB)
55 */
56 /* Neighbor cache */
57 #define UIP_DS6_NBR_NBS 0
58 #ifndef UIP_CONF_DS6_NBR_NBU
59 #define UIP_DS6_NBR_NBU 4
60 #else
61 #define UIP_DS6_NBR_NBU UIP_CONF_DS6_NBR_NBU
62 #endif
63 #define UIP_DS6_NBR_NB UIP_DS6_NBR_NBS + UIP_DS6_NBR_NBU
64 
65 /* Default router list */
66 #define UIP_DS6_DEFRT_NBS 0
67 #ifndef UIP_CONF_DS6_DEFRT_NBU
68 #define UIP_DS6_DEFRT_NBU 2
69 #else
70 #define UIP_DS6_DEFRT_NBU UIP_CONF_DS6_DEFRT_NBU
71 #endif
72 #define UIP_DS6_DEFRT_NB UIP_DS6_DEFRT_NBS + UIP_DS6_DEFRT_NBU
73 
74 /* Prefix list */
75 #define UIP_DS6_PREFIX_NBS 1
76 #ifndef UIP_CONF_DS6_PREFIX_NBU
77 #define UIP_DS6_PREFIX_NBU 2
78 #else
79 #define UIP_DS6_PREFIX_NBU UIP_CONF_DS6_PREFIX_NBU
80 #endif
81 #define UIP_DS6_PREFIX_NB UIP_DS6_PREFIX_NBS + UIP_DS6_PREFIX_NBU
82 
83 /* Routing table */
84 #define UIP_DS6_ROUTE_NBS 0
85 #ifndef UIP_CONF_DS6_ROUTE_NBU
86 #define UIP_DS6_ROUTE_NBU 4
87 #else
88 #define UIP_DS6_ROUTE_NBU UIP_CONF_DS6_ROUTE_NBU
89 #endif
90 #define UIP_DS6_ROUTE_NB UIP_DS6_ROUTE_NBS + UIP_DS6_ROUTE_NBU
91 
92 /* Unicast address list*/
93 #define UIP_DS6_ADDR_NBS 1
94 #ifndef UIP_CONF_DS6_ADDR_NBU
95 #define UIP_DS6_ADDR_NBU 2
96 #else
97 #define UIP_DS6_ADDR_NBU UIP_CONF_DS6_ADDR_NBU
98 #endif
99 #define UIP_DS6_ADDR_NB UIP_DS6_ADDR_NBS + UIP_DS6_ADDR_NBU
100 
101 /* Multicast address list */
102 #if UIP_CONF_ROUTER
103 #define UIP_DS6_MADDR_NBS 2 + UIP_DS6_ADDR_NB /* all routers + all nodes + one solicited per unicast */
104 #else
105 #define UIP_DS6_MADDR_NBS 1 + UIP_DS6_ADDR_NB /* all nodes + one solicited per unicast */
106 #endif
107 #ifndef UIP_CONF_DS6_MADDR_NBU
108 #define UIP_DS6_MADDR_NBU 0
109 #else
110 #define UIP_DS6_MADDR_NBU UIP_CONF_DS6_MADDR_NBU
111 #endif
112 #define UIP_DS6_MADDR_NB UIP_DS6_MADDR_NBS + UIP_DS6_MADDR_NBU
113 
114 /* Anycast address list */
115 #if UIP_CONF_ROUTER
116 #define UIP_DS6_AADDR_NBS UIP_DS6_PREFIX_NB - 1 /* One per non link local prefix (subnet prefix anycast address) */
117 #else
118 #define UIP_DS6_AADDR_NBS 0
119 #endif
120 #ifndef UIP_CONF_DS6_AADDR_NBU
121 #define UIP_DS6_AADDR_NBU 0
122 #else
123 #define UIP_DS6_AADDR_NBU UIP_CONF_DS6_AADDR_NBU
124 #endif
125 #define UIP_DS6_AADDR_NB UIP_DS6_AADDR_NBS + UIP_DS6_AADDR_NBU
126 
127 
128 /*--------------------------------------------------*/
129 /** \brief Possible states for the nbr cache entries */
130 #define NBR_INCOMPLETE 0
131 #define NBR_REACHABLE 1
132 #define NBR_STALE 2
133 #define NBR_DELAY 3
134 #define NBR_PROBE 4
135 
136 /** \brief Possible states for the an address (RFC 4862) */
137 #define ADDR_TENTATIVE 0
138 #define ADDR_PREFERRED 1
139 #define ADDR_DEPRECATED 2
140 
141 /** \brief How the address was acquired: Autoconf, DHCP or manually */
142 #define ADDR_ANYTYPE 0
143 #define ADDR_AUTOCONF 1
144 #define ADDR_DHCP 2
145 #define ADDR_MANUAL 3
146 
147 /** \brief General DS6 definitions */
148 #define UIP_DS6_PERIOD (CLOCK_SECOND/10) /** Period for uip-ds6 periodic task*/
149 #define FOUND 0
150 #define FREESPACE 1
151 #define NOSPACE 2
152 
153 
154 /*--------------------------------------------------*/
155 #if UIP_CONF_IPV6_QUEUE_PKT
156 #include "net/uip-packetqueue.h"
157 #endif /*UIP_CONF_QUEUE_PKT */
158 /** \brief An entry in the nbr cache */
159 typedef struct uip_ds6_nbr {
160  uint8_t isused;
161  uip_ipaddr_t ipaddr;
162  uip_lladdr_t lladdr;
163  struct stimer reachable;
164  struct stimer sendns;
165  clock_time_t last_lookup;
166  uint8_t nscount;
167  uint8_t isrouter;
168  uint8_t state;
169 #if UIP_CONF_IPV6_QUEUE_PKT
170  struct uip_packetqueue_handle packethandle;
171 #define UIP_DS6_NBR_PACKET_LIFETIME CLOCK_SECOND * 4
172 #endif /*UIP_CONF_QUEUE_PKT */
173 } uip_ds6_nbr_t;
174 
175 /** \brief An entry in the default router list */
176 typedef struct uip_ds6_defrt {
177  uint8_t isused;
178  uip_ipaddr_t ipaddr;
179  struct stimer lifetime;
180  uint8_t isinfinite;
181 } uip_ds6_defrt_t;
182 
183 /** \brief A prefix list entry */
184 #if UIP_CONF_ROUTER
185 typedef struct uip_ds6_prefix {
186  uint8_t isused;
187  uip_ipaddr_t ipaddr;
188  uint8_t length;
189  uint8_t advertise;
190  u32_t vlifetime;
191  u32_t plifetime;
192  uint8_t l_a_reserved; /**< on-link and autonomous flags + 6 reserved bits */
193 } uip_ds6_prefix_t;
194 #else /* UIP_CONF_ROUTER */
195 typedef struct uip_ds6_prefix {
196  uint8_t isused;
197  uip_ipaddr_t ipaddr;
198  uint8_t length;
199  struct stimer vlifetime;
200  uint8_t isinfinite;
201 } uip_ds6_prefix_t;
202 #endif /*UIP_CONF_ROUTER */
203 
204 /** * \brief Unicast address structure */
205 typedef struct uip_ds6_addr {
206  uint8_t isused;
207  uip_ipaddr_t ipaddr;
208  uint8_t state;
209  uint8_t type;
210  uint8_t isinfinite;
211  struct stimer vlifetime;
212  struct timer dadtimer;
213  uint8_t dadnscount;
214 } uip_ds6_addr_t;
215 
216 /** \brief Anycast address */
217 typedef struct uip_ds6_aaddr {
218  uint8_t isused;
219  uip_ipaddr_t ipaddr;
220 } uip_ds6_aaddr_t;
221 
222 /** \brief A multicast address */
223 typedef struct uip_ds6_maddr {
224  uint8_t isused;
225  uip_ipaddr_t ipaddr;
226 } uip_ds6_maddr_t;
227 
228 /** \brief define some additional RPL related route state and
229  * neighbor callback for RPL - if not a DS6_ROUTE_STATE is already set */
230 #ifndef UIP_DS6_ROUTE_STATE_TYPE
231 #define UIP_DS6_ROUTE_STATE_TYPE rpl_route_entry_t
232 /* Needed for the extended route entry state when using ContikiRPL */
233 typedef struct rpl_route_entry {
234  uint32_t lifetime;
235  uint32_t saved_lifetime;
236  void *dag;
237  uint8_t learned_from;
238 } rpl_route_entry_t;
239 #endif /* UIP_DS6_ROUTE_STATE_TYPE */
240 
241 /* only define the callback if RPL is active */
242 #if UIP_CONF_IPV6_RPL
243 #ifndef UIP_CONF_DS6_NEIGHBOR_STATE_CHANGED
244 #define UIP_CONF_DS6_NEIGHBOR_STATE_CHANGED rpl_ipv6_neighbor_callback
245 #endif /* UIP_CONF_DS6_NEIGHBOR_STATE_CHANGED */
246 #endif /* UIP_CONF_IPV6_RPL */
247 
248 
249 
250 /** \brief An entry in the routing table */
251 typedef struct uip_ds6_route {
252  uint8_t isused;
253  uip_ipaddr_t ipaddr;
254  uint8_t length;
255  uint8_t metric;
256  uip_ipaddr_t nexthop;
257 #ifdef UIP_DS6_ROUTE_STATE_TYPE
258  UIP_DS6_ROUTE_STATE_TYPE state;
259 #endif
260 } uip_ds6_route_t;
261 
262 /** \brief Interface structure (contains all the interface variables) */
263 typedef struct uip_ds6_netif {
264  uint32_t link_mtu;
265  uint8_t cur_hop_limit;
266  uint32_t base_reachable_time; /* in msec */
267  uint32_t reachable_time; /* in msec */
268  uint32_t retrans_timer; /* in msec */
269  uint8_t maxdadns;
270  uip_ds6_addr_t addr_list[UIP_DS6_ADDR_NB];
271  uip_ds6_aaddr_t aaddr_list[UIP_DS6_AADDR_NB];
272  uip_ds6_maddr_t maddr_list[UIP_DS6_MADDR_NB];
273 } uip_ds6_netif_t;
274 
275 /** \brief Generic type for a DS6, to use a common loop though all DS */
276 typedef struct uip_ds6_element {
277  uint8_t isused;
278  uip_ipaddr_t ipaddr;
279 } uip_ds6_element_t;
280 
281 
282 /*---------------------------------------------------------------------------*/
283 extern uip_ds6_netif_t uip_ds6_if;
284 extern struct etimer uip_ds6_timer_periodic;
285 
286 #if UIP_CONF_ROUTER
287 extern uip_ds6_prefix_t uip_ds6_prefix_list[UIP_DS6_PREFIX_NB];
288 #else /* UIP_CONF_ROUTER */
289 extern struct etimer uip_ds6_timer_rs;
290 #endif /* UIP_CONF_ROUTER */
291 
292 
293 /*---------------------------------------------------------------------------*/
294 /** \brief Initialize data structures */
295 void uip_ds6_init(void);
296 
297 /** \brief Periodic processing of data structures */
298 void uip_ds6_periodic(void);
299 
300 /** \brief Generic loop routine on an abstract data structure, which generalizes
301  * all data structures used in DS6 */
302 uint8_t uip_ds6_list_loop(uip_ds6_element_t *list, uint8_t size,
303  uint16_t elementsize, uip_ipaddr_t *ipaddr,
304  uint8_t ipaddrlen,
305  uip_ds6_element_t **out_element);
306 
307 /** \name Neighbor Cache basic routines */
308 /** @{ */
309 uip_ds6_nbr_t *uip_ds6_nbr_add(uip_ipaddr_t *ipaddr, uip_lladdr_t *lladdr,
310  uint8_t isrouter, uint8_t state);
311 void uip_ds6_nbr_rm(uip_ds6_nbr_t *nbr);
312 uip_ds6_nbr_t *uip_ds6_nbr_lookup(uip_ipaddr_t *ipaddr);
313 
314 /** @} */
315 
316 /** \name Default router list basic routines */
317 /** @{ */
318 uip_ds6_defrt_t *uip_ds6_defrt_add(uip_ipaddr_t *ipaddr,
319  unsigned long interval);
320 void uip_ds6_defrt_rm(uip_ds6_defrt_t *defrt);
321 uip_ds6_defrt_t *uip_ds6_defrt_lookup(uip_ipaddr_t *ipaddr);
322 uip_ipaddr_t *uip_ds6_defrt_choose(void);
323 
324 /** @} */
325 
326 /** \name Prefix list basic routines */
327 /** @{ */
328 #if UIP_CONF_ROUTER
329 uip_ds6_prefix_t *uip_ds6_prefix_add(uip_ipaddr_t *ipaddr, uint8_t length,
330  uint8_t advertise, uint8_t flags,
331  unsigned long vtime,
332  unsigned long ptime);
333 #else /* UIP_CONF_ROUTER */
334 uip_ds6_prefix_t *uip_ds6_prefix_add(uip_ipaddr_t *ipaddr, uint8_t length,
335  unsigned long interval);
336 #endif /* UIP_CONF_ROUTER */
337 void uip_ds6_prefix_rm(uip_ds6_prefix_t *prefix);
338 uip_ds6_prefix_t *uip_ds6_prefix_lookup(uip_ipaddr_t *ipaddr,
339  uint8_t ipaddrlen);
340 uint8_t uip_ds6_is_addr_onlink(uip_ipaddr_t *ipaddr);
341 
342 /** @} */
343 
344 /** \name Unicast address list basic routines */
345 /** @{ */
346 uip_ds6_addr_t *uip_ds6_addr_add(uip_ipaddr_t *ipaddr,
347  unsigned long vlifetime, uint8_t type);
348 void uip_ds6_addr_rm(uip_ds6_addr_t *addr);
349 uip_ds6_addr_t *uip_ds6_addr_lookup(uip_ipaddr_t *ipaddr);
350 uip_ds6_addr_t *uip_ds6_get_link_local(int8_t state);
351 uip_ds6_addr_t *uip_ds6_get_global(int8_t state);
352 
353 /** @} */
354 
355 /** \name Multicast address list basic routines */
356 /** @{ */
357 uip_ds6_maddr_t *uip_ds6_maddr_add(uip_ipaddr_t *ipaddr);
358 void uip_ds6_maddr_rm(uip_ds6_maddr_t *maddr);
359 uip_ds6_maddr_t *uip_ds6_maddr_lookup(uip_ipaddr_t *ipaddr);
360 
361 /** @} */
362 
363 /** \name Anycast address list basic routines */
364 /** @{ */
365 uip_ds6_aaddr_t *uip_ds6_aaddr_add(uip_ipaddr_t *ipaddr);
366 void uip_ds6_aaddr_rm(uip_ds6_aaddr_t *aaddr);
367 uip_ds6_aaddr_t *uip_ds6_aaddr_lookup(uip_ipaddr_t *ipaddr);
368 
369 /** @} */
370 
371 
372 /** \name Routing Table basic routines */
373 /** @{ */
374 uip_ds6_route_t *uip_ds6_route_lookup(uip_ipaddr_t *destipaddr);
375 uip_ds6_route_t *uip_ds6_route_add(uip_ipaddr_t *ipaddr, uint8_t length,
376  uip_ipaddr_t *next_hop, uint8_t metric);
377 void uip_ds6_route_rm(uip_ds6_route_t *route);
378 void uip_ds6_route_rm_by_nexthop(uip_ipaddr_t *nexthop);
379 
380 /** @} */
381 
382 /** \brief set the last 64 bits of an IP address based on the MAC address */
383 void uip_ds6_set_addr_iid(uip_ipaddr_t * ipaddr, uip_lladdr_t * lladdr);
384 
385 /** \brief Get the number of matching bits of two addresses */
386 uint8_t get_match_length(uip_ipaddr_t * src, uip_ipaddr_t * dst);
387 
388 /** \brief Perform Duplicate Address Selection on one address */
389 void uip_ds6_dad(uip_ds6_addr_t * ifaddr);
390 
391 /** \brief Callback when DAD failed */
392 int uip_ds6_dad_failed(uip_ds6_addr_t * ifaddr);
393 
394 /** \brief Source address selection, see RFC 3484 */
395 void uip_ds6_select_src(uip_ipaddr_t * src, uip_ipaddr_t * dst);
396 
397 #if UIP_CONF_ROUTER
398 #if UIP_ND6_SEND_RA
399 /** \brief Send a RA as an asnwer to a RS */
400 void uip_ds6_send_ra_sollicited(void);
401 
402 /** \brief Send a periodic RA */
403 void uip_ds6_send_ra_periodic(void);
404 #endif /* UIP_ND6_SEND_RA */
405 #else /* UIP_CONF_ROUTER */
406 /** \brief Send periodic RS to find router */
407 void uip_ds6_send_rs(void);
408 #endif /* UIP_CONF_ROUTER */
409 
410 /** \brief Compute the reachable time based on base reachable time, see RFC 4861*/
411 uint32_t uip_ds6_compute_reachable_time(void); /** \brief compute random reachable timer */
412 
413 /** \name Macros to check if an IP address (unicast, multicast or anycast) is mine */
414 /** @{ */
415 #define uip_ds6_is_my_addr(addr) (uip_ds6_addr_lookup(addr) != NULL)
416 #define uip_ds6_is_my_maddr(addr) (uip_ds6_maddr_lookup(addr) != NULL)
417 #define uip_ds6_is_my_aaddr(addr) (uip_ds6_aaddr_lookup(addr) != NULL)
418 /** @} */
419 /** @} */
420 
421 #endif /* __UIP_DS6_H__ */
Generated on Fri Aug 30 2013 12:34:06 for Contiki 2.5 by   doxygen 1.8.3.1