From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
	by inbox.dpdk.org (Postfix) with ESMTP id 7ADD3431FC;
	Wed, 25 Oct 2023 18:34:10 +0200 (CEST)
Received: from mails.dpdk.org (localhost [127.0.0.1])
	by mails.dpdk.org (Postfix) with ESMTP id D214D42DB2;
	Wed, 25 Oct 2023 18:34:05 +0200 (CEST)
Received: from wout5-smtp.messagingengine.com (wout5-smtp.messagingengine.com
 [64.147.123.21]) by mails.dpdk.org (Postfix) with ESMTP id D90DF40EAB
 for <dev@dpdk.org>; Wed, 25 Oct 2023 18:34:04 +0200 (CEST)
Received: from compute6.internal (compute6.nyi.internal [10.202.2.47])
 by mailout.west.internal (Postfix) with ESMTP id 8D1B83200989;
 Wed, 25 Oct 2023 12:34:03 -0400 (EDT)
Received: from mailfrontend2 ([10.202.2.163])
 by compute6.internal (MEProxy); Wed, 25 Oct 2023 12:34:04 -0400
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h=
 cc:cc:content-transfer-encoding:content-type:date:date:from:from
 :in-reply-to:in-reply-to:message-id:mime-version:references
 :reply-to:sender:subject:subject:to:to; s=fm3; t=1698251643; x=
 1698338043; bh=tAu4SodJ0U2Qx5L5LNl0sjXglOylD5S7/k8hQAdwy1I=; b=b
 KgObMTKZhKvCnlxOPUptpgmoPTBjJBiskuSxPrBZWrscHgJEazgWU5yzo3uW8YNv
 uB/l/Y0lCLpZrV8S81T6qNBv/vToP5okAoLve62rqhW7cvISJYjotRlb8DS05dzm
 9C9AgujbeF83SXV2kTLJmPGoD6wtkhTbUdIniMCquaQClQKp/Bg5EZUH7IiWDTuw
 2whH8BDTPXB8Cwk4GoB9IWKnNQ1Q8xJSkILIPYhE0r2ZnApOOTxy7/YOclUZxcrY
 oUK4Px/yJIfuGqkIO1doe0JEm4qYwnymvF4+hDbgGBQ5ntl2RBl00x4KSNp8Whm9
 rMPZQd0pOp32ZinPLXkfA==
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=
 messagingengine.com; h=cc:cc:content-transfer-encoding
 :content-type:date:date:feedback-id:feedback-id:from:from
 :in-reply-to:in-reply-to:message-id:mime-version:references
 :reply-to:sender:subject:subject:to:to:x-me-proxy:x-me-proxy
 :x-me-sender:x-me-sender:x-sasl-enc; s=fm3; t=1698251643; x=
 1698338043; bh=tAu4SodJ0U2Qx5L5LNl0sjXglOylD5S7/k8hQAdwy1I=; b=E
 K3QyGE/NxcYsHqHP65xDeznmPqJ/OU5bcjaFCXvNsHGLti6UOFT2/QsSi1KhCFgM
 52xcfWD7HEhnzS+PznImyFlHt/do75Kp+8JsQtqDIDL0Xxet7nMKc86TWSlshfao
 B7ibch6fW/oif8HAsqBFVjaeXCCEEn8JYHABgxx70q9lVWif0w77mdSKO2l5UKG0
 +wQ8H6pG7tMZu1c7bl7sZNiMqS3HRlYgiZjaBan40asPiW/Sj5i72KOuhhw72LiC
 1TC1Ks06XKitL9cBrvTDEtWyExZpr7ZWxm0toKmmLraHmV7zVFkyQVdGi+/4I8Ml
 aVHtodPl5JNJCZxdSTgfQ==
X-ME-Sender: <xms:ekM5Zb8rkIxO7geGq9-fEWMu27KR112Vg1_zLmIZi6eHTdLIAnkVXA>
 <xme:ekM5ZXtWup4cpb6VzSBrYgbTW-a8urtGURIH-k0pOQYZeDdXeGR5ZSDX15AyQPl-_
 tB4ifNwaKp30USKWQ>
X-ME-Received: <xmr:ekM5ZZCszVmqii75jP7n4Dn6K1NoVY-WBOqC5cwN98cxPerCcG4Nfuu-2nVY6oi78Xx9Qxav1B_5hXjwykmKuKwwg7oMn4s>
X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvkedrledtgddutdduucetufdoteggodetrfdotf
 fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen
 uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne
 cujfgurhephffvvefufffkofgjfhgggfestdekredtredttdenucfhrhhomhepvfhhohhm
 rghsucfoohhnjhgrlhhonhcuoehthhhomhgrshesmhhonhhjrghlohhnrdhnvghtqeenuc
 ggtffrrghtthgvrhhnpedvjefhudeghedvtdeijeeigeetuedugfejueekieeltdfhteev
 keehhfeilefhtdenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhepmhgrihhlfh
 hrohhmpehthhhomhgrshesmhhonhhjrghlohhnrdhnvght
X-ME-Proxy: <xmx:ekM5ZXdFPz-vVzL01yhq5YMAZf64MW1ohMZlRCUqT29MdwEg4LrWTA>
 <xmx:ekM5ZQNCUT79WGZNzaGL1XX2ya3_qa0Wmn9ib29A_CGhJSFDyEtKcg>
 <xmx:ekM5ZZlpkn8Fyp-O9z6Ie5N9XTKV5KlbnVCZ6L4TwWbYBwCYcRY8GA>
 <xmx:e0M5Zdp2FWQjj86thNOrnfuBnQlseXCngDuFZq1G2UwY83sCgDFhmg>
