syslog.c File Reference

Syslog protocol. More...

#include <stdint.h>
#include <stdlib.h>
#include <string.h>
#include <ctype.h>
#include <byteswap.h>
#include <ipxe/xfer.h>
#include <ipxe/open.h>
#include <ipxe/tcpip.h>
#include <ipxe/dhcp.h>
#include <ipxe/dhcpv6.h>
#include <ipxe/settings.h>
#include <ipxe/console.h>
#include <ipxe/lineconsole.h>
#include <ipxe/syslog.h>
#include <config/console.h>

Go to the source code of this file.

Macros
#define	CONSOLE_SYSLOG   ( CONSOLE_USAGE_ALL & ~CONSOLE_USAGE_TUI )

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
int	syslog_send (struct interface *xfer, unsigned int severity, const char *message, const char *terminator)
	Transmit formatted syslog message.
static void	syslog_handle_priority (struct ansiesc_context *ctx __unused, unsigned int count __unused, int params[])
	Handle ANSI set syslog priority (private sequence)
static void	syslog_putchar (int character)
	Print a character to syslog console.
const struct setting syslog_setting	__setting (SETTING_MISC, syslog)
	IPv4 syslog server setting.
const struct setting syslog6_setting	__setting (SETTING_MISC, syslog6)
	IPv6 syslog server setting.
static void	syslog_fix_name (char *name)
	Strip invalid characters from host/domain name.
static int	apply_syslog_settings (void)
	Apply syslog settings.

Variables
union {
struct sockaddr   sa
struct sockaddr_tcpip   st
struct sockaddr_in   sin
struct sockaddr_in6   sin6
}	logserver
	The syslog server.
static struct interface_operation	syslogger_operations [] = {}
	Syslog UDP interface operations.
static struct interface_descriptor	syslogger_desc
	Syslog UDP interface descriptor.
static struct interface	syslogger = INTF_INIT ( syslogger_desc )
	The syslog UDP interface.
static char *	syslog_hostname
	Host name (for log messages)
static char *	syslog_domain
	Domain name (for log messages)
static char	syslog_buffer [SYSLOG_BUFSIZE]
	Syslog line buffer.
static unsigned int	syslog_severity = SYSLOG_DEFAULT_SEVERITY
	Syslog severity.
static struct ansiesc_handler	syslog_handlers []
	Syslog ANSI escape sequence handlers.
static struct line_console	syslog_line
	Syslog line console.
static int	syslog_entered
	Syslog recursion marker.
struct console_driver syslog_console	__console_driver
	Syslog console driver.
struct settings_applicator syslog_applicator	__settings_applicator
	Syslog settings applicator.

Detailed Description

Syslog protocol.

Definition in file syslog.c.

Macro Definition Documentation

CONSOLE_SYSLOG

#define CONSOLE_SYSLOG   ( CONSOLE_USAGE_ALL & ~CONSOLE_USAGE_TUI )

Definition at line 52 of file syslog.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

syslog_send()

int syslog_send	(	struct interface *	xfer,
		unsigned int	severity,
		const char *	message,
		const char *	terminator )

Transmit formatted syslog message.

Parameters

xfer	Data transfer interface
severity	Severity
message	Message
terminator	Message terminator

Return values

rc	Return status code

Definition at line 99 of file syslog.c.

                                                                {
        const char *hostname = ( syslog_hostname ? syslog_hostname : "" );
        const char *domain = ( ( hostname[0] && syslog_domain ) ?
                               syslog_domain : "" );
 
        return xfer_printf ( xfer, "<%d>%s%s%s%sipxe: %s%s",
                             SYSLOG_PRIORITY ( SYSLOG_DEFAULT_FACILITY,
                                               severity ), hostname,
                             ( domain[0] ? "." : "" ), domain,
                             ( hostname[0] ? " " : "" ), message, terminator );
}

References message, SYSLOG_DEFAULT_FACILITY, syslog_domain, syslog_hostname, SYSLOG_PRIORITY, terminator, and xfer_printf().

Referenced by syslog_putchar(), and syslogs_putchar().

syslog_handle_priority()

void syslog_handle_priority ( struct ansiesc_context *ctx __unused, unsigned int count __unused, int params[] )

static

Handle ANSI set syslog priority (private sequence)

Parameters

ctx	ANSI escape sequence context
count	Parameter count
params	List of graphic rendition aspects

Definition at line 132 of file syslog.c.

                                                    {
        if ( params[0] >= 0 ) {
                syslog_severity = params[0];
        } else {
                syslog_severity = SYSLOG_DEFAULT_SEVERITY;
        }
}

References __unused, count, ctx, SYSLOG_DEFAULT_SEVERITY, and syslog_severity.

syslog_putchar()

void syslog_putchar ( int character )

static

Print a character to syslog console.

Parameters

character

Character to be printed

