Patch Detail

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

{
    "id": 122765,
    "url": "http://patches.dpdk.org/api/patches/122765/?format=api",
    "web_url": "http://patches.dpdk.org/project/dpdk/patch/1675197017-11287-2-git-send-email-roretzla@linux.microsoft.com/",
    "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": "<1675197017-11287-2-git-send-email-roretzla@linux.microsoft.com>",
    "list_archive_url": "https://inbox.dpdk.org/dev/1675197017-11287-2-git-send-email-roretzla@linux.microsoft.com",
    "date": "2023-01-31T20:30:15",
    "name": "[v5,1/3] eal: add rte control thread create API",
    "commit_ref": null,
    "pull_url": null,
    "state": "superseded",
    "archived": true,
    "hash": "9c9f2e129970b1226c0620a32731dc7f3848d551",
    "submitter": {
        "id": 2077,
        "url": "http://patches.dpdk.org/api/people/2077/?format=api",
        "name": "Tyler Retzlaff",
        "email": "roretzla@linux.microsoft.com"
    },
    "delegate": {
        "id": 24651,
        "url": "http://patches.dpdk.org/api/users/24651/?format=api",
        "username": "dmarchand",
        "first_name": "David",
        "last_name": "Marchand",
        "email": "david.marchand@redhat.com"
    },
    "mbox": "http://patches.dpdk.org/project/dpdk/patch/1675197017-11287-2-git-send-email-roretzla@linux.microsoft.com/mbox/",
    "series": [
        {
            "id": 26720,
            "url": "http://patches.dpdk.org/api/series/26720/?format=api",
            "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=26720",
            "date": "2023-01-31T20:30:15",
            "name": "[v5,1/3] eal: add rte control thread create API",
            "version": 5,
            "mbox": "http://patches.dpdk.org/series/26720/mbox/"
        }
    ],
    "comments": "http://patches.dpdk.org/api/patches/122765/comments/",
    "check": "success",
    "checks": "http://patches.dpdk.org/api/patches/122765/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 AF43141B92;\n\tTue, 31 Jan 2023 21:30:26 +0100 (CET)",
            "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 5423F41148;\n\tTue, 31 Jan 2023 21:30:22 +0100 (CET)",
            "from linux.microsoft.com (linux.microsoft.com [13.77.154.182])\n by mails.dpdk.org (Postfix) with ESMTP id 168DC40684\n for <dev@dpdk.org>; Tue, 31 Jan 2023 21:30:20 +0100 (CET)",
            "by linux.microsoft.com (Postfix, from userid 1086)\n id 61C1A20DFE36; Tue, 31 Jan 2023 12:30:19 -0800 (PST)"
        ],
        "DKIM-Filter": "OpenDKIM Filter v2.11.0 linux.microsoft.com 61C1A20DFE36",
        "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed; d=linux.microsoft.com;\n s=default; t=1675197019;\n bh=CkvX5kpcCGSAR+cv90wGMGQ0qk5sV09Lq7BSmCN2F88=;\n h=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n b=o3eX+MVgt4w5FSeftDDiw8mc4kanUTQBtCJkB3VFbl3xo3yP0Kn89CYR4B55exBYL\n 9P+/MFOYeeJ5xYOAXYRv891mRBXsAxtIboW3bpI0G8vEL2AQfrYSgZI5JvYNbWOxXB\n 6vD18MHFRjJHBub3cMxzmm1SWv7eK6yQNXBbAUyo=",
        "From": "Tyler Retzlaff <roretzla@linux.microsoft.com>",
        "To": "dev@dpdk.org",
        "Cc": "david.marchand@redhat.com, thomas@monjalon.net, olivier.matz@6wind.com,\n stephen@networkplumber.org, mb@smartsharesystems.com,\n hofors@lysator.liu.se, Tyler Retzlaff <roretzla@linux.microsoft.com>",
        "Subject": "[PATCH v5 1/3] eal: add rte control thread create API",
        "Date": "Tue, 31 Jan 2023 12:30:15 -0800",
        "Message-Id": "<1675197017-11287-2-git-send-email-roretzla@linux.microsoft.com>",
        "X-Mailer": "git-send-email 1.8.3.1",
        "In-Reply-To": "<1675197017-11287-1-git-send-email-roretzla@linux.microsoft.com>",
        "References": "<1670271868-11364-1-git-send-email-roretzla@linux.microsoft.com>\n <1675197017-11287-1-git-send-email-roretzla@linux.microsoft.com>",
        "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 <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": "Add rte_control_thread_create API as a replacement for\nrte_ctrl_thread_create to allow deprecation of the use of platform\nspecific types in DPDK public API.\n\nDuplicate the rte_ctrl_thread_create test adapted to use\nrte_control_thread create to keep both APIs under test until\nrte_ctrl_thread_create is removed.\n\nSigned-off-by: Tyler Retzlaff <roretzla@linux.microsoft.com>\nAcked-by: Morten Brørup <mb@smartsharesystems.com>\nReviewed-by: Mattias Rönnblom <mattias.ronnblom@ericsson.com>\n---\n app/test/test_lcores.c             | 41 ++++++++++++++++++\n lib/eal/common/eal_common_thread.c | 85 ++++++++++++++++++++++++++++++++++----\n lib/eal/include/rte_thread.h       | 33 +++++++++++++++\n lib/eal/version.map                |  1 +\n 4 files changed, 152 insertions(+), 8 deletions(-)",
    "diff": "diff --git a/app/test/test_lcores.c b/app/test/test_lcores.c\nindex 5b43aa5..9766f78 100644\n--- a/app/test/test_lcores.c\n+++ b/app/test/test_lcores.c\n@@ -353,6 +353,18 @@ static void *ctrl_thread_loop(void *arg)\n \treturn NULL;\n }\n \n+static uint32_t control_thread_loop(void *arg)\n+{\n+\tstruct thread_context *t = arg;\n+\n+\tprintf(\"Control thread running successfully\\n\");\n+\n+\t/* Set the thread state to DONE */\n+\tt->state = Thread_DONE;\n+\n+\treturn 0;\n+}\n+\n static int\n test_ctrl_thread(void)\n {\n@@ -380,6 +392,32 @@ static void *ctrl_thread_loop(void *arg)\n }\n \n static int\n+test_control_thread(void)\n+{\n+\tstruct thread_context ctrl_thread_context;\n+\tstruct thread_context *t;\n+\n+\t/* Create one control thread */\n+\tt = &ctrl_thread_context;\n+\tt->state = Thread_INIT;\n+\tif (rte_control_thread_create(&t->id, \"test_control_threads\",\n+\t\t\t\t\tNULL, control_thread_loop, t) != 0)\n+\t\treturn -1;\n+\n+\t/* Wait till the control thread exits.\n+\t * This also acts as the barrier such that the memory operations\n+\t * in control thread are visible to this thread.\n+\t */\n+\trte_thread_join(t->id, NULL);\n+\n+\t/* Check if the control thread set the correct state */\n+\tif (t->state != Thread_DONE)\n+\t\treturn -1;\n+\n+\treturn 0;\n+}\n+\n+static int\n test_lcores(void)\n {\n \tunsigned int eal_threads_count = 0;\n@@ -409,6 +447,9 @@ static void *ctrl_thread_loop(void *arg)\n \tif (test_ctrl_thread() < 0)\n \t\treturn TEST_FAILED;\n \n+\tif (test_control_thread() < 0)\n+\t\treturn TEST_FAILED;\n+\n \treturn TEST_SUCCESS;\n }\n \ndiff --git a/lib/eal/common/eal_common_thread.c b/lib/eal/common/eal_common_thread.c\nindex 3181515..7ea216e 100644\n--- a/lib/eal/common/eal_common_thread.c\n+++ b/lib/eal/common/eal_common_thread.c\n@@ -232,7 +232,10 @@ enum __rte_ctrl_thread_status {\n };\n \n struct rte_thread_ctrl_params {\n-\tvoid *(*start_routine)(void *);\n+\tunion {\n+\t\tvoid *(*ctrl_start_routine)(void *arg);\n+\t\trte_thread_func control_start_routine;\n+\t} u;\n \tvoid *arg;\n \tint ret;\n \t/* Control thread status.\n@@ -241,27 +244,47 @@ struct rte_thread_ctrl_params {\n \tenum __rte_ctrl_thread_status ctrl_thread_status;\n };\n \n-static void *ctrl_thread_init(void *arg)\n+static int ctrl_thread_init(void *arg)\n {\n \tstruct internal_config *internal_conf =\n \t\teal_get_internal_configuration();\n \trte_cpuset_t *cpuset = &internal_conf->ctrl_cpuset;\n \tstruct rte_thread_ctrl_params *params = arg;\n-\tvoid *(*start_routine)(void *) = params->start_routine;\n-\tvoid *routine_arg = params->arg;\n \n \t__rte_thread_init(rte_lcore_id(), cpuset);\n \tparams->ret = rte_thread_set_affinity_by_id(rte_thread_self(), cpuset);\n \tif (params->ret != 0) {\n \t\t__atomic_store_n(&params->ctrl_thread_status,\n \t\t\tCTRL_THREAD_ERROR, __ATOMIC_RELEASE);\n-\t\treturn NULL;\n+\t\treturn params->ret;\n \t}\n \n \t__atomic_store_n(&params->ctrl_thread_status,\n \t\tCTRL_THREAD_RUNNING, __ATOMIC_RELEASE);\n \n-\treturn start_routine(routine_arg);\n+\treturn 0;\n+}\n+\n+static void *ctrl_thread_start(void *arg)\n+{\n+\tstruct rte_thread_ctrl_params *params = arg;\n+\tvoid *(*start_routine)(void *) = params->u.ctrl_start_routine;\n+\n+\tif (ctrl_thread_init(arg) != 0)\n+\t\treturn NULL;\n+\n+\treturn start_routine(params->arg);\n+}\n+\n+static uint32_t control_thread_start(void *arg)\n+{\n+\tstruct rte_thread_ctrl_params *params = arg;\n+\trte_thread_func start_routine = params->u.control_start_routine;\n+\n+\tif (ctrl_thread_init(arg) != 0)\n+\t\treturn params->ret;\n+\n+\treturn start_routine(params->arg);\n }\n \n int\n@@ -277,12 +300,12 @@ static void *ctrl_thread_init(void *arg)\n \tif (!params)\n \t\treturn -ENOMEM;\n \n-\tparams->start_routine = start_routine;\n+\tparams->u.ctrl_start_routine = start_routine;\n \tparams->arg = arg;\n \tparams->ret = 0;\n \tparams->ctrl_thread_status = CTRL_THREAD_LAUNCHING;\n \n-\tret = pthread_create(thread, attr, ctrl_thread_init, (void *)params);\n+\tret = pthread_create(thread, attr, ctrl_thread_start, (void *)params);\n \tif (ret != 0) {\n \t\tfree(params);\n \t\treturn -ret;\n@@ -315,6 +338,52 @@ static void *ctrl_thread_init(void *arg)\n }\n \n int\n+rte_control_thread_create(rte_thread_t *thread, const char *name,\n+\tconst rte_thread_attr_t *attr,\n+\trte_thread_func start_routine, void *arg)\n+{\n+\tstruct rte_thread_ctrl_params *params;\n+\tenum __rte_ctrl_thread_status ctrl_thread_status;\n+\tint ret;\n+\n+\tparams = malloc(sizeof(*params));\n+\tif (params == NULL)\n+\t\treturn -ENOMEM;\n+\n+\tparams->u.control_start_routine = start_routine;\n+\tparams->arg = arg;\n+\tparams->ret = 0;\n+\tparams->ctrl_thread_status = CTRL_THREAD_LAUNCHING;\n+\n+\tret = rte_thread_create(thread, attr, control_thread_start, params);\n+\tif (ret != 0) {\n+\t\tfree(params);\n+\t\treturn -ret;\n+\t}\n+\n+\tif (name != NULL)\n+\t\trte_thread_set_name(*thread, name);\n+\n+\t/* Wait for the control thread to initialize successfully */\n+\twhile ((ctrl_thread_status =\n+\t\t\t__atomic_load_n(&params->ctrl_thread_status,\n+\t\t\t__ATOMIC_ACQUIRE)) == CTRL_THREAD_LAUNCHING) {\n+\t\trte_delay_us_sleep(1);\n+\t}\n+\n+\t/* Check if the control thread encountered an error */\n+\tif (ctrl_thread_status == CTRL_THREAD_ERROR) {\n+\t\t/* ctrl thread is exiting */\n+\t\trte_thread_join(*thread, NULL);\n+\t}\n+\n+\tret = params->ret;\n+\tfree(params);\n+\n+\treturn ret;\n+}\n+\n+int\n rte_thread_register(void)\n {\n \tunsigned int lcore_id;\ndiff --git a/lib/eal/include/rte_thread.h b/lib/eal/include/rte_thread.h\nindex d247930..792d8b0 100644\n--- a/lib/eal/include/rte_thread.h\n+++ b/lib/eal/include/rte_thread.h\n@@ -98,6 +98,39 @@ int rte_thread_create(rte_thread_t *thread_id,\n  * @warning\n  * @b EXPERIMENTAL: this API may change without prior notice.\n  *\n+ * Create a control thread.\n+ *\n+ * Creates a control thread with the given name and attributes. The\n+ * affinity of the new thread is based on the CPU affinity retrieved\n+ * at the time rte_eal_init() was called, the EAL threads are then\n+ * excluded. If setting the name of the thread fails, the error is\n+ * ignored and a debug message is logged.\n+ *\n+ * @param thread\n+ *   Filled with the thread id of the new created thread.\n+ * @param name\n+ *   The name of the control thread\n+ *   (max RTE_MAX_THREAD_NAME_LEN characters including '\\0').\n+ * @param thread_attr\n+ *   Attributes for the new thread.\n+ * @param thread_func\n+ *   Function to be executed by the new thread.\n+ * @param arg\n+ *   Argument passed to start_routine.\n+ * @return\n+ *   On success, returns 0; on error, it returns a negative value\n+ *   corresponding to the error number.\n+ */\n+__rte_experimental\n+int\n+rte_control_thread_create(rte_thread_t *thread, const char *name,\n+\t\tconst rte_thread_attr_t *thread_attr,\n+\t\trte_thread_func thread_func, void *arg);\n+\n+/**\n+ * @warning\n+ * @b EXPERIMENTAL: this API may change without prior notice.\n+ *\n  * Waits for the thread identified by 'thread_id' to terminate\n  *\n  * @param thread_id\ndiff --git a/lib/eal/version.map b/lib/eal/version.map\nindex 6523102..a9d0a03 100644\n--- a/lib/eal/version.map\n+++ b/lib/eal/version.map\n@@ -441,6 +441,7 @@ EXPERIMENTAL {\n \trte_thread_join;\n \n \t# added in 23.03\n+\trte_control_thread_create;\n \trte_thread_set_name;\n };\n \n",
    "prefixes": [
        "v5",
        "1/3"
    ]
}