mirror of
https://github.com/edk2-porting/linux-next.git
synced 2024-12-24 13:13:57 +08:00
1b011e2f13
The macro is to be used similarly as WARN_ON as: if (WARN_ON_RATELIMIT(condition, state)) do_something(); One would expect only 'condition' to affect the 'if', but WARN_ON_RATELIMIT does internally only: WARN_ON((condition) && __ratelimit(state)) So the 'if' is affected by the ratelimiting state too. Fix this by returning 'condition' in any case. Note that nobody uses WARN_ON_RATELIMIT yet, so there is nothing to worry about. But I was about to use it and was a bit surprised. Link: http://lkml.kernel.org/r/20161215093224.23126-1-jslaby@suse.cz Signed-off-by: Jiri Slaby <jslaby@suse.cz> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
113 lines
2.6 KiB
C
113 lines
2.6 KiB
C
#ifndef _LINUX_RATELIMIT_H
|
|
#define _LINUX_RATELIMIT_H
|
|
|
|
#include <linux/param.h>
|
|
#include <linux/sched.h>
|
|
#include <linux/spinlock.h>
|
|
|
|
#define DEFAULT_RATELIMIT_INTERVAL (5 * HZ)
|
|
#define DEFAULT_RATELIMIT_BURST 10
|
|
|
|
/* issue num suppressed message on exit */
|
|
#define RATELIMIT_MSG_ON_RELEASE BIT(0)
|
|
|
|
struct ratelimit_state {
|
|
raw_spinlock_t lock; /* protect the state */
|
|
|
|
int interval;
|
|
int burst;
|
|
int printed;
|
|
int missed;
|
|
unsigned long begin;
|
|
unsigned long flags;
|
|
};
|
|
|
|
#define RATELIMIT_STATE_INIT(name, interval_init, burst_init) { \
|
|
.lock = __RAW_SPIN_LOCK_UNLOCKED(name.lock), \
|
|
.interval = interval_init, \
|
|
.burst = burst_init, \
|
|
}
|
|
|
|
#define RATELIMIT_STATE_INIT_DISABLED \
|
|
RATELIMIT_STATE_INIT(ratelimit_state, 0, DEFAULT_RATELIMIT_BURST)
|
|
|
|
#define DEFINE_RATELIMIT_STATE(name, interval_init, burst_init) \
|
|
\
|
|
struct ratelimit_state name = \
|
|
RATELIMIT_STATE_INIT(name, interval_init, burst_init) \
|
|
|
|
static inline void ratelimit_state_init(struct ratelimit_state *rs,
|
|
int interval, int burst)
|
|
{
|
|
memset(rs, 0, sizeof(*rs));
|
|
|
|
raw_spin_lock_init(&rs->lock);
|
|
rs->interval = interval;
|
|
rs->burst = burst;
|
|
}
|
|
|
|
static inline void ratelimit_default_init(struct ratelimit_state *rs)
|
|
{
|
|
return ratelimit_state_init(rs, DEFAULT_RATELIMIT_INTERVAL,
|
|
DEFAULT_RATELIMIT_BURST);
|
|
}
|
|
|
|
static inline void ratelimit_state_exit(struct ratelimit_state *rs)
|
|
{
|
|
if (!(rs->flags & RATELIMIT_MSG_ON_RELEASE))
|
|
return;
|
|
|
|
if (rs->missed) {
|
|
pr_warn("%s: %d output lines suppressed due to ratelimiting\n",
|
|
current->comm, rs->missed);
|
|
rs->missed = 0;
|
|
}
|
|
}
|
|
|
|
static inline void
|
|
ratelimit_set_flags(struct ratelimit_state *rs, unsigned long flags)
|
|
{
|
|
rs->flags = flags;
|
|
}
|
|
|
|
extern struct ratelimit_state printk_ratelimit_state;
|
|
|
|
extern int ___ratelimit(struct ratelimit_state *rs, const char *func);
|
|
#define __ratelimit(state) ___ratelimit(state, __func__)
|
|
|
|
#ifdef CONFIG_PRINTK
|
|
|
|
#define WARN_ON_RATELIMIT(condition, state) ({ \
|
|
bool __rtn_cond = !!(condition); \
|
|
WARN_ON(__rtn_cond && __ratelimit(state)); \
|
|
__rtn_cond; \
|
|
})
|
|
|
|
#define WARN_RATELIMIT(condition, format, ...) \
|
|
({ \
|
|
static DEFINE_RATELIMIT_STATE(_rs, \
|
|
DEFAULT_RATELIMIT_INTERVAL, \
|
|
DEFAULT_RATELIMIT_BURST); \
|
|
int rtn = !!(condition); \
|
|
\
|
|
if (unlikely(rtn && __ratelimit(&_rs))) \
|
|
WARN(rtn, format, ##__VA_ARGS__); \
|
|
\
|
|
rtn; \
|
|
})
|
|
|
|
#else
|
|
|
|
#define WARN_ON_RATELIMIT(condition, state) \
|
|
WARN_ON(condition)
|
|
|
|
#define WARN_RATELIMIT(condition, format, ...) \
|
|
({ \
|
|
int rtn = WARN(condition, format, ##__VA_ARGS__); \
|
|
rtn; \
|
|
})
|
|
|
|
#endif
|
|
|
|
#endif /* _LINUX_RATELIMIT_H */
|