include/net/xdp_sock.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /* AF_XDP internal functions
   3  * Copyright(c) 2018 Intel Corporation.
   4  */
   5
   6 #ifndef _LINUX_XDP_SOCK_H
   7 #define _LINUX_XDP_SOCK_H
   8
   9 #include <linux/workqueue.h>
  10 #include <linux/if_xdp.h>
  11 #include <linux/mutex.h>
  12 #include <linux/spinlock.h>
  13 #include <linux/mm.h>
  14 #include <net/sock.h>
  15
  16 struct net_device;
  17 struct xsk_queue;
  18
  19 struct xdp_umem_page {
  20         void *addr;
  21         dma_addr_t dma;
  22 };
  23
  24 struct xdp_umem_fq_reuse {
  25         u32 nentries;
  26         u32 length;
  27         u64 handles[];
  28 };
  29
  30 struct xdp_umem {
  31         struct xsk_queue *fq;
  32         struct xsk_queue *cq;
  33         struct xdp_umem_page *pages;
  34         u64 chunk_mask;
  35         u64 size;
  36         u32 headroom;
  37         u32 chunk_size_nohr;
  38         struct user_struct *user;
  39         unsigned long address;
  40         refcount_t users;
  41         struct work_struct work;
  42         struct page **pgs;
  43         u32 npgs;
  44         int id;
  45         struct net_device *dev;
  46         struct xdp_umem_fq_reuse *fq_reuse;
  47         u16 queue_id;
  48         bool zc;
  49         spinlock_t xsk_list_lock;
  50         struct list_head xsk_list;
  51 };
  52
  53 struct xdp_sock {
  54         /* struct sock must be the first member of struct xdp_sock */
  55         struct sock sk;
  56         struct xsk_queue *rx;
  57         struct net_device *dev;
  58         struct xdp_umem *umem;
  59         struct list_head flush_node;
  60         u16 queue_id;
  61         bool zc;
  62         /* Protects multiple processes in the control path */
  63         struct mutex mutex;
  64         struct xsk_queue *tx ____cacheline_aligned_in_smp;
  65         struct list_head list;
  66         /* Mutual exclusion of NAPI TX thread and sendmsg error paths
  67          * in the SKB destructor callback.
  68          */
  69         spinlock_t tx_completion_lock;
  70         /* Protects generic receive. */
  71         spinlock_t rx_lock;
  72         u64 rx_dropped;
  73 };
  74
  75 struct xdp_buff;
  76 #ifdef CONFIG_XDP_SOCKETS
  77 int xsk_generic_rcv(struct xdp_sock *xs, struct xdp_buff *xdp);
  78 int xsk_rcv(struct xdp_sock *xs, struct xdp_buff *xdp);
  79 void xsk_flush(struct xdp_sock *xs);
  80 bool xsk_is_setup_for_bpf_map(struct xdp_sock *xs);
  81 /* Used from netdev driver */
  82 bool xsk_umem_has_addrs(struct xdp_umem *umem, u32 cnt);
  83 u64 *xsk_umem_peek_addr(struct xdp_umem *umem, u64 *addr);
  84 void xsk_umem_discard_addr(struct xdp_umem *umem);
  85 void xsk_umem_complete_tx(struct xdp_umem *umem, u32 nb_entries);
  86 bool xsk_umem_consume_tx(struct xdp_umem *umem, struct xdp_desc *desc);
  87 void xsk_umem_consume_tx_done(struct xdp_umem *umem);
  88 struct xdp_umem_fq_reuse *xsk_reuseq_prepare(u32 nentries);
  89 struct xdp_umem_fq_reuse *xsk_reuseq_swap(struct xdp_umem *umem,
  90                                           struct xdp_umem_fq_reuse *newq);
  91 void xsk_reuseq_free(struct xdp_umem_fq_reuse *rq);
  92 struct xdp_umem *xdp_get_umem_from_qid(struct net_device *dev, u16 queue_id);
  93
  94 static inline char *xdp_umem_get_data(struct xdp_umem *umem, u64 addr)
  95 {
  96         return umem->pages[addr >> PAGE_SHIFT].addr + (addr & (PAGE_SIZE - 1));
  97 }
  98
  99 static inline dma_addr_t xdp_umem_get_dma(struct xdp_umem *umem, u64 addr)
 100 {
 101         return umem->pages[addr >> PAGE_SHIFT].dma + (addr & (PAGE_SIZE - 1));
 102 }
 103
 104 /* Reuse-queue aware version of FILL queue helpers */
 105 static inline bool xsk_umem_has_addrs_rq(struct xdp_umem *umem, u32 cnt)
 106 {
 107         struct xdp_umem_fq_reuse *rq = umem->fq_reuse;
 108
 109         if (rq->length >= cnt)
 110                 return true;
 111
 112         return xsk_umem_has_addrs(umem, cnt - rq->length);
 113 }
 114
 115 static inline u64 *xsk_umem_peek_addr_rq(struct xdp_umem *umem, u64 *addr)
 116 {
 117         struct xdp_umem_fq_reuse *rq = umem->fq_reuse;
 118
 119         if (!rq->length)
 120                 return xsk_umem_peek_addr(umem, addr);
 121
 122         *addr = rq->handles[rq->length - 1];
 123         return addr;
 124 }
 125
 126 static inline void xsk_umem_discard_addr_rq(struct xdp_umem *umem)
 127 {
 128         struct xdp_umem_fq_reuse *rq = umem->fq_reuse;
 129
 130         if (!rq->length)
 131                 xsk_umem_discard_addr(umem);
 132         else
 133                 rq->length--;
 134 }
 135
 136 static inline void xsk_umem_fq_reuse(struct xdp_umem *umem, u64 addr)
 137 {
 138         struct xdp_umem_fq_reuse *rq = umem->fq_reuse;
 139
 140         rq->handles[rq->length++] = addr;
 141 }
 142 #else
 143 static inline int xsk_generic_rcv(struct xdp_sock *xs, struct xdp_buff *xdp)
 144 {
 145         return -ENOTSUPP;
 146 }
 147
 148 static inline int xsk_rcv(struct xdp_sock *xs, struct xdp_buff *xdp)
 149 {
 150         return -ENOTSUPP;
 151 }
 152
 153 static inline void xsk_flush(struct xdp_sock *xs)
 154 {
 155 }
 156
 157 static inline bool xsk_is_setup_for_bpf_map(struct xdp_sock *xs)
 158 {
 159         return false;
 160 }
 161
 162 static inline bool xsk_umem_has_addrs(struct xdp_umem *umem, u32 cnt)
 163 {
 164         return false;
 165 }
 166
 167 static inline u64 *xsk_umem_peek_addr(struct xdp_umem *umem, u64 *addr)
 168 {
 169         return NULL;
 170 }
 171
 172 static inline void xsk_umem_discard_addr(struct xdp_umem *umem)
 173 {
 174 }
 175
 176 static inline void xsk_umem_complete_tx(struct xdp_umem *umem, u32 nb_entries)
 177 {
 178 }
 179
 180 static inline bool xsk_umem_consume_tx(struct xdp_umem *umem,
 181                                        struct xdp_desc *desc)
 182 {
 183         return false;
 184 }
 185
 186 static inline void xsk_umem_consume_tx_done(struct xdp_umem *umem)
 187 {
 188 }
 189
 190 static inline struct xdp_umem_fq_reuse *xsk_reuseq_prepare(u32 nentries)
 191 {
 192         return NULL;
 193 }
 194
 195 static inline struct xdp_umem_fq_reuse *xsk_reuseq_swap(
 196         struct xdp_umem *umem,
 197         struct xdp_umem_fq_reuse *newq)
 198 {
 199         return NULL;
 200 }
 201 static inline void xsk_reuseq_free(struct xdp_umem_fq_reuse *rq)
 202 {
 203 }
 204
 205 static inline struct xdp_umem *xdp_get_umem_from_qid(struct net_device *dev,
 206                                                      u16 queue_id)
 207 {
 208         return NULL;
 209 }
 210
 211 static inline char *xdp_umem_get_data(struct xdp_umem *umem, u64 addr)
 212 {
 213         return NULL;
 214 }
 215
 216 static inline dma_addr_t xdp_umem_get_dma(struct xdp_umem *umem, u64 addr)
 217 {
 218         return 0;
 219 }
 220
 221 static inline bool xsk_umem_has_addrs_rq(struct xdp_umem *umem, u32 cnt)
 222 {
 223         return false;
 224 }
 225
 226 static inline u64 *xsk_umem_peek_addr_rq(struct xdp_umem *umem, u64 *addr)
 227 {
 228         return NULL;
 229 }
 230
 231 static inline void xsk_umem_discard_addr_rq(struct xdp_umem *umem)
 232 {
 233 }
 234
 235 static inline void xsk_umem_fq_reuse(struct xdp_umem *umem, u64 addr)
 236 {
 237 }
 238
 239 #endif /* CONFIG_XDP_SOCKETS */
 240
 241 #endif /* _LINUX_XDP_SOCK_H */