nettle-benchmark.c 12.1 KB
Newer Older
1 2 3 4 5 6 7 8
/* nettle-benchmark.c
 *
 * Tries the performance of the various algorithms.
 *
 */
 
/* nettle, low-level cryptographics library
 *
Niels Möller's avatar
Niels Möller committed
9
 * Copyright (C) 2001, 2010 Niels Mller
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
 *  
 * The nettle library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or (at your
 * option) any later version.
 * 
 * The nettle library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with the nettle library; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
 * MA 02111-1307, USA.
 */

27 28
#if HAVE_CONFIG_H
# include "config.h"
29 30 31 32
#endif

#include <assert.h>
#include <errno.h>
33
#include <math.h>
34 35 36 37 38
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#include <time.h>
39

40
#include "aes.h"
Niels Möller's avatar
Niels Möller committed
41 42 43
#include "arcfour.h"
#include "blowfish.h"
#include "cast128.h"
Niels Möller's avatar
Niels Möller committed
44
#include "cbc.h"
Niels Möller's avatar
Niels Möller committed
45
#include "des.h"
46
#include "memxor.h"
Niels Möller's avatar
Niels Möller committed
47
#include "serpent.h"
48
#include "sha.h"
Niels Möller's avatar
Niels Möller committed
49 50
#include "twofish.h"

51 52 53
#include "nettle-meta.h"
#include "nettle-internal.h"

Niels Möller's avatar
Niels Möller committed
54
#include "getopt.h"
55

56
static double frequency = 0.0;
Niels Möller's avatar
Niels Möller committed
57

58
/* Process BENCH_BLOCK bytes at a time, for BENCH_INTERVAL seconds. */
59
#define BENCH_BLOCK 10240
60
#define BENCH_INTERVAL 0.1
Niels Möller's avatar
Niels Möller committed
61

62 63
/* FIXME: Proper configure test for rdtsc? */
#ifndef WITH_CYCLE_COUNTER
64
# if defined(__GNUC__) && (defined(__i386__) || defined(__x86_64__))
65 66 67 68 69 70 71
#  define WITH_CYCLE_COUNTER 1
# else
#  define WITH_CYCLE_COUNTER 0
# endif
#endif

#if WITH_CYCLE_COUNTER
72
# if defined(__i386__)
73 74 75 76 77 78 79 80 81
#define GET_CYCLE_COUNTER(hi, lo)		\
  __asm__("xorl %%eax,%%eax\n"			\
	  "movl %%ebx, %%edi\n"			\
	  "cpuid\n"				\
	  "rdtsc\n"				\
	  "movl %%edi, %%ebx\n"			\
	  : "=a" (lo), "=d" (hi)		\
	  : /* No inputs. */			\
	  : "%edi", "%ecx", "cc")
82 83 84 85 86 87 88 89 90 91 92
# elif defined(__x86_64__)
#define GET_CYCLE_COUNTER(hi, lo)		\
  __asm__("xorl %%eax,%%eax\n"			\
	  "mov %%rbx, %%r10\n"			\
	  "cpuid\n"				\
	  "rdtsc\n"				\
	  "mov %%r10, %%rbx\n"			\
	  : "=a" (lo), "=d" (hi)		\
	  : /* No inputs. */			\
	  : "%r10", "%rcx", "cc")
# endif
93 94 95
#define BENCH_ITERATIONS 10
#endif

96 97
static double overhead = 0.0; 

98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
#if HAVE_CLOCK_GETTIME && defined CLOCK_PROCESS_CPUTIME_ID
#define TIME_TYPE struct timespec
#define TIME_START(start) clock_gettime(CLOCK_PROCESS_CPUTIME_ID, &(start))
#define TIME_END(elapsed, start) do {				\
    struct timespec _time_end_after;				\
    clock_gettime(CLOCK_PROCESS_CPUTIME_ID, &_time_end_after);	\
    (elapsed) = _time_end_after.tv_sec - (start).tv_sec		\
      + 1e-9 * (_time_end_after.tv_nsec - (start).tv_nsec);	\
  } while (0)
