bench.h File Reference

#include <stdint.h>
#include <stdio.h>
#include <string.h>
#include "sys/time.h"

Include dependency graph for bench.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	FP_EXP   (6)
#define	FP_MULT   (1000000LL)

Functions
void	print_number (const int64_t x)
void	run_benchmark (char *name, void(*benchmark)(void *, int), void(*setup)(void *), void(*teardown)(void *, int), void *data, int count, int iter)
int	have_flag (int argc, char **argv, char *flag)
int	have_invalid_args (int argc, char **argv, char **valid_args, size_t n)
int	get_iters (int default_iters)
void	print_output_table_header_row (void)

Macro Definition Documentation

FP_EXP

#define FP_EXP   (6)

Definition at line 21 of file bench.h.

FP_MULT

#define FP_MULT   (1000000LL)

Definition at line 22 of file bench.h.

Function Documentation

get_iters()

int get_iters

(

int

default_iters

)

Definition at line 154 of file bench.h.

                                 {
    char* env = getenv("SECP256K1_BENCH_ITERS");
    if (env) {
        return strtol(env, NULL, 0);
    } else {
        return default_iters;
    }
}

Here is the caller graph for this function:

have_flag()

int have_flag	(	int	argc,
		char **	argv,
		char *	flag )

Definition at line 116 of file bench.h.

                                                 {
    char** argm = argv + argc;
    argv++;
    while (argv != argm) {
        if (strcmp(*argv, flag) == 0) {
            return 1;
        }
        argv++;
    }
    return 0;
}

Here is the caller graph for this function:

have_invalid_args()

int have_invalid_args	(	int	argc,
		char **	argv,
		char **	valid_args,
		size_t	n )

Definition at line 132 of file bench.h.

                                                                          {
    size_t i;
    int found_valid;
    char** argm = argv + argc;
    argv++;
 
    while (argv != argm) {
        found_valid = 0;
        for (i = 0; i < n; i++) {
            if (strcmp(*argv, valid_args[i]) == 0) {
                found_valid = 1; /* user entered a valid arg from the list */
                break;
            }
        }
        if (found_valid == 0) {
            return 1; /* invalid arg found */
        }
        argv++;
    }
    return 0;
}

Here is the caller graph for this function:

print_number()

void print_number

(

const int64_t

x

)

Definition at line 25 of file bench.h.

                                   {
    int64_t x_abs, y;
    int c, i, rounding, g; /* g = integer part size, c = fractional part size */
    size_t ptr;
    char buffer[30];
 
    if (x == INT64_MIN) {
        /* Prevent UB. */
        printf("ERR");
        return;
    }
    x_abs = x < 0 ? -x : x;
 
    /* Determine how many decimals we want to show (more than FP_EXP makes no
     * sense). */
    y = x_abs;
    c = 0;
    while (y > 0LL && y < 100LL * FP_MULT && c < FP_EXP) {
        y *= 10LL;
        c++;
    }
 
    /* Round to 'c' decimals. */
    y = x_abs;
    rounding = 0;
    for (i = c; i < FP_EXP; ++i) {
        rounding = (y % 10) >= 5;
        y /= 10;
    }
    y += rounding;
 
    /* Format and print the number. */
    ptr = sizeof(buffer) - 1;
    buffer[ptr] = 0;
    g = 0;
    if (c != 0) { /* non zero fractional part */
        for (i = 0; i < c; ++i) {
            buffer[--ptr] = '0' + (y % 10);
            y /= 10;
        }
    } else if (c == 0) { /* fractional part is 0 */
        buffer[--ptr] = '0'; 
    }
    buffer[--ptr] = '.';
    do {
        buffer[--ptr] = '0' + (y % 10);
        y /= 10;
        g++;
    } while (y != 0);
    if (x < 0) {
        buffer[--ptr] = '-';
        g++;
    }
    printf("%5.*s", g, &buffer[ptr]); /* Prints integer part */
    printf("%-*s", FP_EXP, &buffer[ptr + g]); /* Prints fractional part */
}

Here is the caller graph for this function:

print_output_table_header_row()

void print_output_table_header_row

(

void

)

Definition at line 163 of file bench.h.

                                         {
    char* bench_str = "Benchmark";     /* left justified */
    char* min_str = "    Min(us)    "; /* center alignment */
    char* avg_str = "    Avg(us)    ";
    char* max_str = "    Max(us)    ";
    printf("%-30s,%-15s,%-15s,%-15s\n", bench_str, min_str, avg_str, max_str);
    printf("\n");
}

Here is the caller graph for this function:

run_benchmark()

void run_benchmark	(	char *	name,
		void(*	benchmark )(void *, int),
		void(*	setup )(void *),
		void(*	teardown )(void *, int),
		void *	data,
		int	count,
		int	iter )

Definition at line 82 of file bench.h.

                                                                                                                                                   {
    int i;
    int64_t min = INT64_MAX;
    int64_t sum = 0;
    int64_t max = 0;
    for (i = 0; i < count; i++) {
        int64_t begin, total;
        if (setup != NULL) {
            setup(data);
        }
        begin = gettime_i64();
        benchmark(data, iter);
        total = gettime_i64() - begin;
        if (teardown != NULL) {
            teardown(data, iter);
        }
        if (total < min) {
            min = total;
        }
        if (total > max) {
            max = total;
        }
        sum += total;
    }
    /* ',' is used as a column delimiter */
    printf("%-30s, ", name);
    print_number(min * FP_MULT / iter);
    printf("   , ");
    print_number(((sum * FP_MULT) / count) / iter);
    printf("   , ");
    print_number(max * FP_MULT / iter);
    printf("\n");
}

Here is the call graph for this function:

Here is the caller graph for this function: