RPL implementation for GNRC. More...

Detailed Description

RPL implementation for GNRC.

Configuration

USEMODULE

Auto-Initialization

If the application defines only one interface (GNRC_NETIF_NUMOF == 1), then RPL will be initialized on this interface.

If the application defines several interfaces (GNRC_NETIF_NUMOF > 1), then RPL will be initialized on the interface GNRC_RPL_DEFAULT_NETIF. Your application is responsible for setting GNRC_RPL_DEFAULT_NETIF to a valid interface PID, e.g. via CFLAGS.

Initializing RPL on multiple interfaces automatically is currently not supported. Call gnrc_rpl_init() manually from your application for the desired interfaces in this case.

CFLAGS

Modules

 RPL source routing header extension
 Implementation of RPL source routing extension headers.
 
 Reactive Discovery of P2P Routes in LLNs
 Implementation of P2P-RPL.
 

Files

file  dodag.h
 DODAG-related functions for RPL.
 
file  of_manager.h
 RPL Objective functions manager header.
 
file  structs.h
 RPL data structs.
 
file  rpl.h
 RPL header.
 
file  net/gnrc/routing/rpl/gnrc_rpl_internal/netstats.h
 RPL control message statistics functions.
 
file  validation.h
 RPL control message validation functions.
 
file  of0.h
 Objective Function Zero.
 

Macros

#define GNRC_RPL_STACK_SIZE   (THREAD_STACKSIZE_DEFAULT)
 Default stack size to use for the RPL thread.
 
#define GNRC_RPL_PRIO   (GNRC_IPV6_PRIO + 1)
 Default priority for the RPL thread.
 
#define GNRC_RPL_MSG_QUEUE_SIZE   (8U)
 Default message queue size to use for the RPL thread.
 
#define GNRC_RPL_ALL_NODES_ADDR   {{ 0xff, 0x02, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0x1a }}
 Static initializer for the all-RPL-nodes multicast IPv6 address (ff02::1a) More...
 
#define GNRC_RPL_MSG_TYPE_LIFETIME_UPDATE   (0x0900)
 Message type for lifetime updates.
 
#define GNRC_RPL_MSG_TYPE_TRICKLE_MSG   (0x0901)
 Message type for trickle.
 
#define GNRC_RPL_MSG_TYPE_DAO_HANDLE   (0x0903)
 Message type for handling DAO sending.
 
#define GNRC_RPL_INFINITE_RANK   (0xFFFF)
 Infinite rank. More...
 
#define GNRC_RPL_DEFAULT_MIN_HOP_RANK_INCREASE   (256)
 Default minimum hop rank increase. More...
 
#define GNRC_RPL_DEFAULT_MAX_RANK_INCREASE   (0)
 Maximum rank increase.
 
#define GNRC_RPL_IMPLEMENTED_OFS_NUMOF   (1)
 Number of implemented Objective Functions.
 
#define GNRC_RPL_DEFAULT_OCP   (0)
 Default Objective Code Point (OF0)
 
#define GNRC_RPL_DEFAULT_INSTANCE   (0)
 Default Instance ID.
 
#define GNRC_RPL_DEFAULT_PREFIX_LEN   (64)
 Default prefix length for the DODAG id.
 
#define GNRC_RPL_DEFAULT_PREFIX_LIFETIME   (0xFFFFFFFF)
 Default prefix valid and preferred time for the DODAG id. More...
 
#define GNRC_RPL_GROUNDED   (1)
 A DODAG can be grounded or floating. More...
 
#define GNRC_RPL_CLEANUP_TIME   (5)
 Cleanup timeout in seconds.
 
#define GNRC_RPL_ROOT_RANK   (GNRC_RPL_DEFAULT_MIN_HOP_RANK_INCREASE)
 Rank of the root node.
 
#define GNRC_RPL_ICMPV6_CODE_DIS   (0x00)
 DIS ICMPv6 code. More...
 
#define GNRC_RPL_ICMPV6_CODE_DIO   (0x01)
 DIO ICMPv6 code. More...
 
#define GNRC_RPL_ICMPV6_CODE_DAO   (0x02)
 DAO ICMPv6 code. More...
 
#define GNRC_RPL_ICMPV6_CODE_DAO_ACK   (0x03)
 DAO ACK ICMPv6 code. More...
 
