fifo_segment.h File Reference

Include dependency graph for fifo_segment.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	fifo_segment_header_t
struct	fifo_segment_t
struct	fifo_segment_main_t
struct	fifo_segment_create_args_t

Macros
#define	FIFO_SEGMENT_MIN_FIFO_SIZE   4096 /* 4kB min fifo size */
#define	FIFO_SEGMENT_MAX_FIFO_SIZE   (2 << 30) /* 2GB max fifo size */
#define	FIFO_SEGMENT_ALLOC_BATCH_SIZE   32 /* Allocation quantum */
#define	fifo_segment_flags(_fs)   _fs->h->flags

Typedefs
typedef enum fifo_segment_flags_	fifo_segment_flags_t

Enumerations
enum	fifo_segment_ftype_t { FIFO_SEGMENT_FTYPE_NONE = -1, FIFO_SEGMENT_RX_FIFO = 0, FIFO_SEGMENT_TX_FIFO, FIFO_SEGMENT_N_FTYPES }
enum	fifo_segment_flags_ { FIFO_SEGMENT_F_IS_PREALLOCATED = 1 << 0, FIFO_SEGMENT_F_WILL_DELETE = 1 << 1 }

Functions
int	fifo_segment_init (fifo_segment_t *fs)
	Initialize fifo segment shared header. More...
int	fifo_segment_create (fifo_segment_main_t *sm, fifo_segment_create_args_t *a)
	Create a fifo segment and initialize as master. More...
int	fifo_segment_attach (fifo_segment_main_t *sm, fifo_segment_create_args_t *a)
	Attach as slave to a fifo segment. More...
void	fifo_segment_delete (fifo_segment_main_t *sm, fifo_segment_t *fs)
fifo_segment_t *	fifo_segment_get_segment (fifo_segment_main_t *sm, u32 fs_index)
u32	fifo_segment_index (fifo_segment_main_t *sm, fifo_segment_t *fs)
void	fifo_segment_info (fifo_segment_t *seg, char **address, size_t *size)
svm_fifo_t *	fifo_segment_alloc_fifo (fifo_segment_t *fs, u32 data_bytes, fifo_segment_ftype_t ftype)
	Allocate fifo in fifo segment. More...
void	fifo_segment_free_fifo (fifo_segment_t *fs, svm_fifo_t *f)
	Free fifo allocated in fifo segment. More...
int	fifo_segment_prealloc_fifo_hdrs (fifo_segment_t *fs, u32 batch_size)
	Try to preallocate fifo headers. More...
int	fifo_segment_prealloc_fifo_chunks (fifo_segment_t *fs, u32 chunk_size, u32 batch_size)
	Try to preallocate fifo chunks on segment. More...
void	fifo_segment_preallocate_fifo_pairs (fifo_segment_t *fs, u32 rx_fifo_size, u32 tx_fifo_size, u32 *n_fifo_pairs)
	Pre-allocates fifo pairs in fifo segment. More...
int	fifo_segment_grow_fifo (fifo_segment_t *fs, svm_fifo_t *f, u32 chunk_size)
	Grow fifo size by adding an additional chunk of memory. More...
int	fifo_segment_collect_fifo_chunks (fifo_segment_t *fs, svm_fifo_t *f)
	Collect unused chunks for fifo. More...
u32	fifo_segment_free_bytes (fifo_segment_t *fs)
	Fifo segment estimate of number of free bytes. More...
void	fifo_segment_update_free_bytes (fifo_segment_t *fs)
	Update fifo segment free bytes estimate. More...
u32	fifo_segment_fl_chunk_bytes (fifo_segment_t *fs)
	Number of bytes on chunk free lists. More...
u8	fifo_segment_has_fifos (fifo_segment_t *fs)
svm_fifo_t *	fifo_segment_get_fifo_list (fifo_segment_t *fs)
u32	fifo_segment_num_fifos (fifo_segment_t *fs)
	Get number of active fifos. More...
u32	fifo_segment_num_free_fifos (fifo_segment_t *fs)
u32	fifo_segment_num_free_chunks (fifo_segment_t *fs, u32 size)
	Find number of free chunks of given size. More...
void	fifo_segment_main_init (fifo_segment_main_t *sm, u64 baseva, u32 timeout_in_seconds)

Variables
format_function_t	format_fifo_segment
format_function_t	format_fifo_segment_type

Macro Definition Documentation

FIFO_SEGMENT_ALLOC_BATCH_SIZE

#define FIFO_SEGMENT_ALLOC_BATCH_SIZE   32 /* Allocation quantum */

Definition at line 31 of file fifo_segment.h.

