Commit bf99c936 authored by Andrii Nakryiko's avatar Andrii Nakryiko Committed by Alexei Starovoitov
Browse files

libbpf: Add BPF ring buffer support 



Declaring and instantiating BPF ring buffer doesn't require any changes to
libbpf, as it's just another type of maps. So using existing BTF-defined maps
syntax with __uint(type, BPF_MAP_TYPE_RINGBUF) and __uint(max_elements,
<size-of-ring-buf>) is all that's necessary to create and use BPF ring buffer.

This patch adds BPF ring buffer consumer to libbpf. It is very similar to
perf_buffer implementation in terms of API, but also attempts to fix some
minor problems and inconveniences with existing perf_buffer API.

ring_buffer support both single ring buffer use case (with just using
ring_buffer__new()), as well as allows to add more ring buffers, each with its
own callback and context. This allows to efficiently poll and consume
multiple, potentially completely independent, ring buffers, using single
epoll instance.

The latter is actually a problem in practice for applications
that are using multiple sets of perf buffers. They have to create multiple
instances for struct perf_buffer and poll them independently or in a loop,
each approach having its own problems (e.g., inability to use a common poll
timeout). struct ring_buffer eliminates this problem by aggregating many
independent ring buffer instances under the single "ring buffer manager".

Second, perf_buffer's callback can't return error, so applications that need
to stop polling due to error in data or data signalling the end, have to use
extra mechanisms to signal that polling has to stop. ring_buffer's callback
can return error, which will be passed through back to user code and can be
acted upon appropariately.

Two APIs allow to consume ring buffer data:
  - ring_buffer__poll(), which will wait for data availability notification
    and will consume data only from reported ring buffer(s); this API allows
    to efficiently use resources by reading data only when it becomes
    available;
  - ring_buffer__consume(), will attempt to read new records regardless of
    data availablity notification sub-system. This API is useful for cases
    when lowest latency is required, in expense of burning CPU resources.

Signed-off-by: default avatarAndrii Nakryiko <andriin@fb.com>
Signed-off-by: default avatarDaniel Borkmann <daniel@iogearbox.net>
Link: https://lore.kernel.org/bpf/20200529075424.3139988-3-andriin@fb.com


Signed-off-by: default avatarAlexei Starovoitov <ast@kernel.org>
parent 457f4436

tools/lib/bpf/Build

+1 −1
Original line number Diff line number Diff line 
libbpf-y := libbpf.o bpf.o nlattr.o btf.o libbpf_errno.o str_error.o \

	    netlink.o bpf_prog_linfo.o libbpf_probes.o xsk.o hashmap.o \

	    btf_dump.o
 
	    btf_dump.o ringbuf.o

tools/lib/bpf/libbpf.h

+21 −0
Original line number Diff line number Diff line
@@ -478,6 +478,27 @@ LIBBPF_API int bpf_get_link_xdp_id(int ifindex, __u32 *prog_id, __u32 flags); 
LIBBPF_API int bpf_get_link_xdp_info(int ifindex, struct xdp_link_info *info,

				     size_t info_size, __u32 flags);



/* Ring buffer APIs */

struct ring_buffer;



typedef int (*ring_buffer_sample_fn)(void *ctx, void *data, size_t size);



struct ring_buffer_opts {

	size_t sz; /* size of this struct, for forward/backward compatiblity */

};



#define ring_buffer_opts__last_field sz



LIBBPF_API struct ring_buffer *

ring_buffer__new(int map_fd, ring_buffer_sample_fn sample_cb, void *ctx,

		 const struct ring_buffer_opts *opts);

LIBBPF_API void ring_buffer__free(struct ring_buffer *rb);

LIBBPF_API int ring_buffer__add(struct ring_buffer *rb, int map_fd,

				ring_buffer_sample_fn sample_cb, void *ctx);

LIBBPF_API int ring_buffer__poll(struct ring_buffer *rb, int timeout_ms);

LIBBPF_API int ring_buffer__consume(struct ring_buffer *rb);



/* Perf buffer APIs */

struct perf_buffer;



