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
;
62 if (!netif_device_present(dev
) || !netif_running(dev
)) {
67 local_irq_save(flags
);
69 if (netif_queue_stopped(dev
) ||
70 dev
->hard_start_xmit(skb
, dev
) != NETDEV_TX_OK
) {
71 skb_queue_head(&npinfo
->txq
, skb
);
73 local_irq_restore(flags
);
75 schedule_delayed_work(&npinfo
->tx_work
, HZ
/10);
79 local_irq_restore(flags
);
83 static __sum16
checksum_udp(struct sk_buff
*skb
, struct udphdr
*uh
,
84 unsigned short ulen
, __be32 saddr
, __be32 daddr
)
88 if (uh
->check
== 0 || skb_csum_unnecessary(skb
))
91 psum
= csum_tcpudp_nofold(saddr
, daddr
, ulen
, IPPROTO_UDP
, 0);
93 if (skb
->ip_summed
== CHECKSUM_COMPLETE
&&
94 !csum_fold(csum_add(psum
, skb
->csum
)))
99 return __skb_checksum_complete(skb
);
103 * Check whether delayed processing was scheduled for our NIC. If so,
104 * we attempt to grab the poll lock and use ->poll() to pump the card.
105 * If this fails, either we've recursed in ->poll() or it's already
106 * running on another CPU.
108 * Note: we don't mask interrupts with this lock because we're using
109 * trylock here and interrupts are already disabled in the softirq
110 * case. Further, we test the poll_owner to avoid recursion on UP
111 * systems where the lock doesn't exist.
113 * In cases where there is bi-directional communications, reading only
114 * one message at a time can lead to packets being dropped by the
115 * network adapter, forcing superfluous retries and possibly timeouts.
116 * Thus, we set our budget to greater than 1.
118 static void poll_napi(struct netpoll
*np
)
120 struct netpoll_info
*npinfo
= np
->dev
->npinfo
;
123 if (test_bit(__LINK_STATE_RX_SCHED
, &np
->dev
->state
) &&
124 npinfo
->poll_owner
!= smp_processor_id() &&
125 spin_trylock(&npinfo
->poll_lock
)) {
126 npinfo
->rx_flags
|= NETPOLL_RX_DROP
;
127 atomic_inc(&trapped
);
129 np
->dev
->poll(np
->dev
, &budget
);
131 atomic_dec(&trapped
);
132 npinfo
->rx_flags
&= ~NETPOLL_RX_DROP
;
133 spin_unlock(&npinfo
->poll_lock
);
137 static void service_arp_queue(struct netpoll_info
*npi
)
144 skb
= skb_dequeue(&npi
->arp_tx
);
146 while (skb
!= NULL
) {
148 skb
= skb_dequeue(&npi
->arp_tx
);
152 void netpoll_poll(struct netpoll
*np
)
154 if (!np
->dev
|| !netif_running(np
->dev
) || !np
->dev
->poll_controller
)
157 /* Process pending work on NIC */
158 np
->dev
->poll_controller(np
->dev
);
162 service_arp_queue(np
->dev
->npinfo
);
164 zap_completion_queue();
167 static void refill_skbs(void)
172 spin_lock_irqsave(&skb_pool
.lock
, flags
);
173 while (skb_pool
.qlen
< MAX_SKBS
) {
174 skb
= alloc_skb(MAX_SKB_SIZE
, GFP_ATOMIC
);
178 __skb_queue_tail(&skb_pool
, skb
);
180 spin_unlock_irqrestore(&skb_pool
.lock
, flags
);
183 static void zap_completion_queue(void)
186 struct softnet_data
*sd
= &get_cpu_var(softnet_data
);
188 if (sd
->completion_queue
) {
189 struct sk_buff
*clist
;
191 local_irq_save(flags
);
192 clist
= sd
->completion_queue
;
193 sd
->completion_queue
= NULL
;
194 local_irq_restore(flags
);
196 while (clist
!= NULL
) {
197 struct sk_buff
*skb
= clist
;
200 dev_kfree_skb_any(skb
); /* put this one back */
206 put_cpu_var(softnet_data
);
209 static struct sk_buff
*find_skb(struct netpoll
*np
, int len
, int reserve
)
214 zap_completion_queue();
218 skb
= alloc_skb(len
, GFP_ATOMIC
);
220 skb
= skb_dequeue(&skb_pool
);
230 atomic_set(&skb
->users
, 1);
231 skb_reserve(skb
, reserve
);
235 static void netpoll_send_skb(struct netpoll
*np
, struct sk_buff
*skb
)
237 int status
= NETDEV_TX_BUSY
;
239 struct net_device
*dev
= np
->dev
;
240 struct netpoll_info
*npinfo
= np
->dev
->npinfo
;
242 if (!npinfo
|| !netif_running(dev
) || !netif_device_present(dev
)) {
247 /* don't get messages out of order, and no recursion */
248 if (skb_queue_len(&npinfo
->txq
) == 0 &&
249 npinfo
->poll_owner
!= smp_processor_id()) {
252 local_irq_save(flags
);
253 if (netif_tx_trylock(dev
)) {
254 /* try until next clock tick */
255 for (tries
= jiffies_to_usecs(1)/USEC_PER_POLL
;
256 tries
> 0; --tries
) {
257 if (!netif_queue_stopped(dev
))
258 status
= dev
->hard_start_xmit(skb
, dev
);
260 if (status
== NETDEV_TX_OK
)
263 /* tickle device maybe there is some cleanup */
266 udelay(USEC_PER_POLL
);
268 netif_tx_unlock(dev
);
270 local_irq_restore(flags
);
273 if (status
!= NETDEV_TX_OK
) {
274 skb_queue_tail(&npinfo
->txq
, skb
);
275 schedule_delayed_work(&npinfo
->tx_work
,0);
279 void netpoll_send_udp(struct netpoll
*np
, const char *msg
, int len
)
281 int total_len
, eth_len
, ip_len
, udp_len
;
287 udp_len
= len
+ sizeof(*udph
);
288 ip_len
= eth_len
= udp_len
+ sizeof(*iph
);
289 total_len
= eth_len
+ ETH_HLEN
+ NET_IP_ALIGN
;
291 skb
= find_skb(np
, total_len
, total_len
- len
);
295 skb_copy_to_linear_data(skb
, msg
, len
);
298 skb_push(skb
, sizeof(*udph
));
299 skb_reset_transport_header(skb
);
301 udph
->source
= htons(np
->local_port
);
302 udph
->dest
= htons(np
->remote_port
);
303 udph
->len
= htons(udp_len
);
305 udph
->check
= csum_tcpudp_magic(htonl(np
->local_ip
),
306 htonl(np
->remote_ip
),
307 udp_len
, IPPROTO_UDP
,
308 csum_partial((unsigned char *)udph
, udp_len
, 0));
309 if (udph
->check
== 0)
310 udph
->check
= CSUM_MANGLED_0
;
312 skb_push(skb
, sizeof(*iph
));
313 skb_reset_network_header(skb
);
316 /* iph->version = 4; iph->ihl = 5; */
317 put_unaligned(0x45, (unsigned char *)iph
);
319 put_unaligned(htons(ip_len
), &(iph
->tot_len
));
323 iph
->protocol
= IPPROTO_UDP
;
325 put_unaligned(htonl(np
->local_ip
), &(iph
->saddr
));
326 put_unaligned(htonl(np
->remote_ip
), &(iph
->daddr
));
327 iph
->check
= ip_fast_csum((unsigned char *)iph
, iph
->ihl
);
329 eth
= (struct ethhdr
*) skb_push(skb
, ETH_HLEN
);
330 skb_reset_mac_header(skb
);
331 skb
->protocol
= eth
->h_proto
= htons(ETH_P_IP
);
332 memcpy(eth
->h_source
, np
->local_mac
, 6);
333 memcpy(eth
->h_dest
, np
->remote_mac
, 6);
337 netpoll_send_skb(np
, skb
);
340 static void arp_reply(struct sk_buff
*skb
)
342 struct netpoll_info
*npinfo
= skb
->dev
->npinfo
;
344 unsigned char *arp_ptr
;
345 int size
, type
= ARPOP_REPLY
, ptype
= ETH_P_ARP
;
348 struct sk_buff
*send_skb
;
349 struct netpoll
*np
= NULL
;
351 if (npinfo
->rx_np
&& npinfo
->rx_np
->dev
== skb
->dev
)
356 /* No arp on this interface */
357 if (skb
->dev
->flags
& IFF_NOARP
)
360 if (!pskb_may_pull(skb
, (sizeof(struct arphdr
) +
361 (2 * skb
->dev
->addr_len
) +
365 skb_reset_network_header(skb
);
366 skb_reset_transport_header(skb
);
369 if ((arp
->ar_hrd
!= htons(ARPHRD_ETHER
) &&
370 arp
->ar_hrd
!= htons(ARPHRD_IEEE802
)) ||
371 arp
->ar_pro
!= htons(ETH_P_IP
) ||
372 arp
->ar_op
!= htons(ARPOP_REQUEST
))
375 arp_ptr
= (unsigned char *)(arp
+1);
376 /* save the location of the src hw addr */
378 arp_ptr
+= skb
->dev
->addr_len
;
379 memcpy(&sip
, arp_ptr
, 4);
381 /* if we actually cared about dst hw addr, it would get copied here */
382 arp_ptr
+= skb
->dev
->addr_len
;
383 memcpy(&tip
, arp_ptr
, 4);
385 /* Should we ignore arp? */
386 if (tip
!= htonl(np
->local_ip
) || LOOPBACK(tip
) || MULTICAST(tip
))
389 size
= sizeof(struct arphdr
) + 2 * (skb
->dev
->addr_len
+ 4);
390 send_skb
= find_skb(np
, size
+ LL_RESERVED_SPACE(np
->dev
),
391 LL_RESERVED_SPACE(np
->dev
));
396 skb_reset_network_header(send_skb
);
397 arp
= (struct arphdr
*) skb_put(send_skb
, size
);
398 send_skb
->dev
= skb
->dev
;
399 send_skb
->protocol
= htons(ETH_P_ARP
);
401 /* Fill the device header for the ARP frame */
403 if (np
->dev
->hard_header
&&
404 np
->dev
->hard_header(send_skb
, skb
->dev
, ptype
,
406 send_skb
->len
) < 0) {
412 * Fill out the arp protocol part.
414 * we only support ethernet device type,
415 * which (according to RFC 1390) should always equal 1 (Ethernet).
418 arp
->ar_hrd
= htons(np
->dev
->type
);
419 arp
->ar_pro
= htons(ETH_P_IP
);
420 arp
->ar_hln
= np
->dev
->addr_len
;
422 arp
->ar_op
= htons(type
);
424 arp_ptr
=(unsigned char *)(arp
+ 1);
425 memcpy(arp_ptr
, np
->dev
->dev_addr
, np
->dev
->addr_len
);
426 arp_ptr
+= np
->dev
->addr_len
;
427 memcpy(arp_ptr
, &tip
, 4);
429 memcpy(arp_ptr
, sha
, np
->dev
->addr_len
);
430 arp_ptr
+= np
->dev
->addr_len
;
431 memcpy(arp_ptr
, &sip
, 4);
433 netpoll_send_skb(np
, send_skb
);
436 int __netpoll_rx(struct sk_buff
*skb
)
438 int proto
, len
, ulen
;
441 struct netpoll_info
*npi
= skb
->dev
->npinfo
;
442 struct netpoll
*np
= npi
->rx_np
;
446 if (skb
->dev
->type
!= ARPHRD_ETHER
)
449 /* check if netpoll clients need ARP */
450 if (skb
->protocol
== htons(ETH_P_ARP
) &&
451 atomic_read(&trapped
)) {
452 skb_queue_tail(&npi
->arp_tx
, skb
);
456 proto
= ntohs(eth_hdr(skb
)->h_proto
);
457 if (proto
!= ETH_P_IP
)
459 if (skb
->pkt_type
== PACKET_OTHERHOST
)
464 iph
= (struct iphdr
*)skb
->data
;
465 if (!pskb_may_pull(skb
, sizeof(struct iphdr
)))
467 if (iph
->ihl
< 5 || iph
->version
!= 4)
469 if (!pskb_may_pull(skb
, iph
->ihl
*4))
471 if (ip_fast_csum((u8
*)iph
, iph
->ihl
) != 0)
474 len
= ntohs(iph
->tot_len
);
475 if (skb
->len
< len
|| len
< iph
->ihl
*4)
479 * Our transport medium may have padded the buffer out.
480 * Now We trim to the true length of the frame.
482 if (pskb_trim_rcsum(skb
, len
))
485 if (iph
->protocol
!= IPPROTO_UDP
)
489 uh
= (struct udphdr
*)(((char *)iph
) + iph
->ihl
*4);
490 ulen
= ntohs(uh
->len
);
494 if (checksum_udp(skb
, uh
, ulen
, iph
->saddr
, iph
->daddr
))
496 if (np
->local_ip
&& np
->local_ip
!= ntohl(iph
->daddr
))
498 if (np
->remote_ip
&& np
->remote_ip
!= ntohl(iph
->saddr
))
500 if (np
->local_port
&& np
->local_port
!= ntohs(uh
->dest
))
503 np
->rx_hook(np
, ntohs(uh
->source
),
505 ulen
- sizeof(struct udphdr
));
511 if (atomic_read(&trapped
)) {
519 int netpoll_parse_options(struct netpoll
*np
, char *opt
)
521 char *cur
=opt
, *delim
;
524 if ((delim
= strchr(cur
, '@')) == NULL
)
527 np
->local_port
= simple_strtol(cur
, NULL
, 10);
531 printk(KERN_INFO
"%s: local port %d\n", np
->name
, np
->local_port
);
534 if ((delim
= strchr(cur
, '/')) == NULL
)
537 np
->local_ip
= ntohl(in_aton(cur
));
540 printk(KERN_INFO
"%s: local IP %d.%d.%d.%d\n",
541 np
->name
, HIPQUAD(np
->local_ip
));
546 /* parse out dev name */
547 if ((delim
= strchr(cur
, ',')) == NULL
)
550 strlcpy(np
->dev_name
, cur
, sizeof(np
->dev_name
));
555 printk(KERN_INFO
"%s: interface %s\n", np
->name
, np
->dev_name
);
559 if ((delim
= strchr(cur
, '@')) == NULL
)
562 np
->remote_port
= simple_strtol(cur
, NULL
, 10);
566 printk(KERN_INFO
"%s: remote port %d\n", np
->name
, np
->remote_port
);
569 if ((delim
= strchr(cur
, '/')) == NULL
)
572 np
->remote_ip
= ntohl(in_aton(cur
));
575 printk(KERN_INFO
"%s: remote IP %d.%d.%d.%d\n",
576 np
->name
, HIPQUAD(np
->remote_ip
));
580 if ((delim
= strchr(cur
, ':')) == NULL
)
583 np
->remote_mac
[0] = simple_strtol(cur
, NULL
, 16);
585 if ((delim
= strchr(cur
, ':')) == NULL
)
588 np
->remote_mac
[1] = simple_strtol(cur
, NULL
, 16);
590 if ((delim
= strchr(cur
, ':')) == NULL
)
593 np
->remote_mac
[2] = simple_strtol(cur
, NULL
, 16);
595 if ((delim
= strchr(cur
, ':')) == NULL
)
598 np
->remote_mac
[3] = simple_strtol(cur
, NULL
, 16);
600 if ((delim
= strchr(cur
, ':')) == NULL
)
603 np
->remote_mac
[4] = simple_strtol(cur
, NULL
, 16);
605 np
->remote_mac
[5] = simple_strtol(cur
, NULL
, 16);
608 printk(KERN_INFO
"%s: remote ethernet address "
609 "%02x:%02x:%02x:%02x:%02x:%02x\n",
621 printk(KERN_INFO
"%s: couldn't parse config at %s!\n",
626 int netpoll_setup(struct netpoll
*np
)
628 struct net_device
*ndev
= NULL
;
629 struct in_device
*in_dev
;
630 struct netpoll_info
*npinfo
;
635 ndev
= dev_get_by_name(np
->dev_name
);
637 printk(KERN_ERR
"%s: %s doesn't exist, aborting.\n",
638 np
->name
, np
->dev_name
);
644 npinfo
= kmalloc(sizeof(*npinfo
), GFP_KERNEL
);
650 npinfo
->rx_flags
= 0;
651 npinfo
->rx_np
= NULL
;
652 spin_lock_init(&npinfo
->poll_lock
);
653 npinfo
->poll_owner
= -1;
655 spin_lock_init(&npinfo
->rx_lock
);
656 skb_queue_head_init(&npinfo
->arp_tx
);
657 skb_queue_head_init(&npinfo
->txq
);
658 INIT_DELAYED_WORK(&npinfo
->tx_work
, queue_process
);
660 atomic_set(&npinfo
->refcnt
, 1);
662 npinfo
= ndev
->npinfo
;
663 atomic_inc(&npinfo
->refcnt
);
666 if (!ndev
->poll_controller
) {
667 printk(KERN_ERR
"%s: %s doesn't support polling, aborting.\n",
668 np
->name
, np
->dev_name
);
673 if (!netif_running(ndev
)) {
674 unsigned long atmost
, atleast
;
676 printk(KERN_INFO
"%s: device %s not up yet, forcing it\n",
677 np
->name
, np
->dev_name
);
680 err
= dev_open(ndev
);
684 printk(KERN_ERR
"%s: failed to open %s\n",
685 np
->name
, ndev
->name
);
689 atleast
= jiffies
+ HZ
/10;
690 atmost
= jiffies
+ 4*HZ
;
691 while (!netif_carrier_ok(ndev
)) {
692 if (time_after(jiffies
, atmost
)) {
694 "%s: timeout waiting for carrier\n",
701 /* If carrier appears to come up instantly, we don't
702 * trust it and pause so that we don't pump all our
703 * queued console messages into the bitbucket.
706 if (time_before(jiffies
, atleast
)) {
707 printk(KERN_NOTICE
"%s: carrier detect appears"
708 " untrustworthy, waiting 4 seconds\n",
714 if (is_zero_ether_addr(np
->local_mac
) && ndev
->dev_addr
)
715 memcpy(np
->local_mac
, ndev
->dev_addr
, 6);
719 in_dev
= __in_dev_get_rcu(ndev
);
721 if (!in_dev
|| !in_dev
->ifa_list
) {
723 printk(KERN_ERR
"%s: no IP address for %s, aborting\n",
724 np
->name
, np
->dev_name
);
729 np
->local_ip
= ntohl(in_dev
->ifa_list
->ifa_local
);
731 printk(KERN_INFO
"%s: local IP %d.%d.%d.%d\n",
732 np
->name
, HIPQUAD(np
->local_ip
));
736 spin_lock_irqsave(&npinfo
->rx_lock
, flags
);
737 npinfo
->rx_flags
|= NETPOLL_RX_ENABLED
;
739 spin_unlock_irqrestore(&npinfo
->rx_lock
, flags
);
742 /* fill up the skb queue */
745 /* last thing to do is link it to the net device structure */
746 ndev
->npinfo
= npinfo
;
748 /* avoid racing with NAPI reading npinfo */
761 static int __init
netpoll_init(void)
763 skb_queue_head_init(&skb_pool
);
766 core_initcall(netpoll_init
);
768 void netpoll_cleanup(struct netpoll
*np
)
770 struct netpoll_info
*npinfo
;
774 npinfo
= np
->dev
->npinfo
;
776 if (npinfo
->rx_np
== np
) {
777 spin_lock_irqsave(&npinfo
->rx_lock
, flags
);
778 npinfo
->rx_np
= NULL
;
779 npinfo
->rx_flags
&= ~NETPOLL_RX_ENABLED
;
780 spin_unlock_irqrestore(&npinfo
->rx_lock
, flags
);
783 np
->dev
->npinfo
= NULL
;
784 if (atomic_dec_and_test(&npinfo
->refcnt
)) {
785 skb_queue_purge(&npinfo
->arp_tx
);
786 skb_queue_purge(&npinfo
->txq
);
787 cancel_rearming_delayed_work(&npinfo
->tx_work
);
788 flush_scheduled_work();
800 int netpoll_trap(void)
802 return atomic_read(&trapped
);
805 void netpoll_set_trap(int trap
)
808 atomic_inc(&trapped
);
810 atomic_dec(&trapped
);
813 EXPORT_SYMBOL(netpoll_set_trap
);
814 EXPORT_SYMBOL(netpoll_trap
);
815 EXPORT_SYMBOL(netpoll_parse_options
);
816 EXPORT_SYMBOL(netpoll_setup
);
817 EXPORT_SYMBOL(netpoll_cleanup
);
818 EXPORT_SYMBOL(netpoll_send_udp
);
819 EXPORT_SYMBOL(netpoll_poll
);