History log of /seL4-test-master/projects/seL4_libs/libsel4bench/include/sel4bench/sel4bench.h
Revision Date Author Comments
# 3cb23f1f 09-Oct-2019 G. Branden Robinson <Branden.Robinson@data61.csiro.au>

sel4bench.h: update documentation and style

* Expand documentation of `sel4bench_enable_counters()`.
* Document `sel4bench_get_num_counter_chunks()`.
* Add missing @param and @return notations.
* Consistently use plurals in the strings for generic event names.
* Use Markdown backticks for literals (e.g., symbol names).
* Keep @param and @return descriptions terse (they should be noun
phrases appropriate for tool tips). Elaborations go in the function
description.
* Don't abbreviate `sel4bench_init()` and `sel4bench_destroy()` as
`_init()` and `_destroy()`, respectively. Use the full names.
* Move documentation of constraint on number of counters to
`sel4bench_get_num_counters()`, instead of duplicating it in two other
functions.
* Emphasise that the cycle counter is not a performance counter.
* Clarify reference to ARM1136 platform, a.k.a. "kzm".

Flag open questions:
* Should some of these prototypes and constant objects be moved to a
"private" header file?

Minor style issues:
* Perform minor wordsmithing.
* Use hyphens more idiomatically.
* Wrap lines at 80 columns.
* Use two spaces between sentences for readability.


# c2dcae03 08-May-2019 Anna Lyons <Anna.Lyons@data61.csiro.au>

trivial: style changed


# 3530ba69 08-May-2019 Anna Lyons <Anna.Lyons@data61.csiro.au>

sel4bench: make it clear reset_counters is not all

sel4bench_reset_counters does not reset the cycle counter


# 9214341c 04-Jun-2017 Anna Lyons <Anna.Lyons@data61.csiro.au>

Fix licenses


# 108d5e54 04-Apr-2017 Anna Lyons <Anna.Lyons@data61.csiro.au>

sel4bench: reset all counters

Resetting a subset of the counters a) doesn't work on all platforms c)
doesn't make much sense and b) is less code, d) unused functionality

If this functionality is required it can be readded in a working form at
a later date.


# 3ee23711 03-Apr-2017 Anna Lyons <Anna.Lyons@data61.csiro.au>

sel4bench: add missing utils/arith.h


# 430e1a87 03-Apr-2017 Anna Lyons <Anna.Lyons@data61.csiro.au>

sel4bench: helpers for looping through events

This commit adds helpers in sel4bench.h to loop through a set of
events when the number of events you want to read are greater than the
number of counters provided by the platform.

These can be used for the generic events or for a custom set
of events.


# beab3372 03-Apr-2017 Anna Lyons <Anna.Lyons@data61.csiro.au>

sel4bench: s/COUNTERS/EVENTS in number of events


# 86ddcd5d 03-Apr-2017 Anna Lyons <Anna.Lyons@data61.csiro.au>

sel4bench: generic events name and constant sanity

Add a static assert to make sure they are at least the same length


# 1af06987 03-Apr-2017 Anna Lyons <Anna.Lyons@data61.csiro.au>

sel4bench: Add MEMORY_ACCESS as generic event

I mistakenly deleted it as platforms variably defined
this counter spelling MEMORY or MEM in the constant.


# e80509ee 29-Mar-2017 Anna Lyons <Anna.Lyons@data61.csiro.au>

sel4bench: names for generic events


# e72691f9 29-Mar-2017 Anna Lyons <Anna.Lyons@data61.csiro.au>

sel4bench: style


# bdcec827 29-Mar-2017 Anna Lyons <Anna.Lyons@data61.csiro.au>

sel4bench: use ccnt_t and remove duplicate

Was duplicated sel4bench_counter_t and format function


# 5cc8dc5e 29-Mar-2017 Anna Lyons <Anna.Lyons@data61.csiro.au>

sel4bench: remove SEL4BENCH_API indirection macro

Use UNUSED and static directly


# 7c7f7c39 29-Mar-2017 Anna Lyons <Anna.Lyons@data61.csiro.au>

sel4bench: improve interface

- define array of generic events
- drop generic events that don't exist for all platforms (i.e are not
generic)
- define number of generic events
- define types to illustate the difference between a counter and an
event


# 58a58d29 28-Mar-2017 Anna Lyons <Anna.Lyons@data61.csiro.au>

sel4bench: use #pragma once


# 9093387e 28-Mar-2017 Anna Lyons <Anna.Lyons@data61.csiro.au>

sel4bench: fix include structure and licenses

For too long sel4bench has relied on relative includes
and filenames with the CPU/ARMV in it.

Finally fix it.


# 2a366f15 08-Nov-2016 Stephen Sherratt <Stephen.Sherratt@data61.csiro.au>

sel4bench: Removed SEL4BENCH_FENCE macro

This macro has been moved to libutils.


# 8351f464 29-Mar-2016 Alexander Kroh <alex.kroh@nicta.com.au>

libsel4bench: Add performance counter descriptions for runtime display


# 5934beaf 20-Mar-2016 Anna Lyons <Anna.Lyons@nicta.com.au>

sel4bench: move FENCE macro from app to lib.

This could be useful elsewhere.