/* Kernel module to control the rate
|
/* Kernel module to control the rate
|
*
|
*
|
* Jérôme de Vivie <devivie@info.enserb.u-bordeaux.fr>
|
* Jérôme de Vivie <devivie@info.enserb.u-bordeaux.fr>
|
* Hervé Eychenne <eychenne@info.enserb.u-bordeaux.fr>
|
* Hervé Eychenne <eychenne@info.enserb.u-bordeaux.fr>
|
*
|
*
|
* 2 September 1999: Changed from the target RATE to the match
|
* 2 September 1999: Changed from the target RATE to the match
|
* `limit', removed logging. Did I mention that
|
* `limit', removed logging. Did I mention that
|
* Alexey is a fucking genius?
|
* Alexey is a fucking genius?
|
* Rusty Russell (rusty@rustcorp.com.au). */
|
* Rusty Russell (rusty@rustcorp.com.au). */
|
#include <linux/module.h>
|
#include <linux/module.h>
|
#include <linux/skbuff.h>
|
#include <linux/skbuff.h>
|
#include <linux/spinlock.h>
|
#include <linux/spinlock.h>
|
#include <linux/interrupt.h>
|
#include <linux/interrupt.h>
|
|
|
#include <linux/netfilter_ipv4/ip_tables.h>
|
#include <linux/netfilter_ipv4/ip_tables.h>
|
#include <linux/netfilter_ipv4/ipt_limit.h>
|
#include <linux/netfilter_ipv4/ipt_limit.h>
|
|
|
/* The algorithm used is the Simple Token Bucket Filter (TBF)
|
/* The algorithm used is the Simple Token Bucket Filter (TBF)
|
* see net/sched/sch_tbf.c in the linux source tree
|
* see net/sched/sch_tbf.c in the linux source tree
|
*/
|
*/
|
|
|
static spinlock_t limit_lock = SPIN_LOCK_UNLOCKED;
|
static spinlock_t limit_lock = SPIN_LOCK_UNLOCKED;
|
|
|
/* Rusty: This is my (non-mathematically-inclined) understanding of
|
/* Rusty: This is my (non-mathematically-inclined) understanding of
|
this algorithm. The `average rate' in jiffies becomes your initial
|
this algorithm. The `average rate' in jiffies becomes your initial
|
amount of credit `credit' and the most credit you can ever have
|
amount of credit `credit' and the most credit you can ever have
|
`credit_cap'. The `peak rate' becomes the cost of passing the
|
`credit_cap'. The `peak rate' becomes the cost of passing the
|
test, `cost'.
|
test, `cost'.
|
|
|
`prev' tracks the last packet hit: you gain one credit per jiffy.
|
`prev' tracks the last packet hit: you gain one credit per jiffy.
|
If you get credit balance more than this, the extra credit is
|
If you get credit balance more than this, the extra credit is
|
discarded. Every time the match passes, you lose `cost' credits;
|
discarded. Every time the match passes, you lose `cost' credits;
|
if you don't have that many, the test fails.
|
if you don't have that many, the test fails.
|
|
|
See Alexey's formal explanation in net/sched/sch_tbf.c.
|
See Alexey's formal explanation in net/sched/sch_tbf.c.
|
|
|
To get the maxmum range, we multiply by this factor (ie. you get N
|
To get the maxmum range, we multiply by this factor (ie. you get N
|
credits per jiffy). We want to allow a rate as low as 1 per day
|
credits per jiffy). We want to allow a rate as low as 1 per day
|
(slowest userspace tool allows), which means
|
(slowest userspace tool allows), which means
|
CREDITS_PER_JIFFY*HZ*60*60*24 < 2^32. ie. */
|
CREDITS_PER_JIFFY*HZ*60*60*24 < 2^32. ie. */
|
#define MAX_CPJ (0xFFFFFFFF / (HZ*60*60*24))
|
#define MAX_CPJ (0xFFFFFFFF / (HZ*60*60*24))
|
|
|
/* Repeated shift and or gives us all 1s, final shift and add 1 gives
|
/* Repeated shift and or gives us all 1s, final shift and add 1 gives
|
* us the power of 2 below the theoretical max, so GCC simply does a
|
* us the power of 2 below the theoretical max, so GCC simply does a
|
* shift. */
|
* shift. */
|
#define _POW2_BELOW2(x) ((x)|((x)>>1))
|
#define _POW2_BELOW2(x) ((x)|((x)>>1))
|
#define _POW2_BELOW4(x) (_POW2_BELOW2(x)|_POW2_BELOW2((x)>>2))
|
#define _POW2_BELOW4(x) (_POW2_BELOW2(x)|_POW2_BELOW2((x)>>2))
|
#define _POW2_BELOW8(x) (_POW2_BELOW4(x)|_POW2_BELOW4((x)>>4))
|
#define _POW2_BELOW8(x) (_POW2_BELOW4(x)|_POW2_BELOW4((x)>>4))
|
#define _POW2_BELOW16(x) (_POW2_BELOW8(x)|_POW2_BELOW8((x)>>8))
|
#define _POW2_BELOW16(x) (_POW2_BELOW8(x)|_POW2_BELOW8((x)>>8))
|
#define _POW2_BELOW32(x) (_POW2_BELOW16(x)|_POW2_BELOW16((x)>>16))
|
#define _POW2_BELOW32(x) (_POW2_BELOW16(x)|_POW2_BELOW16((x)>>16))
|
#define POW2_BELOW32(x) ((_POW2_BELOW32(x)>>1) + 1)
|
#define POW2_BELOW32(x) ((_POW2_BELOW32(x)>>1) + 1)
|
|
|
#define CREDITS_PER_JIFFY POW2_BELOW32(MAX_CPJ)
|
#define CREDITS_PER_JIFFY POW2_BELOW32(MAX_CPJ)
|
|
|
static int
|
static int
|
ipt_limit_match(const struct sk_buff *skb,
|
ipt_limit_match(const struct sk_buff *skb,
|
const struct net_device *in,
|
const struct net_device *in,
|
const struct net_device *out,
|
const struct net_device *out,
|
const void *matchinfo,
|
const void *matchinfo,
|
int offset,
|
int offset,
|
const void *hdr,
|
const void *hdr,
|
u_int16_t datalen,
|
u_int16_t datalen,
|
int *hotdrop)
|
int *hotdrop)
|
{
|
{
|
struct ipt_rateinfo *r = ((struct ipt_rateinfo *)matchinfo)->master;
|
struct ipt_rateinfo *r = ((struct ipt_rateinfo *)matchinfo)->master;
|
unsigned long now = jiffies;
|
unsigned long now = jiffies;
|
|
|
spin_lock_bh(&limit_lock);
|
spin_lock_bh(&limit_lock);
|
r->credit += (now - xchg(&r->prev, now)) * CREDITS_PER_JIFFY;
|
r->credit += (now - xchg(&r->prev, now)) * CREDITS_PER_JIFFY;
|
if (r->credit > r->credit_cap)
|
if (r->credit > r->credit_cap)
|
r->credit = r->credit_cap;
|
r->credit = r->credit_cap;
|
|
|
if (r->credit >= r->cost) {
|
if (r->credit >= r->cost) {
|
/* We're not limited. */
|
/* We're not limited. */
|
r->credit -= r->cost;
|
r->credit -= r->cost;
|
spin_unlock_bh(&limit_lock);
|
spin_unlock_bh(&limit_lock);
|
return 1;
|
return 1;
|
}
|
}
|
|
|
spin_unlock_bh(&limit_lock);
|
spin_unlock_bh(&limit_lock);
|
return 0;
|
return 0;
|
}
|
}
|
|
|
/* Precision saver. */
|
/* Precision saver. */
|
static u_int32_t
|
static u_int32_t
|
user2credits(u_int32_t user)
|
user2credits(u_int32_t user)
|
{
|
{
|
/* If multiplying would overflow... */
|
/* If multiplying would overflow... */
|
if (user > 0xFFFFFFFF / (HZ*CREDITS_PER_JIFFY))
|
if (user > 0xFFFFFFFF / (HZ*CREDITS_PER_JIFFY))
|
/* Divide first. */
|
/* Divide first. */
|
return (user / IPT_LIMIT_SCALE) * HZ * CREDITS_PER_JIFFY;
|
return (user / IPT_LIMIT_SCALE) * HZ * CREDITS_PER_JIFFY;
|
|
|
return (user * HZ * CREDITS_PER_JIFFY) / IPT_LIMIT_SCALE;
|
return (user * HZ * CREDITS_PER_JIFFY) / IPT_LIMIT_SCALE;
|
}
|
}
|
|
|
static int
|
static int
|
ipt_limit_checkentry(const char *tablename,
|
ipt_limit_checkentry(const char *tablename,
|
const struct ipt_ip *ip,
|
const struct ipt_ip *ip,
|
void *matchinfo,
|
void *matchinfo,
|
unsigned int matchsize,
|
unsigned int matchsize,
|
unsigned int hook_mask)
|
unsigned int hook_mask)
|
{
|
{
|
struct ipt_rateinfo *r = matchinfo;
|
struct ipt_rateinfo *r = matchinfo;
|
|
|
if (matchsize != IPT_ALIGN(sizeof(struct ipt_rateinfo)))
|
if (matchsize != IPT_ALIGN(sizeof(struct ipt_rateinfo)))
|
return 0;
|
return 0;
|
|
|
/* Check for overflow. */
|
/* Check for overflow. */
|
if (r->burst == 0
|
if (r->burst == 0
|
|| user2credits(r->avg * r->burst) < user2credits(r->avg)) {
|
|| user2credits(r->avg * r->burst) < user2credits(r->avg)) {
|
printk("Overflow in ipt_limit, try lower: %u/%u\n",
|
printk("Overflow in ipt_limit, try lower: %u/%u\n",
|
r->avg, r->burst);
|
r->avg, r->burst);
|
return 0;
|
return 0;
|
}
|
}
|
|
|
/* User avg in seconds * IPT_LIMIT_SCALE: convert to jiffies *
|
/* User avg in seconds * IPT_LIMIT_SCALE: convert to jiffies *
|
128. */
|
128. */
|
r->prev = jiffies;
|
r->prev = jiffies;
|
r->credit = user2credits(r->avg * r->burst); /* Credits full. */
|
r->credit = user2credits(r->avg * r->burst); /* Credits full. */
|
r->credit_cap = user2credits(r->avg * r->burst); /* Credits full. */
|
r->credit_cap = user2credits(r->avg * r->burst); /* Credits full. */
|
r->cost = user2credits(r->avg);
|
r->cost = user2credits(r->avg);
|
|
|
/* For SMP, we only want to use one set of counters. */
|
/* For SMP, we only want to use one set of counters. */
|
r->master = r;
|
r->master = r;
|
|
|
return 1;
|
return 1;
|
}
|
}
|
|
|
static struct ipt_match ipt_limit_reg
|
static struct ipt_match ipt_limit_reg
|
= { { NULL, NULL }, "limit", ipt_limit_match, ipt_limit_checkentry, NULL,
|
= { { NULL, NULL }, "limit", ipt_limit_match, ipt_limit_checkentry, NULL,
|
THIS_MODULE };
|
THIS_MODULE };
|
|
|
static int __init init(void)
|
static int __init init(void)
|
{
|
{
|
if (ipt_register_match(&ipt_limit_reg))
|
if (ipt_register_match(&ipt_limit_reg))
|
return -EINVAL;
|
return -EINVAL;
|
return 0;
|
return 0;
|
}
|
}
|
|
|
static void __exit fini(void)
|
static void __exit fini(void)
|
{
|
{
|
ipt_unregister_match(&ipt_limit_reg);
|
ipt_unregister_match(&ipt_limit_reg);
|
}
|
}
|
|
|
module_init(init);
|
module_init(init);
|
module_exit(fini);
|
module_exit(fini);
|
MODULE_LICENSE("GPL");
|
MODULE_LICENSE("GPL");
|
|
|
