1b2441318SGreg Kroah-Hartman /* SPDX-License-Identifier: GPL-2.0 */
2717115e1SDave Young #ifndef _LINUX_RATELIMIT_H
3717115e1SDave Young #define _LINUX_RATELIMIT_H
4979f693dSIngo Molnar
5*b4a461e7SHerbert Xu #include <linux/ratelimit_types.h>
66b1d174bSBorislav Petkov #include <linux/sched.h>
7f40c396aSOGAWA Hirofumi #include <linux/spinlock.h>
8717115e1SDave Young
ratelimit_state_init(struct ratelimit_state * rs,int interval,int burst)9f40c396aSOGAWA Hirofumi static inline void ratelimit_state_init(struct ratelimit_state *rs,
10f40c396aSOGAWA Hirofumi int interval, int burst)
11f40c396aSOGAWA Hirofumi {
126b1d174bSBorislav Petkov memset(rs, 0, sizeof(*rs));
136b1d174bSBorislav Petkov
1407354eb1SThomas Gleixner raw_spin_lock_init(&rs->lock);
15f40c396aSOGAWA Hirofumi rs->interval = interval;
16f40c396aSOGAWA Hirofumi rs->burst = burst;
176b1d174bSBorislav Petkov }
186b1d174bSBorislav Petkov
ratelimit_default_init(struct ratelimit_state * rs)196b1d174bSBorislav Petkov static inline void ratelimit_default_init(struct ratelimit_state *rs)
206b1d174bSBorislav Petkov {
216b1d174bSBorislav Petkov return ratelimit_state_init(rs, DEFAULT_RATELIMIT_INTERVAL,
226b1d174bSBorislav Petkov DEFAULT_RATELIMIT_BURST);
236b1d174bSBorislav Petkov }
246b1d174bSBorislav Petkov
ratelimit_state_exit(struct ratelimit_state * rs)256b1d174bSBorislav Petkov static inline void ratelimit_state_exit(struct ratelimit_state *rs)
266b1d174bSBorislav Petkov {
276b1d174bSBorislav Petkov if (!(rs->flags & RATELIMIT_MSG_ON_RELEASE))
286b1d174bSBorislav Petkov return;
296b1d174bSBorislav Petkov
306b1d174bSBorislav Petkov if (rs->missed) {
316b1d174bSBorislav Petkov pr_warn("%s: %d output lines suppressed due to ratelimiting\n",
326b1d174bSBorislav Petkov current->comm, rs->missed);
33f40c396aSOGAWA Hirofumi rs->missed = 0;
346b1d174bSBorislav Petkov }
356b1d174bSBorislav Petkov }
366b1d174bSBorislav Petkov
376b1d174bSBorislav Petkov static inline void
ratelimit_set_flags(struct ratelimit_state * rs,unsigned long flags)386b1d174bSBorislav Petkov ratelimit_set_flags(struct ratelimit_state *rs, unsigned long flags)
396b1d174bSBorislav Petkov {
406b1d174bSBorislav Petkov rs->flags = flags;
41f40c396aSOGAWA Hirofumi }
42f40c396aSOGAWA Hirofumi
43f5d87d85SNamhyung Kim extern struct ratelimit_state printk_ratelimit_state;
44f5d87d85SNamhyung Kim
4586e4ca66SDavid S. Miller #ifdef CONFIG_PRINTK
4686e4ca66SDavid S. Miller
471b011e2fSJiri Slaby #define WARN_ON_RATELIMIT(condition, state) ({ \
481b011e2fSJiri Slaby bool __rtn_cond = !!(condition); \
491b011e2fSJiri Slaby WARN_ON(__rtn_cond && __ratelimit(state)); \
501b011e2fSJiri Slaby __rtn_cond; \
511b011e2fSJiri Slaby })
5286e4ca66SDavid S. Miller
532351a6c6SMarkus Trippelsdorf #define WARN_RATELIMIT(condition, format, ...) \
5486e4ca66SDavid S. Miller ({ \
5586e4ca66SDavid S. Miller static DEFINE_RATELIMIT_STATE(_rs, \
5686e4ca66SDavid S. Miller DEFAULT_RATELIMIT_INTERVAL, \
5786e4ca66SDavid S. Miller DEFAULT_RATELIMIT_BURST); \
582351a6c6SMarkus Trippelsdorf int rtn = !!(condition); \
592351a6c6SMarkus Trippelsdorf \
602351a6c6SMarkus Trippelsdorf if (unlikely(rtn && __ratelimit(&_rs))) \
612351a6c6SMarkus Trippelsdorf WARN(rtn, format, ##__VA_ARGS__); \
622351a6c6SMarkus Trippelsdorf \
632351a6c6SMarkus Trippelsdorf rtn; \
6486e4ca66SDavid S. Miller })
6586e4ca66SDavid S. Miller
6686e4ca66SDavid S. Miller #else
6786e4ca66SDavid S. Miller
6886e4ca66SDavid S. Miller #define WARN_ON_RATELIMIT(condition, state) \
6986e4ca66SDavid S. Miller WARN_ON(condition)
7086e4ca66SDavid S. Miller
712351a6c6SMarkus Trippelsdorf #define WARN_RATELIMIT(condition, format, ...) \
7286e4ca66SDavid S. Miller ({ \
732351a6c6SMarkus Trippelsdorf int rtn = WARN(condition, format, ##__VA_ARGS__); \
7486e4ca66SDavid S. Miller rtn; \
7586e4ca66SDavid S. Miller })
7686e4ca66SDavid S. Miller
7786e4ca66SDavid S. Miller #endif
7886e4ca66SDavid S. Miller
79979f693dSIngo Molnar #endif /* _LINUX_RATELIMIT_H */
80