fib.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2014 Martin Landsmann <Martin.Landsmann@HAW-Hamburg.de>
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <stdint.h>
 
#include "net/fib/table.h"
#include "sched.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef struct {
    uint8_t *address;      
    uint8_t address_size;  
    uint32_t address_flags; 
} rp_address_msg_t;

#define FIB_MSG_RP_SIGNAL_UNREACHABLE_DESTINATION (0x99)

#define FIB_MSG_RP_SIGNAL_DESTINATION_USED (0x98)

#define FIB_MSG_RP_SIGNAL_SOURCE_ROUTE_CREATED (0x97)

typedef struct {
    uint8_t dest[UNIVERSAL_ADDRESS_SIZE]; 
    size_t dest_size;    
} fib_destination_set_entry_t;

#define FIB_LIFETIME_NO_EXPIRE (0xFFFFFFFFffffffff)

#define FIB_FLAG_RPL_ROUTE (1UL << 0)

#define FIB_FLAG_NET_PREFIX_SHIFT (24)

#define FIB_FLAG_NET_PREFIX_MASK (0xffUL << FIB_FLAG_NET_PREFIX_SHIFT)

void fib_init(fib_table_t *table);

void fib_deinit(fib_table_t *table);

int fib_register_rp(fib_table_t *table, uint8_t *prefix, size_t prefix_addr_type_size);

int fib_add_entry(fib_table_t *table, kernel_pid_t iface_id, uint8_t *dst,
                  size_t dst_size, uint32_t dst_flags, uint8_t *next_hop,
                  size_t next_hop_size, uint32_t next_hop_flags,
                  uint32_t lifetime);

int fib_update_entry(fib_table_t *table, uint8_t *dst, size_t dst_size,
                     uint8_t *next_hop, size_t next_hop_size,
                     uint32_t next_hop_flags, uint32_t lifetime);

void fib_remove_entry(fib_table_t *table, uint8_t *dst, size_t dst_size);

void fib_flush(fib_table_t *table, kernel_pid_t interface);

int fib_get_next_hop(fib_table_t *table, kernel_pid_t *iface_id,
                     uint8_t *next_hop, size_t *next_hop_size,
                     uint32_t* next_hop_flags, uint8_t *dst, size_t dst_size,
                     uint32_t dst_flags);

int fib_get_destination_set(fib_table_t *table, uint8_t *prefix,
                            size_t prefix_size,
                            fib_destination_set_entry_t *dst_set,
                            size_t *dst_set_size);

int fib_sr_create(fib_table_t *table, fib_sr_t **fib_sr, kernel_pid_t sr_iface_id,
                  uint32_t sr_flags, uint32_t sr_lifetime);

int fib_sr_read_head(fib_table_t *table, fib_sr_t *fib_sr, kernel_pid_t *sr_iface_id,
                     uint32_t *sr_flags, uint32_t *sr_lifetime);

int fib_sr_read_destination(fib_table_t *table, fib_sr_t *fib_sr,
                            uint8_t *dst, size_t *dst_size);

int fib_sr_set(fib_table_t *table, fib_sr_t *fib_sr, kernel_pid_t *sr_iface_id,
               uint32_t *sr_flags, uint32_t *sr_lifetime);

int fib_sr_delete(fib_table_t *table, fib_sr_t *fib_sr);

int fib_sr_next(fib_table_t *table, fib_sr_t *fib_sr, fib_sr_entry_t **sr_path_entry);

int fib_sr_search(fib_table_t *table, fib_sr_t *fib_sr, uint8_t *addr, size_t addr_size,
                  fib_sr_entry_t **sr_path_entry);

int fib_sr_entry_append(fib_table_t *table, fib_sr_t *fib_sr,
                        uint8_t *dst, size_t dst_size);

int fib_sr_entry_add(fib_table_t *table, fib_sr_t *fib_sr,
                     fib_sr_entry_t *sr_path_entry, uint8_t *addr, size_t addr_size,
                     bool keep_remaining_route);

int fib_sr_entry_delete(fib_table_t *table, fib_sr_t *fib_sr, uint8_t *addr, size_t addr_size,
                        bool keep_remaining_route);

int fib_sr_entry_overwrite(fib_table_t *table, fib_sr_t *fib_sr,
                           uint8_t *addr_old, size_t addr_old_size,
                           uint8_t *addr_new, size_t addr_new_size);

int fib_sr_entry_get_address(fib_table_t *table, fib_sr_t *fib_sr, fib_sr_entry_t *sr_path_entry,
                             uint8_t *addr, size_t *addr_size);

int fib_sr_get_route(fib_table_t *table, uint8_t *dst, size_t dst_size, kernel_pid_t *sr_iface_id,
                     uint32_t *sr_flags,
                     uint8_t *addr_list, size_t *addr_list_size, size_t *element_size,
                     bool reverse, fib_sr_t **fib_sr);

int fib_get_num_used_entries(fib_table_t *table);

void fib_print_notify_rrp(void);

void fib_print_fib_table(fib_table_t *table);

void fib_print_routes(fib_table_t *table);

void fib_print_sr(fib_table_t *table, fib_sr_t *sr);
 
#if FIB_DEVEL_HELPER
int fib_devel_get_lifetime(fib_table_t *table, uint64_t *lifetime, uint8_t *dst,
                           size_t dst_size);
 
#endif
 
#ifdef __cplusplus
}
#endif