1457f4436SAndrii Nakryiko #include <linux/bpf.h> 2457f4436SAndrii Nakryiko #include <linux/btf.h> 3457f4436SAndrii Nakryiko #include <linux/err.h> 4457f4436SAndrii Nakryiko #include <linux/irq_work.h> 5457f4436SAndrii Nakryiko #include <linux/slab.h> 6457f4436SAndrii Nakryiko #include <linux/filter.h> 7457f4436SAndrii Nakryiko #include <linux/mm.h> 8457f4436SAndrii Nakryiko #include <linux/vmalloc.h> 9457f4436SAndrii Nakryiko #include <linux/wait.h> 10457f4436SAndrii Nakryiko #include <linux/poll.h> 11ccff81e1SRustam Kovhaev #include <linux/kmemleak.h> 12457f4436SAndrii Nakryiko #include <uapi/linux/btf.h> 13c317ab71SMenglong Dong #include <linux/btf_ids.h> 14457f4436SAndrii Nakryiko 15457f4436SAndrii Nakryiko #define RINGBUF_CREATE_FLAG_MASK (BPF_F_NUMA_NODE) 16457f4436SAndrii Nakryiko 17457f4436SAndrii Nakryiko /* non-mmap()'able part of bpf_ringbuf (everything up to consumer page) */ 18457f4436SAndrii Nakryiko #define RINGBUF_PGOFF \ 19457f4436SAndrii Nakryiko (offsetof(struct bpf_ringbuf, consumer_pos) >> PAGE_SHIFT) 20457f4436SAndrii Nakryiko /* consumer page and producer page */ 21457f4436SAndrii Nakryiko #define RINGBUF_POS_PAGES 2 22457f4436SAndrii Nakryiko 23457f4436SAndrii Nakryiko #define RINGBUF_MAX_RECORD_SZ (UINT_MAX/4) 24457f4436SAndrii Nakryiko 25457f4436SAndrii Nakryiko /* Maximum size of ring buffer area is limited by 32-bit page offset within 26457f4436SAndrii Nakryiko * record header, counted in pages. Reserve 8 bits for extensibility, and take 27457f4436SAndrii Nakryiko * into account few extra pages for consumer/producer pages and 28457f4436SAndrii Nakryiko * non-mmap()'able parts. This gives 64GB limit, which seems plenty for single 29457f4436SAndrii Nakryiko * ring buffer. 30457f4436SAndrii Nakryiko */ 31457f4436SAndrii Nakryiko #define RINGBUF_MAX_DATA_SZ \ 32457f4436SAndrii Nakryiko (((1ULL << 24) - RINGBUF_POS_PAGES - RINGBUF_PGOFF) * PAGE_SIZE) 33457f4436SAndrii Nakryiko 34457f4436SAndrii Nakryiko struct bpf_ringbuf { 35457f4436SAndrii Nakryiko wait_queue_head_t waitq; 36457f4436SAndrii Nakryiko struct irq_work work; 37457f4436SAndrii Nakryiko u64 mask; 38457f4436SAndrii Nakryiko struct page **pages; 39457f4436SAndrii Nakryiko int nr_pages; 40457f4436SAndrii Nakryiko spinlock_t spinlock ____cacheline_aligned_in_smp; 41457f4436SAndrii Nakryiko /* Consumer and producer counters are put into separate pages to allow 42457f4436SAndrii Nakryiko * mapping consumer page as r/w, but restrict producer page to r/o. 43457f4436SAndrii Nakryiko * This protects producer position from being modified by user-space 44457f4436SAndrii Nakryiko * application and ruining in-kernel position tracking. 45457f4436SAndrii Nakryiko */ 46457f4436SAndrii Nakryiko unsigned long consumer_pos __aligned(PAGE_SIZE); 47457f4436SAndrii Nakryiko unsigned long producer_pos __aligned(PAGE_SIZE); 48457f4436SAndrii Nakryiko char data[] __aligned(PAGE_SIZE); 49457f4436SAndrii Nakryiko }; 50457f4436SAndrii Nakryiko 51457f4436SAndrii Nakryiko struct bpf_ringbuf_map { 52457f4436SAndrii Nakryiko struct bpf_map map; 53457f4436SAndrii Nakryiko struct bpf_ringbuf *rb; 54457f4436SAndrii Nakryiko }; 55457f4436SAndrii Nakryiko 56457f4436SAndrii Nakryiko /* 8-byte ring buffer record header structure */ 57457f4436SAndrii Nakryiko struct bpf_ringbuf_hdr { 58457f4436SAndrii Nakryiko u32 len; 59457f4436SAndrii Nakryiko u32 pg_off; 60457f4436SAndrii Nakryiko }; 61457f4436SAndrii Nakryiko 62457f4436SAndrii Nakryiko static struct bpf_ringbuf *bpf_ringbuf_area_alloc(size_t data_sz, int numa_node) 63457f4436SAndrii Nakryiko { 64be4035c7SRoman Gushchin const gfp_t flags = GFP_KERNEL_ACCOUNT | __GFP_RETRY_MAYFAIL | 65be4035c7SRoman Gushchin __GFP_NOWARN | __GFP_ZERO; 66457f4436SAndrii Nakryiko int nr_meta_pages = RINGBUF_PGOFF + RINGBUF_POS_PAGES; 67457f4436SAndrii Nakryiko int nr_data_pages = data_sz >> PAGE_SHIFT; 68457f4436SAndrii Nakryiko int nr_pages = nr_meta_pages + nr_data_pages; 69457f4436SAndrii Nakryiko struct page **pages, *page; 70457f4436SAndrii Nakryiko struct bpf_ringbuf *rb; 71457f4436SAndrii Nakryiko size_t array_size; 72457f4436SAndrii Nakryiko int i; 73457f4436SAndrii Nakryiko 74457f4436SAndrii Nakryiko /* Each data page is mapped twice to allow "virtual" 75457f4436SAndrii Nakryiko * continuous read of samples wrapping around the end of ring 76457f4436SAndrii Nakryiko * buffer area: 77457f4436SAndrii Nakryiko * ------------------------------------------------------ 78457f4436SAndrii Nakryiko * | meta pages | real data pages | same data pages | 79457f4436SAndrii Nakryiko * ------------------------------------------------------ 80457f4436SAndrii Nakryiko * | | 1 2 3 4 5 6 7 8 9 | 1 2 3 4 5 6 7 8 9 | 81457f4436SAndrii Nakryiko * ------------------------------------------------------ 82457f4436SAndrii Nakryiko * | | TA DA | TA DA | 83457f4436SAndrii Nakryiko * ------------------------------------------------------ 84457f4436SAndrii Nakryiko * ^^^^^^^ 85457f4436SAndrii Nakryiko * | 86457f4436SAndrii Nakryiko * Here, no need to worry about special handling of wrapped-around 87457f4436SAndrii Nakryiko * data due to double-mapped data pages. This works both in kernel and 88457f4436SAndrii Nakryiko * when mmap()'ed in user-space, simplifying both kernel and 89457f4436SAndrii Nakryiko * user-space implementations significantly. 90457f4436SAndrii Nakryiko */ 91457f4436SAndrii Nakryiko array_size = (nr_meta_pages + 2 * nr_data_pages) * sizeof(*pages); 92be4035c7SRoman Gushchin pages = bpf_map_area_alloc(array_size, numa_node); 93457f4436SAndrii Nakryiko if (!pages) 94457f4436SAndrii Nakryiko return NULL; 95457f4436SAndrii Nakryiko 96457f4436SAndrii Nakryiko for (i = 0; i < nr_pages; i++) { 97457f4436SAndrii Nakryiko page = alloc_pages_node(numa_node, flags, 0); 98457f4436SAndrii Nakryiko if (!page) { 99457f4436SAndrii Nakryiko nr_pages = i; 100457f4436SAndrii Nakryiko goto err_free_pages; 101457f4436SAndrii Nakryiko } 102457f4436SAndrii Nakryiko pages[i] = page; 103457f4436SAndrii Nakryiko if (i >= nr_meta_pages) 104457f4436SAndrii Nakryiko pages[nr_data_pages + i] = page; 105457f4436SAndrii Nakryiko } 106457f4436SAndrii Nakryiko 107457f4436SAndrii Nakryiko rb = vmap(pages, nr_meta_pages + 2 * nr_data_pages, 108b293dcc4SHou Tao VM_MAP | VM_USERMAP, PAGE_KERNEL); 109457f4436SAndrii Nakryiko if (rb) { 110ccff81e1SRustam Kovhaev kmemleak_not_leak(pages); 111457f4436SAndrii Nakryiko rb->pages = pages; 112457f4436SAndrii Nakryiko rb->nr_pages = nr_pages; 113457f4436SAndrii Nakryiko return rb; 114457f4436SAndrii Nakryiko } 115457f4436SAndrii Nakryiko 116457f4436SAndrii Nakryiko err_free_pages: 117457f4436SAndrii Nakryiko for (i = 0; i < nr_pages; i++) 118457f4436SAndrii Nakryiko __free_page(pages[i]); 119457f4436SAndrii Nakryiko kvfree(pages); 120457f4436SAndrii Nakryiko return NULL; 121457f4436SAndrii Nakryiko } 122457f4436SAndrii Nakryiko 123457f4436SAndrii Nakryiko static void bpf_ringbuf_notify(struct irq_work *work) 124457f4436SAndrii Nakryiko { 125457f4436SAndrii Nakryiko struct bpf_ringbuf *rb = container_of(work, struct bpf_ringbuf, work); 126457f4436SAndrii Nakryiko 127457f4436SAndrii Nakryiko wake_up_all(&rb->waitq); 128457f4436SAndrii Nakryiko } 129457f4436SAndrii Nakryiko 130457f4436SAndrii Nakryiko static struct bpf_ringbuf *bpf_ringbuf_alloc(size_t data_sz, int numa_node) 131457f4436SAndrii Nakryiko { 132457f4436SAndrii Nakryiko struct bpf_ringbuf *rb; 133457f4436SAndrii Nakryiko 134457f4436SAndrii Nakryiko rb = bpf_ringbuf_area_alloc(data_sz, numa_node); 135457f4436SAndrii Nakryiko if (!rb) 136abbdd081SRoman Gushchin return NULL; 137457f4436SAndrii Nakryiko 138457f4436SAndrii Nakryiko spin_lock_init(&rb->spinlock); 139457f4436SAndrii Nakryiko init_waitqueue_head(&rb->waitq); 140457f4436SAndrii Nakryiko init_irq_work(&rb->work, bpf_ringbuf_notify); 141457f4436SAndrii Nakryiko 142457f4436SAndrii Nakryiko rb->mask = data_sz - 1; 143457f4436SAndrii Nakryiko rb->consumer_pos = 0; 144457f4436SAndrii Nakryiko rb->producer_pos = 0; 145457f4436SAndrii Nakryiko 146457f4436SAndrii Nakryiko return rb; 147457f4436SAndrii Nakryiko } 148457f4436SAndrii Nakryiko 149457f4436SAndrii Nakryiko static struct bpf_map *ringbuf_map_alloc(union bpf_attr *attr) 150457f4436SAndrii Nakryiko { 151457f4436SAndrii Nakryiko struct bpf_ringbuf_map *rb_map; 152457f4436SAndrii Nakryiko 153457f4436SAndrii Nakryiko if (attr->map_flags & ~RINGBUF_CREATE_FLAG_MASK) 154457f4436SAndrii Nakryiko return ERR_PTR(-EINVAL); 155457f4436SAndrii Nakryiko 156457f4436SAndrii Nakryiko if (attr->key_size || attr->value_size || 157517bbe19SAndrii Nakryiko !is_power_of_2(attr->max_entries) || 158517bbe19SAndrii Nakryiko !PAGE_ALIGNED(attr->max_entries)) 159457f4436SAndrii Nakryiko return ERR_PTR(-EINVAL); 160457f4436SAndrii Nakryiko 161517bbe19SAndrii Nakryiko #ifdef CONFIG_64BIT 162517bbe19SAndrii Nakryiko /* on 32-bit arch, it's impossible to overflow record's hdr->pgoff */ 163517bbe19SAndrii Nakryiko if (attr->max_entries > RINGBUF_MAX_DATA_SZ) 164517bbe19SAndrii Nakryiko return ERR_PTR(-E2BIG); 165517bbe19SAndrii Nakryiko #endif 166517bbe19SAndrii Nakryiko 167be4035c7SRoman Gushchin rb_map = kzalloc(sizeof(*rb_map), GFP_USER | __GFP_ACCOUNT); 168457f4436SAndrii Nakryiko if (!rb_map) 169457f4436SAndrii Nakryiko return ERR_PTR(-ENOMEM); 170457f4436SAndrii Nakryiko 171457f4436SAndrii Nakryiko bpf_map_init_from_attr(&rb_map->map, attr); 172457f4436SAndrii Nakryiko 173457f4436SAndrii Nakryiko rb_map->rb = bpf_ringbuf_alloc(attr->max_entries, rb_map->map.numa_node); 174abbdd081SRoman Gushchin if (!rb_map->rb) { 175abbdd081SRoman Gushchin kfree(rb_map); 176abbdd081SRoman Gushchin return ERR_PTR(-ENOMEM); 177457f4436SAndrii Nakryiko } 178457f4436SAndrii Nakryiko 179457f4436SAndrii Nakryiko return &rb_map->map; 180457f4436SAndrii Nakryiko } 181457f4436SAndrii Nakryiko 182457f4436SAndrii Nakryiko static void bpf_ringbuf_free(struct bpf_ringbuf *rb) 183457f4436SAndrii Nakryiko { 184457f4436SAndrii Nakryiko /* copy pages pointer and nr_pages to local variable, as we are going 185457f4436SAndrii Nakryiko * to unmap rb itself with vunmap() below 186457f4436SAndrii Nakryiko */ 187457f4436SAndrii Nakryiko struct page **pages = rb->pages; 188457f4436SAndrii Nakryiko int i, nr_pages = rb->nr_pages; 189457f4436SAndrii Nakryiko 190457f4436SAndrii Nakryiko vunmap(rb); 191457f4436SAndrii Nakryiko for (i = 0; i < nr_pages; i++) 192457f4436SAndrii Nakryiko __free_page(pages[i]); 193457f4436SAndrii Nakryiko kvfree(pages); 194457f4436SAndrii Nakryiko } 195457f4436SAndrii Nakryiko 196457f4436SAndrii Nakryiko static void ringbuf_map_free(struct bpf_map *map) 197457f4436SAndrii Nakryiko { 198457f4436SAndrii Nakryiko struct bpf_ringbuf_map *rb_map; 199457f4436SAndrii Nakryiko 200457f4436SAndrii Nakryiko rb_map = container_of(map, struct bpf_ringbuf_map, map); 201457f4436SAndrii Nakryiko bpf_ringbuf_free(rb_map->rb); 202457f4436SAndrii Nakryiko kfree(rb_map); 203457f4436SAndrii Nakryiko } 204457f4436SAndrii Nakryiko 205457f4436SAndrii Nakryiko static void *ringbuf_map_lookup_elem(struct bpf_map *map, void *key) 206457f4436SAndrii Nakryiko { 207457f4436SAndrii Nakryiko return ERR_PTR(-ENOTSUPP); 208457f4436SAndrii Nakryiko } 209457f4436SAndrii Nakryiko 210457f4436SAndrii Nakryiko static int ringbuf_map_update_elem(struct bpf_map *map, void *key, void *value, 211457f4436SAndrii Nakryiko u64 flags) 212457f4436SAndrii Nakryiko { 213457f4436SAndrii Nakryiko return -ENOTSUPP; 214457f4436SAndrii Nakryiko } 215457f4436SAndrii Nakryiko 216457f4436SAndrii Nakryiko static int ringbuf_map_delete_elem(struct bpf_map *map, void *key) 217457f4436SAndrii Nakryiko { 218457f4436SAndrii Nakryiko return -ENOTSUPP; 219457f4436SAndrii Nakryiko } 220457f4436SAndrii Nakryiko 221457f4436SAndrii Nakryiko static int ringbuf_map_get_next_key(struct bpf_map *map, void *key, 222457f4436SAndrii Nakryiko void *next_key) 223457f4436SAndrii Nakryiko { 224457f4436SAndrii Nakryiko return -ENOTSUPP; 225457f4436SAndrii Nakryiko } 226457f4436SAndrii Nakryiko 227457f4436SAndrii Nakryiko static int ringbuf_map_mmap(struct bpf_map *map, struct vm_area_struct *vma) 228457f4436SAndrii Nakryiko { 229457f4436SAndrii Nakryiko struct bpf_ringbuf_map *rb_map; 230457f4436SAndrii Nakryiko 231457f4436SAndrii Nakryiko rb_map = container_of(map, struct bpf_ringbuf_map, map); 232457f4436SAndrii Nakryiko 23304ea3086SAndrii Nakryiko if (vma->vm_flags & VM_WRITE) { 23404ea3086SAndrii Nakryiko /* allow writable mapping for the consumer_pos only */ 23504ea3086SAndrii Nakryiko if (vma->vm_pgoff != 0 || vma->vm_end - vma->vm_start != PAGE_SIZE) 23604ea3086SAndrii Nakryiko return -EPERM; 23704ea3086SAndrii Nakryiko } else { 23804ea3086SAndrii Nakryiko vma->vm_flags &= ~VM_MAYWRITE; 23904ea3086SAndrii Nakryiko } 24004ea3086SAndrii Nakryiko /* remap_vmalloc_range() checks size and offset constraints */ 241457f4436SAndrii Nakryiko return remap_vmalloc_range(vma, rb_map->rb, 242457f4436SAndrii Nakryiko vma->vm_pgoff + RINGBUF_PGOFF); 243457f4436SAndrii Nakryiko } 244457f4436SAndrii Nakryiko 245457f4436SAndrii Nakryiko static unsigned long ringbuf_avail_data_sz(struct bpf_ringbuf *rb) 246457f4436SAndrii Nakryiko { 247457f4436SAndrii Nakryiko unsigned long cons_pos, prod_pos; 248457f4436SAndrii Nakryiko 249457f4436SAndrii Nakryiko cons_pos = smp_load_acquire(&rb->consumer_pos); 250457f4436SAndrii Nakryiko prod_pos = smp_load_acquire(&rb->producer_pos); 251457f4436SAndrii Nakryiko return prod_pos - cons_pos; 252457f4436SAndrii Nakryiko } 253457f4436SAndrii Nakryiko 254457f4436SAndrii Nakryiko static __poll_t ringbuf_map_poll(struct bpf_map *map, struct file *filp, 255457f4436SAndrii Nakryiko struct poll_table_struct *pts) 256457f4436SAndrii Nakryiko { 257457f4436SAndrii Nakryiko struct bpf_ringbuf_map *rb_map; 258457f4436SAndrii Nakryiko 259457f4436SAndrii Nakryiko rb_map = container_of(map, struct bpf_ringbuf_map, map); 260457f4436SAndrii Nakryiko poll_wait(filp, &rb_map->rb->waitq, pts); 261457f4436SAndrii Nakryiko 262457f4436SAndrii Nakryiko if (ringbuf_avail_data_sz(rb_map->rb)) 263457f4436SAndrii Nakryiko return EPOLLIN | EPOLLRDNORM; 264457f4436SAndrii Nakryiko return 0; 265457f4436SAndrii Nakryiko } 266457f4436SAndrii Nakryiko 267c317ab71SMenglong Dong BTF_ID_LIST_SINGLE(ringbuf_map_btf_ids, struct, bpf_ringbuf_map) 268457f4436SAndrii Nakryiko const struct bpf_map_ops ringbuf_map_ops = { 269f4d05259SMartin KaFai Lau .map_meta_equal = bpf_map_meta_equal, 270457f4436SAndrii Nakryiko .map_alloc = ringbuf_map_alloc, 271457f4436SAndrii Nakryiko .map_free = ringbuf_map_free, 272457f4436SAndrii Nakryiko .map_mmap = ringbuf_map_mmap, 273457f4436SAndrii Nakryiko .map_poll = ringbuf_map_poll, 274457f4436SAndrii Nakryiko .map_lookup_elem = ringbuf_map_lookup_elem, 275457f4436SAndrii Nakryiko .map_update_elem = ringbuf_map_update_elem, 276457f4436SAndrii Nakryiko .map_delete_elem = ringbuf_map_delete_elem, 277457f4436SAndrii Nakryiko .map_get_next_key = ringbuf_map_get_next_key, 278c317ab71SMenglong Dong .map_btf_id = &ringbuf_map_btf_ids[0], 279457f4436SAndrii Nakryiko }; 280457f4436SAndrii Nakryiko 281457f4436SAndrii Nakryiko /* Given pointer to ring buffer record metadata and struct bpf_ringbuf itself, 282457f4436SAndrii Nakryiko * calculate offset from record metadata to ring buffer in pages, rounded 283457f4436SAndrii Nakryiko * down. This page offset is stored as part of record metadata and allows to 284457f4436SAndrii Nakryiko * restore struct bpf_ringbuf * from record pointer. This page offset is 285457f4436SAndrii Nakryiko * stored at offset 4 of record metadata header. 286457f4436SAndrii Nakryiko */ 287457f4436SAndrii Nakryiko static size_t bpf_ringbuf_rec_pg_off(struct bpf_ringbuf *rb, 288457f4436SAndrii Nakryiko struct bpf_ringbuf_hdr *hdr) 289457f4436SAndrii Nakryiko { 290457f4436SAndrii Nakryiko return ((void *)hdr - (void *)rb) >> PAGE_SHIFT; 291457f4436SAndrii Nakryiko } 292457f4436SAndrii Nakryiko 293457f4436SAndrii Nakryiko /* Given pointer to ring buffer record header, restore pointer to struct 294457f4436SAndrii Nakryiko * bpf_ringbuf itself by using page offset stored at offset 4 295457f4436SAndrii Nakryiko */ 296457f4436SAndrii Nakryiko static struct bpf_ringbuf * 297457f4436SAndrii Nakryiko bpf_ringbuf_restore_from_rec(struct bpf_ringbuf_hdr *hdr) 298457f4436SAndrii Nakryiko { 299457f4436SAndrii Nakryiko unsigned long addr = (unsigned long)(void *)hdr; 300457f4436SAndrii Nakryiko unsigned long off = (unsigned long)hdr->pg_off << PAGE_SHIFT; 301457f4436SAndrii Nakryiko 302457f4436SAndrii Nakryiko return (void*)((addr & PAGE_MASK) - off); 303457f4436SAndrii Nakryiko } 304457f4436SAndrii Nakryiko 305457f4436SAndrii Nakryiko static void *__bpf_ringbuf_reserve(struct bpf_ringbuf *rb, u64 size) 306457f4436SAndrii Nakryiko { 307457f4436SAndrii Nakryiko unsigned long cons_pos, prod_pos, new_prod_pos, flags; 308457f4436SAndrii Nakryiko u32 len, pg_off; 309457f4436SAndrii Nakryiko struct bpf_ringbuf_hdr *hdr; 310457f4436SAndrii Nakryiko 311457f4436SAndrii Nakryiko if (unlikely(size > RINGBUF_MAX_RECORD_SZ)) 312457f4436SAndrii Nakryiko return NULL; 313457f4436SAndrii Nakryiko 314457f4436SAndrii Nakryiko len = round_up(size + BPF_RINGBUF_HDR_SZ, 8); 3154b81ccebSThadeu Lima de Souza Cascardo if (len > rb->mask + 1) 3164b81ccebSThadeu Lima de Souza Cascardo return NULL; 3174b81ccebSThadeu Lima de Souza Cascardo 318457f4436SAndrii Nakryiko cons_pos = smp_load_acquire(&rb->consumer_pos); 319457f4436SAndrii Nakryiko 320457f4436SAndrii Nakryiko if (in_nmi()) { 321457f4436SAndrii Nakryiko if (!spin_trylock_irqsave(&rb->spinlock, flags)) 322457f4436SAndrii Nakryiko return NULL; 323457f4436SAndrii Nakryiko } else { 324457f4436SAndrii Nakryiko spin_lock_irqsave(&rb->spinlock, flags); 325457f4436SAndrii Nakryiko } 326457f4436SAndrii Nakryiko 327457f4436SAndrii Nakryiko prod_pos = rb->producer_pos; 328457f4436SAndrii Nakryiko new_prod_pos = prod_pos + len; 329457f4436SAndrii Nakryiko 330457f4436SAndrii Nakryiko /* check for out of ringbuf space by ensuring producer position 331457f4436SAndrii Nakryiko * doesn't advance more than (ringbuf_size - 1) ahead 332457f4436SAndrii Nakryiko */ 333457f4436SAndrii Nakryiko if (new_prod_pos - cons_pos > rb->mask) { 334457f4436SAndrii Nakryiko spin_unlock_irqrestore(&rb->spinlock, flags); 335457f4436SAndrii Nakryiko return NULL; 336457f4436SAndrii Nakryiko } 337457f4436SAndrii Nakryiko 338457f4436SAndrii Nakryiko hdr = (void *)rb->data + (prod_pos & rb->mask); 339457f4436SAndrii Nakryiko pg_off = bpf_ringbuf_rec_pg_off(rb, hdr); 340457f4436SAndrii Nakryiko hdr->len = size | BPF_RINGBUF_BUSY_BIT; 341457f4436SAndrii Nakryiko hdr->pg_off = pg_off; 342457f4436SAndrii Nakryiko 343457f4436SAndrii Nakryiko /* pairs with consumer's smp_load_acquire() */ 344457f4436SAndrii Nakryiko smp_store_release(&rb->producer_pos, new_prod_pos); 345457f4436SAndrii Nakryiko 346457f4436SAndrii Nakryiko spin_unlock_irqrestore(&rb->spinlock, flags); 347457f4436SAndrii Nakryiko 348457f4436SAndrii Nakryiko return (void *)hdr + BPF_RINGBUF_HDR_SZ; 349457f4436SAndrii Nakryiko } 350457f4436SAndrii Nakryiko 351457f4436SAndrii Nakryiko BPF_CALL_3(bpf_ringbuf_reserve, struct bpf_map *, map, u64, size, u64, flags) 352457f4436SAndrii Nakryiko { 353457f4436SAndrii Nakryiko struct bpf_ringbuf_map *rb_map; 354457f4436SAndrii Nakryiko 355457f4436SAndrii Nakryiko if (unlikely(flags)) 356457f4436SAndrii Nakryiko return 0; 357457f4436SAndrii Nakryiko 358457f4436SAndrii Nakryiko rb_map = container_of(map, struct bpf_ringbuf_map, map); 359457f4436SAndrii Nakryiko return (unsigned long)__bpf_ringbuf_reserve(rb_map->rb, size); 360457f4436SAndrii Nakryiko } 361457f4436SAndrii Nakryiko 362457f4436SAndrii Nakryiko const struct bpf_func_proto bpf_ringbuf_reserve_proto = { 363457f4436SAndrii Nakryiko .func = bpf_ringbuf_reserve, 364457f4436SAndrii Nakryiko .ret_type = RET_PTR_TO_ALLOC_MEM_OR_NULL, 365457f4436SAndrii Nakryiko .arg1_type = ARG_CONST_MAP_PTR, 366457f4436SAndrii Nakryiko .arg2_type = ARG_CONST_ALLOC_SIZE_OR_ZERO, 367457f4436SAndrii Nakryiko .arg3_type = ARG_ANYTHING, 368457f4436SAndrii Nakryiko }; 369457f4436SAndrii Nakryiko 370457f4436SAndrii Nakryiko static void bpf_ringbuf_commit(void *sample, u64 flags, bool discard) 371457f4436SAndrii Nakryiko { 372457f4436SAndrii Nakryiko unsigned long rec_pos, cons_pos; 373457f4436SAndrii Nakryiko struct bpf_ringbuf_hdr *hdr; 374457f4436SAndrii Nakryiko struct bpf_ringbuf *rb; 375457f4436SAndrii Nakryiko u32 new_len; 376457f4436SAndrii Nakryiko 377457f4436SAndrii Nakryiko hdr = sample - BPF_RINGBUF_HDR_SZ; 378457f4436SAndrii Nakryiko rb = bpf_ringbuf_restore_from_rec(hdr); 379457f4436SAndrii Nakryiko new_len = hdr->len ^ BPF_RINGBUF_BUSY_BIT; 380457f4436SAndrii Nakryiko if (discard) 381457f4436SAndrii Nakryiko new_len |= BPF_RINGBUF_DISCARD_BIT; 382457f4436SAndrii Nakryiko 383457f4436SAndrii Nakryiko /* update record header with correct final size prefix */ 384457f4436SAndrii Nakryiko xchg(&hdr->len, new_len); 385457f4436SAndrii Nakryiko 386457f4436SAndrii Nakryiko /* if consumer caught up and is waiting for our record, notify about 387457f4436SAndrii Nakryiko * new data availability 388457f4436SAndrii Nakryiko */ 389457f4436SAndrii Nakryiko rec_pos = (void *)hdr - (void *)rb->data; 390457f4436SAndrii Nakryiko cons_pos = smp_load_acquire(&rb->consumer_pos) & rb->mask; 391457f4436SAndrii Nakryiko 392457f4436SAndrii Nakryiko if (flags & BPF_RB_FORCE_WAKEUP) 393457f4436SAndrii Nakryiko irq_work_queue(&rb->work); 394457f4436SAndrii Nakryiko else if (cons_pos == rec_pos && !(flags & BPF_RB_NO_WAKEUP)) 395457f4436SAndrii Nakryiko irq_work_queue(&rb->work); 396457f4436SAndrii Nakryiko } 397457f4436SAndrii Nakryiko 398457f4436SAndrii Nakryiko BPF_CALL_2(bpf_ringbuf_submit, void *, sample, u64, flags) 399457f4436SAndrii Nakryiko { 400457f4436SAndrii Nakryiko bpf_ringbuf_commit(sample, flags, false /* discard */); 401457f4436SAndrii Nakryiko return 0; 402457f4436SAndrii Nakryiko } 403457f4436SAndrii Nakryiko 404457f4436SAndrii Nakryiko const struct bpf_func_proto bpf_ringbuf_submit_proto = { 405457f4436SAndrii Nakryiko .func = bpf_ringbuf_submit, 406457f4436SAndrii Nakryiko .ret_type = RET_VOID, 4078f14852eSKumar Kartikeya Dwivedi .arg1_type = ARG_PTR_TO_ALLOC_MEM | OBJ_RELEASE, 408457f4436SAndrii Nakryiko .arg2_type = ARG_ANYTHING, 409457f4436SAndrii Nakryiko }; 410457f4436SAndrii Nakryiko 411457f4436SAndrii Nakryiko BPF_CALL_2(bpf_ringbuf_discard, void *, sample, u64, flags) 412457f4436SAndrii Nakryiko { 413457f4436SAndrii Nakryiko bpf_ringbuf_commit(sample, flags, true /* discard */); 414457f4436SAndrii Nakryiko return 0; 415457f4436SAndrii Nakryiko } 416457f4436SAndrii Nakryiko 417457f4436SAndrii Nakryiko const struct bpf_func_proto bpf_ringbuf_discard_proto = { 418457f4436SAndrii Nakryiko .func = bpf_ringbuf_discard, 419457f4436SAndrii Nakryiko .ret_type = RET_VOID, 4208f14852eSKumar Kartikeya Dwivedi .arg1_type = ARG_PTR_TO_ALLOC_MEM | OBJ_RELEASE, 421457f4436SAndrii Nakryiko .arg2_type = ARG_ANYTHING, 422457f4436SAndrii Nakryiko }; 423457f4436SAndrii Nakryiko 424457f4436SAndrii Nakryiko BPF_CALL_4(bpf_ringbuf_output, struct bpf_map *, map, void *, data, u64, size, 425457f4436SAndrii Nakryiko u64, flags) 426457f4436SAndrii Nakryiko { 427457f4436SAndrii Nakryiko struct bpf_ringbuf_map *rb_map; 428457f4436SAndrii Nakryiko void *rec; 429457f4436SAndrii Nakryiko 430457f4436SAndrii Nakryiko if (unlikely(flags & ~(BPF_RB_NO_WAKEUP | BPF_RB_FORCE_WAKEUP))) 431457f4436SAndrii Nakryiko return -EINVAL; 432457f4436SAndrii Nakryiko 433457f4436SAndrii Nakryiko rb_map = container_of(map, struct bpf_ringbuf_map, map); 434457f4436SAndrii Nakryiko rec = __bpf_ringbuf_reserve(rb_map->rb, size); 435457f4436SAndrii Nakryiko if (!rec) 436457f4436SAndrii Nakryiko return -EAGAIN; 437457f4436SAndrii Nakryiko 438457f4436SAndrii Nakryiko memcpy(rec, data, size); 439457f4436SAndrii Nakryiko bpf_ringbuf_commit(rec, flags, false /* discard */); 440457f4436SAndrii Nakryiko return 0; 441457f4436SAndrii Nakryiko } 442457f4436SAndrii Nakryiko 443457f4436SAndrii Nakryiko const struct bpf_func_proto bpf_ringbuf_output_proto = { 444457f4436SAndrii Nakryiko .func = bpf_ringbuf_output, 445457f4436SAndrii Nakryiko .ret_type = RET_INTEGER, 446457f4436SAndrii Nakryiko .arg1_type = ARG_CONST_MAP_PTR, 447216e3cd2SHao Luo .arg2_type = ARG_PTR_TO_MEM | MEM_RDONLY, 448457f4436SAndrii Nakryiko .arg3_type = ARG_CONST_SIZE_OR_ZERO, 449457f4436SAndrii Nakryiko .arg4_type = ARG_ANYTHING, 450457f4436SAndrii Nakryiko }; 451457f4436SAndrii Nakryiko 452457f4436SAndrii Nakryiko BPF_CALL_2(bpf_ringbuf_query, struct bpf_map *, map, u64, flags) 453457f4436SAndrii Nakryiko { 454457f4436SAndrii Nakryiko struct bpf_ringbuf *rb; 455457f4436SAndrii Nakryiko 456457f4436SAndrii Nakryiko rb = container_of(map, struct bpf_ringbuf_map, map)->rb; 457457f4436SAndrii Nakryiko 458457f4436SAndrii Nakryiko switch (flags) { 459457f4436SAndrii Nakryiko case BPF_RB_AVAIL_DATA: 460457f4436SAndrii Nakryiko return ringbuf_avail_data_sz(rb); 461457f4436SAndrii Nakryiko case BPF_RB_RING_SIZE: 462457f4436SAndrii Nakryiko return rb->mask + 1; 463457f4436SAndrii Nakryiko case BPF_RB_CONS_POS: 464457f4436SAndrii Nakryiko return smp_load_acquire(&rb->consumer_pos); 465457f4436SAndrii Nakryiko case BPF_RB_PROD_POS: 466457f4436SAndrii Nakryiko return smp_load_acquire(&rb->producer_pos); 467457f4436SAndrii Nakryiko default: 468457f4436SAndrii Nakryiko return 0; 469457f4436SAndrii Nakryiko } 470457f4436SAndrii Nakryiko } 471457f4436SAndrii Nakryiko 472457f4436SAndrii Nakryiko const struct bpf_func_proto bpf_ringbuf_query_proto = { 473457f4436SAndrii Nakryiko .func = bpf_ringbuf_query, 474457f4436SAndrii Nakryiko .ret_type = RET_INTEGER, 475457f4436SAndrii Nakryiko .arg1_type = ARG_CONST_MAP_PTR, 476457f4436SAndrii Nakryiko .arg2_type = ARG_ANYTHING, 477457f4436SAndrii Nakryiko }; 478*bc34dee6SJoanne Koong 479*bc34dee6SJoanne Koong BPF_CALL_4(bpf_ringbuf_reserve_dynptr, struct bpf_map *, map, u32, size, u64, flags, 480*bc34dee6SJoanne Koong struct bpf_dynptr_kern *, ptr) 481*bc34dee6SJoanne Koong { 482*bc34dee6SJoanne Koong struct bpf_ringbuf_map *rb_map; 483*bc34dee6SJoanne Koong void *sample; 484*bc34dee6SJoanne Koong int err; 485*bc34dee6SJoanne Koong 486*bc34dee6SJoanne Koong if (unlikely(flags)) { 487*bc34dee6SJoanne Koong bpf_dynptr_set_null(ptr); 488*bc34dee6SJoanne Koong return -EINVAL; 489*bc34dee6SJoanne Koong } 490*bc34dee6SJoanne Koong 491*bc34dee6SJoanne Koong err = bpf_dynptr_check_size(size); 492*bc34dee6SJoanne Koong if (err) { 493*bc34dee6SJoanne Koong bpf_dynptr_set_null(ptr); 494*bc34dee6SJoanne Koong return err; 495*bc34dee6SJoanne Koong } 496*bc34dee6SJoanne Koong 497*bc34dee6SJoanne Koong rb_map = container_of(map, struct bpf_ringbuf_map, map); 498*bc34dee6SJoanne Koong 499*bc34dee6SJoanne Koong sample = __bpf_ringbuf_reserve(rb_map->rb, size); 500*bc34dee6SJoanne Koong if (!sample) { 501*bc34dee6SJoanne Koong bpf_dynptr_set_null(ptr); 502*bc34dee6SJoanne Koong return -EINVAL; 503*bc34dee6SJoanne Koong } 504*bc34dee6SJoanne Koong 505*bc34dee6SJoanne Koong bpf_dynptr_init(ptr, sample, BPF_DYNPTR_TYPE_RINGBUF, 0, size); 506*bc34dee6SJoanne Koong 507*bc34dee6SJoanne Koong return 0; 508*bc34dee6SJoanne Koong } 509*bc34dee6SJoanne Koong 510*bc34dee6SJoanne Koong const struct bpf_func_proto bpf_ringbuf_reserve_dynptr_proto = { 511*bc34dee6SJoanne Koong .func = bpf_ringbuf_reserve_dynptr, 512*bc34dee6SJoanne Koong .ret_type = RET_INTEGER, 513*bc34dee6SJoanne Koong .arg1_type = ARG_CONST_MAP_PTR, 514*bc34dee6SJoanne Koong .arg2_type = ARG_ANYTHING, 515*bc34dee6SJoanne Koong .arg3_type = ARG_ANYTHING, 516*bc34dee6SJoanne Koong .arg4_type = ARG_PTR_TO_DYNPTR | DYNPTR_TYPE_RINGBUF | MEM_UNINIT, 517*bc34dee6SJoanne Koong }; 518*bc34dee6SJoanne Koong 519*bc34dee6SJoanne Koong BPF_CALL_2(bpf_ringbuf_submit_dynptr, struct bpf_dynptr_kern *, ptr, u64, flags) 520*bc34dee6SJoanne Koong { 521*bc34dee6SJoanne Koong if (!ptr->data) 522*bc34dee6SJoanne Koong return 0; 523*bc34dee6SJoanne Koong 524*bc34dee6SJoanne Koong bpf_ringbuf_commit(ptr->data, flags, false /* discard */); 525*bc34dee6SJoanne Koong 526*bc34dee6SJoanne Koong bpf_dynptr_set_null(ptr); 527*bc34dee6SJoanne Koong 528*bc34dee6SJoanne Koong return 0; 529*bc34dee6SJoanne Koong } 530*bc34dee6SJoanne Koong 531*bc34dee6SJoanne Koong const struct bpf_func_proto bpf_ringbuf_submit_dynptr_proto = { 532*bc34dee6SJoanne Koong .func = bpf_ringbuf_submit_dynptr, 533*bc34dee6SJoanne Koong .ret_type = RET_VOID, 534*bc34dee6SJoanne Koong .arg1_type = ARG_PTR_TO_DYNPTR | DYNPTR_TYPE_RINGBUF | OBJ_RELEASE, 535*bc34dee6SJoanne Koong .arg2_type = ARG_ANYTHING, 536*bc34dee6SJoanne Koong }; 537*bc34dee6SJoanne Koong 538*bc34dee6SJoanne Koong BPF_CALL_2(bpf_ringbuf_discard_dynptr, struct bpf_dynptr_kern *, ptr, u64, flags) 539*bc34dee6SJoanne Koong { 540*bc34dee6SJoanne Koong if (!ptr->data) 541*bc34dee6SJoanne Koong return 0; 542*bc34dee6SJoanne Koong 543*bc34dee6SJoanne Koong bpf_ringbuf_commit(ptr->data, flags, true /* discard */); 544*bc34dee6SJoanne Koong 545*bc34dee6SJoanne Koong bpf_dynptr_set_null(ptr); 546*bc34dee6SJoanne Koong 547*bc34dee6SJoanne Koong return 0; 548*bc34dee6SJoanne Koong } 549*bc34dee6SJoanne Koong 550*bc34dee6SJoanne Koong const struct bpf_func_proto bpf_ringbuf_discard_dynptr_proto = { 551*bc34dee6SJoanne Koong .func = bpf_ringbuf_discard_dynptr, 552*bc34dee6SJoanne Koong .ret_type = RET_VOID, 553*bc34dee6SJoanne Koong .arg1_type = ARG_PTR_TO_DYNPTR | DYNPTR_TYPE_RINGBUF | OBJ_RELEASE, 554*bc34dee6SJoanne Koong .arg2_type = ARG_ANYTHING, 555*bc34dee6SJoanne Koong }; 556