]>
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
;
77 typedef struct _client
{
78 redisContext
* context
;
80 char * randptr
[ 10 ]; /* needed for MSET against 10 keys */
82 unsigned int written
; /* bytes of 'obuf' already written */
83 long long start
; /* start time of a request */
84 long long latency
; /* request latency */
88 static void writeHandler ( aeEventLoop
* el
, int fd
, void * privdata
, int mask
);
89 static void createMissingClients ( client c
);
92 static long long ustime ( void ) {
96 gettimeofday (& tv
, NULL
);
97 ust
= (( long ) tv
. tv_sec
)* 1000000 ;
102 static long long mstime ( void ) {
106 gettimeofday (& tv
, NULL
);
107 mst
= (( long ) tv
. tv_sec
)* 1000 ;
108 mst
+= tv
. tv_usec
/ 1000 ;
112 static void freeClient ( client c
) {
114 aeDeleteFileEvent ( config
. el
, c
-> context
-> fd
, AE_WRITABLE
);
115 aeDeleteFileEvent ( config
. el
, c
-> context
-> fd
, AE_READABLE
);
116 redisFree ( c
-> context
);
119 config
. liveclients
--;
120 ln
= listSearchKey ( config
. clients
, c
);
122 listDelNode ( config
. clients
, ln
);
125 static void freeAllClients ( void ) {
126 listNode
* ln
= config
. clients
-> head
, * next
;
130 freeClient ( ln
-> value
);
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
);
142 static void randomizeClientKey ( client c
) {
146 for ( i
= 0 ; i
< c
-> randlen
; i
++) {
147 r
= random () % config
. randomkeys_keyspacelen
;
148 snprintf ( buf
, sizeof ( buf
), " %0 12zu" , r
);
149 memcpy ( c
-> randptr
[ i
], buf
, 12 );
153 static void clientDone ( client c
) {
154 if ( config
. requests_finished
== config
. requests
) {
159 if ( config
. keepalive
) {
162 config
. liveclients
--;
163 createMissingClients ( c
);
164 config
. liveclients
++;
169 static void readHandler ( aeEventLoop
* el
, int fd
, void * privdata
, int mask
) {
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
);
181 if ( redisBufferRead ( c
-> context
) != REDIS_OK
) {
182 fprintf ( stderr
, "Error: %s \n " , c
-> context
-> errstr
);
185 if ( redisGetReply ( c
-> context
,& reply
) != REDIS_OK
) {
186 fprintf ( stderr
, "Error: %s \n " , c
-> context
-> errstr
);
190 if ( reply
== ( void *) REDIS_REPLY_ERROR
) {
191 fprintf ( stderr
, "Unexpected error reply, exiting... \n " );
195 if ( config
. requests_finished
< config
. requests
)
196 config
. latency
[ config
. requests_finished
++] = c
-> latency
;
202 static void writeHandler ( aeEventLoop
* el
, int fd
, void * privdata
, int mask
) {
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
) {
216 /* Really initialize: randomize keys and set start time. */
217 if ( config
. randomkeys
) randomizeClientKey ( c
);
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 ) {
227 fprintf ( stderr
, "Writing to socket: %s \n " , strerror ( errno
));
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
);
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
);
244 c
-> context
= redisConnectUnixNonBlock ( config
. hostsocket
);
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
);
251 fprintf ( stderr
, " %s : %s \n " , config
. hostsocket
, c
-> context
-> errstr
);
254 c
-> obuf
= sdsnewlen ( cmd
, len
);
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 ;
270 redisSetReplyObjectFunctions ( c
-> context
, NULL
);
271 aeCreateFileEvent ( config
. el
, c
-> context
-> fd
, AE_WRITABLE
, writeHandler
, c
);
272 listAddNodeTail ( config
. clients
, c
);
273 config
. liveclients
++;
277 static void createMissingClients ( client c
) {
280 while ( config
. liveclients
< config
. numclients
) {
281 createClient ( c
-> obuf
, sdslen ( c
-> obuf
));
283 /* Listen backlog is quite limited on most systems */
291 static int compareLatency ( const void * a
, const void * b
) {
292 return (*( long long *) a
)-(*( long long *) b
);
295 static void showLatencyReport ( void ) {
297 float perc
, reqpersec
;
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
);
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
);
317 printf ( "%.2f requests per second \n\n " , reqpersec
);
318 } else if ( config
. csv
) {
319 printf ( " \" %s \" , \" %.2f \"\n " , config
. title
, reqpersec
);
321 printf ( " %s : %.2f requests per second \n " , config
. title
, reqpersec
);
325 static void benchmark ( const char * title
, const char * cmd
, int len
) {
328 config
. title
= title
;
329 config
. requests_issued
= 0 ;
330 config
. requests_finished
= 0 ;
332 c
= createClient ( cmd
, len
);
333 createMissingClients ( c
);
335 config
. start
= mstime ();
337 config
. totlatency
= mstime ()- config
. start
;
343 /* Returns number of consumed options. */
344 int parseOptions ( int argc
, const char ** argv
) {
349 for ( i
= 1 ; i
< argc
; i
++) {
350 lastarg
= ( i
== ( argc
- 1 ));
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" )) {
383 } else if (! strcmp ( argv
[ i
], "--csv" )) {
385 } else if (! strcmp ( argv
[ i
], "-l" )) {
387 } else if (! strcmp ( argv
[ i
], "-I" )) {
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
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" )) {
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
;
415 printf ( "Invalid option \" %s \" or option argument missing \n\n " , argv
[ i
]);
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 "
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 "
453 int showThroughput ( struct aeEventLoop
* eventLoop
, long long id
, void * clientData
) {
454 REDIS_NOTUSED ( eventLoop
);
456 REDIS_NOTUSED ( clientData
);
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
);
463 return 250 ; /* every 250ms */
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
) {
470 int l
= strlen ( name
);
472 if ( config
. tests
== NULL
) return 1 ;
474 memcpy ( buf
+ 1 , name
, l
);
477 return strstr ( config
. tests
, buf
) != NULL
;
480 int main ( int argc
, const char ** argv
) {
487 signal ( SIGHUP
, SIG_IGN
);
488 signal ( SIGPIPE
, SIG_IGN
);
490 config
. numclients
= 50 ;
491 config
. requests
= 10000 ;
492 config
. liveclients
= 0 ;
493 config
. el
= aeCreateEventLoop ( 1024 * 10 );
494 aeCreateTimeEvent ( config
. el
, 1 , showThroughput
, NULL
, NULL
);
495 config
. keepalive
= 1 ;
497 config
. randomkeys
= 0 ;
498 config
. randomkeys_keyspacelen
= 0 ;
503 config
. latency
= NULL
;
504 config
. clients
= listCreate ();
505 config
. hostip
= "127.0.0.1" ;
506 config
. hostport
= 6379 ;
507 config
. hostsocket
= NULL
;
510 i
= parseOptions ( argc
, argv
);
514 config
. latency
= zmalloc ( sizeof ( long long )* config
. requests
);
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 " );
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
);
525 /* and will wait for every */
528 /* Run benchmark with command in the remainder of the arguments. */
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
]));
537 len
= redisFormatCommandArgv (& cmd
, argc
, argv
, NULL
);
538 benchmark ( title
, cmd
, len
);
540 } while ( config
. loop
);
545 /* Run default benchmark suite. */
547 data
= zmalloc ( config
. datasize
+ 1 );
548 memset ( data
, 'x' , config
. datasize
);
549 data
[ config
. datasize
] = '\0' ;
551 if ( test_is_selected ( "ping_inline" ) || test_is_selected ( "ping" ))
552 benchmark ( "PING_INLINE" , "PING \r\n " , 6 );
554 if ( test_is_selected ( "ping_mbulk" ) || test_is_selected ( "ping" )) {
555 len
= redisFormatCommand (& cmd
, "PING" );
556 benchmark ( "PING_BULK" , cmd
, len
);
560 if ( test_is_selected ( "set" )) {
561 len
= redisFormatCommand (& cmd
, "SET foo:rand:000000000000 %s " , data
);
562 benchmark ( "SET" , cmd
, len
);
566 if ( test_is_selected ( "get" )) {
567 len
= redisFormatCommand (& cmd
, "GET foo:rand:000000000000" );
568 benchmark ( "GET" , cmd
, len
);
572 if ( test_is_selected ( "incr" )) {
573 len
= redisFormatCommand (& cmd
, "INCR counter:rand:000000000000" );
574 benchmark ( "INCR" , cmd
, len
);
578 if ( test_is_selected ( "lpush" )) {
579 len
= redisFormatCommand (& cmd
, "LPUSH mylist %s " , data
);
580 benchmark ( "LPUSH" , cmd
, len
);
584 if ( test_is_selected ( "lpop" )) {
585 len
= redisFormatCommand (& cmd
, "LPOP mylist" );
586 benchmark ( "LPOP" , cmd
, len
);
590 if ( test_is_selected ( "sadd" )) {
591 len
= redisFormatCommand (& cmd
,
592 "SADD myset counter:rand:000000000000" );
593 benchmark ( "SADD" , cmd
, len
);
597 if ( test_is_selected ( "spop" )) {
598 len
= redisFormatCommand (& cmd
, "SPOP myset" );
599 benchmark ( "SPOP" , cmd
, len
);
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" ))
609 len
= redisFormatCommand (& cmd
, "LPUSH mylist %s " , data
);
610 benchmark ( "LPUSH (needed to benchmark LRANGE)" , cmd
, len
);
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
);
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
);
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
);
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
);
638 if ( test_is_selected ( "mset" )) {
639 const char * argv
[ 21 ];
641 for ( i
= 1 ; i
< 21 ; i
+= 2 ) {
642 argv
[ i
] = "foo:rand:000000000000" ;
645 len
= redisFormatCommandArgv (& cmd
, 21 , argv
, NULL
);
646 benchmark ( "MSET (10 keys)" , cmd
, len
);
650 if (! config
. csv
) printf ( " \n " );
651 } while ( config
. loop
);