]> git.meshlink.io Git - meshlink/blob - test/blackbox/test_case_optimal_pmtu_07/node_sim_nut.c
Add test cases for the PMTU discovery mechanism.
[meshlink] / test / blackbox / test_case_optimal_pmtu_07 / node_sim_nut.c
1 /*
2     node_sim_nut.c -- Implementation of Node Simulation for Meshlink Testing
3                     for meta connection test case 01 - re-connection of
4                     two nodes when relay node goes down
5     Copyright (C) 2018  Guus Sliepen <guus@meshlink.io>
6
7     This program is free software; you can redistribute it and/or modify
8     it under the terms of the GNU General Public License as published by
9     the Free Software Foundation; either version 2 of the License, or
10     (at your option) any later version.
11
12     This program is distributed in the hope that it will be useful,
13     but WITHOUT ANY WARRANTY; without even the implied warranty of
14     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15     GNU General Public License for more details.
16
17     You should have received a copy of the GNU General Public License along
18     with this program; if not, write to the Free Software Foundation, Inc.,
19     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 */
21 #include <stdio.h>
22 #include <stdlib.h>
23 #include <string.h>
24 #include <pthread.h>
25 #include <assert.h>
26 #include <signal.h>
27 #include <time.h>
28 #include "../common/common_handlers.h"
29 #include "../common/test_step.h"
30 #include "../common/mesh_event_handler.h"
31 #include "../../utils.h"
32 #include "../run_blackbox_tests/test_optimal_pmtu.h"
33
34 #define CMD_LINE_ARG_NODENAME   1
35 #define CMD_LINE_ARG_DEVCLASS   2
36 #define CMD_LINE_ARG_CLIENTID   3
37 #define CMD_LINE_ARG_IMPORTSTR  4
38 #define CMD_LINE_ARG_INVITEURL  5
39 #define CHANNEL_PORT 1234
40
41 #pragma pack(1)
42
43 static int client_id = -1;
44
45 static struct sync_flag peer_reachable = {.mutex  = PTHREAD_MUTEX_INITIALIZER, .cond = PTHREAD_COND_INITIALIZER};
46 static struct sync_flag channel_opened = {.mutex  = PTHREAD_MUTEX_INITIALIZER, .cond = PTHREAD_COND_INITIALIZER};
47
48 static void node_status_cb(meshlink_handle_t *mesh, meshlink_node_t *node,
49                            bool reachable);
50 static void channel_receive_cb(meshlink_handle_t *mesh, meshlink_channel_t *channel, const void *dat, size_t len);
51 static bool channel_accept(meshlink_handle_t *mesh, meshlink_channel_t *channel, uint16_t port, const void *dat, size_t len);
52
53 static pmtu_attr_t node_pmtu[2];
54
55 static void print_mtu_calc(pmtu_attr_t node_pmtu) {
56         fprintf(stderr, "MTU size : %d\n", node_pmtu.mtu_size);
57         fprintf(stderr, "Probes took for calculating PMTU discovery : %d\n", node_pmtu.mtu_discovery.probes);
58         fprintf(stderr, "Probes total length took for calculating PMTU discovery : %d\n", node_pmtu.mtu_discovery.probes_total_len);
59         fprintf(stderr, "Time took for calculating PMTU discovery : %lu\n", node_pmtu.mtu_discovery.time);
60         fprintf(stderr, "Total MTU ping probes : %d\n", node_pmtu.mtu_ping.probes);
61         fprintf(stderr, "Total MTU ping probes length : %d\n", node_pmtu.mtu_ping.probes_total_len);
62         float avg = 0;
63
64         if(node_pmtu.mtu_ping.probes) {
65                 avg = (float)node_pmtu.mtu_ping.time / (float)node_pmtu.mtu_ping.probes;
66         }
67
68         fprintf(stderr, "Average MTU ping probes ping time : %f\n", avg);
69         fprintf(stderr, "Total probes received %d\n", node_pmtu.mtu_recv_probes.probes);
70         fprintf(stderr, "Total probes sent %d\n", node_pmtu.mtu_sent_probes.probes);
71 }
72
73 static void node_status_cb(meshlink_handle_t *mesh, meshlink_node_t *node,
74                            bool reachable) {
75         if(!strcasecmp(node->name, "peer") && reachable) {
76                 set_sync_flag(&peer_reachable, true);
77         }
78
79         mesh_event_sock_send(client_id, reachable ? NODE_JOINED : NODE_LEFT, node->name, 100);
80         return;
81 }
82
83 static void poll_cb(meshlink_handle_t *mesh, meshlink_channel_t *channel, size_t len) {
84         (void)len;
85         meshlink_set_channel_poll_cb(mesh, channel, NULL);
86         assert(meshlink_channel_send(mesh, channel, "test", 5) >= 0);
87         return;
88 }
89
90 static bool channel_accept(meshlink_handle_t *mesh, meshlink_channel_t *channel, uint16_t port, const void *dat, size_t len) {
91         (void)dat;
92         (void)len;
93
94         assert(port == CHANNEL_PORT);
95
96         if(!strcmp(channel->node->name, "peer")) {
97                 meshlink_set_channel_receive_cb(mesh, channel, channel_receive_cb);
98                 mesh->priv = channel;
99
100                 return true;
101         }
102
103         return false;
104 }
105
106 /* channel receive callback */
107 static void channel_receive_cb(meshlink_handle_t *mesh, meshlink_channel_t *channel, const void *dat, size_t len) {
108         if(len == 0) {
109                 mesh_event_sock_send(client_id, ERR_NETWORK, channel->node->name, 100);
110                 return;
111         }
112
113         if(!strcmp(channel->node->name, "peer")) {
114                 if(!memcmp(dat, "reply", 5)) {
115                         set_sync_flag(&channel_opened, true);
116                         fprintf(stderr, "GOT REPLY FROM PEER\n");
117                 } else if(!memcmp(dat, "test", 5)) {
118                         assert(meshlink_channel_send(mesh, channel, "reply", 5) >= 0);
119                 }
120         }
121
122         return;
123 }
124
125 void meshlink_logger(meshlink_handle_t *mesh, meshlink_log_level_t level,
126                      const char *text) {
127         (void)mesh;
128         (void)level;
129         int probe_len;
130         int mtu_len;
131         int probes;
132         char node_name[100];
133         int i = -1;
134
135         time_t cur_time;
136         time_t probe_interval;
137
138         cur_time = time(NULL);
139         assert(cur_time != -1);
140
141         static time_t node_shutdown_time = 0;
142         bool mtu_probe = false;
143
144         if(node_shutdown_time && cur_time >= node_shutdown_time) {
145                 test_running = false;
146         }
147
148         static const char *levelstr[] = {
149                 [MESHLINK_DEBUG] = "\x1b[34mDEBUG",
150                 [MESHLINK_INFO] = "\x1b[32mINFO",
151                 [MESHLINK_WARNING] = "\x1b[33mWARNING",
152                 [MESHLINK_ERROR] = "\x1b[31mERROR",
153                 [MESHLINK_CRITICAL] = "\x1b[31mCRITICAL",
154         };
155
156         fprintf(stderr, "%s:\x1b[0m %s\n", levelstr[level], text);
157
158         if(sscanf(text, "Sending MTU probe length %d to %s", &probe_len, node_name) == 2) {
159                 find_node_index(i, node_name);
160                 node_pmtu[i].mtu_sent_probes.probes += 1;
161                 node_pmtu[i].mtu_sent_probes.probes_total_len += probe_len;
162
163                 if(node_pmtu[i].mtu_size) {
164                         if(node_pmtu[i].mtu_sent_probes.time > node_pmtu[i].mtu_recv_probes.time) {
165                                 probe_interval = cur_time - node_pmtu[i].mtu_sent_probes.time;
166                         } else {
167                                 probe_interval = cur_time - node_pmtu[i].mtu_recv_probes.time;
168                         }
169
170                         node_pmtu[i].mtu_ping.probes += 1;
171                         node_pmtu[i].mtu_ping.time += probe_interval;
172                         node_pmtu[i].mtu_ping.probes_total_len += probe_len;
173                 }
174
175                 node_pmtu[i].mtu_sent_probes.time = cur_time;
176
177         } else if(sscanf(text, "Got MTU probe length %d from %s", &probe_len, node_name) == 2) {
178                 find_node_index(i, node_name);
179                 node_pmtu[i].mtu_recv_probes.probes += 1;
180                 node_pmtu[i].mtu_recv_probes.probes_total_len += probe_len;
181
182                 if(node_pmtu[i].mtu_size) {
183                         if(node_pmtu[i].mtu_sent_probes.time > node_pmtu[i].mtu_recv_probes.time) {
184                                 probe_interval = cur_time - node_pmtu[i].mtu_sent_probes.time;
185                         } else {
186                                 probe_interval = cur_time - node_pmtu[i].mtu_recv_probes.time;
187                         }
188
189                         node_pmtu[i].mtu_ping.probes += 1;
190                         node_pmtu[i].mtu_ping.time += probe_interval;
191                         node_pmtu[i].mtu_ping.probes_total_len += probe_len;
192                 }
193
194                 node_pmtu[i].mtu_recv_probes.time = cur_time;
195
196         } else if(sscanf(text, "Fixing MTU of %s to %d after %d probes", node_name, &mtu_len, &probes) == 3) {
197                 static bool mtu_set = true;
198
199                 if(!node_shutdown_time && !strcasecmp("relay", node_name) && mtu_set) {
200                         node_shutdown_time = cur_time + PING_TRACK_TIMEOUT;
201                         mtu_set = false;
202                 }
203
204                 find_node_index(i, node_name);
205                 node_pmtu[i].mtu_discovery.probes = node_pmtu[i].mtu_recv_probes.probes + node_pmtu[i].mtu_sent_probes.probes;
206                 node_pmtu[i].mtu_discovery.probes_total_len = node_pmtu[i].mtu_sent_probes.probes_total_len + node_pmtu[i].mtu_recv_probes.probes_total_len;
207                 node_pmtu[i].mtu_discovery.time = cur_time - node_pmtu[i].mtu_start.time;
208                 node_pmtu[i].mtu_discovery.count += 1;
209                 node_pmtu[i].mtu_size = mtu_len;
210
211         } else if(sscanf(text, "SPTPS key exchange with %s succesful", node_name) == 1) {
212                 find_node_index(i, node_name);
213                 node_pmtu[i].mtu_start.time = cur_time;
214                 node_pmtu[i].mtu_start.count += 1;
215                 memset(&node_pmtu[i].mtu_discovery, 0, sizeof(struct pmtu_attr_para));
216                 memset(&node_pmtu[i].mtu_ping, 0, sizeof(struct pmtu_attr_para));
217                 memset(&node_pmtu[i].mtu_increase, 0, sizeof(struct pmtu_attr_para));
218
219         } else if(sscanf(text, "Increase in PMTU to %s detected, restarting PMTU discovery", node_name) == 1) {
220                 find_node_index(i, node_name);
221                 node_pmtu[i].mtu_increase.time = cur_time - node_pmtu[i].mtu_start.time;
222                 node_pmtu[i].mtu_increase.count += 1;
223
224         } else if(sscanf(text, "Trying to send MTU probe to unreachable or rekeying node %s", node_name) == 1) {
225
226         } else if(sscanf(text, "%s did not respond to UDP ping, restarting PMTU discovery", node_name) == 1) {
227
228         } else if(sscanf(text, "No response to MTU probes from %s", node_name) == 1) {
229
230         } else if((sscanf(text, "Connection with %s activated", node_name) == 1) || (sscanf(text, "Already connected to %s", node_name) == 1)) {
231                 mesh_event_sock_send(client_id, META_CONN_SUCCESSFUL, node_name, sizeof(node_name));
232
233         } else if((sscanf(text, "Connection closed by %s", node_name) == 1) || (sscanf(text, "Closing connection with %s", node_name) == 1)) {
234                 mesh_event_sock_send(client_id, META_CONN_CLOSED, node_name, sizeof(node_name));
235
236         }
237 }
238
239 int main(int argc, char *argv[]) {
240         struct timeval main_loop_wait = { 5, 0 };
241         int i;
242
243         // Import mesh event handler
244
245         if((argv[CMD_LINE_ARG_CLIENTID]) && (argv[CMD_LINE_ARG_IMPORTSTR])) {
246                 client_id = atoi(argv[CMD_LINE_ARG_CLIENTID]);
247                 mesh_event_sock_connect(argv[CMD_LINE_ARG_IMPORTSTR]);
248         }
249
250         setup_signals();
251
252         // Execute test steps
253
254         meshlink_handle_t *mesh = meshlink_open("testconf", argv[CMD_LINE_ARG_NODENAME],
255                                                 "test_channel_conn", atoi(argv[CMD_LINE_ARG_DEVCLASS]));
256         assert(mesh);
257         meshlink_set_log_cb(mesh, MESHLINK_DEBUG, meshlink_logger);
258         meshlink_set_node_status_cb(mesh, node_status_cb);
259         meshlink_enable_discovery(mesh, false);
260         sleep(1);
261
262         if(argv[CMD_LINE_ARG_INVITEURL]) {
263                 int attempts;
264                 bool join_ret;
265
266                 for(attempts = 0; attempts < 10; attempts++) {
267                         join_ret = meshlink_join(mesh, argv[CMD_LINE_ARG_INVITEURL]);
268
269                         if(join_ret) {
270                                 break;
271                         }
272
273                         sleep(1);
274                 }
275
276                 if(attempts == 10) {
277                         abort();
278                 }
279         }
280
281         assert(meshlink_start(mesh));
282
283         // Wait for peer node to join
284
285         assert(wait_sync_flag(&peer_reachable, 10));
286
287         // Open a channel to peer node
288
289         meshlink_node_t *peer_node = meshlink_get_node(mesh, "peer");
290         assert(peer_node);
291         meshlink_channel_t *channel = meshlink_channel_open(mesh, peer_node, CHANNEL_PORT,
292                                       channel_receive_cb, NULL, 0);
293         meshlink_set_channel_poll_cb(mesh, channel, poll_cb);
294
295         assert(wait_sync_flag(&channel_opened, 30));
296         assert(mesh_event_sock_send(client_id, CHANNEL_OPENED, NULL, 0));
297
298         // All test steps executed - wait for signals to stop/start or close the mesh
299
300         time_t time_stamp, send_time;
301
302         time_stamp = time(NULL);
303         send_time = time_stamp + 10;
304
305         while(test_running) {
306                 select(1, NULL, NULL, NULL, &main_loop_wait);
307
308                 time_stamp = time(NULL);
309
310                 if(time_stamp >= send_time) {
311                         send_time = time_stamp + 10;
312                         meshlink_channel_send(mesh, channel, "ping", 5);
313                 }
314         }
315
316         pmtu_attr_t send_mtu_data;
317         send_mtu_data = node_pmtu[NODE_PMTU_PEER];
318         print_mtu_calc(send_mtu_data);
319         assert(mesh_event_sock_send(client_id, OPTIMAL_PMTU_PEER, &send_mtu_data, sizeof(send_mtu_data)));
320         send_mtu_data = node_pmtu[NODE_PMTU_RELAY];
321         print_mtu_calc(send_mtu_data);
322         assert(mesh_event_sock_send(client_id, OPTIMAL_PMTU_RELAY, &send_mtu_data, sizeof(send_mtu_data)));
323
324         meshlink_close(mesh);
325 }