structs.h

Go to the documentation of this file.

/*
 * Copyright (C) 2017       HAW Hamburg
 * Copyright (C) 2015–2018  Cenk Gündoğan <cenk.guendogan@haw-hamburg.de>
 * Copyright (C) 2013       INRIA.
 *
 * 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.
 */
 
#pragma once

 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "byteorder.h"
#include "net/ipv6/addr.h"
#include "evtimer.h"
#include "evtimer_msg.h"
#include "trickle.h"

#define GNRC_RPL_OPT_DODAG_CONF_LEN         (14)
#define GNRC_RPL_OPT_PREFIX_INFO_LEN        (30)
#define GNRC_RPL_OPT_TARGET_LEN             (18)
#define GNRC_RPL_OPT_TRANSIT_INFO_LEN       (4)

#define GNRC_RPL_DAO_D_BIT                  (1 << 6)
#define GNRC_RPL_DAO_K_BIT                  (1 << 7)

#define GNRC_RPL_DAO_ACK_D_BIT              (1 << 7)

#define GNRC_RPL_REQ_DIO_OPT_DODAG_CONF_SHIFT       (0)
#define GNRC_RPL_REQ_DIO_OPT_DODAG_CONF             (1 << GNRC_RPL_REQ_DIO_OPT_DODAG_CONF_SHIFT)
#define GNRC_RPL_REQ_DIO_OPT_PREFIX_INFO_SHIFT      (1)
#define GNRC_RPL_REQ_DIO_OPT_PREFIX_INFO            (1 << GNRC_RPL_REQ_DIO_OPT_PREFIX_INFO_SHIFT)

typedef struct __attribute__((packed)) {
    uint8_t type;       
    uint8_t length;     
} gnrc_rpl_opt_t;

typedef struct __attribute__((packed)) {
    uint8_t instance_id;        
    uint8_t version_number;     
    network_uint16_t rank;      
    uint8_t g_mop_prf;          
    uint8_t dtsn;               
    uint8_t flags;              
    uint8_t reserved;           
    ipv6_addr_t dodag_id;       
} gnrc_rpl_dio_t;

typedef struct __attribute__((packed)) {
    uint8_t type;                       
    uint8_t length;                     
    uint8_t flags_a_pcs;                
    uint8_t dio_int_doubl;              
    uint8_t dio_int_min;                
    uint8_t dio_redun;                  
    network_uint16_t max_rank_inc;      
    network_uint16_t min_hop_rank_inc;  
    network_uint16_t ocp;               
    uint8_t reserved;                   
    uint8_t default_lifetime;           
    network_uint16_t lifetime_unit;     
} gnrc_rpl_opt_dodag_conf_t;

typedef struct __attribute__((packed)) {
    uint8_t flags;      
    uint8_t reserved;   
} gnrc_rpl_dis_t;

typedef struct __attribute__((packed)) {
    uint8_t type;               
    uint8_t length;             
    uint8_t instance_id;        
    uint8_t VID_flags;          
    ipv6_addr_t dodag_id;       
    uint8_t version_number;     
} gnrc_rpl_opt_dis_solicited_t;

typedef struct __attribute__((packed)) {
    uint8_t instance_id;        
    uint8_t k_d_flags;          
    uint8_t reserved;           
    uint8_t dao_sequence;       
} gnrc_rpl_dao_t;

typedef struct __attribute__((packed)) {
    uint8_t instance_id;        
    uint8_t d_reserved;         
    uint8_t dao_sequence;       
    uint8_t status;             
} gnrc_rpl_dao_ack_t;

typedef struct __attribute__((packed)) {
    uint8_t type;               
    uint8_t length;             
    uint8_t flags;              
    uint8_t prefix_length;      
    ipv6_addr_t target;         
} gnrc_rpl_opt_target_t;

typedef struct __attribute__((packed)) {
    uint8_t type;               
    uint8_t length;             
    uint8_t e_flags;            
    uint8_t path_control;       
    uint8_t path_sequence;      
    uint8_t path_lifetime;      
} gnrc_rpl_opt_transit_t;

typedef struct __attribute__((packed)) {
    uint8_t type;                       
    uint8_t length;                     
    uint8_t prefix_len;                 
    uint8_t LAR_flags;                  
    network_uint32_t valid_lifetime;    
    network_uint32_t pref_lifetime;     
    uint32_t reserved;                  
    ipv6_addr_t prefix;                 
} gnrc_rpl_opt_prefix_info_t;

typedef struct gnrc_rpl_dodag gnrc_rpl_dodag_t;

typedef struct gnrc_rpl_parent gnrc_rpl_parent_t;

typedef struct gnrc_rpl_instance gnrc_rpl_instance_t;

struct gnrc_rpl_parent {
    gnrc_rpl_parent_t *next;        
    uint8_t state;                  
    ipv6_addr_t addr;               
    uint8_t dtsn;                   
    uint16_t rank;                  
    gnrc_rpl_dodag_t *dodag;        
    double link_metric;             
    uint8_t link_metric_type;       
    evtimer_msg_event_t timeout_event;
};

typedef struct {
    uint16_t ocp;   

    uint16_t (*calc_rank)(gnrc_rpl_dodag_t *dodag, uint16_t base_rank);

    int (*parent_cmp)(gnrc_rpl_parent_t *parent1, gnrc_rpl_parent_t *parent2);
    int (*which_dodag)(gnrc_rpl_dodag_t *, gnrc_rpl_dio_t *); 

    void (*reset)(gnrc_rpl_dodag_t *dodag);
    void (*parent_state_callback)(gnrc_rpl_parent_t *, int, int); 

    void (*init)(gnrc_rpl_dodag_t *dodag);
    void (*process_dio)(void);  
} gnrc_rpl_of_t;

struct gnrc_rpl_dodag {
    ipv6_addr_t dodag_id;           
    gnrc_rpl_parent_t *parents;     
    gnrc_rpl_instance_t *instance;  
    uint8_t dtsn;                   
    uint8_t prf;                    
    uint8_t dio_interval_doubl;     
    uint8_t dio_min;                
    uint8_t dio_redun;              
    uint8_t default_lifetime;       
    uint16_t lifetime_unit;         
    kernel_pid_t iface;             
    uint8_t version;                
    uint8_t grounded;               
    uint16_t my_rank;               
    uint8_t node_status;            
    uint8_t dao_seq;                
    uint8_t dao_counter;            
    bool dao_ack_received;          
    uint8_t dio_opts;               
    evtimer_msg_event_t dao_event;  
    trickle_t trickle;              
};
 
struct gnrc_rpl_instance {
    uint8_t id;                     
    uint8_t state;                  
    gnrc_rpl_dodag_t dodag;         
    uint8_t mop;                    
    gnrc_rpl_of_t *of;              
    uint16_t min_hop_rank_inc;      
    uint16_t max_rank_inc;          
    evtimer_msg_event_t cleanup_event;
};

typedef struct {
    uint8_t type;       
    uint8_t length;     
} gnrc_rpl_internal_opt_t;

typedef struct  {
    uint8_t type;                
    uint8_t length;              
    uint8_t instance_id;         
    uint8_t VID_flags;           
    ipv6_addr_t dodag_id;        
    uint8_t version_number;      
} gnrc_rpl_internal_opt_dis_solicited_t;
 
#ifdef __cplusplus
}
#endif