nes-proj/os/net/routing/routing.h
2018-02-02 08:51:29 -08:00

178 lines
5.9 KiB
C

/*
* Copyright (c) 2017, RISE SICS.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the Institute nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* This file is part of the Contiki operating system.
*
*/
/**
* \file
* Routing driver header file
* \author
* Simon Duquennoy <simon.duquennoy@ri.se>
*/
#ifndef ROUTING_H_
#define ROUTING_H_
#include "contiki.h"
#include "net/ipv6/uip.h"
#include "net/ipv6/uip-ds6-nbr.h"
#include "net/ipv6/uip-ds6-route.h"
#include "net/ipv6/uip-sr.h"
#include "net/linkaddr.h"
/**
* The structure of a routing protocol driver.
*/
struct routing_driver {
char *name;
/** Initialize the routing protocol */
void (* init)(void);
/**
* Set the prefix, for nodes that will operate as root
*
* \param prefix The prefix. If NULL, UIP_DS6_DEFAULT_PREFIX is used instead
* \param iid The IID. If NULL, it will be built from uip_ds6_set_addr_iid.
*/
void (* root_set_prefix)(uip_ipaddr_t *prefix, uip_ipaddr_t *iid);
/**
* Set the node as root and start a network
*
* \return 0 in case of success, -1 otherwise
*/
int (* root_start)(void);
/**
* Tells whether the node is a network root or not
*
* \return 1 if we are root, 0 otherwise
*/
int (* node_is_root)(void);
/**
* Returns the IPv6 address of the network root, if any
*
* \param ipaddr A pointer where to copy the IP address of the root
* \return 1 if the root address was copied, 0 otherwise
*/
int (* get_root_ipaddr)(uip_ipaddr_t *ipaddr);
/**
* Returns the global IPv6 address of a source routing node
*
* \param ipaddr A pointer where to copy the IP address of the node
* \param node The source routing node
* \return 1 if the global node address was copied, 0 otherwise
*/
int (* get_sr_node_ipaddr)(uip_ipaddr_t *addr, const uip_sr_node_t *node);
/**
* Leave the network the node is part of
*
*/
void (* leave_network)(void);
/**
* Tells whether the node is currently part of a network
*
* \return 1 if we have joined a network, 0 otherwise.
*/
int (* node_has_joined)(void);
/**
* Tells whether the node is currently reachable as part of the network
*
* \return 1 if we are reachable, 0 otherwise.
*/
int (* node_is_reachable)(void);
/**
* Triggers a global topology repair
*
* \param str A textual description of the cause for triggering a repair
*/
void (* global_repair)(const char *str);
/**
* Triggers a RPL local topology repair
*
* \param str A textual description of the cause for triggering a repair
*/
void (* local_repair)(const char *str);
/**
* Removes all extension headers that pertain to the routing protocol.
*/
void (* ext_header_remove)(void);
/**
* Adds/updates routing protocol extension headers to current uIP packet.
*
* \return 1 in case of success, 0 otherwise
*/
int (* ext_header_update)(void);
/**
* Process and update the routing protocol hob-by-hop
* extention headers of the current uIP packet.
*
* \param uip_ext_opt_offset The offset within the uIP packet where
* extension headers start
* \return 1 in case the packet is valid and to be processed further,
* 0 in case the packet must be dropped.
*/
int (* ext_header_hbh_update)(int uip_ext_opt_offset);
/**
* Process and update SRH in-place,
* i.e. internal address swapping as per RFC6554
* \return 1 if SRH found, 0 otherwise
*/
int (* ext_header_srh_update)(void);
/**
* Look for next hop from SRH of current uIP packet.
*
* \param ipaddr A pointer to the address where to store the next hop.
* \return 1 if a next hop was found, 0 otherwise
*/
int (* ext_header_srh_get_next_hop)(uip_ipaddr_t *ipaddr);
/**
* Called by lower layers after every packet transmission
*
* \param addr The link-layer addrress of the packet destination
* \param status The transmission status (see os/net/mac/mac.h)
* \param numtx The total number of transmission attempts
*/
void (* link_callback)(const linkaddr_t *addr, int status, int numtx);
/**
* Called by uIP to notify addition/removal of IPv6 neighbor entries
*
* \param addr The link-layer addrress of the packet destination
* \param status The transmission status (see os/net/mac/mac.h)
* \param numtx The total number of transmission attempts
*/
void (* neighbor_state_changed)(uip_ds6_nbr_t *nbr);
/**
* Called by uIP if it has decided to drop a route because
*
* \param route The route that will be dropped after this function returns
*/
void (* drop_route)(uip_ds6_route_t *route);
};
#endif /* ROUTING_H_ */