/**************************************************************************** * drivers/syslog/syslog_stream.c * * Copyright (C) 2012, 2016-2017 Gregory Nutt. All rights reserved. * Author: Gregory Nutt * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. 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. * 3. Neither the name NuttX nor the names of its contributors may be * used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 * COPYRIGHT OWNER OR 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. * ****************************************************************************/ /**************************************************************************** * Included Files ****************************************************************************/ #include #include #include #include #include #include #include #include #include "syslog.h" /**************************************************************************** * Private Functions ****************************************************************************/ /**************************************************************************** * Name: syslogstream_flush ****************************************************************************/ #ifdef CONFIG_SYSLOG_BUFFER static int syslogstream_flush(FAR struct lib_syslogstream_s *stream) { FAR struct iob_s *iob; int ret = OK; DEBUGASSERT(stream != NULL); iob = stream->iob; /* Do we have an IO buffer? Is there anything buffered? */ if (iob != NULL && iob->io_len > 0) { /* Yes write the buffered data */ do { ssize_t nbytes = syslog_write((FAR const char *)iob->io_data, (size_t)iob->io_len); if (nbytes < 0) { ret = (int)nbytes; } else { iob->io_len = 0; ret = OK; } } while (ret == -EINTR); } return ret; } #endif /**************************************************************************** * Name: syslogstream_addchar ****************************************************************************/ #ifdef CONFIG_SYSLOG_BUFFER static void syslogstream_addchar(FAR struct lib_syslogstream_s *stream, int ch) { FAR struct iob_s *iob = stream->iob; /* Add the incoming character to the buffer */ iob->io_data[iob->io_len] = ch; iob->io_len++; /* Increment the total number of bytes buffered. */ stream->public.nput++; /* Is the buffer full? */ if (iob->io_len >= CONFIG_IOB_BUFSIZE) { /* Yes.. then flush the buffer */ syslogstream_flush(stream); } } #endif /**************************************************************************** * Name: syslogstream_putc ****************************************************************************/ static void syslogstream_putc(FAR struct lib_outstream_s *this, int ch) { /* Discard carriage returns */ if (ch != '\r') { #ifdef CONFIG_SYSLOG_BUFFER FAR struct lib_syslogstream_s *stream = (FAR struct lib_syslogstream_s *)this; DEBUGASSERT(stream != NULL); /* Do we have an IO buffer? */ if (stream->iob != NULL) { /* Is this a linefeed? */ if (ch == '\n') { /* Yes... pre-pend carriage return */ syslogstream_addchar(stream, '\r'); } /* Add the incoming character to the buffer */ syslogstream_addchar(stream, ch); } else #endif { int ret; /* Try writing until the write was successful or until an * irrecoverable error occurs. */ do { /* Write the character to the supported logging device. On * failure, syslog_putc returns EOF with the errno value set; */ ret = syslog_putc(ch); if (ret >= 0) { this->nput++; return; } /* The special return value -EINTR means that syslog_putc() was * awakened by a signal. This is not a real error and must be * ignored in this context. */ } while (ret == -EINTR); } } } /**************************************************************************** * Public Functions ****************************************************************************/ /**************************************************************************** * Name: syslogstream_create * * Description: * Initializes a stream for use with the configured syslog interface. * Only accessible from with the OS SYSLOG logic. * * Input Parameters: * stream - User allocated, uninitialized instance of struct * lib_lowoutstream_s to be initialized. * * Returned Value: * None (User allocated instance initialized). * ****************************************************************************/ void syslogstream_create(FAR struct lib_syslogstream_s *stream) { #ifdef CONFIG_SYSLOG_BUFFER FAR struct iob_s *iob; #endif DEBUGASSERT(stream != NULL); /* Initialize the common fields */ stream->public.put = syslogstream_putc; stream->public.flush = lib_noflush; stream->public.nput = 0; #ifdef CONFIG_SYSLOG_BUFFER /* Allocate an IOB */ iob = iob_tryalloc(true); stream->iob = iob; if (iob != NULL) { /* Initialize the IOB */ iob->io_len = 0; iob->io_offset = 0; iob->io_pktlen = 0; } #endif } /**************************************************************************** * Name: syslogstream_destroy * * Description: * Free resources held by the syslog stream. * * Input Parameters: * stream - User allocated, uninitialized instance of struct * lib_lowoutstream_s to be initialized. * * Returned Value: * None (Resources freed). * ****************************************************************************/ #ifdef CONFIG_SYSLOG_BUFFER void syslogstream_destroy(FAR struct lib_syslogstream_s *stream) { DEBUGASSERT(stream != NULL); /* Verify that there is an IOB attached (there should be) */ if (stream->iob != NULL) { /* Flush the output buffered in the IOB */ syslogstream_flush(stream); /* Free the IOB */ iob_free(stream->iob); stream->iob = NULL; } } #endif