Merge remote-tracking branch 'origin/ovs-dev' into bsd-port
[sliver-openvswitch.git] / lib / vlog.h
index 2dce3c6..e15e441 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2008, 2009, 2010, 2011 Nicira, Inc.
+ * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,6 +22,8 @@
 #include <stdbool.h>
 #include <time.h>
 #include "compiler.h"
+#include "sat-math.h"
+#include "token-bucket.h"
 #include "util.h"
 
 #ifdef  __cplusplus
@@ -87,35 +89,24 @@ struct vlog_module *vlog_module_from_name(const char *name);
 
 /* Rate-limiter for log messages. */
 struct vlog_rate_limit {
-    /* Configuration settings. */
-    unsigned int rate;          /* Tokens per second. */
-    unsigned int burst;         /* Max cumulative tokens credit. */
-
-    /* Current status. */
-    unsigned int tokens;        /* Current number of tokens. */
-    time_t last_fill;           /* Last time tokens added. */
+    struct token_bucket token_bucket;
     time_t first_dropped;       /* Time first message was dropped. */
     time_t last_dropped;        /* Time of most recent message drop. */
     unsigned int n_dropped;     /* Number of messages dropped. */
 };
 
-/* Number of tokens to emit a message.  We add 'rate' tokens per second, which
- * is 60 times the unit used for 'rate', thus 60 tokens are required to emit
- * one message. */
-#define VLOG_MSG_TOKENS 60
+/* Number of tokens to emit a message.  We add 'rate' tokens per millisecond,
+ * thus 60,000 tokens are required to emit one message per minute. */
+#define VLOG_MSG_TOKENS (60 * 1000)
 
 /* Initializer for a struct vlog_rate_limit, to set up a maximum rate of RATE
  * messages per minute and a maximum burst size of BURST messages. */
-#define VLOG_RATE_LIMIT_INIT(RATE, BURST)                   \
-        {                                                   \
-            RATE,                           /* rate */      \
-            (MIN(BURST, UINT_MAX / VLOG_MSG_TOKENS)         \
-             * VLOG_MSG_TOKENS),            /* burst */     \
-            0,                              /* tokens */    \
-            0,                              /* last_fill */ \
-            0,                              /* first_dropped */ \
-            0,                              /* last_dropped */ \
-            0,                              /* n_dropped */ \
+#define VLOG_RATE_LIMIT_INIT(RATE, BURST)                               \
+        {                                                               \
+            TOKEN_BUCKET_INIT(RATE, SAT_MUL(BURST, VLOG_MSG_TOKENS)),   \
+            0,                              /* first_dropped */         \
+            0,                              /* last_dropped */          \
+            0,                              /* n_dropped */             \
         }
 
 /* Configuring how each module logs messages. */