net: create device lookup API with reference tracking

New users of dev_get_by_index() and dev_get_by_name() keep
getting added and it would be nice to steer them towards
the APIs with reference tracking.

Add variants of those calls which allocate the reference
tracker and use them in a couple of places.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Reviewed-by: Eric Dumazet <edumazet@google.com>
Reviewed-by: David Ahern <dsahern@kernel.org>
Signed-off-by: David S. Miller <davem@davemloft.net>

diff --git a/include/linux/netdevice.h b/include/linux/netdevice.h
index 2d6cb2bf2f05cf870fab33b2a47f32c113a581fe..acf706d49c2b2eefec2007b0d4e511ce94ceda3d 100644 (file)
--- a/include/linux/netdevice.h
+++ b/include/linux/netdevice.h
@@ -3124,6 +3124,10 @@ struct net_device *netdev_sk_get_lowest_dev(struct net_device *dev,
                                            struct sock *sk);
 struct net_device *dev_get_by_index(struct net *net, int ifindex);
 struct net_device *__dev_get_by_index(struct net *net, int ifindex);
+struct net_device *netdev_get_by_index(struct net *net, int ifindex,
+                                      netdevice_tracker *tracker, gfp_t gfp);
+struct net_device *netdev_get_by_name(struct net *net, const char *name,
+                                     netdevice_tracker *tracker, gfp_t gfp);
 struct net_device *dev_get_by_index_rcu(struct net *net, int ifindex);
 struct net_device *dev_get_by_napi_id(unsigned int napi_id);
 int dev_restart(struct net_device *dev);

diff --git a/net/core/dev.c b/net/core/dev.c
index c2456b3667fe5fe89b78e8723ade6cf0b68f43e1..63abb0463c245713557d16ed8688bf786f4a39c6 100644 (file)
--- a/net/core/dev.c
+++ b/net/core/dev.c
@@ -758,29 +758,43 @@ struct net_device *dev_get_by_name_rcu(struct net *net, const char *name)
 }
 EXPORT_SYMBOL(dev_get_by_name_rcu);
 
+/* Deprecated for new users, call netdev_get_by_name() instead */
+struct net_device *dev_get_by_name(struct net *net, const char *name)
+{
+       struct net_device *dev;
+
+       rcu_read_lock();
+       dev = dev_get_by_name_rcu(net, name);
+       dev_hold(dev);
+       rcu_read_unlock();
+       return dev;
+}
+EXPORT_SYMBOL(dev_get_by_name);
+
 /**
- *     dev_get_by_name         - find a device by its name
+ *     netdev_get_by_name() - find a device by its name
  *     @net: the applicable net namespace
  *     @name: name to find
+ *     @tracker: tracking object for the acquired reference
+ *     @gfp: allocation flags for the tracker
  *
  *     Find an interface by name. This can be called from any
  *     context and does its own locking. The returned handle has
- *     the usage count incremented and the caller must use dev_put() to
+ *     the usage count incremented and the caller must use netdev_put() to
  *     release it when it is no longer needed. %NULL is returned if no
  *     matching device is found.
  */
-
-struct net_device *dev_get_by_name(struct net *net, const char *name)
+struct net_device *netdev_get_by_name(struct net *net, const char *name,
+                                     netdevice_tracker *tracker, gfp_t gfp)
 {
        struct net_device *dev;
 
-       rcu_read_lock();
-       dev = dev_get_by_name_rcu(net, name);
-       dev_hold(dev);
-       rcu_read_unlock();
+       dev = dev_get_by_name(net, name);
+       if (dev)
+               netdev_tracker_alloc(dev, tracker, gfp);
        return dev;
 }
-EXPORT_SYMBOL(dev_get_by_name);
+EXPORT_SYMBOL(netdev_get_by_name);
 
 /**
  *     __dev_get_by_index - find a device by its ifindex
@@ -831,29 +845,42 @@ struct net_device *dev_get_by_index_rcu(struct net *net, int ifindex)
 }
 EXPORT_SYMBOL(dev_get_by_index_rcu);
 
+/* Deprecated for new users, call netdev_get_by_index() instead */
+struct net_device *dev_get_by_index(struct net *net, int ifindex)
+{
+       struct net_device *dev;
+
+       rcu_read_lock();
+       dev = dev_get_by_index_rcu(net, ifindex);
+       dev_hold(dev);
+       rcu_read_unlock();
+       return dev;
+}
+EXPORT_SYMBOL(dev_get_by_index);
 
 /**
- *     dev_get_by_index - find a device by its ifindex
+ *     netdev_get_by_index() - find a device by its ifindex
  *     @net: the applicable net namespace
  *     @ifindex: index of device
+ *     @tracker: tracking object for the acquired reference
+ *     @gfp: allocation flags for the tracker
  *
  *     Search for an interface by index. Returns NULL if the device
  *     is not found or a pointer to the device. The device returned has
  *     had a reference added and the pointer is safe until the user calls
- *     dev_put to indicate they have finished with it.
+ *     netdev_put() to indicate they have finished with it.
  */
