include/linux/rolling_buffer.h

Source file repositories/reference/linux-study-clean/include/linux/rolling_buffer.h

File Facts

System
Linux kernel
Corpus path
include/linux/rolling_buffer.h
Extension
.h
Size
2207 bytes
Lines
62
Domain
Core OS
Bucket
Core Kernel Interface
Inferred role
Core OS: implementation source
Status
source implementation candidate

Why This File Exists

Core operating-system implementation surface: boot, tasks, memory, VFS, syscall-facing interfaces, synchronization, credentials, and isolation.

Dependency Surface

Detected Declarations

Annotated Snippet

struct rolling_buffer {
	struct folio_queue	*head;		/* Producer's insertion point */
	struct folio_queue	*tail;		/* Consumer's removal point */
	struct iov_iter		iter;		/* Iterator tracking what's left in the buffer */
	u8			next_head_slot;	/* Next slot in ->head */
	u8			first_tail_slot; /* First slot in ->tail */
};

/*
 * Snapshot of a rolling buffer.
 */
struct rolling_buffer_snapshot {
	struct folio_queue	*curr_folioq;	/* Queue segment in which current folio resides */
	unsigned char		curr_slot;	/* Folio currently being read */
	unsigned char		curr_order;	/* Order of folio */
};

/* Marks to store per-folio in the internal folio_queue structs. */
#define ROLLBUF_MARK_1	BIT(0)
#define ROLLBUF_MARK_2	BIT(1)

int rolling_buffer_init(struct rolling_buffer *roll, unsigned int rreq_id,
			unsigned int direction);
int rolling_buffer_make_space(struct rolling_buffer *roll);
ssize_t rolling_buffer_load_from_ra(struct rolling_buffer *roll,
				    struct readahead_control *ractl,
				    struct folio_batch *put_batch);
ssize_t rolling_buffer_append(struct rolling_buffer *roll, struct folio *folio,
			      unsigned int flags);
struct folio_queue *rolling_buffer_delete_spent(struct rolling_buffer *roll);
void rolling_buffer_clear(struct rolling_buffer *roll);

static inline void rolling_buffer_advance(struct rolling_buffer *roll, size_t amount)
{
	iov_iter_advance(&roll->iter, amount);
}

#endif /* _ROLLING_BUFFER_H */

Annotation

Implementation Notes