blob: 0a260d8a18bf92dc3b8d4b582d3506e169d9dac5 [file] [log] [blame]
Dave Young717115e2008-07-25 01:45:58 -07001#ifndef _LINUX_RATELIMIT_H
2#define _LINUX_RATELIMIT_H
Dave Young717115e2008-07-25 01:45:58 -07003
Ingo Molnar979f6932009-09-22 14:44:11 +02004#include <linux/param.h>
OGAWA Hirofumif40c3962010-05-24 14:33:11 -07005#include <linux/spinlock.h>
Ingo Molnar979f6932009-09-22 14:44:11 +02006
7#define DEFAULT_RATELIMIT_INTERVAL (5 * HZ)
8#define DEFAULT_RATELIMIT_BURST 10
Dave Young717115e2008-07-25 01:45:58 -07009
10struct ratelimit_state {
Thomas Gleixner07354eb2009-07-25 17:50:36 +020011 raw_spinlock_t lock; /* protect the state */
Ingo Molnar979f6932009-09-22 14:44:11 +020012
13 int interval;
14 int burst;
15 int printed;
16 int missed;
17 unsigned long begin;
Dave Young717115e2008-07-25 01:45:58 -070018};
19
Ingo Molnar979f6932009-09-22 14:44:11 +020020#define DEFINE_RATELIMIT_STATE(name, interval_init, burst_init) \
21 \
22 struct ratelimit_state name = { \
Thomas Gleixner07354eb2009-07-25 17:50:36 +020023 .lock = __RAW_SPIN_LOCK_UNLOCKED(name.lock), \
Ingo Molnar979f6932009-09-22 14:44:11 +020024 .interval = interval_init, \
25 .burst = burst_init, \
26 }
Dave Young717115e2008-07-25 01:45:58 -070027
OGAWA Hirofumif40c3962010-05-24 14:33:11 -070028static inline void ratelimit_state_init(struct ratelimit_state *rs,
29 int interval, int burst)
30{
Thomas Gleixner07354eb2009-07-25 17:50:36 +020031 raw_spin_lock_init(&rs->lock);
OGAWA Hirofumif40c3962010-05-24 14:33:11 -070032 rs->interval = interval;
33 rs->burst = burst;
34 rs->printed = 0;
35 rs->missed = 0;
36 rs->begin = 0;
37}
38
Namhyung Kimf5d87d82010-10-26 14:22:49 -070039extern struct ratelimit_state printk_ratelimit_state;
40
Christian Borntraeger5c828712009-10-23 14:58:11 +020041extern int ___ratelimit(struct ratelimit_state *rs, const char *func);
42#define __ratelimit(state) ___ratelimit(state, __func__)
Ingo Molnar979f6932009-09-22 14:44:11 +020043
David S. Miller86e4ca62011-05-26 15:00:31 -040044#ifdef CONFIG_PRINTK
45
46#define WARN_ON_RATELIMIT(condition, state) \
47 WARN_ON((condition) && __ratelimit(state))
48
Markus Trippelsdorf2351a6c2012-10-05 14:57:17 +020049#define WARN_RATELIMIT(condition, format, ...) \
David S. Miller86e4ca62011-05-26 15:00:31 -040050({ \
51 static DEFINE_RATELIMIT_STATE(_rs, \
52 DEFAULT_RATELIMIT_INTERVAL, \
53 DEFAULT_RATELIMIT_BURST); \
Markus Trippelsdorf2351a6c2012-10-05 14:57:17 +020054 int rtn = !!(condition); \
55 \
56 if (unlikely(rtn && __ratelimit(&_rs))) \
57 WARN(rtn, format, ##__VA_ARGS__); \
58 \
59 rtn; \
David S. Miller86e4ca62011-05-26 15:00:31 -040060})
61
62#else
63
64#define WARN_ON_RATELIMIT(condition, state) \
65 WARN_ON(condition)
66
Markus Trippelsdorf2351a6c2012-10-05 14:57:17 +020067#define WARN_RATELIMIT(condition, format, ...) \
David S. Miller86e4ca62011-05-26 15:00:31 -040068({ \
Markus Trippelsdorf2351a6c2012-10-05 14:57:17 +020069 int rtn = WARN(condition, format, ##__VA_ARGS__); \
David S. Miller86e4ca62011-05-26 15:00:31 -040070 rtn; \
71})
72
73#endif
74
Ingo Molnar979f6932009-09-22 14:44:11 +020075#endif /* _LINUX_RATELIMIT_H */