diff options
Diffstat (limited to 'include/ouroboros/shm_rdrbuff.h')
-rw-r--r-- | include/ouroboros/shm_rdrbuff.h | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/include/ouroboros/shm_rdrbuff.h b/include/ouroboros/shm_rdrbuff.h new file mode 100644 index 00000000..09256c56 --- /dev/null +++ b/include/ouroboros/shm_rdrbuff.h @@ -0,0 +1,84 @@ +/* + * Ouroboros - Copyright (C) 2016 + * + * Random Deletion Ring Buffer for Data Units + * + * Dimitri Staessens <dimitri.staessens@intec.ugent.be> + * Sander Vrijders <sander.vrijders@intec.ugent.be> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + */ + +#ifndef OUROBOROS_SHM_RDRBUFF_H +#define OUROBOROS_SHM_RDRBUFF_H + +#include <ouroboros/shared.h> + +#include <stdint.h> +#include <pthread.h> +#include <sys/types.h> + +struct shm_du_buff; +struct shm_rdrbuff; + +struct shm_rdrbuff * shm_rdrbuff_create(); + +struct shm_rdrbuff * shm_rdrbuff_open(); + +void shm_rdrbuff_close(struct shm_rdrbuff * rdrb); + +void shm_rdrbuff_destroy(struct shm_rdrbuff * rdrb); + +void * shm_rdrbuff_sanitize(void * o); + +/* returns the index of the buffer in the DU map */ +ssize_t shm_rdrbuff_write(struct shm_rdrbuff * rdrb, + pid_t dst_api, + size_t headspace, + size_t tailspace, + uint8_t * data, + size_t data_len); + +ssize_t shm_rdrbuff_write_b(struct shm_rdrbuff * rdrb, + pid_t dst_api, + size_t headspace, + size_t tailspace, + uint8_t * data, + size_t data_len); + +int shm_rdrbuff_read(uint8_t ** dst, + struct shm_rdrbuff * rdrb, + ssize_t idx); + +int shm_rdrbuff_remove(struct shm_rdrbuff * rdrb, + ssize_t idx); + + +uint8_t * shm_du_buff_head_alloc(struct shm_rdrbuff * rdrb, + int idx, + ssize_t size); + +uint8_t * shm_du_buff_tail_alloc(struct shm_rdrbuff * rdrb, + int idx, + ssize_t size); + +int shm_du_buff_head_release(struct shm_rdrbuff * rdrb, + int idx, + ssize_t size); + +int shm_du_buff_tail_release(struct shm_rdrbuff * rdrb, + int idx, + ssize_t size); +#endif /* OUROBOROS_SHM_RDRBUFF_H */ |