]>
git.saurik.com Git - redis.git/blob - src/redis-benchmark.c
1 /* Redis benchmark utility.
3 * Copyright (c) 2009-2010, Salvatore Sanfilippo <antirez at gmail dot com>
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
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.
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.
48 #define REDIS_NOTUSED(V) ((void) V)
50 static struct config
{
54 const char * hostsocket
;
59 int requests_finished
;
63 int randomkeys_keyspacelen
;
78 typedef struct _client
{
79 redisContext
* context
;
81 char * randptr
[ 32 ]; /* needed for MSET against 10 keys */
83 unsigned int written
; /* bytes of 'obuf' already written */
84 long long start
; /* start time of a request */
85 long long latency
; /* request latency */
86 int pending
; /* Number of pending requests (sent but no reply received) */
90 static void writeHandler ( aeEventLoop
* el
, int fd
, void * privdata
, int mask
);
91 static void createMissingClients ( client c
);
94 static long long ustime ( void ) {
98 gettimeofday (& tv
, NULL
);
99 ust
= (( long ) tv
. tv_sec
)* 1000000 ;
104 static long long mstime ( void ) {
108 gettimeofday (& tv
, NULL
);
109 mst
= (( long ) tv
. tv_sec
)* 1000 ;
110 mst
+= tv
. tv_usec
/ 1000 ;
114 static void freeClient ( client c
) {
116 aeDeleteFileEvent ( config
. el
, c
-> context
-> fd
, AE_WRITABLE
);
117 aeDeleteFileEvent ( config
. el
, c
-> context
-> fd
, AE_READABLE
);
118 redisFree ( c
-> context
);
121 config
. liveclients
--;
122 ln
= listSearchKey ( config
. clients
, c
);
124 listDelNode ( config
. clients
, ln
);
127 static void freeAllClients ( void ) {
128 listNode
* ln
= config
. clients
-> head
, * next
;
132 freeClient ( ln
-> value
);
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
);
142 c
-> pending
= config
. pipeline
;
145 static void randomizeClientKey ( client c
) {
149 for ( i
= 0 ; i
< c
-> randlen
; i
++) {
150 r
= random () % config
. randomkeys_keyspacelen
;
151 snprintf ( buf
, sizeof ( buf
), " %0 12zu" , r
);
152 memcpy ( c
-> randptr
[ i
], buf
, 12 );
156 static void clientDone ( client c
) {
157 if ( config
. requests_finished
== config
. requests
) {
162 if ( config
. keepalive
) {
165 config
. liveclients
--;
166 createMissingClients ( c
);
167 config
. liveclients
++;
172 static void readHandler ( aeEventLoop
* el
, int fd
, void * privdata
, int mask
) {
179 /* Calculate latency only for the first read event. This means that the
180 * server already sent the reply and we need to parse it. Parsing overhead
181 * is not part of the latency, so calculate it only once, here. */
182 if ( c
-> latency
< 0 ) c
-> latency
= ustime ()-( c
-> start
);
184 if ( redisBufferRead ( c
-> context
) != REDIS_OK
) {
185 fprintf ( stderr
, "Error: %s \n " , c
-> context
-> errstr
);
189 if ( redisGetReply ( c
-> context
,& reply
) != REDIS_OK
) {
190 fprintf ( stderr
, "Error: %s \n " , c
-> context
-> errstr
);
194 if ( reply
== ( void *) REDIS_REPLY_ERROR
) {
195 fprintf ( stderr
, "Unexpected error reply, exiting... \n " );
199 freeReplyObject ( reply
);
201 if ( config
. requests_finished
< config
. requests
)
202 config
. latency
[ config
. requests_finished
++] = c
-> latency
;
204 if ( c
-> pending
== 0 ) clientDone ( c
);
212 static void writeHandler ( aeEventLoop
* el
, int fd
, void * privdata
, int mask
) {
218 /* Initialize request when nothing was written. */
219 if ( c
-> written
== 0 ) {
220 /* Enforce upper bound to number of requests. */
221 if ( config
. requests_issued
++ >= config
. requests
) {
226 /* Really initialize: randomize keys and set start time. */
227 if ( config
. randomkeys
) randomizeClientKey ( c
);
232 if ( sdslen ( c
-> obuf
) > c
-> written
) {
233 void * ptr
= c
-> obuf
+ c
-> written
;
234 int nwritten
= write ( c
-> context
-> fd
, ptr
, sdslen ( c
-> obuf
)- c
-> written
);
235 if ( nwritten
== - 1 ) {
237 fprintf ( stderr
, "Writing to socket: %s \n " , strerror ( errno
));
241 c
-> written
+= nwritten
;
242 if ( sdslen ( c
-> obuf
) == c
-> written
) {
243 aeDeleteFileEvent ( config
. el
, c
-> context
-> fd
, AE_WRITABLE
);
244 aeCreateFileEvent ( config
. el
, c
-> context
-> fd
, AE_READABLE
, readHandler
, c
);
249 static client
createClient ( char * cmd
, size_t len
) {
251 client c
= zmalloc ( sizeof ( struct _client
));
253 if ( config
. hostsocket
== NULL
) {
254 c
-> context
= redisConnectNonBlock ( config
. hostip
, config
. hostport
);
256 c
-> context
= redisConnectUnixNonBlock ( config
. hostsocket
);
258 if ( c
-> context
-> err
) {
259 fprintf ( stderr
, "Could not connect to Redis at " );
260 if ( config
. hostsocket
== NULL
)
261 fprintf ( stderr
, " %s : %d : %s \n " , config
. hostip
, config
. hostport
, c
-> context
-> errstr
);
263 fprintf ( stderr
, " %s : %s \n " , config
. hostsocket
, c
-> context
-> errstr
);
266 /* Suppress hiredis cleanup of unused buffers for max speed. */
267 c
-> context
-> reader
-> maxbuf
= 0 ;
268 /* Queue N requests accordingly to the pipeline size. */
269 c
-> obuf
= sdsempty ();
270 for ( j
= 0 ; j
< config
. pipeline
; j
++)
271 c
-> obuf
= sdscatlen ( c
-> obuf
, cmd
, len
);
274 c
-> pending
= config
. pipeline
;
276 /* Find substrings in the output buffer that need to be randomized. */
277 if ( config
. randomkeys
) {
279 while (( p
= strstr ( p
, ":rand:" )) != NULL
) {
280 assert ( c
-> randlen
< ( signed )( sizeof ( c
-> randptr
)/ sizeof ( char *)));
281 c
-> randptr
[ c
-> randlen
++] = p
+ 6 ;
286 /* redisSetReplyObjectFunctions(c->context,NULL); */
287 aeCreateFileEvent ( config
. el
, c
-> context
-> fd
, AE_WRITABLE
, writeHandler
, c
);
288 listAddNodeTail ( config
. clients
, c
);
289 config
. liveclients
++;
293 static void createMissingClients ( client c
) {
296 while ( config
. liveclients
< config
. numclients
) {
297 createClient ( c
-> obuf
, sdslen ( c
-> obuf
)/ config
. pipeline
);
299 /* Listen backlog is quite limited on most systems */
307 static int compareLatency ( const void * a
, const void * b
) {
308 return (*( long long *) a
)-(*( long long *) b
);
311 static void showLatencyReport ( void ) {
313 float perc
, reqpersec
;
315 reqpersec
= ( float ) config
. requests_finished
/(( float ) config
. totlatency
/ 1000 );
316 if (! config
. quiet
&& ! config
. csv
) {
317 printf ( "====== %s ====== \n " , config
. title
);
318 printf ( " %d requests completed in %.2f seconds \n " , config
. requests_finished
,
319 ( float ) config
. totlatency
/ 1000 );
320 printf ( " %d parallel clients \n " , config
. numclients
);
321 printf ( " %d bytes payload \n " , config
. datasize
);
322 printf ( " keep alive: %d \n " , config
. keepalive
);
325 qsort ( config
. latency
, config
. requests
, sizeof ( long long ), compareLatency
);
326 for ( i
= 0 ; i
< config
. requests
; i
++) {
327 if ( config
. latency
[ i
]/ 1000 != curlat
|| i
== ( config
. requests
- 1 )) {
328 curlat
= config
. latency
[ i
]/ 1000 ;
329 perc
= (( float )( i
+ 1 )* 100 )/ config
. requests
;
330 printf ( "%.2f%% <= %d milliseconds \n " , perc
, curlat
);
333 printf ( "%.2f requests per second \n\n " , reqpersec
);
334 } else if ( config
. csv
) {
335 printf ( " \" %s \" , \" %.2f \"\n " , config
. title
, reqpersec
);
337 printf ( " %s : %.2f requests per second \n " , config
. title
, reqpersec
);
341 static void benchmark ( char * title
, char * cmd
, int len
) {
344 config
. title
= title
;
345 config
. requests_issued
= 0 ;
346 config
. requests_finished
= 0 ;
348 c
= createClient ( cmd
, len
);
349 createMissingClients ( c
);
351 config
. start
= mstime ();
353 config
. totlatency
= mstime ()- config
. start
;
359 /* Returns number of consumed options. */
360 int parseOptions ( int argc
, const char ** argv
) {
365 for ( i
= 1 ; i
< argc
; i
++) {
366 lastarg
= ( i
== ( argc
- 1 ));
368 if (! strcmp ( argv
[ i
], "-c" )) {
369 if ( lastarg
) goto invalid
;
370 config
. numclients
= atoi ( argv
[++ i
]);
371 } else if (! strcmp ( argv
[ i
], "-n" )) {
372 if ( lastarg
) goto invalid
;
373 config
. requests
= atoi ( argv
[++ i
]);
374 } else if (! strcmp ( argv
[ i
], "-k" )) {
375 if ( lastarg
) goto invalid
;
376 config
. keepalive
= atoi ( argv
[++ i
]);
377 } else if (! strcmp ( argv
[ i
], "-h" )) {
378 if ( lastarg
) goto invalid
;
379 config
. hostip
= strdup ( argv
[++ i
]);
380 } else if (! strcmp ( argv
[ i
], "-p" )) {
381 if ( lastarg
) goto invalid
;
382 config
. hostport
= atoi ( argv
[++ i
]);
383 } else if (! strcmp ( argv
[ i
], "-s" )) {
384 if ( lastarg
) goto invalid
;
385 config
. hostsocket
= strdup ( argv
[++ i
]);
386 } else if (! strcmp ( argv
[ i
], "-d" )) {
387 if ( lastarg
) goto invalid
;
388 config
. datasize
= atoi ( argv
[++ i
]);
389 if ( config
. datasize
< 1 ) config
. datasize
= 1 ;
390 if ( config
. datasize
> 1024 * 1024 * 1024 ) config
. datasize
= 1024 * 1024 * 1024 ;
391 } else if (! strcmp ( argv
[ i
], "-P" )) {
392 if ( lastarg
) goto invalid
;
393 config
. pipeline
= atoi ( argv
[++ i
]);
394 if ( config
. pipeline
<= 0 ) config
. pipeline
= 1 ;
395 } else if (! strcmp ( argv
[ i
], "-r" )) {
396 if ( lastarg
) goto invalid
;
397 config
. randomkeys
= 1 ;
398 config
. randomkeys_keyspacelen
= atoi ( argv
[++ i
]);
399 if ( config
. randomkeys_keyspacelen
< 0 )
400 config
. randomkeys_keyspacelen
= 0 ;
401 } else if (! strcmp ( argv
[ i
], "-q" )) {
403 } else if (! strcmp ( argv
[ i
], "--csv" )) {
405 } else if (! strcmp ( argv
[ i
], "-l" )) {
407 } else if (! strcmp ( argv
[ i
], "-I" )) {
409 } else if (! strcmp ( argv
[ i
], "-t" )) {
410 if ( lastarg
) goto invalid
;
411 /* We get the list of tests to run as a string in the form
412 * get,set,lrange,...,test_N. Then we add a comma before and
413 * after the string in order to make sure that searching
414 * for ",testname," will always get a match if the test is
416 config
. tests
= sdsnew ( "," );
417 config
. tests
= sdscat ( config
. tests
,( char *) argv
[++ i
]);
418 config
. tests
= sdscat ( config
. tests
, "," );
419 sdstolower ( config
. tests
);
420 } else if (! strcmp ( argv
[ i
], "--help" )) {
424 /* Assume the user meant to provide an option when the arg starts
425 * with a dash. We're done otherwise and should use the remainder
426 * as the command and arguments for running the benchmark. */
427 if ( argv
[ i
][ 0 ] == '-' ) goto invalid
;
435 printf ( "Invalid option \" %s \" or option argument missing \n\n " , argv
[ i
]);
439 "Usage: redis-benchmark [-h <host>] [-p <port>] [-c <clients>] [-n <requests]> [-k <boolean>] \n\n "
440 " -h <hostname> Server hostname (default 127.0.0.1) \n "
441 " -p <port> Server port (default 6379) \n "
442 " -s <socket> Server socket (overrides host and port) \n "
443 " -c <clients> Number of parallel connections (default 50) \n "
444 " -n <requests> Total number of requests (default 10000) \n "
445 " -d <size> Data size of SET/GET value in bytes (default 2) \n "
446 " -k <boolean> 1=keep alive 0=reconnect (default 1) \n "
447 " -r <keyspacelen> Use random keys for SET/GET/INCR, random values for SADD \n "
448 " Using this option the benchmark will get/set keys \n "
449 " in the form mykey_rand:000000012456 instead of constant \n "
450 " keys, the <keyspacelen> argument determines the max \n "
451 " number of values for the random number. For instance \n "
452 " if set to 10 only rand:000000000000 - rand:000000000009 \n "
453 " range will be allowed. \n "
454 " -P <numreq> Pipeline <numreq> requests. Default 1 (no pipeline). \n "
455 " -q Quiet. Just show query/sec values \n "
456 " --csv Output in CSV format \n "
457 " -l Loop. Run the tests forever \n "
458 " -t <tests> Only run the comma separated list of tests. The test \n "
459 " names are the same as the ones produced as output. \n "
460 " -I Idle mode. Just open N idle connections and wait. \n\n "
462 " Run the benchmark with the default configuration against 127.0.0.1:6379: \n "
463 " $ redis-benchmark \n\n "
464 " Use 20 parallel clients, for a total of 100k requests, against 192.168.1.1: \n "
465 " $ redis-benchmark -h 192.168.1.1 -p 6379 -n 100000 -c 20 \n\n "
466 " Fill 127.0.0.1:6379 with about 1 million keys only using the SET test: \n "
467 " $ redis-benchmark -t set -n 1000000 -r 100000000 \n\n "
468 " Benchmark 127.0.0.1:6379 for a few commands producing CSV output: \n "
469 " $ redis-benchmark -t ping,set,get -n 100000 --csv \n\n "
470 " Fill a list with 10000 random elements: \n "
471 " $ redis-benchmark -r 10000 -n 10000 lpush mylist ele:rand:000000000000 \n\n "
476 int showThroughput ( struct aeEventLoop
* eventLoop
, long long id
, void * clientData
) {
477 REDIS_NOTUSED ( eventLoop
);
479 REDIS_NOTUSED ( clientData
);
481 if ( config
. csv
) return 250 ;
482 float dt
= ( float )( mstime ()- config
. start
)/ 1000.0 ;
483 float rps
= ( float ) config
. requests_finished
/ dt
;
484 printf ( " %s : %.2f \r " , config
. title
, rps
);
486 return 250 ; /* every 250ms */
489 /* Return true if the named test was selected using the -t command line
490 * switch, or if all the tests are selected (no -t passed by user). */
491 int test_is_selected ( char * name
) {
493 int l
= strlen ( name
);
495 if ( config
. tests
== NULL
) return 1 ;
497 memcpy ( buf
+ 1 , name
, l
);
500 return strstr ( config
. tests
, buf
) != NULL
;
503 int main ( int argc
, const char ** argv
) {
510 signal ( SIGHUP
, SIG_IGN
);
511 signal ( SIGPIPE
, SIG_IGN
);
513 config
. numclients
= 50 ;
514 config
. requests
= 10000 ;
515 config
. liveclients
= 0 ;
516 config
. el
= aeCreateEventLoop ( 1024 * 10 );
517 aeCreateTimeEvent ( config
. el
, 1 , showThroughput
, NULL
, NULL
);
518 config
. keepalive
= 1 ;
521 config
. randomkeys
= 0 ;
522 config
. randomkeys_keyspacelen
= 0 ;
527 config
. latency
= NULL
;
528 config
. clients
= listCreate ();
529 config
. hostip
= "127.0.0.1" ;
530 config
. hostport
= 6379 ;
531 config
. hostsocket
= NULL
;
534 i
= parseOptions ( argc
, argv
);
538 config
. latency
= zmalloc ( sizeof ( long long )* config
. requests
);
540 if ( config
. keepalive
== 0 ) {
541 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 " );
544 if ( config
. idlemode
) {
545 printf ( "Creating %d idle connections and waiting forever (Ctrl+C when done) \n " , config
. numclients
);
546 c
= createClient ( "" , 0 ); /* will never receive a reply */
547 createMissingClients ( c
);
549 /* and will wait for every */
552 /* Run benchmark with command in the remainder of the arguments. */
554 sds title
= sdsnew ( argv
[ 0 ]);
555 for ( i
= 1 ; i
< argc
; i
++) {
556 title
= sdscatlen ( title
, " " , 1 );
557 title
= sdscatlen ( title
, ( char *) argv
[ i
], strlen ( argv
[ i
]));
561 len
= redisFormatCommandArgv (& cmd
, argc
, argv
, NULL
);
562 benchmark ( title
, cmd
, len
);
564 } while ( config
. loop
);
569 /* Run default benchmark suite. */
571 data
= zmalloc ( config
. datasize
+ 1 );
572 memset ( data
, 'x' , config
. datasize
);
573 data
[ config
. datasize
] = '\0' ;
575 if ( test_is_selected ( "ping_inline" ) || test_is_selected ( "ping" ))
576 benchmark ( "PING_INLINE" , "PING \r\n " , 6 );
578 if ( test_is_selected ( "ping_mbulk" ) || test_is_selected ( "ping" )) {
579 len
= redisFormatCommand (& cmd
, "PING" );
580 benchmark ( "PING_BULK" , cmd
, len
);
584 if ( test_is_selected ( "set" )) {
585 len
= redisFormatCommand (& cmd
, "SET foo:rand:000000000000 %s " , data
);
586 benchmark ( "SET" , cmd
, len
);
590 if ( test_is_selected ( "get" )) {
591 len
= redisFormatCommand (& cmd
, "GET foo:rand:000000000000" );
592 benchmark ( "GET" , cmd
, len
);
596 if ( test_is_selected ( "incr" )) {
597 len
= redisFormatCommand (& cmd
, "INCR counter:rand:000000000000" );
598 benchmark ( "INCR" , cmd
, len
);
602 if ( test_is_selected ( "lpush" )) {
603 len
= redisFormatCommand (& cmd
, "LPUSH mylist %s " , data
);
604 benchmark ( "LPUSH" , cmd
, len
);
608 if ( test_is_selected ( "lpop" )) {
609 len
= redisFormatCommand (& cmd
, "LPOP mylist" );
610 benchmark ( "LPOP" , cmd
, len
);
614 if ( test_is_selected ( "sadd" )) {
615 len
= redisFormatCommand (& cmd
,
616 "SADD myset counter:rand:000000000000" );
617 benchmark ( "SADD" , cmd
, len
);
621 if ( test_is_selected ( "spop" )) {
622 len
= redisFormatCommand (& cmd
, "SPOP myset" );
623 benchmark ( "SPOP" , cmd
, len
);
627 if ( test_is_selected ( "lrange" ) ||
628 test_is_selected ( "lrange_100" ) ||
629 test_is_selected ( "lrange_300" ) ||
630 test_is_selected ( "lrange_500" ) ||
631 test_is_selected ( "lrange_600" ))
633 len
= redisFormatCommand (& cmd
, "LPUSH mylist %s " , data
);
634 benchmark ( "LPUSH (needed to benchmark LRANGE)" , cmd
, len
);
638 if ( test_is_selected ( "lrange" ) || test_is_selected ( "lrange_100" )) {
639 len
= redisFormatCommand (& cmd
, "LRANGE mylist 0 99" );
640 benchmark ( "LRANGE_100 (first 100 elements)" , cmd
, len
);
644 if ( test_is_selected ( "lrange" ) || test_is_selected ( "lrange_300" )) {
645 len
= redisFormatCommand (& cmd
, "LRANGE mylist 0 299" );
646 benchmark ( "LRANGE_300 (first 300 elements)" , cmd
, len
);
650 if ( test_is_selected ( "lrange" ) || test_is_selected ( "lrange_500" )) {
651 len
= redisFormatCommand (& cmd
, "LRANGE mylist 0 449" );
652 benchmark ( "LRANGE_500 (first 450 elements)" , cmd
, len
);
656 if ( test_is_selected ( "lrange" ) || test_is_selected ( "lrange_600" )) {
657 len
= redisFormatCommand (& cmd
, "LRANGE mylist 0 599" );
658 benchmark ( "LRANGE_600 (first 600 elements)" , cmd
, len
);
662 if ( test_is_selected ( "mset" )) {
663 const char * argv
[ 21 ];
665 for ( i
= 1 ; i
< 21 ; i
+= 2 ) {
666 argv
[ i
] = "foo:rand:000000000000" ;
669 len
= redisFormatCommandArgv (& cmd
, 21 , argv
, NULL
);
670 benchmark ( "MSET (10 keys)" , cmd
, len
);
674 if (! config
. csv
) printf ( " \n " );
675 } while ( config
. loop
);