A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
neighbor-cache-example.cc
Go to the documentation of this file.
1/*
2 * Copyright (c) 2022 ZHIHENG DONG
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation;
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 *
17 * Author: Zhiheng Dong <dzh2077@gmail.com>
18 */
19
20/**
21 * This example shows how to generate neighbor caches on the scope of
22 * a channel, a NetDeviceContainer, an InterfaceContainer and globally.
23 * The example also shows a scenario that auto-generated neighbor caches
24 * can avoid dropping packets because of ARP message or Neighbor Discover
25 * message.
26 * If the user runs the example without any command line option, NeighborCacheHelper
27 * will generate neighbor cache for all devices and the output is their
28 * ARP table or NDISC table, the user can also generate neighbor cache on different
29 * scope by adding command line option --useChannel (on specific channel),
30 * --useNetDeviceContainer (on specific netDeviceContainer) and --useInterfaceContainer
31 * (on specific netDeviceContainer), --noGenerate (don't generate neighbor cache).
32 * The user can also enable --sendTraffic flag to send a data stream from n0 to n1,
33 * the output will be the information of received packets, which shows the packets loss
34 * are reduced after pre-generate neighbor caches.
35 *
36 * IPv4 Network Topology
37 * \verbatim
38
39 LAN 10.1.1.0/24
40 n0 --------------- n1 n2 n3
41 | | |
42 ===============
43 LAN 10.1.2.0/24
44 \endverbatim
45 *
46 *IPv6 Network Topology
47 * \verbatim
48
49 LAN 2001:1::/64
50 n0 --------------- n1 n2 n3
51 | | |
52 ===============
53 LAN 2001:2::/64
54 \endverbatim
55 *
56 * Expected Outputs:
57 * IPv4 (default):
58 * Generate ARP caches for all deveices (default) :
59 * \verbatim
60 ARP Cache of node 0 at time 0
61 10.1.1.2 dev 0 lladdr 02-06-00:00:00:00:00:02 STATIC_AUTOGENERATED
62 ARP Cache of node 1 at time 0
63 10.1.1.1 dev 0 lladdr 02-06-00:00:00:00:00:01 STATIC_AUTOGENERATED
64 10.1.2.2 dev 1 lladdr 02-06-00:00:00:00:00:04 STATIC_AUTOGENERATED
65 10.1.2.3 dev 1 lladdr 02-06-00:00:00:00:00:05 STATIC_AUTOGENERATED
66 ARP Cache of node 2 at time 0
67 10.1.2.1 dev 0 lladdr 02-06-00:00:00:00:00:03 STATIC_AUTOGENERATED
68 10.1.2.3 dev 0 lladdr 02-06-00:00:00:00:00:05 STATIC_AUTOGENERATED
69 ARP Cache of node 3 at time 0
70 10.1.2.1 dev 0 lladdr 02-06-00:00:00:00:00:03 STATIC_AUTOGENERATED
71 10.1.2.2 dev 0 lladdr 02-06-00:00:00:00:00:04 STATIC_AUTOGENERATED
72 \endverbatim
73 *
74 * Generate ARP caches for the left channel (--useChannel):
75 * \verbatim
76 ARP Cache of node 0 at time 0
77 10.1.1.2 dev 0 lladdr 02-06-00:00:00:00:00:02 STATIC_AUTOGENERATED
78 ARP Cache of node 1 at time 0
79 10.1.1.1 dev 0 lladdr 02-06-00:00:00:00:00:01 STATIC_AUTOGENERATED
80 ARP Cache of node 2 at time 0
81 ARP Cache of node 3 at time 0
82 \endverbatim
83 *
84 * Generate ARP caches for devices on the right side (--useNetDeviceContainer):
85 * \verbatim
86 ARP Cache of node 0 at time 0
87 ARP Cache of node 1 at time 0
88 10.1.2.2 dev 1 lladdr 02-06-00:00:00:00:00:04 STATIC_AUTOGENERATED
89 10.1.2.3 dev 1 lladdr 02-06-00:00:00:00:00:05 STATIC_AUTOGENERATED
90 ARP Cache of node 2 at time 0
91 10.1.2.1 dev 0 lladdr 02-06-00:00:00:00:00:03 STATIC_AUTOGENERATED
92 10.1.2.3 dev 0 lladdr 02-06-00:00:00:00:00:05 STATIC_AUTOGENERATED
93 ARP Cache of node 3 at time 0
94 10.1.2.1 dev 0 lladdr 02-06-00:00:00:00:00:03 STATIC_AUTOGENERATED
95 10.1.2.2 dev 0 lladdr 02-06-00:00:00:00:00:04 STATIC_AUTOGENERATED
96 \endverbatim
97 *
98 * Generate ARP caches for specific interfaces (--useInterfaceContainer):
99 * \verbatim
100 ARP Cache of node 0 at time 0
101 10.1.1.2 dev 0 lladdr 02-06-00:00:00:00:00:02 STATIC_AUTOGENERATED
102 ARP Cache of node 1 at time 0
103 ARP Cache of node 2 at time 0
104 ARP Cache of node 3 at time 0
105 10.1.2.1 dev 0 lladdr 02-06-00:00:00:00:00:03 STATIC_AUTOGENERATED
106 10.1.2.2 dev 0 lladdr 02-06-00:00:00:00:00:04 STATIC_AUTOGENERATED
107 \endverbatim
108 *
109 * Do not generate neighbor cache (--noGenerate):
110 * \verbatim
111 ARP Cache of node 0 at time 0
112 ARP Cache of node 1 at time 0
113 ARP Cache of node 2 at time 0
114 ARP Cache of node 3 at time 0
115 \endverbatim
116 *
117 * sending packet with pre-generated neighbor caches(--sendTraffic)
118 * \verbatim
119 Rx pkt from 03-07-0a:01:01:01:01:c0:00 to 03-07-0a:01:01:02:09:00:00 -> (size=512) AND (seq=0
120 time=+1s) Rx pkt from 03-07-0a:01:01:01:01:c0:00 to 03-07-0a:01:01:02:09:00:00 -> (size=512) AND
121 (seq=1 time=+1s) Rx pkt from 03-07-0a:01:01:01:01:c0:00 to 03-07-0a:01:01:02:09:00:00 -> (size=512)
122 AND (seq=2 time=+1s) Rx pkt from 03-07-0a:01:01:01:01:c0:00 to 03-07-0a:01:01:02:09:00:00 ->
123 (size=512) AND (seq=3 time=+1s) Rx pkt from 03-07-0a:01:01:01:01:c0:00 to
124 03-07-0a:01:01:02:09:00:00 -> (size=512) AND (seq=4 time=+1s) Rx pkt from
125 03-07-0a:01:01:01:01:c0:00 to 03-07-0a:01:01:02:09:00:00 -> (size=512) AND (seq=5 time=+1s) Rx pkt
126 from 03-07-0a:01:01:01:01:c0:00 to 03-07-0a:01:01:02:09:00:00 -> (size=512) AND (seq=6 time=+1s) Rx
127 pkt from 03-07-0a:01:01:01:01:c0:00 to 03-07-0a:01:01:02:09:00:00 -> (size=512) AND (seq=7
128 time=+1s) Rx pkt from 03-07-0a:01:01:01:01:c0:00 to 03-07-0a:01:01:02:09:00:00 -> (size=512) AND
129 (seq=8 time=+1s) Rx pkt from 03-07-0a:01:01:01:01:c0:00 to 03-07-0a:01:01:02:09:00:00 -> (size=512)
130 AND (seq=9 time=+1s) Rx pkt from 03-07-0a:01:01:01:01:c0:00 to 03-07-0a:01:01:02:09:00:00 ->
131 (size=512) AND (seq=10 time=+1s) Rx pkt from 03-07-0a:01:01:01:01:c0:00 to
132 03-07-0a:01:01:02:09:00:00 -> (size=512) AND (seq=11 time=+1s) Rx pkt from
133 03-07-0a:01:01:01:01:c0:00 to 03-07-0a:01:01:02:09:00:00 -> (size=512) AND (seq=12 time=+1.00001s)
134 \endverbatim
135 *
136 * sending packet without pre-generated neighbor caches(--sendTraffic --noGenerate)
137 * \verbatim
138 Rx pkt from 03-07-0a:01:01:01:01:c0:00 to 03-07-0a:01:01:02:09:00:00 -> (size=512) AND (seq=0
139 time=+1s) Rx pkt from 03-07-0a:01:01:01:01:c0:00 to 03-07-0a:01:01:02:09:00:00 -> (size=512) AND
140 (seq=1 time=+1s) Rx pkt from 03-07-0a:01:01:01:01:c0:00 to 03-07-0a:01:01:02:09:00:00 -> (size=512)
141 AND (seq=2 time=+1s) Rx pkt from 03-07-0a:01:01:01:01:c0:00 to 03-07-0a:01:01:02:09:00:00 ->
142 (size=512) AND (seq=8 time=+1s) Rx pkt from 03-07-0a:01:01:01:01:c0:00 to
143 03-07-0a:01:01:02:09:00:00 -> (size=512) AND (seq=9 time=+1s) Rx pkt from
144 03-07-0a:01:01:01:01:c0:00 to 03-07-0a:01:01:02:09:00:00 -> (size=512) AND (seq=10 time=+1s) Rx pkt
145 from 03-07-0a:01:01:01:01:c0:00 to 03-07-0a:01:01:02:09:00:00 -> (size=512) AND (seq=11 time=+1s)
146 Rx pkt from 03-07-0a:01:01:01:01:c0:00 to 03-07-0a:01:01:02:09:00:00 -> (size=512) AND (seq=12
147 time=+1.00001s) Rx pkt from 03-07-0a:01:01:01:01:c0:00 to 03-07-0a:01:01:02:09:00:00 -> (size=512)
148 AND (seq=13 time=+1.00001s) Rx pkt from 03-07-0a:01:01:01:01:c0:00 to 03-07-0a:01:01:02:09:00:00 ->
149 (size=512) AND (seq=14 time=+1.00001s) \endverbatim
150 *
151 * IPv6 (--useIPv6):
152 * Generate NDISC caches for all deveices (default) :
153 * \verbatim
154 NDISC Cache of node 0 at time +0s
155 2001:1::200:ff:fe00:2 dev 0 lladdr 02-06-00:00:00:00:00:02 STATIC_AUTOGENERATED
156 fe80::200:ff:fe00:2 dev 0 lladdr 02-06-00:00:00:00:00:02 STATIC_AUTOGENERATED
157 NDISC Cache of node 1 at time +0s
158 2001:1::200:ff:fe00:1 dev 0 lladdr 02-06-00:00:00:00:00:01 STATIC_AUTOGENERATED
159 fe80::200:ff:fe00:1 dev 0 lladdr 02-06-00:00:00:00:00:01 STATIC_AUTOGENERATED
160 2001:2::200:ff:fe00:4 dev 1 lladdr 02-06-00:00:00:00:00:04 STATIC_AUTOGENERATED
161 2001:2::200:ff:fe00:5 dev 1 lladdr 02-06-00:00:00:00:00:05 STATIC_AUTOGENERATED
162 fe80::200:ff:fe00:4 dev 1 lladdr 02-06-00:00:00:00:00:04 STATIC_AUTOGENERATED
163 fe80::200:ff:fe00:5 dev 1 lladdr 02-06-00:00:00:00:00:05 STATIC_AUTOGENERATED
164 NDISC Cache of node 2 at time +0s
165 2001:2::200:ff:fe00:3 dev 0 lladdr 02-06-00:00:00:00:00:03 STATIC_AUTOGENERATED
166 2001:2::200:ff:fe00:5 dev 0 lladdr 02-06-00:00:00:00:00:05 STATIC_AUTOGENERATED
167 fe80::200:ff:fe00:3 dev 0 lladdr 02-06-00:00:00:00:00:03 STATIC_AUTOGENERATED
168 fe80::200:ff:fe00:5 dev 0 lladdr 02-06-00:00:00:00:00:05 STATIC_AUTOGENERATED
169 NDISC Cache of node 3 at time +0s
170 2001:2::200:ff:fe00:3 dev 0 lladdr 02-06-00:00:00:00:00:03 STATIC_AUTOGENERATED
171 2001:2::200:ff:fe00:4 dev 0 lladdr 02-06-00:00:00:00:00:04 STATIC_AUTOGENERATED
172 fe80::200:ff:fe00:3 dev 0 lladdr 02-06-00:00:00:00:00:03 STATIC_AUTOGENERATED
173 fe80::200:ff:fe00:4 dev 0 lladdr 02-06-00:00:00:00:00:04 STATIC_AUTOGENERATED
174 \endverbatim
175 *
176 * Generate NDISC caches for the left channel (--useChannel):
177 * \verbatim
178 NDISC Cache of node 0 at time +0s
179 2001:1::200:ff:fe00:2 dev 0 lladdr 02-06-00:00:00:00:00:02 STATIC_AUTOGENERATED
180 fe80::200:ff:fe00:2 dev 0 lladdr 02-06-00:00:00:00:00:02 STATIC_AUTOGENERATED
181 NDISC Cache of node 1 at time +0s
182 2001:1::200:ff:fe00:1 dev 0 lladdr 02-06-00:00:00:00:00:01 STATIC_AUTOGENERATED
183 fe80::200:ff:fe00:1 dev 0 lladdr 02-06-00:00:00:00:00:01 STATIC_AUTOGENERATED
184 NDISC Cache of node 2 at time +0s
185 NDISC Cache of node 3 at time +0s
186 \endverbatim
187 *
188 * Generate NDISC caches for devices on the right side (--useNetDeviceContainer):
189 * \verbatim
190 NDISC Cache of node 0 at time +0s
191 NDISC Cache of node 1 at time +0s
192 2001:2::200:ff:fe00:4 dev 1 lladdr 02-06-00:00:00:00:00:04 STATIC_AUTOGENERATED
193 2001:2::200:ff:fe00:5 dev 1 lladdr 02-06-00:00:00:00:00:05 STATIC_AUTOGENERATED
194 fe80::200:ff:fe00:4 dev 1 lladdr 02-06-00:00:00:00:00:04 STATIC_AUTOGENERATED
195 fe80::200:ff:fe00:5 dev 1 lladdr 02-06-00:00:00:00:00:05 STATIC_AUTOGENERATED
196 NDISC Cache of node 2 at time +0s
197 2001:2::200:ff:fe00:3 dev 0 lladdr 02-06-00:00:00:00:00:03 STATIC_AUTOGENERATED
198 2001:2::200:ff:fe00:5 dev 0 lladdr 02-06-00:00:00:00:00:05 STATIC_AUTOGENERATED
199 fe80::200:ff:fe00:3 dev 0 lladdr 02-06-00:00:00:00:00:03 STATIC_AUTOGENERATED
200 fe80::200:ff:fe00:5 dev 0 lladdr 02-06-00:00:00:00:00:05 STATIC_AUTOGENERATED
201 NDISC Cache of node 3 at time +0s
202 2001:2::200:ff:fe00:3 dev 0 lladdr 02-06-00:00:00:00:00:03 STATIC_AUTOGENERATED
203 2001:2::200:ff:fe00:4 dev 0 lladdr 02-06-00:00:00:00:00:04 STATIC_AUTOGENERATED
204 fe80::200:ff:fe00:3 dev 0 lladdr 02-06-00:00:00:00:00:03 STATIC_AUTOGENERATED
205 fe80::200:ff:fe00:4 dev 0 lladdr 02-06-00:00:00:00:00:04 STATIC_AUTOGENERATED
206 \endverbatim
207 *
208 * Generate NDISC caches for specific interfaces (--useInterfaceContainer):
209 * \verbatim
210 NDISC Cache of node 0 at time +0s
211 2001:1::200:ff:fe00:2 dev 0 lladdr 02-06-00:00:00:00:00:02 STATIC_AUTOGENERATED
212 fe80::200:ff:fe00:2 dev 0 lladdr 02-06-00:00:00:00:00:02 STATIC_AUTOGENERATED
213 NDISC Cache of node 1 at time +0s
214 NDISC Cache of node 2 at time +0s
215 NDISC Cache of node 3 at time +0s
216 2001:2::200:ff:fe00:3 dev 0 lladdr 02-06-00:00:00:00:00:03 STATIC_AUTOGENERATED
217 2001:2::200:ff:fe00:4 dev 0 lladdr 02-06-00:00:00:00:00:04 STATIC_AUTOGENERATED
218 fe80::200:ff:fe00:3 dev 0 lladdr 02-06-00:00:00:00:00:03 STATIC_AUTOGENERATED
219 fe80::200:ff:fe00:4 dev 0 lladdr 02-06-00:00:00:00:00:04 STATIC_AUTOGENERATED
220 \endverbatim
221 *
222 * Do not generate neighbor cache (--noGenerate):
223 * \verbatim
224 NDISC Cache of node 0 at time +0s
225 NDISC Cache of node 1 at time +0s
226 NDISC Cache of node 2 at time +0s
227 NDISC Cache of node 3 at time +0s
228 \endverbatim
229 *
230 * sending packet with pre-generated neighbor caches(--sendTraffic)
231 * \verbatim
232 Rx pkt from 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:01:01:c0 to
233 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:02:09:00 -> (size=512) AND (seq=0 time=+1s) Rx
234 pkt from 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:01:01:c0 to
235 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:02:09:00 -> (size=512) AND (seq=1 time=+1s) Rx
236 pkt from 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:01:01:c0 to
237 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:02:09:00 -> (size=512) AND (seq=2 time=+1s) Rx
238 pkt from 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:01:01:c0 to
239 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:02:09:00 -> (size=512) AND (seq=3 time=+1s) Rx
240 pkt from 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:01:01:c0 to
241 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:02:09:00 -> (size=512) AND (seq=4 time=+1s) Rx
242 pkt from 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:01:01:c0 to
243 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:02:09:00 -> (size=512) AND (seq=5 time=+1s) Rx
244 pkt from 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:01:01:c0 to
245 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:02:09:00 -> (size=512) AND (seq=6 time=+1s) Rx
246 pkt from 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:01:01:c0 to
247 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:02:09:00 -> (size=512) AND (seq=7 time=+1s) Rx
248 pkt from 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:01:01:c0 to
249 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:02:09:00 -> (size=512) AND (seq=8 time=+1s) Rx
250 pkt from 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:01:01:c0 to
251 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:02:09:00 -> (size=512) AND (seq=9 time=+1s) Rx
252 pkt from 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:01:01:c0 to
253 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:02:09:00 -> (size=512) AND (seq=10 time=+1s) Rx
254 pkt from 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:01:01:c0 to
255 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:02:09:00 -> (size=512) AND (seq=11 time=+1s)
256 \endverbatim
257 *
258 * sending packet without pre-generated neighbor caches(--sendTraffic --noGenerate)
259 * \verbatim
260 Rx pkt from 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:01:01:c0 to
261 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:02:09:00 -> (size=512) AND (seq=8 time=+1s) Rx
262 pkt from 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:01:01:c0 to
263 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:02:09:00 -> (size=512) AND (seq=9 time=+1s) Rx
264 pkt from 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:01:01:c0 to
265 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:02:09:00 -> (size=512) AND (seq=10 time=+1s) Rx
266 pkt from 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:01:01:c0 to
267 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:02:09:00 -> (size=512) AND (seq=11 time=+1s) Rx
268 pkt from 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:01:01:c0 to
269 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:02:09:00 -> (size=512) AND (seq=12
270 time=+1.00001s) Rx pkt from 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:01:01:c0 to
271 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:02:09:00 -> (size=512) AND (seq=13
272 time=+1.00001s) Rx pkt from 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:01:01:c0 to
273 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:02:09:00 -> (size=512) AND (seq=14
274 time=+1.00001s) Rx pkt from 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:01:01:c0 to
275 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:02:09:00 -> (size=512) AND (seq=15
276 time=+1.00001s) Rx pkt from 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:01:01:c0 to
277 04-12-20:01:00:01:00:00:00:00:02:00:00:ff:fe:00:00:02:09:00 -> (size=512) AND (seq=16
278 time=+1.00001s) \endverbatim
279*/
280
281#include "ns3/applications-module.h"
282#include "ns3/core-module.h"
283#include "ns3/csma-module.h"
284#include "ns3/internet-module.h"
285#include "ns3/network-module.h"
286
287using namespace ns3;
288
289NS_LOG_COMPONENT_DEFINE("NeighborCacheExample");
290
291/**
292 * neighbor Cache example class.
293 *
294 * It handles the creation and run of an example.
295 */
296class NeighborCacheExample
297{
298 public:
299 NeighborCacheExample();
300
301 /**
302 * Run the example.
303 */
304 void Run();
305
306 /**
307 * \brief description the command-line parameters.
308 * \param argc The argument count.
309 * \param argv The argument vector.
310 */
311 void CommandSetup(int argc, char** argv);
312
313 private:
314 /**
315 * \brief Print the information of receive data.
316 * \param pkt The received packet.
317 * \param from The sender.
318 * \param dst The receiver.
319 * \param header The header with a sequence, a timestamp, and a "size" attribute
320 */
321 void ReceivePacket(Ptr<const Packet> pkt,
322 const Address& from,
323 const Address& dst,
324 const SeqTsSizeHeader& header);
325
326 bool m_useIpv6{false}; //!< Use IPv6 instead of IPv4
327 bool m_enableLog{false}; //!< Enable ArpL3Protocol and Icmpv6L4Protocol logging
328 bool m_useChannel{false}; //!< Generate neighbor cache for specific Channel
329 bool m_useNetDeviceContainer{
330 false}; //!< Generate neighbor cache for specific netDeviceContainer
331 bool m_useInterfaceContainer{
332 false}; //!< Generate neighbor cache for specific interfaceContainer
333 bool m_noGenerate{false}; //!< do not generate neighbor cache automatically
334 bool m_sendTraffic{false}; //!< send data stream from n0 to n1
335};
336
337NeighborCacheExample::NeighborCacheExample()
338{
339 NS_LOG_FUNCTION(this);
340}
341
342void
343NeighborCacheExample::ReceivePacket(Ptr<const Packet> pkt,
344 const Address& from,
345 const Address& dst,
346 const SeqTsSizeHeader& header)
347{
348 std::cout << "Rx pkt from " << from << " to " << dst << " -> " << header << std::endl;
349}
350
351void
352NeighborCacheExample::CommandSetup(int argc, char** argv)
353{
354 CommandLine cmd(__FILE__);
355 cmd.AddValue("useIPv6", "Use IPv6 instead of IPv4", m_useIpv6);
356 cmd.AddValue("enableLog", "Enable ArpL3Protocol and Icmpv6L4Protocol logging", m_enableLog);
357 cmd.AddValue("useChannel", "Generate neighbor cache for specific Channel", m_useChannel);
358 cmd.AddValue("useNetDeviceContainer",
359 "Generate neighbor cache for specific netDeviceContainer",
360 m_useNetDeviceContainer);
361 cmd.AddValue("useInterfaceContainer",
362 "Generate neighbor cache for specific interfaceContainer",
363 m_useInterfaceContainer);
364 cmd.AddValue("noGenerate", "do not generate neighbor cache automatically", m_noGenerate);
365 cmd.AddValue("sendTraffic", "send data stream from n0 to n1", m_sendTraffic);
366
367 cmd.Parse(argc, argv);
368}
369
370int
371main(int argc, char* argv[])
372{
373 NeighborCacheExample example;
374 example.CommandSetup(argc, argv);
375 example.Run();
376 return 0;
377}
378
379void
380NeighborCacheExample::Run()
381{
382 if (m_enableLog)
383 {
384 LogComponentEnable("ArpL3Protocol", LOG_LEVEL_LOGIC);
385 LogComponentEnable("Icmpv6L4Protocol", LOG_LEVEL_LOGIC);
386 }
387 uint32_t nCsmaLeft = 2;
388 uint32_t nCsmaRight = 2;
389
390 NodeContainer csmaNodesLeft;
391 csmaNodesLeft.Create(nCsmaLeft);
392 NodeContainer csmaNodesRight;
393 csmaNodesRight.Add(csmaNodesLeft.Get(1));
394 csmaNodesRight.Create(nCsmaRight);
395
396 CsmaHelper csmaLeft;
397 csmaLeft.SetChannelAttribute("DataRate", StringValue("20Gbps"));
398 // The 1 microSeconds delay is only for showing packets dropped effect without generating
399 // neighbor caches.
400 csmaLeft.SetChannelAttribute("Delay", TimeValue(MicroSeconds(1)));
401 CsmaHelper csmaRight;
402 csmaRight.SetChannelAttribute("DataRate", StringValue("20Gbps"));
403 csmaRight.SetChannelAttribute("Delay", TimeValue(MicroSeconds(1)));
404
405 NetDeviceContainer csmaDevicesLeft;
406 csmaDevicesLeft = csmaLeft.Install(csmaNodesLeft);
407 NetDeviceContainer csmaDevicesRight;
408 csmaDevicesRight = csmaRight.Install(csmaNodesRight);
409
410 InternetStackHelper stack;
411 if (!m_useIpv6)
412 {
413 stack.SetIpv6StackInstall(false);
414 }
415 else
416 {
417 stack.SetIpv4StackInstall(false);
418 }
419 // disabled Ipv4ArpJitter and Ipv6NsRsJitter to avoid the influence on packet dropped
420 stack.SetIpv4ArpJitter(false);
421 stack.SetIpv6NsRsJitter(false);
422 stack.Install(csmaNodesLeft.Get(0));
423 stack.Install(csmaNodesRight);
424
425 if (!m_useIpv6)
426 {
427 Ipv4AddressHelper address;
428 address.SetBase("10.1.1.0", "255.255.255.0");
429 Ipv4InterfaceContainer csmaInterfacesLeft;
430 csmaInterfacesLeft = address.Assign(csmaDevicesLeft);
431 address.SetBase("10.1.2.0", "255.255.255.0");
432 Ipv4InterfaceContainer csmaInterfacesRight;
433 csmaInterfacesRight = address.Assign(csmaDevicesRight);
434
435 // Populate ARP caches
436 NeighborCacheHelper neighborCache;
437 if (m_useChannel)
438 {
439 // Populate ARP caches for given channel
440 Ptr<Channel> csmaChannel = csmaDevicesLeft.Get(0)->GetChannel();
441 neighborCache.PopulateNeighborCache(csmaChannel);
442 }
443 else if (m_useNetDeviceContainer)
444 {
445 // Populate ARP caches for given netDeviceContainer
446 neighborCache.PopulateNeighborCache(csmaDevicesRight);
447 }
448 else if (m_useInterfaceContainer)
449 {
450 std::pair<Ptr<Ipv4>, uint32_t> txInterface = csmaInterfacesLeft.Get(0);
451 Ptr<Ipv4> ipv41 = txInterface.first;
452 uint32_t index1 = txInterface.second;
453 std::pair<Ptr<Ipv4>, uint32_t> rxInterface = csmaInterfacesRight.Get(nCsmaRight);
454 Ptr<Ipv4> ipv42 = rxInterface.first;
455 uint32_t index2 = rxInterface.second;
456
457 // Populate ARP caches for given interfaceContainer
458 Ipv4InterfaceContainer interfaces;
459 interfaces.Add(ipv41, index1);
460 interfaces.Add(ipv42, index2);
461 neighborCache.PopulateNeighborCache(interfaces);
462 }
463 else if (!m_noGenerate)
464 {
465 // Populate ARP caches for all devices
466 neighborCache.PopulateNeighborCache();
467 }
468
469 if (m_sendTraffic)
470 {
471 // send Packet from n0 to n1
472 uint16_t port = 9; // Discard port (RFC 863)
473 OnOffHelper onoff("ns3::UdpSocketFactory",
474 Address(InetSocketAddress(csmaInterfacesLeft.GetAddress(1), port)));
475 onoff.SetConstantRate(DataRate("10Gbps"));
476 onoff.SetAttribute("EnableSeqTsSizeHeader", BooleanValue(true));
477 ApplicationContainer apps = onoff.Install(csmaNodesLeft.Get(0));
478 apps.Start(Seconds(1.0));
479
480 // Create a packet sink to receive these packets
481 PacketSinkHelper sink("ns3::UdpSocketFactory",
482 Address(InetSocketAddress(Ipv4Address::GetAny(), port)));
483 sink.SetAttribute("EnableSeqTsSizeHeader", BooleanValue(true));
484 apps = sink.Install(csmaNodesLeft);
485 apps.Get(1)->TraceConnectWithoutContext(
486 "RxWithSeqTsSize",
487 MakeCallback(&NeighborCacheExample::ReceivePacket, this));
488 AsciiTraceHelper ascii;
489 Ptr<OutputStreamWrapper> stream = ascii.CreateFileStream("neighbor-cache-example.tr");
490 csmaLeft.EnableAsciiAll(stream);
491 csmaLeft.EnablePcapAll("neighbor-cache-example");
492 }
493 else
494 {
495 Ptr<OutputStreamWrapper> outputStream = Create<OutputStreamWrapper>(&std::cout);
496 Ipv4RoutingHelper::PrintNeighborCacheAllAt(Seconds(0), outputStream);
497 }
498 }
499 else
500 {
501 Ipv6AddressHelper address;
502 address.SetBase(Ipv6Address("2001:1::"), Ipv6Prefix(64));
503 Ipv6InterfaceContainer csmaInterfacesLeft;
504 csmaInterfacesLeft = address.Assign(csmaDevicesLeft);
505 csmaInterfacesLeft.SetForwarding(1, true);
506 csmaInterfacesLeft.SetDefaultRouteInAllNodes(1);
507
508 address.SetBase(Ipv6Address("2001:2::"), Ipv6Prefix(64));
509 Ipv6InterfaceContainer csmaInterfacesRight;
510 csmaInterfacesRight = address.Assign(csmaDevicesRight);
511 csmaInterfacesRight.SetForwarding(0, true);
512 csmaInterfacesRight.SetDefaultRouteInAllNodes(0);
513
514 // Populate neighbor NDISC caches
515 NeighborCacheHelper neighborCache;
516 if (m_useChannel)
517 {
518 // Populate NDISC caches for given channel
519 Ptr<Channel> csmaChannel = csmaDevicesLeft.Get(0)->GetChannel();
520 neighborCache.PopulateNeighborCache(csmaChannel);
521 }
522 else if (m_useNetDeviceContainer)
523 {
524 // Populate NDISC caches for given netDeviceContainer
525 neighborCache.PopulateNeighborCache(csmaDevicesRight);
526 }
527 else if (m_useInterfaceContainer)
528 {
529 std::pair<Ptr<Ipv6>, uint32_t> txInterface = csmaInterfacesLeft.Get(0);
530 Ptr<Ipv6> ipv61 = txInterface.first;
531 uint32_t index1 = txInterface.second;
532 std::pair<Ptr<Ipv6>, uint32_t> rxInterface = csmaInterfacesRight.Get(nCsmaRight);
533 Ptr<Ipv6> ipv62 = rxInterface.first;
534 uint32_t index2 = rxInterface.second;
535
536 // Populate NDISC caches for given interfaceContainer
537 Ipv6InterfaceContainer interfaces;
538 interfaces.Add(ipv61, index1);
539 interfaces.Add(ipv62, index2);
540 neighborCache.PopulateNeighborCache(interfaces);
541 }
542 else if (!m_noGenerate)
543 {
544 // Populate NDISC caches for all devices
545 neighborCache.PopulateNeighborCache();
546 }
547
548 if (m_sendTraffic)
549 {
550 // send Packet from n0 to n1
551 uint16_t port = 9; // Discard port (RFC 863)
552 OnOffHelper onoff(
553 "ns3::UdpSocketFactory",
554 Address(Inet6SocketAddress(csmaInterfacesLeft.GetAddress(1, 1), port)));
555 onoff.SetConstantRate(DataRate("10Gbps"));
556 onoff.SetAttribute("EnableSeqTsSizeHeader", BooleanValue(true));
557 ApplicationContainer apps = onoff.Install(csmaNodesLeft.Get(0));
558 apps.Start(Seconds(1.0));
559
560 // Create a packet sink to receive these packets
561 PacketSinkHelper sink("ns3::UdpSocketFactory",
562 Address(Inet6SocketAddress(Ipv6Address::GetAny(), port)));
563 sink.SetAttribute("EnableSeqTsSizeHeader", BooleanValue(true));
564 apps = sink.Install(csmaNodesLeft);
565 apps.Get(1)->TraceConnectWithoutContext(
566 "RxWithSeqTsSize",
567 MakeCallback(&NeighborCacheExample::ReceivePacket, this));
568 AsciiTraceHelper ascii;
569 Ptr<OutputStreamWrapper> stream = ascii.CreateFileStream("neighbor-cache-example.tr");
570 csmaLeft.EnableAsciiAll(stream);
571 csmaLeft.EnablePcapAll("neighbor-cache-example");
572 }
573 else
574 {
575 Ptr<OutputStreamWrapper> outputStream = Create<OutputStreamWrapper>(&std::cout);
576 Ipv6RoutingHelper::PrintNeighborCacheAllAt(Seconds(0), outputStream);
577 }
578 }
579 Simulator::Stop(Seconds(1.00002));
580 Simulator::Run();
581 Simulator::Destroy();
582}
NeighborCacheExample
neighbor Cache example class.
Definition: neighbor-cache-example.cc:297
NeighborCacheExample::CommandSetup
void CommandSetup(int argc, char **argv)
description the command-line parameters.
Definition: neighbor-cache-example.cc:352
NeighborCacheExample::m_sendTraffic
bool m_sendTraffic
send data stream from n0 to n1
Definition: neighbor-cache-example.cc:334
NeighborCacheExample::m_noGenerate
bool m_noGenerate
do not generate neighbor cache automatically
Definition: neighbor-cache-example.cc:333
NeighborCacheExample::ReceivePacket
void ReceivePacket(Ptr< const Packet > pkt, const Address &from, const Address &dst, const SeqTsSizeHeader &header)
Print the information of receive data.
Definition: neighbor-cache-example.cc:343
NeighborCacheExample::m_useNetDeviceContainer
bool m_useNetDeviceContainer
Generate neighbor cache for specific netDeviceContainer.
Definition: neighbor-cache-example.cc:329
NeighborCacheExample::m_useChannel
bool m_useChannel
Generate neighbor cache for specific Channel.
Definition: neighbor-cache-example.cc:328
NeighborCacheExample::Run
void Run()
Run the example.
Definition: neighbor-cache-example.cc:380
NeighborCacheExample::m_useIpv6
bool m_useIpv6
Use IPv6 instead of IPv4.
Definition: neighbor-cache-example.cc:326
NeighborCacheExample::m_enableLog
bool m_enableLog
Enable ArpL3Protocol and Icmpv6L4Protocol logging.
Definition: neighbor-cache-example.cc:327
NeighborCacheExample::m_useInterfaceContainer
bool m_useInterfaceContainer
Generate neighbor cache for specific interfaceContainer.
Definition: neighbor-cache-example.cc:331
ns3::Address
a polymophic address class
Definition: address.h:101
ns3::ApplicationContainer
holds a vector of ns3::Application pointers.
Definition: application-container.h:44
ns3::ApplicationContainer::Start
void Start(Time start) const
Start all of the Applications in this container at the start time given as a parameter.
Definition: application-container.cc:92
ns3::ApplicationContainer::Get
Ptr< Application > Get(uint32_t i) const
Get the Ptr<Application> stored in this container at a given index.
Definition: application-container.cc:64
ns3::AsciiTraceHelperForDevice::EnableAsciiAll
void EnableAsciiAll(std::string prefix)
Enable ascii trace output on each device (which is of the appropriate type) in the set of all nodes c...
Definition: trace-helper.cc:619
ns3::AsciiTraceHelper
Manage ASCII trace files for device models.
Definition: trace-helper.h:174
ns3::AsciiTraceHelper::CreateFileStream
Ptr< OutputStreamWrapper > CreateFileStream(std::string filename, std::ios::openmode filemode=std::ios::out)
Create and initialize an output stream object we'll use to write the traced bits.
Definition: trace-helper.cc:193
ns3::BooleanValue
AttributeValue implementation for Boolean.
Definition: boolean.h:37
ns3::CommandLine
Parse command-line arguments.
Definition: command-line.h:232
ns3::CsmaHelper
build a set of CsmaNetDevice objects
Definition: csma-helper.h:48
ns3::CsmaHelper::SetChannelAttribute
void SetChannelAttribute(std::string n1, const AttributeValue &v1)
Definition: csma-helper.cc:56
ns3::CsmaHelper::Install
NetDeviceContainer Install(Ptr< Node > node) const
This method creates an ns3::CsmaChannel with the attributes configured by CsmaHelper::SetChannelAttri...
Definition: csma-helper.cc:226
ns3::DataRate
Class for representing data rates.
Definition: data-rate.h:89
ns3::Inet6SocketAddress
An Inet6 address class.
Definition: inet6-socket-address.h:38
ns3::InetSocketAddress
an Inet address class
Definition: inet-socket-address.h:42
ns3::InternetStackHelper
aggregate IP/TCP/UDP functionality to existing Nodes.
Definition: internet-stack-helper.h:92
ns3::Ipv4AddressHelper
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
Definition: ipv4-address-helper.h:49
ns3::Ipv4Address::GetAny
static Ipv4Address GetAny()
Definition: ipv4-address.cc:378
ns3::Ipv4InterfaceContainer
holds a vector of std::pair of Ptr<Ipv4> and interface index.
Definition: ipv4-interface-container.h:56
ns3::Ipv4InterfaceContainer::Get
std::pair< Ptr< Ipv4 >, uint32_t > Get(uint32_t i) const
Get the std::pair of an Ptr<Ipv4> and interface stored at the location specified by the index.
Definition: ipv4-interface-container.cc:95
ns3::Ipv4InterfaceContainer::GetAddress
Ipv4Address GetAddress(uint32_t i, uint32_t j=0) const
Definition: ipv4-interface-container.cc:60
ns3::Ipv4RoutingHelper::PrintNeighborCacheAllAt
static void PrintNeighborCacheAllAt(Time printTime, Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S)
prints the neighbor cache of all nodes at a particular time.
Definition: ipv4-routing-helper.cc:125
ns3::Ipv6AddressHelper
Helper class to auto-assign global IPv6 unicast addresses.
Definition: ipv6-address-helper.h:84
ns3::Ipv6Address
Describes an IPv6 address.
Definition: ipv6-address.h:49
ns3::Ipv6Address::GetAny
static Ipv6Address GetAny()
Get the "any" (::) Ipv6Address.
Definition: ipv6-address.cc:733
ns3::Ipv6InterfaceContainer
Keep track of a set of IPv6 interfaces.
Definition: ipv6-interface-container.h:40
ns3::Ipv6InterfaceContainer::SetForwarding
void SetForwarding(uint32_t i, bool state)
Set the state of the stack (act as a router or as an host) for the specified index.
Definition: ipv6-interface-container.cc:97
ns3::Ipv6InterfaceContainer::SetDefaultRouteInAllNodes
void SetDefaultRouteInAllNodes(uint32_t router)
Set the default route for all the devices (except the router itself).
Definition: ipv6-interface-container.cc:104
ns3::Ipv6InterfaceContainer::GetAddress
Ipv6Address GetAddress(uint32_t i, uint32_t j) const
Get the address for the specified index.
Definition: ipv6-interface-container.cc:61
ns3::Ipv6InterfaceContainer::Get
std::pair< Ptr< Ipv6 >, uint32_t > Get(uint32_t i) const
Get the std::pair of an Ptr<Ipv6> and interface stored at the location specified by the index.
Definition: ipv6-interface-container.cc:91
ns3::Ipv6Prefix
Describes an IPv6 prefix.
Definition: ipv6-address.h:455
ns3::Ipv6RoutingHelper::PrintNeighborCacheAllAt
static void PrintNeighborCacheAllAt(Time printTime, Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S)
prints the neighbor cache of all nodes at a particular time.
Definition: ipv6-routing-helper.cc:125
ns3::NeighborCacheHelper
A helper class to populate neighbor cache.
Definition: neighbor-cache-helper.h:51
ns3::NeighborCacheHelper::PopulateNeighborCache
void PopulateNeighborCache()
Populate neighbor ARP and NDISC caches for all devices.
Definition: neighbor-cache-helper.cc:48
ns3::NetDeviceContainer
holds a vector of ns3::NetDevice pointers
Definition: net-device-container.h:43
ns3::NetDeviceContainer::Get
Ptr< NetDevice > Get(uint32_t i) const
Get the Ptr<NetDevice> stored in this container at a given index.
Definition: net-device-container.cc:67
ns3::NodeContainer
keep track of a set of node pointers.
Definition: node-container.h:40
ns3::NodeContainer::Create
void Create(uint32_t n)
Create n nodes and append pointers to them to the end of this NodeContainer.
Definition: node-container.cc:84
ns3::NodeContainer::Add
void Add(const NodeContainer &nc)
Append the contents of another NodeContainer to the end of this container.
Definition: node-container.cc:102
ns3::NodeContainer::Get
Ptr< Node > Get(uint32_t i) const
Get the Ptr<Node> stored in this container at a given index.
Definition: node-container.cc:78
ns3::ObjectBase::TraceConnectWithoutContext
bool TraceConnectWithoutContext(std::string name, const CallbackBase &cb)
Connect a TraceSource to a Callback without a context.
Definition: object-base.cc:322
ns3::OnOffHelper
A helper to make it easier to instantiate an ns3::OnOffApplication on a set of nodes.
Definition: on-off-helper.h:37
ns3::PacketSinkHelper
A helper to make it easier to instantiate an ns3::PacketSinkApplication on a set of nodes.
Definition: packet-sink-helper.h:34
ns3::PcapHelperForDevice::EnablePcapAll
void EnablePcapAll(std::string prefix, bool promiscuous=false)
Enable pcap output on each device (which is of the appropriate type) in the set of all nodes created ...
Definition: trace-helper.cc:464
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:77
ns3::SeqTsSizeHeader
Header with a sequence, a timestamp, and a "size" attribute.
Definition: seq-ts-size-header.h:38
ns3::Simulator::Destroy
static void Destroy()
Execute the events scheduled with ScheduleDestroy().
Definition: simulator.cc:142
ns3::Simulator::Run
static void Run()
Run the simulation.
Definition: simulator.cc:178
ns3::Simulator::Stop
static void Stop()
Tell the Simulator the calling event should be the last one executed.
Definition: simulator.cc:186
ns3::StringValue
Hold variables of type string.
Definition: string.h:56
ns3::TimeValue
AttributeValue implementation for Time.
Definition: nstime.h:1413
uint32_t
port
uint16_t port
Definition: dsdv-manet.cc:44
NS_LOG_COMPONENT_DEFINE
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
NS_LOG_FUNCTION
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
Definition: log-macros-enabled.h:240
ns3::MicroSeconds
Time MicroSeconds(uint64_t value)
Construct a Time in the indicated unit.
Definition: nstime.h:1350
ns3::Seconds
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1326
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::LogComponentEnable
void LogComponentEnable(const std::string &name, LogLevel level)
Enable the logging output associated with that log component.
Definition: log.cc:302
ns3::MakeCallback
Callback< R, Args... > MakeCallback(R(T::*memPtr)(Args...), OBJ objPtr)
Build Callbacks for class method members which take varying numbers of arguments and potentially retu...
Definition: callback.h:704
ns3::LOG_LEVEL_LOGIC
@ LOG_LEVEL_LOGIC
LOG_LOGIC and above.
Definition: log.h:110
sink
Ptr< PacketSink > sink
Pointer to the packet sink application.
Definition: wifi-tcp.cc:55