1 // SPDX-License-Identifier: GPL-2.0-only
3 * Common framework for low-level network console, dump, and debugger code
5 * Sep 8 2003 Matt Mackall <mpm@selenic.com>
7 * based on the netconsole code from:
9 * Copyright (C) 2001 Ingo Molnar <mingo@redhat.com>
10 * Copyright (C) 2002 Red Hat, Inc.
13 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
15 #include <linux/moduleparam.h>
16 #include <linux/kernel.h>
17 #include <linux/netdevice.h>
18 #include <linux/etherdevice.h>
19 #include <linux/string.h>
20 #include <linux/if_arp.h>
21 #include <linux/inetdevice.h>
22 #include <linux/inet.h>
23 #include <linux/interrupt.h>
24 #include <linux/netpoll.h>
25 #include <linux/sched.h>
26 #include <linux/delay.h>
27 #include <linux/rcupdate.h>
28 #include <linux/workqueue.h>
29 #include <linux/slab.h>
30 #include <linux/export.h>
31 #include <linux/if_vlan.h>
34 #include <net/addrconf.h>
35 #include <net/ndisc.h>
36 #include <net/ip6_checksum.h>
37 #include <asm/unaligned.h>
38 #include <trace/events/napi.h>
39 #include <linux/kconfig.h>
42 * We maintain a small pool of fully-sized skbs, to make sure the
43 * message gets out even in extreme OOM situations.
46 #define MAX_UDP_CHUNK 1460
49 static struct sk_buff_head skb_pool;
51 DEFINE_STATIC_SRCU(netpoll_srcu);
53 #define USEC_PER_POLL 50
55 #define MAX_SKB_SIZE \
56 (sizeof(struct ethhdr) + \
57 sizeof(struct iphdr) + \
58 sizeof(struct udphdr) + \
61 static void zap_completion_queue(void);
63 static unsigned int carrier_timeout = 4;
64 module_param(carrier_timeout, uint, 0644);
66 #define np_info(np, fmt, ...) \
67 pr_info("%s: " fmt, np->name, ##__VA_ARGS__)
68 #define np_err(np, fmt, ...) \
69 pr_err("%s: " fmt, np->name, ##__VA_ARGS__)
70 #define np_notice(np, fmt, ...) \
71 pr_notice("%s: " fmt, np->name, ##__VA_ARGS__)
73 static netdev_tx_t netpoll_start_xmit(struct sk_buff *skb,
74 struct net_device *dev,
75 struct netdev_queue *txq)
77 netdev_tx_t status = NETDEV_TX_OK;
78 netdev_features_t features;
80 features = netif_skb_features(skb);
82 if (skb_vlan_tag_present(skb) &&
83 !vlan_hw_offload_capable(features, skb->vlan_proto)) {
84 skb = __vlan_hwaccel_push_inside(skb);
86 /* This is actually a packet drop, but we
87 * don't want the code that calls this
88 * function to try and operate on a NULL skb.
94 status = netdev_start_xmit(skb, dev, txq, false);
100 static void queue_process(struct work_struct *work)
102 struct netpoll_info *npinfo =
103 container_of(work, struct netpoll_info, tx_work.work);
107 while ((skb = skb_dequeue(&npinfo->txq))) {
108 struct net_device *dev = skb->dev;
109 struct netdev_queue *txq;
110 unsigned int q_index;
112 if (!netif_device_present(dev) || !netif_running(dev)) {
117 local_irq_save(flags);
118 /* check if skb->queue_mapping is still valid */
119 q_index = skb_get_queue_mapping(skb);
120 if (unlikely(q_index >= dev->real_num_tx_queues)) {
121 q_index = q_index % dev->real_num_tx_queues;
122 skb_set_queue_mapping(skb, q_index);
124 txq = netdev_get_tx_queue(dev, q_index);
125 HARD_TX_LOCK(dev, txq, smp_processor_id());
126 if (netif_xmit_frozen_or_stopped(txq) ||
127 !dev_xmit_complete(netpoll_start_xmit(skb, dev, txq))) {
128 skb_queue_head(&npinfo->txq, skb);
129 HARD_TX_UNLOCK(dev, txq);
130 local_irq_restore(flags);
132 schedule_delayed_work(&npinfo->tx_work, HZ/10);
135 HARD_TX_UNLOCK(dev, txq);
136 local_irq_restore(flags);
140 static void poll_one_napi(struct napi_struct *napi)
144 /* If we set this bit but see that it has already been set,
145 * that indicates that napi has been disabled and we need
146 * to abort this operation
148 if (test_and_set_bit(NAPI_STATE_NPSVC, &napi->state))
151 /* We explicilty pass the polling call a budget of 0 to
152 * indicate that we are clearing the Tx path only.
154 work = napi->poll(napi, 0);
155 WARN_ONCE(work, "%pS exceeded budget in poll\n", napi->poll);
156 trace_napi_poll(napi, work, 0);
158 clear_bit(NAPI_STATE_NPSVC, &napi->state);
161 static void poll_napi(struct net_device *dev)
163 struct napi_struct *napi;
164 int cpu = smp_processor_id();
166 list_for_each_entry_rcu(napi, &dev->napi_list, dev_list) {
167 if (cmpxchg(&napi->poll_owner, -1, cpu) == -1) {
169 smp_store_release(&napi->poll_owner, -1);
174 void netpoll_poll_dev(struct net_device *dev)
176 struct netpoll_info *ni = rcu_dereference_bh(dev->npinfo);
177 const struct net_device_ops *ops;
179 /* Don't do any rx activity if the dev_lock mutex is held
180 * the dev_open/close paths use this to block netpoll activity
181 * while changing device state
183 if (!ni || down_trylock(&ni->dev_lock))
186 if (!netif_running(dev)) {
191 ops = dev->netdev_ops;
192 if (ops->ndo_poll_controller)
193 ops->ndo_poll_controller(dev);
199 zap_completion_queue();
201 EXPORT_SYMBOL(netpoll_poll_dev);
203 void netpoll_poll_disable(struct net_device *dev)
205 struct netpoll_info *ni;
208 idx = srcu_read_lock(&netpoll_srcu);
209 ni = srcu_dereference(dev->npinfo, &netpoll_srcu);
212 srcu_read_unlock(&netpoll_srcu, idx);
214 EXPORT_SYMBOL(netpoll_poll_disable);
216 void netpoll_poll_enable(struct net_device *dev)
218 struct netpoll_info *ni;
220 ni = rcu_dereference(dev->npinfo);
225 EXPORT_SYMBOL(netpoll_poll_enable);
227 static void refill_skbs(void)
232 spin_lock_irqsave(&skb_pool.lock, flags);
233 while (skb_pool.qlen < MAX_SKBS) {
234 skb = alloc_skb(MAX_SKB_SIZE, GFP_ATOMIC);
238 __skb_queue_tail(&skb_pool, skb);
240 spin_unlock_irqrestore(&skb_pool.lock, flags);
243 static void zap_completion_queue(void)
246 struct softnet_data *sd = &get_cpu_var(softnet_data);
248 if (sd->completion_queue) {
249 struct sk_buff *clist;
251 local_irq_save(flags);
252 clist = sd->completion_queue;
253 sd->completion_queue = NULL;
254 local_irq_restore(flags);
256 while (clist != NULL) {
257 struct sk_buff *skb = clist;
259 if (!skb_irq_freeable(skb)) {
260 refcount_set(&skb->users, 1);
261 dev_kfree_skb_any(skb); /* put this one back */
268 put_cpu_var(softnet_data);
271 static struct sk_buff *find_skb(struct netpoll *np, int len, int reserve)
276 zap_completion_queue();
280 skb = alloc_skb(len, GFP_ATOMIC);
282 skb = skb_dequeue(&skb_pool);
286 netpoll_poll_dev(np->dev);
292 refcount_set(&skb->users, 1);
293 skb_reserve(skb, reserve);
297 static int netpoll_owner_active(struct net_device *dev)
299 struct napi_struct *napi;
301 list_for_each_entry_rcu(napi, &dev->napi_list, dev_list) {
302 if (napi->poll_owner == smp_processor_id())
308 /* call with IRQ disabled */
309 static netdev_tx_t __netpoll_send_skb(struct netpoll *np, struct sk_buff *skb)
311 netdev_tx_t status = NETDEV_TX_BUSY;
312 struct net_device *dev;
314 /* It is up to the caller to keep npinfo alive. */
315 struct netpoll_info *npinfo;
317 lockdep_assert_irqs_disabled();
320 npinfo = rcu_dereference_bh(dev->npinfo);
322 if (!npinfo || !netif_running(dev) || !netif_device_present(dev)) {
323 dev_kfree_skb_irq(skb);
324 return NET_XMIT_DROP;
327 /* don't get messages out of order, and no recursion */
328 if (skb_queue_len(&npinfo->txq) == 0 && !netpoll_owner_active(dev)) {
329 struct netdev_queue *txq;
331 txq = netdev_core_pick_tx(dev, skb, NULL);
333 /* try until next clock tick */
334 for (tries = jiffies_to_usecs(1)/USEC_PER_POLL;
335 tries > 0; --tries) {
336 if (HARD_TX_TRYLOCK(dev, txq)) {
337 if (!netif_xmit_stopped(txq))
338 status = netpoll_start_xmit(skb, dev, txq);
340 HARD_TX_UNLOCK(dev, txq);
342 if (dev_xmit_complete(status))
347 /* tickle device maybe there is some cleanup */
348 netpoll_poll_dev(np->dev);
350 udelay(USEC_PER_POLL);
353 WARN_ONCE(!irqs_disabled(),
354 "netpoll_send_skb_on_dev(): %s enabled interrupts in poll (%pS)\n",
355 dev->name, dev->netdev_ops->ndo_start_xmit);
359 if (!dev_xmit_complete(status)) {
360 skb_queue_tail(&npinfo->txq, skb);
361 schedule_delayed_work(&npinfo->tx_work,0);
366 netdev_tx_t netpoll_send_skb(struct netpoll *np, struct sk_buff *skb)
372 dev_kfree_skb_irq(skb);
375 local_irq_save(flags);
376 ret = __netpoll_send_skb(np, skb);
377 local_irq_restore(flags);
381 EXPORT_SYMBOL(netpoll_send_skb);
383 void netpoll_send_udp(struct netpoll *np, const char *msg, int len)
385 int total_len, ip_len, udp_len;
390 static atomic_t ip_ident;
391 struct ipv6hdr *ip6h;
393 if (!IS_ENABLED(CONFIG_PREEMPT_RT))
394 WARN_ON_ONCE(!irqs_disabled());
396 udp_len = len + sizeof(*udph);
398 ip_len = udp_len + sizeof(*ip6h);
400 ip_len = udp_len + sizeof(*iph);
402 total_len = ip_len + LL_RESERVED_SPACE(np->dev);
404 skb = find_skb(np, total_len + np->dev->needed_tailroom,
409 skb_copy_to_linear_data(skb, msg, len);
412 skb_push(skb, sizeof(*udph));
413 skb_reset_transport_header(skb);
415 udph->source = htons(np->local_port);
416 udph->dest = htons(np->remote_port);
417 udph->len = htons(udp_len);
421 udph->check = csum_ipv6_magic(&np->local_ip.in6,
423 udp_len, IPPROTO_UDP,
424 csum_partial(udph, udp_len, 0));
425 if (udph->check == 0)
426 udph->check = CSUM_MANGLED_0;
428 skb_push(skb, sizeof(*ip6h));
429 skb_reset_network_header(skb);
430 ip6h = ipv6_hdr(skb);
432 /* ip6h->version = 6; ip6h->priority = 0; */
433 *(unsigned char *)ip6h = 0x60;
434 ip6h->flow_lbl[0] = 0;
435 ip6h->flow_lbl[1] = 0;
436 ip6h->flow_lbl[2] = 0;
438 ip6h->payload_len = htons(sizeof(struct udphdr) + len);
439 ip6h->nexthdr = IPPROTO_UDP;
440 ip6h->hop_limit = 32;
441 ip6h->saddr = np->local_ip.in6;
442 ip6h->daddr = np->remote_ip.in6;
444 eth = skb_push(skb, ETH_HLEN);
445 skb_reset_mac_header(skb);
446 skb->protocol = eth->h_proto = htons(ETH_P_IPV6);
449 udph->check = csum_tcpudp_magic(np->local_ip.ip,
451 udp_len, IPPROTO_UDP,
452 csum_partial(udph, udp_len, 0));
453 if (udph->check == 0)
454 udph->check = CSUM_MANGLED_0;
456 skb_push(skb, sizeof(*iph));
457 skb_reset_network_header(skb);
460 /* iph->version = 4; iph->ihl = 5; */
461 *(unsigned char *)iph = 0x45;
463 put_unaligned(htons(ip_len), &(iph->tot_len));
464 iph->id = htons(atomic_inc_return(&ip_ident));
467 iph->protocol = IPPROTO_UDP;
469 put_unaligned(np->local_ip.ip, &(iph->saddr));
470 put_unaligned(np->remote_ip.ip, &(iph->daddr));
471 iph->check = ip_fast_csum((unsigned char *)iph, iph->ihl);
473 eth = skb_push(skb, ETH_HLEN);
474 skb_reset_mac_header(skb);
475 skb->protocol = eth->h_proto = htons(ETH_P_IP);
478 ether_addr_copy(eth->h_source, np->dev->dev_addr);
479 ether_addr_copy(eth->h_dest, np->remote_mac);
483 netpoll_send_skb(np, skb);
485 EXPORT_SYMBOL(netpoll_send_udp);
487 void netpoll_print_options(struct netpoll *np)
489 np_info(np, "local port %d\n", np->local_port);
491 np_info(np, "local IPv6 address %pI6c\n", &np->local_ip.in6);
493 np_info(np, "local IPv4 address %pI4\n", &np->local_ip.ip);
494 np_info(np, "interface '%s'\n", np->dev_name);
495 np_info(np, "remote port %d\n", np->remote_port);
497 np_info(np, "remote IPv6 address %pI6c\n", &np->remote_ip.in6);
499 np_info(np, "remote IPv4 address %pI4\n", &np->remote_ip.ip);
500 np_info(np, "remote ethernet address %pM\n", np->remote_mac);
502 EXPORT_SYMBOL(netpoll_print_options);
504 static int netpoll_parse_ip_addr(const char *str, union inet_addr *addr)
508 if (!strchr(str, ':') &&
509 in4_pton(str, -1, (void *)addr, -1, &end) > 0) {
513 if (in6_pton(str, -1, addr->in6.s6_addr, -1, &end) > 0) {
514 #if IS_ENABLED(CONFIG_IPV6)
524 int netpoll_parse_options(struct netpoll *np, char *opt)
526 char *cur=opt, *delim;
528 bool ipversion_set = false;
531 if ((delim = strchr(cur, '@')) == NULL)
534 if (kstrtou16(cur, 10, &np->local_port))
541 ipversion_set = true;
542 if ((delim = strchr(cur, '/')) == NULL)
545 ipv6 = netpoll_parse_ip_addr(cur, &np->local_ip);
549 np->ipv6 = (bool)ipv6;
555 /* parse out dev name */
556 if ((delim = strchr(cur, ',')) == NULL)
559 strscpy(np->dev_name, cur, sizeof(np->dev_name));
566 if ((delim = strchr(cur, '@')) == NULL)
569 if (*cur == ' ' || *cur == '\t')
570 np_info(np, "warning: whitespace is not allowed\n");
571 if (kstrtou16(cur, 10, &np->remote_port))
578 if ((delim = strchr(cur, '/')) == NULL)
581 ipv6 = netpoll_parse_ip_addr(cur, &np->remote_ip);
584 else if (ipversion_set && np->ipv6 != (bool)ipv6)
587 np->ipv6 = (bool)ipv6;
592 if (!mac_pton(cur, np->remote_mac))
596 netpoll_print_options(np);
601 np_info(np, "couldn't parse config at '%s'!\n", cur);
604 EXPORT_SYMBOL(netpoll_parse_options);
606 int __netpoll_setup(struct netpoll *np, struct net_device *ndev)
608 struct netpoll_info *npinfo;
609 const struct net_device_ops *ops;
613 strscpy(np->dev_name, ndev->name, IFNAMSIZ);
615 if (ndev->priv_flags & IFF_DISABLE_NETPOLL) {
616 np_err(np, "%s doesn't support polling, aborting\n",
623 npinfo = kmalloc(sizeof(*npinfo), GFP_KERNEL);
629 sema_init(&npinfo->dev_lock, 1);
630 skb_queue_head_init(&npinfo->txq);
631 INIT_DELAYED_WORK(&npinfo->tx_work, queue_process);
633 refcount_set(&npinfo->refcnt, 1);
635 ops = np->dev->netdev_ops;
636 if (ops->ndo_netpoll_setup) {
637 err = ops->ndo_netpoll_setup(ndev, npinfo);
642 npinfo = rtnl_dereference(ndev->npinfo);
643 refcount_inc(&npinfo->refcnt);
646 npinfo->netpoll = np;
648 /* last thing to do is link it to the net device structure */
649 rcu_assign_pointer(ndev->npinfo, npinfo);
658 EXPORT_SYMBOL_GPL(__netpoll_setup);
660 int netpoll_setup(struct netpoll *np)
662 struct net_device *ndev = NULL;
663 struct in_device *in_dev;
667 if (np->dev_name[0]) {
668 struct net *net = current->nsproxy->net_ns;
669 ndev = __dev_get_by_name(net, np->dev_name);
672 np_err(np, "%s doesn't exist, aborting\n", np->dev_name);
678 if (netdev_master_upper_dev_get(ndev)) {
679 np_err(np, "%s is a slave device, aborting\n", np->dev_name);
684 if (!netif_running(ndev)) {
685 unsigned long atmost, atleast;
687 np_info(np, "device %s not up yet, forcing it\n", np->dev_name);
689 err = dev_open(ndev, NULL);
692 np_err(np, "failed to open %s\n", ndev->name);
697 atleast = jiffies + HZ/10;
698 atmost = jiffies + carrier_timeout * HZ;
699 while (!netif_carrier_ok(ndev)) {
700 if (time_after(jiffies, atmost)) {
701 np_notice(np, "timeout waiting for carrier\n");
707 /* If carrier appears to come up instantly, we don't
708 * trust it and pause so that we don't pump all our
709 * queued console messages into the bitbucket.
712 if (time_before(jiffies, atleast)) {
713 np_notice(np, "carrier detect appears untrustworthy, waiting 4 seconds\n");
719 if (!np->local_ip.ip) {
721 const struct in_ifaddr *ifa;
723 in_dev = __in_dev_get_rtnl(ndev);
727 ifa = rtnl_dereference(in_dev->ifa_list);
730 np_err(np, "no IP address for %s, aborting\n",
736 np->local_ip.ip = ifa->ifa_local;
737 np_info(np, "local IP %pI4\n", &np->local_ip.ip);
739 #if IS_ENABLED(CONFIG_IPV6)
740 struct inet6_dev *idev;
743 idev = __in6_dev_get(ndev);
745 struct inet6_ifaddr *ifp;
747 read_lock_bh(&idev->lock);
748 list_for_each_entry(ifp, &idev->addr_list, if_list) {
749 if (!!(ipv6_addr_type(&ifp->addr) & IPV6_ADDR_LINKLOCAL) !=
750 !!(ipv6_addr_type(&np->remote_ip.in6) & IPV6_ADDR_LINKLOCAL))
752 np->local_ip.in6 = ifp->addr;
756 read_unlock_bh(&idev->lock);
759 np_err(np, "no IPv6 address for %s, aborting\n",
763 np_info(np, "local IPv6 %pI6c\n", &np->local_ip.in6);
765 np_err(np, "IPv6 is not supported %s, aborting\n",
773 /* fill up the skb queue */
776 err = __netpoll_setup(np, ndev);
779 netdev_tracker_alloc(ndev, &np->dev_tracker, GFP_KERNEL);
789 EXPORT_SYMBOL(netpoll_setup);
791 static int __init netpoll_init(void)
793 skb_queue_head_init(&skb_pool);
796 core_initcall(netpoll_init);
798 static void rcu_cleanup_netpoll_info(struct rcu_head *rcu_head)
800 struct netpoll_info *npinfo =
801 container_of(rcu_head, struct netpoll_info, rcu);
803 skb_queue_purge(&npinfo->txq);
805 /* we can't call cancel_delayed_work_sync here, as we are in softirq */
806 cancel_delayed_work(&npinfo->tx_work);
808 /* clean after last, unfinished work */
809 __skb_queue_purge(&npinfo->txq);
810 /* now cancel it again */
811 cancel_delayed_work(&npinfo->tx_work);
815 void __netpoll_cleanup(struct netpoll *np)
817 struct netpoll_info *npinfo;
819 npinfo = rtnl_dereference(np->dev->npinfo);
823 synchronize_srcu(&netpoll_srcu);
825 if (refcount_dec_and_test(&npinfo->refcnt)) {
826 const struct net_device_ops *ops;
828 ops = np->dev->netdev_ops;
829 if (ops->ndo_netpoll_cleanup)
830 ops->ndo_netpoll_cleanup(np->dev);
832 RCU_INIT_POINTER(np->dev->npinfo, NULL);
833 call_rcu(&npinfo->rcu, rcu_cleanup_netpoll_info);
835 RCU_INIT_POINTER(np->dev->npinfo, NULL);
837 EXPORT_SYMBOL_GPL(__netpoll_cleanup);
839 void __netpoll_free(struct netpoll *np)
843 /* Wait for transmitting packets to finish before freeing. */
845 __netpoll_cleanup(np);
848 EXPORT_SYMBOL_GPL(__netpoll_free);
850 void netpoll_cleanup(struct netpoll *np)
855 __netpoll_cleanup(np);
856 netdev_put(np->dev, &np->dev_tracker);
861 EXPORT_SYMBOL(netpoll_cleanup);