Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/138762/?format=api
{ "id": 138762, "url": "http://patches.dpdk.org/api/patches/138762/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/20240324024109.306614-10-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": "<20240324024109.306614-10-stephen@networkplumber.org>", "list_archive_url": "https://inbox.dpdk.org/dev/20240324024109.306614-10-stephen@networkplumber.org", "date": "2024-03-24T02:33:31", "name": "[v11,9/9] log: colorize log output", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "82b4f25e154a63ecfafed21bbf2ca1d0cf575763", "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/20240324024109.306614-10-stephen@networkplumber.org/mbox/", "series": [ { "id": 31607, "url": "http://patches.dpdk.org/api/series/31607/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=31607", "date": "2024-03-24T02:33:22", "name": "Logging unification and enhancements", "version": 11, "mbox": "http://patches.dpdk.org/series/31607/mbox/" } ], "comments": "http://patches.dpdk.org/api/patches/138762/comments/", "check": "fail", "checks": "http://patches.dpdk.org/api/patches/138762/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 642A743D36;\n\tSun, 24 Mar 2024 03:42:28 +0100 (CET)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 1FE9C40A6D;\n\tSun, 24 Mar 2024 03:41:35 +0100 (CET)", "from mail-pl1-f180.google.com (mail-pl1-f180.google.com\n [209.85.214.180])\n by mails.dpdk.org (Postfix) with ESMTP id 4966F4064A\n for <dev@dpdk.org>; Sun, 24 Mar 2024 03:41:28 +0100 (CET)", "by mail-pl1-f180.google.com with SMTP id\n d9443c01a7336-1deffa23bb9so24371965ad.2\n for <dev@dpdk.org>; Sat, 23 Mar 2024 19:41:28 -0700 (PDT)", "from hermes.local (204-195-123-203.wavecable.com. [204.195.123.203])\n by smtp.gmail.com with ESMTPSA id\n q17-20020a17090311d100b001dc3c4e7a12sm2244980plh.14.2024.03.23.19.41.26\n (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);\n Sat, 23 Mar 2024 19:41:27 -0700 (PDT)" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=networkplumber-org.20230601.gappssmtp.com; s=20230601; t=1711248087;\n x=1711852887; 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=DmhxcTO2G7R7rt7pFjKteVsBa/8EY55YKFCvUAxoG4I=;\n b=NUEogCRp41zvGAHI/w9z0AfaT2gAH/4vCEZ9EAkjtfALEQFMgSGTugsh0R5oq6dBqC\n iEbcaf4/ReolRUCXao4/3mDGIRhmqVHBEpi7pCcYi9kgExU5Iln1Yy9FYyL/ZkBR5eJZ\n /K2l4c0d3aoGoSnz7Z36OMGwV7a/wofWeE2kuBYHQbJkX+kyy/ycCOhLnM/Gr0QrNRBD\n sPruzdbNImHuEwIUVJwLydTJIzvZ6tXAkTkMKb2+/DopOzA5oSCEZl1WP69oNmxKEPMs\n AkUhaGyCg4rpXzPfEhgf3gPKVYJi3tMopPl5zAljK5N8Dd16oDAZxVWNMbVWjpYJ9StQ\n GSxQ==", "X-Google-DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=1e100.net; s=20230601; t=1711248087; x=1711852887;\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=DmhxcTO2G7R7rt7pFjKteVsBa/8EY55YKFCvUAxoG4I=;\n b=pkUp2NLaQtdIcacCDKCGbkDulMMwYlFg9lnDAf8S5qjnS6yYH7UcdyQ4CBUkWUlIUl\n EHUJHeVwq4G1jA/wc4vz2H50PlU/43iXlAnevDPj9/vSx26W9NQzeBo7i4jS3A8tbTCU\n EtFu2j4ivOCSNhPIYIqGM665aNJeyy1p+qUYNS+ULcD6FJk7eetU/5eShz26uh8i8QQT\n 83qtyl9wohX5Ee28AE1WuYt6k3qUxjCS5YBe1zEEnwU7J8JTpDB5cXOoC7wbc0mIxxS4\n EoRMJhahVOfrqwLRuvcxzLjgktTggnv/9AFXns6halS4MRRonEKCvnaTLc8BjQD1crv1\n hzgQ==", "X-Gm-Message-State": "AOJu0YzuXIOGmlCcm9rEHZAW+TLIi9m3/YQIJpMnkY0sjhh6CUj1401U\n O1+gCi1kqUtUrouBnZCH/sWM2HmZRTB1mbb6fv2gyWm+lBfbxkUrU7+4cROZI+5XQmX0IMM3KrE\n n", "X-Google-Smtp-Source": "\n AGHT+IFRH+nr4yLeqrH6sLgIz0L2ylLruCRo3j6KSUII6QJUqGDtXx9pL2n8jIkJaYX2vSAVUDWGLQ==", "X-Received": "by 2002:a17:902:b48b:b0:1dc:abeb:22fe with SMTP id\n y11-20020a170902b48b00b001dcabeb22femr3227103plr.65.1711248087348;\n Sat, 23 Mar 2024 19:41:27 -0700 (PDT)", "From": "Stephen Hemminger <stephen@networkplumber.org>", "To": "dev@dpdk.org", "Cc": "Stephen Hemminger <stephen@networkplumber.org>", "Subject": "[PATCH v11 9/9] log: colorize log output", "Date": "Sat, 23 Mar 2024 19:33:31 -0700", "Message-ID": "<20240324024109.306614-10-stephen@networkplumber.org>", "X-Mailer": "git-send-email 2.43.0", "In-Reply-To": "<20240324024109.306614-1-stephen@networkplumber.org>", "References": "<20200814173441.23086-1-stephen@networkplumber.org>\n <20240324024109.306614-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": "Like dmesg, colorize the log output (unless redirected to file).\nTimestamp is green, the subsystem is in yellow and the message\nis red if urgent, boldface if an error, and normal for info and\ndebug messages.\n\nSigned-off-by: Stephen Hemminger <stephen@networkplumber.org>\n---\n doc/guides/prog_guide/log_lib.rst | 14 ++-\n lib/eal/common/eal_common_options.c | 1 +\n lib/eal/common/eal_options.h | 2 +\n lib/log/log.c | 153 +++++++++++++++++++++++++++-\n lib/log/log_internal.h | 5 +\n lib/log/version.map | 1 +\n 6 files changed, 173 insertions(+), 3 deletions(-)", "diff": "diff --git a/doc/guides/prog_guide/log_lib.rst b/doc/guides/prog_guide/log_lib.rst\nindex 83949cce35..e0cb9bb9ed 100644\n--- a/doc/guides/prog_guide/log_lib.rst\n+++ b/doc/guides/prog_guide/log_lib.rst\n@@ -58,6 +58,19 @@ For example::\n \n Within an application, the same result can be got using the ``rte_log_set_level_pattern()`` or ``rte_log_set_level_regex()`` APIs.\n \n+Color output\n+~~~~~~~~~~~~\n+\n+It is useful ot be able see important messages highlighted. This is controlled by the\n+``--log-color`` option. The optional argument ``when`` can be ``auto``, ``never``,\n+or ``always``.The default setting is ``auto`` which enables color when the output to\n+``stderr`` is a terminal. If the ``when`` argument is omitted, it defaults to ``always``.\n+\n+For example to turn off all coloring::\n+\n+\t/path/to/app --log-color=none\n+\n+\n Console timestamp\n ~~~~~~~~~~~~~~~~~\n \n@@ -83,7 +96,6 @@ To prefix all console messages with ISO format time the syntax is::\n \t/path/to/app --log-timestamp=iso\n \n \n-\n Using Logging APIs to Generate Log Messages\n -------------------------------------------\n \ndiff --git a/lib/eal/common/eal_common_options.c b/lib/eal/common/eal_common_options.c\nindex bc6d87266d..0da6729c64 100644\n--- a/lib/eal/common/eal_common_options.c\n+++ b/lib/eal/common/eal_common_options.c\n@@ -75,6 +75,7 @@ eal_long_options[] = {\n \t{OPT_LCORES, 1, NULL, OPT_LCORES_NUM },\n \t{OPT_LOG_LEVEL, 1, NULL, OPT_LOG_LEVEL_NUM },\n \t{OPT_LOG_TIMESTAMP, 2, NULL, OPT_LOG_TIMESTAMP_NUM },\n+\t{OPT_LOG_COLOR,\t\t1, NULL, OPT_LOG_COLOR_NUM\t },\n \t{OPT_TRACE, 1, NULL, OPT_TRACE_NUM },\n \t{OPT_TRACE_DIR, 1, NULL, OPT_TRACE_DIR_NUM },\n \t{OPT_TRACE_BUF_SIZE, 1, NULL, OPT_TRACE_BUF_SIZE_NUM },\ndiff --git a/lib/eal/common/eal_options.h b/lib/eal/common/eal_options.h\nindex 197b7b25ef..c1696d75e5 100644\n--- a/lib/eal/common/eal_options.h\n+++ b/lib/eal/common/eal_options.h\n@@ -37,6 +37,8 @@ enum {\n \tOPT_LOG_LEVEL_NUM,\n #define OPT_LOG_TIMESTAMP \"log-timestamp\"\n \tOPT_LOG_TIMESTAMP_NUM,\n+#define OPT_LOG_COLOR\t \"log-color\"\n+\tOPT_LOG_COLOR_NUM,\n #define OPT_TRACE \"trace\"\n \tOPT_TRACE_NUM,\n #define OPT_TRACE_DIR \"trace-dir\"\ndiff --git a/lib/log/log.c b/lib/log/log.c\nindex 4cfa160e3b..e75ed804ec 100644\n--- a/lib/log/log.c\n+++ b/lib/log/log.c\n@@ -22,6 +22,7 @@\n #include <sys/un.h>\n #endif\n \n+#include <rte_common.h>\n #include <rte_log.h>\n #include <rte_per_lcore.h>\n \n@@ -41,6 +42,12 @@ enum eal_log_time_format {\n \tEAL_LOG_TIMESTAMP_ISO,\n };\n \n+enum eal_log_color {\n+\tEAL_LOG_COLOR_AUTO = 0,\t/* default */\n+\tEAL_LOG_COLOR_NEVER,\n+\tEAL_LOG_COLOR_ALWAYS,\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@@ -53,6 +60,7 @@ static struct rte_logs {\n \tint journal_fd;\t/**< Journal file descriptor if using */\n \tlog_print_t print_func;\n \n+\tenum eal_log_color color_mode;\n \tenum eal_log_time_format time_format;\n \tstruct timespec started; /* when log was initialized */\n \tstruct timespec previous; /* when last msg was printed */\n@@ -665,6 +673,74 @@ format_timestamp(char *tsbuf, size_t tsbuflen)\n \treturn 0;\n }\n \n+enum color {\n+\tCOLOR_NONE,\n+\tCOLOR_RED,\n+\tCOLOR_GREEN,\n+\tCOLOR_YELLOW,\n+\tCOLOR_BLUE,\n+\tCOLOR_MAGENTA,\n+\tCOLOR_CYAN,\n+\tCOLOR_WHITE,\n+\tCOLOR_BOLD,\n+\tCOLOR_CLEAR\n+};\n+\n+static const char * const color_code[] = {\n+\t[COLOR_NONE]\t= \"\",\n+\t[COLOR_RED]\t= \"\\e[31m\",\n+\t[COLOR_GREEN]\t= \"\\e[32m\",\n+\t[COLOR_YELLOW]\t= \"\\e[33m\",\n+\t[COLOR_BLUE]\t= \"\\e[34m\",\n+\t[COLOR_MAGENTA] = \"\\e[35m\",\n+\t[COLOR_CYAN] = \"\\e[36m\",\n+\t[COLOR_WHITE]\t= \"\\e[37m\",\n+\t[COLOR_BOLD]\t= \"\\e[1m\",\n+\t[COLOR_CLEAR]\t= \"\\e[0m\",\n+};\n+\n+__rte_format_printf(3, 4)\n+static int color_fprintf(FILE *out, enum color color, const char *fmt, ...)\n+{\n+\tva_list args;\n+\tint ret = 0;\n+\n+\tva_start(args, fmt);\n+\tret = fprintf(out, \"%s\", color_code[color]);\n+\tret += vfprintf(out, fmt, args);\n+\tret += fprintf(out, \"%s\", color_code[COLOR_CLEAR]);\n+\n+\treturn ret;\n+}\n+\n+static ssize_t\n+color_log_write(FILE *f, int level, char *msg)\n+{\n+\tchar *cp;\n+\tssize_t ret = 0;\n+\n+\t/*\n+\t * use convention that first part of message (up to the ':' character)\n+\t * is the subsystem id and should be highlighted.\n+\t */\n+\tcp = strchr(msg, ':');\n+\tif (cp) {\n+\t\t/* print first part in yellow */\n+\t\tret = color_fprintf(stderr, COLOR_YELLOW, \"%.*s\",\n+\t\t\t\t (int)(cp - msg + 1), msg);\n+\t\tmsg = cp + 1;\n+\t}\n+\n+\tif (level <= 0 || level >= (int)RTE_LOG_INFO)\n+\t\tret += fprintf(f, \"%s\", msg);\n+\telse if (level >= (int)RTE_LOG_ERR)\n+\t\tret += color_fprintf(f, COLOR_BOLD, \"%s\", msg);\n+\telse\n+\t\tret += color_fprintf(f, COLOR_RED, \"%s\", msg);\n+\n+\treturn ret;\n+}\n+\n /* default log print function */\n __rte_format_printf(3, 0)\n static int\n@@ -688,6 +764,70 @@ log_print_with_timestamp(FILE *f, uint32_t level,\n \treturn log_print(f, level, format, ap);\n }\n \n+__rte_format_printf(3, 0)\n+static int\n+color_print(FILE *f, uint32_t level, const char *format, va_list ap)\n+{\n+\tchar *buf = NULL;\n+\n+\t/* need to make temporary buffer for color scan */\n+\tif (vasprintf(&buf, format, ap) > 0)\n+\t\treturn color_log_write(f, level, buf);\n+\n+\t/* if vasprintf fails, print without color */\n+\treturn log_print(f, level, format, ap);\n+}\n+\n+__rte_format_printf(3, 0)\n+static int\n+color_print_with_timestamp(FILE *f, uint32_t level,\n+\t\t\t const char *format, va_list ap)\n+{\n+\tchar tsbuf[128];\n+\n+\tif (format_timestamp(tsbuf, sizeof(tsbuf)) > 0)\n+\t\tcolor_fprintf(f, COLOR_GREEN, \"[%s] \", tsbuf);\n+\n+\treturn color_print(f, level, format, ap);\n+}\n+\n+/*\n+ * Controls whether color is enabled:\n+ * modes are:\n+ * always - enable color output regardless\n+ * auto - enable if stderr is a terminal\n+ * never - color output is disabled.\n+ */\n+int\n+eal_log_color(const char *mode)\n+{\n+\tif (mode == NULL || strcmp(mode, \"always\") == 0)\n+\t\trte_logs.color_mode = EAL_LOG_COLOR_ALWAYS;\n+\telse if (strcmp(mode, \"never\") == 0)\n+\t\trte_logs.color_mode = EAL_LOG_COLOR_NEVER;\n+\telse if (strcmp(mode, \"auto\") == 0)\n+\t\trte_logs.color_mode = EAL_LOG_COLOR_AUTO;\n+\telse\n+\t\treturn -1;\n+\n+\treturn 0;\n+}\n+\n+static bool\n+use_color(int out_fd)\n+{\n+\tswitch (rte_logs.color_mode) {\n+\tdefault:\n+\tcase EAL_LOG_COLOR_NEVER:\n+\t\treturn false;\n+\tcase EAL_LOG_COLOR_ALWAYS:\n+\t\treturn true;\n+\tcase EAL_LOG_COLOR_AUTO:\n+\t\treturn !!isatty(out_fd);\n+\t}\n+\n+}\n+\n #ifdef RTE_EXEC_ENV_LINUX\n /*\n * send message using journal protocol to journald\n@@ -817,10 +957,19 @@ eal_log_init(const char *id __rte_unused)\n \t\t\trte_logs.print_func = journal_print;\n \t\t\tjournal_send_id(jfd, id);\n \t\t}\n+\n \t} else\n #endif\n-\tif (rte_logs.time_format != EAL_LOG_TIMESTAMP_NONE) {\n-\t\trte_logs.print_func = log_print_with_timestamp;\n+\tif (use_color(STDERR_FILENO)) {\n+\t\tif (rte_logs.time_format != EAL_LOG_TIMESTAMP_NONE)\n+\t\t\trte_logs.print_func = color_print_with_timestamp;\n+\t\telse\n+\t\t\trte_logs.print_func = color_print;\n+\t} else {\n+\t\tif (rte_logs.time_format != EAL_LOG_TIMESTAMP_NONE)\n+\t\t\trte_logs.print_func = log_print_with_timestamp;\n+\t\telse\n+\t\t\trte_logs.print_func = log_print;\n \t}\n \n #if RTE_LOG_DP_LEVEL >= RTE_LOG_DEBUG\ndiff --git a/lib/log/log_internal.h b/lib/log/log_internal.h\nindex 3544ae49ac..5b8bb6ffc9 100644\n--- a/lib/log/log_internal.h\n+++ b/lib/log/log_internal.h\n@@ -50,5 +50,10 @@ void rte_eal_log_cleanup(void);\n __rte_internal\n int eal_log_timestamp(const char *fmt);\n \n+/*\n+ * Enable or disable color in log messages\n+ */\n+__rte_internal\n+int eal_log_color(const char *mode);\n \n #endif /* LOG_INTERNAL_H */\ndiff --git a/lib/log/version.map b/lib/log/version.map\nindex 7fd5b39e3a..9ca561b05b 100644\n--- a/lib/log/version.map\n+++ b/lib/log/version.map\n@@ -25,6 +25,7 @@ DPDK_24 {\n INTERNAL {\n \tglobal:\n \n+\teal_log_color;\n \teal_log_init;\n \teal_log_level2str;\n \teal_log_save_pattern;\n", "prefixes": [ "v11", "9/9" ] }