Definition at line 165 of file syslog.c.

                                             {
        int rc;
 
        /* Ignore if we are already mid-logging */
        if ( syslog_entered )
                return;
 
        /* Fill line buffer */
        if ( line_putchar ( &syslog_line, character ) == 0 )
                return;
 
        /* Guard against re-entry */
        syslog_entered = 1;
 
        /* Send log message */
        if ( ( rc = syslog_send ( &syslogger, syslog_severity,
                                  syslog_buffer, "" ) ) != 0 ) {
                DBG ( "SYSLOG could not send log message: %s\n",
                      strerror ( rc ) );
        }
 
        /* Clear re-entry flag */
        syslog_entered = 0;
}

References DBG, line_putchar(), rc, strerror(), syslog_buffer, syslog_entered, syslog_line, syslog_send(), syslog_severity, and syslogger.

__setting() [1/2]

const struct setting syslog_setting __setting	(	SETTING_MISC	,
		syslog	)

IPv4 syslog server setting.

References __setting, DHCP_LOG_SERVERS, SETTING_MISC, and syslog.

__setting() [2/2]

const struct setting syslog6_setting __setting	(	SETTING_MISC	,
		syslog6	)

IPv6 syslog server setting.

References __setting, DHCPV6_LOG_SERVERS, dhcpv6_scope, and SETTING_MISC.

syslog_fix_name()

void syslog_fix_name ( char * name )

static

Strip invalid characters from host/domain name.

Parameters

name	Name to strip

Definition at line 226 of file syslog.c.

                                           {
        char *fixed = name;
        int c;
 
        /* Do nothing if name does not exist */
        if ( ! name )
                return;
 
        /* Strip any non-printable or whitespace characters from the name */
        do {
                c = *(name++);
                *fixed = c;
                if ( isprint ( c ) && ! isspace ( c ) )
                        fixed++;
        } while ( c );
}

References fixed, isprint(), isspace(), and name.

Referenced by apply_syslog_settings().

apply_syslog_settings()

int apply_syslog_settings ( void )

static

Apply syslog settings.

Return values

rc	Return status code

Definition at line 248 of file syslog.c.

                                          {
        struct sockaddr old_logserver;
        int rc;
 
        /* Fetch hostname and domain name */
        free ( syslog_hostname );
        fetch_string_setting_copy ( NULL, &hostname_setting, &syslog_hostname );
        syslog_fix_name ( syslog_hostname );
        free ( syslog_domain );
        fetch_string_setting_copy ( NULL, &domain_setting, &syslog_domain );
        syslog_fix_name ( syslog_domain );
 
        /* Fetch log server */
        syslog_console.disabled = CONSOLE_DISABLED;
        memcpy ( &old_logserver, &logserver, sizeof ( old_logserver ) );
        logserver.sa.sa_family = 0;
        if ( fetch_ipv6_setting ( NULL, &syslog6_setting,
                                  &logserver.sin6.sin6_addr ) >= 0 ) {
                logserver.sin6.sin6_family = AF_INET6;
        } else if ( fetch_ipv4_setting ( NULL, &syslog_setting,
                                         &logserver.sin.sin_addr ) >= 0 ) {
                logserver.sin.sin_family = AF_INET;
        }
        if ( logserver.sa.sa_family ) {
                syslog_console.disabled = 0;
                DBG ( "SYSLOG using log server %s\n",
                      sock_ntoa ( &logserver.sa ) );
        }
 
        /* Do nothing unless log server has changed */
        if ( memcmp ( &logserver, &old_logserver, sizeof ( logserver ) ) == 0 )
                return 0;
 
        /* Reset syslog connection */
        intf_restart ( &syslogger, 0 );
 
        /* Do nothing unless we have a log server */
        if ( syslog_console.disabled ) {
                DBG ( "SYSLOG has no log server\n" );
                return 0;
        }
 
        /* Connect to log server */
        if ( ( rc = xfer_open_socket ( &syslogger, SOCK_DGRAM,
                                       &logserver.sa, NULL ) ) != 0 ) {
                DBG ( "SYSLOG cannot connect to log server: %s\n",
                      strerror ( rc ) );
                return rc;
        }
 
        return 0;
}

References AF_INET, AF_INET6, CONSOLE_DISABLED, DBG, fetch_ipv4_setting(), fetch_ipv6_setting(), fetch_string_setting_copy(), free, intf_restart(), logserver, memcmp(), memcpy(), NULL, rc, SOCK_DGRAM, sock_ntoa(), strerror(), syslog_domain, syslog_fix_name(), syslog_hostname, syslogger, and xfer_open_socket().

Variable Documentation

sa

struct sockaddr sa

Definition at line 57 of file syslog.c.

