include/linux/netpoll.h

   1 /*
   2  * Common code for low-level network console, dump, and debugger code
   3  *
   4  * Derived from netconsole, kgdb-over-ethernet, and netdump patches
   5  */
   6
   7 #ifndef _LINUX_NETPOLL_H
   8 #define _LINUX_NETPOLL_H
   9
  10 #include <linux/netdevice.h>
  11 #include <linux/interrupt.h>
  12 #include <linux/rcupdate.h>
  13 #include <linux/list.h>
  14
  15 struct netpoll {
  16         struct net_device *dev;
  17         char dev_name[IFNAMSIZ];
  18         const char *name;
  19         void (*rx_hook)(struct netpoll *, int, char *, int);
  20
  21         __be32 local_ip, remote_ip;
  22         u16 local_port, remote_port;
  23         u8 remote_mac[ETH_ALEN];
  24
  25         struct list_head rx; /* rx_np list element */
  26         struct rcu_head rcu;
  27 };
  28
  29 struct netpoll_info {
  30         atomic_t refcnt;
  31
  32         int rx_flags;
  33         spinlock_t rx_lock;
  34         struct list_head rx_np; /* netpolls that registered an rx_hook */
  35
  36         struct sk_buff_head arp_tx; /* list of arp requests to reply to */
  37         struct sk_buff_head txq;
  38
  39         struct delayed_work tx_work;
  40
  41         struct netpoll *netpoll;
  42         struct rcu_head rcu;
  43 };
  44
  45 void netpoll_send_udp(struct netpoll *np, const char *msg, int len);
  46 void netpoll_print_options(struct netpoll *np);
  47 int netpoll_parse_options(struct netpoll *np, char *opt);
  48 int __netpoll_setup(struct netpoll *np, struct net_device *ndev, gfp_t gfp);
  49 int netpoll_setup(struct netpoll *np);
  50 int netpoll_trap(void);
  51 void netpoll_set_trap(int trap);
  52 void __netpoll_cleanup(struct netpoll *np);
  53 void __netpoll_free_rcu(struct netpoll *np);
  54 void netpoll_cleanup(struct netpoll *np);
  55 int __netpoll_rx(struct sk_buff *skb);
  56 void netpoll_send_skb_on_dev(struct netpoll *np, struct sk_buff *skb,
  57                              struct net_device *dev);
  58 static inline void netpoll_send_skb(struct netpoll *np, struct sk_buff *skb)
  59 {
  60         netpoll_send_skb_on_dev(np, skb, np->dev);
  61 }
  62
  63
  64
  65 #ifdef CONFIG_NETPOLL
  66 static inline bool netpoll_rx(struct sk_buff *skb)
  67 {
  68         struct netpoll_info *npinfo;
  69         unsigned long flags;
  70         bool ret = false;
  71
  72         local_irq_save(flags);
  73         npinfo = rcu_dereference_bh(skb->dev->npinfo);
  74
  75         if (!npinfo || (list_empty(&npinfo->rx_np) && !npinfo->rx_flags))
  76                 goto out;
  77
  78         spin_lock(&npinfo->rx_lock);
  79         /* check rx_flags again with the lock held */
  80         if (npinfo->rx_flags && __netpoll_rx(skb))
  81                 ret = true;
  82         spin_unlock(&npinfo->rx_lock);
  83
  84 out:
  85         local_irq_restore(flags);
  86         return ret;
  87 }
  88
  89 static inline int netpoll_rx_on(struct sk_buff *skb)
  90 {
  91         struct netpoll_info *npinfo = rcu_dereference_bh(skb->dev->npinfo);
  92
  93         return npinfo && (!list_empty(&npinfo->rx_np) || npinfo->rx_flags);
  94 }
  95
  96 static inline int netpoll_receive_skb(struct sk_buff *skb)
  97 {
  98         if (!list_empty(&skb->dev->napi_list))
  99                 return netpoll_rx(skb);
 100         return 0;
 101 }
 102
 103 static inline void *netpoll_poll_lock(struct napi_struct *napi)
 104 {
 105         struct net_device *dev = napi->dev;
 106
 107         if (dev && dev->npinfo) {
 108                 spin_lock(&napi->poll_lock);
 109                 napi->poll_owner = smp_processor_id();
 110                 return napi;
 111         }
 112         return NULL;
 113 }
 114
 115 static inline void netpoll_poll_unlock(void *have)
 116 {
 117         struct napi_struct *napi = have;
 118
 119         if (napi) {
 120                 napi->poll_owner = -1;
 121                 spin_unlock(&napi->poll_lock);
 122         }
 123 }
 124
 125 static inline int netpoll_tx_running(struct net_device *dev)
 126 {
 127         return irqs_disabled();
 128 }
 129
 130 #else
 131 static inline bool netpoll_rx(struct sk_buff *skb)
 132 {
 133         return 0;
 134 }
 135 static inline int netpoll_rx_on(struct sk_buff *skb)
 136 {
 137         return 0;
 138 }
 139 static inline int netpoll_receive_skb(struct sk_buff *skb)
 140 {
 141         return 0;
 142 }
 143 static inline void *netpoll_poll_lock(struct napi_struct *napi)
 144 {
 145         return NULL;
 146 }
 147 static inline void netpoll_poll_unlock(void *have)
 148 {
 149 }
 150 static inline void netpoll_netdev_init(struct net_device *dev)
 151 {
 152 }
 153 static inline int netpoll_tx_running(struct net_device *dev)
 154 {
 155         return 0;
 156 }
 157 #endif
 158
 159 #endif