queue.h File Reference

#include <stddef.h>
#include <stdint.h>
#include <conf.h>
#include "spinlock.h"

Include dependency graph for queue.h:

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

Go to the source code of this file.

Data Structures
struct	queue

Typedefs
typedef struct queue	utils_queue_s

Functions
struct queue	__attribute__ ((aligned(CONF_CACHE_LINE)))
utils_queue_s *	utils_queue_init (void *buff)
unsigned int	utils_queue_used_slots (utils_queue_s *q)
void *	utils_queue_push (utils_queue_s *q, void *data)
void *	utils_queue_pop (utils_queue_s *q)
void *	utils_queue_peek (utils_queue_s *q)

Variables
void *	entries [UTILS_QUEUE_CAPACITY]

Typedef Documentation

utils_queue_s

typedef struct queue utils_queue_s

Definition at line 30 of file queue.h.

Function Documentation

__attribute__()

volatile uint16_t top __attribute__

(

(aligned(CONF_CACHE_LINE))

)

Push here

Pop here

utils_queue_init()

utils_queue_s * utils_queue_init

(

void *

buff

)

Initialize a queue at the memory pointed by buff.

Parameters

buff	Allocated buffer.

Returns

queue instance.NULL on failure.

Definition at line 39 of file queue.c.

References arax_assert, and utils_spinlock_init.

Referenced by arax_vaccel_init().

Here is the caller graph for this function:

utils_queue_peek()

void * utils_queue_peek

(

utils_queue_s *

q

)

Peek first element from queue if any

Parameters

q	Valid queue instance pointer.

Returns

Data pointer, NULL on failure.

Definition at line 126 of file queue.c.

References queue::entries.

utils_queue_pop()

void * utils_queue_pop

(

utils_queue_s *

q

)

Pop data from queue.

Parameters

q	Valid queue instance pointer.

Returns

Data pointer, NULL on failure.

Definition at line 63 of file queue.c.

References arax_assert, and queue::entries.

utils_queue_push()

void * utils_queue_push	(	utils_queue_s *	q,
		void *	data )

Add data to an queue

Parameters

q	Valid queue instance pointer.
data	Non NULL pointer to data.

Returns

Equal to data, NULL on failure.

Definition at line 89 of file queue.c.

References arax_assert, queue::entries, utils_spinlock_lock, and utils_spinlock_unlock.

Referenced by arax_vaccel_add_task().

Here is the caller graph for this function:

utils_queue_used_slots()

unsigned int utils_queue_used_slots

(

utils_queue_s *

q

)

Return number of used slots in the queue.

NOTE: Since this is a concurrent queue the value returned by this function may not always reflect the true state of the queue

Parameters

q	Valid queue instance pointer.

Returns

Number of used slots in queue.

Definition at line 51 of file queue.c.

Referenced by arax_vaccel_queue_size().

Here is the caller graph for this function:

Variable Documentation

entries

void* entries[UTILS_QUEUE_CAPACITY]

Pointers to data.

Definition at line 1 of file queue.h.