ratelimit.c 1.61 KB
Newer Older
1 2 3 4 5
/*
 * ratelimit.c - Do something with rate limit.
 *
 * Isolated from kernel/printk.c by Dave Young <hidave.darkstar@gmail.com>
 *
Dave Young's avatar
Dave Young committed
6 7 8
 * 2008-05-01 rewrite the function and use a ratelimit_state data struct as
 * parameter. Now every user can use their own standalone ratelimit_state.
 *
9 10 11
 * This file is released under the GPLv2.
 */

12
#include <linux/ratelimit.h>
13
#include <linux/jiffies.h>
14
#include <linux/export.h>
15 16 17

/*
 * __ratelimit - rate limiting
Dave Young's avatar
Dave Young committed
18
 * @rs: ratelimit_state data
19
 * @func: name of calling function
20
 *
21 22 23 24 25 26
 * This enforces a rate limit: not more than @rs->burst callbacks
 * in every @rs->interval
 *
 * RETURNS:
 * 0 means callbacks will be suppressed.
 * 1 means go ahead and do it.
27
 */
28
int ___ratelimit(struct ratelimit_state *rs, const char *func)
29
{
30
	unsigned long flags;
31
	int ret;
32

Dave Young's avatar
Dave Young committed
33 34
	if (!rs->interval)
		return 1;
35

36 37 38 39 40 41
	/*
	 * If we contend on this state's lock then almost
	 * by definition we are too busy to print a message,
	 * in addition to the one that will be printed by
	 * the entity that is holding the lock already:
	 */
42
	if (!raw_spin_trylock_irqsave(&rs->lock, flags))
43
		return 0;
44

Dave Young's avatar
Dave Young committed
45 46
	if (!rs->begin)
		rs->begin = jiffies;
47

Dave Young's avatar
Dave Young committed
48
	if (time_is_before_jiffies(rs->begin + rs->interval)) {
49 50
		if (rs->missed) {
			if (!(rs->flags & RATELIMIT_MSG_ON_RELEASE)) {
51 52 53
				printk_deferred(KERN_WARNING
						"%s: %d callbacks suppressed\n",
						func, rs->missed);
54 55 56
				rs->missed = 0;
			}
		}
57
		rs->begin   = jiffies;
Dave Young's avatar
Dave Young committed
58
		rs->printed = 0;
59
	}
60 61 62 63 64 65 66
	if (rs->burst && rs->burst > rs->printed) {
		rs->printed++;
		ret = 1;
	} else {
		rs->missed++;
		ret = 0;
	}
67
	raw_spin_unlock_irqrestore(&rs->lock, flags);
Dave Young's avatar
Dave Young committed
68

69
	return ret;
70
}
71
EXPORT_SYMBOL(___ratelimit);