Merge lp:~kamstrup/dee/benchmark into lp:dee

[Mikkel Kamstrup Erlandsen]

Add a small simple benchmark suite

This branch adds a new make target 'benchmark' or stand alone executable
to the test suite tests/test-benchmark.

It produces some simple statistical output and it's easy to add new
benchmarks in there.

[Michal Hruby (mhr3)]

Awesome!

review: Approve

=== modified file 'Makefile.am'
--- Makefile.am	2011-11-24 21:36:17 +0000
+++ Makefile.am	2011-12-07 15:49:34 +0000
@@ -20,3 +20,6 @@
 	COPYING.GPL
 
 DISTCHECK_CONFIGURE_FLAGS = --enable-gtk-doc --enable-introspection=no
+
+benchmark:
+	cd tests && make benchmark

=== modified file 'tests/Makefile.am'
--- tests/Makefile.am	2011-11-29 16:36:04 +0000
+++ tests/Makefile.am	2011-12-07 15:49:34 +0000
@@ -1,5 +1,24 @@
 noinst_PROGRAMS = \
-  test-dee
+  test-dee \
+  test-benchmark
+
+AM_CPPFLAGS = \
+	-I$(top_srcdir) \
+	-I$(top_srcdir)/dee \
+	-I$(top_srcdir)/dee \
+	-DTESTDIR=\""$(top_builddir)/tests"\" \
+	-DDEE_COMPILATION \
+  $(GCC_FLAGS) \
+	$(DEE_CFLAGS) \
+	$(MAINTAINER_CFLAGS)
+
+test_benchmark_SOURCES = \
+  test-benchmark.c
+
+test_benchmark_LDADD = $(top_builddir)/dee/libdee-1.0.la $(DEE_LIBS) -lm
+
+benchmark: test-benchmark
+	./test-benchmark
 
 test_dee_SOURCES = \
   test-dee.c \
@@ -19,22 +38,12 @@
   test-resource-manager.c \
   $(top_srcdir)/dee/dee-glist-result-set.h
 
-test_dee_CPPFLAGS = \
-	-I$(top_srcdir) \
-	-I$(top_srcdir)/dee \
-	-I$(top_srcdir)/dee \
-	-DTESTDIR=\""$(top_builddir)/tests"\" \
-	-DDEE_COMPILATION \
-  $(GCC_FLAGS) \
-	$(DEE_CFLAGS) \
-	$(MAINTAINER_CFLAGS)
-
 test_dee_LDADD = $(top_builddir)/dee/libdee-1.0.la $(DEE_LIBS)
 
 if HAVE_GTX
 test_dee_SOURCES += test-model-interactions.c
 test_dee_SOURCES += test-peer-interactions.c
-test_dee_CPPFLAGS += $(GTX_CFLAGS)
+AM_CPPFLAGS += $(GTX_CFLAGS)
 test_dee_LDADD += $(GTX_LIBS)
 
 model_helpers = \
@@ -56,15 +65,12 @@
   $(peer_helpers:.c=)
 
 model_helper_clone3rows_SOURCES = model-helper-clone3rows.c
-model_helper_clone3rows_CPPFLAGS = $(test_dee_CPPFLAGS)
 model_helper_clone3rows_LDADD = $(test_dee_LDADD)
 
 model_helper_add3rows_SOURCES = model-helper-add3rows.c
-model_helper_add3rows_CPPFLAGS = $(test_dee_CPPFLAGS)
 model_helper_add3rows_LDADD = $(test_dee_LDADD)
 
 model_helper_change3rows_SOURCES = model-helper-change3rows.c
-model_helper_change3rows_CPPFLAGS = $(test_dee_CPPFLAGS)
 model_helper_change3rows_LDADD = $(test_dee_LDADD)
 
 model_helper_remove3rows_SOURCES = model-helper-remove3rows.c
@@ -72,11 +78,9 @@
 model_helper_remove3rows_LDADD = $(test_dee_LDADD)
 
 model_helper_clear3rows_SOURCES = model-helper-clear3rows.c
-model_helper_clear3rows_CPPFLAGS = $(test_dee_CPPFLAGS)
 model_helper_clear3rows_LDADD = $(test_dee_LDADD)
 
 model_helper_clear3add5_SOURCES = model-helper-clear3add5.c
-model_helper_clear3add5_CPPFLAGS = $(test_dee_CPPFLAGS)
 model_helper_clear3add5_LDADD = $(test_dee_LDADD)
 
 model_helper_insert1row_SOURCES = model-helper-insert1row.c
@@ -84,15 +88,12 @@
 model_helper_insert1row_LDADD = $(test_dee_LDADD)
 
 model_helper_schemaless_SOURCES = model-helper-schemaless.c
-model_helper_schemaless_CPPFLAGS = $(test_dee_CPPFLAGS)
 model_helper_schemaless_LDADD = $(test_dee_LDADD)
 
 model_helper_introspect_SOURCES = model-helper-introspect.c
-model_helper_introspect_CPPFLAGS = $(test_dee_CPPFLAGS)
 model_helper_introspect_LDADD = $(test_dee_LDADD)
 
 peer_helper_1peer_SOURCES = peer-helper-1peer.c
-peer_helper_1peer_CPPFLAGS = $(test_dee_CPPFLAGS)
 peer_helper_1peer_LDADD = $(test_dee_LDADD)
 
 endif # HAVE_GTX
@@ -147,3 +148,4 @@
 
 clean-generic:
 	rm -rf test-dee-results.xml test-dee-results.html dee-test-resource-manager