Feedback-ID: i47234305:Fastmail
Received: by mail.messagingengine.com (Postfix) with ESMTPA; Wed,
 25 Oct 2023 12:34:01 -0400 (EDT)
From: Thomas Monjalon <thomas@monjalon.net>
To: dev@dpdk.org
Cc: David Marchand <david.marchand@redhat.com>,
 Dmitry Kozlyuk <dmitry.kozliuk@gmail.com>,
 Narcisa Ana Maria Vasile <navasile@linux.microsoft.com>,
 Dmitry Malloy <dmitrym@microsoft.com>,
 Pallavi Kadam <pallavi.kadam@intel.com>
Subject: [PATCH v3 1/2] eal: add thread yield functions
Date: Wed, 25 Oct 2023 18:31:10 +0200
Message-ID: <20231025163352.1076755-2-thomas@monjalon.net>
X-Mailer: git-send-email 2.42.0
In-Reply-To: <20231025163352.1076755-1-thomas@monjalon.net>
References: <20231024125416.798897-1-thomas@monjalon.net>
 <20231025163352.1076755-1-thomas@monjalon.net>
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>,
 <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>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org

When running real-time threads, we may need to force scheduling
kernel threads or other real-time threads.
New functions are added to address these cases.

The yield functions should not have any interest for normal threads.
Note: other purposes may be addressed with rte_pause() or rte_delay_*().

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 lib/eal/include/rte_thread.h | 22 ++++++++++++++++++++++
 lib/eal/unix/rte_thread.c    | 16 ++++++++++++++++
 lib/eal/version.map          |  4 ++++
 lib/eal/windows/rte_thread.c | 15 +++++++++++++++
 4 files changed, 57 insertions(+)

diff --git a/lib/eal/include/rte_thread.h b/lib/eal/include/rte_thread.h
index 8da9d4d3fb..139cafac96 100644
--- a/lib/eal/include/rte_thread.h
+++ b/lib/eal/include/rte_thread.h
@@ -183,6 +183,28 @@ int rte_thread_join(rte_thread_t thread_id, uint32_t *value_ptr);
  */
 int rte_thread_detach(rte_thread_t thread_id);
 
+/**
+ * Allow another thread to run on the same CPU core.
+ *
+ * Lower priority threads may not be scheduled.
+ *
+ * Especially useful in real-time thread priority
+ * to schedule other real-time threads.
+ * @see RTE_THREAD_PRIORITY_REALTIME_CRITICAL
+ */
+__rte_experimental
+void rte_thread_yield(void);
+
+/**
+ * Unblock a CPU core running busy in a real-time thread.
+ *
+ * Especially useful in real-time thread priority
+ * to avoid a busy loop blocking vital threads on a core.
+ * @see RTE_THREAD_PRIORITY_REALTIME_CRITICAL
+ */
+__rte_experimental
+void rte_thread_yield_realtime(void);
+
 /**
  * Get the id of the calling thread.
  *
diff --git a/lib/eal/unix/rte_thread.c b/lib/eal/unix/rte_thread.c
index 36a21ab2f9..92b4e53adb 100644
--- a/lib/eal/unix/rte_thread.c
+++ b/lib/eal/unix/rte_thread.c
@@ -5,9 +5,11 @@
 
 #include <errno.h>
 #include <pthread.h>
+#include <sched.h>
 #include <stdbool.h>
 #include <stdlib.h>
 #include <string.h>
+#include <time.h>
 
 #include <rte_errno.h>
 #include <rte_log.h>
@@ -227,6 +229,20 @@ rte_thread_detach(rte_thread_t thread_id)
 	return pthread_detach((pthread_t)thread_id.opaque_id);
 }
 
+void
+rte_thread_yield(void)
+{
+	sched_yield();
+}
+
+void
+rte_thread_yield_realtime(void)
+{
+	/* A simple yield may not be enough to schedule kernel threads. */
+	struct timespec wait = {.tv_nsec = 1};
+	nanosleep(&wait, NULL);
+}
+
 int
 rte_thread_equal(rte_thread_t t1, rte_thread_t t2)
 {
diff --git a/lib/eal/version.map b/lib/eal/version.map
index e00a844805..b81ac3e3af 100644
--- a/lib/eal/version.map
+++ b/lib/eal/version.map
@@ -413,6 +413,10 @@ EXPERIMENTAL {
 	# added in 23.07
 	rte_memzone_max_get;
 	rte_memzone_max_set;
+
+	# added in 23.11
+	rte_thread_yield;
+	rte_thread_yield_realtime;
 };
 
 INTERNAL {
diff --git a/lib/eal/windows/rte_thread.c b/lib/eal/windows/rte_thread.c
index acf648456c..1e031eca40 100644
--- a/lib/eal/windows/rte_thread.c
+++ b/lib/eal/windows/rte_thread.c
@@ -304,6 +304,21 @@ rte_thread_detach(rte_thread_t thread_id)
 	return 0;
 }
 
+void
+rte_thread_yield(void)
+{
+	Sleep(0);
+}
+
+void
+rte_thread_yield_realtime(void)
+{
+	/* Real-time threads are not causing problems on Windows.
+	 * A normal yield should be fine.
+	 */
+	Sleep(0);
+}
+
 int
 rte_thread_equal(rte_thread_t t1, rte_thread_t t2)
 {
-- 
2.42.0