From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id C1E7945BC3; Thu, 24 Oct 2024 21:09:37 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 8547543598; Thu, 24 Oct 2024 21:08:50 +0200 (CEST) Received: from mail-pl1-f173.google.com (mail-pl1-f173.google.com [209.85.214.173]) by mails.dpdk.org (Postfix) with ESMTP id BC5D343576 for ; Thu, 24 Oct 2024 21:08:39 +0200 (CEST) Received: by mail-pl1-f173.google.com with SMTP id d9443c01a7336-20cdb889222so11197155ad.3 for ; Thu, 24 Oct 2024 12:08:39 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=networkplumber-org.20230601.gappssmtp.com; s=20230601; t=1729796919; x=1730401719; darn=dpdk.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=EuvVbjjwfaEGL43bUO38vA+/IG75Fr7bdslObdzXA7I=; b=FwVJsz4CGrneJPJ0+SI6dBr29qcFiORx334Ro7pS5SDc+RBE8IKHMRB9mjkrTuH45o 6TRblRN6o1FcMY7z2osi/1fCXoVeAQglUk3jCHdxjsyAhscE9S0IfNu19TG21f41AIsG PJm0OHd72nhM58s5HrnZT1sfuj+H62ad4yls4fU9r5uVN67FH1KTALGpKA3aNUjWbLYk ksaET39eMSL5pSnfr33DDGbWy8YOVJHzDDYCpRaw4RU+i4GGE+j9ZrvPHBtWY+Q16fI7 hgD4uZsLsNwxi0erFu+144fPzxFIdIsw5Pg2GjEyaSoYrMRh5nfNEMF6SU8yJHHHV9K9 PF0A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1729796919; x=1730401719; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=EuvVbjjwfaEGL43bUO38vA+/IG75Fr7bdslObdzXA7I=; b=BL29iCa36+kJntIy9bO2uCecV3iQJnybe3Ym+yi4coKqyrIRMPnKeX++o88qhvsRNS 7+ZC0IFPSo9/k4aUBr5LsSQQdbrI0+5YgC+abLho5tHi/PVVSUYf2AxHJ/n9GUUaWhs3 lZ6YCXUDhx/c8P8amtG2XNU0m0/RN5jB0UaJfK+G1Jtm6en0ru/lrF6d+dZ5iY05XrBu xVoPxNSGXR+xdOZV+sUYzy0eekkhJDQAtUqnx0L/Gc0vtWLM49348A8em9DPHwYimJ0a 8+cxZ1Fb3QG8PpgPoNcEcjepIjAJHybPzAIRfO8zDMSaQAKHaqczp/R1HYG1+fbJBYPt 80YQ== X-Gm-Message-State: AOJu0YyxM2E1kgY+SR5IphlvmHclqUZQsSLZRSTISRCVw0P3yWaTdlvc DH3DVawmn+XLqpsDD5Hx90OxH/Nw4JJKUiWYE5zc1tB5D50rpdTVtzu7EbwK7r8LU9x2xOsTsin w X-Google-Smtp-Source: AGHT+IHvkXjKaJODJXmB1l1D+Ct22McNETWEqT/5XzlHIhFMIIU1ElbIIq0MiwP6VtuJBCCuwyhnSw== X-Received: by 2002:a17:902:dac6:b0:20c:f9ec:cd9e with SMTP id d9443c01a7336-20fa9eb948amr88961895ad.41.1729796918746; Thu, 24 Oct 2024 12:08:38 -0700 (PDT) Received: from hermes.local (204-195-96-226.wavecable.com. [204.195.96.226]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-20e7f0f364bsm75535385ad.264.2024.10.24.12.08.38 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 24 Oct 2024 12:08:38 -0700 (PDT) From: Stephen Hemminger To: dev@dpdk.org Cc: Stephen Hemminger , =?UTF-8?q?Morten=20Br=C3=B8rup?= , Bruce Richardson Subject: [PATCH v28 11/13] log: add support for systemd journal Date: Thu, 24 Oct 2024 12:02:57 -0700 Message-ID: <20241024190818.172863-12-stephen@networkplumber.org> X-Mailer: git-send-email 2.45.2 In-Reply-To: <20241024190818.172863-1-stephen@networkplumber.org> References: <20200814173441.23086-1-stephen@networkplumber.org> <20241024190818.172863-1-stephen@networkplumber.org> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org If DPDK application is being run as a systemd service, then it can use the journal protocol which allows putting more information in the log such as priority and other information. The use of journal protocol is automatically detected and handled. Rather than having a dependency on libsystemd, just use the protocol directly as defined in: https://systemd.io/JOURNAL_NATIVE_PROTOCOL/ Signed-off-by: Stephen Hemminger Acked-by: Morten Brørup Acked-by: Bruce Richardson --- lib/log/log.c | 7 +- lib/log/log_internal.h | 3 + lib/log/log_journal.c | 154 +++++++++++++++++++++++++++++++++++++++++ lib/log/log_private.h | 14 ++++ lib/log/log_syslog.c | 9 +++ lib/log/meson.build | 4 ++ lib/log/version.map | 1 + 7 files changed, 189 insertions(+), 3 deletions(-) create mode 100644 lib/log/log_journal.c diff --git a/lib/log/log.c b/lib/log/log.c index 7bf4548858..343f9d77b7 100644 --- a/lib/log/log.c +++ b/lib/log/log.c @@ -508,13 +508,14 @@ eal_log_init(const char *id) { FILE *logf = NULL; - if (log_syslog_enabled()) + if (log_journal_enabled()) + logf = log_journal_open(id); + else if (log_syslog_enabled()) logf = log_syslog_open(id); if (logf) rte_openlog_stream(logf); - - if (log_timestamp_enabled()) + else if (log_timestamp_enabled()) rte_logs.print_func = log_print_with_timestamp; else rte_logs.print_func = vfprintf; diff --git a/lib/log/log_internal.h b/lib/log/log_internal.h index 8ef195a6ec..731c099984 100644 --- a/lib/log/log_internal.h +++ b/lib/log/log_internal.h @@ -35,6 +35,9 @@ int eal_log_save_pattern(const char *pattern, uint32_t level); __rte_internal int eal_log_syslog(const char *name); +__rte_internal +int eal_log_journal(const char *opt); + /* * Convert log level to string. */ diff --git a/lib/log/log_journal.c b/lib/log/log_journal.c new file mode 100644 index 0000000000..43341aa233 --- /dev/null +++ b/lib/log/log_journal.c @@ -0,0 +1,154 @@ +/* SPDX-License-Identifier: BSD-3-Clause */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include + +#include "log_internal.h" +#include "log_private.h" + +/* + * Send structured message using journal protocol + * See: https://systemd.io/JOURNAL_NATIVE_PROTOCOL/ + * + * Uses writev() to ensure that whole log message is in one datagram + */ +static int +journal_send(int fd, const char *buf, size_t len) +{ + struct iovec iov[4]; + unsigned int n = 0; + int priority = rte_log_cur_msg_loglevel() - 1; + char msg[] = "MESSAGE="; + char newline = '\n'; + char pbuf[32]; /* "PRIORITY=N\n" */ + + iov[n].iov_base = msg; + iov[n++].iov_len = strlen(msg); + + iov[n].iov_base = (char *)(uintptr_t)buf; + iov[n++].iov_len = len; + + /* if message doesn't end with newline, one will be applied. */ + if (buf[len - 1] != '\n') { + iov[n].iov_base = &newline; + iov[n++].iov_len = 1; + } + + /* priority value between 0 ("emerg") and 7 ("debug") */ + iov[n].iov_base = pbuf; + iov[n++].iov_len = snprintf(pbuf, sizeof(pbuf), + "PRIORITY=%d\n", priority); + return writev(fd, iov, n); +} + + +/* wrapper for log stream to put messages into journal */ +static ssize_t +journal_log_write(void *c, const char *buf, size_t size) +{ + int fd = (uintptr_t)c; + + return journal_send(fd, buf, size); +} + +static int +journal_log_close(void *c) +{ + int fd = (uintptr_t)c; + + close(fd); + return 0; +} + +static cookie_io_functions_t journal_log_func = { + .write = journal_log_write, + .close = journal_log_close, +}; + +/* + * Check if stderr is going to system journal. + * This is the documented way to handle systemd journal + * + * See: https://systemd.io/JOURNAL_NATIVE_PROTOCOL/ + */ +bool +log_journal_enabled(void) +{ + char *jenv, *endp = NULL; + struct stat st; + unsigned long dev, ino; + + jenv = getenv("JOURNAL_STREAM"); + if (jenv == NULL) + return false; + + if (fstat(STDERR_FILENO, &st) < 0) + return false; + + /* systemd sets colon-separated list of device and inode number */ + dev = strtoul(jenv, &endp, 10); + if (endp == NULL || *endp != ':') + return false; /* missing colon */ + + ino = strtoul(endp + 1, NULL, 10); + + return dev == st.st_dev && ino == st.st_ino; +} + +/* Connect to systemd's journal service */ +FILE *log_journal_open(const char *id) +{ + char syslog_id[PATH_MAX]; + FILE *log_stream; + int len; + struct sockaddr_un sun = { + .sun_family = AF_UNIX, + .sun_path = "/run/systemd/journal/socket", + }; + int jfd = -1; + + len = snprintf(syslog_id, sizeof(syslog_id), + "SYSLOG_IDENTIFIER=%s\nSYSLOG_PID=%u", id, getpid()); + + /* Detect truncation of message and fallback to no journal */ + if (len >= (int)sizeof(syslog_id)) + return NULL; + + jfd = socket(AF_UNIX, SOCK_DGRAM, 0); + if (jfd < 0) { + perror("socket"); + goto error; + } + + if (connect(jfd, (struct sockaddr *)&sun, sizeof(sun)) < 0) { + perror("connect"); + goto error; + } + + /* Send identifier as first message */ + if (write(jfd, syslog_id, len) != len) { + perror("write"); + goto error; + } + + /* redirect other log messages to journal */ + log_stream = fopencookie((void *)(uintptr_t)jfd, "w", journal_log_func); + if (log_stream != NULL) + return log_stream; + +error: + close(jfd); + return NULL; +} diff --git a/lib/log/log_private.h b/lib/log/log_private.h index 86eaf3f910..37895949f6 100644 --- a/lib/log/log_private.h +++ b/lib/log/log_private.h @@ -22,6 +22,20 @@ bool log_syslog_enabled(void); FILE *log_syslog_open(const char *id); #endif +#ifdef RTE_EXEC_ENV_LINUX +bool log_journal_enabled(void); +FILE *log_journal_open(const char *id); +#else +static inline bool log_journal_enabled(void) +{ + return false; +} +static inline FILE *log_journal_open(const char *id __rte_unused) +{ + return NULL; +} +#endif /* !RTE_EXEC_ENV_LINUX */ + bool log_timestamp_enabled(void); ssize_t log_timestamp(char *tsbuf, size_t tsbuflen); diff --git a/lib/log/log_syslog.c b/lib/log/log_syslog.c index 7d29e3a00f..c23b19fe89 100644 --- a/lib/log/log_syslog.c +++ b/lib/log/log_syslog.c @@ -18,6 +18,10 @@ static int log_facility; +/* + * Usable list of facilities + * Skip kern, mark, and security + */ static const struct { const char *name; int value; @@ -48,6 +52,11 @@ eal_log_syslog(const char *name) { unsigned int i; + if (name == NULL) { + log_facility = LOG_DAEMON; + return 0; + } + for (i = 0; i < RTE_DIM(facilitys); i++) { if (!strcmp(name, facilitys[i].name)) { log_facility = facilitys[i].value; diff --git a/lib/log/meson.build b/lib/log/meson.build index 4ac232786e..86e4452b19 100644 --- a/lib/log/meson.build +++ b/lib/log/meson.build @@ -11,4 +11,8 @@ if not is_windows sources += files('log_syslog.c') endif +if is_linux + sources += files('log_journal.c') +endif + headers = files('rte_log.h') diff --git a/lib/log/version.map b/lib/log/version.map index 8be6907840..800d3943bc 100644 --- a/lib/log/version.map +++ b/lib/log/version.map @@ -26,6 +26,7 @@ INTERNAL { global: eal_log_init; + eal_log_journal; # WINDOWS_NO_EXPORT eal_log_level2str; eal_log_save_pattern; eal_log_save_regexp; -- 2.45.2