1c0c77d8fSBjörn Töpel // SPDX-License-Identifier: GPL-2.0 2c0c77d8fSBjörn Töpel /* XDP user-space packet buffer 3c0c77d8fSBjörn Töpel * Copyright(c) 2018 Intel Corporation. 4c0c77d8fSBjörn Töpel */ 5c0c77d8fSBjörn Töpel 6c0c77d8fSBjörn Töpel #include <linux/init.h> 7c0c77d8fSBjörn Töpel #include <linux/sched/mm.h> 8c0c77d8fSBjörn Töpel #include <linux/sched/signal.h> 9c0c77d8fSBjörn Töpel #include <linux/sched/task.h> 10c0c77d8fSBjörn Töpel #include <linux/uaccess.h> 11c0c77d8fSBjörn Töpel #include <linux/slab.h> 12c0c77d8fSBjörn Töpel #include <linux/bpf.h> 13c0c77d8fSBjörn Töpel #include <linux/mm.h> 14c0c77d8fSBjörn Töpel 15c0c77d8fSBjörn Töpel #include "xdp_umem.h" 16e61e62b9SBjörn Töpel #include "xsk_queue.h" 17c0c77d8fSBjörn Töpel 18bbff2f32SBjörn Töpel #define XDP_UMEM_MIN_CHUNK_SIZE 2048 19c0c77d8fSBjörn Töpel 20ac98d8aaSMagnus Karlsson void xdp_add_sk_umem(struct xdp_umem *umem, struct xdp_sock *xs) 21ac98d8aaSMagnus Karlsson { 22ac98d8aaSMagnus Karlsson unsigned long flags; 23ac98d8aaSMagnus Karlsson 24ac98d8aaSMagnus Karlsson spin_lock_irqsave(&umem->xsk_list_lock, flags); 25ac98d8aaSMagnus Karlsson list_add_rcu(&xs->list, &umem->xsk_list); 26ac98d8aaSMagnus Karlsson spin_unlock_irqrestore(&umem->xsk_list_lock, flags); 27ac98d8aaSMagnus Karlsson } 28ac98d8aaSMagnus Karlsson 29ac98d8aaSMagnus Karlsson void xdp_del_sk_umem(struct xdp_umem *umem, struct xdp_sock *xs) 30ac98d8aaSMagnus Karlsson { 31ac98d8aaSMagnus Karlsson unsigned long flags; 32ac98d8aaSMagnus Karlsson 33ac98d8aaSMagnus Karlsson if (xs->dev) { 34ac98d8aaSMagnus Karlsson spin_lock_irqsave(&umem->xsk_list_lock, flags); 35ac98d8aaSMagnus Karlsson list_del_rcu(&xs->list); 36ac98d8aaSMagnus Karlsson spin_unlock_irqrestore(&umem->xsk_list_lock, flags); 37ac98d8aaSMagnus Karlsson 38ac98d8aaSMagnus Karlsson if (umem->zc) 39ac98d8aaSMagnus Karlsson synchronize_net(); 40ac98d8aaSMagnus Karlsson } 41ac98d8aaSMagnus Karlsson } 42ac98d8aaSMagnus Karlsson 43173d3adbSBjörn Töpel int xdp_umem_assign_dev(struct xdp_umem *umem, struct net_device *dev, 44173d3adbSBjörn Töpel u32 queue_id, u16 flags) 45173d3adbSBjörn Töpel { 46173d3adbSBjörn Töpel bool force_zc, force_copy; 47173d3adbSBjörn Töpel struct netdev_bpf bpf; 48173d3adbSBjörn Töpel int err; 49173d3adbSBjörn Töpel 50173d3adbSBjörn Töpel force_zc = flags & XDP_ZEROCOPY; 51173d3adbSBjörn Töpel force_copy = flags & XDP_COPY; 52173d3adbSBjörn Töpel 53173d3adbSBjörn Töpel if (force_zc && force_copy) 54173d3adbSBjörn Töpel return -EINVAL; 55173d3adbSBjörn Töpel 56173d3adbSBjörn Töpel if (force_copy) 57173d3adbSBjörn Töpel return 0; 58173d3adbSBjörn Töpel 59*f734607eSJakub Kicinski if (!dev->netdev_ops->ndo_bpf || !dev->netdev_ops->ndo_xsk_async_xmit) 60*f734607eSJakub Kicinski return force_zc ? -ENOTSUPP : 0; /* fail or fallback */ 61173d3adbSBjörn Töpel 62173d3adbSBjörn Töpel bpf.command = XDP_QUERY_XSK_UMEM; 63173d3adbSBjörn Töpel 64173d3adbSBjörn Töpel rtnl_lock(); 65173d3adbSBjörn Töpel err = dev->netdev_ops->ndo_bpf(dev, &bpf); 66173d3adbSBjörn Töpel rtnl_unlock(); 67173d3adbSBjörn Töpel 68*f734607eSJakub Kicinski if (err) 69173d3adbSBjörn Töpel return force_zc ? -ENOTSUPP : 0; 70173d3adbSBjörn Töpel 71173d3adbSBjörn Töpel bpf.command = XDP_SETUP_XSK_UMEM; 72173d3adbSBjörn Töpel bpf.xsk.umem = umem; 73173d3adbSBjörn Töpel bpf.xsk.queue_id = queue_id; 74173d3adbSBjörn Töpel 75173d3adbSBjörn Töpel rtnl_lock(); 76173d3adbSBjörn Töpel err = dev->netdev_ops->ndo_bpf(dev, &bpf); 77173d3adbSBjörn Töpel rtnl_unlock(); 78173d3adbSBjörn Töpel 79*f734607eSJakub Kicinski if (err) 80173d3adbSBjörn Töpel return force_zc ? err : 0; /* fail or fallback */ 81173d3adbSBjörn Töpel 82*f734607eSJakub Kicinski dev_hold(dev); 83173d3adbSBjörn Töpel umem->dev = dev; 84173d3adbSBjörn Töpel umem->queue_id = queue_id; 85173d3adbSBjörn Töpel umem->zc = true; 86173d3adbSBjörn Töpel return 0; 87173d3adbSBjörn Töpel } 88173d3adbSBjörn Töpel 89ac98d8aaSMagnus Karlsson static void xdp_umem_clear_dev(struct xdp_umem *umem) 90173d3adbSBjörn Töpel { 91173d3adbSBjörn Töpel struct netdev_bpf bpf; 92173d3adbSBjörn Töpel int err; 93173d3adbSBjörn Töpel 94173d3adbSBjörn Töpel if (umem->dev) { 95173d3adbSBjörn Töpel bpf.command = XDP_SETUP_XSK_UMEM; 96173d3adbSBjörn Töpel bpf.xsk.umem = NULL; 97173d3adbSBjörn Töpel bpf.xsk.queue_id = umem->queue_id; 98173d3adbSBjörn Töpel 99173d3adbSBjörn Töpel rtnl_lock(); 100173d3adbSBjörn Töpel err = umem->dev->netdev_ops->ndo_bpf(umem->dev, &bpf); 101173d3adbSBjörn Töpel rtnl_unlock(); 102173d3adbSBjörn Töpel 103173d3adbSBjörn Töpel if (err) 104173d3adbSBjörn Töpel WARN(1, "failed to disable umem!\n"); 105173d3adbSBjörn Töpel 106173d3adbSBjörn Töpel dev_put(umem->dev); 107173d3adbSBjörn Töpel umem->dev = NULL; 108173d3adbSBjörn Töpel } 109173d3adbSBjörn Töpel } 110173d3adbSBjörn Töpel 111c0c77d8fSBjörn Töpel static void xdp_umem_unpin_pages(struct xdp_umem *umem) 112c0c77d8fSBjörn Töpel { 113c0c77d8fSBjörn Töpel unsigned int i; 114c0c77d8fSBjörn Töpel 115c0c77d8fSBjörn Töpel for (i = 0; i < umem->npgs; i++) { 116c0c77d8fSBjörn Töpel struct page *page = umem->pgs[i]; 117c0c77d8fSBjörn Töpel 118c0c77d8fSBjörn Töpel set_page_dirty_lock(page); 119c0c77d8fSBjörn Töpel put_page(page); 120c0c77d8fSBjörn Töpel } 121c0c77d8fSBjörn Töpel 122c0c77d8fSBjörn Töpel kfree(umem->pgs); 123c0c77d8fSBjörn Töpel umem->pgs = NULL; 124c0c77d8fSBjörn Töpel } 125c0c77d8fSBjörn Töpel 126c0c77d8fSBjörn Töpel static void xdp_umem_unaccount_pages(struct xdp_umem *umem) 127c0c77d8fSBjörn Töpel { 128c09290c5SDaniel Borkmann if (umem->user) { 129c0c77d8fSBjörn Töpel atomic_long_sub(umem->npgs, &umem->user->locked_vm); 130c0c77d8fSBjörn Töpel free_uid(umem->user); 131c0c77d8fSBjörn Töpel } 132c09290c5SDaniel Borkmann } 133c0c77d8fSBjörn Töpel 134c0c77d8fSBjörn Töpel static void xdp_umem_release(struct xdp_umem *umem) 135c0c77d8fSBjörn Töpel { 136c0c77d8fSBjörn Töpel struct task_struct *task; 137c0c77d8fSBjörn Töpel struct mm_struct *mm; 138c0c77d8fSBjörn Töpel 139173d3adbSBjörn Töpel xdp_umem_clear_dev(umem); 140173d3adbSBjörn Töpel 141423f3832SMagnus Karlsson if (umem->fq) { 142423f3832SMagnus Karlsson xskq_destroy(umem->fq); 143423f3832SMagnus Karlsson umem->fq = NULL; 144423f3832SMagnus Karlsson } 145423f3832SMagnus Karlsson 146fe230832SMagnus Karlsson if (umem->cq) { 147fe230832SMagnus Karlsson xskq_destroy(umem->cq); 148fe230832SMagnus Karlsson umem->cq = NULL; 149fe230832SMagnus Karlsson } 150fe230832SMagnus Karlsson 151c0c77d8fSBjörn Töpel xdp_umem_unpin_pages(umem); 152c0c77d8fSBjörn Töpel 153c0c77d8fSBjörn Töpel task = get_pid_task(umem->pid, PIDTYPE_PID); 154c0c77d8fSBjörn Töpel put_pid(umem->pid); 155c0c77d8fSBjörn Töpel if (!task) 156c0c77d8fSBjörn Töpel goto out; 157c0c77d8fSBjörn Töpel mm = get_task_mm(task); 158c0c77d8fSBjörn Töpel put_task_struct(task); 159c0c77d8fSBjörn Töpel if (!mm) 160c0c77d8fSBjörn Töpel goto out; 161c0c77d8fSBjörn Töpel 162c0c77d8fSBjörn Töpel mmput(mm); 1638aef7340SBjörn Töpel kfree(umem->pages); 1648aef7340SBjörn Töpel umem->pages = NULL; 1658aef7340SBjörn Töpel 166c0c77d8fSBjörn Töpel xdp_umem_unaccount_pages(umem); 167c0c77d8fSBjörn Töpel out: 168c0c77d8fSBjörn Töpel kfree(umem); 169c0c77d8fSBjörn Töpel } 170c0c77d8fSBjörn Töpel 171c0c77d8fSBjörn Töpel static void xdp_umem_release_deferred(struct work_struct *work) 172c0c77d8fSBjörn Töpel { 173c0c77d8fSBjörn Töpel struct xdp_umem *umem = container_of(work, struct xdp_umem, work); 174c0c77d8fSBjörn Töpel 175c0c77d8fSBjörn Töpel xdp_umem_release(umem); 176c0c77d8fSBjörn Töpel } 177c0c77d8fSBjörn Töpel 178c0c77d8fSBjörn Töpel void xdp_get_umem(struct xdp_umem *umem) 179c0c77d8fSBjörn Töpel { 180d3b42f14SBjörn Töpel refcount_inc(&umem->users); 181c0c77d8fSBjörn Töpel } 182c0c77d8fSBjörn Töpel 183c0c77d8fSBjörn Töpel void xdp_put_umem(struct xdp_umem *umem) 184c0c77d8fSBjörn Töpel { 185c0c77d8fSBjörn Töpel if (!umem) 186c0c77d8fSBjörn Töpel return; 187c0c77d8fSBjörn Töpel 188d3b42f14SBjörn Töpel if (refcount_dec_and_test(&umem->users)) { 189c0c77d8fSBjörn Töpel INIT_WORK(&umem->work, xdp_umem_release_deferred); 190c0c77d8fSBjörn Töpel schedule_work(&umem->work); 191c0c77d8fSBjörn Töpel } 192c0c77d8fSBjörn Töpel } 193c0c77d8fSBjörn Töpel 194c0c77d8fSBjörn Töpel static int xdp_umem_pin_pages(struct xdp_umem *umem) 195c0c77d8fSBjörn Töpel { 196c0c77d8fSBjörn Töpel unsigned int gup_flags = FOLL_WRITE; 197c0c77d8fSBjörn Töpel long npgs; 198c0c77d8fSBjörn Töpel int err; 199c0c77d8fSBjörn Töpel 200a343993cSBjörn Töpel umem->pgs = kcalloc(umem->npgs, sizeof(*umem->pgs), 201a343993cSBjörn Töpel GFP_KERNEL | __GFP_NOWARN); 202c0c77d8fSBjörn Töpel if (!umem->pgs) 203c0c77d8fSBjörn Töpel return -ENOMEM; 204c0c77d8fSBjörn Töpel 205c0c77d8fSBjörn Töpel down_write(¤t->mm->mmap_sem); 206c0c77d8fSBjörn Töpel npgs = get_user_pages(umem->address, umem->npgs, 207c0c77d8fSBjörn Töpel gup_flags, &umem->pgs[0], NULL); 208c0c77d8fSBjörn Töpel up_write(¤t->mm->mmap_sem); 209c0c77d8fSBjörn Töpel 210c0c77d8fSBjörn Töpel if (npgs != umem->npgs) { 211c0c77d8fSBjörn Töpel if (npgs >= 0) { 212c0c77d8fSBjörn Töpel umem->npgs = npgs; 213c0c77d8fSBjörn Töpel err = -ENOMEM; 214c0c77d8fSBjörn Töpel goto out_pin; 215c0c77d8fSBjörn Töpel } 216c0c77d8fSBjörn Töpel err = npgs; 217c0c77d8fSBjörn Töpel goto out_pgs; 218c0c77d8fSBjörn Töpel } 219c0c77d8fSBjörn Töpel return 0; 220c0c77d8fSBjörn Töpel 221c0c77d8fSBjörn Töpel out_pin: 222c0c77d8fSBjörn Töpel xdp_umem_unpin_pages(umem); 223c0c77d8fSBjörn Töpel out_pgs: 224c0c77d8fSBjörn Töpel kfree(umem->pgs); 225c0c77d8fSBjörn Töpel umem->pgs = NULL; 226c0c77d8fSBjörn Töpel return err; 227c0c77d8fSBjörn Töpel } 228c0c77d8fSBjörn Töpel 229c0c77d8fSBjörn Töpel static int xdp_umem_account_pages(struct xdp_umem *umem) 230c0c77d8fSBjörn Töpel { 231c0c77d8fSBjörn Töpel unsigned long lock_limit, new_npgs, old_npgs; 232c0c77d8fSBjörn Töpel 233c0c77d8fSBjörn Töpel if (capable(CAP_IPC_LOCK)) 234c0c77d8fSBjörn Töpel return 0; 235c0c77d8fSBjörn Töpel 236c0c77d8fSBjörn Töpel lock_limit = rlimit(RLIMIT_MEMLOCK) >> PAGE_SHIFT; 237c0c77d8fSBjörn Töpel umem->user = get_uid(current_user()); 238c0c77d8fSBjörn Töpel 239c0c77d8fSBjörn Töpel do { 240c0c77d8fSBjörn Töpel old_npgs = atomic_long_read(&umem->user->locked_vm); 241c0c77d8fSBjörn Töpel new_npgs = old_npgs + umem->npgs; 242c0c77d8fSBjörn Töpel if (new_npgs > lock_limit) { 243c0c77d8fSBjörn Töpel free_uid(umem->user); 244c0c77d8fSBjörn Töpel umem->user = NULL; 245c0c77d8fSBjörn Töpel return -ENOBUFS; 246c0c77d8fSBjörn Töpel } 247c0c77d8fSBjörn Töpel } while (atomic_long_cmpxchg(&umem->user->locked_vm, old_npgs, 248c0c77d8fSBjörn Töpel new_npgs) != old_npgs); 249c0c77d8fSBjörn Töpel return 0; 250c0c77d8fSBjörn Töpel } 251c0c77d8fSBjörn Töpel 252a49049eaSBjörn Töpel static int xdp_umem_reg(struct xdp_umem *umem, struct xdp_umem_reg *mr) 253c0c77d8fSBjörn Töpel { 254bbff2f32SBjörn Töpel u32 chunk_size = mr->chunk_size, headroom = mr->headroom; 255bbff2f32SBjörn Töpel unsigned int chunks, chunks_per_page; 256c0c77d8fSBjörn Töpel u64 addr = mr->addr, size = mr->len; 2578aef7340SBjörn Töpel int size_chk, err, i; 258c0c77d8fSBjörn Töpel 259bbff2f32SBjörn Töpel if (chunk_size < XDP_UMEM_MIN_CHUNK_SIZE || chunk_size > PAGE_SIZE) { 260c0c77d8fSBjörn Töpel /* Strictly speaking we could support this, if: 261c0c77d8fSBjörn Töpel * - huge pages, or* 262c0c77d8fSBjörn Töpel * - using an IOMMU, or 263c0c77d8fSBjörn Töpel * - making sure the memory area is consecutive 264c0c77d8fSBjörn Töpel * but for now, we simply say "computer says no". 265c0c77d8fSBjörn Töpel */ 266c0c77d8fSBjörn Töpel return -EINVAL; 267c0c77d8fSBjörn Töpel } 268c0c77d8fSBjörn Töpel 269bbff2f32SBjörn Töpel if (!is_power_of_2(chunk_size)) 270c0c77d8fSBjörn Töpel return -EINVAL; 271c0c77d8fSBjörn Töpel 272c0c77d8fSBjörn Töpel if (!PAGE_ALIGNED(addr)) { 273c0c77d8fSBjörn Töpel /* Memory area has to be page size aligned. For 274c0c77d8fSBjörn Töpel * simplicity, this might change. 275c0c77d8fSBjörn Töpel */ 276c0c77d8fSBjörn Töpel return -EINVAL; 277c0c77d8fSBjörn Töpel } 278c0c77d8fSBjörn Töpel 279c0c77d8fSBjörn Töpel if ((addr + size) < addr) 280c0c77d8fSBjörn Töpel return -EINVAL; 281c0c77d8fSBjörn Töpel 282bbff2f32SBjörn Töpel chunks = (unsigned int)div_u64(size, chunk_size); 283bbff2f32SBjörn Töpel if (chunks == 0) 284c0c77d8fSBjörn Töpel return -EINVAL; 285c0c77d8fSBjörn Töpel 286bbff2f32SBjörn Töpel chunks_per_page = PAGE_SIZE / chunk_size; 287bbff2f32SBjörn Töpel if (chunks < chunks_per_page || chunks % chunks_per_page) 288c0c77d8fSBjörn Töpel return -EINVAL; 289c0c77d8fSBjörn Töpel 290bbff2f32SBjörn Töpel headroom = ALIGN(headroom, 64); 291c0c77d8fSBjörn Töpel 292bbff2f32SBjörn Töpel size_chk = chunk_size - headroom - XDP_PACKET_HEADROOM; 293c0c77d8fSBjörn Töpel if (size_chk < 0) 294c0c77d8fSBjörn Töpel return -EINVAL; 295c0c77d8fSBjörn Töpel 296c0c77d8fSBjörn Töpel umem->pid = get_task_pid(current, PIDTYPE_PID); 297c0c77d8fSBjörn Töpel umem->address = (unsigned long)addr; 298bbff2f32SBjörn Töpel umem->props.chunk_mask = ~((u64)chunk_size - 1); 299bbff2f32SBjörn Töpel umem->props.size = size; 300bbff2f32SBjörn Töpel umem->headroom = headroom; 301bbff2f32SBjörn Töpel umem->chunk_size_nohr = chunk_size - headroom; 302c0c77d8fSBjörn Töpel umem->npgs = size / PAGE_SIZE; 303c0c77d8fSBjörn Töpel umem->pgs = NULL; 304c0c77d8fSBjörn Töpel umem->user = NULL; 305ac98d8aaSMagnus Karlsson INIT_LIST_HEAD(&umem->xsk_list); 306ac98d8aaSMagnus Karlsson spin_lock_init(&umem->xsk_list_lock); 307c0c77d8fSBjörn Töpel 308d3b42f14SBjörn Töpel refcount_set(&umem->users, 1); 309c0c77d8fSBjörn Töpel 310c0c77d8fSBjörn Töpel err = xdp_umem_account_pages(umem); 311c0c77d8fSBjörn Töpel if (err) 312c0c77d8fSBjörn Töpel goto out; 313c0c77d8fSBjörn Töpel 314c0c77d8fSBjörn Töpel err = xdp_umem_pin_pages(umem); 315c0c77d8fSBjörn Töpel if (err) 316c0c77d8fSBjörn Töpel goto out_account; 3178aef7340SBjörn Töpel 3188aef7340SBjörn Töpel umem->pages = kcalloc(umem->npgs, sizeof(*umem->pages), GFP_KERNEL); 3198aef7340SBjörn Töpel if (!umem->pages) { 3208aef7340SBjörn Töpel err = -ENOMEM; 3218aef7340SBjörn Töpel goto out_account; 3228aef7340SBjörn Töpel } 3238aef7340SBjörn Töpel 3248aef7340SBjörn Töpel for (i = 0; i < umem->npgs; i++) 3258aef7340SBjörn Töpel umem->pages[i].addr = page_address(umem->pgs[i]); 3268aef7340SBjörn Töpel 327c0c77d8fSBjörn Töpel return 0; 328c0c77d8fSBjörn Töpel 329c0c77d8fSBjörn Töpel out_account: 330c0c77d8fSBjörn Töpel xdp_umem_unaccount_pages(umem); 331c0c77d8fSBjörn Töpel out: 332c0c77d8fSBjörn Töpel put_pid(umem->pid); 333c0c77d8fSBjörn Töpel return err; 334c0c77d8fSBjörn Töpel } 335965a9909SMagnus Karlsson 336a49049eaSBjörn Töpel struct xdp_umem *xdp_umem_create(struct xdp_umem_reg *mr) 337a49049eaSBjörn Töpel { 338a49049eaSBjörn Töpel struct xdp_umem *umem; 339a49049eaSBjörn Töpel int err; 340a49049eaSBjörn Töpel 341a49049eaSBjörn Töpel umem = kzalloc(sizeof(*umem), GFP_KERNEL); 342a49049eaSBjörn Töpel if (!umem) 343a49049eaSBjörn Töpel return ERR_PTR(-ENOMEM); 344a49049eaSBjörn Töpel 345a49049eaSBjörn Töpel err = xdp_umem_reg(umem, mr); 346a49049eaSBjörn Töpel if (err) { 347a49049eaSBjörn Töpel kfree(umem); 348a49049eaSBjörn Töpel return ERR_PTR(err); 349a49049eaSBjörn Töpel } 350a49049eaSBjörn Töpel 351a49049eaSBjörn Töpel return umem; 352a49049eaSBjörn Töpel } 353a49049eaSBjörn Töpel 354965a9909SMagnus Karlsson bool xdp_umem_validate_queues(struct xdp_umem *umem) 355965a9909SMagnus Karlsson { 356da60cf00SBjörn Töpel return umem->fq && umem->cq; 357965a9909SMagnus Karlsson } 358