Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * net/sched/gen_estimator.c Simple rate estimator. | |
3 | * | |
4 | * This program is free software; you can redistribute it and/or | |
5 | * modify it under the terms of the GNU General Public License | |
6 | * as published by the Free Software Foundation; either version | |
7 | * 2 of the License, or (at your option) any later version. | |
8 | * | |
9 | * Authors: Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru> | |
1c0d32fd | 10 | * Eric Dumazet <edumazet@google.com> |
1da177e4 LT |
11 | * |
12 | * Changes: | |
13 | * Jamal Hadi Salim - moved it to net/core and reshulfed | |
14 | * names to make it usable in general net subsystem. | |
15 | */ | |
16 | ||
7c0f6ba6 | 17 | #include <linux/uaccess.h> |
1977f032 | 18 | #include <linux/bitops.h> |
1da177e4 LT |
19 | #include <linux/module.h> |
20 | #include <linux/types.h> | |
21 | #include <linux/kernel.h> | |
22 | #include <linux/jiffies.h> | |
23 | #include <linux/string.h> | |
24 | #include <linux/mm.h> | |
25 | #include <linux/socket.h> | |
26 | #include <linux/sockios.h> | |
27 | #include <linux/in.h> | |
28 | #include <linux/errno.h> | |
29 | #include <linux/interrupt.h> | |
30 | #include <linux/netdevice.h> | |
31 | #include <linux/skbuff.h> | |
32 | #include <linux/rtnetlink.h> | |
33 | #include <linux/init.h> | |
5a0e3ad6 | 34 | #include <linux/slab.h> |
1c0d32fd | 35 | #include <linux/seqlock.h> |
1da177e4 LT |
36 | #include <net/sock.h> |
37 | #include <net/gen_stats.h> | |
38 | ||
1c0d32fd ED |
39 | /* This code is NOT intended to be used for statistics collection, |
40 | * its purpose is to provide a base for statistical multiplexing | |
41 | * for controlled load service. | |
42 | * If you need only statistics, run a user level daemon which | |
43 | * periodically reads byte counters. | |
1da177e4 LT |
44 | */ |
45 | ||
1c0d32fd | 46 | struct net_rate_estimator { |
c1a8f1f1 | 47 | struct gnet_stats_basic_packed *bstats; |
1da177e4 | 48 | spinlock_t *stats_lock; |
edb09eb1 | 49 | seqcount_t *running; |
1c0d32fd ED |
50 | struct gnet_stats_basic_cpu __percpu *cpu_bstats; |
51 | u8 ewma_log; | |
52 | u8 intvl_log; /* period : (250ms << intvl_log) */ | |
53 | ||
54 | seqcount_t seq; | |
32f675bb | 55 | u32 last_packets; |
1da177e4 | 56 | u64 last_bytes; |
1c0d32fd ED |
57 | |
58 | u64 avpps; | |
511e11e3 | 59 | u64 avbps; |
1da177e4 | 60 | |
1c0d32fd ED |
61 | unsigned long next_jiffies; |
62 | struct timer_list timer; | |
63 | struct rcu_head rcu; | |
1da177e4 LT |
64 | }; |
65 | ||
1c0d32fd ED |
66 | static void est_fetch_counters(struct net_rate_estimator *e, |
67 | struct gnet_stats_basic_packed *b) | |
1da177e4 | 68 | { |
a5f7add3 | 69 | memset(b, 0, sizeof(*b)); |
1c0d32fd ED |
70 | if (e->stats_lock) |
71 | spin_lock(e->stats_lock); | |
1da177e4 | 72 | |
1c0d32fd | 73 | __gnet_stats_copy_basic(e->running, b, e->cpu_bstats, e->bstats); |
1da177e4 | 74 | |
1c0d32fd ED |
75 | if (e->stats_lock) |
76 | spin_unlock(e->stats_lock); | |
12efa1fa | 77 | |
1da177e4 LT |
78 | } |
79 | ||
e99e88a9 | 80 | static void est_timer(struct timer_list *t) |
4db0acf3 | 81 | { |
e99e88a9 | 82 | struct net_rate_estimator *est = from_timer(est, t, timer); |
1c0d32fd ED |
83 | struct gnet_stats_basic_packed b; |
84 | u64 rate, brate; | |
4db0acf3 | 85 | |
1c0d32fd | 86 | est_fetch_counters(est, &b); |
ca558e18 | 87 | brate = (b.bytes - est->last_bytes) << (10 - est->ewma_log - est->intvl_log); |
1c0d32fd | 88 | brate -= (est->avbps >> est->ewma_log); |
4db0acf3 | 89 | |
ca558e18 | 90 | rate = (u64)(b.packets - est->last_packets) << (10 - est->ewma_log - est->intvl_log); |
1c0d32fd | 91 | rate -= (est->avpps >> est->ewma_log); |
4db0acf3 | 92 | |
1c0d32fd ED |
93 | write_seqcount_begin(&est->seq); |
94 | est->avbps += brate; | |
95 | est->avpps += rate; | |
96 | write_seqcount_end(&est->seq); | |
4db0acf3 | 97 | |
1c0d32fd ED |
98 | est->last_bytes = b.bytes; |
99 | est->last_packets = b.packets; | |
4db0acf3 | 100 | |
1c0d32fd | 101 | est->next_jiffies += ((HZ/4) << est->intvl_log); |
4db0acf3 | 102 | |
1c0d32fd ED |
103 | if (unlikely(time_after_eq(jiffies, est->next_jiffies))) { |
104 | /* Ouch... timer was delayed. */ | |
105 | est->next_jiffies = jiffies + 1; | |
4db0acf3 | 106 | } |
1c0d32fd | 107 | mod_timer(&est->timer, est->next_jiffies); |
4db0acf3 JP |
108 | } |
109 | ||
1da177e4 LT |
110 | /** |
111 | * gen_new_estimator - create a new rate estimator | |
112 | * @bstats: basic statistics | |
e9fc2f05 | 113 | * @cpu_bstats: bstats per cpu |
1da177e4 LT |
114 | * @rate_est: rate estimator statistics |
115 | * @stats_lock: statistics lock | |
edb09eb1 | 116 | * @running: qdisc running seqcount |
1da177e4 LT |
117 | * @opt: rate estimator configuration TLV |
118 | * | |
119 | * Creates a new rate estimator with &bstats as source and &rate_est | |
120 | * as destination. A new timer with the interval specified in the | |
121 | * configuration TLV is created. Upon each interval, the latest statistics | |
122 | * will be read from &bstats and the estimated rate will be stored in | |
e793c0f7 | 123 | * &rate_est with the statistics lock grabbed during this period. |
4ec93edb | 124 | * |
1da177e4 | 125 | * Returns 0 on success or a negative error code. |
0929c2dd | 126 | * |
1da177e4 | 127 | */ |
c1a8f1f1 | 128 | int gen_new_estimator(struct gnet_stats_basic_packed *bstats, |
22e0f8b9 | 129 | struct gnet_stats_basic_cpu __percpu *cpu_bstats, |
1c0d32fd | 130 | struct net_rate_estimator __rcu **rate_est, |
0929c2dd | 131 | spinlock_t *stats_lock, |
edb09eb1 | 132 | seqcount_t *running, |
1e90474c | 133 | struct nlattr *opt) |
1da177e4 | 134 | { |
1e90474c | 135 | struct gnet_estimator *parm = nla_data(opt); |
1c0d32fd ED |
136 | struct net_rate_estimator *old, *est; |
137 | struct gnet_stats_basic_packed b; | |
138 | int intvl_log; | |
1da177e4 | 139 | |
1e90474c | 140 | if (nla_len(opt) < sizeof(*parm)) |
1da177e4 LT |
141 | return -EINVAL; |
142 | ||
1c0d32fd ED |
143 | /* allowed timer periods are : |
144 | * -2 : 250ms, -1 : 500ms, 0 : 1 sec | |
145 | * 1 : 2 sec, 2 : 4 sec, 3 : 8 sec | |
146 | */ | |
1da177e4 LT |
147 | if (parm->interval < -2 || parm->interval > 3) |
148 | return -EINVAL; | |
149 | ||
77d04bd9 | 150 | est = kzalloc(sizeof(*est), GFP_KERNEL); |
1c0d32fd | 151 | if (!est) |
1da177e4 LT |
152 | return -ENOBUFS; |
153 | ||
1c0d32fd ED |
154 | seqcount_init(&est->seq); |
155 | intvl_log = parm->interval + 2; | |
1da177e4 | 156 | est->bstats = bstats; |
1da177e4 | 157 | est->stats_lock = stats_lock; |
edb09eb1 | 158 | est->running = running; |
1da177e4 | 159 | est->ewma_log = parm->ewma_log; |
1c0d32fd | 160 | est->intvl_log = intvl_log; |
22e0f8b9 | 161 | est->cpu_bstats = cpu_bstats; |
1da177e4 | 162 | |
40ca54e3 ED |
163 | if (stats_lock) |
164 | local_bh_disable(); | |
1c0d32fd | 165 | est_fetch_counters(est, &b); |
40ca54e3 ED |
166 | if (stats_lock) |
167 | local_bh_enable(); | |
1c0d32fd ED |
168 | est->last_bytes = b.bytes; |
169 | est->last_packets = b.packets; | |
170 | old = rcu_dereference_protected(*rate_est, 1); | |
171 | if (old) { | |
172 | del_timer_sync(&old->timer); | |
173 | est->avbps = old->avbps; | |
174 | est->avpps = old->avpps; | |
1da177e4 | 175 | } |
0929c2dd | 176 | |
1c0d32fd | 177 | est->next_jiffies = jiffies + ((HZ/4) << intvl_log); |
e99e88a9 | 178 | timer_setup(&est->timer, est_timer, 0); |
1c0d32fd | 179 | mod_timer(&est->timer, est->next_jiffies); |
4db0acf3 | 180 | |
1c0d32fd ED |
181 | rcu_assign_pointer(*rate_est, est); |
182 | if (old) | |
183 | kfree_rcu(old, rcu); | |
1da177e4 LT |
184 | return 0; |
185 | } | |
c1b56878 | 186 | EXPORT_SYMBOL(gen_new_estimator); |
1da177e4 LT |
187 | |
188 | /** | |
189 | * gen_kill_estimator - remove a rate estimator | |
1c0d32fd | 190 | * @rate_est: rate estimator |
1da177e4 | 191 | * |
1c0d32fd | 192 | * Removes the rate estimator. |
0929c2dd | 193 | * |
1da177e4 | 194 | */ |
1c0d32fd | 195 | void gen_kill_estimator(struct net_rate_estimator __rcu **rate_est) |
1da177e4 | 196 | { |
1c0d32fd | 197 | struct net_rate_estimator *est; |
1da177e4 | 198 | |
1c0d32fd ED |
199 | est = xchg((__force struct net_rate_estimator **)rate_est, NULL); |
200 | if (est) { | |
201 | del_timer_sync(&est->timer); | |
202 | kfree_rcu(est, rcu); | |
1da177e4 LT |
203 | } |
204 | } | |
c1b56878 | 205 | EXPORT_SYMBOL(gen_kill_estimator); |
1da177e4 LT |
206 | |
207 | /** | |
96750162 | 208 | * gen_replace_estimator - replace rate estimator configuration |
1da177e4 | 209 | * @bstats: basic statistics |
e9fc2f05 | 210 | * @cpu_bstats: bstats per cpu |
1da177e4 LT |
211 | * @rate_est: rate estimator statistics |
212 | * @stats_lock: statistics lock | |
edb09eb1 | 213 | * @running: qdisc running seqcount (might be NULL) |
1da177e4 LT |
214 | * @opt: rate estimator configuration TLV |
215 | * | |
216 | * Replaces the configuration of a rate estimator by calling | |
217 | * gen_kill_estimator() and gen_new_estimator(). | |
4ec93edb | 218 | * |
1da177e4 LT |
219 | * Returns 0 on success or a negative error code. |
220 | */ | |
c1a8f1f1 | 221 | int gen_replace_estimator(struct gnet_stats_basic_packed *bstats, |
22e0f8b9 | 222 | struct gnet_stats_basic_cpu __percpu *cpu_bstats, |
1c0d32fd | 223 | struct net_rate_estimator __rcu **rate_est, |
edb09eb1 ED |
224 | spinlock_t *stats_lock, |
225 | seqcount_t *running, struct nlattr *opt) | |
1da177e4 | 226 | { |
1c0d32fd ED |
227 | return gen_new_estimator(bstats, cpu_bstats, rate_est, |
228 | stats_lock, running, opt); | |
1da177e4 | 229 | } |
c1b56878 SH |
230 | EXPORT_SYMBOL(gen_replace_estimator); |
231 | ||
232 | /** | |
233 | * gen_estimator_active - test if estimator is currently in use | |
1c0d32fd | 234 | * @rate_est: rate estimator |
c1b56878 | 235 | * |
244e6c2d | 236 | * Returns true if estimator is active, and false if not. |
c1b56878 | 237 | */ |
1c0d32fd | 238 | bool gen_estimator_active(struct net_rate_estimator __rcu **rate_est) |
c1b56878 | 239 | { |
1c0d32fd ED |
240 | return !!rcu_access_pointer(*rate_est); |
241 | } | |
242 | EXPORT_SYMBOL(gen_estimator_active); | |
ae638c47 | 243 | |
1c0d32fd ED |
244 | bool gen_estimator_read(struct net_rate_estimator __rcu **rate_est, |
245 | struct gnet_stats_rate_est64 *sample) | |
246 | { | |
247 | struct net_rate_estimator *est; | |
248 | unsigned seq; | |
249 | ||
250 | rcu_read_lock(); | |
251 | est = rcu_dereference(*rate_est); | |
252 | if (!est) { | |
253 | rcu_read_unlock(); | |
254 | return false; | |
255 | } | |
1da177e4 | 256 | |
1c0d32fd ED |
257 | do { |
258 | seq = read_seqcount_begin(&est->seq); | |
259 | sample->bps = est->avbps >> 8; | |
260 | sample->pps = est->avpps >> 8; | |
261 | } while (read_seqcount_retry(&est->seq, seq)); | |
ae638c47 | 262 | |
1c0d32fd ED |
263 | rcu_read_unlock(); |
264 | return true; | |
c1b56878 | 265 | } |
1c0d32fd | 266 | EXPORT_SYMBOL(gen_estimator_read); |