#else /* !HAVE_CLOCK_GETTIME */
#define TIME_TYPE clock_t
#define TIME_START(start) ((start) = clock)
#define TIME_END(elapsed, start) \
  ((elapsed) = (double) (clock() - (start)) / CLOCKS_PER_SEC)
#endif /* !HAVE_CLOCK_GETTIME */

114
/* Returns second per function call */
115 116 117
static double
time_function(void (*f)(void *arg), void *arg)
{
118
  unsigned ncalls;
119 120
  double elapsed;

121
  for (ncalls = 10 ;;)
122
    {
123 124 125 126 127 128 129 130 131 132 133 134
      TIME_TYPE start;
      unsigned i;
      TIME_START(start);
      for (i = 0; i < ncalls; i++)
	f(arg);
      TIME_END(elapsed, start);
      if (elapsed > BENCH_INTERVAL)
	break;
      else if (elapsed < BENCH_INTERVAL / 10)
	ncalls *= 10;
      else
	ncalls *= 2;
135
    }
136 137 138 139 140 141 142
  return elapsed / ncalls - overhead;
}

static void
bench_nothing(void *arg UNUSED)
{
  return;
143 144
}

145 146 147 148
struct bench_memxor_info
{
  uint8_t *dst;
  const uint8_t *src;
149
  const uint8_t *other;  
150 151 152 153 154 155 156 157 158
};

static void
bench_memxor(void *arg)
{
  struct bench_memxor_info *info = arg;
  memxor (info->dst, info->src, BENCH_BLOCK);
}

159 160 161 162 163 164 165
static void
bench_memxor3(void *arg)
{
  struct bench_memxor_info *info = arg;
  memxor3 (info->dst, info->src, info->other, BENCH_BLOCK);
}

166 167 168
struct bench_hash_info
{
  void *ctx;
169
  nettle_hash_update_func *update;
170 171 172 173 174 175 176 177 178 179
  const uint8_t *data;
};

static void
bench_hash(void *arg)
{
  struct bench_hash_info *info = arg;
  info->update(info->ctx, BENCH_BLOCK, info->data);
}

180 181 182
struct bench_cipher_info
{
  void *ctx;
183
  nettle_crypt_func *crypt;
184 185 186 187 188 189 190
  uint8_t *data;
};

static void
bench_cipher(void *arg)
{
  struct bench_cipher_info *info = arg;
191
  info->crypt(info->ctx, BENCH_BLOCK, info->data, info->data);
192 193 194 195 196
}

struct bench_cbc_info
{
  void *ctx;
197
  nettle_crypt_func *crypt;
198
 
199
  uint8_t *data;
200
  
201 202 203 204 205 206 207 208
  unsigned block_size;
  uint8_t *iv;
};

static void
bench_cbc_encrypt(void *arg)
{
  struct bench_cbc_info *info = arg;
209 210 211
  cbc_encrypt(info->ctx, info->crypt,
	      info->block_size, info->iv,
	      BENCH_BLOCK, info->data, info->data);
212 213 214 215 216 217
}

static void
bench_cbc_decrypt(void *arg)
{
  struct bench_cbc_info *info = arg;
218 219 220
  cbc_decrypt(info->ctx, info->crypt,
	      info->block_size, info->iv,
	      BENCH_BLOCK, info->data, info->data);
221 222 223 224 225 226 227
}

/* Set data[i] = floor(sqrt(i)) */
static void
init_data(uint8_t *data)
{
  unsigned i,j;
Niels Möller's avatar
Niels Möller committed
228
  for (i = j = 0; i<BENCH_BLOCK;  i++)
229 230 231 232 233 234 235 236
    {
      if (j*j < i)
	j++;
      data[i] = j;
    }
}

static void
Niels Möller's avatar
Niels Möller committed
237 238
init_key(unsigned length,
         uint8_t *key)
239
{
Niels Möller's avatar
Niels Möller committed
240 241 242
  unsigned i;
  for (i = 0; i<length; i++)
    key[i] = i;
243 244
}

