/* * M*LIB - Fixed size BUFFER & STACK interface * * Copyright (c) 2017, Patrick Pelissier * All rights reserved. * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * + Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * + Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #ifndef __M_BUFFER_H #define __M_BUFFER_H #include #include #include #include #include "m-core.h" #include "m-mutex.h" /* Define the different kind of policy a buffer can have. */ typedef enum { BUFFER_QUEUE = 0, BUFFER_STACK = 1, BUFFER_BLOCKING = 0, BUFFER_UNBLOCKING = 2, BUFFER_THREAD_SAFE = 0, BUFFER_THREAD_UNSAFE = 4, BUFFER_PUSH_INIT_POP_MOVE = 8, BUFFER_PUSH_OVERWRITE = 16 } buffer_policy_e; /* Define a buffer. USAGE: BUFFER_DEF(name, type, size_of_buffer_or_0, policy[, oplist]) */ #define BUFFER_DEF(name, type, m_size, ... ) \ M_IF_NARGS_EQ1(__VA_ARGS__) \ (BUFFERI_DEF2(name, type, m_size,__VA_ARGS__, ()), \ BUFFERI_DEF2(name, type, m_size,__VA_ARGS__)) /********************************** INTERNAL ************************************/ #define BUFFERI_IF_CTE_SIZE(m_size) M_IF(M_BOOL(m_size)) #define BUFFERI_SIZE(m_size) BUFFERI_IF_CTE_SIZE(m_size) (m_size, v->size) #define BUFFERI_DEF2(name, type, m_size, policy, oplist) \ typedef struct M_C3(buffer_, name, _s) { \ M_MUTEX_T mutex; \ M_COND_T there_is_data; \ M_COND_T there_is_room_for_data; \ BUFFERI_IF_CTE_SIZE(m_size)( ,size_t size;) \ size_t idx_prod, idx_cons, number; \ type *data; \ } M_C3(buffer_, name,_t)[1]; \ \ static inline void \ M_C3(buffer_, name, _init)(M_C3(buffer_, name,_t) v, size_t size) \ { \ assert( size > 0); \ BUFFERI_IF_CTE_SIZE(m_size)(assert(size == m_size), v->size = size); \ v->idx_prod = v->idx_cons = v->number = 0; \ if (((policy) & BUFFER_THREAD_UNSAFE) != BUFFER_THREAD_UNSAFE) { \ M_MUTEX_INIT(v->mutex); \ M_COND_INIT(v->there_is_data); \ M_COND_INIT(v->there_is_room_for_data); \ } else \ assert(((policy)&BUFFER_UNBLOCKING) == BUFFER_UNBLOCKING); \ v->data = M_MEMORY_REALLOC (type, NULL, BUFFERI_SIZE(m_size)); \ if (v->data == NULL) { \ M_MEMORY_FULL (BUFFERI_SIZE(m_size)*sizeof(type)); \ return; \ } \ if (((policy) & BUFFER_PUSH_INIT_POP_MOVE) == 0) { \ for(size_t i = 0; i < size; i++) \ M_GET_INIT oplist(v->data[i]); \ } \ } \ \ static inline void \ M_C3(bufferi_, name, _clear_obj)(M_C3(buffer_, name,_t) v) \ { \ if (((policy)&BUFFER_PUSH_INIT_POP_MOVE) == 0) { \ for(size_t i = 0; i < BUFFERI_SIZE(m_size); i++) \ M_GET_CLEAR oplist(v->data[i]); \ } else { \ size_t i = ((policy)&BUFFER_STACK) != 0 ? 0 : v->idx_cons; \ while (i != v->idx_prod) { \ M_GET_CLEAR oplist(v->data[i]); \ i++; \ if (((policy)&BUFFER_STACK) == 0 && i >= BUFFERI_SIZE(m_size)) \ i = 0; \ } \ } \ v->idx_prod = v->idx_cons = v->number = 0; \ } \ \ static inline void \ M_C3(buffer_, name, _clear)(M_C3(buffer_, name,_t) v) \ { \ int rc; \ M_C3(bufferi_, name, _clear_obj)(v); \ M_MEMORY_FREE (v->data); \ v->data = NULL; \ if (((policy) & BUFFER_THREAD_UNSAFE) != BUFFER_THREAD_UNSAFE) { \ rc = M_MUTEX_CLEAR(v->mutex); \ assert (rc == 0); \ rc = M_COND_CLEAR(v->there_is_data); \ assert (rc == 0); \ rc = M_COND_CLEAR(v->there_is_room_for_data); \ assert (rc == 0); \ } \ } \ \ static inline void \ M_C3(buffer_, name, _clean)(M_C3(buffer_, name,_t) v) \ { \ assert (v->number <= BUFFERI_SIZE(m_size)); \ if (((policy) & BUFFER_THREAD_UNSAFE) != BUFFER_THREAD_UNSAFE) \ M_MUTEX_LOCK(v->mutex); \ if (((policy)&BUFFER_PUSH_INIT_POP_MOVE) != 0) \ M_C3(bufferi_, name, _clear_obj)(v); \ if (((policy) & BUFFER_THREAD_UNSAFE) != BUFFER_THREAD_UNSAFE) { \ M_COND_SIGNAL(v->there_is_room_for_data); \ M_MUTEX_UNLOCK(v->mutex); \ } \ } \ \ static inline bool \ M_C3(buffer_, name, _empty_p)(M_C3(buffer_, name,_t) v) \ { \ assert(v->number <= BUFFERI_SIZE(m_size)); \ return v->number == 0; \ } \ \ static inline bool \ M_C3(buffer_, name, _full_p)(M_C3(buffer_, name,_t) v) \ { \ assert(v->number <= BUFFERI_SIZE(m_size)); \ return v->number == BUFFERI_SIZE(m_size); \ } \ \ static inline bool \ M_C3(buffer_, name, _push)(M_C3(buffer_, name,_t) v, type const data) \ { \ if (((policy) & BUFFER_THREAD_UNSAFE) != BUFFER_THREAD_UNSAFE) { \ M_MUTEX_LOCK(v->mutex); \ while (((policy)&BUFFER_PUSH_OVERWRITE) == 0 \ && M_C3(buffer_, name, _full_p)(v)) { \ if (((policy) & BUFFER_UNBLOCKING) == BUFFER_UNBLOCKING) { \ M_MUTEX_UNLOCK(v->mutex); \ return false; \ } \ M_COND_WAIT(v->there_is_room_for_data, v->mutex); \ } \ } else if (((policy)&BUFFER_PUSH_OVERWRITE) == 0 \ && M_C3(buffer_, name, _full_p)(v)) \ return false; \ \ if (((policy)&BUFFER_PUSH_OVERWRITE) != 0 \ && v->number == BUFFERI_SIZE(m_size) ) { \ /* Let's clear the last element to overwrite it */ \ if (((policy) & BUFFER_STACK) == 0) { \ v->idx_prod = (v->idx_prod - 1) % BUFFERI_SIZE(m_size); \ } else { \ (v->idx_prod) --; \ } \ v->number --; \ if (((policy) & BUFFER_PUSH_INIT_POP_MOVE) != 0) { \ M_GET_CLEAR oplist(v->data[v->idx_prod]); \ } \ } \ \ if (((policy) & BUFFER_PUSH_INIT_POP_MOVE) == 0) { \ M_GET_SET oplist(v->data[v->idx_prod], data); \ } else { \ M_GET_INIT_SET oplist(v->data[v->idx_prod], data); \ } \ if (((policy) & BUFFER_STACK) != BUFFER_STACK) { \ v->idx_prod = (v->idx_prod +1) % BUFFERI_SIZE(m_size); \ } else { \ (v->idx_prod) ++; \ } \ v->number ++; \ \ if (((policy) & BUFFER_THREAD_UNSAFE) != BUFFER_THREAD_UNSAFE) { \ M_COND_SIGNAL(v->there_is_data); \ M_MUTEX_UNLOCK(v->mutex); \ } \ return true; \ } \ \ static inline bool \ M_C3(buffer_, name, _pop)(type *data, M_C3(buffer_, name,_t) v) \ { \ if (((policy) & BUFFER_THREAD_UNSAFE) != BUFFER_THREAD_UNSAFE) { \ M_MUTEX_LOCK(v->mutex); \ while (M_C3(buffer_, name, _empty_p)(v)) { \ if (((policy) & BUFFER_UNBLOCKING) == BUFFER_UNBLOCKING) { \ M_MUTEX_UNLOCK(v->mutex); \ return false; \ } \ M_COND_WAIT(v->there_is_data, v->mutex); \ } \ } else if (M_C3(buffer_, name, _empty_p)(v)) \ return false; \ \ if (((policy) & BUFFER_STACK) != BUFFER_STACK) { \ if (((policy) & BUFFER_PUSH_INIT_POP_MOVE ) == 0) { \ M_GET_SET oplist (*data, v->data[v->idx_cons]); \ } else { \ M_GET_INIT_MOVE oplist (*data, v->data[v->idx_cons]); \ } \ v->idx_cons = (v->idx_cons +1) % BUFFERI_SIZE(m_size); \ } else { \ v->idx_prod --; \ if (((policy) & BUFFER_PUSH_INIT_POP_MOVE ) == 0) { \ M_GET_SET oplist (*data, v->data[v->idx_prod]); \ } else { \ M_GET_INIT_MOVE oplist (*data, v->data[v->idx_prod]); \ } \ } \ v->number --; \ \ if (((policy) & BUFFER_THREAD_UNSAFE) != BUFFER_THREAD_UNSAFE) { \ M_COND_SIGNAL(v->there_is_room_for_data); \ M_MUTEX_UNLOCK(v->mutex); \ } \ return true; \ } \ // NOTE: SET & INIT_SET are deliberatly missing. TBC if it the right way. // NOTE: There is no oplist defined for this container. // TODO: priority queue when it is the one with the huge priority which is taken out // TODO: merge queue waiting for all threads to finish producing one object to make it available to consummer (allow partial production by different threads) #endif