]> git.saurik.com Git - redis.git/blob - src/redis-benchmark.c
redis-benchmark: ability to run selected tests. Better help with examples.
[redis.git] / 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 REDIS_NOTUSED(V) ((void) V)
49
50 static struct config {
51 aeEventLoop *el;
52 const char *hostip;
53 int hostport;
54 const char *hostsocket;
55 int numclients;
56 int liveclients;
57 int requests;
58 int requests_issued;
59 int requests_finished;
60 int keysize;
61 int datasize;
62 int randomkeys;
63 int randomkeys_keyspacelen;
64 int keepalive;
65 long long start;
66 long long totlatency;
67 long long *latency;
68 const char *title;
69 list *clients;
70 int quiet;
71 int csv;
72 int loop;
73 int idlemode;
74 char *tests;
75 } config;
76
77 typedef struct _client {
78 redisContext *context;
79 sds obuf;
80 char *randptr[10]; /* needed for MSET against 10 keys */
81 size_t randlen;
82 unsigned int written; /* bytes of 'obuf' already written */
83 long long start; /* start time of a request */
84 long long latency; /* request latency */
85 } *client;
86
87 /* Prototypes */
88 static void writeHandler(aeEventLoop *el, int fd, void *privdata, int mask);
89 static void createMissingClients(client c);
90
91 /* Implementation */
92 static long long ustime(void) {
93 struct timeval tv;
94 long long ust;
95
96 gettimeofday(&tv, NULL);
97 ust = ((long)tv.tv_sec)*1000000;
98 ust += tv.tv_usec;
99 return ust;
100 }
101
102 static long long mstime(void) {
103 struct timeval tv;
104 long long mst;
105
106 gettimeofday(&tv, NULL);
107 mst = ((long)tv.tv_sec)*1000;
108 mst += tv.tv_usec/1000;
109 return mst;
110 }
111
112 static void freeClient(client c) {
113 listNode *ln;
114 aeDeleteFileEvent(config.el,c->context->fd,AE_WRITABLE);
115 aeDeleteFileEvent(config.el,c->context->fd,AE_READABLE);
116 redisFree(c->context);
117 sdsfree(c->obuf);
118 zfree(c);
119 config.liveclients--;
120 ln = listSearchKey(config.clients,c);
121 assert(ln != NULL);
122 listDelNode(config.clients,ln);
123 }
124
125 static void freeAllClients(void) {
126 listNode *ln = config.clients->head, *next;
127
128 while(ln) {
129 next = ln->next;
130 freeClient(ln->value);
131 ln = next;
132 }
133 }
134
135 static void resetClient(client c) {
136 aeDeleteFileEvent(config.el,c->context->fd,AE_WRITABLE);
137 aeDeleteFileEvent(config.el,c->context->fd,AE_READABLE);
138 aeCreateFileEvent(config.el,c->context->fd,AE_WRITABLE,writeHandler,c);
139 c->written = 0;
140 }
141
142 static void randomizeClientKey(client c) {
143 char buf[32];
144 size_t i, r;
145
146 for (i = 0; i < c->randlen; i++) {
147 r = random() % config.randomkeys_keyspacelen;
148 snprintf(buf,sizeof(buf),"%012zu",r);
149 memcpy(c->randptr[i],buf,12);
150 }
151 }
152
153 static void clientDone(client c) {
154 if (config.requests_finished == config.requests) {
155 freeClient(c);
156 aeStop(config.el);
157 return;
158 }
159 if (config.keepalive) {
160 resetClient(c);
161 } else {
162 config.liveclients--;
163 createMissingClients(c);
164 config.liveclients++;
165 freeClient(c);
166 }
167 }
168
169 static void readHandler(aeEventLoop *el, int fd, void *privdata, int mask) {
170 client c = privdata;
171 void *reply = NULL;
172 REDIS_NOTUSED(el);
173 REDIS_NOTUSED(fd);
174 REDIS_NOTUSED(mask);
175
176 /* Calculate latency only for the first read event. This means that the
177 * server already sent the reply and we need to parse it. Parsing overhead
178 * is not part of the latency, so calculate it only once, here. */
179 if (c->latency < 0) c->latency = ustime()-(c->start);
180
181 if (redisBufferRead(c->context) != REDIS_OK) {
182 fprintf(stderr,"Error: %s\n",c->context->errstr);
183 exit(1);
184 } else {
185 if (redisGetReply(c->context,&reply) != REDIS_OK) {
186 fprintf(stderr,"Error: %s\n",c->context->errstr);
187 exit(1);
188 }
189 if (reply != NULL) {
190 if (reply == (void*)REDIS_REPLY_ERROR) {
191 fprintf(stderr,"Unexpected error reply, exiting...\n");
192 exit(1);
193 }
194
195 if (config.requests_finished < config.requests)
196 config.latency[config.requests_finished++] = c->latency;
197 clientDone(c);
198 }
199 }
200 }
201
202 static void writeHandler(aeEventLoop *el, int fd, void *privdata, int mask) {
203 client c = privdata;
204 REDIS_NOTUSED(el);
205 REDIS_NOTUSED(fd);
206 REDIS_NOTUSED(mask);
207
208 /* Initialize request when nothing was written. */
209 if (c->written == 0) {
210 /* Enforce upper bound to number of requests. */
211 if (config.requests_issued++ >= config.requests) {
212 freeClient(c);
213 return;
214 }
215
216 /* Really initialize: randomize keys and set start time. */
217 if (config.randomkeys) randomizeClientKey(c);
218 c->start = ustime();
219 c->latency = -1;
220 }
221
222 if (sdslen(c->obuf) > c->written) {
223 void *ptr = c->obuf+c->written;
224 int nwritten = write(c->context->fd,ptr,sdslen(c->obuf)-c->written);
225 if (nwritten == -1) {
226 if (errno != EPIPE)
227 fprintf(stderr, "Writing to socket: %s\n", strerror(errno));
228 freeClient(c);
229 return;
230 }
231 c->written += nwritten;
232 if (sdslen(c->obuf) == c->written) {
233 aeDeleteFileEvent(config.el,c->context->fd,AE_WRITABLE);
234 aeCreateFileEvent(config.el,c->context->fd,AE_READABLE,readHandler,c);
235 }
236 }
237 }
238
239 static client createClient(const char *cmd, size_t len) {
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->obuf = sdsnewlen(cmd,len);
255 c->randlen = 0;
256 c->written = 0;
257
258 /* Find substrings in the output buffer that need to be randomized. */
259 if (config.randomkeys) {
260 char *p = c->obuf, *newline;
261 while ((p = strstr(p,":rand:")) != NULL) {
262 newline = strstr(p,"\r\n");
263 assert(newline-(p+6) == 12); /* 12 chars for randomness */
264 assert(c->randlen < (signed)(sizeof(c->randptr)/sizeof(char*)));
265 c->randptr[c->randlen++] = p+6;
266 p = newline+2;
267 }
268 }
269
270 redisSetReplyObjectFunctions(c->context,NULL);
271 aeCreateFileEvent(config.el,c->context->fd,AE_WRITABLE,writeHandler,c);
272 listAddNodeTail(config.clients,c);
273 config.liveclients++;
274 return c;
275 }
276
277 static void createMissingClients(client c) {
278 int n = 0;
279
280 while(config.liveclients < config.numclients) {
281 createClient(c->obuf,sdslen(c->obuf));
282
283 /* Listen backlog is quite limited on most systems */
284 if (++n > 64) {
285 usleep(50000);
286 n = 0;
287 }
288 }
289 }
290
291 static int compareLatency(const void *a, const void *b) {
292 return (*(long long*)a)-(*(long long*)b);
293 }
294
295 static void showLatencyReport(void) {
296 int i, curlat = 0;
297 float perc, reqpersec;
298
299 reqpersec = (float)config.requests_finished/((float)config.totlatency/1000);
300 if (!config.quiet && !config.csv) {
301 printf("====== %s ======\n", config.title);
302 printf(" %d requests completed in %.2f seconds\n", config.requests_finished,
303 (float)config.totlatency/1000);
304 printf(" %d parallel clients\n", config.numclients);
305 printf(" %d bytes payload\n", config.datasize);
306 printf(" keep alive: %d\n", config.keepalive);
307 printf("\n");
308
309 qsort(config.latency,config.requests,sizeof(long long),compareLatency);
310 for (i = 0; i < config.requests; i++) {
311 if (config.latency[i]/1000 != curlat || i == (config.requests-1)) {
312 curlat = config.latency[i]/1000;
313 perc = ((float)(i+1)*100)/config.requests;
314 printf("%.2f%% <= %d milliseconds\n", perc, curlat);
315 }
316 }
317 printf("%.2f requests per second\n\n", reqpersec);
318 } else if (config.csv) {
319 printf("\"%s\",\"%.2f\"\n", config.title, reqpersec);
320 } else {
321 printf("%s: %.2f requests per second\n", config.title, reqpersec);
322 }
323 }
324
325 static void benchmark(const char *title, const char *cmd, int len) {
326 client c;
327
328 config.title = title;
329 config.requests_issued = 0;
330 config.requests_finished = 0;
331
332 c = createClient(cmd,len);
333 createMissingClients(c);
334
335 config.start = mstime();
336 aeMain(config.el);
337 config.totlatency = mstime()-config.start;
338
339 showLatencyReport();
340 freeAllClients();
341 }
342
343 /* Returns number of consumed options. */
344 int parseOptions(int argc, const char **argv) {
345 int i;
346 int lastarg;
347 int exit_status = 1;
348
349 for (i = 1; i < argc; i++) {
350 lastarg = (i == (argc-1));
351
352 if (!strcmp(argv[i],"-c")) {
353 if (lastarg) goto invalid;
354 config.numclients = atoi(argv[++i]);
355 } else if (!strcmp(argv[i],"-n")) {
356 if (lastarg) goto invalid;
357 config.requests = atoi(argv[++i]);
358 } else if (!strcmp(argv[i],"-k")) {
359 if (lastarg) goto invalid;
360 config.keepalive = atoi(argv[++i]);
361 } else if (!strcmp(argv[i],"-h")) {
362 if (lastarg) goto invalid;
363 config.hostip = strdup(argv[++i]);
364 } else if (!strcmp(argv[i],"-p")) {
365 if (lastarg) goto invalid;
366 config.hostport = atoi(argv[++i]);
367 } else if (!strcmp(argv[i],"-s")) {
368 if (lastarg) goto invalid;
369 config.hostsocket = strdup(argv[++i]);
370 } else if (!strcmp(argv[i],"-d")) {
371 if (lastarg) goto invalid;
372 config.datasize = atoi(argv[++i]);
373 if (config.datasize < 1) config.datasize=1;
374 if (config.datasize > 1024*1024*1024) config.datasize = 1024*1024*1024;
375 } else if (!strcmp(argv[i],"-r")) {
376 if (lastarg) goto invalid;
377 config.randomkeys = 1;
378 config.randomkeys_keyspacelen = atoi(argv[++i]);
379 if (config.randomkeys_keyspacelen < 0)
380 config.randomkeys_keyspacelen = 0;
381 } else if (!strcmp(argv[i],"-q")) {
382 config.quiet = 1;
383 } else if (!strcmp(argv[i],"--csv")) {
384 config.csv = 1;
385 } else if (!strcmp(argv[i],"-l")) {
386 config.loop = 1;
387 } else if (!strcmp(argv[i],"-I")) {
388 config.idlemode = 1;
389 } else if (!strcmp(argv[i],"-t")) {
390 if (lastarg) goto invalid;
391 /* We get the list of tests to run as a string in the form
392 * get,set,lrange,...,test_N. Then we add a comma before and
393 * after the string in order to make sure that searching
394 * for ",testname," will always get a match if the test is
395 * enabled. */
396 config.tests = sdsnew(",");
397 config.tests = sdscat(config.tests,(char*)argv[++i]);
398 config.tests = sdscat(config.tests,",");
399 sdstolower(config.tests);
400 } else if (!strcmp(argv[i],"--help")) {
401 exit_status = 0;
402 goto usage;
403 } else {
404 /* Assume the user meant to provide an option when the arg starts
405 * with a dash. We're done otherwise and should use the remainder
406 * as the command and arguments for running the benchmark. */
407 if (argv[i][0] == '-') goto invalid;
408 return i;
409 }
410 }
411
412 return i;
413
414 invalid:
415 printf("Invalid option \"%s\" or option argument missing\n\n",argv[i]);
416
417 usage:
418 printf(
419 "Usage: redis-benchmark [-h <host>] [-p <port>] [-c <clients>] [-n <requests]> [-k <boolean>]\n\n"
420 " -h <hostname> Server hostname (default 127.0.0.1)\n"
421 " -p <port> Server port (default 6379)\n"
422 " -s <socket> Server socket (overrides host and port)\n"
423 " -c <clients> Number of parallel connections (default 50)\n"
424 " -n <requests> Total number of requests (default 10000)\n"
425 " -d <size> Data size of SET/GET value in bytes (default 2)\n"
426 " -k <boolean> 1=keep alive 0=reconnect (default 1)\n"
427 " -r <keyspacelen> Use random keys for SET/GET/INCR, random values for SADD\n"
428 " Using this option the benchmark will get/set keys\n"
429 " in the form mykey_rand000000012456 instead of constant\n"
430 " keys, the <keyspacelen> argument determines the max\n"
431 " number of values for the random number. For instance\n"
432 " if set to 10 only rand000000000000 - rand000000000009\n"
433 " range will be allowed.\n"
434 " -q Quiet. Just show query/sec values\n"
435 " --csv Output in CSV format\n"
436 " -l Loop. Run the tests forever\n"
437 " -t <tests> Only run the comma separated list of tests. The test\n"
438 " names are the same as the ones produced as output.\n"
439 " -I Idle mode. Just open N idle connections and wait.\n\n"
440 "Examples:\n\n"
441 " Run the benchmark with the default configuration against 127.0.0.1:6379:\n"
442 " $ redis-benchmark\n\n"
443 " Use 20 parallel clients, for a total of 100k requests, against 192.168.1.1:\n"
444 " $ redis-benchmark -h 192.168.1.1 -p 6379 -n 100000 -c 20\n\n"
445 " Fill 127.0.0.1:6379 with about 1 million keys only using the SET test:\n"
446 " $ redis-benchmark -t set -n 1000000 -r 100000000\n\n"
447 " Benchmark 127.0.0.1:6379 for a few commands producing CSV output:\n"
448 " $ redis-benchmark -t ping,set,get -n 100000 --csv\n\n"
449 );
450 exit(exit_status);
451 }
452
453 int showThroughput(struct aeEventLoop *eventLoop, long long id, void *clientData) {
454 REDIS_NOTUSED(eventLoop);
455 REDIS_NOTUSED(id);
456 REDIS_NOTUSED(clientData);
457
458 if (config.csv) return 250;
459 float dt = (float)(mstime()-config.start)/1000.0;
460 float rps = (float)config.requests_finished/dt;
461 printf("%s: %.2f\r", config.title, rps);
462 fflush(stdout);
463 return 250; /* every 250ms */
464 }
465
466 /* Return true if the named test was selected using the -t command line
467 * switch, or if all the tests are selected (no -t passed by user). */
468 int test_is_selected(char *name) {
469 char buf[256];
470 int l = strlen(name);
471
472 if (config.tests == NULL) return 1;
473 buf[0] = ',';
474 memcpy(buf+1,name,l);
475 buf[l+1] = ',';
476 buf[l+2] = '\0';
477 return strstr(config.tests,buf) != NULL;
478 }
479
480 int main(int argc, const char **argv) {
481 int i;
482 char *data, *cmd;
483 int len;
484
485 client c;
486
487 signal(SIGHUP, SIG_IGN);
488 signal(SIGPIPE, SIG_IGN);
489
490 config.numclients = 50;
491 config.requests = 10000;
492 config.liveclients = 0;
493 config.el = aeCreateEventLoop();
494 aeCreateTimeEvent(config.el,1,showThroughput,NULL,NULL);
495 config.keepalive = 1;
496 config.datasize = 3;
497 config.randomkeys = 0;
498 config.randomkeys_keyspacelen = 0;
499 config.quiet = 0;
500 config.csv = 0;
501 config.loop = 0;
502 config.idlemode = 0;
503 config.latency = NULL;
504 config.clients = listCreate();
505 config.hostip = "127.0.0.1";
506 config.hostport = 6379;
507 config.hostsocket = NULL;
508 config.tests = NULL;
509
510 i = parseOptions(argc,argv);
511 argc -= i;
512 argv += i;
513
514 config.latency = zmalloc(sizeof(long long)*config.requests);
515
516 if (config.keepalive == 0) {
517 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");
518 }
519
520 if (config.idlemode) {
521 printf("Creating %d idle connections and waiting forever (Ctrl+C when done)\n", config.numclients);
522 c = createClient("",0); /* will never receive a reply */
523 createMissingClients(c);
524 aeMain(config.el);
525 /* and will wait for every */
526 }
527
528 /* Run benchmark with command in the remainder of the arguments. */
529 if (argc) {
530 sds title = sdsnew(argv[0]);
531 for (i = 1; i < argc; i++) {
532 title = sdscatlen(title, " ", 1);
533 title = sdscatlen(title, (char*)argv[i], strlen(argv[i]));
534 }
535
536 do {
537 len = redisFormatCommandArgv(&cmd,argc,argv,NULL);
538 benchmark(title,cmd,len);
539 free(cmd);
540 } while(config.loop);
541
542 return 0;
543 }
544
545 /* Run default benchmark suite. */
546 do {
547 data = zmalloc(config.datasize+1);
548 memset(data,'x',config.datasize);
549 data[config.datasize] = '\0';
550
551 if (test_is_selected("ping_inline") || test_is_selected("ping"))
552 benchmark("PING_INLINE","PING\r\n",6);
553
554 if (test_is_selected("ping_mbulk") || test_is_selected("ping")) {
555 len = redisFormatCommand(&cmd,"PING");
556 benchmark("PING_BULK",cmd,len);
557 free(cmd);
558 }
559
560 if (test_is_selected("set")) {
561 len = redisFormatCommand(&cmd,"SET foo:rand:000000000000 %s",data);
562 benchmark("SET",cmd,len);
563 free(cmd);
564 }
565
566 if (test_is_selected("get")) {
567 len = redisFormatCommand(&cmd,"GET foo:rand:000000000000");
568 benchmark("GET",cmd,len);
569 free(cmd);
570 }
571
572 if (test_is_selected("incr")) {
573 len = redisFormatCommand(&cmd,"INCR counter:rand:000000000000");
574 benchmark("INCR",cmd,len);
575 free(cmd);
576 }
577
578 if (test_is_selected("lpush")) {
579 len = redisFormatCommand(&cmd,"LPUSH mylist %s",data);
580 benchmark("LPUSH",cmd,len);
581 free(cmd);
582 }
583
584 if (test_is_selected("lpop")) {
585 len = redisFormatCommand(&cmd,"LPOP mylist");
586 benchmark("LPOP",cmd,len);
587 free(cmd);
588 }
589
590 if (test_is_selected("sadd")) {
591 len = redisFormatCommand(&cmd,
592 "SADD myset counter:rand:000000000000");
593 benchmark("SADD",cmd,len);
594 free(cmd);
595 }
596
597 if (test_is_selected("spop")) {
598 len = redisFormatCommand(&cmd,"SPOP myset");
599 benchmark("SPOP",cmd,len);
600 free(cmd);
601 }
602
603 if (test_is_selected("lrange") ||
604 test_is_selected("lrange_100") ||
605 test_is_selected("lrange_300") ||
606 test_is_selected("lrange_500") ||
607 test_is_selected("lrange_600"))
608 {
609 len = redisFormatCommand(&cmd,"LPUSH mylist %s",data);
610 benchmark("LPUSH (needed to benchmark LRANGE)",cmd,len);
611 free(cmd);
612 }
613
614 if (test_is_selected("lrange") || test_is_selected("lrange_100")) {
615 len = redisFormatCommand(&cmd,"LRANGE mylist 0 99");
616 benchmark("LRANGE_100 (first 100 elements)",cmd,len);
617 free(cmd);
618 }
619
620 if (test_is_selected("lrange") || test_is_selected("lrange_300")) {
621 len = redisFormatCommand(&cmd,"LRANGE mylist 0 299");
622 benchmark("LRANGE_300 (first 300 elements)",cmd,len);
623 free(cmd);
624 }
625
626 if (test_is_selected("lrange") || test_is_selected("lrange_500")) {
627 len = redisFormatCommand(&cmd,"LRANGE mylist 0 449");
628 benchmark("LRANGE_500 (first 450 elements)",cmd,len);
629 free(cmd);
630 }
631
632 if (test_is_selected("lrange") || test_is_selected("lrange_600")) {
633 len = redisFormatCommand(&cmd,"LRANGE mylist 0 599");
634 benchmark("LRANGE_600 (first 600 elements)",cmd,len);
635 free(cmd);
636 }
637
638 if (test_is_selected("mset")) {
639 const char *argv[21];
640 argv[0] = "MSET";
641 for (i = 1; i < 21; i += 2) {
642 argv[i] = "foo:rand:000000000000";
643 argv[i+1] = data;
644 }
645 len = redisFormatCommandArgv(&cmd,21,argv,NULL);
646 benchmark("MSET (10 keys)",cmd,len);
647 free(cmd);
648 }
649
650 if (!config.csv) printf("\n");
651 } while(config.loop);
652
653 return 0;
654 }