sledge/runtime/include/priority_queue.h

#ifndef PRIORITY_QUEUE_H
#define PRIORITY_QUEUE_H

#include "lock.h"
#include "runtime.h"
#include "worker_thread.h"

#define MAX 4096

/**
 * How to get the priority out of the generic element
 * We assume priority is expressed as an unsigned 64-bit integer (i.e. cycles or
 * UNIX time in ms). This is used to maintain a read replica of the highest
 * priority element that can be used to maintain a read replica
 * @param element
 * @returns priority (a uint64_t)
 */
typedef uint64_t (*priority_queue_get_priority_fn_t)(void *element);

/* We assume that priority is expressed in terms of a 64 bit unsigned integral */
struct priority_queue {
	lock_t                           lock;
	uint64_t                         highest_priority;
	void *                           items[MAX];
	int                              first_free;
	priority_queue_get_priority_fn_t get_priority_fn;
};

/**
 * Checks if a priority queue is empty
 * @param self the priority queue to check
 * @returns true if empty, else otherwise
 */
static inline bool
priority_queue_is_empty(struct priority_queue *self)
{
	return self->highest_priority == ULONG_MAX;
}

void priority_queue_initialize(struct priority_queue *self, priority_queue_get_priority_fn_t get_priority_fn);
int  priority_queue_enqueue(struct priority_queue *self, void *value);
int  priority_queue_dequeue(struct priority_queue *self, void **dequeued_element);
int  priority_queue_dequeue_if_earlier(struct priority_queue *self, void **dequeued_element, uint64_t target_deadline);
int  priority_queue_length(struct priority_queue *self);
uint64_t priority_queue_peek(struct priority_queue *self);
int      priority_queue_delete(struct priority_queue *self, void *value);
int      priority_queue_top(struct priority_queue *self, void **dequeued_element);

#endif /* PRIORITY_QUEUE_H */