libnl  3.7.0
tc.h
1 /* SPDX-License-Identifier: LGPL-2.1-only */
2 /*
3  * Copyright (c) 2003-2011 Thomas Graf <tgraf@suug.ch>
4  */
5 
6 #ifndef NETLINK_TC_H_
7 #define NETLINK_TC_H_
8 
9 #include <netlink/netlink.h>
10 #include <netlink/cache.h>
11 #include <netlink/data.h>
12 #include <netlink/route/link.h>
13 #include <linux/pkt_sched.h>
14 #include <linux/pkt_cls.h>
15 
16 #ifdef __cplusplus
17 extern "C" {
18 #endif
19 
20 enum rtnl_tc_type {
21  RTNL_TC_TYPE_QDISC,
22  RTNL_TC_TYPE_CLASS,
23  RTNL_TC_TYPE_CLS,
24  RTNL_TC_TYPE_ACT,
25  __RTNL_TC_TYPE_MAX,
26 };
27 
28 #define RTNL_TC_TYPE_MAX (__RTNL_TC_TYPE_MAX - 1)
29 
30 /**
31  * Compute tc handle based on major and minor parts
32  * @ingroup tc
33  */
34 #define TC_HANDLE(maj, min) (TC_H_MAJ((maj) << 16) | TC_H_MIN(min))
35 
36 /**
37  * Traffic control object
38  * @ingroup tc
39  */
40 struct rtnl_tc;
41 
42 /**
43  * Macro to cast qdisc/class/classifier to tc object
44  * @ingroup tc
45  *
46  * @code
47  * rtnl_tc_set_mpu(TC_CAST(qdisc), 40);
48  * @endcode
49  */
50 #define TC_CAST(ptr) ((struct rtnl_tc *) (ptr))
51 
52 /**
53  * Traffic control statistical identifier
54  * @ingroup tc
55  *
56  * @code
57  * uint64_t n = rtnl_tc_get_stat(TC_CAST(class), RTNL_TC_PACKETS);
58  * @endcode
59  */
61  RTNL_TC_PACKETS, /**< Number of packets seen */
62  RTNL_TC_BYTES, /**< Total bytes seen */
63  RTNL_TC_RATE_BPS, /**< Current bits/s (rate estimator) */
64  RTNL_TC_RATE_PPS, /**< Current packet/s (rate estimator) */
65  RTNL_TC_QLEN, /**< Current queue length */
66  RTNL_TC_BACKLOG, /**< Current backlog length */
67  RTNL_TC_DROPS, /**< Total number of packets dropped */
68  RTNL_TC_REQUEUES, /**< Total number of requeues */
69  RTNL_TC_OVERLIMITS, /**< Total number of overlimits */
70  __RTNL_TC_STATS_MAX,
71 };
72 
73 #define RTNL_TC_STATS_MAX (__RTNL_TC_STATS_MAX - 1)
74 
75 extern void rtnl_tc_set_ifindex(struct rtnl_tc *, int);
76 extern int rtnl_tc_get_ifindex(struct rtnl_tc *);
77 extern void rtnl_tc_set_link(struct rtnl_tc *, struct rtnl_link *);
78 extern struct rtnl_link *rtnl_tc_get_link(struct rtnl_tc *);
79 extern void rtnl_tc_set_mtu(struct rtnl_tc *, uint32_t);
80 extern uint32_t rtnl_tc_get_mtu(struct rtnl_tc *);
81 extern void rtnl_tc_set_mpu(struct rtnl_tc *, uint32_t);
82 extern uint32_t rtnl_tc_get_mpu(struct rtnl_tc *);
83 extern void rtnl_tc_set_overhead(struct rtnl_tc *, uint32_t);
84 extern uint32_t rtnl_tc_get_overhead(struct rtnl_tc *);
85 extern void rtnl_tc_set_linktype(struct rtnl_tc *, uint32_t);
86 extern uint32_t rtnl_tc_get_linktype(struct rtnl_tc *);
87 extern void rtnl_tc_set_handle(struct rtnl_tc *, uint32_t);
88 extern uint32_t rtnl_tc_get_handle(struct rtnl_tc *);
89 extern void rtnl_tc_set_parent(struct rtnl_tc *, uint32_t);
90 extern uint32_t rtnl_tc_get_parent(struct rtnl_tc *);
91 extern int rtnl_tc_set_kind(struct rtnl_tc *, const char *);
92 extern char * rtnl_tc_get_kind(struct rtnl_tc *);
93 extern uint64_t rtnl_tc_get_stat(struct rtnl_tc *, enum rtnl_tc_stat);
94 extern char * rtnl_tc_stat2str(enum rtnl_tc_stat, char *, size_t);
95 extern int rtnl_tc_str2stat(const char *);
96 
97 extern int rtnl_tc_calc_txtime(int, int);
98 extern int rtnl_tc_calc_bufsize(int, int);
99 extern int rtnl_tc_calc_cell_log(int);
100 
101 extern int rtnl_tc_read_classid_file(void);
102 extern char * rtnl_tc_handle2str(uint32_t, char *, size_t);
103 extern int rtnl_tc_str2handle(const char *, uint32_t *);
104 extern int rtnl_classid_generate(const char *, uint32_t *,
105  uint32_t);
106 extern void rtnl_tc_set_chain(struct rtnl_tc *, uint32_t);
107 extern int rtnl_tc_get_chain(struct rtnl_tc *, uint32_t *);
108 
109 #ifdef __cplusplus
110 }
111 #endif
112 
113 #endif
char * rtnl_tc_handle2str(uint32_t, char *, size_t)
Convert a traffic control handle to a character string (Reentrant).
Definition: classid.c:103
int rtnl_tc_str2handle(const char *, uint32_t *)
Convert a charactering strint to a traffic control handle.
Definition: classid.c:148
int rtnl_tc_read_classid_file(void)
(Re-)read classid file
Definition: classid.c:305
void rtnl_tc_set_mpu(struct rtnl_tc *, uint32_t)
Set the Minimum Packet Unit (MPU) of a traffic control object.
Definition: tc.c:393
uint32_t rtnl_tc_get_parent(struct rtnl_tc *)
Return parent identifier of a traffic control object.
Definition: tc.c:511
void rtnl_tc_set_linktype(struct rtnl_tc *, uint32_t)
Set the linktype of a traffic control object.
Definition: tc.c:450
int rtnl_tc_set_kind(struct rtnl_tc *, const char *)
Define the type of traffic control object.
Definition: tc.c:523
int rtnl_tc_calc_cell_log(int)
Calculate the binary logarithm for a specific cell size.
Definition: tc.c:671
int rtnl_tc_get_chain(struct rtnl_tc *, uint32_t *)
Return chain index of traffic control object.
Definition: tc.c:591
void rtnl_tc_set_ifindex(struct rtnl_tc *, int)
Set interface index of traffic control object.
Definition: tc.c:272
void rtnl_tc_set_overhead(struct rtnl_tc *, uint32_t)
Set per packet overhead of a traffic control object.
Definition: tc.c:422
int rtnl_tc_calc_bufsize(int, int)
Calculate buffer size able to transmit in a specific time and rate.
Definition: tc.c:661
uint32_t rtnl_tc_get_mtu(struct rtnl_tc *)
Return the MTU of traffic control object.
Definition: tc.c:373
int rtnl_tc_get_ifindex(struct rtnl_tc *)
Return interface index of traffic control object.
Definition: tc.c:287
void rtnl_tc_set_link(struct rtnl_tc *, struct rtnl_link *)
Set link of traffic control object.
Definition: tc.c:304
uint32_t rtnl_tc_get_handle(struct rtnl_tc *)
Return identifier of a traffic control object.
Definition: tc.c:490
char * rtnl_tc_get_kind(struct rtnl_tc *)
Return kind of traffic control object.
Definition: tc.c:548
uint32_t rtnl_tc_get_overhead(struct rtnl_tc *)
Return per packet overhead of a traffic control object.
Definition: tc.c:434
struct rtnl_link * rtnl_tc_get_link(struct rtnl_tc *)
Get link of traffic control object.
Definition: tc.c:335
void rtnl_tc_set_handle(struct rtnl_tc *, uint32_t)
Set identifier of traffic control object.
Definition: tc.c:480
void rtnl_tc_set_parent(struct rtnl_tc *, uint32_t)
Set the parent identifier of a traffic control object.
Definition: tc.c:501
void rtnl_tc_set_mtu(struct rtnl_tc *, uint32_t)
Set the Maximum Transmission Unit (MTU) of traffic control object.
Definition: tc.c:358
void rtnl_tc_set_chain(struct rtnl_tc *, uint32_t)
Set the chain index of a traffic control object.
Definition: tc.c:577
uint64_t rtnl_tc_get_stat(struct rtnl_tc *, enum rtnl_tc_stat)
Return value of a statistical counter of a traffic control object.
Definition: tc.c:563
rtnl_tc_stat
Traffic control statistical identifier.
Definition: tc.h:60
uint32_t rtnl_tc_get_linktype(struct rtnl_tc *)
Return the linktype of a traffic control object.
Definition: tc.c:465
uint32_t rtnl_tc_get_mpu(struct rtnl_tc *)
Return the Minimum Packet Unit (MPU) of a traffic control object.
Definition: tc.c:405
int rtnl_tc_calc_txtime(int, int)
Calculate time required to transmit buffer at a specific rate.
Definition: tc.c:642
@ RTNL_TC_PACKETS
Number of packets seen.
Definition: tc.h:61
@ RTNL_TC_BYTES
Total bytes seen.
Definition: tc.h:62
@ RTNL_TC_QLEN
Current queue length.
Definition: tc.h:65
@ RTNL_TC_OVERLIMITS
Total number of overlimits.
Definition: tc.h:69
@ RTNL_TC_DROPS
Total number of packets dropped.
Definition: tc.h:67
@ RTNL_TC_RATE_PPS
Current packet/s (rate estimator)
Definition: tc.h:64
@ RTNL_TC_REQUEUES
Total number of requeues.
Definition: tc.h:68
@ RTNL_TC_BACKLOG
Current backlog length.
Definition: tc.h:66
@ RTNL_TC_RATE_BPS
Current bits/s (rate estimator)
Definition: tc.h:63