@@@ adjust bench timings

[mLib] / test / bench.h

/* -*-c-*-
 *
 * Benchmarking support
 *
 * (c) 2023 Straylight/Edgeware
 */

/*----- Licensing notice --------------------------------------------------*
 *
 * This file is part of the mLib utilities library.
 *
 * mLib is free software: you can redistribute it and/or modify it under
 * the terms of the GNU Library General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at
 * your option) any later version.
 *
 * mLib 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 Library General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with mLib.  If not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
 * USA.
 */

#ifndef MLIB_BENCH_H
#define MLIB_BENCH_H

#ifdef __cplusplus
  extern "C" {
#endif

/*----- Header files ------------------------------------------------------*/

#ifndef MLIB_BITS_H
#  include "bits.h"
#endif

/*----- Data structures ---------------------------------------------------*/

struct bench_time {
  unsigned f;
#define BTF_TIMEOK 1u
#define BTF_CYOK 2u
#define BTF_ANY (BTF_TIMEOK | BTF_CYOK)
  kludge64 s; uint32 ns;
  kludge64 cy;
};

struct bench_timing {
  unsigned f;
  unsigned long n;
  double t, cy;
};

struct bench_timer { const struct bench_timerops *ops; };

struct bench_timerops {
  void (*now)(struct bench_timer */*bt*/, struct bench_time */*t_out*/);
  void (*destroy)(struct bench_timer */*bt*/);
};

struct bench_state {
  struct bench_timer *tm;
  double target_s;
  unsigned f;
  struct { double m, c; } clk, cy;
};

typedef void bench_fn(unsigned long /*n*/, void */*p*/);

/*----- Functions provided ------------------------------------------------*/

extern struct bench_timer *bench_createtimer(void);

extern void bench_init(struct bench_state *b, struct bench_timer *tm);

extern void bench_destroy(struct bench_state *b);

extern int bench_calibrate(struct bench_state */*b*/);

extern int bench_measure(struct bench_timing */*t_out*/,
			 struct bench_state */*b*/,
			 bench_fn */*fn*/, void */*p*/);

/*----- That's all, folks -------------------------------------------------*/

#ifdef __cplusplus
  }
#endif

#endif