From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from NAM02-SN1-obe.outbound.protection.outlook.com (mail-sn1nam02on0047.outbound.protection.outlook.com [104.47.36.47]) by dpdk.org (Postfix) with ESMTP id 15EFDF959 for ; Wed, 29 Mar 2017 15:47:21 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=CAVIUMNETWORKS.onmicrosoft.com; s=selector1-cavium-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version; bh=IQJ6gmM6kHVxOB+4SoLdov5L3/pZ4+KiNVC/rcv06Z0=; b=NmHobSa28D4rE1x2a2vjFwD8lG84Ri4v4fvS7pcrEpHXr3W0N37knosYbPZ+BSiiENKt+7wIA43ZZXxm5lDfO4YLOIsKngR9BLDvn1KQkAeDUKi7fP5LIM61+BviA08rs3QaX2Dm0Tc1VZEKzA3r4hz1kdDUO0qV3lDKm7oRXZY= Authentication-Results: intel.com; dkim=none (message not signed) header.d=none;intel.com; dmarc=none action=none header.from=caviumnetworks.com; Received: from localhost.localdomain (14.140.2.178) by CY1PR0701MB1727.namprd07.prod.outlook.com (10.163.21.141) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.991.14; Wed, 29 Mar 2017 13:47:18 +0000 Date: Wed, 29 Mar 2017 19:17:01 +0530 From: Jerin Jacob To: Harry van Haaren Cc: dev@dpdk.org Message-ID: <20170329134659.pwlv3j4wkzgc3era@localhost.localdomain> References: <489175012-101439-1-git-send-email-harry.van.haaren@intel.com> <1490374395-149320-1-git-send-email-harry.van.haaren@intel.com> <1490374395-149320-20-git-send-email-harry.van.haaren@intel.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <1490374395-149320-20-git-send-email-harry.van.haaren@intel.com> User-Agent: NeoMutt/20170306 (1.8.0) X-Originating-IP: [14.140.2.178] X-ClientProxiedBy: BM1PR01CA0080.INDPRD01.PROD.OUTLOOK.COM (10.174.208.148) To CY1PR0701MB1727.namprd07.prod.outlook.com (10.163.21.141) X-MS-Office365-Filtering-Correlation-Id: 0cb08954-983b-4054-bae2-08d476aa1ea5 X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(22001)(201703131423075)(201703031133081); SRVR:CY1PR0701MB1727; X-Microsoft-Exchange-Diagnostics: 1; CY1PR0701MB1727; 3:qkWUfqN03YG4Qky9NPlMYzNKZvLlh4emrAvuLa7Km4s0+yKmMFZxWhgmuU9PqflO//Vh7rUOpHZMt33N1EArl4PrUStzP0SoG6MXjDTYLlPIN/WZTwYNDtMRdFZp5nlK2LKKfWTUeggkx6AgDP9O03GwtsHrn5Ewn8bW+NQLSHlYWa9gj1KzbRCBxwDoWxon7X/KAq6jmJj+qnBzSeSK8Q3Po9RrqF2pZC/YDW1cnDqV34Cu0y6X8uULhYnp5U6i1z6U7OMgrpSX/UclDv/IPOCnlhR4MEvweiUiiv0tnYGg70+9ykClnioCRBqChEJz+Hj7JB0TYaV2MzH+9McvnA==; 25:fF2NG3v2ZP996Nl4IN4DKl2sqZ5tWz1bs6jNKj0BPqvi2bfId8coKvU6Nunge+NALivPm6fkA2WCWKb2fzYeR1Du/kjya6RPTTIeLDdOn3ICptzPbMncy6A1ijr1DYOutjh4I/9LunNFCdIk/+iQBzmtczUJRyc4wYiXGbgHxTRBskf06PODYCdpIs1fJD+fn+oosLoYewUuuuzh5mzs0M7PmTSCTaKbQW+YTdoidd3ca771juj2qkP+24xE06PK7VBi17a5fI1HZg4Bv9VAGhSaVjQ7tW7axgQIO5KQutD1HB/xURWTCANTBbScmtQ2hW7E0SLxUCpz+aDL3/+jLuyT7vCxf7FV0YUrC59i/yHPmOmjN505CH2oHbq4aXvSyyv+NPFzKyyfVPB759yTPI+WDY2Y2xgTjepdCwP6kfzKrJnypeO8sdxaG+6XV6Q/qI2B/+hCjbZPLoN7cK1KbQ== X-Microsoft-Exchange-Diagnostics: 1; CY1PR0701MB1727; 31:NkbfmGWJyAu0dR3q3fNV3GOJ2fO1E03YpNxuLBwHQzcfdF4SSiK5Yqtsp6jRrzdbXcaAt2x5X2vv5INE7+y34B68Z8PjTHZ1F0GqcAvdjtV/Y/8Hcx4rUQVCtyaX4l1eZYfGWeMMhk3TM61hTKyeCZKKwkskwQ2JG3LYxMDdF19uX64jamm30lAAJvOv0Odbmw4aBNz3r3piJZpE9WfDS9ottIgixZBF2Dy8aG3mReAFAPAxVlWd5hYVAhDtj7LUnxUSbCtChKe/ImlrqvCPig==; 20:TEzqn7iahaBPtthUVALKwpIu89NqhLhJQ2KdfVZJPAUs9XqfcNWx7jVtqImlpiwtXmtsY5tgGam1dHzWbhTgBXU+msdUxCihKrT+8E+CiSQcfrZCgGh6BcudEskep5LODsBHC5bVGUqciHU5J8Cl/ryaH+RcgxurYdWdptU0mjSfnKJ8oj+Rv4v6qem7/KAoGRHjb6PW9+xAr6MXIvqOHd7w7DtZHXMkBVRsJMdeMOQ7/Eqo4rhVaROU6yCtBo6UCiIPcmjzexwaPUC36b1RQlkaoaPZFIS8tj9+6jJ0f8pxFx8cwMImYx0PEDNKoktMzX7y/fSq7LyghrgxdbtJqWf/YJYlMGZvO2hU+Pn0SKoExaL/X6EUm9YcPQfoAe1xbVdAyi+QqnO3sM6U5DE4MQZlgTT+iIL6NEwC+hrofPNVsZPstGPDHap4htFhPiuQEdug5kCtXRrRXwiISDgdJcC+k2Ugavyhcidm5Gp9R/FrwBzjxpKmhIe2AAB6LFf5PAsSYBbQFY5FfP8GkwyXCktg8yRlPovvlwqI5LDcVjbkveuw75tPwCowGWlu9PNImRGIXxEA/abdyJa9daC48AwtMh5fCuOoPE/GbPkOVqg= X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:(228905959029699); X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(6040450)(601004)(2401047)(5005006)(8121501046)(3002001)(10201501046)(6041248)(20161123562025)(20161123555025)(20161123564025)(20161123558025)(201703131423075)(201702281528075)(201703061421075)(201703061406075)(20161123560025)(6072148); SRVR:CY1PR0701MB1727; BCL:0; PCL:0; RULEID:; SRVR:CY1PR0701MB1727; X-Microsoft-Exchange-Diagnostics: 1; CY1PR0701MB1727; 4:yxbJbyra5GBbLfxxpyerc9oQlt2d+N6Z3FHSQq0IRIhsLJim8RrwOu+5/NyKINhjuuvqT6GtbqfyXl2tXqi3vS/eodCa8PtmXzynUq18P2LmNym1neauQmcMDf0AKYA5G0Sw+fKltuljLlCRvSlyHSsRfx9TKdZUo5GAjRkiGnp10+z9VIkcrFSo29x/ArgbumDQYWBgfkxztH1eLprIQmM/uUiUwdiSf8vytSgSZoeeG/GTbhkC6OqFl1DqgnCA5TVSLjgOmW3ncEKn+4DUYOZ78geId7ijwv65XniVrh837Lk9F1L3RJL4Li/44QbCxTGcjbi2n9ouxq59BmfR87/Sub9R8NaSWVR+YW2z7ciQPW68+gyRjjL7IBRGUL8R5H0qL+/2r0u8BInZf7u9FvSqmF+VZBkEg6DAhvuEG4t+1b7IJ9GO+M6fQlebeHtAXR/L4QyNoIvmr9PB0wYuUWW7JDjPJpKPg0g0HYVfugLBmGW8KOXWsXTmyABijLqI8WxUiOHe90rd/Yy/LTnvLQv0dIQICGXV/3XFDG44KTib/TzrjTHpFpm1HFwgeIQ92ZXo/MmVq5ZHURR2JJ9akU+1lr4XrwlasT24BY/8WsvqPxiMg2fBnU1h2O9/8w3BLIFMtwl/p5b/UPaXzR2qVZf/NK+pmF8AUygP1ae/aJGouX04Jb3vWfkUeRbENj4hK3nmtVlDZUQr3cB552J462jf3/ywlrRenJPj8XCREClsihDBolaKZTgNaQbBGY8HBGdjdnHPfVkZK2mUwIxd8M6Qpks7Jzi9Fg2Nuoun3mU= X-Forefront-PRVS: 0261CCEEDF X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(4630300001)(979002)(6069001)(6009001)(39410400002)(39400400002)(39840400002)(39450400003)(24454002)(76176999)(229853002)(2906002)(50986999)(61506002)(54356999)(4001350100001)(4326008)(38730400002)(25786009)(110136004)(6246003)(50466002)(189998001)(5660300001)(5009440100003)(6506006)(23726003)(3846002)(1076002)(33646002)(8676002)(6116002)(42186005)(66066001)(55016002)(47776003)(83506001)(7736002)(53936002)(9686003)(42882006)(305945005)(2950100002)(81166006)(6916009)(6666003)(110426004)(969003)(989001)(999001)(1009001)(1019001); DIR:OUT; SFP:1101; SCL:1; SRVR:CY1PR0701MB1727; H:localhost.localdomain; FPR:; SPF:None; MLV:ovrnspm; PTR:InfoNoRecords; LANG:en; X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1; CY1PR0701MB1727; 23:bhVSJFujeXxVPs0Rz7w6vGvfPXiUgoSVaEi8Xct?= =?us-ascii?Q?6zcTQdKLFJPVjY1oOfFwieXxigs+x1S0wnm8h/3QNkuEs6opZUD32ZNH7uIO?= =?us-ascii?Q?iaGpchNDQHKnb7Vw9zjxMWjP2uv1osgOsxjdxRkaAXfoi5Pl/h3ry7mlY1s+?= =?us-ascii?Q?3knHUS3YrHgstnyKCQ2ChV4D/WnwPXNLjpq09CHKrQXmoI1ymMLTv1zDpQFe?= =?us-ascii?Q?gAVmUz8ScgKZF6j/8Xti3UsScj2hCY7ZCyLbkO3AwO0c76w3rDeA2A/vrH9L?= =?us-ascii?Q?qFL+1NTyRNPKdbVPE8tzahL44hnbI/oYUYDzKH6F0kRvx8mfZH943EqJ8Sdv?= =?us-ascii?Q?jiydwsz7xGTKCXk7mry11TikFzSxS6ckCdkmMcOHR21YTKWGppQxutZ9Ettg?= =?us-ascii?Q?Bor+hrIHyMN3H/U/MIq397Srg8I5nca7mVyxXu3qt+fQHSZz+xCDq93lOy8q?= =?us-ascii?Q?ySaYnDtzydnV3rGceAKr6himoSh+mEEkekpoTjY7IaCg6QUAHkrGDz1wFNL7?= =?us-ascii?Q?Yzhcuav5wPl+oKAe7oAIsC/UWvQyk1c4hGjA02NZv21iC4BzOD+TjaA5b6gw?= =?us-ascii?Q?voUJIga4BPZuX9KEMROyMiwMUx+IIDz+JU5XmAFSdC5M+AIVmfuDRaw1IIY4?= =?us-ascii?Q?ugyMqlw4Oue8Euz9YKLiGyswSG5l6NnMZzvXx+ddIrx1EDn4K/llgzQQ4rEq?= =?us-ascii?Q?AYkEK1tp6KLKIk6wqs+5HO2iFYUSjHEVkQ2OtoBrpNzOLoIR38qrYxq0GSRS?= =?us-ascii?Q?odl0PvTe79b5mWpfiNGRrk6eMbmmFOKs0/InhOF6dY26kEX75kU3XBv5sRLl?= =?us-ascii?Q?SCSleKXgmU5KnIBYwwT7SSyaxL+UutT9M1dYYDB1c6vwMLVDE07Jlj2YZMqX?= =?us-ascii?Q?WJndPrmVYN8TrZcKLrur1pid/eG08l6XnaXYCBZnAyytfcEuHAV+03nTSIPf?= =?us-ascii?Q?RM2TUWHopGh0S1kzhp6fCr7VP6kB/zHvWJ6uWrCRkHE3YS0Dq4+YDYx0I77k?= =?us-ascii?Q?wi5/iiRlum/EEYjBKCMyhoOtH1kdRz3v96pYvj8SlZFeI8/ts32rN/s3pVo1?= =?us-ascii?Q?x5tmQFQxcuS/9DlTf4u887fzrkZ/5HCiwhGfiIV2E83K8CYlEE1H5/trS22r?= =?us-ascii?Q?EQ4FybgpejGZWovh7eUiBNmdSZy9HqNqSRbLwbdyptAEHXicQEJBnYHZkX8L?= =?us-ascii?Q?NAJlDgKLHsVtaBNVDYX4jNsE4GYlnqeW4AlW75qgTcpMooycBqJLFxvJjPcD?= =?us-ascii?Q?+C/TvPnB4n4iss7ZtlfQ=3D?= X-Microsoft-Exchange-Diagnostics: 1; CY1PR0701MB1727; 6:1tka+4Q41Xg+gVRH8Yg/w51wgHplNKBB6oLQqdxmXkAxdRSThMMPaNJ9XyOYMwaVPha65/Gv7zHEqNrzVEiQDVKJ1OP6vZI4kE27iTsq/gN+L0j4gejFt3GodlucjeTgehgBk7co6AkbGAhUFk8VUeeOrUftl0TImkzu9+tsHM2VTMyWkFRrVRBH8ptVja195ufYOhwOyiXszfN6O/K+cGz9PyLSQEzqR5oTRQqOnG7tw1BmCeSg9xFgL6ahviRfVe8bccQeyDDnVNroQ+WBsvQsjxS10WT3U//JjfSFJSis5ZsHDoPwp2FR6U4lj1Kdg/tRSYj06Ppsb4K5qULngv24yG2I+xHoE1yxTOkpVeLkjCWJ5NsfCcJTeoVN8Z/HnDljby7scCvbiOZFNeFmxA==; 5:AeJQUKqU0O1mrPe+UD/FGOm8q/DScqaxkQ10az/qLrRDl48mD5+ObrjKqQUfBQ/2lsiFJBHC/4XIkYnfpast3qBDpsr574ce9rL9RBJ9jajkmliWDDFrtf9/8d5GFwqHKBzxuNJKCgjc4bhX1pRpDw==; 24:iGBGBjNI7J00AF6CACxBvenyc214ksErpLBQIqe9JWG/ifxiSSagEkNTTFEXl/nulDexisPNNmng9S5lS7uKwL24Jh/wFJ77y34iiFFIG5Q= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-Microsoft-Exchange-Diagnostics: 1; CY1PR0701MB1727; 7:ZdUXg/IbTX56IAmLfyeX3oEEZFLMj+yjJV2c1Rgw6P4RVZRITLAoO7zbqdiPa4ql6b/rz5Dwq0lyqV9LMXwJ/rNRZEZoZxegwH4by0ZaObn2GewMfhMsmxdxQ+E3V7/GyVq+Ta0zvHAZWuT98q3mZbku8ZzkeEgMYYoTSkpKRHuqIUBIeQsAaMh74q3NU8nrHRSEh5FMRqDFDWUxHX97CaF6pO11A0FF0caRzARwROWfyYS4Q74ZSCoaaVMguhKa0Bai0J1eTb5XrOCrAMovODqEFDgY8dnOt+9Z+NRdi9p97HDklmJGT93huJoqGvMIX3kfUIjaAX/vtfrv4yPFHg== X-OriginatorOrg: caviumnetworks.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 29 Mar 2017 13:47:18.0783 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY1PR0701MB1727 Subject: Re: [dpdk-dev] [PATCH v5 19/20] doc: add event device and software eventdev X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 29 Mar 2017 13:47:22 -0000 On Fri, Mar 24, 2017 at 04:53:14PM +0000, Harry van Haaren wrote: > This commit adds a section to the docs listing the event > device PMDs available. > > It then adds the software eventdev PMD to the listed event > devices. > > Signed-off-by: Harry van Haaren > --- > doc/guides/eventdevs/index.rst | 40 +++++++++++ > doc/guides/eventdevs/sw.rst | 148 +++++++++++++++++++++++++++++++++++++++++ > doc/guides/index.rst | 1 + > 3 files changed, 189 insertions(+) > create mode 100644 doc/guides/eventdevs/index.rst > create mode 100644 doc/guides/eventdevs/sw.rst > > diff --git a/doc/guides/eventdevs/index.rst b/doc/guides/eventdevs/index.rst > new file mode 100644 > index 0000000..9b1fcc7 > --- /dev/null > +++ b/doc/guides/eventdevs/index.rst > @@ -0,0 +1,40 @@ > +.. BSD LICENSE > + Copyright(c) 2017 Intel Corporation. All rights reserved. > + > + Redistribution and use in source and binary forms, with or without > + modification, are permitted provided that the following conditions > + are met: > + > + * Redistributions of source code must retain the above copyright > + notice, this list of conditions and the following disclaimer. > + * Redistributions in binary form must reproduce the above copyright > + notice, this list of conditions and the following disclaimer in > + the documentation and/or other materials provided with the > + distribution. > + * Neither the name of Intel Corporation nor the names of its > + contributors may be used to endorse or promote products derived > + from this software without specific prior written permission. > + > + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS > + "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT > + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR > + A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT > + OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, > + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT > + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, > + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY > + THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT > + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE > + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. > + > +Event Device Drivers > +==================== > + > +The following are a list of Event device PMDs, which can be used from an > +application trough the EventDev API. > + > +.. toctree:: > + :maxdepth: 2 > + :numbered: > + > + sw > diff --git a/doc/guides/eventdevs/sw.rst b/doc/guides/eventdevs/sw.rst > new file mode 100644 > index 0000000..79d8023 > --- /dev/null > +++ b/doc/guides/eventdevs/sw.rst > @@ -0,0 +1,148 @@ > +.. BSD LICENSE > + Copyright(c) 2017 Intel Corporation. All rights reserved. > + > + Redistribution and use in source and binary forms, with or without > + modification, are permitted provided that the following conditions > + are met: > + > + * Redistributions of source code must retain the above copyright > + notice, this list of conditions and the following disclaimer. > + * Redistributions in binary form must reproduce the above copyright > + notice, this list of conditions and the following disclaimer in > + the documentation and/or other materials provided with the > + distribution. > + * Neither the name of Intel Corporation nor the names of its > + contributors may be used to endorse or promote products derived > + from this software without specific prior written permission. > + > + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS > + "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT > + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR > + A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT > + OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, > + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT > + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, > + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY > + THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT > + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE > + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. > + > +Software Eventdev Poll Mode Driver > +================================== > + > +The software eventdev is an implementation of the Eventdev API, that provides a > +wide range of the Eventdev features. The eventdev relies on a CPU core to > +perform event scheduling. > + > + > +Features > +-------- > + > +The software eventdev implements many features in the eventdev API; > + > +Queues > + * Atomic > + * Ordered > + * Parallel > + * Single-Link > + > +Ports > + * Load balanced (for Atomic, Ordered, Parallel queues) > + * Single Link (for single-link queues) > + > +Event Priorities > + * Each event has a priority, which can be used to provide basic QOS s/QOS/QoS > + > + > +Configuration and Options > +------------------------- > + > +The software eventdev is a vdev device, and as such can be created from the > +application code, or from the EAL command line: > + > +* Call ``rte_eal_vdev_init("event_sw0")`` from the application > + > +* Use ``--vdev="event_sw0"`` in the EAL options, which will call > + rte_eal_vdev_init() internally > + > +Example: > + > +.. code-block:: console > + > + ./your_eventdev_application --vdev="event_sw0" > + > + > +Scheduling Quanta > +~~~~~~~~~~~~~~~~~ > + > +The scheduling quanta sets the number of events that the device attempts to > +schedule before returning to the application from the ``rte_event_schedule()`` > +function. Note that is a *hint* only, and that fewer or more events may be > +scheduled in a given iteration. > + > +The scheduling quanta can be set using a string argument to the vdev > +create call: > + > +.. code-block:: console > + > + --vdev="event_sw0,sched_quanta=64" > + > + > +Credit Quanta > +~~~~~~~~~~~~~ > + > +The credit quanta is the number of credits that a port will fetch at a time from > +the instance's credit pool. Higher numbers will cause less overhead in the > +atomic credit fetch code, however it also reduces the overall number of credits > +in the system faster. A balanced number (eg 32) ensures that only small numbers > +of credits are pre-allocated at a time, while also mitigating performance impact > +of the atomics. > + > +Experimentation with higher values may provide minor performance improvements, > +at the cost of the whole system having less credits. On the other hand, > +reducing the quanta may cause measurable performance impact but provide the > +system with a higher number of credits at all times. > + > +A value of 32 seems a good balance however your specific application may > +benefit from a higher or reduced quanta size, experimentation is required to > +verify possible gains. > + > +.. code-block:: console > + > + --vdev="event_sw0,credit_quanta=64" > + > + > +Limitations > +----------- > + > +The software eventdev implementation has a few limitations. The root cause of > +these limitations is that the performance impact of supporting the feature > +would be significant. > + > + > +"All Types" Queues > +~~~~~~~~~~~~~~~~~~ > + > +The software eventdev does not support creating queues that handle all types of > +traffic. An eventdev with this capability allows enqueueing Atomic, Ordered and > +Parallel traffic to the same queue, but scheduling each of them appropriately. > + > +The root cause of not allowing Atomic, Ordered and Parallel event types in the > +same queue is that it causes excessive branching in the code to enqueue packets > +to the queue, causing a significant performance impact. > + > +The ``RTE_EVENT_DEV_CAP_QUEUE_ALL_TYPES`` flag is not set in the > +``event_dev_cap`` field of the ``rte_event_dev_info`` struct for the software > +eventdev. > + > +Distributed Scheduler > +~~~~~~~~~~~~~~~~~~~~~ > + > +The software eventdev is a centralized scheduler, requiring the > +``rte_event_schedule()`` function to be called by a CPU core to perform the > +required event distribution. This is not really a limitation but rather a > +design decision. > + > +The ``RTE_EVENT_DEV_CAP_DISTRIBUTED_SCHED`` flag is not set in the > +``event_dev_cap`` field of the ``rte_event_dev_info`` struct for the software > +eventdev. How about adding unavilablity of timeout support rte_event_dequeue_burst? > diff --git a/doc/guides/index.rst b/doc/guides/index.rst > index 82b00e9..63716b0 100644 > --- a/doc/guides/index.rst > +++ b/doc/guides/index.rst > @@ -43,6 +43,7 @@ DPDK documentation > testpmd_app_ug/index > nics/index > cryptodevs/index > + eventdevs/index > xen/index > contributing/index > rel_notes/index > -- > 2.7.4 With suggested changes, Acked-by: Jerin Jacob >