Message ID | 20210416160252.2830567-7-kuba@kernel.org (mailing list archive) |
---|---|
State | RFC |
Delegated to: | Michal Kubecek |
Headers | show |
Series | ethtool: add FEC & std stats support | expand |
Context | Check | Description |
---|---|---|
netdev/tree_selection | success | Not a local patch |
On Fri, Apr 16, 2021 at 09:02:52AM -0700, Jakub Kicinski wrote: > # ethtool -S eth0 --groups eth-phy eth-mac rmon > Stats for eth0: > eth-phy-SymbolErrorDuringCarrier: 1 > eth-mac-FramesTransmittedOK: 1 > eth-mac-FrameTooLongErrors: 1 > rmon-etherStatsUndersizePkts: 1 > rmon-etherStatsJabbers: 1 > rmon-etherStatsPkts64Octets: 1 > rmon-etherStatsPkts128to255Octets: 1 > rmon-etherStatsPkts1024toMaxOctets: 0 > > # ethtool --json -S eth0 --groups eth-phy eth-mac rmon | jq > [ > { > "ifname": "eth0", > "eth-phy": { > "SymbolErrorDuringCarrier": 1 > }, > "eth-mac": { > "FramesTransmittedOK": 1, > "FrameTooLongErrors": 0 > }, > "rmon": { > "etherStatsUndersizePkts": 1, > "etherStatsJabbers": 0, > "pktsNtoM": [ > { > "low": 0, > "high": 64, > "val": 1 > }, > { > "low": 128, > "high": 255, > "val": 1 > }, > { > "low": 1024, > "high": 0, > "val": 0 > } > ] > } > } > ] > > # ethtool --json -S eth0 --groups eth-phy eth-mac rmon | \ > jq '.[].rmon.pktsNtoM | map(select(.low >= 128)) | map(.val) | add' > 1 > > Signed-off-by: Jakub Kicinski <kuba@kernel.org> > --- > Makefile.am | 1 + > ethtool.8.in | 11 ++ > ethtool.c | 5 +- > netlink/desc-ethtool.c | 39 +++++++ > netlink/extapi.h | 4 + > netlink/stats.c | 242 +++++++++++++++++++++++++++++++++++++++++ > 6 files changed, 301 insertions(+), 1 deletion(-) > create mode 100644 netlink/stats.c > > diff --git a/Makefile.am b/Makefile.am > index f643a24af97a..75c245653cda 100644 > --- a/Makefile.am > +++ b/Makefile.am > @@ -36,6 +36,7 @@ ethtool_SOURCES += \ > netlink/features.c netlink/privflags.c netlink/rings.c \ > netlink/channels.c netlink/coalesce.c netlink/pause.c \ > netlink/eee.c netlink/tsinfo.c netlink/fec.c \ > + netlink/stats.c \ > netlink/desc-ethtool.c netlink/desc-genlctrl.c \ > netlink/desc-rtnl.c netlink/cable_test.c netlink/tunnels.c \ > uapi/linux/ethtool_netlink.h \ > diff --git a/ethtool.8.in b/ethtool.8.in > index ba4e245cdc61..0ca11595158a 100644 > --- a/ethtool.8.in > +++ b/ethtool.8.in > @@ -240,6 +240,12 @@ ethtool \- query or control network driver and hardware settings > .HP > .B ethtool \-S|\-\-statistics > .I devname > +.RB [\fB--groups > +.RB [\fBeth\-phy\fP] > +.RB [\fBeth\-mac\fP] > +.RB [\fBeth\-ctrl\fP] > +.RN [\fBrmon\fP] > +.RB ] > .HP > .B ethtool \-\-phy\-statistics > .I devname > @@ -653,6 +659,11 @@ auto-negotiation is enabled. > .B \-S \-\-statistics > Queries the specified network device for NIC- and driver-specific > statistics. > +.RS 4 > +.TP > +.B \fB--groups [\fBeth\-phy\fP] [\fBeth\-mac\fP] [\fBeth\-ctrl\fP] [\fBrmon\fP] > +Request standard device statistics of a specific group. > +.RE > .TP > .B \-\-phy\-statistics > Queries the specified network device for PHY specific statistics. > diff --git a/ethtool.c b/ethtool.c > index b07fd9292d77..1b5690f424c8 100644 > --- a/ethtool.c > +++ b/ethtool.c > @@ -5760,7 +5760,10 @@ static const struct option args[] = { > { > .opts = "-S|--statistics", > .func = do_gnicstats, > - .help = "Show adapter statistics" > + .nlchk = nl_gstats_chk, > + .nlfunc = nl_gstats, > + .help = "Show adapter statistics", > + .xhelp = " [ --groups [eth-phy] [eth-mac] [eth-ctrl] [rmon] ]\n" > }, > { > .opts = "--phy-statistics", > diff --git a/netlink/desc-ethtool.c b/netlink/desc-ethtool.c > index 9da052a5b8aa..63e91ee7ffcd 100644 > --- a/netlink/desc-ethtool.c > +++ b/netlink/desc-ethtool.c > @@ -325,6 +325,43 @@ static const struct pretty_nla_desc __fec_desc[] = { > NLATTR_DESC_U32(ETHTOOL_A_FEC_ACTIVE), > }; > > +static const struct pretty_nla_desc __stats_grp_stat_desc[] = { > + NLATTR_DESC_U64(0), NLATTR_DESC_U64(1), NLATTR_DESC_U64(2), > + NLATTR_DESC_U64(3), NLATTR_DESC_U64(4), NLATTR_DESC_U64(5), > + NLATTR_DESC_U64(6), NLATTR_DESC_U64(7), NLATTR_DESC_U64(8), > + NLATTR_DESC_U64(9), NLATTR_DESC_U64(10), NLATTR_DESC_U64(11), > + NLATTR_DESC_U64(12), NLATTR_DESC_U64(13), NLATTR_DESC_U64(14), > + NLATTR_DESC_U64(15), NLATTR_DESC_U64(16), NLATTR_DESC_U64(17), > + NLATTR_DESC_U64(18), NLATTR_DESC_U64(19), NLATTR_DESC_U64(20), > + NLATTR_DESC_U64(21), NLATTR_DESC_U64(22), NLATTR_DESC_U64(23), > + NLATTR_DESC_U64(24), NLATTR_DESC_U64(25), NLATTR_DESC_U64(26), > + NLATTR_DESC_U64(27), NLATTR_DESC_U64(28), NLATTR_DESC_U64(29), > +}; > + > +static const struct pretty_nla_desc __stats_grp_hist_desc[] = { > + NLATTR_DESC_U32(ETHTOOL_A_STATS_GRP_HIST_BKT_LOW), > + NLATTR_DESC_U32(ETHTOOL_A_STATS_GRP_HIST_BKT_HI), > + NLATTR_DESC_U64(ETHTOOL_A_STATS_GRP_HIST_VAL), > +}; > + > +static const struct pretty_nla_desc __stats_grp_desc[] = { > + NLATTR_DESC_INVALID(ETHTOOL_A_STATS_GRP_UNSPEC), > + NLATTR_DESC_INVALID(ETHTOOL_A_STATS_GRP_PAD), > + NLATTR_DESC_U32(ETHTOOL_A_STATS_GRP_ID), > + NLATTR_DESC_U32(ETHTOOL_A_STATS_GRP_SS_ID), > + NLATTR_DESC_NESTED(ETHTOOL_A_STATS_GRP_STAT, stats_grp_stat), > + NLATTR_DESC_NESTED(ETHTOOL_A_STATS_GRP_HIST_RX, stats_grp_hist), > + NLATTR_DESC_NESTED(ETHTOOL_A_STATS_GRP_HIST_TX, stats_grp_hist), > +}; > + > +static const struct pretty_nla_desc __stats_desc[] = { > + NLATTR_DESC_INVALID(ETHTOOL_A_STATS_UNSPEC), > + NLATTR_DESC_INVALID(ETHTOOL_A_STATS_PAD), > + NLATTR_DESC_NESTED(ETHTOOL_A_STATS_HEADER, header), > + NLATTR_DESC_NESTED(ETHTOOL_A_STATS_GROUPS, bitset), > + NLATTR_DESC_NESTED(ETHTOOL_A_STATS_GRP, stats_grp), > +}; > + > const struct pretty_nlmsg_desc ethnl_umsg_desc[] = { > NLMSG_DESC_INVALID(ETHTOOL_MSG_USER_NONE), > NLMSG_DESC(ETHTOOL_MSG_STRSET_GET, strset), > @@ -357,6 +394,7 @@ const struct pretty_nlmsg_desc ethnl_umsg_desc[] = { > NLMSG_DESC(ETHTOOL_MSG_TUNNEL_INFO_GET, tunnel_info), > NLMSG_DESC(ETHTOOL_MSG_FEC_GET, fec), > NLMSG_DESC(ETHTOOL_MSG_FEC_SET, fec), > + NLMSG_DESC(ETHTOOL_MSG_STATS_GET, stats), > }; > > const unsigned int ethnl_umsg_n_desc = ARRAY_SIZE(ethnl_umsg_desc); > @@ -394,6 +432,7 @@ const struct pretty_nlmsg_desc ethnl_kmsg_desc[] = { > NLMSG_DESC(ETHTOOL_MSG_TUNNEL_INFO_GET_REPLY, tunnel_info), > NLMSG_DESC(ETHTOOL_MSG_FEC_GET_REPLY, fec), > NLMSG_DESC(ETHTOOL_MSG_FEC_NTF, fec), > + NLMSG_DESC(ETHTOOL_MSG_STATS_GET_REPLY, stats), > }; > > const unsigned int ethnl_kmsg_n_desc = ARRAY_SIZE(ethnl_kmsg_desc); > diff --git a/netlink/extapi.h b/netlink/extapi.h > index d6036a39e920..97113eb98ca0 100644 > --- a/netlink/extapi.h > +++ b/netlink/extapi.h > @@ -41,6 +41,8 @@ int nl_cable_test_tdr(struct cmd_context *ctx); > int nl_gtunnels(struct cmd_context *ctx); > int nl_gfec(struct cmd_context *ctx); > int nl_sfec(struct cmd_context *ctx); > +bool nl_gstats_chk(struct cmd_context *ctx); > +int nl_gstats(struct cmd_context *ctx); > int nl_monitor(struct cmd_context *ctx); > > void nl_monitor_usage(void); > @@ -92,6 +94,8 @@ static inline void nl_monitor_usage(void) > #define nl_gtunnels NULL > #define nl_gfec NULL > #define nl_sfec NULL > +#define nl_gstats_chk NULL > +#define nl_gstats NULL > > #endif /* ETHTOOL_ENABLE_NETLINK */ > > diff --git a/netlink/stats.c b/netlink/stats.c > new file mode 100644 > index 000000000000..6c0b37a9aa4a > --- /dev/null > +++ b/netlink/stats.c > @@ -0,0 +1,242 @@ > +/* > + * stats.c - netlink implementation of stats > + * > + * Implementation of "ethtool -S <dev> <types>" and > + */ > + > +#include <errno.h> > +#include <ctype.h> > +#include <inttypes.h> > +#include <string.h> > +#include <stdio.h> > + > +#include "../internal.h" > +#include "../common.h" > +#include "netlink.h" > +#include "parser.h" > +#include "strset.h" > + > +static int parse_rmon_hist(const struct nlattr *hist) > +{ > + const struct nlattr *tb[ETHTOOL_A_STATS_GRP_HIST_VAL + 1] = {}; > + DECLARE_ATTR_TB_INFO(tb); > + unsigned long long val; > + unsigned int low, hi; > + int ret; > + > + ret = mnl_attr_parse_nested(hist, attr_cb, &tb_info); > + if (ret < 0) { > + fprintf(stderr, "invalid kernel response - malformed histogram entry\n"); > + return 1; > + } > + > + if (!tb[ETHTOOL_A_STATS_GRP_HIST_BKT_LOW] || > + !tb[ETHTOOL_A_STATS_GRP_HIST_BKT_HI] || > + !tb[ETHTOOL_A_STATS_GRP_HIST_VAL]) { > + fprintf(stderr, "invalid kernel response - histogram entry missing attributes\n"); > + return 1; > + } > + > + low = mnl_attr_get_u32(tb[ETHTOOL_A_STATS_GRP_HIST_BKT_LOW]); > + hi = mnl_attr_get_u32(tb[ETHTOOL_A_STATS_GRP_HIST_BKT_HI]); > + val = mnl_attr_get_u64(tb[ETHTOOL_A_STATS_GRP_HIST_VAL]); > + > + if (!is_json_context()) { > + fprintf(stdout, "rmon-%s-etherStatsPkts", > + mnl_attr_get_type(hist) == ETHTOOL_A_STATS_GRP_HIST_RX ? > + "rx" : "tx"); > + > + if (low && hi) { > + fprintf(stdout, "%uto%uOctets: %llu\n", low, hi, val); > + } else if (hi) { > + fprintf(stdout, "%uOctets: %llu\n", hi, val); > + } else if (low) { > + fprintf(stdout, "%utoMaxOctets: %llu\n", low, val); > + } else { > + fprintf(stderr, "invalid kernel response - bad histogram entry bounds\n"); > + return 1; > + } > + } else { > + open_json_object(NULL); > + print_uint(PRINT_JSON, "low", NULL, low); > + print_uint(PRINT_JSON, "high", NULL, hi); > + print_u64(PRINT_JSON, "val", NULL, val); In the non-JSON output you distinguish between Rx/Tx, but it's missing from the JSON output as can be seen in your example: ``` "pktsNtoM": [ { "low": 0, "high": 64, "val": 1 }, { "low": 128, "high": 255, "val": 1 }, { "low": 1024, "high": 0, "val": 0 } ] ``` I see that mlxsw and mlx5 only support Rx, but it's going to be confusing with bnxt that supports both Rx and Tx. Made me think about the structure of these attributes. Currently you have: ETHTOOL_A_STATS_GRP_HIST_RX ETHTOOL_A_STATS_GRP_HIST_BKT_LOW ETHTOOL_A_STATS_GRP_HIST_BKT_HI ETHTOOL_A_STATS_GRP_HIST_VAL ETHTOOL_A_STATS_GRP_HIST_TX ETHTOOL_A_STATS_GRP_HIST_BKT_LOW ETHTOOL_A_STATS_GRP_HIST_BKT_HI ETHTOOL_A_STATS_GRP_HIST_VAL Did you consider: ETHTOOL_A_STATS_GRP_HIST ETHTOOL_A_STATS_GRP_HIST_BKT_LOW ETHTOOL_A_STATS_GRP_HIST_BKT_HI ETHTOOL_A_STATS_GRP_HIST_VAL ETHTOOL_A_STATS_GRP_HIST_BKT_UNITS ETHTOOL_A_STATS_GRP_HIST_TYPE So you will have something like: ETHTOOL_A_STATS_GRP_HIST_BKT_UNITS_BYTES ETHTOOL_A_STATS_GRP_HIST_VAL_TYPE_RX_PACKETS ETHTOOL_A_STATS_GRP_HIST_VAL_TYPE_TX_PACKETS And it will allow you to get rid of the special casing of the RMON stuff below: ``` if (id == ETHTOOL_STATS_RMON) { open_json_array("pktsNtoM", ""); mnl_attr_for_each_nested(attr, grp) { s = mnl_attr_get_type(attr); if (s != ETHTOOL_A_STATS_GRP_HIST_RX && s != ETHTOOL_A_STATS_GRP_HIST_TX) continue; if (parse_rmon_hist(attr)) goto err_close_rmon; } close_json_array(""); } ``` I don't know how many histograms we are going to have as part of RFCs, but at least mlxsw also supports histograms of the Tx queue depth and latency. Not to be exposed by this interface, but shows the importance of encoding the units. > + close_json_object(); > + } > + > + return 0; > +} > + > +static int parse_grp(struct nl_context *nlctx, const struct nlattr *grp, > + const struct stringset *std_str) > +{ > + const struct nlattr *tb[ETHTOOL_A_STATS_GRP_SS_ID + 1] = {}; > + DECLARE_ATTR_TB_INFO(tb); > + const struct stringset *stat_str; > + const struct nlattr *attr, *stat; > + const char *std_name, *name; > + unsigned int ss_id, id, s; > + unsigned long long val; > + int ret; > + > + ret = mnl_attr_parse_nested(grp, attr_cb, &tb_info); > + if (ret < 0) > + return 1; > + > + if (!tb[ETHTOOL_A_STATS_GRP_ID]) > + return 1; > + if (!tb[ETHTOOL_A_STATS_GRP_SS_ID]) > + return 0; > + > + id = mnl_attr_get_u32(tb[ETHTOOL_A_STATS_GRP_ID]); > + ss_id = mnl_attr_get_u32(tb[ETHTOOL_A_STATS_GRP_SS_ID]); > + > + stat_str = global_stringset(ss_id, nlctx->ethnl2_socket); > + > + std_name = get_string(std_str, id); > + open_json_object(std_name); > + > + mnl_attr_for_each_nested(attr, grp) { > + if (mnl_attr_get_type(attr) != ETHTOOL_A_STATS_GRP_STAT) > + continue; > + stat = mnl_attr_get_payload(attr); > + ret = mnl_attr_validate(stat, MNL_TYPE_U64); > + if (ret) { > + fprintf(stderr, "invalid kernel response - bad statistic entry\n"); > + goto err_close_grp; > + } > + s = mnl_attr_get_type(stat); > + name = get_string(stat_str, s); > + if (!name || !name[0]) > + continue; > + > + if (!is_json_context()) > + fprintf(stdout, "%s-%s: ", std_name, name); > + > + val = mnl_attr_get_u64(stat); > + print_u64(PRINT_ANY, name, "%llu\n", val); > + } > + > + if (id == ETHTOOL_STATS_RMON) { > + open_json_array("pktsNtoM", ""); > + > + mnl_attr_for_each_nested(attr, grp) { > + s = mnl_attr_get_type(attr); > + if (s != ETHTOOL_A_STATS_GRP_HIST_RX && > + s != ETHTOOL_A_STATS_GRP_HIST_TX) > + continue; > + > + if (parse_rmon_hist(attr)) > + goto err_close_rmon; > + } > + close_json_array(""); > + } > + > + close_json_object(); > + > + return 0; > + > +err_close_rmon: > + close_json_array(""); > +err_close_grp: > + close_json_object(); > + return 1; > +} > + > +static int stats_reply_cb(const struct nlmsghdr *nlhdr, void *data) > +{ > + const struct nlattr *tb[ETHTOOL_A_STATS_MAX + 1] = {}; > + DECLARE_ATTR_TB_INFO(tb); > + struct nl_context *nlctx = data; > + const struct stringset *std_str; > + const struct nlattr *attr; > + bool silent; > + int err_ret; > + int ret; > + > + silent = nlctx->is_dump || nlctx->is_monitor; > + err_ret = silent ? MNL_CB_OK : MNL_CB_ERROR; > + ret = mnl_attr_parse(nlhdr, GENL_HDRLEN, attr_cb, &tb_info); > + if (ret < 0) > + return err_ret; > + nlctx->devname = get_dev_name(tb[ETHTOOL_A_STATS_HEADER]); > + if (!dev_ok(nlctx)) > + return err_ret; > + > + ret = netlink_init_ethnl2_socket(nlctx); > + if (ret < 0) > + return err_ret; > + std_str = global_stringset(ETH_SS_STATS_STD, nlctx->ethnl2_socket); > + > + if (silent) > + print_nl(); > + > + open_json_object(NULL); > + > + print_string(PRINT_ANY, "ifname", "Standard stats for %s:\n", > + nlctx->devname); > + > + mnl_attr_for_each(attr, nlhdr, GENL_HDRLEN) { > + if (mnl_attr_get_type(attr) == ETHTOOL_A_STATS_GRP) { > + ret = parse_grp(nlctx, attr, std_str); > + if (ret) > + goto err_close_dev; > + } > + } > + > + close_json_object(); > + > + return MNL_CB_OK; > + > +err_close_dev: > + close_json_object(); > + return err_ret; > +} > + > +static const struct bitset_parser_data stats_parser_data = { > + .no_mask = true, > + .force_hex = false, > +}; > + > +static const struct param_parser stats_params[] = { > + { > + .arg = "--groups", > + .type = ETHTOOL_A_STATS_GROUPS, > + .handler = nl_parse_bitset, > + .handler_data = &stats_parser_data, > + .min_argc = 1, > + }, > + {} > +}; > + > +int nl_gstats(struct cmd_context *ctx) > +{ > + struct nl_context *nlctx = ctx->nlctx; > + struct nl_socket *nlsk = nlctx->ethnl_socket; > + int ret; > + > + ret = nlsock_prep_get_request(nlsk, ETHTOOL_MSG_STATS_GET, > + ETHTOOL_A_STATS_HEADER, 0); > + if (ret < 0) > + return ret; > + > + nlctx->cmd = "-S"; > + nlctx->argp = ctx->argp; > + nlctx->argc = ctx->argc; > + nlctx->devname = ctx->devname; > + nlsk = nlctx->ethnl_socket; > + > + ret = nl_parser(nlctx, stats_params, NULL, PARSER_GROUP_NONE, NULL); > + if (ret < 0) > + return 1; > + > + new_json_obj(ctx->json); > + ret = nlsock_send_get_request(nlsk, stats_reply_cb); > + delete_json_obj(); > + return ret; > +} > + > +bool nl_gstats_chk(struct cmd_context *ctx) > +{ > + return ctx->argc; > +} > -- > 2.30.2 >
On Sat, 17 Apr 2021 21:14:40 +0300 Ido Schimmel wrote: > > + if (!is_json_context()) { > > + fprintf(stdout, "rmon-%s-etherStatsPkts", > > + mnl_attr_get_type(hist) == ETHTOOL_A_STATS_GRP_HIST_RX ? > > + "rx" : "tx"); > > + > > + if (low && hi) { > > + fprintf(stdout, "%uto%uOctets: %llu\n", low, hi, val); > > + } else if (hi) { > > + fprintf(stdout, "%uOctets: %llu\n", hi, val); > > + } else if (low) { > > + fprintf(stdout, "%utoMaxOctets: %llu\n", low, val); > > + } else { > > + fprintf(stderr, "invalid kernel response - bad histogram entry bounds\n"); > > + return 1; > > + } > > + } else { > > + open_json_object(NULL); > > + print_uint(PRINT_JSON, "low", NULL, low); > > + print_uint(PRINT_JSON, "high", NULL, hi); > > + print_u64(PRINT_JSON, "val", NULL, val); > > In the non-JSON output you distinguish between Rx/Tx, but it's missing > from the JSON output as can be seen in your example: > > ``` > "pktsNtoM": [ > { > "low": 0, > "high": 64, > "val": 1 > }, > { > "low": 128, > "high": 255, > "val": 1 > }, > { > "low": 1024, > "high": 0, > "val": 0 > } > ] > ``` > > I see that mlxsw and mlx5 only support Rx, but it's going to be > confusing with bnxt that supports both Rx and Tx. Good catch! I added Tx last minute (even though it's non standard). I'll split split into two arrays - "rx-pktsNtoM" and "tx-pktsNtoM", sounds good? Or we can add a layer: ["pktsNtoM"]["rx"] etc. > Made me think about the structure of these attributes. Currently you > have: > > ETHTOOL_A_STATS_GRP_HIST_RX > ETHTOOL_A_STATS_GRP_HIST_BKT_LOW > ETHTOOL_A_STATS_GRP_HIST_BKT_HI > ETHTOOL_A_STATS_GRP_HIST_VAL > > ETHTOOL_A_STATS_GRP_HIST_TX > ETHTOOL_A_STATS_GRP_HIST_BKT_LOW > ETHTOOL_A_STATS_GRP_HIST_BKT_HI > ETHTOOL_A_STATS_GRP_HIST_VAL > > Did you consider: > > ETHTOOL_A_STATS_GRP_HIST > ETHTOOL_A_STATS_GRP_HIST_BKT_LOW > ETHTOOL_A_STATS_GRP_HIST_BKT_HI > ETHTOOL_A_STATS_GRP_HIST_VAL > ETHTOOL_A_STATS_GRP_HIST_BKT_UNITS > ETHTOOL_A_STATS_GRP_HIST_TYPE I went back and forth on that. The reason I put the direction in the type is that normal statistics don't have an extra _TYPE or direction. It will also be easier to break the stats out to arrays if they are typed on the outside, see below. > So you will have something like: > > ETHTOOL_A_STATS_GRP_HIST_BKT_UNITS_BYTES Histogram has two dimensions, what's the second dimension for bytes? Time? Packet arrival? > ETHTOOL_A_STATS_GRP_HIST_VAL_TYPE_RX_PACKETS > ETHTOOL_A_STATS_GRP_HIST_VAL_TYPE_TX_PACKETS > > And it will allow you to get rid of the special casing of the RMON stuff > below: > > ``` > if (id == ETHTOOL_STATS_RMON) { > open_json_array("pktsNtoM", ""); > > mnl_attr_for_each_nested(attr, grp) { > s = mnl_attr_get_type(attr); > if (s != ETHTOOL_A_STATS_GRP_HIST_RX && > s != ETHTOOL_A_STATS_GRP_HIST_TX) > continue; > > if (parse_rmon_hist(attr)) > goto err_close_rmon; > } > close_json_array(""); > } > ``` We can drop the if, but we still need a separate for() loop to be able to place those entries in a JSON array. > I don't know how many histograms we are going to have as part of RFCs, > but at least mlxsw also supports histograms of the Tx queue depth and > latency. Not to be exposed by this interface, but shows the importance > of encoding the units. TBH I hope we'll never use the hist for anything else. Sadly the bucketing of various drivers is really different (at least 6 variants). But the overarching goal is a common interface for common port stats.
On Sat, Apr 17, 2021 at 11:47:28AM -0700, Jakub Kicinski wrote: > On Sat, 17 Apr 2021 21:14:40 +0300 Ido Schimmel wrote: > > > + if (!is_json_context()) { > > > + fprintf(stdout, "rmon-%s-etherStatsPkts", > > > + mnl_attr_get_type(hist) == ETHTOOL_A_STATS_GRP_HIST_RX ? > > > + "rx" : "tx"); > > > + > > > + if (low && hi) { > > > + fprintf(stdout, "%uto%uOctets: %llu\n", low, hi, val); > > > + } else if (hi) { > > > + fprintf(stdout, "%uOctets: %llu\n", hi, val); > > > + } else if (low) { > > > + fprintf(stdout, "%utoMaxOctets: %llu\n", low, val); > > > + } else { > > > + fprintf(stderr, "invalid kernel response - bad histogram entry bounds\n"); > > > + return 1; > > > + } > > > + } else { > > > + open_json_object(NULL); > > > + print_uint(PRINT_JSON, "low", NULL, low); > > > + print_uint(PRINT_JSON, "high", NULL, hi); > > > + print_u64(PRINT_JSON, "val", NULL, val); > > > > In the non-JSON output you distinguish between Rx/Tx, but it's missing > > from the JSON output as can be seen in your example: > > > > ``` > > "pktsNtoM": [ > > { > > "low": 0, > > "high": 64, > > "val": 1 > > }, > > { > > "low": 128, > > "high": 255, > > "val": 1 > > }, > > { > > "low": 1024, > > "high": 0, > > "val": 0 > > } > > ] > > ``` > > > > I see that mlxsw and mlx5 only support Rx, but it's going to be > > confusing with bnxt that supports both Rx and Tx. > > Good catch! I added Tx last minute (even though it's non standard). > I'll split split into two arrays - "rx-pktsNtoM" and "tx-pktsNtoM", > sounds good? Or we can add a layer: ["pktsNtoM"]["rx"] etc. I'm fine with both, but I think the first form will be easier when working with jq to extract Rx/Tx. It is also more inline with the current nesting of the netlink attributes. > > > Made me think about the structure of these attributes. Currently you > > have: > > > > ETHTOOL_A_STATS_GRP_HIST_RX > > ETHTOOL_A_STATS_GRP_HIST_BKT_LOW > > ETHTOOL_A_STATS_GRP_HIST_BKT_HI > > ETHTOOL_A_STATS_GRP_HIST_VAL > > > > ETHTOOL_A_STATS_GRP_HIST_TX > > ETHTOOL_A_STATS_GRP_HIST_BKT_LOW > > ETHTOOL_A_STATS_GRP_HIST_BKT_HI > > ETHTOOL_A_STATS_GRP_HIST_VAL > > > > Did you consider: > > > > ETHTOOL_A_STATS_GRP_HIST > > ETHTOOL_A_STATS_GRP_HIST_BKT_LOW > > ETHTOOL_A_STATS_GRP_HIST_BKT_HI > > ETHTOOL_A_STATS_GRP_HIST_VAL > > ETHTOOL_A_STATS_GRP_HIST_BKT_UNITS > > ETHTOOL_A_STATS_GRP_HIST_TYPE > > I went back and forth on that. The reason I put the direction in the > type is that normal statistics don't have an extra _TYPE or direction. > > It will also be easier to break the stats out to arrays if they are > typed on the outside, see below. > > > So you will have something like: > > > > ETHTOOL_A_STATS_GRP_HIST_BKT_UNITS_BYTES > > Histogram has two dimensions, what's the second dimension for bytes? > Time? Packet arrival? Not sure what you mean. Here you are counting how many Rx/Tx packets are between N to M bytes in length. I meant to add two attributes. One that tells user space that you are counting Rx/Tx packets and the second that N to M are in bytes. But given your comment below about this histogram probably being a one time thing, I think maybe staying with the current attributes is OK. There is no need to over-engineer it if we don't see ourselves adding new histograms. Anyway, these histograms are under ETHTOOL_A_STATS_GRP that should give user space all the context about what is being counted. > > > ETHTOOL_A_STATS_GRP_HIST_VAL_TYPE_RX_PACKETS > > ETHTOOL_A_STATS_GRP_HIST_VAL_TYPE_TX_PACKETS > > > > And it will allow you to get rid of the special casing of the RMON stuff > > below: > > > > ``` > > if (id == ETHTOOL_STATS_RMON) { > > open_json_array("pktsNtoM", ""); > > > > mnl_attr_for_each_nested(attr, grp) { > > s = mnl_attr_get_type(attr); > > if (s != ETHTOOL_A_STATS_GRP_HIST_RX && > > s != ETHTOOL_A_STATS_GRP_HIST_TX) > > continue; > > > > if (parse_rmon_hist(attr)) > > goto err_close_rmon; > > } > > close_json_array(""); > > } > > ``` > > We can drop the if, but we still need a separate for() loop > to be able to place those entries in a JSON array. > > > I don't know how many histograms we are going to have as part of RFCs, > > but at least mlxsw also supports histograms of the Tx queue depth and > > latency. Not to be exposed by this interface, but shows the importance > > of encoding the units. > > TBH I hope we'll never use the hist for anything else. Sadly the > bucketing of various drivers is really different (at least 6 > variants). But the overarching goal is a common interface for common > port stats.
On Sat, 17 Apr 2021 22:22:57 +0300 Ido Schimmel wrote: > > > So you will have something like: > > > > > > ETHTOOL_A_STATS_GRP_HIST_BKT_UNITS_BYTES > > > > Histogram has two dimensions, what's the second dimension for bytes? > > Time? Packet arrival? > > Not sure what you mean. Here you are counting how many Rx/Tx packets are > between N to M bytes in length. I meant to add two attributes. One that > tells user space that you are counting Rx/Tx packets and the second that > N to M are in bytes. Ah, these were not part of the same enum, I get it now. I thought maybe bytes were trying to cater to the queue length use case and I wasn't sure how that histogram is constructed. > But given your comment below about this histogram probably being a one > time thing, I think maybe staying with the current attributes is OK. > There is no need to over-engineer it if we don't see ourselves adding > new histograms. > > Anyway, these histograms are under ETHTOOL_A_STATS_GRP that should give > user space all the context about what is being counted.
diff --git a/Makefile.am b/Makefile.am index f643a24af97a..75c245653cda 100644 --- a/Makefile.am +++ b/Makefile.am @@ -36,6 +36,7 @@ ethtool_SOURCES += \ netlink/features.c netlink/privflags.c netlink/rings.c \ netlink/channels.c netlink/coalesce.c netlink/pause.c \ netlink/eee.c netlink/tsinfo.c netlink/fec.c \ + netlink/stats.c \ netlink/desc-ethtool.c netlink/desc-genlctrl.c \ netlink/desc-rtnl.c netlink/cable_test.c netlink/tunnels.c \ uapi/linux/ethtool_netlink.h \ diff --git a/ethtool.8.in b/ethtool.8.in index ba4e245cdc61..0ca11595158a 100644 --- a/ethtool.8.in +++ b/ethtool.8.in @@ -240,6 +240,12 @@ ethtool \- query or control network driver and hardware settings .HP .B ethtool \-S|\-\-statistics .I devname +.RB [\fB--groups +.RB [\fBeth\-phy\fP] +.RB [\fBeth\-mac\fP] +.RB [\fBeth\-ctrl\fP] +.RN [\fBrmon\fP] +.RB ] .HP .B ethtool \-\-phy\-statistics .I devname @@ -653,6 +659,11 @@ auto-negotiation is enabled. .B \-S \-\-statistics Queries the specified network device for NIC- and driver-specific statistics. +.RS 4 +.TP +.B \fB--groups [\fBeth\-phy\fP] [\fBeth\-mac\fP] [\fBeth\-ctrl\fP] [\fBrmon\fP] +Request standard device statistics of a specific group. +.RE .TP .B \-\-phy\-statistics Queries the specified network device for PHY specific statistics. diff --git a/ethtool.c b/ethtool.c index b07fd9292d77..1b5690f424c8 100644 --- a/ethtool.c +++ b/ethtool.c @@ -5760,7 +5760,10 @@ static const struct option args[] = { { .opts = "-S|--statistics", .func = do_gnicstats, - .help = "Show adapter statistics" + .nlchk = nl_gstats_chk, + .nlfunc = nl_gstats, + .help = "Show adapter statistics", + .xhelp = " [ --groups [eth-phy] [eth-mac] [eth-ctrl] [rmon] ]\n" }, { .opts = "--phy-statistics", diff --git a/netlink/desc-ethtool.c b/netlink/desc-ethtool.c index 9da052a5b8aa..63e91ee7ffcd 100644 --- a/netlink/desc-ethtool.c +++ b/netlink/desc-ethtool.c @@ -325,6 +325,43 @@ static const struct pretty_nla_desc __fec_desc[] = { NLATTR_DESC_U32(ETHTOOL_A_FEC_ACTIVE), }; +static const struct pretty_nla_desc __stats_grp_stat_desc[] = { + NLATTR_DESC_U64(0), NLATTR_DESC_U64(1), NLATTR_DESC_U64(2), + NLATTR_DESC_U64(3), NLATTR_DESC_U64(4), NLATTR_DESC_U64(5), + NLATTR_DESC_U64(6), NLATTR_DESC_U64(7), NLATTR_DESC_U64(8), + NLATTR_DESC_U64(9), NLATTR_DESC_U64(10), NLATTR_DESC_U64(11), + NLATTR_DESC_U64(12), NLATTR_DESC_U64(13), NLATTR_DESC_U64(14), + NLATTR_DESC_U64(15), NLATTR_DESC_U64(16), NLATTR_DESC_U64(17), + NLATTR_DESC_U64(18), NLATTR_DESC_U64(19), NLATTR_DESC_U64(20), + NLATTR_DESC_U64(21), NLATTR_DESC_U64(22), NLATTR_DESC_U64(23), + NLATTR_DESC_U64(24), NLATTR_DESC_U64(25), NLATTR_DESC_U64(26), + NLATTR_DESC_U64(27), NLATTR_DESC_U64(28), NLATTR_DESC_U64(29), +}; + +static const struct pretty_nla_desc __stats_grp_hist_desc[] = { + NLATTR_DESC_U32(ETHTOOL_A_STATS_GRP_HIST_BKT_LOW), + NLATTR_DESC_U32(ETHTOOL_A_STATS_GRP_HIST_BKT_HI), + NLATTR_DESC_U64(ETHTOOL_A_STATS_GRP_HIST_VAL), +}; + +static const struct pretty_nla_desc __stats_grp_desc[] = { + NLATTR_DESC_INVALID(ETHTOOL_A_STATS_GRP_UNSPEC), + NLATTR_DESC_INVALID(ETHTOOL_A_STATS_GRP_PAD), + NLATTR_DESC_U32(ETHTOOL_A_STATS_GRP_ID), + NLATTR_DESC_U32(ETHTOOL_A_STATS_GRP_SS_ID), + NLATTR_DESC_NESTED(ETHTOOL_A_STATS_GRP_STAT, stats_grp_stat), + NLATTR_DESC_NESTED(ETHTOOL_A_STATS_GRP_HIST_RX, stats_grp_hist), + NLATTR_DESC_NESTED(ETHTOOL_A_STATS_GRP_HIST_TX, stats_grp_hist), +}; + +static const struct pretty_nla_desc __stats_desc[] = { + NLATTR_DESC_INVALID(ETHTOOL_A_STATS_UNSPEC), + NLATTR_DESC_INVALID(ETHTOOL_A_STATS_PAD), + NLATTR_DESC_NESTED(ETHTOOL_A_STATS_HEADER, header), + NLATTR_DESC_NESTED(ETHTOOL_A_STATS_GROUPS, bitset), + NLATTR_DESC_NESTED(ETHTOOL_A_STATS_GRP, stats_grp), +}; + const struct pretty_nlmsg_desc ethnl_umsg_desc[] = { NLMSG_DESC_INVALID(ETHTOOL_MSG_USER_NONE), NLMSG_DESC(ETHTOOL_MSG_STRSET_GET, strset), @@ -357,6 +394,7 @@ const struct pretty_nlmsg_desc ethnl_umsg_desc[] = { NLMSG_DESC(ETHTOOL_MSG_TUNNEL_INFO_GET, tunnel_info), NLMSG_DESC(ETHTOOL_MSG_FEC_GET, fec), NLMSG_DESC(ETHTOOL_MSG_FEC_SET, fec), + NLMSG_DESC(ETHTOOL_MSG_STATS_GET, stats), }; const unsigned int ethnl_umsg_n_desc = ARRAY_SIZE(ethnl_umsg_desc); @@ -394,6 +432,7 @@ const struct pretty_nlmsg_desc ethnl_kmsg_desc[] = { NLMSG_DESC(ETHTOOL_MSG_TUNNEL_INFO_GET_REPLY, tunnel_info), NLMSG_DESC(ETHTOOL_MSG_FEC_GET_REPLY, fec), NLMSG_DESC(ETHTOOL_MSG_FEC_NTF, fec), + NLMSG_DESC(ETHTOOL_MSG_STATS_GET_REPLY, stats), }; const unsigned int ethnl_kmsg_n_desc = ARRAY_SIZE(ethnl_kmsg_desc); diff --git a/netlink/extapi.h b/netlink/extapi.h index d6036a39e920..97113eb98ca0 100644 --- a/netlink/extapi.h +++ b/netlink/extapi.h @@ -41,6 +41,8 @@ int nl_cable_test_tdr(struct cmd_context *ctx); int nl_gtunnels(struct cmd_context *ctx); int nl_gfec(struct cmd_context *ctx); int nl_sfec(struct cmd_context *ctx); +bool nl_gstats_chk(struct cmd_context *ctx); +int nl_gstats(struct cmd_context *ctx); int nl_monitor(struct cmd_context *ctx); void nl_monitor_usage(void); @@ -92,6 +94,8 @@ static inline void nl_monitor_usage(void) #define nl_gtunnels NULL #define nl_gfec NULL #define nl_sfec NULL +#define nl_gstats_chk NULL +#define nl_gstats NULL #endif /* ETHTOOL_ENABLE_NETLINK */ diff --git a/netlink/stats.c b/netlink/stats.c new file mode 100644 index 000000000000..6c0b37a9aa4a --- /dev/null +++ b/netlink/stats.c @@ -0,0 +1,242 @@ +/* + * stats.c - netlink implementation of stats + * + * Implementation of "ethtool -S <dev> <types>" and + */ + +#include <errno.h> +#include <ctype.h> +#include <inttypes.h> +#include <string.h> +#include <stdio.h> + +#include "../internal.h" +#include "../common.h" +#include "netlink.h" +#include "parser.h" +#include "strset.h" + +static int parse_rmon_hist(const struct nlattr *hist) +{ + const struct nlattr *tb[ETHTOOL_A_STATS_GRP_HIST_VAL + 1] = {}; + DECLARE_ATTR_TB_INFO(tb); + unsigned long long val; + unsigned int low, hi; + int ret; + + ret = mnl_attr_parse_nested(hist, attr_cb, &tb_info); + if (ret < 0) { + fprintf(stderr, "invalid kernel response - malformed histogram entry\n"); + return 1; + } + + if (!tb[ETHTOOL_A_STATS_GRP_HIST_BKT_LOW] || + !tb[ETHTOOL_A_STATS_GRP_HIST_BKT_HI] || + !tb[ETHTOOL_A_STATS_GRP_HIST_VAL]) { + fprintf(stderr, "invalid kernel response - histogram entry missing attributes\n"); + return 1; + } + + low = mnl_attr_get_u32(tb[ETHTOOL_A_STATS_GRP_HIST_BKT_LOW]); + hi = mnl_attr_get_u32(tb[ETHTOOL_A_STATS_GRP_HIST_BKT_HI]); + val = mnl_attr_get_u64(tb[ETHTOOL_A_STATS_GRP_HIST_VAL]); + + if (!is_json_context()) { + fprintf(stdout, "rmon-%s-etherStatsPkts", + mnl_attr_get_type(hist) == ETHTOOL_A_STATS_GRP_HIST_RX ? + "rx" : "tx"); + + if (low && hi) { + fprintf(stdout, "%uto%uOctets: %llu\n", low, hi, val); + } else if (hi) { + fprintf(stdout, "%uOctets: %llu\n", hi, val); + } else if (low) { + fprintf(stdout, "%utoMaxOctets: %llu\n", low, val); + } else { + fprintf(stderr, "invalid kernel response - bad histogram entry bounds\n"); + return 1; + } + } else { + open_json_object(NULL); + print_uint(PRINT_JSON, "low", NULL, low); + print_uint(PRINT_JSON, "high", NULL, hi); + print_u64(PRINT_JSON, "val", NULL, val); + close_json_object(); + } + + return 0; +} + +static int parse_grp(struct nl_context *nlctx, const struct nlattr *grp, + const struct stringset *std_str) +{ + const struct nlattr *tb[ETHTOOL_A_STATS_GRP_SS_ID + 1] = {}; + DECLARE_ATTR_TB_INFO(tb); + const struct stringset *stat_str; + const struct nlattr *attr, *stat; + const char *std_name, *name; + unsigned int ss_id, id, s; + unsigned long long val; + int ret; + + ret = mnl_attr_parse_nested(grp, attr_cb, &tb_info); + if (ret < 0) + return 1; + + if (!tb[ETHTOOL_A_STATS_GRP_ID]) + return 1; + if (!tb[ETHTOOL_A_STATS_GRP_SS_ID]) + return 0; + + id = mnl_attr_get_u32(tb[ETHTOOL_A_STATS_GRP_ID]); + ss_id = mnl_attr_get_u32(tb[ETHTOOL_A_STATS_GRP_SS_ID]); + + stat_str = global_stringset(ss_id, nlctx->ethnl2_socket); + + std_name = get_string(std_str, id); + open_json_object(std_name); + + mnl_attr_for_each_nested(attr, grp) { + if (mnl_attr_get_type(attr) != ETHTOOL_A_STATS_GRP_STAT) + continue; + stat = mnl_attr_get_payload(attr); + ret = mnl_attr_validate(stat, MNL_TYPE_U64); + if (ret) { + fprintf(stderr, "invalid kernel response - bad statistic entry\n"); + goto err_close_grp; + } + s = mnl_attr_get_type(stat); + name = get_string(stat_str, s); + if (!name || !name[0]) + continue; + + if (!is_json_context()) + fprintf(stdout, "%s-%s: ", std_name, name); + + val = mnl_attr_get_u64(stat); + print_u64(PRINT_ANY, name, "%llu\n", val); + } + + if (id == ETHTOOL_STATS_RMON) { + open_json_array("pktsNtoM", ""); + + mnl_attr_for_each_nested(attr, grp) { + s = mnl_attr_get_type(attr); + if (s != ETHTOOL_A_STATS_GRP_HIST_RX && + s != ETHTOOL_A_STATS_GRP_HIST_TX) + continue; + + if (parse_rmon_hist(attr)) + goto err_close_rmon; + } + close_json_array(""); + } + + close_json_object(); + + return 0; + +err_close_rmon: + close_json_array(""); +err_close_grp: + close_json_object(); + return 1; +} + +static int stats_reply_cb(const struct nlmsghdr *nlhdr, void *data) +{ + const struct nlattr *tb[ETHTOOL_A_STATS_MAX + 1] = {}; + DECLARE_ATTR_TB_INFO(tb); + struct nl_context *nlctx = data; + const struct stringset *std_str; + const struct nlattr *attr; + bool silent; + int err_ret; + int ret; + + silent = nlctx->is_dump || nlctx->is_monitor; + err_ret = silent ? MNL_CB_OK : MNL_CB_ERROR; + ret = mnl_attr_parse(nlhdr, GENL_HDRLEN, attr_cb, &tb_info); + if (ret < 0) + return err_ret; + nlctx->devname = get_dev_name(tb[ETHTOOL_A_STATS_HEADER]); + if (!dev_ok(nlctx)) + return err_ret; + + ret = netlink_init_ethnl2_socket(nlctx); + if (ret < 0) + return err_ret; + std_str = global_stringset(ETH_SS_STATS_STD, nlctx->ethnl2_socket); + + if (silent) + print_nl(); + + open_json_object(NULL); + + print_string(PRINT_ANY, "ifname", "Standard stats for %s:\n", + nlctx->devname); + + mnl_attr_for_each(attr, nlhdr, GENL_HDRLEN) { + if (mnl_attr_get_type(attr) == ETHTOOL_A_STATS_GRP) { + ret = parse_grp(nlctx, attr, std_str); + if (ret) + goto err_close_dev; + } + } + + close_json_object(); + + return MNL_CB_OK; + +err_close_dev: + close_json_object(); + return err_ret; +} + +static const struct bitset_parser_data stats_parser_data = { + .no_mask = true, + .force_hex = false, +}; + +static const struct param_parser stats_params[] = { + { + .arg = "--groups", + .type = ETHTOOL_A_STATS_GROUPS, + .handler = nl_parse_bitset, + .handler_data = &stats_parser_data, + .min_argc = 1, + }, + {} +}; + +int nl_gstats(struct cmd_context *ctx) +{ + struct nl_context *nlctx = ctx->nlctx; + struct nl_socket *nlsk = nlctx->ethnl_socket; + int ret; + + ret = nlsock_prep_get_request(nlsk, ETHTOOL_MSG_STATS_GET, + ETHTOOL_A_STATS_HEADER, 0); + if (ret < 0) + return ret; + + nlctx->cmd = "-S"; + nlctx->argp = ctx->argp; + nlctx->argc = ctx->argc; + nlctx->devname = ctx->devname; + nlsk = nlctx->ethnl_socket; + + ret = nl_parser(nlctx, stats_params, NULL, PARSER_GROUP_NONE, NULL); + if (ret < 0) + return 1; + + new_json_obj(ctx->json); + ret = nlsock_send_get_request(nlsk, stats_reply_cb); + delete_json_obj(); + return ret; +} + +bool nl_gstats_chk(struct cmd_context *ctx) +{ + return ctx->argc; +}
# ethtool -S eth0 --groups eth-phy eth-mac rmon Stats for eth0: eth-phy-SymbolErrorDuringCarrier: 1 eth-mac-FramesTransmittedOK: 1 eth-mac-FrameTooLongErrors: 1 rmon-etherStatsUndersizePkts: 1 rmon-etherStatsJabbers: 1 rmon-etherStatsPkts64Octets: 1 rmon-etherStatsPkts128to255Octets: 1 rmon-etherStatsPkts1024toMaxOctets: 0 # ethtool --json -S eth0 --groups eth-phy eth-mac rmon | jq [ { "ifname": "eth0", "eth-phy": { "SymbolErrorDuringCarrier": 1 }, "eth-mac": { "FramesTransmittedOK": 1, "FrameTooLongErrors": 0 }, "rmon": { "etherStatsUndersizePkts": 1, "etherStatsJabbers": 0, "pktsNtoM": [ { "low": 0, "high": 64, "val": 1 }, { "low": 128, "high": 255, "val": 1 }, { "low": 1024, "high": 0, "val": 0 } ] } } ] # ethtool --json -S eth0 --groups eth-phy eth-mac rmon | \ jq '.[].rmon.pktsNtoM | map(select(.low >= 128)) | map(.val) | add' 1 Signed-off-by: Jakub Kicinski <kuba@kernel.org> --- Makefile.am | 1 + ethtool.8.in | 11 ++ ethtool.c | 5 +- netlink/desc-ethtool.c | 39 +++++++ netlink/extapi.h | 4 + netlink/stats.c | 242 +++++++++++++++++++++++++++++++++++++++++ 6 files changed, 301 insertions(+), 1 deletion(-) create mode 100644 netlink/stats.c