[PATCH net-next 1/2] rtnetlink: Add new RTM_GETEECSTATE message to get SyncE status

Maciej Machnikowski
2021-08-31T12:12:31Z

This patch series introduces basic interface for reading the Ethernet
Equipment Clock (EEC) state on a SyncE capable device. This state gives
information about the source of the syntonization signal and the state
of EEC. This interface is required to implement Synchronization Status
Messaging on upper layers.

Initial implementation returns:
- SyncE EEC state
- Source of signal driving SyncE EEC (SyncE, GNSS, PTP or External)
- Current index of the pin driving the EEC to track multiple recovered
clock paths

SyncE EEC state read needs to be implemented as ndo_get_eec_state
function.

Signed-off-by: Maciej Machnikowski <maciej.machnikowski@intel.com>
---
include/linux/netdevice.h | 5 +++
include/uapi/linux/if_link.h | 46 ++++++++++++++++++++++++
include/uapi/linux/rtnetlink.h | 3 ++
net/core/rtnetlink.c | 64 ++++++++++++++++++++++++++++++++++
security/selinux/nlmsgtab.c | 3 +-
5 files changed, 120 insertions(+), 1 deletion(-)

diff --git a/include/linux/netdevice.h b/include/linux/netdevice.h
index 6fd3a4d42668..4e5380900134 100644
--- a/include/linux/netdevice.h
+++ b/include/linux/netdevice.h
@@ -1344,6 +1344,8 @@ struct netdev_net_notifier {
* The caller must be under RCU read context.
* int (*ndo_fill_forward_path)(struct net_device_path_ctx *ctx, struct net_device_path *path);
* Get the forwarding path to reach the real device from the HW destination address
+ * int (*ndo_get_synce_state)(struct net_device *dev, struct if_eec_state_msg *state)
+ * Get state of physical layer frequency syntonization (SyncE)
*/
struct net_device_ops {
int (*ndo_init)(struct net_device *dev);
@@ -1563,6 +1565,9 @@ struct net_device_ops {
struct net_device * (*ndo_get_peer_dev)(struct net_device *dev);
int (*ndo_fill_forward_path)(struct net_device_path_ctx *ctx,
struct net_device_path *path);
+ int (*ndo_get_eec_state)(struct net_device *dev,
+ struct if_eec_state_msg *state,
+ struct netlink_ext_ack *extack);
};

/**
diff --git a/include/uapi/linux/if_link.h b/include/uapi/linux/if_link.h
index eebd3894fe89..7158a4b2b78f 100644
--- a/include/uapi/linux/if_link.h
+++ b/include/uapi/linux/if_link.h
@@ -1273,4 +1273,50 @@ enum {

#define IFLA_MCTP_MAX (__IFLA_MCTP_MAX - 1)

+/* SyncE section */
+
+enum if_eec_state {
+ IF_EEC_STATE_INVALID = 0,
+ IF_EEC_STATE_FREERUN,
+ IF_EEC_STATE_LOCKACQ,
+ IF_EEC_STATE_LOCKREC,
+ IF_EEC_STATE_LOCKED,
+ IF_EEC_STATE_HOLDOVER,
+ IF_EEC_STATE_OPEN_LOOP,
+ __IF_EEC_STATE_MAX,
+};
+
+#define IF_EEC_STATE_MAX (__IF_EEC_STATE_MAX - 1)
+
+enum if_eec_src {
+ IF_EEC_SRC_UNKNOWN = 0,
+ IF_EEC_SRC_SYNCE,
+ IF_EEC_SRC_GNSS,
+ IF_EEC_SRC_PTP,
+ IF_EEC_SRC_EXT,
+ __IF_EEC_SRC_MAX,
+};
+
+#define EEC_FLAG_STATE_VAL (1 << 0)
+#define EEC_FLAG_SRC_VAL (1 << 1)
+#define EEC_FLAG_PIN_VAL (1 << 2)
+
+struct if_eec_state_msg {
+ __u8 flags;
+ __u8 state;
+ __u8 src;
+ __u8 pin;
+ __u32 ifindex;
+};
+
+enum {
+ IFLA_EEC_FLAGS,
+ IFLA_EEC_STATE,
+ IFLA_EEC_SRC,
+ IFLA_EEC_PIN,
+ __IFLA_EEC_MAX,
+};
+
+#define IFLA_EEC_MAX (__IFLA_EEC_MAX - 1)
+
#endif /* _UAPI_LINUX_IF_LINK_H */
diff --git a/include/uapi/linux/rtnetlink.h b/include/uapi/linux/rtnetlink.h
index 5888492a5257..642ac18a09d9 100644
--- a/include/uapi/linux/rtnetlink.h
+++ b/include/uapi/linux/rtnetlink.h
@@ -185,6 +185,9 @@ enum {
RTM_GETNEXTHOPBUCKET,
#define RTM_GETNEXTHOPBUCKET RTM_GETNEXTHOPBUCKET

+ RTM_GETEECSTATE = 120,
+#define RTM_GETEECSTATE RTM_GETEECSTATE
+
__RTM_MAX,
#define RTM_MAX (((__RTM_MAX + 3) & ~3) - 1)
};
diff --git a/net/core/rtnetlink.c b/net/core/rtnetlink.c
index 972c8cb303a5..f5aa6e341952 100644
--- a/net/core/rtnetlink.c
+++ b/net/core/rtnetlink.c
@@ -5468,6 +5468,68 @@ static int rtnl_stats_dump(struct sk_buff *skb, struct netlink_callback *cb)
return skb->len;
}

+static int rtnl_fill_eec_state(struct sk_buff *msg, struct net_device *dev,
+ u32 portid, u32 seq, struct netlink_callback *cb,
+ int flags, struct netlink_ext_ack *extack)
+{
+ const struct net_device_ops *ops = dev->netdev_ops;
+ struct if_eec_state_msg *state;
+ struct nlmsghdr *nlh;
+ int err;
+
+ ASSERT_RTNL();
+
+ if (!ops->ndo_get_eec_state)
+ return -EOPNOTSUPP;
+
+ nlh = nlmsg_put(msg, portid, seq, RTM_GETEECSTATE,
+ sizeof(*state), flags);
+ if (!nlh)
+ return -EMSGSIZE;
+
+ state = nlmsg_data(nlh);
+
+ memset(state, 0, sizeof(*state));
+ err = ops->ndo_get_eec_state(dev, state, extack);
+ if (err)
+ return err;
+
+ return 0;
+}
+
+static int rtnl_eec_state_get(struct sk_buff *skb, struct nlmsghdr *nlh,
+ struct netlink_ext_ack *extack)
+{
+ struct net *net = sock_net(skb->sk);
+ struct if_eec_state_msg *state;
+ struct net_device *dev;
+ struct sk_buff *nskb;
+ int err;
+
+ state = nlmsg_data(nlh);
+ if (state->ifindex > 0)
+ dev = __dev_get_by_index(net, state->ifindex);
+ else
+ return -EINVAL;
+
+ if (!dev)
+ return -ENODEV;
+
+ nskb = nlmsg_new(NLMSG_DEFAULT_SIZE, GFP_KERNEL);
+ if (!nskb)
+ return -ENOBUFS;
+
+ err = rtnl_fill_eec_state(nskb, dev, NETLINK_CB(skb).portid,
+ nlh->nlmsg_seq, NULL, nlh->nlmsg_flags,
+ extack);
+ if (err < 0)
+ kfree_skb(nskb);
+ else
+ err = rtnl_unicast(nskb, net, NETLINK_CB(skb).portid);
+
+ return err;
+}
+
/* Process one rtnetlink message. */

static int rtnetlink_rcv_msg(struct sk_buff *skb, struct nlmsghdr *nlh,
@@ -5693,4 +5755,6 @@ void __init rtnetlink_init(void)

rtnl_register(PF_UNSPEC, RTM_GETSTATS, rtnl_stats_get, rtnl_stats_dump,
0);
+
+ rtnl_register(PF_UNSPEC, RTM_GETEECSTATE, rtnl_eec_state_get, NULL, 0);
}
diff --git a/security/selinux/nlmsgtab.c b/security/selinux/nlmsgtab.c
index d59276f48d4f..0e2d84d6045f 100644
--- a/security/selinux/nlmsgtab.c
+++ b/security/selinux/nlmsgtab.c
@@ -91,6 +91,7 @@ static const struct nlmsg_perm nlmsg_route_perms[] =
{ RTM_NEWNEXTHOPBUCKET, NETLINK_ROUTE_SOCKET__NLMSG_WRITE },
{ RTM_DELNEXTHOPBUCKET, NETLINK_ROUTE_SOCKET__NLMSG_WRITE },
{ RTM_GETNEXTHOPBUCKET, NETLINK_ROUTE_SOCKET__NLMSG_READ },
+ { RTM_GETEECSTATE, NETLINK_ROUTE_SOCKET__NLMSG_READ },
};

static const struct nlmsg_perm nlmsg_tcpdiag_perms[] =
@@ -174,7 +175,7 @@ int selinux_nlmsg_lookup(u16 sclass, u16 nlmsg_type, u32 *perm)
* structures at the top of this file with the new mappings
* before updating the BUILD_BUG_ON() macro!
*/
- BUILD_BUG_ON(RTM_MAX != (RTM_NEWNEXTHOPBUCKET + 3));
+ BUILD_BUG_ON(RTM_MAX != (RTM_GETEECSTATE + 3));
err = nlmsg_perm(nlmsg_type, perm, nlmsg_route_perms,
sizeof(nlmsg_route_perms));
break;
--
2.26.3