Patch Detail

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

{
    "id": 104141,
    "url": "https://patches.dpdk.org/api/patches/104141/?format=api",
    "web_url": "https://patches.dpdk.org/project/dpdk/patch/1636594425-9692-9-git-send-email-navasile@linux.microsoft.com/",
    "project": {
        "id": 1,
        "url": "https://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": "<1636594425-9692-9-git-send-email-navasile@linux.microsoft.com>",
    "list_archive_url": "https://inbox.dpdk.org/dev/1636594425-9692-9-git-send-email-navasile@linux.microsoft.com",
    "date": "2021-11-11T01:33:45",
    "name": "[v18,8/8] eal: implement functions for mutex management",
    "commit_ref": null,
    "pull_url": null,
    "state": "superseded",
    "archived": true,
    "hash": "65e9d7b314bbd50b71244934fef1c35b52f8d6a3",
    "submitter": {
        "id": 1668,
        "url": "https://patches.dpdk.org/api/people/1668/?format=api",
        "name": "Narcisa Ana Maria Vasile",
        "email": "navasile@linux.microsoft.com"
    },
    "delegate": {
        "id": 24651,
        "url": "https://patches.dpdk.org/api/users/24651/?format=api",
        "username": "dmarchand",
        "first_name": "David",
        "last_name": "Marchand",
        "email": "david.marchand@redhat.com"
    },
    "mbox": "https://patches.dpdk.org/project/dpdk/patch/1636594425-9692-9-git-send-email-navasile@linux.microsoft.com/mbox/",
    "series": [
        {
            "id": 20472,
            "url": "https://patches.dpdk.org/api/series/20472/?format=api",
            "web_url": "https://patches.dpdk.org/project/dpdk/list/?series=20472",
            "date": "2021-11-11T01:33:40",
            "name": "eal: Add EAL API for threading",
            "version": 18,
            "mbox": "https://patches.dpdk.org/series/20472/mbox/"
        }
    ],
    "comments": "https://patches.dpdk.org/api/patches/104141/comments/",
    "check": "warning",
    "checks": "https://patches.dpdk.org/api/patches/104141/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 590D9A0C4B;\n\tThu, 11 Nov 2021 02:35:21 +0100 (CET)",
            "from [217.70.189.124] (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id C55C441158;\n\tThu, 11 Nov 2021 02:35:00 +0100 (CET)",
            "from linux.microsoft.com (linux.microsoft.com [13.77.154.182])\n by mails.dpdk.org (Postfix) with ESMTP id 3149D40DF5\n for <dev@dpdk.org>; Thu, 11 Nov 2021 02:34:54 +0100 (CET)",
            "by linux.microsoft.com (Postfix, from userid 1059)\n id ED54220C358B; Wed, 10 Nov 2021 17:34:52 -0800 (PST)"
        ],
        "DKIM-Filter": "OpenDKIM Filter v2.11.0 linux.microsoft.com ED54220C358B",
        "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed; d=linux.microsoft.com;\n s=default; t=1636594492;\n bh=arzBqOCEVzJfUYyLX/tPn4p8iFMgMhzQpz4cg0+/aeM=;\n h=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n b=iN/Ukq9f74e2G25t9jNpb6N+9Qyblq995TKw2xrAVkAGcIqzQLev2+jAS7exSV/V3\n 6ij0JOr2AWppnrP2hMEVNaFYvgGpNmewIuCCa1jnKG8NnlbluhT/7z+V0h07Xyb5Jy\n 8nBbEnS2X52ZZg7F/fKDeu8eqJazpzpvRugibSCQ=",
        "From": "Narcisa Ana Maria Vasile <navasile@linux.microsoft.com>",
        "To": "dev@dpdk.org, thomas@monjalon.net, dmitry.kozliuk@gmail.com,\n khot@microsoft.com, navasile@microsoft.com, dmitrym@microsoft.com,\n roretzla@microsoft.com, talshn@nvidia.com, ocardona@microsoft.com",
        "Cc": "bruce.richardson@intel.com, david.marchand@redhat.com,\n pallavi.kadam@intel.com",
        "Subject": "[PATCH v18 8/8] eal: implement functions for mutex management",
        "Date": "Wed, 10 Nov 2021 17:33:45 -0800",
        "Message-Id": "<1636594425-9692-9-git-send-email-navasile@linux.microsoft.com>",
        "X-Mailer": "git-send-email 1.8.3.1",
        "In-Reply-To": "<1636594425-9692-1-git-send-email-navasile@linux.microsoft.com>",
        "References": "<1636513302-7359-1-git-send-email-navasile@linux.microsoft.com>\n <1636594425-9692-1-git-send-email-navasile@linux.microsoft.com>",
        "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": "From: Narcisa Vasile <navasile@microsoft.com>\n\nAdd functions for mutex init, destroy, lock, unlock, trylock.\n\nWindows does not have a static initializer. Initialization\nis only done through InitializeCriticalSection(). To overcome this,\nRTE_INIT_MUTEX macro is added to replace static initialization\nof mutexes. The macro calls rte_thread_mutex_init().\n\nAdd unit tests to verify that the mutex correctly locks/unlocks\nand protects the data. Check both static and dynamic mutexes.\n\nSigned-off-by: Narcisa Vasile <navasile@microsoft.com>\n---\n app/test/test_threads.c      | 106 +++++++++++++++++++++++++++++++++++\n lib/eal/common/rte_thread.c  |  69 +++++++++++++++++++++++\n lib/eal/include/rte_thread.h |  85 ++++++++++++++++++++++++++++\n lib/eal/version.map          |   5 ++\n lib/eal/windows/rte_thread.c |  64 +++++++++++++++++++++\n 5 files changed, 329 insertions(+)",
    "diff": "diff --git a/app/test/test_threads.c b/app/test/test_threads.c\nindex 00f604ab7e..91155a04e3 100644\n--- a/app/test/test_threads.c\n+++ b/app/test/test_threads.c\n@@ -243,6 +243,110 @@ test_thread_barrier(void)\n \treturn 0;\n }\n \n+RTE_INIT_MUTEX(static_mutex);\n+\n+struct mutex_loop_args {\n+\trte_thread_barrier *barrier;\n+\trte_thread_mutex *mutex;\n+\tunsigned long result_A;\n+\tunsigned long result_B;\n+};\n+\n+static void *\n+thread_loop_mutex_B(void *arg)\n+{\n+\tstruct mutex_loop_args *args = arg;\n+\n+\tif (rte_thread_mutex_try_lock(args->mutex) == 0) {\n+\t\trte_thread_barrier_wait(args->barrier);\n+\t\trte_thread_mutex_unlock(args->mutex);\n+\t\targs->result_B = 1;\n+\t} else {\n+\t\trte_thread_barrier_wait(args->barrier);\n+\t\targs->result_B = 2;\n+\t}\n+\n+\treturn NULL;\n+}\n+\n+static void *\n+thread_loop_mutex_A(void *arg)\n+{\n+\tstruct mutex_loop_args *args = arg;\n+\n+\tif (rte_thread_mutex_try_lock(args->mutex) != 0) {\n+\t\trte_thread_barrier_wait(args->barrier);\n+\t\targs->result_A = 2;\n+\t} else {\n+\t\trte_thread_barrier_wait(args->barrier);\n+\t\trte_thread_mutex_unlock(args->mutex);\n+\t\targs->result_A = 1;\n+\t}\n+\n+\treturn NULL;\n+}\n+\n+static int\n+test_thread_mutex(rte_thread_mutex *pmutex)\n+{\n+\trte_thread_t thread_A;\n+\trte_thread_t thread_B;\n+\trte_thread_mutex mutex;\n+\trte_thread_barrier barrier;\n+\tstruct mutex_loop_args args;\n+\tint ret = 0;\n+\n+\t/* If mutex is not statically initialized */\n+\tif (pmutex == NULL) {\n+\t\tret = rte_thread_mutex_init(&mutex);\n+\t\tRTE_TEST_ASSERT(ret == 0, \"Failed to initialize mutex!\");\n+\t} else\n+\t\tmutex = *pmutex;\n+\n+\tret = rte_thread_barrier_init(&barrier, 2);\n+\tRTE_TEST_ASSERT(ret == 0, \"Failed to initialize barrier!\");\n+\n+\targs.mutex = &mutex;\n+\targs.barrier = &barrier;\n+\n+\tret = rte_thread_create(&thread_A, NULL, thread_loop_mutex_A, &args);\n+\tRTE_TEST_ASSERT(ret == 0, \"Failed to create thread!\");\n+\n+\tret = rte_thread_create(&thread_B, NULL, thread_loop_mutex_B, &args);\n+\tRTE_TEST_ASSERT(ret == 0, \"Failed to create thread!\");\n+\n+\tret = rte_thread_join(thread_A, NULL);\n+\tRTE_TEST_ASSERT(ret == 0, \"Failed to join thread!\");\n+\n+\tret = rte_thread_join(thread_B, NULL);\n+\tRTE_TEST_ASSERT(ret == 0, \"Failed to join thread!\");\n+\n+\tRTE_TEST_ASSERT(args.result_A != args.result_B, \"Mutex failed to be acquired or was acquired by both threads!\");\n+\n+\t/* Destroy if dynamically initialized */\n+\tif (pmutex == NULL) {\n+\t\tret = rte_thread_mutex_destroy(&mutex);\n+\t\tRTE_TEST_ASSERT(ret == 0, \"Failed to destroy mutex!\");\n+\t}\n+\n+\tret = rte_thread_barrier_destroy(&barrier);\n+\tRTE_TEST_ASSERT(ret == 0, \"Failed to destroy barrier!\");\n+\n+\treturn ret;\n+}\n+\n+static int\n+test_thread_mutex_static(void)\n+{\n+\treturn test_thread_mutex(&static_mutex);\n+}\n+\n+static int\n+test_thread_mutex_dynamic(void)\n+{\n+\treturn test_thread_mutex(NULL);\n+}\n+\n static struct unit_test_suite threads_test_suite = {\n \t.suite_name = \"threads autotest\",\n \t.setup = NULL,\n@@ -253,6 +357,8 @@ static struct unit_test_suite threads_test_suite = {\n \t\t\tTEST_CASE(test_thread_attributes_priority),\n \t\t\tTEST_CASE(test_thread_detach),\n \t\t\tTEST_CASE(test_thread_barrier),\n+\t\t\tTEST_CASE(test_thread_mutex_static),\n+\t\t\tTEST_CASE(test_thread_mutex_dynamic),\n \t\t\tTEST_CASES_END()\n \t}\n };\ndiff --git a/lib/eal/common/rte_thread.c b/lib/eal/common/rte_thread.c\nindex d30a8a7ca3..4a9a1b6e07 100644\n--- a/lib/eal/common/rte_thread.c\n+++ b/lib/eal/common/rte_thread.c\n@@ -309,6 +309,75 @@ rte_thread_detach(rte_thread_t thread_id)\n \treturn pthread_detach((pthread_t)thread_id.opaque_id);\n }\n \n+int\n+rte_thread_mutex_init(rte_thread_mutex *mutex)\n+{\n+\tint ret = 0;\n+\tpthread_mutex_t *m = NULL;\n+\n+\tRTE_VERIFY(mutex != NULL);\n+\n+\tm = calloc(1, sizeof(*m));\n+\tif (m == NULL) {\n+\t\tRTE_LOG(DEBUG, EAL, \"Unable to initialize mutex. Insufficient memory!\\n\");\n+\t\tret = ENOMEM;\n+\t\tgoto cleanup;\n+\t}\n+\n+\tret = pthread_mutex_init(m, NULL);\n+\tif (ret != 0) {\n+\t\tRTE_LOG(DEBUG, EAL, \"Failed to init mutex. ret = %d\\n\", ret);\n+\t\tgoto cleanup;\n+\t}\n+\n+\tmutex->mutex_id = m;\n+\tm = NULL;\n+\n+cleanup:\n+\tfree(m);\n+\treturn ret;\n+}\n+\n+int\n+rte_thread_mutex_lock(rte_thread_mutex *mutex)\n+{\n+\tRTE_VERIFY(mutex != NULL);\n+\n+\treturn pthread_mutex_lock((pthread_mutex_t *)mutex->mutex_id);\n+}\n+\n+int\n+rte_thread_mutex_unlock(rte_thread_mutex *mutex)\n+{\n+\tRTE_VERIFY(mutex != NULL);\n+\n+\treturn pthread_mutex_unlock((pthread_mutex_t *)mutex->mutex_id);\n+}\n+\n+int\n+rte_thread_mutex_try_lock(rte_thread_mutex *mutex)\n+{\n+\tRTE_VERIFY(mutex != NULL);\n+\n+\treturn pthread_mutex_trylock((pthread_mutex_t *)mutex->mutex_id);\n+}\n+\n+int\n+rte_thread_mutex_destroy(rte_thread_mutex *mutex)\n+{\n+\tint ret = 0;\n+\tRTE_VERIFY(mutex != NULL);\n+\n+\tret = pthread_mutex_destroy((pthread_mutex_t *)mutex->mutex_id);\n+\tif (ret != 0)\n+\t\tRTE_LOG(DEBUG, EAL, \"Unable to destroy mutex, ret = %d\\n\", ret);\n+\n+\tfree(mutex->mutex_id);\n+\tmutex->mutex_id = NULL;\n+\n+\treturn ret;\n+}\n+\n int\n rte_thread_barrier_init(rte_thread_barrier *barrier, int count)\n {\ndiff --git a/lib/eal/include/rte_thread.h b/lib/eal/include/rte_thread.h\nindex 7c84e32988..09a5fd8add 100644\n--- a/lib/eal/include/rte_thread.h\n+++ b/lib/eal/include/rte_thread.h\n@@ -54,6 +54,25 @@ typedef struct {\n \n #endif /* RTE_HAS_CPUSET */\n \n+#define RTE_DECLARE_MUTEX(private_lock)          rte_thread_mutex private_lock\n+\n+#define RTE_DEFINE_MUTEX(private_lock)\\\n+RTE_INIT(__rte_ ## private_lock ## _init)\\\n+{\\\n+\tRTE_VERIFY(rte_thread_mutex_init(&private_lock) == 0);\\\n+}\n+\n+#define RTE_INIT_MUTEX(private_lock)\\\n+static RTE_DECLARE_MUTEX(private_lock);\\\n+RTE_DEFINE_MUTEX(private_lock)\n+\n+/**\n+ * Thread mutex representation.\n+ */\n+typedef struct rte_thread_mutex_tag {\n+\tvoid *mutex_id;  /**< mutex identifier */\n+} rte_thread_mutex;\n+\n /**\n  * Returned by rte_thread_barrier_wait() when call is successful.\n  */\n@@ -314,6 +333,72 @@ __rte_experimental\n int rte_thread_set_priority(rte_thread_t thread_id,\n \t\tenum rte_thread_priority priority);\n \n+/**\n+ * Initializes a mutex.\n+ *\n+ * @param mutex\n+ *    The mutex to be initialized.\n+ *\n+ * @return\n+ *   On success, return 0.\n+ *   On failure, return a positive errno-style error number.\n+ */\n+__rte_experimental\n+int rte_thread_mutex_init(rte_thread_mutex *mutex);\n+\n+/**\n+ * Locks a mutex.\n+ *\n+ * @param mutex\n+ *    The mutex to be locked.\n+ *\n+ * @return\n+ *   On success, return 0.\n+ *   On failure, return a positive errno-style error number.\n+ */\n+__rte_experimental\n+int rte_thread_mutex_lock(rte_thread_mutex *mutex);\n+\n+/**\n+ * Unlocks a mutex.\n+ *\n+ * @param mutex\n+ *    The mutex to be unlocked.\n+ *\n+ * @return\n+ *   On success, return 0.\n+ *   On failure, return a positive errno-style error number.\n+ */\n+__rte_experimental\n+int rte_thread_mutex_unlock(rte_thread_mutex *mutex);\n+\n+/**\n+ * Tries to lock a mutex.If the mutex is already held by a different thread,\n+ * the function returns without blocking.\n+ *\n+ * @param mutex\n+ *    The mutex that will be acquired, if not already locked.\n+ *\n+ * @return\n+ *   On success, if the mutex is acquired, return 0.\n+ *   On failure, return a positive errno-style error number.\n+ */\n+__rte_experimental\n+int rte_thread_mutex_try_lock(rte_thread_mutex *mutex);\n+\n+/**\n+ * Releases all resources associated with a mutex.\n+ *\n+ * @param mutex\n+ *    The mutex to be uninitialized.\n+ *\n+ * @return\n+ *   On success, return 0.\n+ *   On failure, return a positive errno-style error number.\n+ */\n+__rte_experimental\n+int rte_thread_mutex_destroy(rte_thread_mutex *mutex);\n+\n /**\n  * Initializes a synchronization barrier.\n  *\ndiff --git a/lib/eal/version.map b/lib/eal/version.map\nindex 06e5f82da2..e80eea4316 100644\n--- a/lib/eal/version.map\n+++ b/lib/eal/version.map\n@@ -431,6 +431,11 @@ EXPERIMENTAL {\n \trte_thread_barrier_wait;\n \trte_thread_barrier_destroy;\n \trte_thread_get_affinity_by_id;\n+\trte_thread_mutex_init;\n+\trte_thread_mutex_lock;\n+\trte_thread_mutex_unlock;\n+\trte_thread_mutex_try_lock;\n+\trte_thread_mutex_destroy;\n \trte_thread_set_affinity_by_id;\n \trte_thread_get_priority;\n \trte_thread_set_priority;\ndiff --git a/lib/eal/windows/rte_thread.c b/lib/eal/windows/rte_thread.c\nindex 3f72bbf716..11b4863fe8 100644\n--- a/lib/eal/windows/rte_thread.c\n+++ b/lib/eal/windows/rte_thread.c\n@@ -504,6 +504,70 @@ rte_thread_detach(rte_thread_t thread_id)\n \treturn 0;\n }\n \n+int\n+rte_thread_mutex_init(rte_thread_mutex *mutex)\n+{\n+\tint ret = 0;\n+\tCRITICAL_SECTION *m = NULL;\n+\n+\tRTE_VERIFY(mutex != NULL);\n+\n+\tm = calloc(1, sizeof(*m));\n+\tif (m == NULL) {\n+\t\tRTE_LOG(DEBUG, EAL, \"Unable to initialize mutex. Insufficient memory!\\n\");\n+\t\tret = ENOMEM;\n+\t\tgoto cleanup;\n+\t}\n+\n+\tInitializeCriticalSection(m);\n+\tmutex->mutex_id = m;\n+\tm = NULL;\n+\n+cleanup:\n+\treturn ret;\n+}\n+\n+int\n+rte_thread_mutex_lock(rte_thread_mutex *mutex)\n+{\n+\tRTE_VERIFY(mutex != NULL);\n+\n+\tEnterCriticalSection(mutex->mutex_id);\n+\treturn 0;\n+}\n+\n+int\n+rte_thread_mutex_unlock(rte_thread_mutex *mutex)\n+{\n+\tRTE_VERIFY(mutex != NULL);\n+\n+\tLeaveCriticalSection(mutex->mutex_id);\n+\treturn 0;\n+}\n+\n+int\n+rte_thread_mutex_try_lock(rte_thread_mutex *mutex)\n+{\n+\tRTE_VERIFY(mutex != NULL);\n+\n+\tif (TryEnterCriticalSection(mutex->mutex_id) != 0)\n+\t\treturn 0;\n+\n+\treturn EBUSY;\n+}\n+\n+int\n+rte_thread_mutex_destroy(rte_thread_mutex *mutex)\n+{\n+\tRTE_VERIFY(mutex != NULL);\n+\n+\tDeleteCriticalSection(mutex->mutex_id);\n+\tfree(mutex->mutex_id);\n+\tmutex->mutex_id = NULL;\n+\n+\treturn 0;\n+}\n+\n int\n rte_thread_barrier_init(rte_thread_barrier *barrier, int count)\n {\n",
    "prefixes": [
        "v18",
        "8/8"
    ]
}