Neels Hofmeyr | 17518fe | 2017-06-20 04:35:06 +0200 | [diff] [blame] | 1 | /*! \file strrb.h |
| 2 | * Osmocom string ringbuffer handling routines. */ |
| 3 | /* |
| 4 | * (C) 2012-2013 by Katerina Barone-Adesi <kat.obsc@gmail.com> |
Katerina Barone-Adesi | 3309a43 | 2013-02-21 05:16:29 +0000 | [diff] [blame] | 5 | * All Rights Reserved |
| 6 | * |
| 7 | * This program is free software; you can redistribute it and/or modify |
| 8 | * it under the terms of the GNU General Public License as published by |
Harald Welte | 33e940b | 2014-10-26 20:52:25 +0100 | [diff] [blame] | 9 | * the Free Software Foundation; either version 2 of the License, or |
Katerina Barone-Adesi | 3309a43 | 2013-02-21 05:16:29 +0000 | [diff] [blame] | 10 | * (at your option) any later version. |
| 11 | * |
| 12 | * This program is distributed in the hope that it will be useful, |
| 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 15 | * GNU General Public License for more details. |
| 16 | * |
| 17 | * You should have received a copy of the GNU General Public License along |
| 18 | * with this program; if not, write to the Free Software Foundation, Inc., |
| 19 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |
| 20 | * |
| 21 | */ |
| 22 | |
Neels Hofmeyr | 17518fe | 2017-06-20 04:35:06 +0200 | [diff] [blame] | 23 | #pragma once |
| 24 | |
Katerina Barone-Adesi | 3309a43 | 2013-02-21 05:16:29 +0000 | [diff] [blame] | 25 | /*! \defgroup osmo_strrb Osmocom ringbuffers for log strings |
| 26 | * @{ |
Neels Hofmeyr | 17518fe | 2017-06-20 04:35:06 +0200 | [diff] [blame] | 27 | * \file strrb.h */ |
Katerina Barone-Adesi | 3309a43 | 2013-02-21 05:16:29 +0000 | [diff] [blame] | 28 | |
| 29 | #include <unistd.h> |
| 30 | #include <stdbool.h> |
| 31 | #include <stdint.h> |
| 32 | |
| 33 | #include <osmocom/core/talloc.h> |
| 34 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 35 | /*! A structure representing an osmocom string ringbuffer */ |
Katerina Barone-Adesi | 3309a43 | 2013-02-21 05:16:29 +0000 | [diff] [blame] | 36 | |
| 37 | #define RB_MAX_MESSAGE_SIZE 240 |
| 38 | struct osmo_strrb { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 39 | uint16_t start; /*!< index of the first slot */ |
| 40 | uint16_t end; /*!< index of the last slot */ |
| 41 | uint16_t size; /*!< max number of messages to store */ |
| 42 | char **buffer; /*!< storage for messages */ |
Katerina Barone-Adesi | 3309a43 | 2013-02-21 05:16:29 +0000 | [diff] [blame] | 43 | }; |
| 44 | |
| 45 | struct osmo_strrb *osmo_strrb_create(TALLOC_CTX * ctx, size_t rb_size); |
| 46 | bool osmo_strrb_is_empty(const struct osmo_strrb *rb); |
| 47 | const char *osmo_strrb_get_nth(const struct osmo_strrb *rb, |
| 48 | unsigned int string_index); |
| 49 | bool _osmo_strrb_is_bufindex_valid(const struct osmo_strrb *rb, |
| 50 | unsigned int offset); |
| 51 | size_t osmo_strrb_elements(const struct osmo_strrb *rb); |
| 52 | int osmo_strrb_add(struct osmo_strrb *rb, const char *data); |
| 53 | |
| 54 | /*! @} */ |