Setting tag sliver-openvswitch-2.2.90-1
[sliver-openvswitch.git] / lib / coverage.h
index aa93630..0b41b00 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009 Nicira Networks.
+ * Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * for traditional coverage instrumentation with e.g. "gcov", but it is still
  * a useful debugging tool. */
 
+#include "ovs-thread.h"
 #include "vlog.h"
+#include "compiler.h"
+
+/* Makes coverage_run run every 5000 ms (5 seconds).
+ * If this value is redefined, the new value must
+ * divide 60000 (1 minute). */
+#define COVERAGE_RUN_INTERVAL    5000
+BUILD_ASSERT_DECL(60000 % COVERAGE_RUN_INTERVAL == 0);
+
+#define COVERAGE_CLEAR_INTERVAL  1000
+BUILD_ASSERT_DECL(COVERAGE_RUN_INTERVAL % COVERAGE_CLEAR_INTERVAL == 0);
+
+/* Defines the moving average array length. */
+#define MIN_AVG_LEN (60000/COVERAGE_RUN_INTERVAL)
+#define HR_AVG_LEN  60
 
 /* A coverage counter. */
 struct coverage_counter {
-    const char *name;           /* Textual name. */
-    unsigned int count;         /* Count within the current epoch. */
-    unsigned long long int total; /* Total count over all epochs. */
+    const char *const name;            /* Textual name. */
+    unsigned int (*const count)(void); /* Gets, zeros this thread's count. */
+    unsigned long long int total;      /* Total count. */
+    unsigned long long int last_total;
+    /* The moving average arrays. */
+    unsigned int min[MIN_AVG_LEN];
+    unsigned int hr[HR_AVG_LEN];
 };
 
-/* Increments the counter with the given NAME.  Coverage counters need not be
- * declared explicitly, but when you add the first coverage counter to a given
- * file, you must also add that file to COVERAGE_FILES in lib/automake.mk. */
-#define COVERAGE_INC(NAME)                              \
-    do {                                                \
-        extern struct coverage_counter NAME##_count;    \
-        NAME##_count.count++;                           \
-    } while (0)
-
-/* Adds AMOUNT to the coverage counter with the given NAME. */
-#define COVERAGE_ADD(NAME, AMOUNT)                      \
-    do {                                                \
-        extern struct coverage_counter NAME##_count;    \
-        NAME##_count.count += AMOUNT;                   \
-    } while (0)
+void coverage_counter_register(struct coverage_counter*);
+
+/* Defines COUNTER.  There must be exactly one such definition at file scope
+ * within a program. */
+#define COVERAGE_DEFINE(COUNTER)                                        \
+        DEFINE_STATIC_PER_THREAD_DATA(unsigned int,                     \
+                                      counter_##COUNTER, 0);            \
+        static unsigned int COUNTER##_count(void)                       \
+        {                                                               \
+            unsigned int *countp = counter_##COUNTER##_get();           \
+            unsigned int count = *countp;                               \
+            *countp = 0;                                                \
+            return count;                                               \
+        }                                                               \
+        static inline void COUNTER##_add(unsigned int n)                \
+        {                                                               \
+            *counter_##COUNTER##_get() += n;                            \
+        }                                                               \
+        extern struct coverage_counter counter_##COUNTER;               \
+        struct coverage_counter counter_##COUNTER                       \
+            = { #COUNTER, COUNTER##_count, 0, 0, {0}, {0} };            \
+        OVS_CONSTRUCTOR(COUNTER##_init) {                               \
+            coverage_counter_register(&counter_##COUNTER);              \
+        }
+
+/* Adds 1 to COUNTER. */
+#define COVERAGE_INC(COUNTER) COVERAGE_ADD(COUNTER, 1)
+
+/* Adds AMOUNT to COUNTER. */
+#define COVERAGE_ADD(COUNTER, AMOUNT) COUNTER##_add(AMOUNT)
 
 void coverage_init(void);
-void coverage_log(enum vlog_level, bool suppress_dups);
+void coverage_log(void);
 void coverage_clear(void);
+void coverage_run(void);
+
+/* Implementation detail. */
+#define COVERAGE_DEFINE__(COUNTER)                              \
 
 #endif /* coverage.h */