xref: /openbmc/linux/net/ethtool/stats.c (revision a8b06e9d)
1 // SPDX-License-Identifier: GPL-2.0-only
2 
3 #include "netlink.h"
4 #include "common.h"
5 #include "bitset.h"
6 
7 struct stats_req_info {
8 	struct ethnl_req_info		base;
9 	DECLARE_BITMAP(stat_mask, __ETHTOOL_STATS_CNT);
10 };
11 
12 #define STATS_REQINFO(__req_base) \
13 	container_of(__req_base, struct stats_req_info, base)
14 
15 struct stats_reply_data {
16 	struct ethnl_reply_data		base;
17 	struct ethtool_eth_phy_stats	phy_stats;
18 	struct ethtool_eth_mac_stats	mac_stats;
19 	struct ethtool_eth_ctrl_stats	ctrl_stats;
20 	struct ethtool_rmon_stats	rmon_stats;
21 	const struct ethtool_rmon_hist_range	*rmon_ranges;
22 };
23 
24 #define STATS_REPDATA(__reply_base) \
25 	container_of(__reply_base, struct stats_reply_data, base)
26 
27 const char stats_std_names[__ETHTOOL_STATS_CNT][ETH_GSTRING_LEN] = {
28 	[ETHTOOL_STATS_ETH_PHY]			= "eth-phy",
29 	[ETHTOOL_STATS_ETH_MAC]			= "eth-mac",
30 	[ETHTOOL_STATS_ETH_CTRL]		= "eth-ctrl",
31 	[ETHTOOL_STATS_RMON]			= "rmon",
32 };
33 
34 const char stats_eth_phy_names[__ETHTOOL_A_STATS_ETH_PHY_CNT][ETH_GSTRING_LEN] = {
35 	[ETHTOOL_A_STATS_ETH_PHY_5_SYM_ERR]	= "SymbolErrorDuringCarrier",
36 };
37 
38 const char stats_eth_mac_names[__ETHTOOL_A_STATS_ETH_MAC_CNT][ETH_GSTRING_LEN] = {
39 	[ETHTOOL_A_STATS_ETH_MAC_2_TX_PKT]	= "FramesTransmittedOK",
40 	[ETHTOOL_A_STATS_ETH_MAC_3_SINGLE_COL]	= "SingleCollisionFrames",
41 	[ETHTOOL_A_STATS_ETH_MAC_4_MULTI_COL]	= "MultipleCollisionFrames",
42 	[ETHTOOL_A_STATS_ETH_MAC_5_RX_PKT]	= "FramesReceivedOK",
43 	[ETHTOOL_A_STATS_ETH_MAC_6_FCS_ERR]	= "FrameCheckSequenceErrors",
44 	[ETHTOOL_A_STATS_ETH_MAC_7_ALIGN_ERR]	= "AlignmentErrors",
45 	[ETHTOOL_A_STATS_ETH_MAC_8_TX_BYTES]	= "OctetsTransmittedOK",
46 	[ETHTOOL_A_STATS_ETH_MAC_9_TX_DEFER]	= "FramesWithDeferredXmissions",
47 	[ETHTOOL_A_STATS_ETH_MAC_10_LATE_COL]	= "LateCollisions",
48 	[ETHTOOL_A_STATS_ETH_MAC_11_XS_COL]	= "FramesAbortedDueToXSColls",
49 	[ETHTOOL_A_STATS_ETH_MAC_12_TX_INT_ERR]	= "FramesLostDueToIntMACXmitError",
50 	[ETHTOOL_A_STATS_ETH_MAC_13_CS_ERR]	= "CarrierSenseErrors",
51 	[ETHTOOL_A_STATS_ETH_MAC_14_RX_BYTES]	= "OctetsReceivedOK",
52 	[ETHTOOL_A_STATS_ETH_MAC_15_RX_INT_ERR]	= "FramesLostDueToIntMACRcvError",
53 	[ETHTOOL_A_STATS_ETH_MAC_18_TX_MCAST]	= "MulticastFramesXmittedOK",
54 	[ETHTOOL_A_STATS_ETH_MAC_19_TX_BCAST]	= "BroadcastFramesXmittedOK",
55 	[ETHTOOL_A_STATS_ETH_MAC_20_XS_DEFER]	= "FramesWithExcessiveDeferral",
56 	[ETHTOOL_A_STATS_ETH_MAC_21_RX_MCAST]	= "MulticastFramesReceivedOK",
57 	[ETHTOOL_A_STATS_ETH_MAC_22_RX_BCAST]	= "BroadcastFramesReceivedOK",
58 	[ETHTOOL_A_STATS_ETH_MAC_23_IR_LEN_ERR]	= "InRangeLengthErrors",
59 	[ETHTOOL_A_STATS_ETH_MAC_24_OOR_LEN]	= "OutOfRangeLengthField",
60 	[ETHTOOL_A_STATS_ETH_MAC_25_TOO_LONG_ERR]	= "FrameTooLongErrors",
61 };
62 
63 const char stats_eth_ctrl_names[__ETHTOOL_A_STATS_ETH_CTRL_CNT][ETH_GSTRING_LEN] = {
64 	[ETHTOOL_A_STATS_ETH_CTRL_3_TX]		= "MACControlFramesTransmitted",
65 	[ETHTOOL_A_STATS_ETH_CTRL_4_RX]		= "MACControlFramesReceived",
66 	[ETHTOOL_A_STATS_ETH_CTRL_5_RX_UNSUP]	= "UnsupportedOpcodesReceived",
67 };
68 
69 const char stats_rmon_names[__ETHTOOL_A_STATS_RMON_CNT][ETH_GSTRING_LEN] = {
70 	[ETHTOOL_A_STATS_RMON_UNDERSIZE]	= "etherStatsUndersizePkts",
71 	[ETHTOOL_A_STATS_RMON_OVERSIZE]		= "etherStatsOversizePkts",
72 	[ETHTOOL_A_STATS_RMON_FRAG]		= "etherStatsFragments",
73 	[ETHTOOL_A_STATS_RMON_JABBER]		= "etherStatsJabbers",
74 };
75 
76 const struct nla_policy ethnl_stats_get_policy[ETHTOOL_A_STATS_GROUPS + 1] = {
77 	[ETHTOOL_A_STATS_HEADER]	=
78 		NLA_POLICY_NESTED(ethnl_header_policy),
79 	[ETHTOOL_A_STATS_GROUPS]	= { .type = NLA_NESTED },
80 };
81 
82 static int stats_parse_request(struct ethnl_req_info *req_base,
83 			       struct nlattr **tb,
84 			       struct netlink_ext_ack *extack)
85 {
86 	struct stats_req_info *req_info = STATS_REQINFO(req_base);
87 	bool mod = false;
88 	int err;
89 
90 	err = ethnl_update_bitset(req_info->stat_mask, __ETHTOOL_STATS_CNT,
91 				  tb[ETHTOOL_A_STATS_GROUPS], stats_std_names,
92 				  extack, &mod);
93 	if (err)
94 		return err;
95 
96 	if (!mod) {
97 		NL_SET_ERR_MSG(extack, "no stats requested");
98 		return -EINVAL;
99 	}
100 
101 	return 0;
102 }
103 
104 static int stats_prepare_data(const struct ethnl_req_info *req_base,
105 			      struct ethnl_reply_data *reply_base,
106 			      struct genl_info *info)
107 {
108 	const struct stats_req_info *req_info = STATS_REQINFO(req_base);
109 	struct stats_reply_data *data = STATS_REPDATA(reply_base);
110 	struct net_device *dev = reply_base->dev;
111 	int ret;
112 
113 	ret = ethnl_ops_begin(dev);
114 	if (ret < 0)
115 		return ret;
116 
117 	memset(&data->phy_stats, 0xff, sizeof(data->phy_stats));
118 	memset(&data->mac_stats, 0xff, sizeof(data->mac_stats));
119 	memset(&data->ctrl_stats, 0xff, sizeof(data->mac_stats));
120 	memset(&data->rmon_stats, 0xff, sizeof(data->rmon_stats));
121 
122 	if (test_bit(ETHTOOL_STATS_ETH_PHY, req_info->stat_mask) &&
123 	    dev->ethtool_ops->get_eth_phy_stats)
124 		dev->ethtool_ops->get_eth_phy_stats(dev, &data->phy_stats);
125 	if (test_bit(ETHTOOL_STATS_ETH_MAC, req_info->stat_mask) &&
126 	    dev->ethtool_ops->get_eth_mac_stats)
127 		dev->ethtool_ops->get_eth_mac_stats(dev, &data->mac_stats);
128 	if (test_bit(ETHTOOL_STATS_ETH_CTRL, req_info->stat_mask) &&
129 	    dev->ethtool_ops->get_eth_ctrl_stats)
130 		dev->ethtool_ops->get_eth_ctrl_stats(dev, &data->ctrl_stats);
131 	if (test_bit(ETHTOOL_STATS_RMON, req_info->stat_mask) &&
132 	    dev->ethtool_ops->get_rmon_stats)
133 		dev->ethtool_ops->get_rmon_stats(dev, &data->rmon_stats,
134 						 &data->rmon_ranges);
135 
136 	ethnl_ops_complete(dev);
137 	return 0;
138 }
139 
140 static int stats_reply_size(const struct ethnl_req_info *req_base,
141 			    const struct ethnl_reply_data *reply_base)
142 {
143 	const struct stats_req_info *req_info = STATS_REQINFO(req_base);
144 	unsigned int n_grps = 0, n_stats = 0;
145 	int len = 0;
146 
147 	if (test_bit(ETHTOOL_STATS_ETH_PHY, req_info->stat_mask)) {
148 		n_stats += sizeof(struct ethtool_eth_phy_stats) / sizeof(u64);
149 		n_grps++;
150 	}
151 	if (test_bit(ETHTOOL_STATS_ETH_MAC, req_info->stat_mask)) {
152 		n_stats += sizeof(struct ethtool_eth_mac_stats) / sizeof(u64);
153 		n_grps++;
154 	}
155 	if (test_bit(ETHTOOL_STATS_ETH_CTRL, req_info->stat_mask)) {
156 		n_stats += sizeof(struct ethtool_eth_ctrl_stats) / sizeof(u64);
157 		n_grps++;
158 	}
159 	if (test_bit(ETHTOOL_STATS_RMON, req_info->stat_mask)) {
160 		n_stats += sizeof(struct ethtool_rmon_stats) / sizeof(u64);
161 		n_grps++;
162 		/* Above includes the space for _A_STATS_GRP_HIST_VALs */
163 
164 		len += (nla_total_size(0) +	/* _A_STATS_GRP_HIST */
165 			nla_total_size(4) +	/* _A_STATS_GRP_HIST_BKT_LOW */
166 			nla_total_size(4)) *	/* _A_STATS_GRP_HIST_BKT_HI */
167 			ETHTOOL_RMON_HIST_MAX * 2;
168 	}
169 
170 	len += n_grps * (nla_total_size(0) + /* _A_STATS_GRP */
171 			 nla_total_size(4) + /* _A_STATS_GRP_ID */
172 			 nla_total_size(4)); /* _A_STATS_GRP_SS_ID */
173 	len += n_stats * (nla_total_size(0) + /* _A_STATS_GRP_STAT */
174 			  nla_total_size_64bit(sizeof(u64)));
175 
176 	return len;
177 }
178 
179 static int stat_put(struct sk_buff *skb, u16 attrtype, u64 val)
180 {
181 	struct nlattr *nest;
182 	int ret;
183 
184 	if (val == ETHTOOL_STAT_NOT_SET)
185 		return 0;
186 
187 	/* We want to start stats attr types from 0, so we don't have a type
188 	 * for pad inside ETHTOOL_A_STATS_GRP_STAT. Pad things on the outside
189 	 * of ETHTOOL_A_STATS_GRP_STAT. Since we're one nest away from the
190 	 * actual attr we're 4B off - nla_need_padding_for_64bit() & co.
191 	 * can't be used.
192 	 */
193 #ifndef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
194 	if (!IS_ALIGNED((unsigned long)skb_tail_pointer(skb), 8))
195 		if (!nla_reserve(skb, ETHTOOL_A_STATS_GRP_PAD, 0))
196 			return -EMSGSIZE;
197 #endif
198 
199 	nest = nla_nest_start(skb, ETHTOOL_A_STATS_GRP_STAT);
200 	if (!nest)
201 		return -EMSGSIZE;
202 
203 	ret = nla_put_u64_64bit(skb, attrtype, val, -1 /* not used */);
204 	if (ret) {
205 		nla_nest_cancel(skb, nest);
206 		return ret;
207 	}
208 
209 	nla_nest_end(skb, nest);
210 	return 0;
211 }
212 
213 static int stats_put_phy_stats(struct sk_buff *skb,
214 			       const struct stats_reply_data *data)
215 {
216 	if (stat_put(skb, ETHTOOL_A_STATS_ETH_PHY_5_SYM_ERR,
217 		     data->phy_stats.SymbolErrorDuringCarrier))
218 		return -EMSGSIZE;
219 	return 0;
220 }
221 
222 static int stats_put_mac_stats(struct sk_buff *skb,
223 			       const struct stats_reply_data *data)
224 {
225 	if (stat_put(skb, ETHTOOL_A_STATS_ETH_MAC_2_TX_PKT,
226 		     data->mac_stats.FramesTransmittedOK) ||
227 	    stat_put(skb, ETHTOOL_A_STATS_ETH_MAC_3_SINGLE_COL,
228 		     data->mac_stats.SingleCollisionFrames) ||
229 	    stat_put(skb, ETHTOOL_A_STATS_ETH_MAC_4_MULTI_COL,
230 		     data->mac_stats.MultipleCollisionFrames) ||
231 	    stat_put(skb, ETHTOOL_A_STATS_ETH_MAC_5_RX_PKT,
232 		     data->mac_stats.FramesReceivedOK) ||
233 	    stat_put(skb, ETHTOOL_A_STATS_ETH_MAC_6_FCS_ERR,
234 		     data->mac_stats.FrameCheckSequenceErrors) ||
235 	    stat_put(skb, ETHTOOL_A_STATS_ETH_MAC_7_ALIGN_ERR,
236 		     data->mac_stats.AlignmentErrors) ||
237 	    stat_put(skb, ETHTOOL_A_STATS_ETH_MAC_8_TX_BYTES,
238 		     data->mac_stats.OctetsTransmittedOK) ||
239 	    stat_put(skb, ETHTOOL_A_STATS_ETH_MAC_9_TX_DEFER,
240 		     data->mac_stats.FramesWithDeferredXmissions) ||
241 	    stat_put(skb, ETHTOOL_A_STATS_ETH_MAC_10_LATE_COL,
242 		     data->mac_stats.LateCollisions) ||
243 	    stat_put(skb, ETHTOOL_A_STATS_ETH_MAC_11_XS_COL,
244 		     data->mac_stats.FramesAbortedDueToXSColls) ||
245 	    stat_put(skb, ETHTOOL_A_STATS_ETH_MAC_12_TX_INT_ERR,
246 		     data->mac_stats.FramesLostDueToIntMACXmitError) ||
247 	    stat_put(skb, ETHTOOL_A_STATS_ETH_MAC_13_CS_ERR,
248 		     data->mac_stats.CarrierSenseErrors) ||
249 	    stat_put(skb, ETHTOOL_A_STATS_ETH_MAC_14_RX_BYTES,
250 		     data->mac_stats.OctetsReceivedOK) ||
251 	    stat_put(skb, ETHTOOL_A_STATS_ETH_MAC_15_RX_INT_ERR,
252 		     data->mac_stats.FramesLostDueToIntMACRcvError) ||
253 	    stat_put(skb, ETHTOOL_A_STATS_ETH_MAC_18_TX_MCAST,
254 		     data->mac_stats.MulticastFramesXmittedOK) ||
255 	    stat_put(skb, ETHTOOL_A_STATS_ETH_MAC_19_TX_BCAST,
256 		     data->mac_stats.BroadcastFramesXmittedOK) ||
257 	    stat_put(skb, ETHTOOL_A_STATS_ETH_MAC_20_XS_DEFER,
258 		     data->mac_stats.FramesWithExcessiveDeferral) ||
259 	    stat_put(skb, ETHTOOL_A_STATS_ETH_MAC_21_RX_MCAST,
260 		     data->mac_stats.MulticastFramesReceivedOK) ||
261 	    stat_put(skb, ETHTOOL_A_STATS_ETH_MAC_22_RX_BCAST,
262 		     data->mac_stats.BroadcastFramesReceivedOK) ||
263 	    stat_put(skb, ETHTOOL_A_STATS_ETH_MAC_23_IR_LEN_ERR,
264 		     data->mac_stats.InRangeLengthErrors) ||
265 	    stat_put(skb, ETHTOOL_A_STATS_ETH_MAC_24_OOR_LEN,
266 		     data->mac_stats.OutOfRangeLengthField) ||
267 	    stat_put(skb, ETHTOOL_A_STATS_ETH_MAC_25_TOO_LONG_ERR,
268 		     data->mac_stats.FrameTooLongErrors))
269 		return -EMSGSIZE;
270 	return 0;
271 }
272 
273 static int stats_put_ctrl_stats(struct sk_buff *skb,
274 				const struct stats_reply_data *data)
275 {
276 	if (stat_put(skb, ETHTOOL_A_STATS_ETH_CTRL_3_TX,
277 		     data->ctrl_stats.MACControlFramesTransmitted) ||
278 	    stat_put(skb, ETHTOOL_A_STATS_ETH_CTRL_4_RX,
279 		     data->ctrl_stats.MACControlFramesReceived) ||
280 	    stat_put(skb, ETHTOOL_A_STATS_ETH_CTRL_5_RX_UNSUP,
281 		     data->ctrl_stats.UnsupportedOpcodesReceived))
282 		return -EMSGSIZE;
283 	return 0;
284 }
285 
286 static int stats_put_rmon_hist(struct sk_buff *skb, u32 attr, const u64 *hist,
287 			       const struct ethtool_rmon_hist_range *ranges)
288 {
289 	struct nlattr *nest;
290 	int i;
291 
292 	if (!ranges)
293 		return 0;
294 
295 	for (i = 0; i <	ETHTOOL_RMON_HIST_MAX; i++) {
296 		if (!ranges[i].low && !ranges[i].high)
297 			break;
298 		if (hist[i] == ETHTOOL_STAT_NOT_SET)
299 			continue;
300 
301 		nest = nla_nest_start(skb, attr);
302 		if (!nest)
303 			return -EMSGSIZE;
304 
305 		if (nla_put_u32(skb, ETHTOOL_A_STATS_GRP_HIST_BKT_LOW,
306 				ranges[i].low) ||
307 		    nla_put_u32(skb, ETHTOOL_A_STATS_GRP_HIST_BKT_HI,
308 				ranges[i].high) ||
309 		    nla_put_u64_64bit(skb, ETHTOOL_A_STATS_GRP_HIST_VAL,
310 				      hist[i], ETHTOOL_A_STATS_GRP_PAD))
311 			goto err_cancel_hist;
312 
313 		nla_nest_end(skb, nest);
314 	}
315 
316 	return 0;
317 
318 err_cancel_hist:
319 	nla_nest_cancel(skb, nest);
320 	return -EMSGSIZE;
321 }
322 
323 static int stats_put_rmon_stats(struct sk_buff *skb,
324 				const struct stats_reply_data *data)
325 {
326 	if (stats_put_rmon_hist(skb, ETHTOOL_A_STATS_GRP_HIST_RX,
327 				data->rmon_stats.hist, data->rmon_ranges) ||
328 	    stats_put_rmon_hist(skb, ETHTOOL_A_STATS_GRP_HIST_TX,
329 				data->rmon_stats.hist_tx, data->rmon_ranges))
330 		return -EMSGSIZE;
331 
332 	if (stat_put(skb, ETHTOOL_A_STATS_RMON_UNDERSIZE,
333 		     data->rmon_stats.undersize_pkts) ||
334 	    stat_put(skb, ETHTOOL_A_STATS_RMON_OVERSIZE,
335 		     data->rmon_stats.oversize_pkts) ||
336 	    stat_put(skb, ETHTOOL_A_STATS_RMON_FRAG,
337 		     data->rmon_stats.fragments) ||
338 	    stat_put(skb, ETHTOOL_A_STATS_RMON_JABBER,
339 		     data->rmon_stats.jabbers))
340 		return -EMSGSIZE;
341 
342 	return 0;
343 }
344 
345 static int stats_put_stats(struct sk_buff *skb,
346 			   const struct stats_reply_data *data,
347 			   u32 id, u32 ss_id,
348 			   int (*cb)(struct sk_buff *skb,
349 				     const struct stats_reply_data *data))
350 {
351 	struct nlattr *nest;
352 
353 	nest = nla_nest_start(skb, ETHTOOL_A_STATS_GRP);
354 	if (!nest)
355 		return -EMSGSIZE;
356 
357 	if (nla_put_u32(skb, ETHTOOL_A_STATS_GRP_ID, id) ||
358 	    nla_put_u32(skb, ETHTOOL_A_STATS_GRP_SS_ID, ss_id))
359 		goto err_cancel;
360 
361 	if (cb(skb, data))
362 		goto err_cancel;
363 
364 	nla_nest_end(skb, nest);
365 	return 0;
366 
367 err_cancel:
368 	nla_nest_cancel(skb, nest);
369 	return -EMSGSIZE;
370 }
371 
372 static int stats_fill_reply(struct sk_buff *skb,
373 			    const struct ethnl_req_info *req_base,
374 			    const struct ethnl_reply_data *reply_base)
375 {
376 	const struct stats_req_info *req_info = STATS_REQINFO(req_base);
377 	const struct stats_reply_data *data = STATS_REPDATA(reply_base);
378 	int ret = 0;
379 
380 	if (!ret && test_bit(ETHTOOL_STATS_ETH_PHY, req_info->stat_mask))
381 		ret = stats_put_stats(skb, data, ETHTOOL_STATS_ETH_PHY,
382 				      ETH_SS_STATS_ETH_PHY,
383 				      stats_put_phy_stats);
384 	if (!ret && test_bit(ETHTOOL_STATS_ETH_MAC, req_info->stat_mask))
385 		ret = stats_put_stats(skb, data, ETHTOOL_STATS_ETH_MAC,
386 				      ETH_SS_STATS_ETH_MAC,
387 				      stats_put_mac_stats);
388 	if (!ret && test_bit(ETHTOOL_STATS_ETH_CTRL, req_info->stat_mask))
389 		ret = stats_put_stats(skb, data, ETHTOOL_STATS_ETH_CTRL,
390 				      ETH_SS_STATS_ETH_CTRL,
391 				      stats_put_ctrl_stats);
392 	if (!ret && test_bit(ETHTOOL_STATS_RMON, req_info->stat_mask))
393 		ret = stats_put_stats(skb, data, ETHTOOL_STATS_RMON,
394 				      ETH_SS_STATS_RMON, stats_put_rmon_stats);
395 
396 	return ret;
397 }
398 
399 const struct ethnl_request_ops ethnl_stats_request_ops = {
400 	.request_cmd		= ETHTOOL_MSG_STATS_GET,
401 	.reply_cmd		= ETHTOOL_MSG_STATS_GET_REPLY,
402 	.hdr_attr		= ETHTOOL_A_STATS_HEADER,
403 	.req_info_size		= sizeof(struct stats_req_info),
404 	.reply_data_size	= sizeof(struct stats_reply_data),
405 
406 	.parse_request		= stats_parse_request,
407 	.prepare_data		= stats_prepare_data,
408 	.reply_size		= stats_reply_size,
409 	.fill_reply		= stats_fill_reply,
410 };
411