-
-struct net_device *dev_get_by_index(struct net *net, int ifindex)
+struct net_device *netdev_get_by_index(struct net *net, int ifindex,
+                                      netdevice_tracker *tracker, gfp_t gfp)
 {
        struct net_device *dev;
 
-       rcu_read_lock();
-       dev = dev_get_by_index_rcu(net, ifindex);
-       dev_hold(dev);
-       rcu_read_unlock();
+       dev = dev_get_by_index(net, ifindex);
+       if (dev)
+               netdev_tracker_alloc(dev, tracker, gfp);
        return dev;
 }
-EXPORT_SYMBOL(dev_get_by_index);
+EXPORT_SYMBOL(netdev_get_by_index);
 
 /**
  *     dev_get_by_napi_id - find a device by napi_id

diff --git a/net/ethtool/netlink.c b/net/ethtool/netlink.c
index 5dd5e8222c45609aa3d1ad2119e5a172290d26b3..39a459b0111b4e0c4d1b6960a1f8af1371b409a6 100644 (file)
--- a/net/ethtool/netlink.c
+++ b/net/ethtool/netlink.c
@@ -115,7 +115,8 @@ int ethnl_parse_header_dev_get(struct ethnl_req_info *req_info,
        if (tb[ETHTOOL_A_HEADER_DEV_INDEX]) {
                u32 ifindex = nla_get_u32(tb[ETHTOOL_A_HEADER_DEV_INDEX]);
 
-               dev = dev_get_by_index(net, ifindex);
+               dev = netdev_get_by_index(net, ifindex, &req_info->dev_tracker,
+                                         GFP_KERNEL);
                if (!dev) {
                        NL_SET_ERR_MSG_ATTR(extack,
                                            tb[ETHTOOL_A_HEADER_DEV_INDEX],
@@ -125,13 +126,14 @@ int ethnl_parse_header_dev_get(struct ethnl_req_info *req_info,
                /* if both ifindex and ifname are passed, they must match */
                if (devname_attr &&
                    strncmp(dev->name, nla_data(devname_attr), IFNAMSIZ)) {
-                       dev_put(dev);
+                       netdev_put(dev, &req_info->dev_tracker);
                        NL_SET_ERR_MSG_ATTR(extack, header,
                                            "ifindex and name do not match");
                        return -ENODEV;
                }
        } else if (devname_attr) {
-               dev = dev_get_by_name(net, nla_data(devname_attr));
+               dev = netdev_get_by_name(net, nla_data(devname_attr),
+                                        &req_info->dev_tracker, GFP_KERNEL);
                if (!dev) {
                        NL_SET_ERR_MSG_ATTR(extack, devname_attr,
                                            "no device matches name");
@@ -144,8 +146,6 @@ int ethnl_parse_header_dev_get(struct ethnl_req_info *req_info,
        }
 
        req_info->dev = dev;
-       if (dev)
-               netdev_tracker_alloc(dev, &req_info->dev_tracker, GFP_KERNEL);
        req_info->flags = flags;
        return 0;
 }

diff --git a/net/ipv6/route.c b/net/ipv6/route.c
index 392aaa373b6671e3f0f9e04f3fa7f4363a06dadb..e510a4162ef8b8bd7209d8c571a6a1fc465244ab 100644 (file)
--- a/net/ipv6/route.c
+++ b/net/ipv6/route.c
@@ -3503,6 +3503,7 @@ int fib6_nh_init(struct net *net, struct fib6_nh *fib6_nh,
                 struct fib6_config *cfg, gfp_t gfp_flags,
                 struct netlink_ext_ack *extack)
 {
+       netdevice_tracker *dev_tracker = &fib6_nh->fib_nh_dev_tracker;
        struct net_device *dev = NULL;
        struct inet6_dev *idev = NULL;
        int addr_type;
@@ -3520,7 +3521,8 @@ int fib6_nh_init(struct net *net, struct fib6_nh *fib6_nh,
 
        err = -ENODEV;
        if (cfg->fc_ifindex) {
-               dev = dev_get_by_index(net, cfg->fc_ifindex);
+               dev = netdev_get_by_index(net, cfg->fc_ifindex,
+                                         dev_tracker, gfp_flags);
                if (!dev)
                        goto out;
                idev = in6_dev_get(dev);
@@ -3554,11 +3556,11 @@ int fib6_nh_init(struct net *net, struct fib6_nh *fib6_nh,
                /* hold loopback dev/idev if we haven't done so. */
                if (dev != net->loopback_dev) {
                        if (dev) {
-                               dev_put(dev);
+                               netdev_put(dev, dev_tracker);
                                in6_dev_put(idev);
                        }
                        dev = net->loopback_dev;
-                       dev_hold(dev);
+                       netdev_hold(dev, dev_tracker, gfp_flags);
                        idev = in6_dev_get(dev);
                        if (!idev) {
                                err = -ENODEV;
@@ -3610,8 +3612,6 @@ pcpu_alloc:
        }
 
        fib6_nh->fib_nh_dev = dev;
-       netdev_tracker_alloc(dev, &fib6_nh->fib_nh_dev_tracker, gfp_flags);
-
        fib6_nh->fib_nh_oif = dev->ifindex;
        err = 0;
 out:
@@ -3621,7 +3621,7 @@ out:
        if (err) {
                lwtstate_put(fib6_nh->fib_nh_lws);
                fib6_nh->fib_nh_lws = NULL;
-               dev_put(dev);
+               netdev_put(dev, dev_tracker);
        }
 
        return err;