Here we mmap() memory, that is later reported via (rr *ringReader) size() int {} and is publicly accessable via (r *Reader) BufferSize() int {}

I'm not yet sure about the proposed change. Maybe updating the documentation to (r *Reader) BufferSize() int {} could help, as an alternative?

As the person who added BufferSize in #1167, the intent was to return the total amount of data the user could write into the ring buffer. We use this primarily to determine ring buffer utilization in tandem with Remaining.

Here we mmap() memory, that is later reported via (rr *ringReader) size() int {} and is publicly accessable via (r *Reader) BufferSize() int {}

ebpf/ringbuf/ring.go

Line 27 in c959fd7

prod, err := unix.Mmap(mapFD, (int64)(os.Getpagesize()), os.Getpagesize()+2*size, unix.PROT_READ, unix.MAP_SHARED)

I'm not yet sure about the proposed change. Maybe updating the documentation to (r *Reader) BufferSize() int {} could help, as an alternative?

Hey @florianl, in the mmap call we set the size as PAGE_SIZE + 2*size, where size is the max entries specified by the user. The call doubles it because of the unique memory layout of the buffer discussed above. However, the capacity infact is still size.

As Bryce mentioned, BufferSize is used as the total amount of data the buffer can hold, so it should be adjusted according to this.

Thanks all!