From 73377229bb33ab79682ce4b126a63602d13304ad Mon Sep 17 00:00:00 2001 From: Katerina Barone-Adesi Date: Thu, 21 Feb 2013 05:16:29 +0000 Subject: Added a ring buffer log target to store the last N log messages. The log target can be used via log alarms and show alarms. Why? This feature was proposed/requested at http://openbsc.osmocom.org/trac/wiki/Tasks/ErrorLogTarget All messages use the same amount of space, prioritizing simplicity. --- include/osmocom/core/logging.h | 5 ++++ include/osmocom/core/loggingrb.h | 40 +++++++++++++++++++++++++++ include/osmocom/core/strrb.h | 58 ++++++++++++++++++++++++++++++++++++++++ 3 files changed, 103 insertions(+) create mode 100644 include/osmocom/core/loggingrb.h create mode 100644 include/osmocom/core/strrb.h (limited to 'include') diff --git a/include/osmocom/core/logging.h b/include/osmocom/core/logging.h index 54262b7f..fa3365ad 100644 --- a/include/osmocom/core/logging.h +++ b/include/osmocom/core/logging.h @@ -114,6 +114,7 @@ enum log_target_type { LOG_TGT_TYPE_SYSLOG, /*!< \brief syslog based logging */ LOG_TGT_TYPE_FILE, /*!< \brief text file logging */ LOG_TGT_TYPE_STDERR, /*!< \brief stderr logging */ + LOG_TGT_TYPE_STRRB, /*!< \brief osmo_strrb-backed logging */ }; /*! \brief structure representing a logging target */ @@ -154,6 +155,10 @@ struct log_target { struct { void *vty; } tgt_vty; + + struct { + void *rb; + } tgt_rb; }; /*! \brief call-back function to be called when the logging framework diff --git a/include/osmocom/core/loggingrb.h b/include/osmocom/core/loggingrb.h new file mode 100644 index 00000000..a6f377b1 --- /dev/null +++ b/include/osmocom/core/loggingrb.h @@ -0,0 +1,40 @@ +#ifndef _LOGGINGRB_H +#define _LOGGINGRB_H + +/* (C) 2012-2013 by Katerina Barone-Adesi + * All Rights Reserved + * + * 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 3 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., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + * + */ + + +/*! \defgroup loggingrb Osmocom ringbuffer-backed logging + * @{ + */ + +/*! \file loggingrb.h + */ + +struct log_info; + +size_t log_target_rb_used_size(struct log_target const *target); +size_t log_target_rb_avail_size(struct log_target const *target); +const char *log_target_rb_get(struct log_target const *target, size_t logindex); +struct log_target *log_target_create_rb(size_t size); + +/*! @} */ + +#endif /* _LOGGINGRB_H */ diff --git a/include/osmocom/core/strrb.h b/include/osmocom/core/strrb.h new file mode 100644 index 00000000..cfc56dc0 --- /dev/null +++ b/include/osmocom/core/strrb.h @@ -0,0 +1,58 @@ +#ifndef _STRRB_H +#define _STRRB_H + +/* (C) 2012-2013 by Katerina Barone-Adesi + * All Rights Reserved + * + * 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 3 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., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + * + */ + +/*! \defgroup osmo_strrb Osmocom ringbuffers for log strings + * @{ + */ + +/*! \file strrb.h + * \brief Osmocom string ringbuffer handling routines + */ + +#include +#include +#include + +#include + +/*! \brief A structure representing an osmocom string ringbuffer */ + +#define RB_MAX_MESSAGE_SIZE 240 +struct osmo_strrb { + uint16_t start; /*!< \brief index of the first slot */ + uint16_t end; /*!< \brief index of the last slot */ + uint16_t size; /*!< \brief max number of messages to store */ + char **buffer; /*!< \brief storage for messages */ +}; + +struct osmo_strrb *osmo_strrb_create(TALLOC_CTX * ctx, size_t rb_size); +bool osmo_strrb_is_empty(const struct osmo_strrb *rb); +const char *osmo_strrb_get_nth(const struct osmo_strrb *rb, + unsigned int string_index); +bool _osmo_strrb_is_bufindex_valid(const struct osmo_strrb *rb, + unsigned int offset); +size_t osmo_strrb_elements(const struct osmo_strrb *rb); +int osmo_strrb_add(struct osmo_strrb *rb, const char *data); + +/*! @} */ + +#endif /* _STRRB_H */ -- cgit v1.2.3