2 * Common framework for low-level network console, dump, and debugger code
4 * Sep 8 2003 Matt Mackall <mpm@selenic.com>
6 * based on the netconsole code from:
8 * Copyright (C) 2001 Ingo Molnar <mingo@redhat.com>
9 * Copyright (C) 2002 Red Hat, Inc.
12 #include <linux/moduleparam.h>
13 #include <linux/netdevice.h>
14 #include <linux/etherdevice.h>
15 #include <linux/string.h>
16 #include <linux/if_arp.h>
17 #include <linux/inetdevice.h>
18 #include <linux/inet.h>
19 #include <linux/interrupt.h>
20 #include <linux/netpoll.h>
21 #include <linux/sched.h>
22 #include <linux/delay.h>
23 #include <linux/rcupdate.h>
24 #include <linux/workqueue.h>
25 #include <linux/slab.h>
28 #include <asm/unaligned.h>
29 #include <trace/events/napi.h>
32 * We maintain a small pool of fully-sized skbs, to make sure the
33 * message gets out even in extreme OOM situations.
36 #define MAX_UDP_CHUNK 1460
39 static struct sk_buff_head skb_pool;
41 static atomic_t trapped;
43 #define USEC_PER_POLL 50
44 #define NETPOLL_RX_ENABLED 1
45 #define NETPOLL_RX_DROP 2
47 #define MAX_SKB_SIZE \
48 (MAX_UDP_CHUNK + sizeof(struct udphdr) + \
49 sizeof(struct iphdr) + sizeof(struct ethhdr))
51 static void zap_completion_queue(void);
52 static void arp_reply(struct sk_buff *skb);
54 static unsigned int carrier_timeout = 4;
55 module_param(carrier_timeout, uint, 0644);
57 static void queue_process(struct work_struct *work)
59 struct netpoll_info *npinfo =
60 container_of(work, struct netpoll_info, tx_work.work);
64 while ((skb = skb_dequeue(&npinfo->txq))) {
65 struct net_device *dev = skb->dev;
66 const struct net_device_ops *ops = dev->netdev_ops;
67 struct netdev_queue *txq;
69 if (!netif_device_present(dev) || !netif_running(dev)) {
74 txq = netdev_get_tx_queue(dev, skb_get_queue_mapping(skb));
76 local_irq_save(flags);
77 __netif_tx_lock(txq, smp_processor_id());
78 if (netif_tx_queue_frozen_or_stopped(txq) ||
79 ops->ndo_start_xmit(skb, dev) != NETDEV_TX_OK) {
80 skb_queue_head(&npinfo->txq, skb);
81 __netif_tx_unlock(txq);
82 local_irq_restore(flags);
84 schedule_delayed_work(&npinfo->tx_work, HZ/10);
87 __netif_tx_unlock(txq);
88 local_irq_restore(flags);
92 static __sum16 checksum_udp(struct sk_buff *skb, struct udphdr *uh,
93 unsigned short ulen, __be32 saddr, __be32 daddr)
97 if (uh->check == 0 || skb_csum_unnecessary(skb))
100 psum = csum_tcpudp_nofold(saddr, daddr, ulen, IPPROTO_UDP, 0);
102 if (skb->ip_summed == CHECKSUM_COMPLETE &&
103 !csum_fold(csum_add(psum, skb->csum)))
108 return __skb_checksum_complete(skb);
112 * Check whether delayed processing was scheduled for our NIC. If so,
113 * we attempt to grab the poll lock and use ->poll() to pump the card.
114 * If this fails, either we've recursed in ->poll() or it's already
115 * running on another CPU.
117 * Note: we don't mask interrupts with this lock because we're using
118 * trylock here and interrupts are already disabled in the softirq
119 * case. Further, we test the poll_owner to avoid recursion on UP
120 * systems where the lock doesn't exist.
122 * In cases where there is bi-directional communications, reading only
123 * one message at a time can lead to packets being dropped by the
124 * network adapter, forcing superfluous retries and possibly timeouts.
125 * Thus, we set our budget to greater than 1.
127 static int poll_one_napi(struct netpoll_info *npinfo,
128 struct napi_struct *napi, int budget)
132 /* net_rx_action's ->poll() invocations and our's are
133 * synchronized by this test which is only made while
134 * holding the napi->poll_lock.
136 if (!test_bit(NAPI_STATE_SCHED, &napi->state))
139 npinfo->rx_flags |= NETPOLL_RX_DROP;
140 atomic_inc(&trapped);
141 set_bit(NAPI_STATE_NPSVC, &napi->state);
143 work = napi->poll(napi, budget);
144 trace_napi_poll(napi);
146 clear_bit(NAPI_STATE_NPSVC, &napi->state);
147 atomic_dec(&trapped);
148 npinfo->rx_flags &= ~NETPOLL_RX_DROP;
150 return budget - work;
153 static void poll_napi(struct net_device *dev)
155 struct napi_struct *napi;
158 list_for_each_entry(napi, &dev->napi_list, dev_list) {
159 if (napi->poll_owner != smp_processor_id() &&
160 spin_trylock(&napi->poll_lock)) {
161 budget = poll_one_napi(dev->npinfo, napi, budget);
162 spin_unlock(&napi->poll_lock);
170 static void service_arp_queue(struct netpoll_info *npi)
175 while ((skb = skb_dequeue(&npi->arp_tx)))
180 static void netpoll_poll_dev(struct net_device *dev)
182 const struct net_device_ops *ops;
184 if (!dev || !netif_running(dev))
187 ops = dev->netdev_ops;
188 if (!ops->ndo_poll_controller)
191 /* Process pending work on NIC */
192 ops->ndo_poll_controller(dev);
196 if (dev->priv_flags & IFF_SLAVE) {
198 struct net_device *bond_dev = dev->master;
200 while ((skb = skb_dequeue(&dev->npinfo->arp_tx))) {
202 skb_queue_tail(&bond_dev->npinfo->arp_tx, skb);
207 service_arp_queue(dev->npinfo);
209 zap_completion_queue();
212 static void netpoll_poll(struct netpoll *np)
214 netpoll_poll_dev(np->dev);
217 static void refill_skbs(void)
222 spin_lock_irqsave(&skb_pool.lock, flags);
223 while (skb_pool.qlen < MAX_SKBS) {
224 skb = alloc_skb(MAX_SKB_SIZE, GFP_ATOMIC);
228 __skb_queue_tail(&skb_pool, skb);
230 spin_unlock_irqrestore(&skb_pool.lock, flags);
233 static void zap_completion_queue(void)
236 struct softnet_data *sd = &get_cpu_var(softnet_data);
238 if (sd->completion_queue) {
239 struct sk_buff *clist;
241 local_irq_save(flags);
242 clist = sd->completion_queue;
243 sd->completion_queue = NULL;
244 local_irq_restore(flags);
246 while (clist != NULL) {
247 struct sk_buff *skb = clist;
249 if (skb->destructor) {
250 atomic_inc(&skb->users);
251 dev_kfree_skb_any(skb); /* put this one back */
258 put_cpu_var(softnet_data);
261 static struct sk_buff *find_skb(struct netpoll *np, int len, int reserve)
266 zap_completion_queue();
270 skb = alloc_skb(len, GFP_ATOMIC);
272 skb = skb_dequeue(&skb_pool);
282 atomic_set(&skb->users, 1);
283 skb_reserve(skb, reserve);
287 static int netpoll_owner_active(struct net_device *dev)
289 struct napi_struct *napi;
291 list_for_each_entry(napi, &dev->napi_list, dev_list) {
292 if (napi->poll_owner == smp_processor_id())
298 void netpoll_send_skb_on_dev(struct netpoll *np, struct sk_buff *skb,
299 struct net_device *dev)
301 int status = NETDEV_TX_BUSY;
303 const struct net_device_ops *ops = dev->netdev_ops;
304 /* It is up to the caller to keep npinfo alive. */
305 struct netpoll_info *npinfo = np->dev->npinfo;
307 if (!npinfo || !netif_running(dev) || !netif_device_present(dev)) {
312 /* don't get messages out of order, and no recursion */
313 if (skb_queue_len(&npinfo->txq) == 0 && !netpoll_owner_active(dev)) {
314 struct netdev_queue *txq;
317 txq = netdev_get_tx_queue(dev, skb_get_queue_mapping(skb));
319 local_irq_save(flags);
320 /* try until next clock tick */
321 for (tries = jiffies_to_usecs(1)/USEC_PER_POLL;
322 tries > 0; --tries) {
323 if (__netif_tx_trylock(txq)) {
324 if (!netif_tx_queue_stopped(txq)) {
325 status = ops->ndo_start_xmit(skb, dev);
326 if (status == NETDEV_TX_OK)
327 txq_trans_update(txq);
329 __netif_tx_unlock(txq);
331 if (status == NETDEV_TX_OK)
336 /* tickle device maybe there is some cleanup */
339 udelay(USEC_PER_POLL);
342 WARN_ONCE(!irqs_disabled(),
343 "netpoll_send_skb(): %s enabled interrupts in poll (%pF)\n",
344 dev->name, ops->ndo_start_xmit);
346 local_irq_restore(flags);
349 if (status != NETDEV_TX_OK) {
350 skb_queue_tail(&npinfo->txq, skb);
351 schedule_delayed_work(&npinfo->tx_work,0);
354 EXPORT_SYMBOL(netpoll_send_skb_on_dev);
356 void netpoll_send_udp(struct netpoll *np, const char *msg, int len)
358 int total_len, eth_len, ip_len, udp_len;
364 udp_len = len + sizeof(*udph);
365 ip_len = eth_len = udp_len + sizeof(*iph);
366 total_len = eth_len + ETH_HLEN + NET_IP_ALIGN;
368 skb = find_skb(np, total_len, total_len - len);
372 skb_copy_to_linear_data(skb, msg, len);
375 skb_push(skb, sizeof(*udph));
376 skb_reset_transport_header(skb);
378 udph->source = htons(np->local_port);
379 udph->dest = htons(np->remote_port);
380 udph->len = htons(udp_len);
382 udph->check = csum_tcpudp_magic(np->local_ip,
384 udp_len, IPPROTO_UDP,
385 csum_partial(udph, udp_len, 0));
386 if (udph->check == 0)
387 udph->check = CSUM_MANGLED_0;
389 skb_push(skb, sizeof(*iph));
390 skb_reset_network_header(skb);
393 /* iph->version = 4; iph->ihl = 5; */
394 put_unaligned(0x45, (unsigned char *)iph);
396 put_unaligned(htons(ip_len), &(iph->tot_len));
400 iph->protocol = IPPROTO_UDP;
402 put_unaligned(np->local_ip, &(iph->saddr));
403 put_unaligned(np->remote_ip, &(iph->daddr));
404 iph->check = ip_fast_csum((unsigned char *)iph, iph->ihl);
406 eth = (struct ethhdr *) skb_push(skb, ETH_HLEN);
407 skb_reset_mac_header(skb);
408 skb->protocol = eth->h_proto = htons(ETH_P_IP);
409 memcpy(eth->h_source, np->dev->dev_addr, ETH_ALEN);
410 memcpy(eth->h_dest, np->remote_mac, ETH_ALEN);
414 netpoll_send_skb(np, skb);
416 EXPORT_SYMBOL(netpoll_send_udp);
418 static void arp_reply(struct sk_buff *skb)
420 struct netpoll_info *npinfo = skb->dev->npinfo;
422 unsigned char *arp_ptr;
423 int size, type = ARPOP_REPLY, ptype = ETH_P_ARP;
426 struct sk_buff *send_skb;
427 struct netpoll *np, *tmp;
431 if (list_empty(&npinfo->rx_np))
434 /* Before checking the packet, we do some early
435 inspection whether this is interesting at all */
436 spin_lock_irqsave(&npinfo->rx_lock, flags);
437 list_for_each_entry_safe(np, tmp, &npinfo->rx_np, rx) {
438 if (np->dev == skb->dev)
441 spin_unlock_irqrestore(&npinfo->rx_lock, flags);
443 /* No netpoll struct is using this dev */
447 /* No arp on this interface */
448 if (skb->dev->flags & IFF_NOARP)
451 if (!pskb_may_pull(skb, arp_hdr_len(skb->dev)))
454 skb_reset_network_header(skb);
455 skb_reset_transport_header(skb);
458 if ((arp->ar_hrd != htons(ARPHRD_ETHER) &&
459 arp->ar_hrd != htons(ARPHRD_IEEE802)) ||
460 arp->ar_pro != htons(ETH_P_IP) ||
461 arp->ar_op != htons(ARPOP_REQUEST))
464 arp_ptr = (unsigned char *)(arp+1);
465 /* save the location of the src hw addr */
467 arp_ptr += skb->dev->addr_len;
468 memcpy(&sip, arp_ptr, 4);
470 /* If we actually cared about dst hw addr,
471 it would get copied here */
472 arp_ptr += skb->dev->addr_len;
473 memcpy(&tip, arp_ptr, 4);
475 /* Should we ignore arp? */
476 if (ipv4_is_loopback(tip) || ipv4_is_multicast(tip))
479 size = arp_hdr_len(skb->dev);
481 spin_lock_irqsave(&npinfo->rx_lock, flags);
482 list_for_each_entry_safe(np, tmp, &npinfo->rx_np, rx) {
483 if (tip != np->local_ip)
486 send_skb = find_skb(np, size + LL_ALLOCATED_SPACE(np->dev),
487 LL_RESERVED_SPACE(np->dev));
491 skb_reset_network_header(send_skb);
492 arp = (struct arphdr *) skb_put(send_skb, size);
493 send_skb->dev = skb->dev;
494 send_skb->protocol = htons(ETH_P_ARP);
496 /* Fill the device header for the ARP frame */
497 if (dev_hard_header(send_skb, skb->dev, ptype,
498 sha, np->dev->dev_addr,
499 send_skb->len) < 0) {
505 * Fill out the arp protocol part.
507 * we only support ethernet device type,
508 * which (according to RFC 1390) should
509 * always equal 1 (Ethernet).
512 arp->ar_hrd = htons(np->dev->type);
513 arp->ar_pro = htons(ETH_P_IP);
514 arp->ar_hln = np->dev->addr_len;
516 arp->ar_op = htons(type);
518 arp_ptr = (unsigned char *)(arp + 1);
519 memcpy(arp_ptr, np->dev->dev_addr, np->dev->addr_len);
520 arp_ptr += np->dev->addr_len;
521 memcpy(arp_ptr, &tip, 4);
523 memcpy(arp_ptr, sha, np->dev->addr_len);
524 arp_ptr += np->dev->addr_len;
525 memcpy(arp_ptr, &sip, 4);
527 netpoll_send_skb(np, send_skb);
529 /* If there are several rx_hooks for the same address,
530 we're fine by sending a single reply */
533 spin_unlock_irqrestore(&npinfo->rx_lock, flags);
536 int __netpoll_rx(struct sk_buff *skb)
538 int proto, len, ulen;
540 const struct iphdr *iph;
542 struct netpoll_info *npinfo = skb->dev->npinfo;
543 struct netpoll *np, *tmp;
545 if (list_empty(&npinfo->rx_np))
548 if (skb->dev->type != ARPHRD_ETHER)
551 /* check if netpoll clients need ARP */
552 if (skb->protocol == htons(ETH_P_ARP) &&
553 atomic_read(&trapped)) {
554 skb_queue_tail(&npinfo->arp_tx, skb);
558 proto = ntohs(eth_hdr(skb)->h_proto);
559 if (proto != ETH_P_IP)
561 if (skb->pkt_type == PACKET_OTHERHOST)
566 iph = (struct iphdr *)skb->data;
567 if (!pskb_may_pull(skb, sizeof(struct iphdr)))
569 if (iph->ihl < 5 || iph->version != 4)
571 if (!pskb_may_pull(skb, iph->ihl*4))
573 if (ip_fast_csum((u8 *)iph, iph->ihl) != 0)
576 len = ntohs(iph->tot_len);
577 if (skb->len < len || len < iph->ihl*4)
581 * Our transport medium may have padded the buffer out.
582 * Now We trim to the true length of the frame.
584 if (pskb_trim_rcsum(skb, len))
587 if (iph->protocol != IPPROTO_UDP)
591 uh = (struct udphdr *)(((char *)iph) + iph->ihl*4);
592 ulen = ntohs(uh->len);
596 if (checksum_udp(skb, uh, ulen, iph->saddr, iph->daddr))
599 list_for_each_entry_safe(np, tmp, &npinfo->rx_np, rx) {
600 if (np->local_ip && np->local_ip != iph->daddr)
602 if (np->remote_ip && np->remote_ip != iph->saddr)
604 if (np->local_port && np->local_port != ntohs(uh->dest))
607 np->rx_hook(np, ntohs(uh->source),
609 ulen - sizeof(struct udphdr));
620 if (atomic_read(&trapped)) {
628 void netpoll_print_options(struct netpoll *np)
630 printk(KERN_INFO "%s: local port %d\n",
631 np->name, np->local_port);
632 printk(KERN_INFO "%s: local IP %pI4\n",
633 np->name, &np->local_ip);
634 printk(KERN_INFO "%s: interface '%s'\n",
635 np->name, np->dev_name);
636 printk(KERN_INFO "%s: remote port %d\n",
637 np->name, np->remote_port);
638 printk(KERN_INFO "%s: remote IP %pI4\n",
639 np->name, &np->remote_ip);
640 printk(KERN_INFO "%s: remote ethernet address %pM\n",
641 np->name, np->remote_mac);
643 EXPORT_SYMBOL(netpoll_print_options);
645 int netpoll_parse_options(struct netpoll *np, char *opt)
647 char *cur=opt, *delim;
650 if ((delim = strchr(cur, '@')) == NULL)
653 np->local_port = simple_strtol(cur, NULL, 10);
659 if ((delim = strchr(cur, '/')) == NULL)
662 np->local_ip = in_aton(cur);
668 /* parse out dev name */
669 if ((delim = strchr(cur, ',')) == NULL)
672 strlcpy(np->dev_name, cur, sizeof(np->dev_name));
679 if ((delim = strchr(cur, '@')) == NULL)
682 if (*cur == ' ' || *cur == '\t')
683 printk(KERN_INFO "%s: warning: whitespace"
684 "is not allowed\n", np->name);
685 np->remote_port = simple_strtol(cur, NULL, 10);
691 if ((delim = strchr(cur, '/')) == NULL)
694 np->remote_ip = in_aton(cur);
699 if (!mac_pton(cur, np->remote_mac))
703 netpoll_print_options(np);
708 printk(KERN_INFO "%s: couldn't parse config at '%s'!\n",
712 EXPORT_SYMBOL(netpoll_parse_options);
714 int __netpoll_setup(struct netpoll *np)
716 struct net_device *ndev = np->dev;
717 struct netpoll_info *npinfo;
718 const struct net_device_ops *ops;
722 if ((ndev->priv_flags & IFF_DISABLE_NETPOLL) ||
723 !ndev->netdev_ops->ndo_poll_controller) {
724 printk(KERN_ERR "%s: %s doesn't support polling, aborting.\n",
725 np->name, np->dev_name);
731 npinfo = kmalloc(sizeof(*npinfo), GFP_KERNEL);
737 npinfo->rx_flags = 0;
738 INIT_LIST_HEAD(&npinfo->rx_np);
740 spin_lock_init(&npinfo->rx_lock);
741 skb_queue_head_init(&npinfo->arp_tx);
742 skb_queue_head_init(&npinfo->txq);
743 INIT_DELAYED_WORK(&npinfo->tx_work, queue_process);
745 atomic_set(&npinfo->refcnt, 1);
747 ops = np->dev->netdev_ops;
748 if (ops->ndo_netpoll_setup) {
749 err = ops->ndo_netpoll_setup(ndev, npinfo);
754 npinfo = ndev->npinfo;
755 atomic_inc(&npinfo->refcnt);
758 npinfo->netpoll = np;
761 spin_lock_irqsave(&npinfo->rx_lock, flags);
762 npinfo->rx_flags |= NETPOLL_RX_ENABLED;
763 list_add_tail(&np->rx, &npinfo->rx_np);
764 spin_unlock_irqrestore(&npinfo->rx_lock, flags);
767 /* last thing to do is link it to the net device structure */
768 rcu_assign_pointer(ndev->npinfo, npinfo);
777 EXPORT_SYMBOL_GPL(__netpoll_setup);
779 int netpoll_setup(struct netpoll *np)
781 struct net_device *ndev = NULL;
782 struct in_device *in_dev;
786 ndev = dev_get_by_name(&init_net, np->dev_name);
788 printk(KERN_ERR "%s: %s doesn't exist, aborting.\n",
789 np->name, np->dev_name);
794 printk(KERN_ERR "%s: %s is a slave device, aborting.\n",
795 np->name, np->dev_name);
800 if (!netif_running(ndev)) {
801 unsigned long atmost, atleast;
803 printk(KERN_INFO "%s: device %s not up yet, forcing it\n",
804 np->name, np->dev_name);
807 err = dev_open(ndev);
811 printk(KERN_ERR "%s: failed to open %s\n",
812 np->name, ndev->name);
816 atleast = jiffies + HZ/10;
817 atmost = jiffies + carrier_timeout * HZ;
818 while (!netif_carrier_ok(ndev)) {
819 if (time_after(jiffies, atmost)) {
821 "%s: timeout waiting for carrier\n",
828 /* If carrier appears to come up instantly, we don't
829 * trust it and pause so that we don't pump all our
830 * queued console messages into the bitbucket.
833 if (time_before(jiffies, atleast)) {
834 printk(KERN_NOTICE "%s: carrier detect appears"
835 " untrustworthy, waiting 4 seconds\n",
843 in_dev = __in_dev_get_rcu(ndev);
845 if (!in_dev || !in_dev->ifa_list) {
847 printk(KERN_ERR "%s: no IP address for %s, aborting\n",
848 np->name, np->dev_name);
853 np->local_ip = in_dev->ifa_list->ifa_local;
855 printk(KERN_INFO "%s: local IP %pI4\n", np->name, &np->local_ip);
860 /* fill up the skb queue */
864 err = __netpoll_setup(np);
876 EXPORT_SYMBOL(netpoll_setup);
878 static int __init netpoll_init(void)
880 skb_queue_head_init(&skb_pool);
883 core_initcall(netpoll_init);
885 void __netpoll_cleanup(struct netpoll *np)
887 struct netpoll_info *npinfo;
890 npinfo = np->dev->npinfo;
894 if (!list_empty(&npinfo->rx_np)) {
895 spin_lock_irqsave(&npinfo->rx_lock, flags);
897 if (list_empty(&npinfo->rx_np))
898 npinfo->rx_flags &= ~NETPOLL_RX_ENABLED;
899 spin_unlock_irqrestore(&npinfo->rx_lock, flags);
902 if (atomic_dec_and_test(&npinfo->refcnt)) {
903 const struct net_device_ops *ops;
905 ops = np->dev->netdev_ops;
906 if (ops->ndo_netpoll_cleanup)
907 ops->ndo_netpoll_cleanup(np->dev);
909 rcu_assign_pointer(np->dev->npinfo, NULL);
911 /* avoid racing with NAPI reading npinfo */
912 synchronize_rcu_bh();
914 skb_queue_purge(&npinfo->arp_tx);
915 skb_queue_purge(&npinfo->txq);
916 cancel_delayed_work_sync(&npinfo->tx_work);
918 /* clean after last, unfinished work */
919 __skb_queue_purge(&npinfo->txq);
923 EXPORT_SYMBOL_GPL(__netpoll_cleanup);
925 void netpoll_cleanup(struct netpoll *np)
931 __netpoll_cleanup(np);
937 EXPORT_SYMBOL(netpoll_cleanup);
939 int netpoll_trap(void)
941 return atomic_read(&trapped);
943 EXPORT_SYMBOL(netpoll_trap);
945 void netpoll_set_trap(int trap)
948 atomic_inc(&trapped);
950 atomic_dec(&trapped);
952 EXPORT_SYMBOL(netpoll_set_trap);