245 246 247 248 249
static void
header(void)
{
  printf("%18s %11s Mbyte/s%s\n",
	 "Algorithm", "mode", 
Niels Möller's avatar
Niels Möller committed
250
	 frequency > 0.0 ? " cycles/byte cycles/block" : "");  
251 252
}

Niels Möller's avatar
Niels Möller committed
253
static void
Niels Möller's avatar
Niels Möller committed
254
display(const char *name, const char *mode, unsigned block_size,
255
	double time)
Niels Möller's avatar
Niels Möller committed
256
{
257
  printf("%18s %11s %7.2f",
Niels Möller's avatar
Niels Möller committed
258
	 name, mode,
259
	 BENCH_BLOCK / (time * 1048576.0));
260
  if (frequency > 0.0)
Niels Möller's avatar
Niels Möller committed
261
    {
262
      printf(" %11.2f", time * frequency / BENCH_BLOCK);
Niels Möller's avatar
Niels Möller committed
263
      if (block_size > 0)
264
	printf(" %12.2f", time * frequency * block_size / BENCH_BLOCK);
Niels Möller's avatar
Niels Möller committed
265
    }
266
  printf("\n");
Niels Möller's avatar
Niels Möller committed
267 268
}

269 270 271 272 273 274 275 276 277 278 279 280 281
static void *
xalloc(size_t size)
{
  void *p = malloc(size);
  if (!p)
    {
      fprintf(stderr, "Virtual memory exhausted.\n");
      abort();
    }

  return p;
}

282 283 284 285 286 287 288 289 290 291 292 293
static void
time_overhead(void)
{
  overhead = time_function(bench_nothing, NULL);
  printf("benchmark call overhead: %7f us", overhead * 1e6);
  if (frequency > 0.0)
    printf("%7.2f cycles\n", overhead * frequency);
  printf("\n");  
}



294 295 296 297
static void
time_memxor(void)
{
  struct bench_memxor_info info;
298
  uint8_t src[BENCH_BLOCK + sizeof(long)];
299
  uint8_t other[BENCH_BLOCK + sizeof(long)];
300
  uint8_t dst[BENCH_BLOCK];
301 302 303 304

  info.src = src;
  info.dst = dst;

305 306
  display ("memxor", "aligned", sizeof(unsigned long),
	   time_function(bench_memxor, &info));
307
  info.src = src + 1;
308
  display ("memxor", "unaligned", sizeof(unsigned long),
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
	   time_function(bench_memxor, &info));

  info.src = src;
  info.other = other;
  display ("memxor3", "aligned", sizeof(unsigned long),
	   time_function(bench_memxor3, &info));

  info.other = other + 1;
  display ("memxor3", "unaligned01", sizeof(unsigned long),
	   time_function(bench_memxor3, &info));
  info.src = src + 1;
  display ("memxor3", "unaligned11", sizeof(unsigned long),
	   time_function(bench_memxor3, &info));
  info.other = other + 2;
  display ("memxor3", "unaligned12", sizeof(unsigned long),
	   time_function(bench_memxor3, &info));  
325 326
}

327 328 329 330 331
static void
time_hash(const struct nettle_hash *hash)
{
  static uint8_t data[BENCH_BLOCK];
  struct bench_hash_info info;
332

333
  info.ctx = xalloc(hash->context_size); 
334 335 336 337 338 339
  info.update = hash->update;
  info.data = data;

  init_data(data);
  hash->init(info.ctx);

Niels Möller's avatar
Niels Möller committed
340
  display(hash->name, "update", hash->block_size,
341
	  time_function(bench_hash, &info));
342 343

  free(info.ctx);
344 345
}

