Buffered_LIFO.h

Go to the documentation of this file.

/* ############################ MALP License ############################## */
/* # Fri Jan 18 14:00:00 CET 2013                                         # */
/* # Copyright or (C) or Copr. Commissariat a l'Energie Atomique          # */
/* #                                                                      # */
/* # This software is governed by the CeCILL-C license under French law   # */
/* # and abiding by the rules of distribution of free software.  You can  # */
/* # use, modify and/ or redistribute the software under the terms of     # */
/* # the CeCILL-C license as circulated by CEA, CNRS and INRIA at the     # */
/* # following URL http://www.cecill.info.                                # */
/* #                                                                      # */
/* # The fact that you are presently reading this means that you have     # */
/* # had knowledge of the CeCILL-C license and that you accept its        # */
/* # terms.                                                               # */
/* #                                                                      # */
/* # Authors:                                                             # */
/* #   - BESNARD Jean-Baptiste jean-baptiste.besnard@cea.fr               # */
/* #                                                                      # */
/* ######################################################################## */
#ifndef BUFFERED_LIFO_H
#define BUFFERED_LIFO_H

#ifdef __cplusplus
  extern "C"
  {
#endif


#include <stdint.h>
#include <stdlib.h>
#include "Spinlock.h"

struct Buffered_LIFO_chunk
{
        uint64_t offset;                                        
        struct Buffered_LIFO_chunk *next; 
        char elems[0];                                          
};

struct Buffered_LIFO_chunk * Buffered_LIFO_chunk_new( size_t sizeof_payload, uint64_t chunk_size, struct Buffered_LIFO_chunk * prev );

void Buffered_LIFO_chunk_release( struct Buffered_LIFO_chunk * chunk, size_t sizeof_payload, void (*free_func)( void *) );

struct Buffered_LIFO_chunk *  Buffered_LIFO_chunk_push( struct Buffered_LIFO_chunk *  chunk,
                                                                                                                  void * elem,  size_t sizeof_payload, uint64_t chunk_size );

struct Buffered_LIFO_chunk * Buffered_LIFO_chunk_pop(  struct Buffered_LIFO_chunk * chunk, 
                                                                                                                 size_t sizeof_payload, uint64_t chunk_size,
                                                                                                                 void * elem, int *did_ret );
void * Buffered_LIFO_chunk_head( struct Buffered_LIFO_chunk * chunk,  size_t sizeof_payload );

struct Buffered_LIFO
{
        size_t sizeof_payload;                                  
        uint64_t chunk_size;                                    
        MALP_Spinlock lock;                                             
        struct Buffered_LIFO_chunk * head;      
};

void Buffered_LIFO_init( struct Buffered_LIFO *lifo, size_t sizeof_payload, uint64_t chunk_size );

void Buffered_LIFO_release( struct Buffered_LIFO *lifo, void (*free_func)( void *) );

void Buffered_LIFO_push( struct Buffered_LIFO *lifo, void * elem );

void * Buffered_LIFO_pop( struct Buffered_LIFO *lifo, void * elem );

void * Buffered_LIFO_head( struct Buffered_LIFO *lifo );

void * Buffered_LIFO_head_locked( struct Buffered_LIFO *lifo );

void Buffered_LIFO_head_unlock( struct Buffered_LIFO *lifo );

#ifdef __cplusplus
        }
#endif

#endif /* BUFFERED_LIFO_H */