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/netdevice.h>
13 #include <linux/etherdevice.h>
14 #include <linux/string.h>
15 #include <linux/if_arp.h>
16 #include <linux/inetdevice.h>
17 #include <linux/inet.h>
18 #include <linux/interrupt.h>
19 #include <linux/netpoll.h>
20 #include <linux/sched.h>
21 #include <linux/delay.h>
22 #include <linux/rcupdate.h>
23 #include <linux/workqueue.h>
26 #include <asm/unaligned.h>
29 * We maintain a small pool of fully-sized skbs, to make sure the
30 * message gets out even in extreme OOM situations.
33 #define MAX_UDP_CHUNK 1460
35 #define MAX_QUEUE_DEPTH (MAX_SKBS / 2)
37 static struct sk_buff_head skb_pool;
39 static atomic_t trapped;
41 #define USEC_PER_POLL 50
42 #define NETPOLL_RX_ENABLED 1
43 #define NETPOLL_RX_DROP 2
45 #define MAX_SKB_SIZE \
46 (MAX_UDP_CHUNK + sizeof(struct udphdr) + \
47 sizeof(struct iphdr) + sizeof(struct ethhdr))
49 static void zap_completion_queue(void);
50 static void arp_reply(struct sk_buff *skb);
52 static void queue_process(struct work_struct *work)
54 struct netpoll_info *npinfo =
55 container_of(work, struct netpoll_info, tx_work.work);
59 while ((skb = skb_dequeue(&npinfo->txq))) {
60 struct net_device *dev = skb->dev;
61 struct netdev_queue *txq;
63 if (!netif_device_present(dev) || !netif_running(dev)) {
68 txq = netdev_get_tx_queue(dev, skb_get_queue_mapping(skb));
70 local_irq_save(flags);
71 __netif_tx_lock(txq, smp_processor_id());
72 if (netif_tx_queue_stopped(txq) ||
73 netif_tx_queue_frozen(txq) ||
74 dev->hard_start_xmit(skb, dev) != NETDEV_TX_OK) {
75 skb_queue_head(&npinfo->txq, skb);
76 __netif_tx_unlock(txq);
77 local_irq_restore(flags);
79 schedule_delayed_work(&npinfo->tx_work, HZ/10);
82 __netif_tx_unlock(txq);
83 local_irq_restore(flags);
87 static __sum16 checksum_udp(struct sk_buff *skb, struct udphdr *uh,
88 unsigned short ulen, __be32 saddr, __be32 daddr)
92 if (uh->check == 0 || skb_csum_unnecessary(skb))
95 psum = csum_tcpudp_nofold(saddr, daddr, ulen, IPPROTO_UDP, 0);
97 if (skb->ip_summed == CHECKSUM_COMPLETE &&
98 !csum_fold(csum_add(psum, skb->csum)))
103 return __skb_checksum_complete(skb);
107 * Check whether delayed processing was scheduled for our NIC. If so,
108 * we attempt to grab the poll lock and use ->poll() to pump the card.
109 * If this fails, either we've recursed in ->poll() or it's already
110 * running on another CPU.
112 * Note: we don't mask interrupts with this lock because we're using
113 * trylock here and interrupts are already disabled in the softirq
114 * case. Further, we test the poll_owner to avoid recursion on UP
115 * systems where the lock doesn't exist.
117 * In cases where there is bi-directional communications, reading only
118 * one message at a time can lead to packets being dropped by the
119 * network adapter, forcing superfluous retries and possibly timeouts.
120 * Thus, we set our budget to greater than 1.
122 static int poll_one_napi(struct netpoll_info *npinfo,
123 struct napi_struct *napi, int budget)
127 /* net_rx_action's ->poll() invocations and our's are
128 * synchronized by this test which is only made while
129 * holding the napi->poll_lock.
131 if (!test_bit(NAPI_STATE_SCHED, &napi->state))
134 npinfo->rx_flags |= NETPOLL_RX_DROP;
135 atomic_inc(&trapped);
137 work = napi->poll(napi, budget);
139 atomic_dec(&trapped);
140 npinfo->rx_flags &= ~NETPOLL_RX_DROP;
142 return budget - work;
145 static void poll_napi(struct net_device *dev)
147 struct napi_struct *napi;
150 list_for_each_entry(napi, &dev->napi_list, dev_list) {
151 if (napi->poll_owner != smp_processor_id() &&
152 spin_trylock(&napi->poll_lock)) {
153 budget = poll_one_napi(dev->npinfo, napi, budget);
154 spin_unlock(&napi->poll_lock);
162 static void service_arp_queue(struct netpoll_info *npi)
167 while ((skb = skb_dequeue(&npi->arp_tx)))
172 void netpoll_poll(struct netpoll *np)
174 struct net_device *dev = np->dev;
175 const struct net_device_ops *ops = dev->netdev_ops;
177 if (!dev || !netif_running(dev) || !ops->ndo_poll_controller)
180 /* Process pending work on NIC */
181 ops->ndo_poll_controller(dev);
185 service_arp_queue(dev->npinfo);
187 zap_completion_queue();
190 static void refill_skbs(void)
195 spin_lock_irqsave(&skb_pool.lock, flags);
196 while (skb_pool.qlen < MAX_SKBS) {
197 skb = alloc_skb(MAX_SKB_SIZE, GFP_ATOMIC);
201 __skb_queue_tail(&skb_pool, skb);
203 spin_unlock_irqrestore(&skb_pool.lock, flags);
206 static void zap_completion_queue(void)
209 struct softnet_data *sd = &get_cpu_var(softnet_data);
211 if (sd->completion_queue) {
212 struct sk_buff *clist;
214 local_irq_save(flags);
215 clist = sd->completion_queue;
216 sd->completion_queue = NULL;
217 local_irq_restore(flags);
219 while (clist != NULL) {
220 struct sk_buff *skb = clist;
222 if (skb->destructor) {
223 atomic_inc(&skb->users);
224 dev_kfree_skb_any(skb); /* put this one back */
231 put_cpu_var(softnet_data);
234 static struct sk_buff *find_skb(struct netpoll *np, int len, int reserve)
239 zap_completion_queue();
243 skb = alloc_skb(len, GFP_ATOMIC);
245 skb = skb_dequeue(&skb_pool);
255 atomic_set(&skb->users, 1);
256 skb_reserve(skb, reserve);
260 static int netpoll_owner_active(struct net_device *dev)
262 struct napi_struct *napi;
264 list_for_each_entry(napi, &dev->napi_list, dev_list) {
265 if (napi->poll_owner == smp_processor_id())
271 static void netpoll_send_skb(struct netpoll *np, struct sk_buff *skb)
273 int status = NETDEV_TX_BUSY;
275 struct net_device *dev = np->dev;
276 struct netpoll_info *npinfo = np->dev->npinfo;
278 if (!npinfo || !netif_running(dev) || !netif_device_present(dev)) {
283 /* don't get messages out of order, and no recursion */
284 if (skb_queue_len(&npinfo->txq) == 0 && !netpoll_owner_active(dev)) {
285 struct netdev_queue *txq;
288 txq = netdev_get_tx_queue(dev, skb_get_queue_mapping(skb));
290 local_irq_save(flags);
291 /* try until next clock tick */
292 for (tries = jiffies_to_usecs(1)/USEC_PER_POLL;
293 tries > 0; --tries) {
294 if (__netif_tx_trylock(txq)) {
295 if (!netif_tx_queue_stopped(txq))
296 status = dev->hard_start_xmit(skb, dev);
297 __netif_tx_unlock(txq);
299 if (status == NETDEV_TX_OK)
304 /* tickle device maybe there is some cleanup */
307 udelay(USEC_PER_POLL);
309 local_irq_restore(flags);
312 if (status != NETDEV_TX_OK) {
313 skb_queue_tail(&npinfo->txq, skb);
314 schedule_delayed_work(&npinfo->tx_work,0);
318 void netpoll_send_udp(struct netpoll *np, const char *msg, int len)
320 int total_len, eth_len, ip_len, udp_len;
326 udp_len = len + sizeof(*udph);
327 ip_len = eth_len = udp_len + sizeof(*iph);
328 total_len = eth_len + ETH_HLEN + NET_IP_ALIGN;
330 skb = find_skb(np, total_len, total_len - len);
334 skb_copy_to_linear_data(skb, msg, len);
337 skb_push(skb, sizeof(*udph));
338 skb_reset_transport_header(skb);
340 udph->source = htons(np->local_port);
341 udph->dest = htons(np->remote_port);
342 udph->len = htons(udp_len);
344 udph->check = csum_tcpudp_magic(htonl(np->local_ip),
345 htonl(np->remote_ip),
346 udp_len, IPPROTO_UDP,
347 csum_partial(udph, udp_len, 0));
348 if (udph->check == 0)
349 udph->check = CSUM_MANGLED_0;
351 skb_push(skb, sizeof(*iph));
352 skb_reset_network_header(skb);
355 /* iph->version = 4; iph->ihl = 5; */
356 put_unaligned(0x45, (unsigned char *)iph);
358 put_unaligned(htons(ip_len), &(iph->tot_len));
362 iph->protocol = IPPROTO_UDP;
364 put_unaligned(htonl(np->local_ip), &(iph->saddr));
365 put_unaligned(htonl(np->remote_ip), &(iph->daddr));
366 iph->check = ip_fast_csum((unsigned char *)iph, iph->ihl);
368 eth = (struct ethhdr *) skb_push(skb, ETH_HLEN);
369 skb_reset_mac_header(skb);
370 skb->protocol = eth->h_proto = htons(ETH_P_IP);
371 memcpy(eth->h_source, np->dev->dev_addr, ETH_ALEN);
372 memcpy(eth->h_dest, np->remote_mac, ETH_ALEN);
376 netpoll_send_skb(np, skb);
379 static void arp_reply(struct sk_buff *skb)
381 struct netpoll_info *npinfo = skb->dev->npinfo;
383 unsigned char *arp_ptr;
384 int size, type = ARPOP_REPLY, ptype = ETH_P_ARP;
387 struct sk_buff *send_skb;
388 struct netpoll *np = NULL;
390 if (npinfo->rx_np && npinfo->rx_np->dev == skb->dev)
395 /* No arp on this interface */
396 if (skb->dev->flags & IFF_NOARP)
399 if (!pskb_may_pull(skb, arp_hdr_len(skb->dev)))
402 skb_reset_network_header(skb);
403 skb_reset_transport_header(skb);
406 if ((arp->ar_hrd != htons(ARPHRD_ETHER) &&
407 arp->ar_hrd != htons(ARPHRD_IEEE802)) ||
408 arp->ar_pro != htons(ETH_P_IP) ||
409 arp->ar_op != htons(ARPOP_REQUEST))
412 arp_ptr = (unsigned char *)(arp+1);
413 /* save the location of the src hw addr */
415 arp_ptr += skb->dev->addr_len;
416 memcpy(&sip, arp_ptr, 4);
418 /* if we actually cared about dst hw addr, it would get copied here */
419 arp_ptr += skb->dev->addr_len;
420 memcpy(&tip, arp_ptr, 4);
422 /* Should we ignore arp? */
423 if (tip != htonl(np->local_ip) ||
424 ipv4_is_loopback(tip) || ipv4_is_multicast(tip))
427 size = arp_hdr_len(skb->dev);
428 send_skb = find_skb(np, size + LL_ALLOCATED_SPACE(np->dev),
429 LL_RESERVED_SPACE(np->dev));
434 skb_reset_network_header(send_skb);
435 arp = (struct arphdr *) skb_put(send_skb, size);
436 send_skb->dev = skb->dev;
437 send_skb->protocol = htons(ETH_P_ARP);
439 /* Fill the device header for the ARP frame */
440 if (dev_hard_header(send_skb, skb->dev, ptype,
441 sha, np->dev->dev_addr,
442 send_skb->len) < 0) {
448 * Fill out the arp protocol part.
450 * we only support ethernet device type,
451 * which (according to RFC 1390) should always equal 1 (Ethernet).
454 arp->ar_hrd = htons(np->dev->type);
455 arp->ar_pro = htons(ETH_P_IP);
456 arp->ar_hln = np->dev->addr_len;
458 arp->ar_op = htons(type);
460 arp_ptr=(unsigned char *)(arp + 1);
461 memcpy(arp_ptr, np->dev->dev_addr, np->dev->addr_len);
462 arp_ptr += np->dev->addr_len;
463 memcpy(arp_ptr, &tip, 4);
465 memcpy(arp_ptr, sha, np->dev->addr_len);
466 arp_ptr += np->dev->addr_len;
467 memcpy(arp_ptr, &sip, 4);
469 netpoll_send_skb(np, send_skb);
472 int __netpoll_rx(struct sk_buff *skb)
474 int proto, len, ulen;
477 struct netpoll_info *npi = skb->dev->npinfo;
478 struct netpoll *np = npi->rx_np;
482 if (skb->dev->type != ARPHRD_ETHER)
485 /* check if netpoll clients need ARP */
486 if (skb->protocol == htons(ETH_P_ARP) &&
487 atomic_read(&trapped)) {
488 skb_queue_tail(&npi->arp_tx, skb);
492 proto = ntohs(eth_hdr(skb)->h_proto);
493 if (proto != ETH_P_IP)
495 if (skb->pkt_type == PACKET_OTHERHOST)
500 iph = (struct iphdr *)skb->data;
501 if (!pskb_may_pull(skb, sizeof(struct iphdr)))
503 if (iph->ihl < 5 || iph->version != 4)
505 if (!pskb_may_pull(skb, iph->ihl*4))
507 if (ip_fast_csum((u8 *)iph, iph->ihl) != 0)
510 len = ntohs(iph->tot_len);
511 if (skb->len < len || len < iph->ihl*4)
515 * Our transport medium may have padded the buffer out.
516 * Now We trim to the true length of the frame.
518 if (pskb_trim_rcsum(skb, len))
521 if (iph->protocol != IPPROTO_UDP)
525 uh = (struct udphdr *)(((char *)iph) + iph->ihl*4);
526 ulen = ntohs(uh->len);
530 if (checksum_udp(skb, uh, ulen, iph->saddr, iph->daddr))
532 if (np->local_ip && np->local_ip != ntohl(iph->daddr))
534 if (np->remote_ip && np->remote_ip != ntohl(iph->saddr))
536 if (np->local_port && np->local_port != ntohs(uh->dest))
539 np->rx_hook(np, ntohs(uh->source),
541 ulen - sizeof(struct udphdr));
547 if (atomic_read(&trapped)) {
555 void netpoll_print_options(struct netpoll *np)
557 printk(KERN_INFO "%s: local port %d\n",
558 np->name, np->local_port);
559 printk(KERN_INFO "%s: local IP %d.%d.%d.%d\n",
560 np->name, HIPQUAD(np->local_ip));
561 printk(KERN_INFO "%s: interface %s\n",
562 np->name, np->dev_name);
563 printk(KERN_INFO "%s: remote port %d\n",
564 np->name, np->remote_port);
565 printk(KERN_INFO "%s: remote IP %d.%d.%d.%d\n",
566 np->name, HIPQUAD(np->remote_ip));
567 printk(KERN_INFO "%s: remote ethernet address %pM\n",
568 np->name, np->remote_mac);
571 int netpoll_parse_options(struct netpoll *np, char *opt)
573 char *cur=opt, *delim;
576 if ((delim = strchr(cur, '@')) == NULL)
579 np->local_port = simple_strtol(cur, NULL, 10);
585 if ((delim = strchr(cur, '/')) == NULL)
588 np->local_ip = ntohl(in_aton(cur));
594 /* parse out dev name */
595 if ((delim = strchr(cur, ',')) == NULL)
598 strlcpy(np->dev_name, cur, sizeof(np->dev_name));
605 if ((delim = strchr(cur, '@')) == NULL)
608 np->remote_port = simple_strtol(cur, NULL, 10);
614 if ((delim = strchr(cur, '/')) == NULL)
617 np->remote_ip = ntohl(in_aton(cur));
622 if ((delim = strchr(cur, ':')) == NULL)
625 np->remote_mac[0] = simple_strtol(cur, NULL, 16);
627 if ((delim = strchr(cur, ':')) == NULL)
630 np->remote_mac[1] = simple_strtol(cur, NULL, 16);
632 if ((delim = strchr(cur, ':')) == NULL)
635 np->remote_mac[2] = simple_strtol(cur, NULL, 16);
637 if ((delim = strchr(cur, ':')) == NULL)
640 np->remote_mac[3] = simple_strtol(cur, NULL, 16);
642 if ((delim = strchr(cur, ':')) == NULL)
645 np->remote_mac[4] = simple_strtol(cur, NULL, 16);
647 np->remote_mac[5] = simple_strtol(cur, NULL, 16);
650 netpoll_print_options(np);
655 printk(KERN_INFO "%s: couldn't parse config at %s!\n",
660 int netpoll_setup(struct netpoll *np)
662 struct net_device *ndev = NULL;
663 struct in_device *in_dev;
664 struct netpoll_info *npinfo;
669 ndev = dev_get_by_name(&init_net, np->dev_name);
671 printk(KERN_ERR "%s: %s doesn't exist, aborting.\n",
672 np->name, np->dev_name);
678 npinfo = kmalloc(sizeof(*npinfo), GFP_KERNEL);
684 npinfo->rx_flags = 0;
685 npinfo->rx_np = NULL;
687 spin_lock_init(&npinfo->rx_lock);
688 skb_queue_head_init(&npinfo->arp_tx);
689 skb_queue_head_init(&npinfo->txq);
690 INIT_DELAYED_WORK(&npinfo->tx_work, queue_process);
692 atomic_set(&npinfo->refcnt, 1);
694 npinfo = ndev->npinfo;
695 atomic_inc(&npinfo->refcnt);
698 if (!ndev->netdev_ops->ndo_poll_controller) {
699 printk(KERN_ERR "%s: %s doesn't support polling, aborting.\n",
700 np->name, np->dev_name);
705 if (!netif_running(ndev)) {
706 unsigned long atmost, atleast;
708 printk(KERN_INFO "%s: device %s not up yet, forcing it\n",
709 np->name, np->dev_name);
712 err = dev_open(ndev);
716 printk(KERN_ERR "%s: failed to open %s\n",
717 np->name, ndev->name);
721 atleast = jiffies + HZ/10;
722 atmost = jiffies + 4*HZ;
723 while (!netif_carrier_ok(ndev)) {
724 if (time_after(jiffies, atmost)) {
726 "%s: timeout waiting for carrier\n",
733 /* If carrier appears to come up instantly, we don't
734 * trust it and pause so that we don't pump all our
735 * queued console messages into the bitbucket.
738 if (time_before(jiffies, atleast)) {
739 printk(KERN_NOTICE "%s: carrier detect appears"
740 " untrustworthy, waiting 4 seconds\n",
748 in_dev = __in_dev_get_rcu(ndev);
750 if (!in_dev || !in_dev->ifa_list) {
752 printk(KERN_ERR "%s: no IP address for %s, aborting\n",
753 np->name, np->dev_name);
758 np->local_ip = ntohl(in_dev->ifa_list->ifa_local);
760 printk(KERN_INFO "%s: local IP %d.%d.%d.%d\n",
761 np->name, HIPQUAD(np->local_ip));
765 spin_lock_irqsave(&npinfo->rx_lock, flags);
766 npinfo->rx_flags |= NETPOLL_RX_ENABLED;
768 spin_unlock_irqrestore(&npinfo->rx_lock, flags);
771 /* fill up the skb queue */
774 /* last thing to do is link it to the net device structure */
775 ndev->npinfo = npinfo;
777 /* avoid racing with NAPI reading npinfo */
790 static int __init netpoll_init(void)
792 skb_queue_head_init(&skb_pool);
795 core_initcall(netpoll_init);
797 void netpoll_cleanup(struct netpoll *np)
799 struct netpoll_info *npinfo;
803 npinfo = np->dev->npinfo;
805 if (npinfo->rx_np == np) {
806 spin_lock_irqsave(&npinfo->rx_lock, flags);
807 npinfo->rx_np = NULL;
808 npinfo->rx_flags &= ~NETPOLL_RX_ENABLED;
809 spin_unlock_irqrestore(&npinfo->rx_lock, flags);
812 if (atomic_dec_and_test(&npinfo->refcnt)) {
813 skb_queue_purge(&npinfo->arp_tx);
814 skb_queue_purge(&npinfo->txq);
815 cancel_rearming_delayed_work(&npinfo->tx_work);
817 /* clean after last, unfinished work */
818 __skb_queue_purge(&npinfo->txq);
820 np->dev->npinfo = NULL;
830 int netpoll_trap(void)
832 return atomic_read(&trapped);
835 void netpoll_set_trap(int trap)
838 atomic_inc(&trapped);
840 atomic_dec(&trapped);
843 EXPORT_SYMBOL(netpoll_set_trap);
844 EXPORT_SYMBOL(netpoll_trap);
845 EXPORT_SYMBOL(netpoll_print_options);
846 EXPORT_SYMBOL(netpoll_parse_options);
847 EXPORT_SYMBOL(netpoll_setup);
848 EXPORT_SYMBOL(netpoll_cleanup);
849 EXPORT_SYMBOL(netpoll_send_udp);
850 EXPORT_SYMBOL(netpoll_poll);