typedef void (*perf_buffer_sample_fn)(void *ctx, int cpu,

tools/lib/bpf/libbpf.map

+5 −0
Original line number Diff line number Diff line
@@ -263,4 +263,9 @@ LIBBPF_0.0.9 { 
		bpf_link_get_next_id;

		bpf_program__attach_iter;

		perf_buffer__consume;

		ring_buffer__add;

		ring_buffer__consume;

		ring_buffer__free;

		ring_buffer__new;

		ring_buffer__poll;

} LIBBPF_0.0.8;

tools/lib/bpf/libbpf_probes.c

+5 −0
Original line number Diff line number Diff line
@@ -238,6 +238,11 @@ bool bpf_probe_map_type(enum bpf_map_type map_type, __u32 ifindex) 
		if (btf_fd < 0)

			return false;

		break;

	case BPF_MAP_TYPE_RINGBUF:

		key_size = 0;

		value_size = 0;

		max_entries = 4096;

		break;

	case BPF_MAP_TYPE_UNSPEC:

	case BPF_MAP_TYPE_HASH:

	case BPF_MAP_TYPE_ARRAY:

tools/lib/bpf/ringbuf.c

0 → 100644
+285 −0
Original line number Diff line number Diff line 
// SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause)

/*

 * Ring buffer operations.

 *

 * Copyright (C) 2020 Facebook, Inc.

 */

#include <stdlib.h>

#include <stdio.h>

#include <errno.h>

#include <unistd.h>

#include <linux/err.h>

#include <linux/bpf.h>

#include <asm/barrier.h>

#include <sys/mman.h>

#include <sys/epoll.h>

#include <tools/libc_compat.h>



#include "libbpf.h"

#include "libbpf_internal.h"

#include "bpf.h"



/* make sure libbpf doesn't use kernel-only integer typedefs */

#pragma GCC poison u8 u16 u32 u64 s8 s16 s32 s64



struct ring {

	ring_buffer_sample_fn sample_cb;

	void *ctx;

	void *data;

	unsigned long *consumer_pos;

	unsigned long *producer_pos;

	unsigned long mask;

	int map_fd;

};



struct ring_buffer {

	struct epoll_event *events;

	struct ring *rings;

	size_t page_size;

	int epoll_fd;

	int ring_cnt;

};



static void ringbuf_unmap_ring(struct ring_buffer *rb, struct ring *r)

{

	if (r->consumer_pos) {

		munmap(r->consumer_pos, rb->page_size);

		r->consumer_pos = NULL;

	}

	if (r->producer_pos) {

		munmap(r->producer_pos, rb->page_size + 2 * (r->mask + 1));

		r->producer_pos = NULL;

	}

}



/* Add extra RINGBUF maps to this ring buffer manager */

int ring_buffer__add(struct ring_buffer *rb, int map_fd,

		     ring_buffer_sample_fn sample_cb, void *ctx)

{

	struct bpf_map_info info;

	__u32 len = sizeof(info);

	struct epoll_event *e;

	struct ring *r;

	void *tmp;

	int err;



	memset(&info, 0, sizeof(info));



	err = bpf_obj_get_info_by_fd(map_fd, &info, &len);

	if (err) {

		err = -errno;

		pr_warn("ringbuf: failed to get map info for fd=%d: %d\n",

			map_fd, err);

		return err;

	}



	if (info.type != BPF_MAP_TYPE_RINGBUF) {

		pr_warn("ringbuf: map fd=%d is not BPF_MAP_TYPE_RINGBUF\n",

			map_fd);

		return -EINVAL;

	}



	tmp = reallocarray(rb->rings, rb->ring_cnt + 1, sizeof(*rb->rings));

	if (!tmp)

		return -ENOMEM;

	rb->rings = tmp;



	tmp = reallocarray(rb->events, rb->ring_cnt + 1, sizeof(*rb->events));

	if (!tmp)

		return -ENOMEM;

	rb->events = tmp;



	r = &rb->rings[rb->ring_cnt];

	memset(r, 0, sizeof(*r));



	r->map_fd = map_fd;

	r->sample_cb = sample_cb;

	r->ctx = ctx;

	r->mask = info.max_entries - 1;



	/* Map writable consumer page */

	tmp = mmap(NULL, rb->page_size, PROT_READ | PROT_WRITE, MAP_SHARED,

		   map_fd, 0);

	if (tmp == MAP_FAILED) {

		err = -errno;

		pr_warn("ringbuf: failed to mmap consumer page for map fd=%d: %d\n",

			map_fd, err);

		return err;

	}

	r->consumer_pos = tmp;



	/* Map read-only producer page and data pages. We map twice as big

	 * data size to allow simple reading of samples that wrap around the

	 * end of a ring buffer. See kernel implementation for details.

	 * */

	tmp = mmap(NULL, rb->page_size + 2 * info.max_entries, PROT_READ,

		   MAP_SHARED, map_fd, rb->page_size);

	if (tmp == MAP_FAILED) {

		err = -errno;

		ringbuf_unmap_ring(rb, r);

		pr_warn("ringbuf: failed to mmap data pages for map fd=%d: %d\n",

			map_fd, err);

		return err;

	}

	r->producer_pos = tmp;

	r->data = tmp + rb->page_size;



	e = &rb->events[rb->ring_cnt];

	memset(e, 0, sizeof(*e));



	e->events = EPOLLIN;

	e->data.fd = rb->ring_cnt;

	if (epoll_ctl(rb->epoll_fd, EPOLL_CTL_ADD, map_fd, e) < 0) {

		err = -errno;

		ringbuf_unmap_ring(rb, r);

		pr_warn("ringbuf: failed to epoll add map fd=%d: %d\n",

			map_fd, err);

		return err;

	}



	rb->ring_cnt++;

	return 0;

}



void ring_buffer__free(struct ring_buffer *rb)

{

	int i;



	if (!rb)

		return;



	for (i = 0; i < rb->ring_cnt; ++i)

		ringbuf_unmap_ring(rb, &rb->rings[i]);

	if (rb->epoll_fd >= 0)

		close(rb->epoll_fd);



	free(rb->events);

	free(rb->rings);

	free(rb);

}



struct ring_buffer *

ring_buffer__new(int map_fd, ring_buffer_sample_fn sample_cb, void *ctx,

		 const struct ring_buffer_opts *opts)

{

	struct ring_buffer *rb;

	int err;



	if (!OPTS_VALID(opts, ring_buffer_opts))

		return NULL;



	rb = calloc(1, sizeof(*rb));

	if (!rb)

		return NULL;



	rb->page_size = getpagesize();



	rb->epoll_fd = epoll_create1(EPOLL_CLOEXEC);

	if (rb->epoll_fd < 0) {

		err = -errno;

		pr_warn("ringbuf: failed to create epoll instance: %d\n", err);

		goto err_out;

	}



	err = ring_buffer__add(rb, map_fd, sample_cb, ctx);

	if (err)

		goto err_out;



	return rb;



err_out:

	ring_buffer__free(rb);

	return NULL;

}



static inline int roundup_len(__u32 len)

{

	/* clear out top 2 bits (discard and busy, if set) */

	len <<= 2;

	len >>= 2;

	/* add length prefix */

	len += BPF_RINGBUF_HDR_SZ;

	/* round up to 8 byte alignment */

	return (len + 7) / 8 * 8;

}



static int ringbuf_process_ring(struct ring* r)

{

	int *len_ptr, len, err, cnt = 0;

	unsigned long cons_pos, prod_pos;

	bool got_new_data;

	void *sample;



	cons_pos = smp_load_acquire(r->consumer_pos);

	do {

		got_new_data = false;

		prod_pos = smp_load_acquire(r->producer_pos);

		while (cons_pos < prod_pos) {

			len_ptr = r->data + (cons_pos & r->mask);

			len = smp_load_acquire(len_ptr);



			/* sample not committed yet, bail out for now */

			if (len & BPF_RINGBUF_BUSY_BIT)

				goto done;



			got_new_data = true;

			cons_pos += roundup_len(len);



			if ((len & BPF_RINGBUF_DISCARD_BIT) == 0) {

				sample = (void *)len_ptr + BPF_RINGBUF_HDR_SZ;

				err = r->sample_cb(r->ctx, sample, len);

				if (err) {

					/* update consumer pos and bail out */

					smp_store_release(r->consumer_pos,

							  cons_pos);

					return err;

				}

				cnt++;

			}



			smp_store_release(r->consumer_pos, cons_pos);

		}

	} while (got_new_data);

done:

	return cnt;

}



/* Consume available ring buffer(s) data without event polling.

 * Returns number of records consumed across all registered ring buffers, or

 * negative number if any of the callbacks return error.

 */

int ring_buffer__consume(struct ring_buffer *rb)

{

	int i, err, res = 0;



	for (i = 0; i < rb->ring_cnt; i++) {

		struct ring *ring = &rb->rings[i];



		err = ringbuf_process_ring(ring);

		if (err < 0)

			return err;

		res += err;

	}

	return res;

}



/* Poll for available data and consume records, if any are available.

 * Returns number of records consumed, or negative number, if any of the

 * registered callbacks returned error.

 */

int ring_buffer__poll(struct ring_buffer *rb, int timeout_ms)

{

	int i, cnt, err, res = 0;



	cnt = epoll_wait(rb->epoll_fd, rb->events, rb->ring_cnt, timeout_ms);

	for (i = 0; i < cnt; i++) {

		__u32 ring_id = rb->events[i].data.fd;

		struct ring *ring = &rb->rings[ring_id];



		err = ringbuf_process_ring(ring);

		if (err < 0)

			return err;

		res += cnt;

	}

	return cnt < 0 ? -errno : res;

}

CRA Git | Maintained and supported by SUSTech CRA and CCSE