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 dev
->hard_start_xmit(skb
, dev
) != NETDEV_TX_OK
) {
74 skb_queue_head(&npinfo
->txq
, skb
);
75 __netif_tx_unlock(txq
);
76 local_irq_restore(flags
);
78 schedule_delayed_work(&npinfo
->tx_work
, HZ
/10);
81 __netif_tx_unlock(txq
);
82 local_irq_restore(flags
);
86 static __sum16
checksum_udp(struct sk_buff
*skb
, struct udphdr
*uh
,
87 unsigned short ulen
, __be32 saddr
, __be32 daddr
)
91 if (uh
->check
== 0 || skb_csum_unnecessary(skb
))
94 psum
= csum_tcpudp_nofold(saddr
, daddr
, ulen
, IPPROTO_UDP
, 0);
96 if (skb
->ip_summed
== CHECKSUM_COMPLETE
&&
97 !csum_fold(csum_add(psum
, skb
->csum
)))
102 return __skb_checksum_complete(skb
);
106 * Check whether delayed processing was scheduled for our NIC. If so,
107 * we attempt to grab the poll lock and use ->poll() to pump the card.
108 * If this fails, either we've recursed in ->poll() or it's already
109 * running on another CPU.
111 * Note: we don't mask interrupts with this lock because we're using
112 * trylock here and interrupts are already disabled in the softirq
113 * case. Further, we test the poll_owner to avoid recursion on UP
114 * systems where the lock doesn't exist.
116 * In cases where there is bi-directional communications, reading only
117 * one message at a time can lead to packets being dropped by the
118 * network adapter, forcing superfluous retries and possibly timeouts.
119 * Thus, we set our budget to greater than 1.
121 static int poll_one_napi(struct netpoll_info
*npinfo
,
122 struct napi_struct
*napi
, int budget
)
126 /* net_rx_action's ->poll() invocations and our's are
127 * synchronized by this test which is only made while
128 * holding the napi->poll_lock.
130 if (!test_bit(NAPI_STATE_SCHED
, &napi
->state
))
133 npinfo
->rx_flags
|= NETPOLL_RX_DROP
;
134 atomic_inc(&trapped
);
136 work
= napi
->poll(napi
, budget
);
138 atomic_dec(&trapped
);
139 npinfo
->rx_flags
&= ~NETPOLL_RX_DROP
;
141 return budget
- work
;
144 static void poll_napi(struct net_device
*dev
)
146 struct napi_struct
*napi
;
149 list_for_each_entry(napi
, &dev
->napi_list
, dev_list
) {
150 if (napi
->poll_owner
!= smp_processor_id() &&
151 spin_trylock(&napi
->poll_lock
)) {
152 budget
= poll_one_napi(dev
->npinfo
, napi
, budget
);
153 spin_unlock(&napi
->poll_lock
);
161 static void service_arp_queue(struct netpoll_info
*npi
)
166 while ((skb
= skb_dequeue(&npi
->arp_tx
)))
171 void netpoll_poll(struct netpoll
*np
)
173 struct net_device
*dev
= np
->dev
;
175 if (!dev
|| !netif_running(dev
) || !dev
->poll_controller
)
178 /* Process pending work on NIC */
179 dev
->poll_controller(dev
);
183 service_arp_queue(dev
->npinfo
);
185 zap_completion_queue();
188 static void refill_skbs(void)
193 spin_lock_irqsave(&skb_pool
.lock
, flags
);
194 while (skb_pool
.qlen
< MAX_SKBS
) {
195 skb
= alloc_skb(MAX_SKB_SIZE
, GFP_ATOMIC
);
199 __skb_queue_tail(&skb_pool
, skb
);
201 spin_unlock_irqrestore(&skb_pool
.lock
, flags
);
204 static void zap_completion_queue(void)
207 struct softnet_data
*sd
= &get_cpu_var(softnet_data
);
209 if (sd
->completion_queue
) {
210 struct sk_buff
*clist
;
212 local_irq_save(flags
);
213 clist
= sd
->completion_queue
;
214 sd
->completion_queue
= NULL
;
215 local_irq_restore(flags
);
217 while (clist
!= NULL
) {
218 struct sk_buff
*skb
= clist
;
220 if (skb
->destructor
) {
221 atomic_inc(&skb
->users
);
222 dev_kfree_skb_any(skb
); /* put this one back */
229 put_cpu_var(softnet_data
);
232 static struct sk_buff
*find_skb(struct netpoll
*np
, int len
, int reserve
)
237 zap_completion_queue();
241 skb
= alloc_skb(len
, GFP_ATOMIC
);
243 skb
= skb_dequeue(&skb_pool
);
253 atomic_set(&skb
->users
, 1);
254 skb_reserve(skb
, reserve
);
258 static int netpoll_owner_active(struct net_device
*dev
)
260 struct napi_struct
*napi
;
262 list_for_each_entry(napi
, &dev
->napi_list
, dev_list
) {
263 if (napi
->poll_owner
== smp_processor_id())
269 static void netpoll_send_skb(struct netpoll
*np
, struct sk_buff
*skb
)
271 int status
= NETDEV_TX_BUSY
;
273 struct net_device
*dev
= np
->dev
;
274 struct netpoll_info
*npinfo
= np
->dev
->npinfo
;
276 if (!npinfo
|| !netif_running(dev
) || !netif_device_present(dev
)) {
281 /* don't get messages out of order, and no recursion */
282 if (skb_queue_len(&npinfo
->txq
) == 0 && !netpoll_owner_active(dev
)) {
283 struct netdev_queue
*txq
;
286 txq
= netdev_get_tx_queue(dev
, skb_get_queue_mapping(skb
));
288 local_irq_save(flags
);
289 /* try until next clock tick */
290 for (tries
= jiffies_to_usecs(1)/USEC_PER_POLL
;
291 tries
> 0; --tries
) {
292 if (__netif_tx_trylock(txq
)) {
293 if (!netif_tx_queue_stopped(txq
))
294 status
= dev
->hard_start_xmit(skb
, dev
);
295 __netif_tx_unlock(txq
);
297 if (status
== NETDEV_TX_OK
)
302 /* tickle device maybe there is some cleanup */
305 udelay(USEC_PER_POLL
);
307 local_irq_restore(flags
);
310 if (status
!= NETDEV_TX_OK
) {
311 skb_queue_tail(&npinfo
->txq
, skb
);
312 schedule_delayed_work(&npinfo
->tx_work
,0);
316 void netpoll_send_udp(struct netpoll
*np
, const char *msg
, int len
)
318 int total_len
, eth_len
, ip_len
, udp_len
;
324 udp_len
= len
+ sizeof(*udph
);
325 ip_len
= eth_len
= udp_len
+ sizeof(*iph
);
326 total_len
= eth_len
+ ETH_HLEN
+ NET_IP_ALIGN
;
328 skb
= find_skb(np
, total_len
, total_len
- len
);
332 skb_copy_to_linear_data(skb
, msg
, len
);
335 skb_push(skb
, sizeof(*udph
));
336 skb_reset_transport_header(skb
);
338 udph
->source
= htons(np
->local_port
);
339 udph
->dest
= htons(np
->remote_port
);
340 udph
->len
= htons(udp_len
);
342 udph
->check
= csum_tcpudp_magic(htonl(np
->local_ip
),
343 htonl(np
->remote_ip
),
344 udp_len
, IPPROTO_UDP
,
345 csum_partial((unsigned char *)udph
, udp_len
, 0));
346 if (udph
->check
== 0)
347 udph
->check
= CSUM_MANGLED_0
;
349 skb_push(skb
, sizeof(*iph
));
350 skb_reset_network_header(skb
);
353 /* iph->version = 4; iph->ihl = 5; */
354 put_unaligned(0x45, (unsigned char *)iph
);
356 put_unaligned(htons(ip_len
), &(iph
->tot_len
));
360 iph
->protocol
= IPPROTO_UDP
;
362 put_unaligned(htonl(np
->local_ip
), &(iph
->saddr
));
363 put_unaligned(htonl(np
->remote_ip
), &(iph
->daddr
));
364 iph
->check
= ip_fast_csum((unsigned char *)iph
, iph
->ihl
);
366 eth
= (struct ethhdr
*) skb_push(skb
, ETH_HLEN
);
367 skb_reset_mac_header(skb
);
368 skb
->protocol
= eth
->h_proto
= htons(ETH_P_IP
);
369 memcpy(eth
->h_source
, np
->dev
->dev_addr
, ETH_ALEN
);
370 memcpy(eth
->h_dest
, np
->remote_mac
, ETH_ALEN
);
374 netpoll_send_skb(np
, skb
);
377 static void arp_reply(struct sk_buff
*skb
)
379 struct netpoll_info
*npinfo
= skb
->dev
->npinfo
;
381 unsigned char *arp_ptr
;
382 int size
, type
= ARPOP_REPLY
, ptype
= ETH_P_ARP
;
385 struct sk_buff
*send_skb
;
386 struct netpoll
*np
= NULL
;
388 if (npinfo
->rx_np
&& npinfo
->rx_np
->dev
== skb
->dev
)
393 /* No arp on this interface */
394 if (skb
->dev
->flags
& IFF_NOARP
)
397 if (!pskb_may_pull(skb
, arp_hdr_len(skb
->dev
)))
400 skb_reset_network_header(skb
);
401 skb_reset_transport_header(skb
);
404 if ((arp
->ar_hrd
!= htons(ARPHRD_ETHER
) &&
405 arp
->ar_hrd
!= htons(ARPHRD_IEEE802
)) ||
406 arp
->ar_pro
!= htons(ETH_P_IP
) ||
407 arp
->ar_op
!= htons(ARPOP_REQUEST
))
410 arp_ptr
= (unsigned char *)(arp
+1);
411 /* save the location of the src hw addr */
413 arp_ptr
+= skb
->dev
->addr_len
;
414 memcpy(&sip
, arp_ptr
, 4);
416 /* if we actually cared about dst hw addr, it would get copied here */
417 arp_ptr
+= skb
->dev
->addr_len
;
418 memcpy(&tip
, arp_ptr
, 4);
420 /* Should we ignore arp? */
421 if (tip
!= htonl(np
->local_ip
) ||
422 ipv4_is_loopback(tip
) || ipv4_is_multicast(tip
))
425 size
= arp_hdr_len(skb
->dev
);
426 send_skb
= find_skb(np
, size
+ LL_ALLOCATED_SPACE(np
->dev
),
427 LL_RESERVED_SPACE(np
->dev
));
432 skb_reset_network_header(send_skb
);
433 arp
= (struct arphdr
*) skb_put(send_skb
, size
);
434 send_skb
->dev
= skb
->dev
;
435 send_skb
->protocol
= htons(ETH_P_ARP
);
437 /* Fill the device header for the ARP frame */
438 if (dev_hard_header(send_skb
, skb
->dev
, ptype
,
439 sha
, np
->dev
->dev_addr
,
440 send_skb
->len
) < 0) {
446 * Fill out the arp protocol part.
448 * we only support ethernet device type,
449 * which (according to RFC 1390) should always equal 1 (Ethernet).
452 arp
->ar_hrd
= htons(np
->dev
->type
);
453 arp
->ar_pro
= htons(ETH_P_IP
);
454 arp
->ar_hln
= np
->dev
->addr_len
;
456 arp
->ar_op
= htons(type
);
458 arp_ptr
=(unsigned char *)(arp
+ 1);
459 memcpy(arp_ptr
, np
->dev
->dev_addr
, np
->dev
->addr_len
);
460 arp_ptr
+= np
->dev
->addr_len
;
461 memcpy(arp_ptr
, &tip
, 4);
463 memcpy(arp_ptr
, sha
, np
->dev
->addr_len
);
464 arp_ptr
+= np
->dev
->addr_len
;
465 memcpy(arp_ptr
, &sip
, 4);
467 netpoll_send_skb(np
, send_skb
);
470 int __netpoll_rx(struct sk_buff
*skb
)
472 int proto
, len
, ulen
;
475 struct netpoll_info
*npi
= skb
->dev
->npinfo
;
476 struct netpoll
*np
= npi
->rx_np
;
480 if (skb
->dev
->type
!= ARPHRD_ETHER
)
483 /* check if netpoll clients need ARP */
484 if (skb
->protocol
== htons(ETH_P_ARP
) &&
485 atomic_read(&trapped
)) {
486 skb_queue_tail(&npi
->arp_tx
, skb
);
490 proto
= ntohs(eth_hdr(skb
)->h_proto
);
491 if (proto
!= ETH_P_IP
)
493 if (skb
->pkt_type
== PACKET_OTHERHOST
)
498 iph
= (struct iphdr
*)skb
->data
;
499 if (!pskb_may_pull(skb
, sizeof(struct iphdr
)))
501 if (iph
->ihl
< 5 || iph
->version
!= 4)
503 if (!pskb_may_pull(skb
, iph
->ihl
*4))
505 if (ip_fast_csum((u8
*)iph
, iph
->ihl
) != 0)
508 len
= ntohs(iph
->tot_len
);
509 if (skb
->len
< len
|| len
< iph
->ihl
*4)
513 * Our transport medium may have padded the buffer out.
514 * Now We trim to the true length of the frame.
516 if (pskb_trim_rcsum(skb
, len
))
519 if (iph
->protocol
!= IPPROTO_UDP
)
523 uh
= (struct udphdr
*)(((char *)iph
) + iph
->ihl
*4);
524 ulen
= ntohs(uh
->len
);
528 if (checksum_udp(skb
, uh
, ulen
, iph
->saddr
, iph
->daddr
))
530 if (np
->local_ip
&& np
->local_ip
!= ntohl(iph
->daddr
))
532 if (np
->remote_ip
&& np
->remote_ip
!= ntohl(iph
->saddr
))
534 if (np
->local_port
&& np
->local_port
!= ntohs(uh
->dest
))
537 np
->rx_hook(np
, ntohs(uh
->source
),
539 ulen
- sizeof(struct udphdr
));
545 if (atomic_read(&trapped
)) {
553 void netpoll_print_options(struct netpoll
*np
)
555 DECLARE_MAC_BUF(mac
);
556 printk(KERN_INFO
"%s: local port %d\n",
557 np
->name
, np
->local_port
);
558 printk(KERN_INFO
"%s: local IP %d.%d.%d.%d\n",
559 np
->name
, HIPQUAD(np
->local_ip
));
560 printk(KERN_INFO
"%s: interface %s\n",
561 np
->name
, np
->dev_name
);
562 printk(KERN_INFO
"%s: remote port %d\n",
563 np
->name
, np
->remote_port
);
564 printk(KERN_INFO
"%s: remote IP %d.%d.%d.%d\n",
565 np
->name
, HIPQUAD(np
->remote_ip
));
566 printk(KERN_INFO
"%s: remote ethernet address %s\n",
567 np
->name
, print_mac(mac
, np
->remote_mac
));
570 int netpoll_parse_options(struct netpoll
*np
, char *opt
)
572 char *cur
=opt
, *delim
;
575 if ((delim
= strchr(cur
, '@')) == NULL
)
578 np
->local_port
= simple_strtol(cur
, NULL
, 10);
584 if ((delim
= strchr(cur
, '/')) == NULL
)
587 np
->local_ip
= ntohl(in_aton(cur
));
593 /* parse out dev name */
594 if ((delim
= strchr(cur
, ',')) == NULL
)
597 strlcpy(np
->dev_name
, cur
, sizeof(np
->dev_name
));
604 if ((delim
= strchr(cur
, '@')) == NULL
)
607 np
->remote_port
= simple_strtol(cur
, NULL
, 10);
613 if ((delim
= strchr(cur
, '/')) == NULL
)
616 np
->remote_ip
= ntohl(in_aton(cur
));
621 if ((delim
= strchr(cur
, ':')) == NULL
)
624 np
->remote_mac
[0] = simple_strtol(cur
, NULL
, 16);
626 if ((delim
= strchr(cur
, ':')) == NULL
)
629 np
->remote_mac
[1] = simple_strtol(cur
, NULL
, 16);
631 if ((delim
= strchr(cur
, ':')) == NULL
)
634 np
->remote_mac
[2] = simple_strtol(cur
, NULL
, 16);
636 if ((delim
= strchr(cur
, ':')) == NULL
)
639 np
->remote_mac
[3] = simple_strtol(cur
, NULL
, 16);
641 if ((delim
= strchr(cur
, ':')) == NULL
)
644 np
->remote_mac
[4] = simple_strtol(cur
, NULL
, 16);
646 np
->remote_mac
[5] = simple_strtol(cur
, NULL
, 16);
649 netpoll_print_options(np
);
654 printk(KERN_INFO
"%s: couldn't parse config at %s!\n",
659 int netpoll_setup(struct netpoll
*np
)
661 struct net_device
*ndev
= NULL
;
662 struct in_device
*in_dev
;
663 struct netpoll_info
*npinfo
;
668 ndev
= dev_get_by_name(&init_net
, np
->dev_name
);
670 printk(KERN_ERR
"%s: %s doesn't exist, aborting.\n",
671 np
->name
, np
->dev_name
);
677 npinfo
= kmalloc(sizeof(*npinfo
), GFP_KERNEL
);
683 npinfo
->rx_flags
= 0;
684 npinfo
->rx_np
= NULL
;
686 spin_lock_init(&npinfo
->rx_lock
);
687 skb_queue_head_init(&npinfo
->arp_tx
);
688 skb_queue_head_init(&npinfo
->txq
);
689 INIT_DELAYED_WORK(&npinfo
->tx_work
, queue_process
);
691 atomic_set(&npinfo
->refcnt
, 1);
693 npinfo
= ndev
->npinfo
;
694 atomic_inc(&npinfo
->refcnt
);
697 if (!ndev
->poll_controller
) {
698 printk(KERN_ERR
"%s: %s doesn't support polling, aborting.\n",
699 np
->name
, np
->dev_name
);
704 if (!netif_running(ndev
)) {
705 unsigned long atmost
, atleast
;
707 printk(KERN_INFO
"%s: device %s not up yet, forcing it\n",
708 np
->name
, np
->dev_name
);
711 err
= dev_open(ndev
);
715 printk(KERN_ERR
"%s: failed to open %s\n",
716 np
->name
, ndev
->name
);
720 atleast
= jiffies
+ HZ
/10;
721 atmost
= jiffies
+ 4*HZ
;
722 while (!netif_carrier_ok(ndev
)) {
723 if (time_after(jiffies
, atmost
)) {
725 "%s: timeout waiting for carrier\n",
732 /* If carrier appears to come up instantly, we don't
733 * trust it and pause so that we don't pump all our
734 * queued console messages into the bitbucket.
737 if (time_before(jiffies
, atleast
)) {
738 printk(KERN_NOTICE
"%s: carrier detect appears"
739 " untrustworthy, waiting 4 seconds\n",
747 in_dev
= __in_dev_get_rcu(ndev
);
749 if (!in_dev
|| !in_dev
->ifa_list
) {
751 printk(KERN_ERR
"%s: no IP address for %s, aborting\n",
752 np
->name
, np
->dev_name
);
757 np
->local_ip
= ntohl(in_dev
->ifa_list
->ifa_local
);
759 printk(KERN_INFO
"%s: local IP %d.%d.%d.%d\n",
760 np
->name
, HIPQUAD(np
->local_ip
));
764 spin_lock_irqsave(&npinfo
->rx_lock
, flags
);
765 npinfo
->rx_flags
|= NETPOLL_RX_ENABLED
;
767 spin_unlock_irqrestore(&npinfo
->rx_lock
, flags
);
770 /* fill up the skb queue */
773 /* last thing to do is link it to the net device structure */
774 ndev
->npinfo
= npinfo
;
776 /* avoid racing with NAPI reading npinfo */
789 static int __init
netpoll_init(void)
791 skb_queue_head_init(&skb_pool
);
794 core_initcall(netpoll_init
);
796 void netpoll_cleanup(struct netpoll
*np
)
798 struct netpoll_info
*npinfo
;
802 npinfo
= np
->dev
->npinfo
;
804 if (npinfo
->rx_np
== np
) {
805 spin_lock_irqsave(&npinfo
->rx_lock
, flags
);
806 npinfo
->rx_np
= NULL
;
807 npinfo
->rx_flags
&= ~NETPOLL_RX_ENABLED
;
808 spin_unlock_irqrestore(&npinfo
->rx_lock
, flags
);
811 if (atomic_dec_and_test(&npinfo
->refcnt
)) {
812 skb_queue_purge(&npinfo
->arp_tx
);
813 skb_queue_purge(&npinfo
->txq
);
814 cancel_rearming_delayed_work(&npinfo
->tx_work
);
816 /* clean after last, unfinished work */
817 __skb_queue_purge(&npinfo
->txq
);
819 np
->dev
->npinfo
= NULL
;
829 int netpoll_trap(void)
831 return atomic_read(&trapped
);
834 void netpoll_set_trap(int trap
)
837 atomic_inc(&trapped
);
839 atomic_dec(&trapped
);
842 EXPORT_SYMBOL(netpoll_set_trap
);
843 EXPORT_SYMBOL(netpoll_trap
);
844 EXPORT_SYMBOL(netpoll_print_options
);
845 EXPORT_SYMBOL(netpoll_parse_options
);
846 EXPORT_SYMBOL(netpoll_setup
);
847 EXPORT_SYMBOL(netpoll_cleanup
);
848 EXPORT_SYMBOL(netpoll_send_udp
);
849 EXPORT_SYMBOL(netpoll_poll
);