Add a SYSLOG character device that can be used to re-direct output to the SYSLOG

This commit is contained in:
Gregory Nutt 2016-07-05 12:58:18 -06:00
parent a39ce80add
commit 02b91d9880
6 changed files with 165 additions and 4 deletions

View File

@ -2570,7 +2570,7 @@ New features and extended functionality:
particular for a CDC/ACM with MSC USB composite driver).
Added a new RAM logging driver. This will allow debug output into
a RAM buffer associated with a character driver at /dev/syslog.
a RAM buffer associated with a character driver at /dev/ramlog.
Added the new command 'dmesg' to NSH that can be used to dump the
current contents of the log. This is useful for systems that do not
have the usual serial console (for example, if you only have a

View File

@ -172,7 +172,7 @@ config SYSLOG_CHAR_CRLF
config SYSLOG_DEVPATH
string "System log device"
default "/dev/syslog"
default "/dev/ttyS1"
depends on SYSLOG_CHAR
---help---
The full path to the system logging device. For the RAMLOG SYSLOG device,
@ -180,4 +180,17 @@ config SYSLOG_DEVPATH
some other existing character device (or file) supported by the configuration
(such as "/dev/ttyS1")/
config SYSLOG_CHARDEV
bool "SYSLOG character device"
default n
---help---
Enables support for a simple character driver at /dev/syslog whose
write() method will transfer data to the SYSLOG device. This can be
useful if, for example, you want to redirect the output of a program
to the SYSLOG.
NOTE that unlike other syslog output, this data is unformatted raw
byte output with no time-stamping or any other SYSLOG features
supported.
endmenu # System logging

View File

@ -80,7 +80,9 @@ ifeq ($(CONFIG_SYSLOG_FILE),y)
CSRCS += syslog_filechannel.c
endif
# (Add other SYSLOG drivers here)
ifeq ($(CONFIG_SYSLOG_CHARDEV),y)
CSRCS += syslog_chardev.c
endif
ifeq ($(CONFIG_CONSOLE_SYSLOG),y)
CSRCS += syslog_console.c

View File

@ -0,0 +1,129 @@
/****************************************************************************
* drivers/syslog/syslog_chardev.c
*
* Copyright (C) 2016 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* 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 <nuttx/config.h>
#include <sys/types.h>
#include <stdbool.h>
#include <string.h>
#include <poll.h>
#include <errno.h>
#include <nuttx/fs/fs.h>
#include <nuttx/syslog/syslog.h>
#include "syslog.h"
#ifdef CONFIG_SYSLOG_CHARDEV
/****************************************************************************
* Private Function Prototypes
****************************************************************************/
static ssize_t syslog_write(FAR struct file *filep, FAR const char *buffer,
size_t buflen);
/****************************************************************************
* Private Data
****************************************************************************/
static const struct file_operations syslog_fops =
{
NULL, /* open */
NULL, /* close */
NULL, /* read */
syslog_write, /* write */
NULL, /* seek */
NULL /* ioctl */
#ifndef CONFIG_DISABLE_POLL
, NULL /* poll */
#endif
#ifndef CONFIG_DISABLE_PSEUDOFS_OPERATIONS
, NULL /* unlink */
#endif
};
/****************************************************************************
* Private Functions
****************************************************************************/
/****************************************************************************
* Name: syslog_write
****************************************************************************/
static ssize_t syslog_write(FAR struct file *filep, FAR const char *buffer,
size_t len)
{
size_t nwritten;
int ret;
for (nwritten = 0; nwritten < len; nwritten++)
{
int ch = *buffer++;
ret = syslog_putc(ch);
UNUSED(ret);
}
return len;
}
/****************************************************************************
* Public Functions
****************************************************************************/
/****************************************************************************
* Name: syslog_register
*
* Description:
* Register a simple character driver at /dev/syslog whose write() method
* will transfer data to the SYSLOG device. This can be useful if, for
* example, you want to redirect the output of a program to the SYSLOG.
*
* NOTE that unlike other syslog output, this data is unformatted raw
* byte output with no time-stamping or any other SYSLOG features
* supported.
*
****************************************************************************/
void syslog_register(void)
{
(void)register_driver("/dev/syslog", &syslog_fops, 0222, NULL);
}
#endif /* CONFIG_SYSLOG_CHARDEV */

View File

@ -135,7 +135,6 @@ int ioctl(int fd, int req, unsigned long arg)
int errcode;
#if CONFIG_NFILE_DESCRIPTORS > 0
FAR struct file *filep;
int ret = OK;
/* Did we get a valid file descriptor? */

View File

@ -271,6 +271,24 @@ int syslog_flush(void);
int _vsyslog(int priority, FAR const IPTR char *src, FAR va_list *ap);
/****************************************************************************
* Name: syslog_register
*
* Description:
* Register a simple character driver at /dev/syslog whose write() method
* will transfer data to the SYSLOG device. This can be useful if, for
* example, you want to redirect the output of a program to the SYSLOG.
*
* NOTE that unlike other syslog output, this data is unformatted raw
* byte output with no time-stamping or any other SYSLOG features
* supported.
*
****************************************************************************/
#ifdef CONFIG_SYSLOG_CHARDEV
void syslog_register(void);
#endif
#undef EXTERN
#ifdef __cplusplus
}