Referenced by apply_dns_settings(), comboot_resolv_done(), dns_resolv(), dns_send_packet(), efi_pxe_ip_sockaddr(), efi_pxe_udp_write(), fc_fill_sockaddr(), fetch_next_server_and_filename(), ftp_reply(), ib_create_path(), ib_create_service_madx(), ib_mcast_mad(), ipv4_sock_aton(), ipv4_sock_ntoa(), ipv6_sock_aton(), ipv6_sock_ntoa(), named_resolv_done(), nslookup_resolv_done(), numeric_resolv(), peerdisc_socket_tx(), pxe_tftp_open(), resolv(), resolv_done(), resolv_setting(), sock_aton(), sock_ntoa(), start_dhcpv6(), start_ntp(), tftp_process_multicast(), tkip_michael(), and x509_check_ipaddress().

st

u8 st

Definition at line 58 of file syslog.c.

Referenced by arbel_create_cq(), arbel_create_eq(), dns_send_packet(), efi_pxe_udp_write(), hermon_create_cq(), hermon_create_eq(), ipv4_rx(), ipv6_rx(), peerdisc_socket_tx(), and start_ntp().

sin

struct sockaddr_in sin

Definition at line 59 of file syslog.c.

Referenced by apply_dns_settings(), comboot_resolv_done(), dns_send_packet(), fetch_next_server_and_filename(), ftp_reply(), ipv4_rx(), ipv4_sock_aton(), ipv4_sock_ntoa(), nslookup_resolv_done(), pxe_tftp_open(), tftp_process_multicast(), and x509_check_ipaddress().

sin6

struct sockaddr_in6 sin6

Definition at line 60 of file syslog.c.

Referenced by apply_dns_settings(), dns_send_packet(), ipv6_rx(), ipv6_sock_aton(), ipv6_sock_ntoa(), nslookup_resolv_done(), start_dhcpv6(), and x509_check_ipaddress().

[union]

union { ... } logserver

Initial value:

= {
        .st = {
                .st_port = htons ( SYSLOG_PORT ),
        },
}

The syslog server.

syslogger_operations

struct interface_operation syslogger_operations[] = {}

static

Syslog UDP interface operations.

Definition at line 68 of file syslog.c.

{};

syslogger_desc

struct interface_descriptor syslogger_desc

static

Initial value:

=
        INTF_DESC_PURE ( syslogger_operations )

Syslog UDP interface descriptor.

Definition at line 71 of file syslog.c.

syslogger

struct interface syslogger = INTF_INIT ( syslogger_desc )

static

The syslog UDP interface.

Definition at line 75 of file syslog.c.

Referenced by apply_syslog_settings(), and syslog_putchar().

syslog_hostname

char* syslog_hostname

static

Host name (for log messages)

Definition at line 85 of file syslog.c.

Referenced by apply_syslog_settings(), and syslog_send().

syslog_domain

char* syslog_domain

static

Domain name (for log messages)

Definition at line 88 of file syslog.c.

Referenced by apply_syslog_settings(), and syslog_send().

syslog_buffer

char syslog_buffer[SYSLOG_BUFSIZE]

static

Syslog line buffer.

Definition at line 120 of file syslog.c.

Referenced by syslog_putchar().

syslog_severity

unsigned int syslog_severity = SYSLOG_DEFAULT_SEVERITY

static

Syslog severity.

Definition at line 123 of file syslog.c.

Referenced by syslog_handle_priority(), and syslog_putchar().

syslog_handlers

struct ansiesc_handler syslog_handlers[]

static

Initial value:

= {
        { ANSIESC_LOG_PRIORITY, syslog_handle_priority },
        { 0, NULL }
}

Syslog ANSI escape sequence handlers.

Definition at line 143 of file syslog.c.

                                                  {
        { ANSIESC_LOG_PRIORITY, syslog_handle_priority },
        { 0, NULL }
};

syslog_line

struct line_console syslog_line

static

Initial value:

= {
        .buffer = syslog_buffer,
        .len = sizeof ( syslog_buffer ),
        .ctx = {
                .handlers = syslog_handlers,
        },
}

Syslog line console.

Definition at line 149 of file syslog.c.

                                         {
        .buffer = syslog_buffer,
        .len = sizeof ( syslog_buffer ),
        .ctx = {
                .handlers = syslog_handlers,
        },
};

Referenced by syslog_putchar().

syslog_entered

int syslog_entered

static

Syslog recursion marker.

Definition at line 158 of file syslog.c.

Referenced by syslog_putchar().

__console_driver

struct console_driver syslog_console __console_driver

Initial value:

= {
        .putchar = syslog_putchar,
        .disabled = CONSOLE_DISABLED,
        .usage = CONSOLE_SYSLOG,
}

Syslog console driver.

Definition at line 191 of file syslog.c.

                                                        {
        .putchar = syslog_putchar,
        .disabled = CONSOLE_DISABLED,
        .usage = CONSOLE_SYSLOG,
};

__settings_applicator

struct settings_applicator syslog_applicator __settings_applicator

Initial value:

= {
        .apply = apply_syslog_settings,
}

Syslog settings applicator.

Definition at line 302 of file syslog.c.

                                                                     {
        .apply = apply_syslog_settings,
};