LXR linux/include/linux/netpoll.h

   1/* SPDX-License-Identifier: GPL-2.0 */
   2/*
   3 * Common code for low-level network console, dump, and debugger code
   4 *
   5 * Derived from netconsole, kgdb-over-ethernet, and netdump patches
   6 */
   7
   8#ifndef _LINUX_NETPOLL_H
   9#define _LINUX_NETPOLL_H
  10
  11#include <linux/netdevice.h>
  12#include <linux/interrupt.h>
  13#include <linux/rcupdate.h>
  14#include <linux/list.h>
  15#include <linux/refcount.h>
  16
  17union inet_addr {
  18        __u32           all[4];
  19        __be32          ip;
  20        __be32          ip6[4];
  21        struct in_addr  in;
  22        struct in6_addr in6;
  23};
  24
  25struct netpoll {
  26        struct net_device *dev;
  27        char dev_name[IFNAMSIZ];
  28        const char *name;
  29
  30        union inet_addr local_ip, remote_ip;
  31        bool ipv6;
  32        u16 local_port, remote_port;
  33        u8 remote_mac[ETH_ALEN];
  34};
  35
  36struct netpoll_info {
  37        refcount_t refcnt;
  38
  39        struct semaphore dev_lock;
  40
  41        struct sk_buff_head txq;
  42
  43        struct delayed_work tx_work;
  44
  45        struct netpoll *netpoll;
  46        struct rcu_head rcu;
  47};
  48
  49#ifdef CONFIG_NETPOLL
  50void netpoll_poll_dev(struct net_device *dev);
  51void netpoll_poll_disable(struct net_device *dev);
  52void netpoll_poll_enable(struct net_device *dev);
  53#else
  54static inline void netpoll_poll_disable(struct net_device *dev) { return; }
  55static inline void netpoll_poll_enable(struct net_device *dev) { return; }
  56#endif
  57
  58void netpoll_send_udp(struct netpoll *np, const char *msg, int len);
  59void netpoll_print_options(struct netpoll *np);
  60int netpoll_parse_options(struct netpoll *np, char *opt);
  61int __netpoll_setup(struct netpoll *np, struct net_device *ndev);
  62int netpoll_setup(struct netpoll *np);
  63void __netpoll_cleanup(struct netpoll *np);
  64void __netpoll_free(struct netpoll *np);
  65void netpoll_cleanup(struct netpoll *np);
  66void netpoll_send_skb_on_dev(struct netpoll *np, struct sk_buff *skb,
  67                             struct net_device *dev);
  68static inline void netpoll_send_skb(struct netpoll *np, struct sk_buff *skb)
  69{
  70        unsigned long flags;
  71        local_irq_save(flags);
  72        netpoll_send_skb_on_dev(np, skb, np->dev);
  73        local_irq_restore(flags);
  74}
  75
  76#ifdef CONFIG_NETPOLL
  77static inline void *netpoll_poll_lock(struct napi_struct *napi)
  78{
  79        struct net_device *dev = napi->dev;
  80
  81        if (dev && dev->npinfo) {
  82                int owner = smp_processor_id();
  83
  84                while (cmpxchg(&napi->poll_owner, -1, owner) != -1)
  85                        cpu_relax();
  86
  87                return napi;
  88        }
  89        return NULL;
  90}
  91
  92static inline void netpoll_poll_unlock(void *have)
  93{
  94        struct napi_struct *napi = have;
  95
  96        if (napi)
  97                smp_store_release(&napi->poll_owner, -1);
  98}
  99
 100static inline bool netpoll_tx_running(struct net_device *dev)
 101{
 102        return irqs_disabled();
 103}
 104
 105#else
 106static inline void *netpoll_poll_lock(struct napi_struct *napi)
 107{
 108        return NULL;
 109}
 110static inline void netpoll_poll_unlock(void *have)
 111{
 112}
 113static inline void netpoll_netdev_init(struct net_device *dev)
 114{
 115}
 116static inline bool netpoll_tx_running(struct net_device *dev)
 117{
 118        return false;
 119}
 120#endif
 121
 122#endif
 123