Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/138869/?format=api
{ "id": 138869, "url": "http://patches.dpdk.org/api/patches/138869/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/20240327164726.68732-14-stephen@networkplumber.org/", "project": { "id": 1, "url": "http://patches.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<20240327164726.68732-14-stephen@networkplumber.org>", "list_archive_url": "https://inbox.dpdk.org/dev/20240327164726.68732-14-stephen@networkplumber.org", "date": "2024-03-27T16:45:31", "name": "[v16,13/15] log: add optional support of syslog", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "f89f3b4e484cdb03b52996fc0cc31a0aa1c8c8af", "submitter": { "id": 27, "url": "http://patches.dpdk.org/api/people/27/?format=api", "name": "Stephen Hemminger", "email": "stephen@networkplumber.org" }, "delegate": { "id": 1, "url": "http://patches.dpdk.org/api/users/1/?format=api", "username": "tmonjalo", "first_name": "Thomas", "last_name": "Monjalon", "email": "thomas@monjalon.net" }, "mbox": "http://patches.dpdk.org/project/dpdk/patch/20240327164726.68732-14-stephen@networkplumber.org/mbox/", "series": [ { "id": 31630, "url": "http://patches.dpdk.org/api/series/31630/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=31630", "date": "2024-03-27T16:45:18", "name": "Logging unification and improvements", "version": 16, "mbox": "http://patches.dpdk.org/series/31630/mbox/" } ], "comments": "http://patches.dpdk.org/api/patches/138869/comments/", "check": "warning", "checks": "http://patches.dpdk.org/api/patches/138869/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@inbox.dpdk.org", "Delivered-To": "patchwork@inbox.dpdk.org", "Received": [ "from mails.dpdk.org (mails.dpdk.org [217.70.189.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id 23D7F43D55;\n\tWed, 27 Mar 2024 17:49:10 +0100 (CET)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id D9F0942D8C;\n\tWed, 27 Mar 2024 17:47:55 +0100 (CET)", "from mail-pf1-f182.google.com (mail-pf1-f182.google.com\n [209.85.210.182])\n by mails.dpdk.org (Postfix) with ESMTP id 967CE42B71\n for <dev@dpdk.org>; Wed, 27 Mar 2024 17:47:47 +0100 (CET)", "by mail-pf1-f182.google.com with SMTP id\n d2e1a72fcca58-6e704078860so90561b3a.0\n for <dev@dpdk.org>; Wed, 27 Mar 2024 09:47:47 -0700 (PDT)", "from hermes.local (204-195-123-203.wavecable.com. [204.195.123.203])\n by smtp.gmail.com with ESMTPSA id\n a33-20020a056a0011e100b006e580678dfbsm5160873pfu.193.2024.03.27.09.47.45\n (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);\n Wed, 27 Mar 2024 09:47:46 -0700 (PDT)" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=networkplumber-org.20230601.gappssmtp.com; s=20230601; t=1711558067;\n x=1712162867; darn=dpdk.org;\n h=content-transfer-encoding:mime-version:references:in-reply-to\n :message-id:date:subject:cc:to:from:from:to:cc:subject:date\n :message-id:reply-to;\n bh=GvIiQ00/+ZWT077nwyatKCF+plHPu2a/G6R1AK5lzAo=;\n b=PTR5KxrwMoEXpf3UTsGV74454o/RK7TTJfc7sDw942yzEuDBzX8FiaDybEe/qDR6s2\n 7NCyo85H64aSWeq6rBCHinclCoA11Xdl3iXlL6D7C3P17nGRP4GAmBN5LTsfECWALXeR\n L8H11x72f0NQc079511EWiGuRj3f5CM/fQQl2631desSGyQF7vOekBf02Lo6dSokxTJ8\n OBoLx40aM4EjkL41g62svY8rvtjoXhlKLzFYjw1X5tZI1QNDWjX/qh1K4V4efKujwFPQ\n omuodZicf67XmBvmQclQh7IUIXaq8jyOvP6sIdQKmMZKu2u/bqwT7BmmivDSVTHPNTv2\n pqAQ==", "X-Google-DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=1e100.net; s=20230601; t=1711558067; x=1712162867;\n h=content-transfer-encoding:mime-version:references:in-reply-to\n :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc\n :subject:date:message-id:reply-to;\n bh=GvIiQ00/+ZWT077nwyatKCF+plHPu2a/G6R1AK5lzAo=;\n b=qzAC9ipngxyCnIHLejr3hyFAsuZgN1iNvBFjjl/340x7HUtmcOWVz21W5Tp3BgWotx\n QOhwbjbT9sXQxArL9xhQzUCRvoAL5duwlGsbVg0TOcFCsEZHUodvkVVDpinkq9yIdTIg\n 6e+VMA4dlNeVvcjzXb84LqtDA3hmGsQmcw/CbGJXLuAGXviu/zSmJidjfhkhCxyoUw3y\n hossXIo43qyXFXnDOFip/lcZ36sDDIlQP0zw2nwRXrtsSubWkSRddLNbRmK8ZUv2b6r3\n hvntCUvLGqPcjzbM/d1JSaBZ7LxRYrd9dEwOXNz404YVruCr1HaFIWl2J0v0fXWXJhJw\n 2kHw==", "X-Gm-Message-State": "AOJu0YwT9/fRKqaJQw+tKo3eZk1cCDtXRixFfIt5uGiiyQbka7afEtTR\n iRGPcWeH3iMKu/MY4N1X3A8/FLAmbkYpElZCW10iuEqcapRRiAMgS5Rz3ffMkj8J3Kwa37Dj7km\n b", "X-Google-Smtp-Source": "\n AGHT+IEY2ECZ9G+qCiMpqTYivBbMhRV11QNl3CI4x0TGPkxrJsSUwiLGsTp1kzzCflUKnBKrUyrVqQ==", "X-Received": "by 2002:a05:6a00:2307:b0:6ea:950f:7d25 with SMTP id\n h7-20020a056a00230700b006ea950f7d25mr313616pfh.18.1711558066492;\n Wed, 27 Mar 2024 09:47:46 -0700 (PDT)", "From": "Stephen Hemminger <stephen@networkplumber.org>", "To": "dev@dpdk.org", "Cc": "Stephen Hemminger <stephen@networkplumber.org>", "Subject": "[PATCH v16 13/15] log: add optional support of syslog", "Date": "Wed, 27 Mar 2024 09:45:31 -0700", "Message-ID": "<20240327164726.68732-14-stephen@networkplumber.org>", "X-Mailer": "git-send-email 2.43.0", "In-Reply-To": "<20240327164726.68732-1-stephen@networkplumber.org>", "References": "<20200814173441.23086-1-stephen@networkplumber.org>\n <20240327164726.68732-1-stephen@networkplumber.org>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.29", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n <mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://mails.dpdk.org/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n <mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org" }, "content": "Log to syslog only if option is specified. And if syslog is used\nthen normally only log to syslog, don't duplicate output.\nAlso enables syslog support on FreeBSD.\n\nSigned-off-by: Stephen Hemminger <stephen@networkplumber.org>\n---\n app/test/test_eal_flags.c | 5 +-\n doc/guides/linux_gsg/linux_eal_parameters.rst | 27 ----\n doc/guides/prog_guide/log_lib.rst | 17 +++\n lib/eal/common/eal_common_options.c | 5 +-\n lib/log/log.c | 121 ++++++++++++++++--\n 5 files changed, 137 insertions(+), 38 deletions(-)", "diff": "diff --git a/app/test/test_eal_flags.c b/app/test/test_eal_flags.c\nindex e54f6e8b7f..08f4866461 100644\n--- a/app/test/test_eal_flags.c\n+++ b/app/test/test_eal_flags.c\n@@ -987,9 +987,10 @@ test_misc_flags(void)\n \t/* With empty --syslog */\n \tconst char *argv3[] = {prgname, prefix, mp_flag, \"--syslog\"};\n \t/* With valid --syslog */\n-\tconst char *argv4[] = {prgname, prefix, mp_flag, \"--syslog\", \"always\"};\n+\tconst char *argv4[] = {prgname, prefix, mp_flag, \"--syslog=both\"};\n \t/* With invalid --syslog */\n-\tconst char *argv5[] = {prgname, prefix, mp_flag, \"--syslog\", \"error\"};\n+\tconst char *argv5[] = {prgname, prefix, mp_flag, \"--syslog=invalid\"};\n+\n \t/* With no-sh-conf, also use no-huge to ensure this test runs on BSD */\n \tconst char *argv6[] = {prgname, \"-m\", DEFAULT_MEM_SIZE,\n \t\t\tno_shconf, nosh_prefix, no_huge};\ndiff --git a/doc/guides/linux_gsg/linux_eal_parameters.rst b/doc/guides/linux_gsg/linux_eal_parameters.rst\nindex ea8f381391..d86f94d8a8 100644\n--- a/doc/guides/linux_gsg/linux_eal_parameters.rst\n+++ b/doc/guides/linux_gsg/linux_eal_parameters.rst\n@@ -108,30 +108,3 @@ Memory-related options\n * ``--match-allocations``\n \n Free hugepages back to system exactly as they were originally allocated.\n-\n-Other options\n-~~~~~~~~~~~~~\n-\n-* ``--syslog <syslog facility>``\n-\n- Set syslog facility. Valid syslog facilities are::\n-\n- auth\n- cron\n- daemon\n- ftp\n- kern\n- lpr\n- mail\n- news\n- syslog\n- user\n- uucp\n- local0\n- local1\n- local2\n- local3\n- local4\n- local5\n- local6\n- local7\ndiff --git a/doc/guides/prog_guide/log_lib.rst b/doc/guides/prog_guide/log_lib.rst\nindex 504eefe1d2..abaedc7212 100644\n--- a/doc/guides/prog_guide/log_lib.rst\n+++ b/doc/guides/prog_guide/log_lib.rst\n@@ -83,6 +83,23 @@ To prefix all console messages with ISO format time the syntax is::\n \n \t/path/to/app --log-timestamp=iso\n \n+Log output\n+~~~~~~~~~~\n+\n+If desired, messages can be redirected to syslog (on Linux and FreeBSD) with the ``--syslog``\n+option. There are three possible settings for this option:\n+\n+*always*\n+ Redirect all log output to syslog.\n+\n+*auto*\n+ Use console if it is a terminal, and use syslog if is not.\n+\n+*both*\n+ Print to both console and syslog.\n+\n+If ``--syslog`` option is not specified, then only console (stderr) will be used.\n+\n \n \n Using Logging APIs to Generate Log Messages\ndiff --git a/lib/eal/common/eal_common_options.c b/lib/eal/common/eal_common_options.c\nindex 5173835c2c..9ca7db04aa 100644\n--- a/lib/eal/common/eal_common_options.c\n+++ b/lib/eal/common/eal_common_options.c\n@@ -91,7 +91,7 @@ eal_long_options[] = {\n \t{OPT_PROC_TYPE, 1, NULL, OPT_PROC_TYPE_NUM },\n \t{OPT_SOCKET_MEM, 1, NULL, OPT_SOCKET_MEM_NUM },\n \t{OPT_SOCKET_LIMIT, 1, NULL, OPT_SOCKET_LIMIT_NUM },\n-\t{OPT_SYSLOG, 1, NULL, OPT_SYSLOG_NUM },\n+\t{OPT_SYSLOG, 2, NULL, OPT_SYSLOG_NUM },\n \t{OPT_VDEV, 1, NULL, OPT_VDEV_NUM },\n \t{OPT_VFIO_INTR, 1, NULL, OPT_VFIO_INTR_NUM },\n \t{OPT_VFIO_VF_TOKEN, 1, NULL, OPT_VFIO_VF_TOKEN_NUM },\n@@ -2221,6 +2221,9 @@ eal_common_usage(void)\n \t \" (can be used multiple times)\\n\"\n \t \" --\"OPT_VMWARE_TSC_MAP\" Use VMware TSC map instead of native RDTSC\\n\"\n \t \" --\"OPT_PROC_TYPE\" Type of this process (primary|secondary|auto)\\n\"\n+#ifndef RTE_EXEC_ENV_WINDOWS\n+\t \" --\"OPT_SYSLOG\"[=<when>] Enable use of syslog\\n\"\n+#endif\n \t \" --\"OPT_LOG_LEVEL\"=<level> Set global log level\\n\"\n \t \" --\"OPT_LOG_LEVEL\"=<type-match>:<level>\\n\"\n \t \" Set specific log level\\n\"\ndiff --git a/lib/log/log.c b/lib/log/log.c\nindex 2dca91306e..ec0d55273e 100644\n--- a/lib/log/log.c\n+++ b/lib/log/log.c\n@@ -13,15 +13,17 @@\n #include <sys/queue.h>\n #include <unistd.h>\n \n+#ifdef RTE_EXEC_ENV_WINDOWS\n+#include <rte_os_shim.h>\n+#else\n+#include <syslog.h>\n+#endif\n+\n #include <rte_log.h>\n #include <rte_per_lcore.h>\n \n #include \"log_internal.h\"\n \n-#ifdef RTE_EXEC_ENV_WINDOWS\n-#include <rte_os_shim.h>\n-#endif\n-\n struct rte_log_dynamic_type {\n \tconst char *name;\n \tuint32_t loglevel;\n@@ -36,14 +38,25 @@ enum eal_log_time_format {\n \tEAL_LOG_TIMESTAMP_ISO,\n };\n \n+enum eal_log_syslog {\n+\tEAL_LOG_SYSLOG_NONE = 0,\t/* do not use syslog */\n+\tEAL_LOG_SYSLOG_AUTO,\t\t/* use syslog only if not a terminal */\n+\tEAL_LOG_SYSLOG_ALWAYS,\t\t/* always use syslog */\n+\tEAL_LOG_SYSLOG_BOTH,\t\t/* log to both syslog and stderr */\n+};\n+\n typedef int (*log_print_t)(FILE *f, uint32_t level, const char *fmt, va_list ap);\n static int log_print(FILE *f, uint32_t level, const char *format, va_list ap);\n \n+\n /** The rte_log structure. */\n static struct rte_logs {\n \tuint32_t type; /**< Bitfield with enabled logs. */\n \tuint32_t level; /**< Log level. */\n \tFILE *file; /**< Output file set by rte_openlog_stream, or NULL. */\n+#ifndef RTE_EXEC_ENV_WINDOWS\n+\tenum eal_log_syslog syslog_opt;\n+#endif\n \tlog_print_t print_func;\n \n \tenum eal_log_time_format time_format;\n@@ -532,9 +545,23 @@ rte_log(uint32_t level, uint32_t logtype, const char *format, ...)\n \n /* Placeholder */\n int\n-eal_log_syslog(const char *mode __rte_unused)\n+eal_log_syslog(const char *str)\n {\n+#ifdef RTE_EXEC_ENV_WINDOWS\n+\tRTE_SET_USED(str);\n \treturn -1;\n+#else\n+\tif (str == NULL || strcmp(str, \"auto\") == 0)\n+\t\t/* log to syslog only if stderr is not a terminal */\n+\t\trte_logs.syslog_opt = EAL_LOG_SYSLOG_AUTO;\n+\telse if (strcmp(str, \"both\") == 0)\n+\t\trte_logs.syslog_opt = EAL_LOG_SYSLOG_BOTH;\n+\telse if (strcmp(str, \"always\") == 0)\n+\t\trte_logs.syslog_opt = EAL_LOG_SYSLOG_ALWAYS;\n+\telse\n+\t\treturn -1;\n+\treturn 0;\n+#endif\n }\n \n /* Set the log timestamp format */\n@@ -706,17 +733,95 @@ log_print_with_timestamp(FILE *f, uint32_t level,\n \treturn log_print(f, level, format, ap);\n }\n \n+#ifndef RTE_EXEC_ENV_WINDOWS\n+static bool\n+using_syslog(bool is_terminal)\n+{\n+\tswitch (rte_logs.syslog_opt) {\n+\tdefault:\n+\t\treturn false;\n+\n+\tcase EAL_LOG_SYSLOG_ALWAYS:\n+\tcase EAL_LOG_SYSLOG_BOTH:\n+\t\treturn true;\n+\n+\tcase EAL_LOG_SYSLOG_AUTO:\n+\t\treturn !is_terminal;\n+\t}\n+}\n+\n /*\n- * Called by rte_eal_init\n+ * wrapper for log stream to put messages into syslog\n+ * useful for cases like:\n+ * rte_hex_dump(rte_get_log_stream(), ...)\n */\n-void\n-eal_log_init(const char *id __rte_unused)\n+static ssize_t\n+syslog_log_write(__rte_unused void *c, const char *buf, size_t size)\n {\n+\t/* Syslog error levels are from 0 to 7, so subtract 1 to convert */\n+\tsyslog(rte_log_cur_msg_loglevel() - 1, \"%.*s\", (int)size, buf);\n+\treturn size;\n+}\n+\n+static int\n+syslog_log_close(__rte_unused void *c)\n+{\n+\tcloselog();\n+\treturn 0;\n+}\n+\n+static cookie_io_functions_t syslog_log_func = {\n+\t.write = syslog_log_write,\n+\t.close = syslog_log_close,\n+};\n+\n+static void\n+log_open_syslog(const char *id, bool is_terminal)\n+{\n+\tint flags = LOG_NDELAY | LOG_PID;\n+\n+#ifdef LOG_PERROR\n+\tif (rte_logs.syslog_opt == EAL_LOG_SYSLOG_BOTH)\n+\t\tflags |= LOG_PERROR;\n+#endif\n+\topenlog(id, flags, is_terminal ? LOG_USER : LOG_DAEMON);\n+\n+\t/* redirect other log messages to syslog as well */\n+\tFILE *log_stream = fopencookie(NULL, \"w\", syslog_log_func);\n+\tif (log_stream != NULL)\n+\t\tdefault_log_stream = log_stream;\n+}\n+#endif\n+\n+/* Choose how log output is directed */\n+static void\n+log_output_selection(const char *id)\n+{\n+\tRTE_SET_USED(id);\n+\n+#ifndef RTE_EXEC_ENV_WINDOWS\n+\tbool is_terminal = isatty(STDERR_FILENO);\n+\n+\tif (using_syslog(is_terminal)) {\n+\t\tlog_open_syslog(id, is_terminal);\n+\t\treturn;\n+\t}\n+#endif\n \tif (rte_logs.time_format != EAL_LOG_TIMESTAMP_NONE)\n \t\trte_logs.print_func = log_print_with_timestamp;\n+}\n \n+/*\n+ * Called by rte_eal_init\n+ */\n+void\n+eal_log_init(const char *id)\n+{\n+\trte_logs.print_func = log_print;\n \tdefault_log_stream = stderr;\n \n+\tlog_output_selection(id);\n+\n #if RTE_LOG_DP_LEVEL >= RTE_LOG_DEBUG\n \tRTE_LOG(NOTICE, EAL,\n \t\t\"Debug dataplane logs available - lower performance\\n\");\n", "prefixes": [ "v16", "13/15" ] }