fifo_segment_flags

#define fifo_segment_flags

(

_fs

)

_fs->h->flags

Definition at line 72 of file fifo_segment.h.

FIFO_SEGMENT_MAX_FIFO_SIZE

#define FIFO_SEGMENT_MAX_FIFO_SIZE   (2 << 30) /* 2GB max fifo size */

Definition at line 30 of file fifo_segment.h.

FIFO_SEGMENT_MIN_FIFO_SIZE

#define FIFO_SEGMENT_MIN_FIFO_SIZE   4096 /* 4kB min fifo size */

Definition at line 29 of file fifo_segment.h.

Typedef Documentation

fifo_segment_flags_t

typedef enum fifo_segment_flags_ fifo_segment_flags_t

Enumeration Type Documentation

fifo_segment_flags_

enum fifo_segment_flags_

Enumerator
FIFO_SEGMENT_F_IS_PREALLOCATED
FIFO_SEGMENT_F_WILL_DELETE

Definition at line 33 of file fifo_segment.h.

fifo_segment_ftype_t

enum fifo_segment_ftype_t

Enumerator
FIFO_SEGMENT_FTYPE_NONE
FIFO_SEGMENT_RX_FIFO
FIFO_SEGMENT_TX_FIFO
FIFO_SEGMENT_N_FTYPES

Definition at line 21 of file fifo_segment.h.

Function Documentation

fifo_segment_alloc_fifo()

svm_fifo_t* fifo_segment_alloc_fifo	(	fifo_segment_t *	fs,
		u32	data_bytes,
		fifo_segment_ftype_t	ftype
	)

Allocate fifo in fifo segment.

Parameters

fs	fifo segment for fifo
data_bytes	size of default fifo chunk in bytes
ftype	fifo type fifo_segment_ftype_t

Returns

new fifo or 0 if alloc failed

Definition at line 380 of file fifo_segment.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fifo_segment_attach()

int fifo_segment_attach	(	fifo_segment_main_t *	sm,
		fifo_segment_create_args_t *	a
	)

Attach as slave to a fifo segment.

Definition at line 99 of file fifo_segment.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fifo_segment_collect_fifo_chunks()

int fifo_segment_collect_fifo_chunks	(	fifo_segment_t *	fs,
		svm_fifo_t *	f
	)

Collect unused chunks for fifo.

Parameters

fs	fifo segment for fifo
f	fifo whose chunks are to be collected

Returns

0 on success, error otherwise

Definition at line 694 of file fifo_segment.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fifo_segment_create()

int fifo_segment_create	(	fifo_segment_main_t *	sm,
		fifo_segment_create_args_t *	a
	)

Create a fifo segment and initialize as master.

Definition at line 65 of file fifo_segment.c.

Here is the call graph for this function:

fifo_segment_delete()

void fifo_segment_delete	(	fifo_segment_main_t *	sm,
		fifo_segment_t *	fs
	)

Definition at line 129 of file fifo_segment.c.

Here is the call graph for this function:

fifo_segment_fl_chunk_bytes()

u32 fifo_segment_fl_chunk_bytes

(

fifo_segment_t *

fs

)

Number of bytes on chunk free lists.

Parameters

fs	fifo segment

Returns

free bytes on chunk free lists

Definition at line 809 of file fifo_segment.c.

Here is the caller graph for this function:

fifo_segment_free_bytes()

u32 fifo_segment_free_bytes

(

fifo_segment_t *

fs

)

Fifo segment estimate of number of free bytes.

Returns fifo segment's internal estimate of the number of free bytes. To force a synchronization between the segment and the underlying memory allocator, call fifo_segment_update_free_bytes

Parameters

fs	fifo segment

Returns

free bytes estimate

Definition at line 803 of file fifo_segment.c.

fifo_segment_free_fifo()

void fifo_segment_free_fifo	(	fifo_segment_t *	fs,
		svm_fifo_t *	f
	)

Free fifo allocated in fifo segment.

Parameters

fs	fifo segment for fifo
f	fifo to be freed

Definition at line 435 of file fifo_segment.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fifo_segment_get_fifo_list()

svm_fifo_t* fifo_segment_get_fifo_list

(

fifo_segment_t *

fs

)

Definition at line 821 of file fifo_segment.c.

Here is the caller graph for this function:

fifo_segment_get_segment()

fifo_segment_t* fifo_segment_get_segment	(	fifo_segment_main_t *	sm,
		u32	fs_index
	)

Definition at line 149 of file fifo_segment.c.

fifo_segment_grow_fifo()

int fifo_segment_grow_fifo	(	fifo_segment_t *	fs,
		svm_fifo_t *	f,
		u32	chunk_size
	)

