benchmark.h File Reference

#include "./../serial/serial_c_iface.h"
#include "../key_value/kv_system.h"
#include "ram/ram_util.h"

Description

Header file for benchmarking.

Author

Eric Huang

Copyright

Copyright 2017 The University of British Columbia, IonDB Project Contributors (see AUTHORS.md)

Redistribution and use in source and binary forms, with or without

modification, are permitted provided that the following conditions are met:

1.Redistributions of source code must retain the above copyright notice,

this list of conditions and the following disclaimer.

2.Redistributions in binary form must reproduce the above copyright notice,

this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3.Neither the name of the copyright holder nor the names of its contributors

may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"

AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file benchmark.h.

Include dependency graph for benchmark.h:

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

Functions
void	benchmark_start (void)
void	benchmark_stop (void)

Variables
static unsigned volatile int	ram_counter
static unsigned volatile int	time_counter

Function Documentation

void benchmark_start

(

void

)

Definition at line 40 of file benchmark.c.

  {
    ram_counter     = free_ram();
    time_counter    = millis();
}

Here is the call graph for this function:

void benchmark_stop

(

void

)

Definition at line 48 of file benchmark.c.

  {
    unsigned int    ram_used        = ram_counter - free_ram() - 4; /* Magic offset - compensates for benchmark requiring 4 bytes to work */
    unsigned int    time_elapsed    = millis() - time_counter;

    printf("%db RAM use in %dms.\n", ram_used, time_elapsed);
}

Here is the call graph for this function:

Variable Documentation

unsigned volatile int ram_counter

static

Definition at line 48 of file benchmark.h.

unsigned volatile int time_counter

static

Definition at line 49 of file benchmark.h.