#define GNRC_RPL_LIFETIME_UPDATE_STEP   (2)
 Update interval of the lifetime update function.
 
#define DAGRANK(rank, mhri)   (rank/mhri)
 Rank part of the DODAG. More...
 

Functions

kernel_pid_t gnrc_rpl_init (kernel_pid_t if_pid)
 Initialization of the RPL thread. More...
 
gnrc_rpl_instance_tgnrc_rpl_root_init (uint8_t instance_id, ipv6_addr_t *dodag_id, bool gen_inst_id, bool local_inst_id)
 Initialization of a node as root. More...
 
void gnrc_rpl_send_DIO (gnrc_rpl_instance_t *instance, ipv6_addr_t *destination)
 Send a DIO of the instance to the destination. More...
 
void gnrc_rpl_send_DIS (gnrc_rpl_instance_t *instance, ipv6_addr_t *destination)
 Send a DIS of the instace to the destination. More...
 
void gnrc_rpl_send_DAO (gnrc_rpl_instance_t *instance, ipv6_addr_t *destination, uint8_t lifetime)
 Send a DAO of the dodag to the destination. More...
 
void gnrc_rpl_send_DAO_ACK (gnrc_rpl_instance_t *instance, ipv6_addr_t *destination, uint8_t seq)
 Send a DAO-ACK of the instance to the destination. More...
 
void gnrc_rpl_recv_DIS (gnrc_rpl_dis_t *dis, kernel_pid_t iface, ipv6_addr_t *src, ipv6_addr_t *dst, uint16_t len)
 Parse a DIS. More...
 
void gnrc_rpl_recv_DIO (gnrc_rpl_dio_t *dio, kernel_pid_t iface, ipv6_addr_t *src, ipv6_addr_t *dst, uint16_t len)
 Parse a DIO. More...
 
void gnrc_rpl_recv_DAO (gnrc_rpl_dao_t *dao, kernel_pid_t iface, ipv6_addr_t *src, ipv6_addr_t *dst, uint16_t len)
 Parse a DAO. More...
 
void gnrc_rpl_recv_DAO_ACK (gnrc_rpl_dao_ack_t *dao_ack, kernel_pid_t iface, ipv6_addr_t *src, ipv6_addr_t *dst, uint16_t len)
 Parse a DAO-ACK. More...
 
void gnrc_rpl_delay_dao (gnrc_rpl_dodag_t *dodag)
 Delay the DAO sending interval. More...
 
void gnrc_rpl_long_delay_dao (gnrc_rpl_dodag_t *dodag)
 Long delay the DAO sending interval. More...
 
gnrc_rpl_instance_tgnrc_rpl_root_instance_init (uint8_t instance_id, ipv6_addr_t *dodag_id, uint8_t mop)
 Create a new RPL instance and RPL DODAG. More...
 
void gnrc_rpl_send (gnrc_pktsnip_t *pkt, kernel_pid_t iface, ipv6_addr_t *src, ipv6_addr_t *dst, ipv6_addr_t *dodag_id)
 Send a control message. More...
 
uint8_t gnrc_rpl_gen_instance_id (bool local)
 Generate a local or global instance id. More...
 
static void gnrc_rpl_config_pio (gnrc_rpl_dodag_t *dodag, bool status)
 (De-)Activate the transmission of Prefix Information Options within DIOs for a particular DODAG More...
 

Variables

kernel_pid_t gnrc_rpl_pid
 PID of the RPL thread.
 
const ipv6_addr_t ipv6_addr_all_rpl_nodes
 

RPL Mode of Operations

#define GNRC_RPL_MOP_NO_DOWNWARD_ROUTES   (0x00)
 
#define GNRC_RPL_MOP_NON_STORING_MODE   (0x01)
 
#define GNRC_RPL_MOP_STORING_MODE_NO_MC   (0x02)
 
#define GNRC_RPL_MOP_STORING_MODE_MC   (0x03)
 
#define GNRC_RPL_DEFAULT_MOP   GNRC_RPL_MOP_STORING_MODE_NO_MC
 default MOP set on compile time
 

Sequence counter handling

See also
Sequence Counter Operation
static uint8_t GNRC_RPL_COUNTER_INCREMENT (uint8_t counter)
 
static bool GNRC_RPL_COUNTER_IS_INIT (uint8_t counter)
 
static bool GNRC_RPL_COUNTER_GREATER_THAN_LOCAL (uint8_t A, uint8_t B)
 
static bool GNRC_RPL_COUNTER_GREATER_THAN (uint8_t A, uint8_t B)
 
#define GNRC_RPL_COUNTER_MAX   (255)
 
#define GNRC_RPL_COUNTER_LOWER_REGION   (127)
 
#define GNRC_RPL_COUNTER_SEQ_WINDOW   (16)
 
#define GNRC_RPL_COUNTER_INIT   (GNRC_RPL_COUNTER_MAX - GNRC_RPL_COUNTER_SEQ_WINDOW + 1)
 

Trickle parameters

See also
Trickle Parameters
#define GNRC_RPL_DEFAULT_DIO_INTERVAL_DOUBLINGS   (20)
 
#define GNRC_RPL_DEFAULT_DIO_INTERVAL_MIN   (3)
 
#define GNRC_RPL_DEFAULT_DIO_REDUNDANCY_CONSTANT   (10)
 

Default parent and route entry lifetime

default lifetime will be multiplied by the lifetime unit to obtain the resulting lifetime

See also
DODAG Configuration
#define GNRC_RPL_DEFAULT_LIFETIME   (5)
 
#define GNRC_RPL_LIFETIME_UNIT   (60)
 

Parameters used for DAO handling

See also
RPL Constants and Variables
#define GNRC_RPL_DAO_SEND_RETRIES   (4)
 
#define GNRC_RPL_DEFAULT_WAIT_FOR_DAO_ACK   (3)
 
#define GNRC_RPL_REGULAR_DAO_INTERVAL   (60)
 
#define GNRC_RPL_DEFAULT_DAO_DELAY   (1)
 

Node Status

#define GNRC_RPL_NORMAL_NODE   (0)
 
#define GNRC_RPL_ROOT_NODE   (1)
 
#define GNRC_RPL_LEAF_NODE   (2)
 

RPL Control Message Options

See also
RPL Control Message Options
#define GNRC_RPL_OPT_PAD1   (0)
 
#define GNRC_RPL_OPT_PADN   (1)
 
#define GNRC_RPL_OPT_DAG_METRIC_CONTAINER   (2)
 
#define GNRC_RPL_OPT_ROUTE_INFO   (3)
 
#define GNRC_RPL_OPT_DODAG_CONF   (4)
 
#define GNRC_RPL_OPT_TARGET   (5)
 
#define GNRC_RPL_OPT_TRANSIT   (6)
 
#define GNRC_RPL_OPT_SOLICITED_INFO   (7)
 
#define GNRC_RPL_OPT_PREFIX_INFO   (8)
 
#define GNRC_RPL_OPT_TARGET_DESC   (9)
 

Global / Local instance id masks

See also
RFC 6550, section 5.1, RPL Instance ID
#define GNRC_RPL_INSTANCE_ID_MSB   (1 << 7)
 
#define GNRC_RPL_GLOBAL_INSTANCE_MASK   (0x7F)
 
#define GNRC_RPL_LOCAL_INSTANCE_MASK   (0x3F)
 
#define GNRC_RPL_INSTANCE_D_FLAG_MASK   (1 << 6)
 

Macro Definition Documentation

◆ DAGRANK

#define DAGRANK (   rank,
  mhri 
)    (rank/mhri)

Rank part of the DODAG.

See also
RFC 6550, section 3.5.1, Rank Comparison (DAGRank())

Definition at line 424 of file rpl.h.

◆ GNRC_RPL_ALL_NODES_ADDR

#define GNRC_RPL_ALL_NODES_ADDR   {{ 0xff, 0x02, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0x1a }}

Static initializer for the all-RPL-nodes multicast IPv6 address (ff02::1a)

See also
RFC 6550, section 6

Definition at line 151 of file rpl.h.

◆ GNRC_RPL_DEFAULT_MIN_HOP_RANK_INCREASE

#define GNRC_RPL_DEFAULT_MIN_HOP_RANK_INCREASE   (256)

Default minimum hop rank increase.

See also
RFC 6550, section 17

Definition at line 183 of file rpl.h.

◆ GNRC_RPL_DEFAULT_PREFIX_LIFETIME

#define GNRC_RPL_DEFAULT_PREFIX_LIFETIME   (0xFFFFFFFF)