Grow fifo size by adding an additional chunk of memory.

Parameters

fs	fifo segment for fifo
f	fifo to be grown
chunk_size	number of bytes to be added to fifo

Returns

0 on success or a negative number otherwise

Definition at line 645 of file fifo_segment.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fifo_segment_has_fifos()

u8 fifo_segment_has_fifos

(

fifo_segment_t *

fs

)

Definition at line 815 of file fifo_segment.c.

Here is the caller graph for this function:

fifo_segment_index()

u32 fifo_segment_index	(	fifo_segment_main_t *	sm,
		fifo_segment_t *	fs
	)

Definition at line 137 of file fifo_segment.c.

fifo_segment_info()

void fifo_segment_info	(	fifo_segment_t *	seg,
		char **	address,
		size_t *	size
	)

Definition at line 155 of file fifo_segment.c.

Here is the caller graph for this function:

fifo_segment_init()

int fifo_segment_init

(

fifo_segment_t *

fs

)

Initialize fifo segment shared header.

Definition at line 41 of file fifo_segment.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fifo_segment_main_init()

void fifo_segment_main_init	(	fifo_segment_main_t *	sm,
		u64	baseva,
		u32	timeout_in_seconds
	)

Definition at line 162 of file fifo_segment.c.

Here is the caller graph for this function:

fifo_segment_num_fifos()

u32 fifo_segment_num_fifos

(

fifo_segment_t *

fs

)

Get number of active fifos.

Definition at line 726 of file fifo_segment.c.

Here is the caller graph for this function:

fifo_segment_num_free_chunks()

u32 fifo_segment_num_free_chunks	(	fifo_segment_t *	fs,
		u32	size
	)

Find number of free chunks of given size.

Parameters

fs	fifo segment
size	chunk size of interest or ~0 if all should be counted

Returns

number of chunks of given size

Definition at line 751 of file fifo_segment.c.

Here is the call graph for this function:

fifo_segment_num_free_fifos()

u32 fifo_segment_num_free_fifos

(

fifo_segment_t *

fs

)

Definition at line 732 of file fifo_segment.c.

Here is the caller graph for this function:

fifo_segment_prealloc_fifo_chunks()

int fifo_segment_prealloc_fifo_chunks	(	fifo_segment_t *	fs,
		u32	chunk_size,
		u32	batch_size
	)

Try to preallocate fifo chunks on segment.

Tries to preallocate chunks of requested size on segment and adds them to chunk freelist.

Parameters

fs	fifo segment
chunk_size	size of chunks to be allocated in bytes
batch_size	number of chunks to be allocated

Returns

0 on success, negative number otherwise

Definition at line 542 of file fifo_segment.c.

Here is the call graph for this function:

fifo_segment_prealloc_fifo_hdrs()

int fifo_segment_prealloc_fifo_hdrs	(	fifo_segment_t *	fs,
		u32	batch_size
	)

Try to preallocate fifo headers.

Tries to preallocate fifo headers and adds them to freelist.

Parameters

fs	fifo segment
batch_size	number of chunks to be allocated

Returns

0 on success, negative number otherwise

Definition at line 505 of file fifo_segment.c.

Here is the call graph for this function:

fifo_segment_preallocate_fifo_pairs()

void fifo_segment_preallocate_fifo_pairs	(	fifo_segment_t *	fs,
		u32	rx_fifo_size,
		u32	tx_fifo_size,
		u32 *	n_fifo_pairs
	)

Pre-allocates fifo pairs in fifo segment.

The number of fifos pre-allocated is the minimum of the requested number of pairs and the maximum number that fit within the segment. If the maximum is hit, the number of fifo pairs requested is updated by subtracting the number of fifos that have been successfully allocated.

Parameters

fs	fifo segment for fifo
rx_fifo_size	data size of rx fifos
tx_fifo_size	data size of tx fifos
n_fifo_pairs	number of pairs requested. Prior to returning, this is decremented by the the number of pairs allocated.

Definition at line 594 of file fifo_segment.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fifo_segment_update_free_bytes()

void fifo_segment_update_free_bytes

(

fifo_segment_t *

fs

)

Update fifo segment free bytes estimate.

Forces fifo segment free bytes estimate synchronization with underlying memory allocator.

Parameters

fs	fifo segment

Definition at line 797 of file fifo_segment.c.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

format_fifo_segment

format_function_t format_fifo_segment

Definition at line 212 of file fifo_segment.h.

format_fifo_segment_type

format_function_t format_fifo_segment_type

Definition at line 213 of file fifo_segment.h.