src/redis-benchmark.c

   1 /* Redis benchmark utility.
   2  *
   3  * Copyright (c) 2009-2010, Salvatore Sanfilippo <antirez at gmail dot com>
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions are met:
   8  *
   9  *   * Redistributions of source code must retain the above copyright notice,
  10  *     this list of conditions and the following disclaimer.
  11  *   * Redistributions in binary form must reproduce the above copyright
  12  *     notice, this list of conditions and the following disclaimer in the
  13  *     documentation and/or other materials provided with the distribution.
  14  *   * Neither the name of Redis nor the names of its contributors may be used
  15  *     to endorse or promote products derived from this software without
  16  *     specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28  * POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #include "fmacros.h"
  32
  33 #include <stdio.h>
  34 #include <string.h>
  35 #include <stdlib.h>
  36 #include <unistd.h>
  37 #include <errno.h>
  38 #include <sys/time.h>
  39 #include <signal.h>
  40 #include <assert.h>
  41
  42 #include "ae.h"
  43 #include "hiredis.h"
  44 #include "sds.h"
  45 #include "adlist.h"
  46 #include "zmalloc.h"
  47
  48 #define CLIENT_CONNECTING 0
  49 #define CLIENT_SENDQUERY 1
  50 #define CLIENT_READREPLY 2
  51
  52 #define REDIS_NOTUSED(V) ((void) V)
  53
  54 static struct config {
  55     int debug;
  56     int numclients;
  57     int requests;
  58     int liveclients;
  59     int donerequests;
  60     int keysize;
  61     int datasize;
  62     int randomkeys;
  63     int randomkeys_keyspacelen;
  64     aeEventLoop *el;
  65     char *hostip;
  66     int hostport;
  67     char *hostsocket;
  68     int keepalive;
  69     long long start;
  70     long long totlatency;
  71     long long *latency;
  72     char *title;
  73     list *clients;
  74     int quiet;
  75     int loop;
  76     int idlemode;
  77 } config;
  78
  79 typedef struct _client {
  80     redisContext *context;
  81     int state;
  82     sds obuf;
  83     unsigned int written; /* bytes of 'obuf' already written */
  84     int replytype;
  85     long long start; /* start time of a request */
  86     long long latency; /* request latency */
  87 } *client;
  88
  89 /* Prototypes */
  90 static void writeHandler(aeEventLoop *el, int fd, void *privdata, int mask);
  91 static void createMissingClients(client c);
  92
  93 /* Implementation */
  94 static long long ustime(void) {
  95     struct timeval tv;
  96     long long ust;
  97
  98     gettimeofday(&tv, NULL);
  99     ust = ((long)tv.tv_sec)*1000000;
 100     ust += tv.tv_usec;
 101     return ust;
 102 }
 103
 104 static long long mstime(void) {
 105     struct timeval tv;
 106     long long mst;
 107
 108     gettimeofday(&tv, NULL);
 109     mst = ((long)tv.tv_sec)*1000;
 110     mst += tv.tv_usec/1000;
 111     return mst;
 112 }
 113
 114 static void freeClient(client c) {
 115     listNode *ln;
 116     aeDeleteFileEvent(config.el,c->context->fd,AE_WRITABLE);
 117     aeDeleteFileEvent(config.el,c->context->fd,AE_READABLE);
 118     redisFree(c->context);
 119     sdsfree(c->obuf);
 120     zfree(c);
 121     config.liveclients--;
 122     ln = listSearchKey(config.clients,c);
 123     assert(ln != NULL);
 124     listDelNode(config.clients,ln);
 125 }
 126
 127 static void freeAllClients(void) {
 128     listNode *ln = config.clients->head, *next;
 129
 130     while(ln) {
 131         next = ln->next;
 132         freeClient(ln->value);
 133         ln = next;
 134     }
 135 }
 136
 137 static void resetClient(client c) {
 138     aeDeleteFileEvent(config.el,c->context->fd,AE_WRITABLE);
 139     aeDeleteFileEvent(config.el,c->context->fd,AE_READABLE);
 140     aeCreateFileEvent(config.el,c->context->fd,AE_WRITABLE,writeHandler,c);
 141     c->written = 0;
 142     c->state = CLIENT_SENDQUERY;
 143     c->start = ustime();
 144     c->latency = -1;
 145 }
 146
 147 static void randomizeClientKey(client c) {
 148     char *p;
 149     char buf[32];
 150     long r;
 151
 152     p = strstr(c->obuf, "_rand");
 153     if (!p) return;
 154     p += 5;
 155     r = random() % config.randomkeys_keyspacelen;
 156     sprintf(buf,"%ld",r);
 157     memcpy(p,buf,strlen(buf));
 158 }
 159
 160 static void clientDone(client c) {
 161     if (config.donerequests == config.requests) {
 162         freeClient(c);
 163         aeStop(config.el);
 164         return;
 165     }
 166     if (config.keepalive) {
 167         resetClient(c);
 168         if (config.randomkeys) randomizeClientKey(c);
 169     } else {
 170         config.liveclients--;
 171         createMissingClients(c);
 172         config.liveclients++;
 173         freeClient(c);
 174     }
 175 }
 176
 177 static void readHandler(aeEventLoop *el, int fd, void *privdata, int mask) {
 178     client c = privdata;
 179     void *reply = NULL;
 180     REDIS_NOTUSED(el);
 181     REDIS_NOTUSED(fd);
 182     REDIS_NOTUSED(mask);
 183
 184     /* Calculate latency only for the first read event. This means that the
 185      * server already sent the reply and we need to parse it. Parsing overhead
 186      * is not part of the latency, so calculate it only once, here. */
 187     if (c->latency < 0) c->latency = ustime()-(c->start);
 188
 189     if (redisBufferRead(c->context) != REDIS_OK) {
 190         fprintf(stderr,"Error: %s\n",c->context->errstr);
 191         exit(1);
 192     } else {
 193         if (redisGetReply(c->context,&reply) != REDIS_OK) {
 194             fprintf(stderr,"Error: %s\n",c->context->errstr);
 195             exit(1);
 196         }
 197         if (reply != NULL) {
 198             if (reply == (void*)REDIS_REPLY_ERROR) {
 199                 fprintf(stderr,"Unexpected error reply, exiting...\n");
 200                 exit(1);
 201             }
 202
 203             if (config.donerequests < config.requests)
 204                 config.latency[config.donerequests++] = c->latency;
 205             clientDone(c);
 206         }
 207     }
 208 }
 209
 210 static void writeHandler(aeEventLoop *el, int fd, void *privdata, int mask) {
 211     client c = privdata;
 212     REDIS_NOTUSED(el);
 213     REDIS_NOTUSED(fd);
 214     REDIS_NOTUSED(mask);
 215
 216     if (c->state == CLIENT_CONNECTING) {
 217         c->state = CLIENT_SENDQUERY;
 218         c->start = ustime();
 219         c->latency = -1;
 220     }
 221     if (sdslen(c->obuf) > c->written) {
 222         void *ptr = c->obuf+c->written;
 223         int nwritten = write(c->context->fd,ptr,sdslen(c->obuf)-c->written);
 224         if (nwritten == -1) {
 225             if (errno != EPIPE)
 226                 fprintf(stderr, "Writing to socket: %s\n", strerror(errno));
 227             freeClient(c);
 228             return;
 229         }
 230         c->written += nwritten;
 231         if (sdslen(c->obuf) == c->written) {
 232             aeDeleteFileEvent(config.el,c->context->fd,AE_WRITABLE);
 233             aeCreateFileEvent(config.el,c->context->fd,AE_READABLE,readHandler,c);
 234             c->state = CLIENT_READREPLY;
 235         }
 236     }
 237 }
 238
 239 static client createClient(int replytype) {
 240     client c = zmalloc(sizeof(struct _client));
 241     if (config.hostsocket == NULL) {
 242         c->context = redisConnectNonBlock(config.hostip,config.hostport);
 243     } else {
 244         c->context = redisConnectUnixNonBlock(config.hostsocket);
 245     }
 246     if (c->context->err) {
 247         fprintf(stderr,"Could not connect to Redis at ");
 248         if (config.hostsocket == NULL)
 249             fprintf(stderr,"%s:%d: %s\n",config.hostip,config.hostport,c->context->errstr);
 250         else
 251             fprintf(stderr,"%s: %s\n",config.hostsocket,c->context->errstr);
 252         exit(1);
 253     }
 254     c->replytype = replytype;
 255     c->state = CLIENT_CONNECTING;
 256     c->obuf = sdsempty();
 257     c->written = 0;
 258     redisSetReplyObjectFunctions(c->context,NULL);
 259     aeCreateFileEvent(config.el,c->context->fd,AE_WRITABLE,writeHandler,c);
 260     listAddNodeTail(config.clients,c);
 261     config.liveclients++;
 262     return c;
 263 }
 264
 265 static void createMissingClients(client c) {
 266     while(config.liveclients < config.numclients) {
 267         client new = createClient(c->replytype);
 268         sdsfree(new->obuf);
 269         new->obuf = sdsdup(c->obuf);
 270         if (config.randomkeys) randomizeClientKey(c);
 271     }
 272 }
 273
 274 static int compareLatency(const void *a, const void *b) {
 275     return (*(long long*)a)-(*(long long*)b);
 276 }
 277
 278 static void showLatencyReport(void) {
 279     int i, curlat = 0;
 280     float perc, reqpersec;
 281
 282     reqpersec = (float)config.donerequests/((float)config.totlatency/1000);
 283     if (!config.quiet) {
 284         printf("====== %s ======\n", config.title);
 285         printf("  %d requests completed in %.2f seconds\n", config.donerequests,
 286             (float)config.totlatency/1000);
 287         printf("  %d parallel clients\n", config.numclients);
 288         printf("  %d bytes payload\n", config.datasize);
 289         printf("  keep alive: %d\n", config.keepalive);
 290         printf("\n");
 291
 292         qsort(config.latency,config.requests,sizeof(long long),compareLatency);
 293         for (i = 0; i < config.requests; i++) {
 294             if (config.latency[i]/1000 != curlat || i == (config.requests-1)) {
 295                 curlat = config.latency[i]/1000;
 296                 perc = ((float)(i+1)*100)/config.requests;
 297                 printf("%.2f%% <= %d milliseconds\n", perc, curlat);
 298             }
 299         }
 300         printf("%.2f requests per second\n\n", reqpersec);
 301     } else {
 302         printf("%s: %.2f requests per second\n", config.title, reqpersec);
 303     }
 304 }
 305
 306 static void prepareForBenchmark(char *title) {
 307     config.title = title;
 308     config.start = mstime();
 309     config.donerequests = 0;
 310 }
 311
 312 static void endBenchmark(void) {
 313     config.totlatency = mstime()-config.start;
 314     showLatencyReport();
 315     freeAllClients();
 316 }
 317
 318 void parseOptions(int argc, char **argv) {
 319     int i;
 320
 321     for (i = 1; i < argc; i++) {
 322         int lastarg = i==argc-1;
 323
 324         if (!strcmp(argv[i],"-c") && !lastarg) {
 325             config.numclients = atoi(argv[i+1]);
 326             i++;
 327         } else if (!strcmp(argv[i],"-n") && !lastarg) {
 328             config.requests = atoi(argv[i+1]);
 329             i++;
 330         } else if (!strcmp(argv[i],"-k") && !lastarg) {
 331             config.keepalive = atoi(argv[i+1]);
 332             i++;
 333         } else if (!strcmp(argv[i],"-h") && !lastarg) {
 334             config.hostip = argv[i+1];
 335             i++;
 336         } else if (!strcmp(argv[i],"-p") && !lastarg) {
 337             config.hostport = atoi(argv[i+1]);
 338             i++;
 339         } else if (!strcmp(argv[i],"-s") && !lastarg) {
 340             config.hostsocket = argv[i+1];
 341             i++;
 342         } else if (!strcmp(argv[i],"-d") && !lastarg) {
 343             config.datasize = atoi(argv[i+1]);
 344             i++;
 345             if (config.datasize < 1) config.datasize=1;
 346             if (config.datasize > 1024*1024) config.datasize = 1024*1024;
 347         } else if (!strcmp(argv[i],"-r") && !lastarg) {
 348             config.randomkeys = 1;
 349             config.randomkeys_keyspacelen = atoi(argv[i+1]);
 350             if (config.randomkeys_keyspacelen < 0)
 351                 config.randomkeys_keyspacelen = 0;
 352             i++;
 353         } else if (!strcmp(argv[i],"-q")) {
 354             config.quiet = 1;
 355         } else if (!strcmp(argv[i],"-l")) {
 356             config.loop = 1;
 357         } else if (!strcmp(argv[i],"-D")) {
 358             config.debug = 1;
 359         } else if (!strcmp(argv[i],"-I")) {
 360             config.idlemode = 1;
 361         } else {
 362             printf("Wrong option '%s' or option argument missing\n\n",argv[i]);
 363             printf("Usage: redis-benchmark [-h <host>] [-p <port>] [-c <clients>] [-n <requests]> [-k <boolean>]\n\n");
 364             printf(" -h <hostname>      Server hostname (default 127.0.0.1)\n");
 365             printf(" -p <port>          Server port (default 6379)\n");
 366             printf(" -s <socket>        Server socket (overrides host and port)\n");
 367             printf(" -c <clients>       Number of parallel connections (default 50)\n");
 368             printf(" -n <requests>      Total number of requests (default 10000)\n");
 369             printf(" -d <size>          Data size of SET/GET value in bytes (default 2)\n");
 370             printf(" -k <boolean>       1=keep alive 0=reconnect (default 1)\n");
 371             printf(" -r <keyspacelen>   Use random keys for SET/GET/INCR, random values for SADD\n");
 372             printf("  Using this option the benchmark will get/set keys\n");
 373             printf("  in the form mykey_rand000000012456 instead of constant\n");
 374             printf("  keys, the <keyspacelen> argument determines the max\n");
 375             printf("  number of values for the random number. For instance\n");
 376             printf("  if set to 10 only rand000000000000 - rand000000000009\n");
 377             printf("  range will be allowed.\n");
 378             printf(" -q                 Quiet. Just show query/sec values\n");
 379             printf(" -l                 Loop. Run the tests forever\n");
 380             printf(" -I                 Idle mode. Just open N idle connections and wait.\n");
 381             printf(" -D                 Debug mode. more verbose.\n");
 382             exit(1);
 383         }
 384     }
 385 }
 386
 387 int showThroughput(struct aeEventLoop *eventLoop, long long id, void *clientData) {
 388     REDIS_NOTUSED(eventLoop);
 389     REDIS_NOTUSED(id);
 390     REDIS_NOTUSED(clientData);
 391
 392     float dt = (float)(mstime()-config.start)/1000.0;
 393     float rps = (float)config.donerequests/dt;
 394     printf("%s: %.2f\r", config.title, rps);
 395     fflush(stdout);
 396     return 250; /* every 250ms */
 397 }
 398
 399 int main(int argc, char **argv) {
 400     int i;
 401     client c;
 402
 403     signal(SIGHUP, SIG_IGN);
 404     signal(SIGPIPE, SIG_IGN);
 405
 406     config.debug = 0;
 407     config.numclients = 50;
 408     config.requests = 10000;
 409     config.liveclients = 0;
 410     config.el = aeCreateEventLoop();
 411     aeCreateTimeEvent(config.el,1,showThroughput,NULL,NULL);
 412     config.keepalive = 1;
 413     config.donerequests = 0;
 414     config.datasize = 3;
 415     config.randomkeys = 0;
 416     config.randomkeys_keyspacelen = 0;
 417     config.quiet = 0;
 418     config.loop = 0;
 419     config.idlemode = 0;
 420     config.latency = NULL;
 421     config.clients = listCreate();
 422     config.hostip = "127.0.0.1";
 423     config.hostport = 6379;
 424     config.hostsocket = NULL;
 425
 426     parseOptions(argc,argv);
 427     config.latency = zmalloc(sizeof(long long)*config.requests);
 428
 429     if (config.keepalive == 0) {
 430         printf("WARNING: keepalive disabled, you probably need 'echo 1 > /proc/sys/net/ipv4/tcp_tw_reuse' for Linux and 'sudo sysctl -w net.inet.tcp.msl=1000' for Mac OS X in order to use a lot of clients/requests\n");
 431     }
 432
 433     if (config.idlemode) {
 434         printf("Creating %d idle connections and waiting forever (Ctrl+C when done)\n", config.numclients);
 435         prepareForBenchmark("IDLE");
 436         c = createClient(0); /* will never receive a reply */
 437         c->obuf = sdsempty();
 438         createMissingClients(c);
 439         aeMain(config.el);
 440         /* and will wait for every */
 441     }
 442
 443     do {
 444         char *data = zmalloc(config.datasize+1);
 445         memset(data,'x',config.datasize);
 446         data[config.datasize] = '\0';
 447
 448         prepareForBenchmark("PING");
 449         c = createClient(REDIS_REPLY_STATUS);
 450         c->obuf = sdscat(c->obuf,"PING\r\n");
 451         createMissingClients(c);
 452         aeMain(config.el);
 453         endBenchmark();
 454
 455         prepareForBenchmark("PING (multi bulk)");
 456         c = createClient(REDIS_REPLY_STATUS);
 457         c->obuf = sdscat(c->obuf,"*1\r\n$4\r\nPING\r\n");
 458         createMissingClients(c);
 459         aeMain(config.el);
 460         endBenchmark();
 461
 462         prepareForBenchmark("MSET (10 keys, multi bulk)");
 463         c = createClient(REDIS_REPLY_ARRAY);
 464         c->obuf = sdscatprintf(c->obuf,"*%d\r\n$4\r\nMSET\r\n", 11);
 465         for (i = 0; i < 10; i++) {
 466             c->obuf = sdscatprintf(c->obuf,"$%d\r\n%s\r\n",config.datasize,data);
 467         createMissingClients(c);
 468         aeMain(config.el);
 469         endBenchmark();
 470
 471         prepareForBenchmark("SET");
 472         c = createClient(REDIS_REPLY_STATUS);
 473         c->obuf = sdscat(c->obuf,"*3\r\n$3\r\nSET\r\n$20\r\nfoo_rand000000000000\r\n");
 474         c->obuf = sdscatprintf(c->obuf,"$%d\r\n%s\r\n",config.datasize,data);
 475         createMissingClients(c);
 476         aeMain(config.el);
 477         endBenchmark();
 478
 479         prepareForBenchmark("GET");
 480         c = createClient(REDIS_REPLY_STRING);
 481         c->obuf = sdscat(c->obuf,"GET foo_rand000000000000\r\n");
 482         createMissingClients(c);
 483         aeMain(config.el);
 484         endBenchmark();
 485
 486         prepareForBenchmark("INCR");
 487         c = createClient(REDIS_REPLY_INTEGER);
 488         c->obuf = sdscat(c->obuf,"INCR counter_rand000000000000\r\n");
 489         createMissingClients(c);
 490         aeMain(config.el);
 491         endBenchmark();
 492
 493         prepareForBenchmark("LPUSH");
 494         c = createClient(REDIS_REPLY_INTEGER);
 495         c->obuf = sdscat(c->obuf,"LPUSH mylist bar\r\n");
 496         createMissingClients(c);
 497         aeMain(config.el);
 498         endBenchmark();
 499
 500         prepareForBenchmark("LPOP");
 501         c = createClient(REDIS_REPLY_STRING);
 502         c->obuf = sdscat(c->obuf,"LPOP mylist\r\n");
 503         createMissingClients(c);
 504         aeMain(config.el);
 505         endBenchmark();
 506
 507         prepareForBenchmark("SADD");
 508         c = createClient(REDIS_REPLY_STATUS);
 509         c->obuf = sdscat(c->obuf,"SADD myset counter_rand000000000000\r\n");
 510         createMissingClients(c);
 511         aeMain(config.el);
 512         endBenchmark();
 513
 514         prepareForBenchmark("SPOP");
 515         c = createClient(REDIS_REPLY_STRING);
 516         c->obuf = sdscat(c->obuf,"SPOP myset\r\n");
 517         createMissingClients(c);
 518         aeMain(config.el);
 519         endBenchmark();
 520
 521         prepareForBenchmark("LPUSH (again, in order to bench LRANGE)");
 522         c = createClient(REDIS_REPLY_STATUS);
 523         c->obuf = sdscat(c->obuf,"LPUSH mylist bar\r\n");
 524         createMissingClients(c);
 525         aeMain(config.el);
 526         endBenchmark();
 527
 528         prepareForBenchmark("LRANGE (first 100 elements)");
 529         c = createClient(REDIS_REPLY_ARRAY);
 530         c->obuf = sdscat(c->obuf,"LRANGE mylist 0 99\r\n");
 531         createMissingClients(c);
 532         aeMain(config.el);
 533         endBenchmark();
 534
 535         prepareForBenchmark("LRANGE (first 300 elements)");
 536         c = createClient(REDIS_REPLY_ARRAY);
 537         c->obuf = sdscat(c->obuf,"LRANGE mylist 0 299\r\n");
 538         createMissingClients(c);
 539         aeMain(config.el);
 540         endBenchmark();
 541
 542         prepareForBenchmark("LRANGE (first 450 elements)");
 543         c = createClient(REDIS_REPLY_ARRAY);
 544         c->obuf = sdscat(c->obuf,"LRANGE mylist 0 449\r\n");
 545         createMissingClients(c);
 546         aeMain(config.el);
 547         endBenchmark();
 548
 549         prepareForBenchmark("LRANGE (first 600 elements)");
 550         c = createClient(REDIS_REPLY_ARRAY);
 551         c->obuf = sdscat(c->obuf,"LRANGE mylist 0 599\r\n");
 552         createMissingClients(c);
 553         aeMain(config.el);
 554         endBenchmark();
 555
 556         printf("\n");
 557     } while(config.loop);
 558
 559     return 0;
 560 }