1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
/*
* Copyright (c) 2017-2019 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file fibEntry.h
* @brief A forwarding entry in the FIB table
*
* A Forwarding Information Base (FIB) entry (FibEntry) is a
* set of nexthops for a name. It also indicates the forwarding strategy.
*
* Each nexthop contains the ConnectionId assocaited with it. This could be
* something specific like a MAC address or point-to-point tunnel. Or, it
* could be something general like a MAC group address or ip multicast overlay.
*
* See strategy.h for a description of forwarding strategies.
* In short, a strategy is the algorithm used to select one or more nexthops
* from the set of available nexthops.
*
* Each nexthop also contains a void* to a forwarding strategy data container.
* This allows a strategy to keep proprietary information about each nexthop.
*
*
*/
#ifndef fibEntry_h
#define fibEntry_h
#include <src/core/name.h>
#include <src/strategies/strategyImpl.h>
#ifdef WITH_MAPME
#include <parc/algol/parc_EventTimer.h>
#include <parc/algol/parc_Iterator.h>
#endif /* WITH_MAPME */
struct fib_entry;
typedef struct fib_entry FibEntry;
FibEntry *fibEntry_Create(Name *name, strategy_type fwdStrategy);
/**
* Decrements the reference count by one, and destroys the memory after last
* release
*
*/
void fibEntry_Release(FibEntry **fibEntryPtr);
/**
* Returns a reference counted copy of the fib entry
*
* The reference count is increased by one. The returned value must be
* released via fibEnty_Release().
*
* @param [in] fibEntry An allocated FibEntry
*
* @return non-null A reference counted copy of the fibEntry
*
*/
FibEntry *fibEntry_Acquire(const FibEntry *fibEntry);
void fibEntry_SetStrategy(FibEntry *fibEntry, strategy_type strategy);
void fibEntry_AddNexthop(FibEntry *fibEntry, unsigned connectionId);
void fibEntry_RemoveNexthopByConnectionId(FibEntry *fibEntry,
unsigned connectionId);
size_t fibEntry_NexthopCount(const FibEntry *fibEntry);
/**
* @function fibEntry_GetNexthops
* @abstract Returns the nexthop set of the FIB entry. You must Acquire if it
* will be saved.
* @discussion
* Returns the next hop set for the FIB entry.
*/
const NumberSet *fibEntry_GetNexthops(const FibEntry *fibEntry);
const NumberSet *fibEntry_GetNexthopsFromForwardingStrategy(
const FibEntry *fibEntry, const Message *interestMessage);
void fibEntry_ReceiveObjectMessage(const FibEntry *fibEntry,
const NumberSet *egressId,
const Message *objectMessage, Ticks rtt);
void fibEntry_OnTimeout(const FibEntry *fibEntry, const NumberSet *egressId);
strategy_type fibEntry_GetFwdStrategyType(const FibEntry *fibEntry);
StrategyImpl *fibEntry_GetFwdStrategy(const FibEntry *fibEntry);
/**
* @function fibEntry_GetPrefix
* @abstract Returns a copy of the prefix.
* @return A reference counted copy that you must destroy
*/
Name *fibEntry_GetPrefix(const FibEntry *fibEntry);
#ifdef WITH_MAPME
/**
* @function fibEntry_AddNexthopByConnectionId
* @abstract Adds a next hop directly from the connection id.
* @param [in] fibEntry - Pointer to the FIB entry.
* @return The sequence number stored in the FIB entry.
*/
void fibEntry_AddNexthopByConnectionId(FibEntry *fibEntry,
unsigned connectionId);
/**
* @function fibEntry_getUserData
* @abstract Returns user data associated to the FIB entry.
* @param [in] fibEntry - Pointer to the FIB entry.
* @return User data as a void pointer
*/
void *fibEntry_getUserData(const FibEntry *fibEntry);
/**
* @function fibEntry_getUserData
* @abstract Associates user data and release callback to a FIB entry.
* @param [in] fibEntry - Pointer to the FIB entry.
* @param [in] userData - Generic pointer to user data
* @param [in@ userDataRelease - Callback used to release user data upon change
* of FIB entry removal.
*/
void fibEntry_setUserData(FibEntry *fibEntry, const void *userData,
void (*userDataRelease)(void **));
#endif /* WITH_MAPME */
#endif // fibEntry_h
|
