1 // SPDX-License-Identifier: GPL-2.0
2 #include <linux/kmod.h>
3 #include <linux/netdevice.h>
4 #include <linux/inetdevice.h>
5 #include <linux/etherdevice.h>
6 #include <linux/rtnetlink.h>
7 #include <linux/net_tstamp.h>
8 #include <linux/phylib_stubs.h>
9 #include <linux/wireless.h>
10 #include <linux/if_bridge.h>
11 #include <net/dsa_stubs.h>
17 * Map an interface index to its name (SIOCGIFNAME)
21 * We need this ioctl for efficient implementation of the
22 * if_indextoname() function required by the IPv6 API. Without
23 * it, we would have to search all the interfaces to find a
27 static int dev_ifname(struct net *net, struct ifreq *ifr)
29 ifr->ifr_name[IFNAMSIZ-1] = 0;
30 return netdev_get_name(net, ifr->ifr_name, ifr->ifr_ifindex);
34 * Perform a SIOCGIFCONF call. This structure will change
35 * size eventually, and there is nothing I can do about it.
36 * Thus we will need a 'compatibility mode'.
38 int dev_ifconf(struct net *net, struct ifconf __user *uifc)
40 struct net_device *dev;
43 int len, total = 0, done;
45 /* both the ifconf and the ifreq structures are slightly different */
46 if (in_compat_syscall()) {
47 struct compat_ifconf ifc32;
49 if (copy_from_user(&ifc32, uifc, sizeof(struct compat_ifconf)))
52 pos = compat_ptr(ifc32.ifcbuf);
54 size = sizeof(struct compat_ifreq);
58 if (copy_from_user(&ifc, uifc, sizeof(struct ifconf)))
63 size = sizeof(struct ifreq);
66 /* Loop over the interfaces, and write an info block for each. */
68 for_each_netdev(net, dev) {
70 done = inet_gifconf(dev, NULL, 0, size);
72 done = inet_gifconf(dev, pos + total,
82 return put_user(total, &uifc->ifc_len);
85 static int dev_getifmap(struct net_device *dev, struct ifreq *ifr)
87 struct ifmap *ifmap = &ifr->ifr_map;
89 if (in_compat_syscall()) {
90 struct compat_ifmap *cifmap = (struct compat_ifmap *)ifmap;
92 cifmap->mem_start = dev->mem_start;
93 cifmap->mem_end = dev->mem_end;
94 cifmap->base_addr = dev->base_addr;
95 cifmap->irq = dev->irq;
96 cifmap->dma = dev->dma;
97 cifmap->port = dev->if_port;
102 ifmap->mem_start = dev->mem_start;
103 ifmap->mem_end = dev->mem_end;
104 ifmap->base_addr = dev->base_addr;
105 ifmap->irq = dev->irq;
106 ifmap->dma = dev->dma;
107 ifmap->port = dev->if_port;
112 static int dev_setifmap(struct net_device *dev, struct ifreq *ifr)
114 struct compat_ifmap *cifmap = (struct compat_ifmap *)&ifr->ifr_map;
116 if (!dev->netdev_ops->ndo_set_config)
119 if (in_compat_syscall()) {
120 struct ifmap ifmap = {
121 .mem_start = cifmap->mem_start,
122 .mem_end = cifmap->mem_end,
123 .base_addr = cifmap->base_addr,
126 .port = cifmap->port,
129 return dev->netdev_ops->ndo_set_config(dev, &ifmap);
132 return dev->netdev_ops->ndo_set_config(dev, &ifr->ifr_map);
136 * Perform the SIOCxIFxxx calls, inside rcu_read_lock()
138 static int dev_ifsioc_locked(struct net *net, struct ifreq *ifr, unsigned int cmd)
141 struct net_device *dev = dev_get_by_name_rcu(net, ifr->ifr_name);
147 case SIOCGIFFLAGS: /* Get interface flags */
148 ifr->ifr_flags = (short) dev_get_flags(dev);
151 case SIOCGIFMETRIC: /* Get the metric on the interface
152 (currently unused) */
156 case SIOCGIFMTU: /* Get the MTU of a device */
157 ifr->ifr_mtu = dev->mtu;
165 return dev_getifmap(dev, ifr);
168 ifr->ifr_ifindex = dev->ifindex;
172 ifr->ifr_qlen = dev->tx_queue_len;
176 /* dev_ioctl() should ensure this case
187 static int net_hwtstamp_validate(const struct kernel_hwtstamp_config *cfg)
189 enum hwtstamp_tx_types tx_type;
190 enum hwtstamp_rx_filters rx_filter;
191 int tx_type_valid = 0;
192 int rx_filter_valid = 0;
194 if (cfg->flags & ~HWTSTAMP_FLAG_MASK)
197 tx_type = cfg->tx_type;
198 rx_filter = cfg->rx_filter;
201 case HWTSTAMP_TX_OFF:
203 case HWTSTAMP_TX_ONESTEP_SYNC:
204 case HWTSTAMP_TX_ONESTEP_P2P:
207 case __HWTSTAMP_TX_CNT:
208 /* not a real value */
213 case HWTSTAMP_FILTER_NONE:
214 case HWTSTAMP_FILTER_ALL:
215 case HWTSTAMP_FILTER_SOME:
216 case HWTSTAMP_FILTER_PTP_V1_L4_EVENT:
217 case HWTSTAMP_FILTER_PTP_V1_L4_SYNC:
218 case HWTSTAMP_FILTER_PTP_V1_L4_DELAY_REQ:
219 case HWTSTAMP_FILTER_PTP_V2_L4_EVENT:
220 case HWTSTAMP_FILTER_PTP_V2_L4_SYNC:
221 case HWTSTAMP_FILTER_PTP_V2_L4_DELAY_REQ:
222 case HWTSTAMP_FILTER_PTP_V2_L2_EVENT:
223 case HWTSTAMP_FILTER_PTP_V2_L2_SYNC:
224 case HWTSTAMP_FILTER_PTP_V2_L2_DELAY_REQ:
225 case HWTSTAMP_FILTER_PTP_V2_EVENT:
226 case HWTSTAMP_FILTER_PTP_V2_SYNC:
227 case HWTSTAMP_FILTER_PTP_V2_DELAY_REQ:
228 case HWTSTAMP_FILTER_NTP_ALL:
231 case __HWTSTAMP_FILTER_CNT:
232 /* not a real value */
236 if (!tx_type_valid || !rx_filter_valid)
242 static int dev_eth_ioctl(struct net_device *dev,
243 struct ifreq *ifr, unsigned int cmd)
245 const struct net_device_ops *ops = dev->netdev_ops;
247 if (!ops->ndo_eth_ioctl)
250 if (!netif_device_present(dev))
253 return ops->ndo_eth_ioctl(dev, ifr, cmd);
257 * dev_get_hwtstamp_phylib() - Get hardware timestamping settings of NIC
258 * or of attached phylib PHY
259 * @dev: Network device
260 * @cfg: Timestamping configuration structure
262 * Helper for enforcing a common policy that phylib timestamping, if available,
263 * should take precedence in front of hardware timestamping provided by the
266 * Note: phy_mii_ioctl() only handles SIOCSHWTSTAMP (not SIOCGHWTSTAMP), and
267 * there only exists a phydev->mii_ts->hwtstamp() method. So this will return
268 * -EOPNOTSUPP for phylib for now, which is still more accurate than letting
269 * the netdev handle the GET request.
271 static int dev_get_hwtstamp_phylib(struct net_device *dev,
272 struct kernel_hwtstamp_config *cfg)
274 if (phy_has_hwtstamp(dev->phydev))
275 return phy_hwtstamp_get(dev->phydev, cfg);
277 return dev->netdev_ops->ndo_hwtstamp_get(dev, cfg);
280 static int dev_get_hwtstamp(struct net_device *dev, struct ifreq *ifr)
282 const struct net_device_ops *ops = dev->netdev_ops;
283 struct kernel_hwtstamp_config kernel_cfg = {};
284 struct hwtstamp_config cfg;
287 if (!ops->ndo_hwtstamp_get)
288 return dev_eth_ioctl(dev, ifr, SIOCGHWTSTAMP); /* legacy */
290 if (!netif_device_present(dev))
293 kernel_cfg.ifr = ifr;
294 err = dev_get_hwtstamp_phylib(dev, &kernel_cfg);
298 /* If the request was resolved through an unconverted driver, omit
299 * the copy_to_user(), since the implementation has already done that
301 if (!kernel_cfg.copied_to_user) {
302 hwtstamp_config_from_kernel(&cfg, &kernel_cfg);
304 if (copy_to_user(ifr->ifr_data, &cfg, sizeof(cfg)))
312 * dev_set_hwtstamp_phylib() - Change hardware timestamping of NIC
313 * or of attached phylib PHY
314 * @dev: Network device
315 * @cfg: Timestamping configuration structure
316 * @extack: Netlink extended ack message structure, for error reporting
318 * Helper for enforcing a common policy that phylib timestamping, if available,
319 * should take precedence in front of hardware timestamping provided by the
320 * netdev. If the netdev driver needs to perform specific actions even for PHY
321 * timestamping to work properly (a switch port must trap the timestamped
322 * frames and not forward them), it must set IFF_SEE_ALL_HWTSTAMP_REQUESTS in
325 static int dev_set_hwtstamp_phylib(struct net_device *dev,
326 struct kernel_hwtstamp_config *cfg,
327 struct netlink_ext_ack *extack)
329 const struct net_device_ops *ops = dev->netdev_ops;
330 bool phy_ts = phy_has_hwtstamp(dev->phydev);
331 struct kernel_hwtstamp_config old_cfg = {};
332 bool changed = false;
335 cfg->source = phy_ts ? HWTSTAMP_SOURCE_PHYLIB : HWTSTAMP_SOURCE_NETDEV;
337 if (phy_ts && (dev->priv_flags & IFF_SEE_ALL_HWTSTAMP_REQUESTS)) {
338 err = ops->ndo_hwtstamp_get(dev, &old_cfg);
343 if (!phy_ts || (dev->priv_flags & IFF_SEE_ALL_HWTSTAMP_REQUESTS)) {
344 err = ops->ndo_hwtstamp_set(dev, cfg, extack);
347 netdev_err(dev, "%s\n", extack->_msg);
352 if (phy_ts && (dev->priv_flags & IFF_SEE_ALL_HWTSTAMP_REQUESTS))
353 changed = kernel_hwtstamp_config_changed(&old_cfg, cfg);
356 err = phy_hwtstamp_set(dev->phydev, cfg, extack);
359 ops->ndo_hwtstamp_set(dev, &old_cfg, NULL);
367 static int dev_set_hwtstamp(struct net_device *dev, struct ifreq *ifr)
369 const struct net_device_ops *ops = dev->netdev_ops;
370 struct kernel_hwtstamp_config kernel_cfg = {};
371 struct netlink_ext_ack extack = {};
372 struct hwtstamp_config cfg;
375 if (copy_from_user(&cfg, ifr->ifr_data, sizeof(cfg)))
378 hwtstamp_config_to_kernel(&kernel_cfg, &cfg);
379 kernel_cfg.ifr = ifr;
381 err = net_hwtstamp_validate(&kernel_cfg);
385 err = dsa_master_hwtstamp_validate(dev, &kernel_cfg, &extack);
388 netdev_err(dev, "%s\n", extack._msg);
392 if (!ops->ndo_hwtstamp_set)
393 return dev_eth_ioctl(dev, ifr, SIOCSHWTSTAMP); /* legacy */
395 if (!netif_device_present(dev))
398 err = dev_set_hwtstamp_phylib(dev, &kernel_cfg, &extack);
402 /* The driver may have modified the configuration, so copy the
403 * updated version of it back to user space
405 if (!kernel_cfg.copied_to_user) {
406 hwtstamp_config_from_kernel(&cfg, &kernel_cfg);
408 if (copy_to_user(ifr->ifr_data, &cfg, sizeof(cfg)))
415 static int generic_hwtstamp_ioctl_lower(struct net_device *dev, int cmd,
416 struct kernel_hwtstamp_config *kernel_cfg)
421 strscpy_pad(ifrr.ifr_name, dev->name, IFNAMSIZ);
422 ifrr.ifr_ifru = kernel_cfg->ifr->ifr_ifru;
424 err = dev_eth_ioctl(dev, &ifrr, cmd);
428 kernel_cfg->ifr->ifr_ifru = ifrr.ifr_ifru;
429 kernel_cfg->copied_to_user = true;
434 int generic_hwtstamp_get_lower(struct net_device *dev,
435 struct kernel_hwtstamp_config *kernel_cfg)
437 const struct net_device_ops *ops = dev->netdev_ops;
439 if (!netif_device_present(dev))
442 if (ops->ndo_hwtstamp_get)
443 return dev_get_hwtstamp_phylib(dev, kernel_cfg);
445 /* Legacy path: unconverted lower driver */
446 return generic_hwtstamp_ioctl_lower(dev, SIOCGHWTSTAMP, kernel_cfg);
448 EXPORT_SYMBOL(generic_hwtstamp_get_lower);
450 int generic_hwtstamp_set_lower(struct net_device *dev,
451 struct kernel_hwtstamp_config *kernel_cfg,
452 struct netlink_ext_ack *extack)
454 const struct net_device_ops *ops = dev->netdev_ops;
456 if (!netif_device_present(dev))
459 if (ops->ndo_hwtstamp_set)
460 return dev_set_hwtstamp_phylib(dev, kernel_cfg, extack);
462 /* Legacy path: unconverted lower driver */
463 return generic_hwtstamp_ioctl_lower(dev, SIOCSHWTSTAMP, kernel_cfg);
465 EXPORT_SYMBOL(generic_hwtstamp_set_lower);
467 static int dev_siocbond(struct net_device *dev,
468 struct ifreq *ifr, unsigned int cmd)
470 const struct net_device_ops *ops = dev->netdev_ops;
472 if (ops->ndo_siocbond) {
473 if (netif_device_present(dev))
474 return ops->ndo_siocbond(dev, ifr, cmd);
482 static int dev_siocdevprivate(struct net_device *dev, struct ifreq *ifr,
483 void __user *data, unsigned int cmd)
485 const struct net_device_ops *ops = dev->netdev_ops;
487 if (ops->ndo_siocdevprivate) {
488 if (netif_device_present(dev))
489 return ops->ndo_siocdevprivate(dev, ifr, data, cmd);
497 static int dev_siocwandev(struct net_device *dev, struct if_settings *ifs)
499 const struct net_device_ops *ops = dev->netdev_ops;
501 if (ops->ndo_siocwandev) {
502 if (netif_device_present(dev))
503 return ops->ndo_siocwandev(dev, ifs);
512 * Perform the SIOCxIFxxx calls, inside rtnl_lock()
514 static int dev_ifsioc(struct net *net, struct ifreq *ifr, void __user *data,
518 struct net_device *dev = __dev_get_by_name(net, ifr->ifr_name);
519 const struct net_device_ops *ops;
520 netdevice_tracker dev_tracker;
525 ops = dev->netdev_ops;
528 case SIOCSIFFLAGS: /* Set interface flags */
529 return dev_change_flags(dev, ifr->ifr_flags, NULL);
531 case SIOCSIFMETRIC: /* Set the metric on the interface
532 (currently unused) */
535 case SIOCSIFMTU: /* Set the MTU of a device */
536 return dev_set_mtu(dev, ifr->ifr_mtu);
539 if (dev->addr_len > sizeof(struct sockaddr))
541 return dev_set_mac_address_user(dev, &ifr->ifr_hwaddr, NULL);
543 case SIOCSIFHWBROADCAST:
544 if (ifr->ifr_hwaddr.sa_family != dev->type)
546 memcpy(dev->broadcast, ifr->ifr_hwaddr.sa_data,
547 min(sizeof(ifr->ifr_hwaddr.sa_data_min),
548 (size_t)dev->addr_len));
549 call_netdevice_notifiers(NETDEV_CHANGEADDR, dev);
553 return dev_setifmap(dev, ifr);
556 if (!ops->ndo_set_rx_mode ||
557 ifr->ifr_hwaddr.sa_family != AF_UNSPEC)
559 if (!netif_device_present(dev))
561 return dev_mc_add_global(dev, ifr->ifr_hwaddr.sa_data);
564 if (!ops->ndo_set_rx_mode ||
565 ifr->ifr_hwaddr.sa_family != AF_UNSPEC)
567 if (!netif_device_present(dev))
569 return dev_mc_del_global(dev, ifr->ifr_hwaddr.sa_data);
572 if (ifr->ifr_qlen < 0)
574 return dev_change_tx_queue_len(dev, ifr->ifr_qlen);
577 ifr->ifr_newname[IFNAMSIZ-1] = '\0';
578 return dev_change_name(dev, ifr->ifr_newname);
581 return dev_siocwandev(dev, &ifr->ifr_settings);
585 if (!netif_device_present(dev))
587 if (!netif_is_bridge_master(dev))
589 netdev_hold(dev, &dev_tracker, GFP_KERNEL);
591 err = br_ioctl_call(net, netdev_priv(dev), cmd, ifr, NULL);
592 netdev_put(dev, &dev_tracker);
596 case SIOCDEVPRIVATE ... SIOCDEVPRIVATE + 15:
597 return dev_siocdevprivate(dev, ifr, data, cmd);
600 return dev_set_hwtstamp(dev, ifr);
603 return dev_get_hwtstamp(dev, ifr);
608 return dev_eth_ioctl(dev, ifr, cmd);
610 case SIOCBONDENSLAVE:
611 case SIOCBONDRELEASE:
612 case SIOCBONDSETHWADDR:
613 case SIOCBONDSLAVEINFOQUERY:
614 case SIOCBONDINFOQUERY:
615 case SIOCBONDCHANGEACTIVE:
616 return dev_siocbond(dev, ifr, cmd);
626 * dev_load - load a network module
627 * @net: the applicable net namespace
628 * @name: name of interface
630 * If a network interface is not present and the process has suitable
631 * privileges this function loads the module. If module loading is not
632 * available in this kernel then it becomes a nop.
635 void dev_load(struct net *net, const char *name)
637 struct net_device *dev;
641 dev = dev_get_by_name_rcu(net, name);
645 if (no_module && capable(CAP_NET_ADMIN))
646 no_module = request_module("netdev-%s", name);
647 if (no_module && capable(CAP_SYS_MODULE))
648 request_module("%s", name);
650 EXPORT_SYMBOL(dev_load);
653 * This function handles all "interface"-type I/O control requests. The actual
654 * 'doing' part of this is dev_ifsioc above.
658 * dev_ioctl - network device ioctl
659 * @net: the applicable net namespace
660 * @cmd: command to issue
661 * @ifr: pointer to a struct ifreq in user space
662 * @data: data exchanged with userspace
663 * @need_copyout: whether or not copy_to_user() should be called
665 * Issue ioctl functions to devices. This is normally called by the
666 * user space syscall interfaces but can sometimes be useful for
667 * other purposes. The return value is the return from the syscall if
668 * positive or a negative errno code on error.
671 int dev_ioctl(struct net *net, unsigned int cmd, struct ifreq *ifr,
672 void __user *data, bool *need_copyout)
678 *need_copyout = true;
679 if (cmd == SIOCGIFNAME)
680 return dev_ifname(net, ifr);
682 ifr->ifr_name[IFNAMSIZ-1] = 0;
684 colon = strchr(ifr->ifr_name, ':');
689 * See which interface the caller is talking about.
694 dev_load(net, ifr->ifr_name);
695 ret = dev_get_mac_address(&ifr->ifr_hwaddr, net, ifr->ifr_name);
701 * - can be done by all.
702 * - atomic and do not require locking.
712 dev_load(net, ifr->ifr_name);
714 ret = dev_ifsioc_locked(net, ifr, cmd);
721 dev_load(net, ifr->ifr_name);
722 ret = dev_ethtool(net, ifr, data);
729 * - require superuser power.
730 * - require strict serialization.
736 dev_load(net, ifr->ifr_name);
737 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
740 ret = dev_ifsioc(net, ifr, data, cmd);
748 * - require superuser power.
749 * - require strict serialization.
750 * - do not return a value
754 if (!capable(CAP_NET_ADMIN))
759 * - require local superuser power.
760 * - require strict serialization.
761 * - do not return a value
770 case SIOCSIFHWBROADCAST:
772 case SIOCBONDENSLAVE:
773 case SIOCBONDRELEASE:
774 case SIOCBONDSETHWADDR:
775 case SIOCBONDCHANGEACTIVE:
779 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
782 case SIOCBONDSLAVEINFOQUERY:
783 case SIOCBONDINFOQUERY:
784 dev_load(net, ifr->ifr_name);
786 ret = dev_ifsioc(net, ifr, data, cmd);
789 *need_copyout = false;
793 /* Get the per device memory space. We can add this but
794 * currently do not support it */
796 /* Set the per device memory buffer space.
797 * Not applicable in our case */
802 * Unknown or private ioctl.
805 if (cmd == SIOCWANDEV ||
806 cmd == SIOCGHWTSTAMP ||
807 (cmd >= SIOCDEVPRIVATE &&
808 cmd <= SIOCDEVPRIVATE + 15)) {
809 dev_load(net, ifr->ifr_name);
811 ret = dev_ifsioc(net, ifr, data, cmd);