1 /*------------------------------------------------------------------------------ 2 * 3 * Copyright (c) 2011-2021, EURid vzw. All rights reserved. 4 * The YADIFA TM software product is provided under the BSD 3-clause license: 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 10 * * Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * * Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * * Neither the name of EURid nor the names of its contributors may be 16 * used to endorse or promote products derived from this software 17 * without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 20 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 23 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 * POSSIBILITY OF SUCH DAMAGE. 30 * 31 *------------------------------------------------------------------------------ 32 * 33 */ 34 35 /** @defgroup threading Threading, pools, queues, ... 36 * @ingroup dnscore 37 * @brief 38 * 39 * This version of the ring buffer uses the condition-wait mechanism instead of the 3-mutex one. 40 * I'll have to bench both versions but the main incentive is to get rid of complains from helgrind 41 * 42 * @{ 43 * 44 *----------------------------------------------------------------------------*/ 45 #ifndef _THREADED_RINGBUFFER_CW_H 46 #define _THREADED_RINGBUFFER_CW_H 47 48 #include <dnscore/sys_types.h> 49 #include <dnscore/mutex.h> 50 51 #ifdef __cplusplus 52 extern "C" { 53 #endif 54 55 typedef struct threaded_ringbuffer_cw threaded_ringbuffer_cw; 56 57 58 struct threaded_ringbuffer_cw_node; 59 60 /* NOTE: The algorithm does not need these to be volatile */ 61 62 struct threaded_ringbuffer_cw 63 { 64 void** buffer; 65 void** buffer_limit; 66 void** write_slot; 67 void** read_slot; 68 69 mutex_t mutex; 70 cond_t cond_read; 71 cond_t cond_write; 72 73 u32 max_size; 74 u32 size; 75 }; 76 77 #define THREADED_RINGBUFFER_CW_EMPTY {0,0,0,0,MUTEX_INITIALIZER,PTHREAD_COND_INITIALIZER,PTHREAD_COND_INITIALIZER,0,0} 78 79 void threaded_ringbuffer_cw_init(threaded_ringbuffer_cw *queue, int max_size); 80 void threaded_ringbuffer_cw_finalize(threaded_ringbuffer_cw *queue); 81 void threaded_ringbuffer_cw_enqueue(threaded_ringbuffer_cw *queue,void* constant_pointer); 82 void threaded_ringbuffer_cw_enqueue_set(threaded_ringbuffer_cw *queue, void **constant_pointer_array, u32 count); 83 bool threaded_ringbuffer_cw_try_enqueue(threaded_ringbuffer_cw *queue,void* constant_pointer); 84 void* threaded_ringbuffer_cw_peek(threaded_ringbuffer_cw *queue); 85 void* threaded_ringbuffer_cw_try_peek(threaded_ringbuffer_cw *queue); 86 void* threaded_ringbuffer_cw_dequeue(threaded_ringbuffer_cw *queue); 87 void* threaded_ringbuffer_cw_dequeue_with_timeout(threaded_ringbuffer_cw *queue, s64 timeout_us); 88 void* threaded_ringbuffer_cw_try_dequeue(threaded_ringbuffer_cw *queue); 89 u32 threaded_ringbuffer_cw_dequeue_set(threaded_ringbuffer_cw *queue, void** array, u32 array_size); 90 void threaded_ringbuffer_cw_wait_empty(threaded_ringbuffer_cw *queue); 91 u32 threaded_ringbuffer_cw_size(threaded_ringbuffer_cw *queue); 92 int threaded_ringbuffer_cw_room(threaded_ringbuffer_cw *queue); 93 94 /* 95 * The queue will block (write) if bigger than this. 96 * Note that if the key is already bigger it will blocked (write) until 97 * the content is emptied by the readers. 98 */ 99 100 ya_result threaded_ringbuffer_cw_set_maxsize(threaded_ringbuffer_cw *queue, int max_size); 101 102 #ifdef __cplusplus 103 } 104 #endif 105 106 #endif /* _THREADED_QUEUE_H */ 107 /** @} */ 108