Patch Detail

HTTP 200 OK
Allow: GET, PUT, PATCH, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "id": 88890,
    "url": "http://patchwork.dpdk.org/api/patches/88890/?format=api",
    "web_url": "http://patchwork.dpdk.org/project/dpdk/patch/20210310172430.412405-2-bruce.richardson@intel.com/",
    "project": {
        "id": 1,
        "url": "http://patchwork.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": "<20210310172430.412405-2-bruce.richardson@intel.com>",
    "list_archive_url": "https://inbox.dpdk.org/dev/20210310172430.412405-2-bruce.richardson@intel.com",
    "date": "2021-03-10T17:24:27",
    "name": "[1/4] telemetry: use rte_log for logging",
    "commit_ref": null,
    "pull_url": null,
    "state": "superseded",
    "archived": true,
    "hash": "78930ca19a9c18746b72c70066364d5d1617402a",
    "submitter": {
        "id": 20,
        "url": "http://patchwork.dpdk.org/api/people/20/?format=api",
        "name": "Bruce Richardson",
        "email": "bruce.richardson@intel.com"
    },
    "delegate": {
        "id": 1,
        "url": "http://patchwork.dpdk.org/api/users/1/?format=api",
        "username": "tmonjalo",
        "first_name": "Thomas",
        "last_name": "Monjalon",
        "email": "thomas@monjalon.net"
    },
    "mbox": "http://patchwork.dpdk.org/project/dpdk/patch/20210310172430.412405-2-bruce.richardson@intel.com/mbox/",
    "series": [
        {
            "id": 15587,
            "url": "http://patchwork.dpdk.org/api/series/15587/?format=api",
            "web_url": "http://patchwork.dpdk.org/project/dpdk/list/?series=15587",
            "date": "2021-03-10T17:24:26",
            "name": "telemetry logging improvements and cleanup",
            "version": 1,
            "mbox": "http://patchwork.dpdk.org/series/15587/mbox/"
        }
    ],
    "comments": "http://patchwork.dpdk.org/api/patches/88890/comments/",
    "check": "success",
    "checks": "http://patchwork.dpdk.org/api/patches/88890/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 19A15A056A;\n\tWed, 10 Mar 2021 18:24:46 +0100 (CET)",
            "from [217.70.189.124] (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id F097522A38A;\n\tWed, 10 Mar 2021 18:24:45 +0100 (CET)",
            "from mga06.intel.com (mga06.intel.com [134.134.136.31])\n by mails.dpdk.org (Postfix) with ESMTP id 492D022A387\n for <dev@dpdk.org>; Wed, 10 Mar 2021 18:24:44 +0100 (CET)",
            "from orsmga008.jf.intel.com ([10.7.209.65])\n by orsmga104.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;\n 10 Mar 2021 09:24:41 -0800",
            "from silpixa00399126.ir.intel.com ([10.237.223.188])\n by orsmga008.jf.intel.com with ESMTP; 10 Mar 2021 09:24:40 -0800"
        ],
        "IronPort-SDR": [
            "\n qNB5qD1RThTbg9xUgp8mPmMkD2Yevy01GEJWmWI+9FgE7Vy/m1/N/abIIW0xNclMKBDxwEf+cW\n KNkKJ4cZANlw==",
            "\n CRuXZ9zPqw1xOT6EwoVfyOWhf0LHSR/aX1BZKYuB/vcB9z0WRSonaDPUM0Ajw6X+WOTP4Fdfjz\n aDs/jB7SxMoA=="
        ],
        "X-IronPort-AV": [
            "E=McAfee;i=\"6000,8403,9919\"; a=\"249887291\"",
            "E=Sophos;i=\"5.81,237,1610438400\"; d=\"scan'208\";a=\"249887291\"",
            "E=Sophos;i=\"5.81,237,1610438400\"; d=\"scan'208\";a=\"410271649\""
        ],
        "X-ExtLoop1": "1",
        "From": "Bruce Richardson <bruce.richardson@intel.com>",
        "To": "dev@dpdk.org",
        "Cc": "Bruce Richardson <bruce.richardson@intel.com>,\n Kevin Laatz <kevin.laatz@intel.com>",
        "Date": "Wed, 10 Mar 2021 17:24:27 +0000",
        "Message-Id": "<20210310172430.412405-2-bruce.richardson@intel.com>",
        "X-Mailer": "git-send-email 2.27.0",
        "In-Reply-To": "<20210310172430.412405-1-bruce.richardson@intel.com>",
        "References": "<20210310172430.412405-1-bruce.richardson@intel.com>",
        "MIME-Version": "1.0",
        "Content-Transfer-Encoding": "8bit",
        "Subject": "[dpdk-dev] [PATCH 1/4] telemetry: use rte_log for logging",
        "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",
        "Sender": "\"dev\" <dev-bounces@dpdk.org>"
    },
    "content": "Rather than passing back an error string to the caller, take as input the\nrte_log function to use, and just use regular logging.\n\nSigned-off-by: Bruce Richardson <bruce.richardson@intel.com>\n---\n lib/librte_eal/freebsd/eal.c         | 10 ++--\n lib/librte_eal/linux/eal.c           | 10 ++--\n lib/librte_telemetry/rte_telemetry.h | 15 ++++--\n lib/librte_telemetry/telemetry.c     | 72 +++++++++++++---------------\n 4 files changed, 49 insertions(+), 58 deletions(-)\n\n--\n2.27.0",
    "diff": "diff --git a/lib/librte_eal/freebsd/eal.c b/lib/librte_eal/freebsd/eal.c\nindex e2cdad5283..b8a798bc7d 100644\n--- a/lib/librte_eal/freebsd/eal.c\n+++ b/lib/librte_eal/freebsd/eal.c\n@@ -941,15 +941,11 @@ rte_eal_init(int argc, char **argv)\n \t\treturn -1;\n \t}\n \tif (!internal_conf->no_telemetry) {\n-\t\tconst char *error_str = NULL;\n+\t\tuint32_t tlog = rte_log_register_type_and_pick_level(\n+\t\t\t\t\"lib.telemetry\", RTE_LOG_WARNING);\n \t\tif (rte_telemetry_init(rte_eal_get_runtime_dir(),\n-\t\t\t\t&internal_conf->ctrl_cpuset, &error_str)\n-\t\t\t\t!= 0) {\n-\t\t\trte_eal_init_alert(error_str);\n+\t\t\t\t&internal_conf->ctrl_cpuset, rte_log, tlog) != 0)\n \t\t\treturn -1;\n-\t\t}\n-\t\tif (error_str != NULL)\n-\t\t\tRTE_LOG(NOTICE, EAL, \"%s\\n\", error_str);\n \t}\n\n \teal_mcfg_complete();\ndiff --git a/lib/librte_eal/linux/eal.c b/lib/librte_eal/linux/eal.c\nindex 6c34ac8903..23e3a32036 100644\n--- a/lib/librte_eal/linux/eal.c\n+++ b/lib/librte_eal/linux/eal.c\n@@ -1314,15 +1314,11 @@ rte_eal_init(int argc, char **argv)\n \t\treturn -1;\n \t}\n \tif (!internal_conf->no_telemetry) {\n-\t\tconst char *error_str = NULL;\n+\t\tuint32_t tlog = rte_log_register_type_and_pick_level(\n+\t\t\t\t\"lib.telemetry\", RTE_LOG_WARNING);\n \t\tif (rte_telemetry_init(rte_eal_get_runtime_dir(),\n-\t\t\t\t&internal_conf->ctrl_cpuset, &error_str)\n-\t\t\t\t!= 0) {\n-\t\t\trte_eal_init_alert(error_str);\n+\t\t\t\t&internal_conf->ctrl_cpuset, rte_log, tlog) != 0)\n \t\t\treturn -1;\n-\t\t}\n-\t\tif (error_str != NULL)\n-\t\t\tRTE_LOG(NOTICE, EAL, \"%s\\n\", error_str);\n \t}\n\n \teal_mcfg_complete();\ndiff --git a/lib/librte_telemetry/rte_telemetry.h b/lib/librte_telemetry/rte_telemetry.h\nindex f8e54dc68e..2c3da3ab7f 100644\n--- a/lib/librte_telemetry/rte_telemetry.h\n+++ b/lib/librte_telemetry/rte_telemetry.h\n@@ -292,6 +292,12 @@ __rte_experimental\n int\n rte_telemetry_register_cmd(const char *cmd, telemetry_cb fn, const char *help);\n\n+/**\n+ * @internal\n+ * Log function type, to allow passing as parameter if necessary\n+ */\n+typedef int (*rte_log_fn)(uint32_t level, uint32_t logtype, const char *format, ...);\n+\n /**\n  * @internal\n  * Initialize Telemetry.\n@@ -300,9 +306,10 @@ rte_telemetry_register_cmd(const char *cmd, telemetry_cb fn, const char *help);\n  * The runtime directory of DPDK.\n  * @param cpuset\n  * The CPU set to be used for setting the thread affinity.\n- * @param err_str\n- * This err_str pointer should point to NULL on entry. In the case of an error\n- * or warning, it will be non-NULL on exit.\n+ * @param log_fn\n+ * Function pointer to the rte_log function for logging use\n+ * @param registered_logtype\n+ * The registered log type to use for logging\n  *\n  * @return\n  *  0 on success.\n@@ -312,7 +319,7 @@ rte_telemetry_register_cmd(const char *cmd, telemetry_cb fn, const char *help);\n __rte_internal\n int\n rte_telemetry_init(const char *runtime_dir, rte_cpuset_t *cpuset,\n-\t\tconst char **err_str);\n+\t\trte_log_fn log_fn, uint32_t registered_logtype);\n\n /**\n  * Get a pointer to a container with memory allocated. The container is to be\ndiff --git a/lib/librte_telemetry/telemetry.c b/lib/librte_telemetry/telemetry.c\nindex b142729da4..18f2ae2e2f 100644\n--- a/lib/librte_telemetry/telemetry.c\n+++ b/lib/librte_telemetry/telemetry.c\n@@ -16,6 +16,7 @@\n #include <rte_common.h>\n #include <rte_spinlock.h>\n #include <rte_version.h>\n+#include <rte_log.h>\n\n #include \"rte_telemetry.h\"\n #include \"telemetry_json.h\"\n@@ -48,7 +49,15 @@ struct socket {\n static struct socket v2_socket; /* socket for v2 telemetry */\n static struct socket v1_socket; /* socket for v1 telemetry */\n #endif /* !RTE_EXEC_ENV_WINDOWS */\n-static char telemetry_log_error[1024]; /* Will contain error on init failure */\n+\n+static const char *socket_dir;\n+static rte_cpuset_t *thread_cpuset;\n+static rte_log_fn rte_log_ptr;\n+static uint32_t logtype;\n+\n+#define TMTY_LOG(l, ...) \\\n+\t rte_log_ptr(RTE_LOG_ ## l, logtype, \"TELEMETRY: \" __VA_ARGS__)\n+\n /* list of command callbacks, with one command registered by default */\n static struct cmd_callback callbacks[TELEMETRY_MAX_CALLBACKS];\n static int num_callbacks; /* How many commands are registered */\n@@ -344,9 +353,7 @@ socket_listener(void *socket)\n \t\tstruct socket *s = (struct socket *)socket;\n \t\tint s_accepted = accept(s->sock, NULL, NULL);\n \t\tif (s_accepted < 0) {\n-\t\t\tsnprintf(telemetry_log_error,\n-\t\t\t\tsizeof(telemetry_log_error),\n-\t\t\t\t\"Error with accept, telemetry thread quitting\");\n+\t\t\tTMTY_LOG(ERR, \"Error with accept, telemetry thread quitting\\n\");\n \t\t\treturn NULL;\n \t\t}\n \t\tif (s->num_clients != NULL) {\n@@ -388,9 +395,7 @@ create_socket(char *path)\n {\n \tint sock = socket(AF_UNIX, SOCK_SEQPACKET, 0);\n \tif (sock < 0) {\n-\t\tsnprintf(telemetry_log_error, sizeof(telemetry_log_error),\n-\t\t\t\t\"Error with socket creation, %s\",\n-\t\t\t\tstrerror(errno));\n+\t\tTMTY_LOG(ERR, \"Error with socket creation, %s\\n\", strerror(errno));\n \t\treturn -1;\n \t}\n\n@@ -398,17 +403,13 @@ create_socket(char *path)\n \tstrlcpy(sun.sun_path, path, sizeof(sun.sun_path));\n \tunlink(sun.sun_path);\n \tif (bind(sock, (void *) &sun, sizeof(sun)) < 0) {\n-\t\tsnprintf(telemetry_log_error, sizeof(telemetry_log_error),\n-\t\t\t\t\"Error binding socket: %s\",\n-\t\t\t\tstrerror(errno));\n+\t\tTMTY_LOG(ERR, \"Error binding socket: %s\\n\", strerror(errno));\n \t\tsun.sun_path[0] = 0;\n \t\tgoto error;\n \t}\n\n \tif (listen(sock, 1) < 0) {\n-\t\tsnprintf(telemetry_log_error, sizeof(telemetry_log_error),\n-\t\t\t\t\"Error calling listen for socket: %s\",\n-\t\t\t\tstrerror(errno));\n+\t\tTMTY_LOG(ERR, \"Error calling listen for socket: %s\\n\", strerror(errno));\n \t\tgoto error;\n \t}\n\n@@ -421,35 +422,33 @@ create_socket(char *path)\n }\n\n static int\n-telemetry_legacy_init(const char *runtime_dir, rte_cpuset_t *cpuset)\n+telemetry_legacy_init(void)\n {\n \tpthread_t t_old;\n\n \tif (num_legacy_callbacks == 1) {\n-\t\tsnprintf(telemetry_log_error, sizeof(telemetry_log_error),\n-\t\t\t \"No legacy callbacks, legacy socket not created\");\n+\t\tTMTY_LOG(WARNING, \"No legacy callbacks, legacy socket not created\\n\");\n \t\treturn -1;\n \t}\n\n \tv1_socket.fn = legacy_client_handler;\n \tif ((size_t) snprintf(v1_socket.path, sizeof(v1_socket.path),\n-\t\t\t\"%s/telemetry\", runtime_dir)\n-\t\t\t>= sizeof(v1_socket.path)) {\n-\t\tsnprintf(telemetry_log_error, sizeof(telemetry_log_error),\n-\t\t\t\t\"Error with socket binding, path too long\");\n+\t\t\t\"%s/telemetry\", socket_dir) >= sizeof(v1_socket.path)) {\n+\t\tTMTY_LOG(ERR, \"Error with socket binding, path too long\\n\");\n \t\treturn -1;\n \t}\n \tv1_socket.sock = create_socket(v1_socket.path);\n \tif (v1_socket.sock < 0)\n \t\treturn -1;\n \tpthread_create(&t_old, NULL, socket_listener, &v1_socket);\n-\tpthread_setaffinity_np(t_old, sizeof(*cpuset), cpuset);\n+\tpthread_setaffinity_np(t_old, sizeof(*thread_cpuset), thread_cpuset);\n\n+\tTMTY_LOG(DEBUG, \"Legacy telemetry socket initialized ok\\n\");\n \treturn 0;\n }\n\n static int\n-telemetry_v2_init(const char *runtime_dir, rte_cpuset_t *cpuset)\n+telemetry_v2_init(void)\n {\n \tpthread_t t_new;\n\n@@ -461,10 +460,9 @@ telemetry_v2_init(const char *runtime_dir, rte_cpuset_t *cpuset)\n \trte_telemetry_register_cmd(\"/help\", command_help,\n \t\t\t\"Returns help text for a command. Parameters: string command\");\n \tv2_socket.fn = client_handler;\n-\tif (strlcpy(v2_socket.path, get_socket_path(runtime_dir, 2),\n+\tif (strlcpy(v2_socket.path, get_socket_path(socket_dir, 2),\n \t\t\tsizeof(v2_socket.path)) >= sizeof(v2_socket.path)) {\n-\t\tsnprintf(telemetry_log_error, sizeof(telemetry_log_error),\n-\t\t\t\t\"Error with socket binding, path too long\");\n+\t\tTMTY_LOG(ERR, \"Error with socket binding, path too long\\n\");\n \t\treturn -1;\n \t}\n\n@@ -472,7 +470,7 @@ telemetry_v2_init(const char *runtime_dir, rte_cpuset_t *cpuset)\n \tif (v2_socket.sock < 0)\n \t\treturn -1;\n \tpthread_create(&t_new, NULL, socket_listener, &v2_socket);\n-\tpthread_setaffinity_np(t_new, sizeof(*cpuset), cpuset);\n+\tpthread_setaffinity_np(t_new, sizeof(*thread_cpuset), thread_cpuset);\n \tatexit(unlink_sockets);\n\n \treturn 0;\n@@ -482,23 +480,17 @@ telemetry_v2_init(const char *runtime_dir, rte_cpuset_t *cpuset)\n\n int32_t\n rte_telemetry_init(const char *runtime_dir, rte_cpuset_t *cpuset,\n-\t\tconst char **err_str)\n+\t\trte_log_fn log_fn, uint32_t registered_logtype)\n {\n+\tsocket_dir = runtime_dir;\n+\tthread_cpuset = cpuset;\n+\trte_log_ptr = log_fn;\n+\tlogtype = registered_logtype;\n #ifndef RTE_EXEC_ENV_WINDOWS\n-\tif (telemetry_v2_init(runtime_dir, cpuset) != 0) {\n-\t\t*err_str = telemetry_log_error;\n+\tif (telemetry_v2_init() != 0)\n \t\treturn -1;\n-\t}\n-\tif (telemetry_legacy_init(runtime_dir, cpuset) != 0) {\n-\t\t*err_str = telemetry_log_error;\n-\t}\n-#else /* RTE_EXEC_ENV_WINDOWS */\n-\tRTE_SET_USED(runtime_dir);\n-\tRTE_SET_USED(cpuset);\n-\tRTE_SET_USED(err_str);\n-\n-\tsnprintf(telemetry_log_error, sizeof(telemetry_log_error),\n-\t\t\"DPDK Telemetry is not supported on Windows.\");\n+\tTMTY_LOG(DEBUG, \"Telemetry initialized ok\\n\");\n+\ttelemetry_legacy_init();\n #endif /* RTE_EXEC_ENV_WINDOWS */\n\n \treturn 0;\n",
    "prefixes": [
        "1/4"
    ]
}