Default prefix valid and preferred time for the DODAG id.

Note
Currently not used, but needed for RIOs
See also
Route Information

Definition at line 311 of file rpl.h.

◆ GNRC_RPL_GROUNDED

#define GNRC_RPL_GROUNDED   (1)

A DODAG can be grounded or floating.

See also
Grounded and Floating DODAGs

Definition at line 319 of file rpl.h.

◆ GNRC_RPL_ICMPV6_CODE_DAO

#define GNRC_RPL_ICMPV6_CODE_DAO   (0x02)

DAO ICMPv6 code.

See also
RFC 6550, section 6

Definition at line 403 of file rpl.h.

◆ GNRC_RPL_ICMPV6_CODE_DAO_ACK

#define GNRC_RPL_ICMPV6_CODE_DAO_ACK   (0x03)

DAO ACK ICMPv6 code.

See also
RFC 6550, section 6

Definition at line 411 of file rpl.h.

◆ GNRC_RPL_ICMPV6_CODE_DIO

#define GNRC_RPL_ICMPV6_CODE_DIO   (0x01)

DIO ICMPv6 code.

See also
RFC 6550, section 6

Definition at line 395 of file rpl.h.

◆ GNRC_RPL_ICMPV6_CODE_DIS

#define GNRC_RPL_ICMPV6_CODE_DIS   (0x00)

DIS ICMPv6 code.

See also
RFC 6550, section 6

Definition at line 387 of file rpl.h.

◆ GNRC_RPL_INFINITE_RANK

#define GNRC_RPL_INFINITE_RANK   (0xFFFF)

Infinite rank.

See also
RFC 6550, section 17

Definition at line 174 of file rpl.h.

Function Documentation

◆ gnrc_rpl_config_pio()

static void gnrc_rpl_config_pio ( gnrc_rpl_dodag_t dodag,
bool  status 
)
inlinestatic

(De-)Activate the transmission of Prefix Information Options within DIOs for a particular DODAG

Parameters
[in]dodagPointer to the DODAG
[in]statustrue for activating PIOs and false for deactivating them

Definition at line 621 of file rpl.h.

◆ gnrc_rpl_delay_dao()

void gnrc_rpl_delay_dao ( gnrc_rpl_dodag_t dodag)

Delay the DAO sending interval.

Parameters
[in]dodagThe DODAG of the DAO

◆ gnrc_rpl_gen_instance_id()

uint8_t gnrc_rpl_gen_instance_id ( bool  local)

Generate a local or global instance id.

Parameters
[in]localflag to indicate whether a local or global instance id is requested
Returns
Local instance id, if local is true
Global instance id, otherwise.

◆ gnrc_rpl_init()

kernel_pid_t gnrc_rpl_init ( kernel_pid_t  if_pid)

Initialization of the RPL thread.

Parameters
[in]if_pidPID of the interface
Returns
The PID of the RPL thread, on success.
a negative errno on error.

◆ gnrc_rpl_long_delay_dao()

void gnrc_rpl_long_delay_dao ( gnrc_rpl_dodag_t dodag)

Long delay the DAO sending interval.

Parameters
[in]dodagThe DODAG of the DAO

◆ gnrc_rpl_recv_DAO()

void gnrc_rpl_recv_DAO ( gnrc_rpl_dao_t dao,
kernel_pid_t  iface,
ipv6_addr_t src,
ipv6_addr_t dst,
uint16_t  len 
)

Parse a DAO.

Parameters
[in]daoPointer to the DAO message.
[in]ifaceInterface PID of the incoming DIO.
[in]srcPointer to the source address of the IPv6 packet.
[in]dstPointer to the destination address of the IPv6 packet.
[in]lenLength of the IPv6 packet.

◆ gnrc_rpl_recv_DAO_ACK()

void gnrc_rpl_recv_DAO_ACK ( gnrc_rpl_dao_ack_t dao_ack,
kernel_pid_t  iface,
ipv6_addr_t src,
ipv6_addr_t dst,
uint16_t  len 
)

Parse a DAO-ACK.

Parameters
[in]dao_ackPointer to the DAO-ACK message.
[in]ifaceInterface PID of the incoming DIO.
[in]srcPointer to the source address of the IPv6 packet.
[in]dstPointer to the destination address of the IPv6 packet.
[in]lenLength of the IPv6 packet.