+

=== added file 'tests/test-benchmark.c'
--- tests/test-benchmark.c	1970-01-01 00:00:00 +0000
+++ tests/test-benchmark.c	2011-12-07 15:49:34 +0000
@@ -0,0 +1,192 @@
+/*
+ * Copyright (C) 2011 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as 
+ * published by the Free Software Foundation.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by
+ *              Mikkel Kamstrup Erlandsen <[e-mail]>
+ *
+ */
+
+#include "config.h"
+#include <math.h>
+#include <glib.h>
+#include <glib/gprintf.h>
+#include <glib-object.h>
+
+#include <dee.h>
+
+typedef struct _Benchmark Benchmark;
+typedef void (*BenchmarkFunc) (Benchmark *benchmark);
+typedef void (*BenchmarkSetup) (Benchmark *benchmark);
+typedef void (*BenchmarkTeardown) (Benchmark *benchmark);
+
+typedef struct {
+  gdouble elapsed;
+} RunData;
+
+struct _Benchmark {
+  const gchar       *name;
+  BenchmarkSetup     benchmark_setup;
+  BenchmarkFunc      benchmark_func;
+  BenchmarkTeardown  benchmark_teardown;
+  guint              n_runs;
+  RunData           *runs;
+  gpointer           state;
+};
+
+static GList *benchmarks = NULL;
+
+static void
+add_benchmark (Benchmark *benchmark)
+{
+  benchmarks = g_list_append (benchmarks, benchmark);
+}
+
+static void
+run_benchmark (Benchmark *bench)
+{
+  GTimer *timer;
+  guint   i;
+  gdouble total_runtime, avg_runtime, std_dev;
+  
+  bench->runs = g_new0 (RunData, bench->n_runs + 1);
+  timer = g_timer_new ();
+  total_runtime = 0;
+  
+  bench->benchmark_setup (bench);
+  
+  g_printf ("=== %s ===\n", bench->name);
+      
+  for (i = 0; i < bench->n_runs; i++)
+  {
+    g_timer_start (timer);
+    bench->benchmark_func (bench);
+    bench->runs[i].elapsed = g_timer_elapsed (timer, NULL);
+    total_runtime += bench->runs[i].elapsed;
+  }
+  
+  /* Compute average runtime */
+  avg_runtime = total_runtime / bench->n_runs;
+  
+  /* Compute standard deviation */
+  std_dev = 0;
+  for (i = 0; i < bench->n_runs; i++)
+    {
+      gdouble delta = bench->runs[i].elapsed - avg_runtime;
+      std_dev += delta * delta;
+    }
+  std_dev = sqrt (std_dev / bench->n_runs);
+  
+  /* Print report */
+  g_printf ("Runs           : %u\n", bench->n_runs);
+  g_printf ("Total runtime  : %fs\n", total_runtime);
+  g_printf ("Avg. runtime   : %fs\n", avg_runtime);
+  g_printf ("Std. deviation : %fs\n", std_dev);
+  g_printf ("\n");
+  
+  
+  
+  g_timer_destroy (timer);
+  bench->benchmark_teardown (bench);
+  // purposely leak bench->runs. Caller may want it
+}
+
+static void
+run_benchmarks (void)
+{
+  GList  *iter;
+  
+  for (iter = benchmarks; iter; iter = iter->next)
+    {
+      Benchmark *bench = (Benchmark*) iter->data;
+      run_benchmark (bench);
+    }
+}
+
+static void
+bench_seqmodel_setup (Benchmark *bench)
+{
+  DeeModel *model;
+  
+  model = dee_sequence_model_new ();
+  dee_model_set_schema (model, "s", "s", "s", "u", "b", NULL);
+  bench->state = model;
+}
+
+static void
+bench_seqmodel_append_run (Benchmark *bench)
+{
+  DeeModel *model;
+  guint     limit = 1000, i;
+  
+  g_assert (DEE_IS_MODEL (bench->state));
+  
+  model = DEE_MODEL (bench->state);
+  
+  for (i = 0; i < limit; i++)
+    {
+      dee_model_append (model, "Hello", "world", "!", 42, TRUE);
+    }
+}
+
+static void
+bench_seqmodel_prepend_run (Benchmark *bench)
+{
+  DeeModel *model;
+  guint     limit = 1000, i;
+  
+  g_assert (DEE_IS_MODEL (bench->state));
+  
+  model = DEE_MODEL (bench->state);
+  
+  for (i = 0; i < limit; i++)
+    {
+      dee_model_prepend (model, "Hello", "world", "!", 42, TRUE);
+    }
+}
+
+static void
+bench_gobject_teardown (Benchmark *bench)
+{
+  GObject *obj;
+  
+  obj = G_OBJECT (bench->state);
+  g_object_unref (obj);
+}
+
+gint
+main (gint argc, gchar *argv[])
+{
+  g_type_init ();
+  g_thread_init (NULL);
+
+  Benchmark seqmodel_append = { "SequenceModel.append()",
+                                bench_seqmodel_setup,
+                                bench_seqmodel_append_run,
+                                bench_gobject_teardown,
+                                10,
+                                NULL };
+  add_benchmark (&seqmodel_append);
+  
+  Benchmark seqmodel_prepend = { "SequenceModel.prepend()",
+                                bench_seqmodel_setup,
+                                bench_seqmodel_prepend_run,
+                                bench_gobject_teardown,
+                                10,
+                                NULL };
+  add_benchmark (&seqmodel_prepend);
+
+  run_benchmarks ();
+  return 0;
+}