Niels Möller's avatar
Niels Möller committed
346
static void
347
time_cipher(const struct nettle_cipher *cipher)
Niels Möller's avatar
Niels Möller committed
348
{
349 350
  void *ctx = xalloc(cipher->context_size);
  uint8_t *key = xalloc(cipher->key_size);
Niels Möller's avatar
Niels Möller committed
351

352
  static uint8_t data[BENCH_BLOCK];
Niels Möller's avatar
Niels Möller committed
353 354 355 356

  printf("\n");
  
  init_data(data);
357 358

  {
Niels Möller's avatar
Niels Möller committed
359 360 361 362 363
    /* Decent initializers are a GNU extension, so don't use it here. */
    struct bench_cipher_info info;
    info.ctx = ctx;
    info.crypt = cipher->encrypt;
    info.data = data;
364
    
Niels Möller's avatar
Niels Möller committed
365
    init_key(cipher->key_size, key);
366
    cipher->set_encrypt_key(ctx, cipher->key_size, key);
Niels Möller's avatar
Niels Möller committed
367

Niels Möller's avatar
Niels Möller committed
368
    display(cipher->name, "ECB encrypt", cipher->block_size,
Niels Möller's avatar
Niels Möller committed
369
	    time_function(bench_cipher, &info));
370
  }
Niels Möller's avatar
Niels Möller committed
371
  
372
  {
Niels Möller's avatar
Niels Möller committed
373 374 375 376
    struct bench_cipher_info info;
    info.ctx = ctx;
    info.crypt = cipher->decrypt;
    info.data = data;
377
    
Niels Möller's avatar
Niels Möller committed
378
    init_key(cipher->key_size, key);
379
    cipher->set_decrypt_key(ctx, cipher->key_size, key);
Niels Möller's avatar
Niels Möller committed
380

Niels Möller's avatar
Niels Möller committed
381
    display(cipher->name, "ECB decrypt", cipher->block_size,
Niels Möller's avatar
Niels Möller committed
382
	    time_function(bench_cipher, &info));
383 384
  }

Niels Möller's avatar
Niels Möller committed
385 386
  /* Don't use nettle cbc to benchmark openssl ciphers */
  if (cipher->block_size && cipher->name[0] != 'o')
Niels Möller's avatar
Niels Möller committed
387
    {
388
      uint8_t *iv = xalloc(cipher->block_size);
Niels Möller's avatar
Niels Möller committed
389 390 391
      
      /* Do CBC mode */
      {
Niels Möller's avatar
Niels Möller committed
392 393 394 395 396 397
        struct bench_cbc_info info;
	info.ctx = ctx;
	info.crypt = cipher->encrypt;
	info.data = data;
	info.block_size = cipher->block_size;
	info.iv = iv;
398
    
Niels Möller's avatar
Niels Möller committed
399
        memset(iv, 0, sizeof(iv));
400
    
401
        cipher->set_encrypt_key(ctx, cipher->key_size, key);
402

Niels Möller's avatar
Niels Möller committed
403
	display(cipher->name, "CBC encrypt", cipher->block_size,
Niels Möller's avatar
Niels Möller committed
404
		time_function(bench_cbc_encrypt, &info));
Niels Möller's avatar
Niels Möller committed
405
      }
406

Niels Möller's avatar
Niels Möller committed
407
      {
Niels Möller's avatar
Niels Möller committed
408 409 410 411 412 413
        struct bench_cbc_info info;
	info.ctx = ctx;
	info.crypt = cipher->decrypt;
	info.data = data;
	info.block_size = cipher->block_size;
	info.iv = iv;
414
    
Niels Möller's avatar
Niels Möller committed
415
        memset(iv, 0, sizeof(iv));
416

417
        cipher->set_decrypt_key(ctx, cipher->key_size, key);
418

Niels Möller's avatar
Niels Möller committed
419
	display(cipher->name, "CBC decrypt", cipher->block_size,
Niels Möller's avatar
Niels Möller committed
420
		time_function(bench_cbc_decrypt, &info));
Niels Möller's avatar
Niels Möller committed
421
      }
422
      free(iv);
Niels Möller's avatar
Niels Möller committed
423
    }
424 425
  free(ctx);
  free(key);
Niels Möller's avatar
Niels Möller committed
426 427
}

428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
static int
compare_double(const void *ap, const void *bp)
{
  double a = *(const double *) ap;
  double b = *(const double *) bp;
  if (a < b)
    return -1;
  else if (a > b)
    return 1;
  else
    return 0;
}

