Outline ![]()
Files ![]()
loading...
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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
/**************************************************************************/
/* */
/* Copyright (c) Microsoft Corporation. All rights reserved. */
/* */
/* This software is licensed under the Microsoft Software License */
/* Terms for Microsoft Azure RTOS. Full text of the license can be */
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
/* and in the root directory of this software. */
/* */
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** NetX Component */
/** */
/** Internet Protocol (IP) */
/** */
/**************************************************************************/
/**************************************************************************/
#define NX_SOURCE_CODE
/* Include necessary system files. */
#include "nx_api.h"
#include "nx_ip.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_ip_static_route_add PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function adds a static routing entry to the routing table. */
/* */
/* INPUT */
/* */
/* ip_ptr Pointer to IP instance */
/* network_address Network address, in host byte */
/* order. */
/* net_mask Network Mask, in host byte */
/* order. */
/* next_hop Next Hop address, in host */
/* byte order. */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* tx_mutex_get Obtain a protection mutex */
/* tx_mutex_put Release protection mutex */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/* NOTE: */
/* */
/* next hop address must be on the local network. */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_ip_static_route_add(NX_IP *ip_ptr, ULONG network_address,
ULONG net_mask, ULONG next_hop)
{
#if !defined(NX_DISABLE_IPV4) && defined(NX_ENABLE_IP_STATIC_ROUTING)
INT i;
NX_INTERFACE *nx_ip_interface = NX_NULL;
/* If trace is enabled, insert this event into the trace buffer. */
NX_TRACE_IN_LINE_INSERT(NX_TRACE_IP_STATIC_ROUTE_ADD, ip_ptr, network_address, net_mask, next_hop, NX_TRACE_IP_EVENTS, 0, 0);
/* Obtain the IP mutex so we can manipulate the internal routing table. */
/* This routine does not need to be protected by mask off interrupt
because it cannot be invoked from ISR. */
tx_mutex_get(&(ip_ptr -> nx_ip_protection), TX_WAIT_FOREVER);
/* Make sure next hop is on one of the interfaces. */
for (i = 0; i < NX_MAX_IP_INTERFACES; i++)
{
if (ip_ptr -> nx_ip_interface[i].nx_interface_valid &&
((next_hop & (ip_ptr -> nx_ip_interface[i].nx_interface_ip_network_mask)) == ip_ptr -> nx_ip_interface[i].nx_interface_ip_network))
{
nx_ip_interface = &(ip_ptr -> nx_ip_interface[i]);
/* Break out of the for loop */
break;
}
}
/* If no matching interface, return the error status. */
if (nx_ip_interface == NX_NULL)
{
/* Unlock the mutex, and return the error status. */
tx_mutex_put(&(ip_ptr -> nx_ip_protection));
return(NX_IP_ADDRESS_ERROR);
}
/* Obtain the network address, based on net_mask passed in. */
network_address = network_address & net_mask;
/* Search through the routing table, check whether the same entry exists. */
for (i = 0; i < (INT)ip_ptr -> nx_ip_routing_table_entry_count; i++)
{
if (ip_ptr -> nx_ip_routing_table[i].nx_ip_routing_dest_ip == network_address &&
ip_ptr -> nx_ip_routing_table[i].nx_ip_routing_net_mask == net_mask)
{
/* Found the same entry: only need to update the next hop field */
ip_ptr -> nx_ip_routing_table[i].nx_ip_routing_next_hop_address = next_hop;
/* All done. Unlock the mutex, and return */
tx_mutex_put(&(ip_ptr -> nx_ip_protection));
return(NX_SUCCESS);
}
/* The net mask that has more top bits set has a greater numerical value than the
one with less top bits set. During a search we want to match smaller nets
(more top bits set, or larger numerical value) before matching larger nets. */
if (ip_ptr -> nx_ip_routing_table[i].nx_ip_routing_net_mask <= net_mask)
{
INT j;
/* Check whether the table is full. */
if (ip_ptr -> nx_ip_routing_table_entry_count == NX_IP_ROUTING_TABLE_SIZE)
{
tx_mutex_put(&(ip_ptr -> nx_ip_protection));
return(NX_OVERFLOW);
}
/* The entry pointed to by "i" is a larger network (thus smaller net mask
value. The new entry needs to be inserted before "i".
To do so, we need to make room for the new entry, by shifting entries i and
after one slot. */
for (j = (INT)ip_ptr -> nx_ip_routing_table_entry_count - 1; j >= i; j--)
{
ip_ptr -> nx_ip_routing_table[j + 1].nx_ip_routing_dest_ip =
ip_ptr -> nx_ip_routing_table[j].nx_ip_routing_dest_ip;
ip_ptr -> nx_ip_routing_table[j + 1].nx_ip_routing_net_mask =
ip_ptr -> nx_ip_routing_table[j].nx_ip_routing_net_mask;
ip_ptr -> nx_ip_routing_table[j + 1].nx_ip_routing_next_hop_address =
ip_ptr -> nx_ip_routing_table[j].nx_ip_routing_next_hop_address;
ip_ptr -> nx_ip_routing_table[j + 1].nx_ip_routing_entry_ip_interface =
ip_ptr -> nx_ip_routing_table[j].nx_ip_routing_entry_ip_interface;
}
break;
}
}
/* Check whether the table is full. */
if (i == NX_IP_ROUTING_TABLE_SIZE)
{
tx_mutex_put(&(ip_ptr -> nx_ip_protection));
return(NX_OVERFLOW);
}
ip_ptr -> nx_ip_routing_table[i].nx_ip_routing_dest_ip = network_address;
ip_ptr -> nx_ip_routing_table[i].nx_ip_routing_net_mask = net_mask;
ip_ptr -> nx_ip_routing_table[i].nx_ip_routing_next_hop_address = next_hop;
ip_ptr -> nx_ip_routing_table[i].nx_ip_routing_entry_ip_interface = nx_ip_interface;
ip_ptr -> nx_ip_routing_table_entry_count++;
/* Unlock the mutex. */
tx_mutex_put(&(ip_ptr -> nx_ip_protection));
/* Return success to the caller. */
return(NX_SUCCESS);
#else /* !NX_DISABLE_IPV4 && NX_ENABLE_IP_STATIC_ROUTING */
NX_PARAMETER_NOT_USED(ip_ptr);
NX_PARAMETER_NOT_USED(network_address);
NX_PARAMETER_NOT_USED(net_mask);
NX_PARAMETER_NOT_USED(next_hop);
return(NX_NOT_SUPPORTED);
#endif /* !NX_DISABLE_IPV4 && NX_ENABLE_IP_STATIC_ROUTING */
}
Details ![]()
Show: from Types: Columns: ![]( "Show Project Names")
![]( "Show Locations")
![]( "Show Referring Symbols")
![]( "Show Scope")
This file uses the notable symbols shown below. Click anywhere in the file to view more details.