test-server/test-ping.c

   1 /*
   2  * libwebsockets-test-ping - libwebsockets floodping
   3  *
   4  * Copyright (C) 2011 Andy Green <andy@warmcat.com>
   5  *
   6  *  This library is free software; you can redistribute it and/or
   7  *  modify it under the terms of the GNU Lesser General Public
   8  *  License as published by the Free Software Foundation:
   9  *  version 2.1 of the License.
  10  *
  11  *  This library is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  *  Lesser General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU Lesser General Public
  17  *  License along with this library; if not, write to the Free Software
  18  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  19  *  MA  02110-1301  USA
  20  */
  21
  22 #include <stdio.h>
  23 #include <stdlib.h>
  24 #include <unistd.h>
  25 #include <getopt.h>
  26 #include <string.h>
  27 #include <signal.h>
  28 #include <unistd.h>
  29
  30 #include <sys/time.h>
  31 #include <sys/types.h>
  32 #include <sys/socket.h>
  33 #include <netdb.h>
  34
  35 #include <sys/ioctl.h>
  36
  37 #include "../lib/libwebsockets.h"
  38 #include <poll.h>
  39
  40 /*
  41  * this is specified in the 04 standard, control frames can only have small
  42  * payload length styles
  43  */
  44 #define MAX_PING_PAYLOAD 125
  45 #define MAX_MIRROR_PAYLOAD 4096
  46 #define MAX_PING_CLIENTS 256
  47 #define PING_RINGBUFFER_SIZE 256
  48
  49 static struct libwebsocket *ping_wsi[MAX_PING_CLIENTS];
  50 static unsigned int interval_us = 1000000;
  51 static unsigned int size = 64;
  52 static int flood;
  53 static const char *address;
  54 static unsigned char pingbuf[LWS_SEND_BUFFER_PRE_PADDING + MAX_MIRROR_PAYLOAD +
  55                                                   LWS_SEND_BUFFER_POST_PADDING];
  56 static char peer_name[128];
  57 static unsigned long started;
  58 static int screen_width = 80;
  59 static int use_mirror;
  60 static unsigned int write_options;
  61
  62 static unsigned long rtt_min = 100000000;
  63 static unsigned long rtt_max;
  64 static unsigned long rtt_avg;
  65 static unsigned long global_rx_count;
  66 static unsigned long global_tx_count;
  67 static int clients = 1;
  68 static unsigned long interrupted_time;
  69
  70 struct ping {
  71         unsigned long issue_timestamp;
  72         unsigned long index;
  73         unsigned int seen;
  74 };
  75
  76 struct per_session_data__ping {
  77         unsigned long ping_index;
  78
  79         struct ping ringbuffer[PING_RINGBUFFER_SIZE];
  80         int ringbuffer_head;
  81         int ringbuffer_tail;
  82
  83         unsigned long rx_count;
  84 };
  85
  86 /*
  87  * uses the ping pong protocol features to provide an equivalent for the
  88  * ping utility for 04+ websockets
  89  */
  90
  91 enum demo_protocols {
  92
  93         PROTOCOL_LWS_MIRROR,
  94
  95         /* always last */
  96         DEMO_PROTOCOL_COUNT
  97 };
  98
  99
 100 static int
 101 callback_lws_mirror(struct libwebsocket_context * this,
 102                         struct libwebsocket *wsi,
 103                         enum libwebsocket_callback_reasons reason,
 104                                                void *user, void *in, size_t len)
 105 {
 106         struct timeval tv;
 107         unsigned char *p;
 108         int shift;
 109         unsigned long l;
 110         unsigned long iv;
 111         int n;
 112         int match = 0;
 113         struct per_session_data__ping *psd = user;
 114
 115         switch (reason) {
 116         case LWS_CALLBACK_CLOSED:
 117
 118                 fprintf(stderr, "LWS_CALLBACK_CLOSED on %p\n", (void *)wsi);
 119
 120                 /* remove closed guy */
 121
 122                 for (n = 0; n < clients; n++)
 123                         if (ping_wsi[n] == wsi) {
 124                                 clients--;
 125                                 while (n < clients) {
 126                                         ping_wsi[n] = ping_wsi[n + 1];
 127                                         n++;
 128                                 }
 129                         }
 130
 131                 break;
 132
 133         case LWS_CALLBACK_CLIENT_ESTABLISHED:
 134
 135                 psd->rx_count = 0;
 136                 psd->ping_index = 1;
 137                 psd->ringbuffer_head = 0;
 138                 psd->ringbuffer_tail = 0;
 139
 140                 /*
 141                  * start the ball rolling,
 142                  * LWS_CALLBACK_CLIENT_WRITEABLE will come next service
 143                  */
 144
 145                 libwebsocket_callback_on_writable(this, wsi);
 146                 break;
 147
 148         case LWS_CALLBACK_CLIENT_RECEIVE:
 149         case LWS_CALLBACK_CLIENT_RECEIVE_PONG:
 150                 gettimeofday(&tv, NULL);
 151                 iv = (tv.tv_sec * 1000000) + tv.tv_usec;
 152
 153                 psd->rx_count++;
 154
 155                 shift = 56;
 156                 p = in;
 157                 l = 0;
 158
 159                 while (shift >= 0) {
 160                         l |= (*p++) << shift;
 161                         shift -= 8;
 162                 }
 163
 164                 /* find it in the ringbuffer, look backwards from head */
 165                 n = psd->ringbuffer_head;
 166                 while (!match) {
 167
 168                         if (psd->ringbuffer[n].index == l) {
 169                                 psd->ringbuffer[n].seen++;
 170                                 match = 1;
 171                                 continue;
 172                         }
 173
 174                         if (n == psd->ringbuffer_tail) {
 175                                 match = -1;
 176                                 continue;
 177                         }
 178
 179                         if (n == 0)
 180                                 n = PING_RINGBUFFER_SIZE - 1;
 181                         else
 182                                 n--;
 183                 }
 184
 185                 if (match < 1) {
 186
 187                         if (!flood)
 188                                 fprintf(stderr, "%d bytes from %s: req=%ld "
 189                                       "time=(unknown)\n", (int)len, address, l);
 190                         else
 191                                 fprintf(stderr, "\b \b");
 192
 193                         break;
 194                 }
 195
 196                 if (psd->ringbuffer[n].seen > 1)
 197                         fprintf(stderr, "DUP! ");
 198
 199                 if ((iv - psd->ringbuffer[n].issue_timestamp) < rtt_min)
 200                         rtt_min = iv - psd->ringbuffer[n].issue_timestamp;
 201
 202                 if ((iv - psd->ringbuffer[n].issue_timestamp) > rtt_max)
 203                         rtt_max = iv - psd->ringbuffer[n].issue_timestamp;
 204
 205                 rtt_avg += iv - psd->ringbuffer[n].issue_timestamp;
 206                 global_rx_count++;
 207
 208                 if (!flood)
 209                         fprintf(stderr, "%d bytes from %s: req=%ld "
 210                                 "time=%lu.%lums\n", (int)len, address, l,
 211                                (iv - psd->ringbuffer[n].issue_timestamp) / 1000,
 212                         ((iv - psd->ringbuffer[n].issue_timestamp) / 100) % 10);
 213                 else
 214                         fprintf(stderr, "\b \b");
 215                 break;
 216
 217         case LWS_CALLBACK_CLIENT_WRITEABLE:
 218
 219                 shift = 56;
 220                 p = &pingbuf[LWS_SEND_BUFFER_PRE_PADDING];
 221
 222                 /* 64-bit ping index in network byte order */
 223
 224                 while (shift >= 0) {
 225                         *p++ = psd->ping_index >> shift;
 226                         shift -= 8;
 227                 }
 228
 229                 gettimeofday(&tv, NULL);
 230
 231                 psd->ringbuffer[psd->ringbuffer_head].issue_timestamp =
 232                                              (tv.tv_sec * 1000000) + tv.tv_usec;
 233                 psd->ringbuffer[psd->ringbuffer_head].index = psd->ping_index++;
 234                 psd->ringbuffer[psd->ringbuffer_head].seen = 0;
 235
 236                 if (psd->ringbuffer_head == PING_RINGBUFFER_SIZE - 1)
 237                         psd->ringbuffer_head = 0;
 238                 else
 239                         psd->ringbuffer_head++;
 240
 241                 /* snip any re-used tail so we keep to the ring length */
 242
 243                 if (psd->ringbuffer_tail == psd->ringbuffer_head) {
 244                         if (psd->ringbuffer_tail == PING_RINGBUFFER_SIZE - 1)
 245                                 psd->ringbuffer_tail = 0;
 246                         else
 247                                 psd->ringbuffer_tail++;
 248                 }
 249
 250                 global_tx_count++;
 251
 252                 if (use_mirror)
 253                         libwebsocket_write(wsi,
 254                                 &pingbuf[LWS_SEND_BUFFER_PRE_PADDING],
 255                                         size, write_options | LWS_WRITE_BINARY);
 256                 else
 257                         libwebsocket_write(wsi,
 258                                 &pingbuf[LWS_SEND_BUFFER_PRE_PADDING],
 259                                         size, write_options | LWS_WRITE_PING);
 260
 261                 if (flood &&
 262                          (psd->ping_index - psd->rx_count) < (screen_width - 1))
 263                         fprintf(stderr, ".");
 264                 break;
 265
 266         default:
 267                 break;
 268         }
 269
 270         return 0;
 271 }
 272
 273
 274 /* list of supported protocols and callbacks */
 275
 276 static struct libwebsocket_protocols protocols[] = {
 277
 278         [PROTOCOL_LWS_MIRROR] = {
 279                 .name = "lws-mirror-protocol",
 280                 .callback = callback_lws_mirror,
 281                 .per_session_data_size = sizeof (struct per_session_data__ping),
 282         },
 283         [DEMO_PROTOCOL_COUNT] = {  /* end of list */
 284                 .callback = NULL
 285         }
 286 };
 287
 288 static struct option options[] = {
 289         { "help",       no_argument,            NULL, 'h' },
 290         { "port",       required_argument,      NULL, 'p' },
 291         { "ssl",        no_argument,            NULL, 't' },
 292         { "interval",   required_argument,      NULL, 'i' },
 293         { "size",       required_argument,      NULL, 's' },
 294         { "protocol",   required_argument,      NULL, 'n' },
 295         { "flood",      no_argument,            NULL, 'f' },
 296         { "mirror",     no_argument,            NULL, 'm' },
 297         { "replicate",  required_argument,      NULL, 'r' },
 298         { "killmask",   no_argument,            NULL, 'k' },
 299         { "version",    required_argument,      NULL, 'v' },
 300         { NULL, 0, 0, 0 }
 301 };
 302
 303
 304 static void
 305 signal_handler(int sig, siginfo_t *si, void *v)
 306 {
 307         struct timeval tv;
 308
 309         gettimeofday(&tv, NULL);
 310         interrupted_time = (tv.tv_sec * 1000000) + tv.tv_usec;
 311 }
 312
 313
 314 int main(int argc, char **argv)
 315 {
 316         int n = 0;
 317         int port = 7681;
 318         int use_ssl = 0;
 319         struct libwebsocket_context *context;
 320         char protocol_name[256];
 321         char ip[30];
 322         struct sigaction sa;
 323         struct timeval tv;
 324         struct winsize w;
 325         unsigned long oldus = 0;
 326         unsigned long l;
 327         int ietf_version = -1;
 328
 329         if (argc < 2)
 330                 goto usage;
 331
 332         address = argv[1];
 333         optind++;
 334
 335         while (n >= 0) {
 336                 n = getopt_long(argc, argv, "v:kr:hmfts:n:i:p:", options, NULL);
 337                 if (n < 0)
 338                         continue;
 339                 switch (n) {
 340                 case 'm':
 341                         use_mirror = 1;
 342                         break;
 343                 case 't':
 344                         use_ssl = 2; /* 2 = allow selfsigned */
 345                         break;
 346                 case 'p':
 347                         port = atoi(optarg);
 348                         break;
 349                 case 'n':
 350                         strncpy(protocol_name, optarg, sizeof protocol_name);
 351                         protocol_name[(sizeof protocol_name) - 1] = '\0';
 352                         protocols[PROTOCOL_LWS_MIRROR].name = protocol_name;
 353                         break;
 354                 case 'i':
 355                         interval_us = 1000000.0 * atof(optarg);
 356                         break;
 357                 case 's':
 358                         size = atoi(optarg);
 359                         break;
 360                 case 'f':
 361                         flood = 1;
 362                         break;
 363                 case 'r':
 364                         clients = atoi(optarg);
 365                         if (clients > MAX_PING_CLIENTS || clients < 1) {
 366                                 fprintf(stderr, "Max clients supportd = %d\n",
 367                                                               MAX_PING_CLIENTS);
 368                                 return 1;
 369                         }
 370                         break;
 371                 case 'k':
 372                         write_options = LWS_WRITE_CLIENT_IGNORE_XOR_MASK;
 373                         break;
 374                 case 'v':
 375                         ietf_version = atoi(optarg);
 376                         break;
 377
 378                 case 'h':
 379                         goto usage;
 380                 }
 381         }
 382
 383         if (!use_mirror) {
 384                 if (size > MAX_PING_PAYLOAD) {
 385                         fprintf(stderr, "Max ping opcode payload size %d\n",
 386                                                               MAX_PING_PAYLOAD);
 387                         return 1;
 388                 }
 389         } else {
 390                 if (size > MAX_MIRROR_PAYLOAD) {
 391                         fprintf(stderr, "Max mirror payload size %d\n",
 392                                                             MAX_MIRROR_PAYLOAD);
 393                         return 1;
 394                 }
 395         }
 396
 397
 398         if (isatty(STDOUT_FILENO))
 399                 if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &w) != -1)
 400                         if (w.ws_col > 0)
 401                                 screen_width = w.ws_col;
 402
 403         context = libwebsocket_create_context(CONTEXT_PORT_NO_LISTEN, NULL,
 404                                               protocols, NULL, NULL, -1, -1, 0);
 405         if (context == NULL) {
 406                 fprintf(stderr, "Creating libwebsocket context failed\n");
 407                 return 1;
 408         }
 409
 410         /* create client websockets using dumb increment protocol */
 411
 412         for (n = 0; n < clients; n++) {
 413                 ping_wsi[n] = libwebsocket_client_connect(context, address,
 414                                                    port, use_ssl, "/", address,
 415                                  "origin", protocols[PROTOCOL_LWS_MIRROR].name,
 416                                                                   ietf_version);
 417                 if (ping_wsi[n] == NULL) {
 418                         fprintf(stderr, "client connnection %d failed to "
 419                                                                 "connect\n", n);
 420                         return 1;
 421                 }
 422         }
 423
 424         libwebsockets_get_peer_addresses(
 425                         libwebsocket_get_socket_fd(ping_wsi[0]),
 426                                     peer_name, sizeof peer_name, ip, sizeof ip);
 427
 428         fprintf(stderr, "Websocket PING %s (%s) %d bytes of data.\n",
 429                                                            peer_name, ip, size);
 430
 431         /* set the ^C handler */
 432
 433         sa.sa_sigaction = signal_handler;
 434         sa.sa_flags = SA_SIGINFO;
 435         sigemptyset(&sa.sa_mask);
 436         sigaction(SIGINT, &sa, NULL);
 437
 438         gettimeofday(&tv, NULL);
 439         started = (tv.tv_sec * 1000000) + tv.tv_usec;
 440
 441         /* service loop */
 442
 443         n = 0;
 444         while (n >= 0) {
 445
 446                 gettimeofday(&tv, NULL);
 447                 l = (tv.tv_sec * 1000000) + tv.tv_usec;
 448
 449                 /* servers can hang up on us */
 450
 451                 if (clients == 0) {
 452                         n = -1;
 453                         continue;
 454                 }
 455
 456                 if (!interrupted_time) {
 457                         if ((l - oldus) > interval_us) {
 458                                 for (n = 0; n < clients; n++)
 459                                         libwebsocket_callback_on_writable(
 460                                                           context, ping_wsi[n]);
 461                                 oldus = l;
 462                         }
 463                 } else
 464
 465                         /* allow time for in-flight pongs to come */
 466
 467                         if ((l - interrupted_time) > 250000) {
 468                                 n = -1;
 469                                 continue;
 470                         }
 471
 472                 if (!interval_us)
 473                         n = libwebsocket_service(context, 0);
 474                 else
 475                         n = libwebsocket_service(context, 1);
 476         }
 477
 478         /* stats */
 479
 480         fprintf(stderr, "\n--- %s websocket ping statistics "
 481                 "using %d connections ---\n"
 482                 "%lu packets transmitted, %lu received, "
 483                 "%lu%% packet loss, time %ldms\n"
 484                 "rtt min/avg/max = %0.3f/%0.3f/%0.3f ms\n"
 485                 "payload bandwidth average %0.3f KiBytes/sec\n",
 486                 peer_name, clients, global_tx_count, global_rx_count,
 487                 ((global_tx_count - global_rx_count) * 100) / global_tx_count,
 488                 (l - started) / 1000,
 489                 ((double)rtt_min) / 1000.0,
 490                 ((double)rtt_avg / global_rx_count) / 1000.0,
 491                 ((double)rtt_max) / 1000.0,
 492                 ((double)global_rx_count * (double)size) /
 493                                   ((double)(l - started) / 1000000.0) / 1024.0);
 494
 495         libwebsocket_context_destroy(context);
 496
 497         return 0;
 498
 499 usage:
 500         fprintf(stderr, "Usage: libwebsockets-test-ping "
 501                                              "<server address> [--port=<p>] "
 502                                              "[--ssl] [--interval=<float sec>] "
 503                                              "[--size=<bytes>] "
 504                                              "[--protocol=<protocolname>] "
 505                                              "[--mirror] "
 506                                              "[--replicate=clients>]"
 507                                              "[--version <version>]"
 508                                              "\n");
 509         return 1;
 510 }