◆ gnrc_rpl_recv_DIO()

void gnrc_rpl_recv_DIO ( gnrc_rpl_dio_t dio,
kernel_pid_t  iface,
ipv6_addr_t src,
ipv6_addr_t dst,
uint16_t  len 
)

Parse a DIO.

Parameters
[in]dioPointer to the DIO message.
[in]ifaceInterface PID of the incoming DIO.
[in]srcPointer to the source address of the IPv6 packet.
[in]dstPointer to the destination address of the IPv6 packet.
[in]lenLength of the IPv6 packet.

◆ gnrc_rpl_recv_DIS()

void gnrc_rpl_recv_DIS ( gnrc_rpl_dis_t dis,
kernel_pid_t  iface,
ipv6_addr_t src,
ipv6_addr_t dst,
uint16_t  len 
)

Parse a DIS.

Parameters
[in]disPointer to the DIS message.
[in]ifaceInterface PID of the incoming DIS.
[in]srcPointer to the source address of the IPv6 packet.
[in]dstPointer to the destination address of the IPv6 packet.
[in]lenLength of the IPv6 packet.

◆ gnrc_rpl_root_init()

gnrc_rpl_instance_t* gnrc_rpl_root_init ( uint8_t  instance_id,
ipv6_addr_t dodag_id,
bool  gen_inst_id,
bool  local_inst_id 
)

Initialization of a node as root.

Parameters
[in]instance_idId of the instance
[in]dodag_idId of the DODAG
[in]gen_inst_idFlag indicating whether to generate an instance id. If true, instance_id will be ignored
[in]local_inst_idFlag indicating whether a local or global instance id should be generatad
Returns
Pointer to the new RPL Instance, on success.
NULL, otherwise.

◆ gnrc_rpl_root_instance_init()

gnrc_rpl_instance_t* gnrc_rpl_root_instance_init ( uint8_t  instance_id,
ipv6_addr_t dodag_id,
uint8_t  mop 
)

Create a new RPL instance and RPL DODAG.

Parameters
[in]instance_idId of the instance
[in]dodag_idId of the DODAG
[in]mopMode of Operation
Returns
Pointer to the new RPL instance, on success.
NULL, otherwise.

◆ gnrc_rpl_send()

void gnrc_rpl_send ( gnrc_pktsnip_t pkt,
kernel_pid_t  iface,
ipv6_addr_t src,
ipv6_addr_t dst,
ipv6_addr_t dodag_id 
)

Send a control message.

Parameters
[in]pktgnrc_pktnsip_t to send
[in]ifaceInterface PID to send this pkt to
[in]srcSource address of the packet
[in]dstDestination address of the packet
[in]dodag_idId of the DODAG

◆ gnrc_rpl_send_DAO()

void gnrc_rpl_send_DAO ( gnrc_rpl_instance_t instance,
ipv6_addr_t destination,
uint8_t  lifetime 
)

Send a DAO of the dodag to the destination.

Parameters
[in]instancePointer to the instance.
[in]destinationIPv6 addres of the destination.
[in]lifetimeLifetime of the route to announce.

◆ gnrc_rpl_send_DAO_ACK()

void gnrc_rpl_send_DAO_ACK ( gnrc_rpl_instance_t instance,
ipv6_addr_t destination,
uint8_t  seq 
)

Send a DAO-ACK of the instance to the destination.

Parameters
[in]instancePointer to the RPL instance.
[in]destinationIPv6 addres of the destination.
[in]seqSequence number to be acknowledged.

◆ gnrc_rpl_send_DIO()

void gnrc_rpl_send_DIO ( gnrc_rpl_instance_t instance,
ipv6_addr_t destination 
)

Send a DIO of the instance to the destination.

Parameters
[in]instancePointer to the RPL instance.
[in]destinationIPv6 addres of the destination.

◆ gnrc_rpl_send_DIS()

void gnrc_rpl_send_DIS ( gnrc_rpl_instance_t instance,
ipv6_addr_t destination 
)

Send a DIS of the instace to the destination.

Parameters
[in]instancePointer to the RPL instance, optional.
[in]destinationIPv6 addres of the destination.

Variable Documentation

◆ ipv6_addr_all_rpl_nodes

const ipv6_addr_t ipv6_addr_all_rpl_nodes