/* Try to get accurate cycle times for assembler functions. */
static void
bench_sha1_compress(void)
{
#if WITH_CYCLE_COUNTER
  uint32_t state[_SHA1_DIGEST_LENGTH];
  uint8_t data[BENCH_ITERATIONS * SHA1_DATA_SIZE];
  uint32_t start_lo, start_hi, end_lo, end_hi;

  double count[5];
  
  uint8_t *p;
  unsigned i, j;

  for (j = 0; j < 5; j++)
    {
      i = 0;
      p = data;
      GET_CYCLE_COUNTER(start_hi, start_lo);
      for (; i < BENCH_ITERATIONS; i++, p += SHA1_DATA_SIZE)
	_nettle_sha1_compress(state, p);

      GET_CYCLE_COUNTER(end_hi, end_lo);

      end_hi -= (start_hi + (start_lo > end_lo));
      end_lo -= start_lo;

      count[j] = ldexp(end_hi, 32) + end_lo;
    }

  qsort(count, 5, sizeof(double), compare_double);
  printf("sha1_compress: %.2f cycles\n\n", count[2] / BENCH_ITERATIONS);  
#endif
}

Niels Möller's avatar
Niels Möller committed
476
#if WITH_OPENSSL
477 478 479 480
# define OPENSSL(x) x,
#else
# define OPENSSL(x)
#endif
Niels Möller's avatar
Niels Möller committed
481 482

int
483
main(int argc, char **argv)
Niels Möller's avatar
Niels Möller committed
484 485
{
  unsigned i;
486
  int c;
487
  const char *alg;
488 489 490 491

  const struct nettle_hash *hashes[] =
    {
      &nettle_md2, &nettle_md4, &nettle_md5,
492
      OPENSSL(&nettle_openssl_md5)
493
      &nettle_sha1, OPENSSL(&nettle_openssl_sha1)
Niels Möller's avatar
Niels Möller committed
494 495
      &nettle_sha224, &nettle_sha256,
      &nettle_sha384, &nettle_sha512,
496 497 498
      NULL
    };

499
  const struct nettle_cipher *ciphers[] =
Niels Möller's avatar
Niels Möller committed
500
    {
501
      &nettle_aes128, &nettle_aes192, &nettle_aes256,
Niels Möller's avatar
Niels Möller committed
502 503 504 505 506
      OPENSSL(&nettle_openssl_aes128)
      OPENSSL(&nettle_openssl_aes192)
      OPENSSL(&nettle_openssl_aes256)
      &nettle_arcfour128, OPENSSL(&nettle_openssl_arcfour128)
      &nettle_blowfish128, OPENSSL(&nettle_openssl_blowfish128)
Niels Möller's avatar
Niels Möller committed
507
      &nettle_camellia128, &nettle_camellia192, &nettle_camellia256,
508 509 510
      &nettle_cast128, OPENSSL(&nettle_openssl_cast128)
      &nettle_des, OPENSSL(&nettle_openssl_des)
      &nettle_des3,
511 512
      &nettle_serpent256,
      &nettle_twofish128, &nettle_twofish192, &nettle_twofish256,
513
      NULL
Niels Möller's avatar
Niels Möller committed
514
    };
515

516 517 518 519 520 521 522 523 524
  while ( (c = getopt(argc, argv, "f:")) != -1)
    switch (c)
      {
      case 'f':
	frequency = atof(optarg);
	if (frequency > 0.0)
	  break;

      case ':': case '?':
525
	fprintf(stderr, "Usage: nettle-benchmark [-f clock frequency] [alg]\n");
526 527 528 529 530 531
	return EXIT_FAILURE;

      default:
	abort();
    }

532
  alg = argv[optind];
533

534 535
  bench_sha1_compress();

536 537
  time_overhead();

538 539
  header();

540 541 542 543 544
  if (!alg || strstr ("memxor", alg))
    {
      time_memxor();
      printf("\n");
    }
545
  
546 547 548 549 550
  for (i = 0; hashes[i]; i++)
    {
      if (!alg || strstr(hashes[i]->name, alg))
	time_hash(hashes[i]);
    }
551
  for (i = 0; ciphers[i]; i++)
552 553 554
    if (!alg || strstr(ciphers[i]->name, alg))
      time_cipher(ciphers[i]);

555 556
  return 0;
}