1 // SPDX-License-Identifier: GPL-2.0-or-later
5 * Authors: Thomas Graf <tgraf@suug.ch>
7 * Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>
9 * See Documentation/networking/gen_stats.rst
12 #include <linux/types.h>
13 #include <linux/kernel.h>
14 #include <linux/module.h>
15 #include <linux/interrupt.h>
16 #include <linux/socket.h>
17 #include <linux/rtnetlink.h>
18 #include <linux/gen_stats.h>
19 #include <net/netlink.h>
20 #include <net/gen_stats.h>
21 #include <net/sch_generic.h>
24 gnet_stats_copy(struct gnet_dump
*d
, int type
, void *buf
, int size
, int padattr
)
26 if (nla_put_64bit(d
->skb
, type
, size
, buf
, padattr
))
32 spin_unlock_bh(d
->lock
);
40 * gnet_stats_start_copy_compat - start dumping procedure in compatibility mode
41 * @skb: socket buffer to put statistics TLVs into
42 * @type: TLV type for top level statistic TLV
43 * @tc_stats_type: TLV type for backward compatibility struct tc_stats TLV
44 * @xstats_type: TLV type for backward compatibility xstats TLV
45 * @lock: statistics lock
47 * @padattr: padding attribute
49 * Initializes the dumping handle, grabs the statistic lock and appends
50 * an empty TLV header to the socket buffer for use a container for all
51 * other statistic TLVS.
53 * The dumping handle is marked to be in backward compatibility mode telling
54 * all gnet_stats_copy_XXX() functions to fill a local copy of struct tc_stats.
56 * Returns 0 on success or -1 if the room in the socket buffer was not sufficient.
59 gnet_stats_start_copy_compat(struct sk_buff
*skb
, int type
, int tc_stats_type
,
60 int xstats_type
, spinlock_t
*lock
,
61 struct gnet_dump
*d
, int padattr
)
64 memset(d
, 0, sizeof(*d
));
67 d
->tail
= (struct nlattr
*)skb_tail_pointer(skb
);
69 d
->compat_tc_stats
= tc_stats_type
;
70 d
->compat_xstats
= xstats_type
;
77 int ret
= gnet_stats_copy(d
, type
, NULL
, 0, padattr
);
79 /* The initial attribute added in gnet_stats_copy() may be
80 * preceded by a padding attribute, in which case d->tail will
81 * end up pointing at the padding instead of the real attribute.
82 * Fix this so gnet_stats_finish_copy() adjusts the length of
83 * the right attribute.
85 if (ret
== 0 && d
->tail
->nla_type
== padattr
)
86 d
->tail
= (struct nlattr
*)((char *)d
->tail
+
87 NLA_ALIGN(d
->tail
->nla_len
));
93 EXPORT_SYMBOL(gnet_stats_start_copy_compat
);
96 * gnet_stats_start_copy - start dumping procedure in compatibility mode
97 * @skb: socket buffer to put statistics TLVs into
98 * @type: TLV type for top level statistic TLV
99 * @lock: statistics lock
101 * @padattr: padding attribute
103 * Initializes the dumping handle, grabs the statistic lock and appends
104 * an empty TLV header to the socket buffer for use a container for all
105 * other statistic TLVS.
107 * Returns 0 on success or -1 if the room in the socket buffer was not sufficient.
110 gnet_stats_start_copy(struct sk_buff
*skb
, int type
, spinlock_t
*lock
,
111 struct gnet_dump
*d
, int padattr
)
113 return gnet_stats_start_copy_compat(skb
, type
, 0, 0, lock
, d
, padattr
);
115 EXPORT_SYMBOL(gnet_stats_start_copy
);
117 /* Must not be inlined, due to u64_stats seqcount_t lockdep key */
118 void gnet_stats_basic_sync_init(struct gnet_stats_basic_sync
*b
)
120 u64_stats_set(&b
->bytes
, 0);
121 u64_stats_set(&b
->packets
, 0);
122 u64_stats_init(&b
->syncp
);
124 EXPORT_SYMBOL(gnet_stats_basic_sync_init
);
126 static void gnet_stats_add_basic_cpu(struct gnet_stats_basic_sync
*bstats
,
127 struct gnet_stats_basic_sync __percpu
*cpu
)
129 u64 t_bytes
= 0, t_packets
= 0;
132 for_each_possible_cpu(i
) {
133 struct gnet_stats_basic_sync
*bcpu
= per_cpu_ptr(cpu
, i
);
138 start
= u64_stats_fetch_begin(&bcpu
->syncp
);
139 bytes
= u64_stats_read(&bcpu
->bytes
);
140 packets
= u64_stats_read(&bcpu
->packets
);
141 } while (u64_stats_fetch_retry(&bcpu
->syncp
, start
));
144 t_packets
+= packets
;
146 _bstats_update(bstats
, t_bytes
, t_packets
);
149 void gnet_stats_add_basic(struct gnet_stats_basic_sync
*bstats
,
150 struct gnet_stats_basic_sync __percpu
*cpu
,
151 struct gnet_stats_basic_sync
*b
, bool running
)
157 WARN_ON_ONCE((cpu
|| running
) && in_hardirq());
160 gnet_stats_add_basic_cpu(bstats
, cpu
);
165 start
= u64_stats_fetch_begin(&b
->syncp
);
166 bytes
= u64_stats_read(&b
->bytes
);
167 packets
= u64_stats_read(&b
->packets
);
168 } while (running
&& u64_stats_fetch_retry(&b
->syncp
, start
));
170 _bstats_update(bstats
, bytes
, packets
);
172 EXPORT_SYMBOL(gnet_stats_add_basic
);
174 static void gnet_stats_read_basic(u64
*ret_bytes
, u64
*ret_packets
,
175 struct gnet_stats_basic_sync __percpu
*cpu
,
176 struct gnet_stats_basic_sync
*b
, bool running
)
181 u64 t_bytes
= 0, t_packets
= 0;
184 for_each_possible_cpu(i
) {
185 struct gnet_stats_basic_sync
*bcpu
= per_cpu_ptr(cpu
, i
);
190 start
= u64_stats_fetch_begin(&bcpu
->syncp
);
191 bytes
= u64_stats_read(&bcpu
->bytes
);
192 packets
= u64_stats_read(&bcpu
->packets
);
193 } while (u64_stats_fetch_retry(&bcpu
->syncp
, start
));
196 t_packets
+= packets
;
198 *ret_bytes
= t_bytes
;
199 *ret_packets
= t_packets
;
204 start
= u64_stats_fetch_begin(&b
->syncp
);
205 *ret_bytes
= u64_stats_read(&b
->bytes
);
206 *ret_packets
= u64_stats_read(&b
->packets
);
207 } while (running
&& u64_stats_fetch_retry(&b
->syncp
, start
));
211 ___gnet_stats_copy_basic(struct gnet_dump
*d
,
212 struct gnet_stats_basic_sync __percpu
*cpu
,
213 struct gnet_stats_basic_sync
*b
,
214 int type
, bool running
)
216 u64 bstats_bytes
, bstats_packets
;
218 gnet_stats_read_basic(&bstats_bytes
, &bstats_packets
, cpu
, b
, running
);
220 if (d
->compat_tc_stats
&& type
== TCA_STATS_BASIC
) {
221 d
->tc_stats
.bytes
= bstats_bytes
;
222 d
->tc_stats
.packets
= bstats_packets
;
226 struct gnet_stats_basic sb
;
229 memset(&sb
, 0, sizeof(sb
));
230 sb
.bytes
= bstats_bytes
;
231 sb
.packets
= bstats_packets
;
232 res
= gnet_stats_copy(d
, type
, &sb
, sizeof(sb
), TCA_STATS_PAD
);
233 if (res
< 0 || sb
.packets
== bstats_packets
)
235 /* emit 64bit stats only if needed */
236 return gnet_stats_copy(d
, TCA_STATS_PKT64
, &bstats_packets
,
237 sizeof(bstats_packets
), TCA_STATS_PAD
);
243 * gnet_stats_copy_basic - copy basic statistics into statistic TLV
245 * @cpu: copy statistic per cpu
246 * @b: basic statistics
247 * @running: true if @b represents a running qdisc, thus @b's
248 * internal values might change during basic reads.
249 * Only used if @cpu is NULL
251 * Context: task; must not be run from IRQ or BH contexts
253 * Appends the basic statistics to the top level TLV created by
254 * gnet_stats_start_copy().
256 * Returns 0 on success or -1 with the statistic lock released
257 * if the room in the socket buffer was not sufficient.
260 gnet_stats_copy_basic(struct gnet_dump
*d
,
261 struct gnet_stats_basic_sync __percpu
*cpu
,
262 struct gnet_stats_basic_sync
*b
,
265 return ___gnet_stats_copy_basic(d
, cpu
, b
, TCA_STATS_BASIC
, running
);
267 EXPORT_SYMBOL(gnet_stats_copy_basic
);
270 * gnet_stats_copy_basic_hw - copy basic hw statistics into statistic TLV
272 * @cpu: copy statistic per cpu
273 * @b: basic statistics
274 * @running: true if @b represents a running qdisc, thus @b's
275 * internal values might change during basic reads.
276 * Only used if @cpu is NULL
278 * Context: task; must not be run from IRQ or BH contexts
280 * Appends the basic statistics to the top level TLV created by
281 * gnet_stats_start_copy().
283 * Returns 0 on success or -1 with the statistic lock released
284 * if the room in the socket buffer was not sufficient.
287 gnet_stats_copy_basic_hw(struct gnet_dump
*d
,
288 struct gnet_stats_basic_sync __percpu
*cpu
,
289 struct gnet_stats_basic_sync
*b
,
292 return ___gnet_stats_copy_basic(d
, cpu
, b
, TCA_STATS_BASIC_HW
, running
);
294 EXPORT_SYMBOL(gnet_stats_copy_basic_hw
);
297 * gnet_stats_copy_rate_est - copy rate estimator statistics into statistics TLV
299 * @rate_est: rate estimator
301 * Appends the rate estimator statistics to the top level TLV created by
302 * gnet_stats_start_copy().
304 * Returns 0 on success or -1 with the statistic lock released
305 * if the room in the socket buffer was not sufficient.
308 gnet_stats_copy_rate_est(struct gnet_dump
*d
,
309 struct net_rate_estimator __rcu
**rate_est
)
311 struct gnet_stats_rate_est64 sample
;
312 struct gnet_stats_rate_est est
;
315 if (!gen_estimator_read(rate_est
, &sample
))
317 est
.bps
= min_t(u64
, UINT_MAX
, sample
.bps
);
318 /* we have some time before reaching 2^32 packets per second */
319 est
.pps
= sample
.pps
;
321 if (d
->compat_tc_stats
) {
322 d
->tc_stats
.bps
= est
.bps
;
323 d
->tc_stats
.pps
= est
.pps
;
327 res
= gnet_stats_copy(d
, TCA_STATS_RATE_EST
, &est
, sizeof(est
),
329 if (res
< 0 || est
.bps
== sample
.bps
)
331 /* emit 64bit stats only if needed */
332 return gnet_stats_copy(d
, TCA_STATS_RATE_EST64
, &sample
,
333 sizeof(sample
), TCA_STATS_PAD
);
338 EXPORT_SYMBOL(gnet_stats_copy_rate_est
);
340 static void gnet_stats_add_queue_cpu(struct gnet_stats_queue
*qstats
,
341 const struct gnet_stats_queue __percpu
*q
)
345 for_each_possible_cpu(i
) {
346 const struct gnet_stats_queue
*qcpu
= per_cpu_ptr(q
, i
);
348 qstats
->qlen
+= qcpu
->qlen
;
349 qstats
->backlog
+= qcpu
->backlog
;
350 qstats
->drops
+= qcpu
->drops
;
351 qstats
->requeues
+= qcpu
->requeues
;
352 qstats
->overlimits
+= qcpu
->overlimits
;
356 void gnet_stats_add_queue(struct gnet_stats_queue
*qstats
,
357 const struct gnet_stats_queue __percpu
*cpu
,
358 const struct gnet_stats_queue
*q
)
361 gnet_stats_add_queue_cpu(qstats
, cpu
);
363 qstats
->qlen
+= q
->qlen
;
364 qstats
->backlog
+= q
->backlog
;
365 qstats
->drops
+= q
->drops
;
366 qstats
->requeues
+= q
->requeues
;
367 qstats
->overlimits
+= q
->overlimits
;
370 EXPORT_SYMBOL(gnet_stats_add_queue
);
373 * gnet_stats_copy_queue - copy queue statistics into statistics TLV
375 * @cpu_q: per cpu queue statistics
376 * @q: queue statistics
377 * @qlen: queue length statistics
379 * Appends the queue statistics to the top level TLV created by
380 * gnet_stats_start_copy(). Using per cpu queue statistics if
381 * they are available.
383 * Returns 0 on success or -1 with the statistic lock released
384 * if the room in the socket buffer was not sufficient.
387 gnet_stats_copy_queue(struct gnet_dump
*d
,
388 struct gnet_stats_queue __percpu
*cpu_q
,
389 struct gnet_stats_queue
*q
, __u32 qlen
)
391 struct gnet_stats_queue qstats
= {0};
393 gnet_stats_add_queue(&qstats
, cpu_q
, q
);
396 if (d
->compat_tc_stats
) {
397 d
->tc_stats
.drops
= qstats
.drops
;
398 d
->tc_stats
.qlen
= qstats
.qlen
;
399 d
->tc_stats
.backlog
= qstats
.backlog
;
400 d
->tc_stats
.overlimits
= qstats
.overlimits
;
404 return gnet_stats_copy(d
, TCA_STATS_QUEUE
,
405 &qstats
, sizeof(qstats
),
410 EXPORT_SYMBOL(gnet_stats_copy_queue
);
413 * gnet_stats_copy_app - copy application specific statistics into statistics TLV
415 * @st: application specific statistics data
416 * @len: length of data
418 * Appends the application specific statistics to the top level TLV created by
419 * gnet_stats_start_copy() and remembers the data for XSTATS if the dumping
420 * handle is in backward compatibility mode.
422 * Returns 0 on success or -1 with the statistic lock released
423 * if the room in the socket buffer was not sufficient.
426 gnet_stats_copy_app(struct gnet_dump
*d
, void *st
, int len
)
428 if (d
->compat_xstats
) {
429 d
->xstats
= kmemdup(st
, len
, GFP_ATOMIC
);
436 return gnet_stats_copy(d
, TCA_STATS_APP
, st
, len
,
443 spin_unlock_bh(d
->lock
);
447 EXPORT_SYMBOL(gnet_stats_copy_app
);
450 * gnet_stats_finish_copy - finish dumping procedure
453 * Corrects the length of the top level TLV to include all TLVs added
454 * by gnet_stats_copy_XXX() calls. Adds the backward compatibility TLVs
455 * if gnet_stats_start_copy_compat() was used and releases the statistics
458 * Returns 0 on success or -1 with the statistic lock released
459 * if the room in the socket buffer was not sufficient.
462 gnet_stats_finish_copy(struct gnet_dump
*d
)
465 d
->tail
->nla_len
= skb_tail_pointer(d
->skb
) - (u8
*)d
->tail
;
467 if (d
->compat_tc_stats
)
468 if (gnet_stats_copy(d
, d
->compat_tc_stats
, &d
->tc_stats
,
469 sizeof(d
->tc_stats
), d
->padattr
) < 0)
472 if (d
->compat_xstats
&& d
->xstats
) {
473 if (gnet_stats_copy(d
, d
->compat_xstats
, d
->xstats
,
474 d
->xstats_len
, d
->padattr
) < 0)
479 spin_unlock_bh(d
->lock
);
485 EXPORT_SYMBOL(gnet_stats_finish_copy
);