From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id E39BD42C40; Tue, 6 Jun 2023 16:56:31 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id ADA3542D85; Tue, 6 Jun 2023 16:55:43 +0200 (CEST) Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by mails.dpdk.org (Postfix) with ESMTP id 99EBB42DA0 for ; Tue, 6 Jun 2023 16:55:41 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1686063341; x=1717599341; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=lBgqkLshrZe6BW13IiXo6i5LJx9AehXaxAh6DNj9ZFk=; b=XLYWYoyyXMnQxK8cfvi5j9lek4QrTfA/OtdrOmYcNGYJnDqYgKb3/geI vz/hpGvG9GU37gKLj3M1dXfMZtmrt+jvgoq2bm+b5kY+A+ddJhrKJabJT jYWtsyO9L28BkFbvjPHwf351Ox7VIdtKsqTZKEZMKAbUB3MU1qEDZ8oSm hmHhxLSDgl3zC4p2/KZotVfz4Z/B6N2iJNHNIvub6u8GaY8QN9e0ULAox vAaBBH4WU6aMrOL/cDxTJh+LwuvoQ00HBKiZaDsYGBS5Hmi7AnnS3a2B6 FuMvq1ugqI0DCgs11zeAEizdWOeNcu3b13BdVgXjGS+fG3W80RLwbBttK g==; X-IronPort-AV: E=McAfee;i="6600,9927,10733"; a="356705763" X-IronPort-AV: E=Sophos;i="6.00,221,1681196400"; d="scan'208";a="356705763" Received: from fmsmga005.fm.intel.com ([10.253.24.32]) by fmsmga103.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 06 Jun 2023 07:55:33 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10733"; a="1039223064" X-IronPort-AV: E=Sophos;i="6.00,221,1681196400"; d="scan'208";a="1039223064" Received: from dpdk-zhirun-lmm.sh.intel.com ([10.67.119.94]) by fmsmga005.fm.intel.com with ESMTP; 06 Jun 2023 07:55:31 -0700 From: Zhirun Yan To: dev@dpdk.org, jerinj@marvell.com, kirankumark@marvell.com, ndabilpuram@marvell.com, stephen@networkplumber.org, pbhagavatula@marvell.com, jerinjacobk@gmail.com Cc: cunming.liang@intel.com, haiyue.wang@intel.com, mattias.ronnblom@ericsson.com, Zhirun Yan Subject: [PATCH v8 17/17] doc: update multicore dispatch model in graph guides Date: Tue, 6 Jun 2023 22:47:46 +0800 Message-Id: <20230606144746.708388-18-zhirun.yan@intel.com> X-Mailer: git-send-email 2.37.2 In-Reply-To: <20230606144746.708388-1-zhirun.yan@intel.com> References: <20230605111923.3772260-1-zhirun.yan@intel.com> <20230606144746.708388-1-zhirun.yan@intel.com> 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 List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Update graph documentation to introduce new multicore dispatch model. Signed-off-by: Haiyue Wang Signed-off-by: Cunming Liang Signed-off-by: Zhirun Yan --- doc/guides/prog_guide/graph_lib.rst | 68 +++++++++++++++++++++++++++-- 1 file changed, 64 insertions(+), 4 deletions(-) diff --git a/doc/guides/prog_guide/graph_lib.rst b/doc/guides/prog_guide/graph_lib.rst index 1cfdc86433..aecf3d2e03 100644 --- a/doc/guides/prog_guide/graph_lib.rst +++ b/doc/guides/prog_guide/graph_lib.rst @@ -189,14 +189,74 @@ In the above example, A graph object will be created with ethdev Rx node of port 0 and queue 0, all ipv4* nodes in the system, and ethdev tx node of all ports. -Multicore graph processing -~~~~~~~~~~~~~~~~~~~~~~~~~~ -In the current graph library implementation, specifically, -``rte_graph_walk()`` and ``rte_node_enqueue*`` fast path API functions +Graph models chossing +~~~~~~~~~~~~~~~~~~~~~ +Currently, there are 2 different walking models. Use macro +RTE_GRAPH_MODEL_SELECT to set the model in compile time. Also offers the +ability to choose models in runtime. +For application, must #define RTE_GRAPH_MODEL_SELECT before inlcuding +rte_graph_worker.h. + +In l3fwd-graph, set RTE_GRAPH_MODEL_SELECT as the model explicitly for +performance-sensitive use case. +Or set the macro as GRAPH_MODEL_MCORE_RUNTIME_SELECT. And parse +``"--model=NAME"`` in cmdline and use ``rte_graph_worker_model_set()`` +to set the walking model in runtime. + +RTC (Run-To-Completion) +^^^^^^^^^^^^^^^^^^^^^^^ +This is the default graph walking model. Specifically, +``rte_graph_walk_rtc()`` and ``rte_node_enqueue*`` fast path API functions are designed to work on single-core to have better performance. The fast path API works on graph object, So the multi-core graph processing strategy would be to create graph object PER WORKER. +Example: + +Graph: node-0 -> node-1 -> node-2 @Core0. + +.. code-block:: diff + + + - - - - - - - - - - - - - - - - - - - - - + + ' Core #0 ' + ' ' + ' +--------+ +---------+ +--------+ ' + ' | Node-0 | --> | Node-1 | --> | Node-2 | ' + ' +--------+ +---------+ +--------+ ' + ' ' + + - - - - - - - - - - - - - - - - - - - - - + + +Dispatch model +^^^^^^^^^^^^^^ +The dispatch model enables a cross-core dispatching mechanism which employs +a scheduling work-queue to dispatch streams to other worker cores which +being associated with the destination node. + +Use ``rte_graph_model_mcore_dispatch_lcore_affinity_set()`` to set lcore affinity +with the node. +Each worker core will have a graph repetition. Use ``rte_graph_clone()`` to clone +graph for each worker and use``rte_graph_model_mcore_dispatch_core_bind()`` to +bind graph with the worker core. + +Example: + +Graph topo: node-0 -> Core1; node-1 -> node-2; node-2 -> node-3. +Config graph: node-0 @Core0; node-1/3 @Core1; node-2 @Core2. + +.. code-block:: diff + + + - - - - - -+ +- - - - - - - - - - - - - + + - - - - - -+ + ' Core #0 ' ' Core #1 ' ' Core #2 ' + ' ' ' ' ' ' + ' +--------+ ' ' +--------+ +--------+ ' ' +--------+ ' + ' | Node-0 | - - - ->| Node-1 | | Node-3 |<- - - - | Node-2 | ' + ' +--------+ ' ' +--------+ +--------+ ' ' +--------+ ' + ' ' ' | ' ' ^ ' + + - - - - - -+ +- - -|- - - - - - - - - - + + - - -|- - -+ + | | + + - - - - - - - - - - - - - - - - + + + In fast path ~~~~~~~~~~~~ Typical fast-path code looks like below, where the application -- 2.37.2