2012-11-10 17:06:01 +01:00
|
|
|
/****************************************************************************
|
2022-11-23 18:48:20 +01:00
|
|
|
* libs/libc/stream/lib_syslogstream.c
|
2012-11-10 17:06:01 +01:00
|
|
|
*
|
2021-03-04 07:10:42 +01:00
|
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
|
|
* contributor license agreements. See the NOTICE file distributed with
|
|
|
|
* this work for additional information regarding copyright ownership. The
|
|
|
|
* ASF licenses this file to you under the Apache License, Version 2.0 (the
|
|
|
|
* "License"); you may not use this file except in compliance with the
|
|
|
|
* License. You may obtain a copy of the License at
|
2012-11-10 17:06:01 +01:00
|
|
|
*
|
2021-03-04 07:10:42 +01:00
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
2012-11-10 17:06:01 +01:00
|
|
|
*
|
2021-03-04 07:10:42 +01:00
|
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
|
|
* License for the specific language governing permissions and limitations
|
|
|
|
* under the License.
|
2012-11-10 17:06:01 +01:00
|
|
|
*
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Included Files
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
|
|
|
|
#include <assert.h>
|
|
|
|
#include <errno.h>
|
|
|
|
|
2017-05-11 01:36:08 +02:00
|
|
|
#include <nuttx/mm/iob.h>
|
2022-11-23 18:48:20 +01:00
|
|
|
#include <nuttx/streams.h>
|
2017-05-11 01:36:08 +02:00
|
|
|
#include <nuttx/syslog/syslog.h>
|
2012-11-10 17:06:01 +01:00
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Private Functions
|
|
|
|
****************************************************************************/
|
|
|
|
|
2017-05-12 14:58:33 +02:00
|
|
|
/****************************************************************************
|
|
|
|
* 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,
|
2022-11-23 18:48:20 +01:00
|
|
|
iob->io_len);
|
2017-05-12 14:58:33 +02:00
|
|
|
if (nbytes < 0)
|
|
|
|
{
|
2022-11-23 18:48:20 +01:00
|
|
|
ret = nbytes;
|
2017-05-12 14:58:33 +02:00
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
iob->io_len = 0;
|
|
|
|
ret = OK;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
while (ret == -EINTR);
|
|
|
|
}
|
|
|
|
|
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
2017-05-12 15:31:50 +02:00
|
|
|
/****************************************************************************
|
|
|
|
* Name: syslogstream_addchar
|
|
|
|
****************************************************************************/
|
|
|
|
|
2017-05-12 15:57:45 +02:00
|
|
|
#ifdef CONFIG_SYSLOG_BUFFER
|
2021-03-04 08:02:21 +01:00
|
|
|
static void syslogstream_addchar(FAR struct lib_syslogstream_s *stream,
|
|
|
|
int ch)
|
2017-05-12 15:31:50 +02:00
|
|
|
{
|
|
|
|
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? */
|
|
|
|
|
2021-10-28 12:26:11 +02:00
|
|
|
if (iob->io_len >= CONFIG_IOB_BUFSIZE)
|
2017-05-12 15:31:50 +02:00
|
|
|
{
|
|
|
|
/* Yes.. then flush the buffer */
|
|
|
|
|
|
|
|
syslogstream_flush(stream);
|
|
|
|
}
|
|
|
|
}
|
2017-05-12 15:57:45 +02:00
|
|
|
#endif
|
2017-05-12 15:31:50 +02:00
|
|
|
|
2012-11-10 17:06:01 +01:00
|
|
|
/****************************************************************************
|
|
|
|
* Name: syslogstream_putc
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
static void syslogstream_putc(FAR struct lib_outstream_s *this, int ch)
|
|
|
|
{
|
2022-12-29 14:56:27 +01:00
|
|
|
FAR struct lib_syslogstream_s *stream =
|
|
|
|
(FAR struct lib_syslogstream_s *)this;
|
|
|
|
|
|
|
|
DEBUGASSERT(stream != NULL);
|
|
|
|
stream->last_ch = ch;
|
|
|
|
|
2017-05-11 00:13:21 +02:00
|
|
|
/* Discard carriage returns */
|
2017-05-10 22:42:43 +02:00
|
|
|
|
2017-05-11 00:13:21 +02:00
|
|
|
if (ch != '\r')
|
|
|
|
{
|
2017-05-11 01:36:08 +02:00
|
|
|
#ifdef CONFIG_SYSLOG_BUFFER
|
|
|
|
/* Do we have an IO buffer? */
|
2017-05-10 22:42:43 +02:00
|
|
|
|
2017-05-12 15:31:50 +02:00
|
|
|
if (stream->iob != NULL)
|
2017-05-11 00:13:21 +02:00
|
|
|
{
|
2017-05-12 15:31:50 +02:00
|
|
|
/* Add the incoming character to the buffer */
|
|
|
|
|
|
|
|
syslogstream_addchar(stream, ch);
|
2012-11-10 17:06:01 +01:00
|
|
|
}
|
2017-05-11 01:36:08 +02:00
|
|
|
else
|
|
|
|
#endif
|
|
|
|
{
|
|
|
|
int ret;
|
|
|
|
|
|
|
|
/* Try writing until the write was successful or until an
|
|
|
|
* irrecoverable error occurs.
|
|
|
|
*/
|
2012-11-10 17:06:01 +01:00
|
|
|
|
2017-05-11 01:36:08 +02:00
|
|
|
do
|
|
|
|
{
|
|
|
|
/* Write the character to the supported logging device. On
|
2019-09-16 15:48:48 +02:00
|
|
|
* failure, syslog_putc returns a negated errno value.
|
2017-05-11 01:36:08 +02:00
|
|
|
*/
|
|
|
|
|
|
|
|
ret = syslog_putc(ch);
|
2018-01-31 00:23:10 +01:00
|
|
|
if (ret >= 0)
|
2017-05-11 01:36:08 +02:00
|
|
|
{
|
|
|
|
this->nput++;
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2018-01-31 00:23:10 +01:00
|
|
|
/* The special return value -EINTR means that syslog_putc() was
|
2017-05-11 01:36:08 +02:00
|
|
|
* awakened by a signal. This is not a real error and must be
|
|
|
|
* ignored in this context.
|
|
|
|
*/
|
|
|
|
}
|
2018-01-31 00:23:10 +01:00
|
|
|
while (ret == -EINTR);
|
2017-05-11 01:36:08 +02:00
|
|
|
}
|
2012-11-10 17:06:01 +01:00
|
|
|
}
|
2017-05-10 22:42:43 +02:00
|
|
|
}
|
|
|
|
|
2012-11-10 17:06:01 +01:00
|
|
|
/****************************************************************************
|
|
|
|
* Public Functions
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
/****************************************************************************
|
2022-11-23 18:48:20 +01:00
|
|
|
* Name: lib_syslogstream_open
|
2012-11-10 17:06:01 +01:00
|
|
|
*
|
|
|
|
* Description:
|
|
|
|
* Initializes a stream for use with the configured syslog interface.
|
2016-06-19 15:56:24 +02:00
|
|
|
* Only accessible from with the OS SYSLOG logic.
|
2012-11-10 17:06:01 +01:00
|
|
|
*
|
2018-02-01 17:00:02 +01:00
|
|
|
* Input Parameters:
|
2016-06-19 15:56:24 +02:00
|
|
|
* stream - User allocated, uninitialized instance of struct
|
2019-09-16 15:48:48 +02:00
|
|
|
* lib_syslogstream_s to be initialized.
|
2012-11-10 17:06:01 +01:00
|
|
|
*
|
|
|
|
* Returned Value:
|
|
|
|
* None (User allocated instance initialized).
|
|
|
|
*
|
|
|
|
****************************************************************************/
|
|
|
|
|
2022-11-23 18:48:20 +01:00
|
|
|
void lib_syslogstream_open(FAR struct lib_syslogstream_s *stream)
|
2012-11-10 17:06:01 +01:00
|
|
|
{
|
2017-05-12 14:58:33 +02:00
|
|
|
DEBUGASSERT(stream != NULL);
|
2017-05-11 01:36:08 +02:00
|
|
|
|
|
|
|
/* Initialize the common fields */
|
|
|
|
|
2022-12-04 10:35:13 +01:00
|
|
|
stream->public.putc = syslogstream_putc;
|
2017-05-12 14:58:33 +02:00
|
|
|
stream->public.flush = lib_noflush;
|
2017-05-10 22:42:43 +02:00
|
|
|
stream->public.nput = 0;
|
2017-05-11 01:36:08 +02:00
|
|
|
|
2017-05-12 14:58:33 +02:00
|
|
|
#ifdef CONFIG_SYSLOG_BUFFER
|
2017-05-11 01:36:08 +02:00
|
|
|
/* Allocate an IOB */
|
|
|
|
|
2022-12-15 15:51:14 +01:00
|
|
|
stream->iob = iob_tryalloc(true);
|
2017-05-10 22:42:43 +02:00
|
|
|
#endif
|
2012-11-10 17:06:01 +01:00
|
|
|
}
|
2017-05-11 01:36:08 +02:00
|
|
|
|
|
|
|
/****************************************************************************
|
2022-11-23 18:48:20 +01:00
|
|
|
* Name: lib_syslogstream_close
|
2017-05-11 01:36:08 +02:00
|
|
|
*
|
|
|
|
* Description:
|
|
|
|
* Free resources held by the syslog stream.
|
|
|
|
*
|
2018-02-01 17:00:02 +01:00
|
|
|
* Input Parameters:
|
2017-05-11 01:36:08 +02:00
|
|
|
* stream - User allocated, uninitialized instance of struct
|
2019-09-16 15:48:48 +02:00
|
|
|
* lib_syslogstream_s to be initialized.
|
2017-05-11 01:36:08 +02:00
|
|
|
*
|
|
|
|
* Returned Value:
|
|
|
|
* None (Resources freed).
|
|
|
|
*
|
|
|
|
****************************************************************************/
|
|
|
|
|
2022-12-30 10:09:45 +01:00
|
|
|
#ifdef CONFIG_SYSLOG_BUFFER
|
2022-11-23 18:48:20 +01:00
|
|
|
void lib_syslogstream_close(FAR struct lib_syslogstream_s *stream)
|
2017-05-11 01:36:08 +02:00
|
|
|
{
|
|
|
|
DEBUGASSERT(stream != NULL);
|
|
|
|
|
|
|
|
/* Verify that there is an IOB attached (there should be) */
|
|
|
|
|
|
|
|
if (stream->iob != NULL)
|
|
|
|
{
|
2017-05-12 14:58:33 +02:00
|
|
|
/* Flush the output buffered in the IOB */
|
|
|
|
|
|
|
|
syslogstream_flush(stream);
|
|
|
|
|
2017-05-11 01:36:08 +02:00
|
|
|
/* Free the IOB */
|
|
|
|
|
2022-08-08 04:21:03 +02:00
|
|
|
iob_free(stream->iob);
|
2017-05-11 01:36:08 +02:00
|
|
|
stream->iob = NULL;
|
|
|
|
}
|
2022-12-29 14:56:27 +01:00
|
|
|
}
|
2022-12-30 10:09:45 +01:00
|
|
|
#endif
|