From mboxrd@z Thu Jan 1 00:00:00 1970 From: Pablo de Lara Subject: =?utf-8?q?=5BPATCH_v4_6/8=5D_doc=3A_removed_reference_?= =?utf-8?q?to_Intel_DPDK_in_Rel_Notes?= Date: Wed, 17 Dec 2014 16:47:35 +0000 Message-ID: <1418834857-8643-7-git-send-email-pablo.de.lara.guarch@intel.com> References: <1418741302-19898-1-git-send-email-siobhan.a.butler@intel.com> <1418834857-8643-1-git-send-email-pablo.de.lara.guarch@intel.com> Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable To: dev-VfR2kkLFssw@public.gmane.org Return-path: In-Reply-To: <1418834857-8643-1-git-send-email-pablo.de.lara.guarch-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org> List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces-VfR2kkLFssw@public.gmane.org Sender: "dev" From: Siobhan Butler Removed multiple references to Intel(R) DPDK where no longer relevant. Signed-off-by: Siobhan Butler --- doc/guides/rel_notes/faq.rst | 14 +++--- doc/guides/rel_notes/known_issues.rst | 30 ++++++------- doc/guides/rel_notes/rel_description.rst | 36 ++++++--------- doc/guides/rel_notes/resolved_issues.rst | 70 ++++++++++++++---------= ------ doc/guides/rel_notes/supported_features.rst | 10 ++--- doc/guides/rel_notes/supported_os.rst | 2 +- doc/guides/rel_notes/updating_apps.rst | 12 +++-- 7 files changed, 85 insertions(+), 89 deletions(-) diff --git a/doc/guides/rel_notes/faq.rst b/doc/guides/rel_notes/faq.rst index dfc34e6..054db10 100644 --- a/doc/guides/rel_notes/faq.rst +++ b/doc/guides/rel_notes/faq.rst @@ -36,7 +36,7 @@ When running the test application, I get =E2=80=9CEAL: = map_all_hugepages(): open faile =20 This is most likely due to the test application not being run with sudo = to promote the user to a superuser. Alternatively, applications can also be run as regular user. -For more information, please refer to *Intel=C2=AE DPDK Getting Started = Guide*. +For more information, please refer to *DPDK Getting Started Guide*. =20 If I want to change the number of TLB Hugepages allocated, how do I remo= ve the original pages allocated? ------------------------------------------------------------------------= -------------------------------- @@ -49,7 +49,7 @@ If you look in the directory, you will see n number of = 2M pages files. If you sp These are then placed in memory segments to get contiguous memory. =20 If you need to change the number of pages, it is easier to first remove = the pages. The tools/setup.sh script provides an option to do this. -See the =E2=80=9CQuick Start Setup Script=E2=80=9D section in the *Intel= =C2=AE DPDK Getting Started Guide* for more information. +See the =E2=80=9CQuick Start Setup Script=E2=80=9D section in the *DPDK = Getting Started Guide* for more information. =20 If I execute =E2=80=9Cl2fwd -c f -m 64 =E2=80=93n 3 -- -p 3=E2=80=9D, I = get the following output, indicating that there are no socket 0 hugepages= to allocate the mbuf and ring structures to? ------------------------------------------------------------------------= -------------------------------------------------------------------------= ---------------------- @@ -59,14 +59,14 @@ I have set up a total of 1024 Hugepages (that is, all= ocated 512 2M pages to each The -m command line parameter does not guarantee that huge pages will be= reserved on specific sockets. Therefore, allocated huge pages may not be= on socket 0. To request memory to be reserved on a specific socket, please use the --= socket-mem command-line parameter instead of -m. =20 -I am running a 32-bit Intel=C2=AE DPDK application on a NUMA system, and= sometimes the application initializes fine but cannot allocate memory. W= hy is that happening? +I am running a 32-bit DPDK application on a NUMA system, and sometimes t= he application initializes fine but cannot allocate memory. Why is that h= appening? ------------------------------------------------------------------------= -------------------------------------------------------------------------= ---------------- =20 32-bit applications have limitations in terms of how much virtual memory= is available, hence the number of hugepages they are able to allocate is= also limited (1 GB per page size). If your system has a lot (>1 GB per page size) of hugepage memory, not a= ll of it will be allocated. Due to hugepages typically being allocated on a local NUMA node, the hug= epages allocation the application gets during the initialization depends = on which NUMA node it is running on (the EAL does not affinitize cores until much= later in the initialization process). -Sometimes, the Linux OS runs the Intel=C2=AE DPDK application on a core = that is located on a different NUMA node from Intel=C2=AE DPDK master cor= e and +Sometimes, the Linux OS runs the DPDK application on a core that is loca= ted on a different NUMA node from DPDK master core and therefore all the hugepages are allocated on the wrong socket. =20 To avoid this scenario, either lower the amount of hugepage memory avail= able to 1 GB per page size (or less), or run the application with taskset @@ -102,7 +102,7 @@ Traditionally, there is a trade-off between throughpu= t and latency. An applicati but the end-to-end latency of an average packet typically increases as a= result. Similarly, the application can be tuned to have, on average, a low end-t= o-end latency at the cost of lower throughput. =20 -To achieve higher throughput, the Intel=C2=AE DPDK attempts to aggregate= the cost of processing each packet individually by processing packets in= bursts. +To achieve higher throughput, the DPDK attempts to aggregate the cost of= processing each packet individually by processing packets in bursts. Using the testpmd application as an example, the =E2=80=9Cburst=E2=80=9D= size can be set on the command line to a value of 16 (also the default v= alue). This allows the application to request 16 packets at a time from the PMD= . The testpmd application then immediately attempts to transmit all the pa= ckets that were received, in this case, all 16 packets. @@ -144,11 +144,11 @@ For best performance with NUMA disabled, only one s= ocket should be populated. I am getting errors about not being able to open files. Why? ------------------------------------------------------------ =20 -As the Intel=C2=AE DPDK operates, it opens a lot of files, which can res= ult in reaching the open files limits, which is set using the ulimit comm= and or in the limits.conf file. +As the DPDK operates, it opens a lot of files, which can result in reach= ing the open files limits, which is set using the ulimit command or in th= e limits.conf file. This is especially true when using a large number (>512) of 2 MB huge pa= ges. Please increase the open file limit if your application is not able = to open files. This can be done either by issuing a ulimit command or editing the limit= s.conf file. Please consult Linux* manpages for usage information. =20 -Does my kernel require patching to run the Intel=C2=AE=C2=A0DPDK? +Does my kernel require patching to run the=C2=A0DPDK? ------------------------------------------------------- =20 Any kernel greater than version 2.6.33 can be used without any patches a= pplied. The following kernels may require patches to provide hugepage sup= port: diff --git a/doc/guides/rel_notes/known_issues.rst b/doc/guides/rel_notes= /known_issues.rst index 1cfc977..0107f9d 100644 --- a/doc/guides/rel_notes/known_issues.rst +++ b/doc/guides/rel_notes/known_issues.rst @@ -31,7 +31,7 @@ Known Issues and Limitations =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D =20 -This section describes known issues with the Intel=C2=AE DPDK software, = Release 1.6.0. +This section describes known issues with the DPDK software, Release 1.8.= 0. =20 Pause Frame Forwarding does not work properly on igb ---------------------------------------------------- @@ -112,13 +112,13 @@ Vhost-xen cannot detect Domain U application exit o= n Xen version 4.0.1 | Reference # | IXA00168947 = | | | = | +--------------------------------+--------------------------------------= ------------------------------------------------+ -| Description | When using Intel=C2=AE DPDK applicati= ons on Xen 4.0.1, e.g. TestPMD Sample Application, | +| Description | When using DPDK applications on Xen 4= .0.1, e.g. TestPMD Sample Application, | | | on killing the application (e.g. kill= all testmd) vhost-switch cannot detect | | | the domain U exited and does not free= the Virtio device. | | | = | +--------------------------------+--------------------------------------= ------------------------------------------------+ | Implication | Virtio device not freed after applica= tion is killed when using vhost-switch on Xen | -| | = 4.0.1 | +| | 4.0.1 = | | | = | +--------------------------------+--------------------------------------= ------------------------------------------------+ | Resolution | = | @@ -154,7 +154,7 @@ Virtio incorrect header length used if MSI-X is disab= led by kernel driver | | specification and resolves to the VIR= TIO_NET_F_MAC feature instead. | | | = | +--------------------------------+--------------------------------------= ------------------------------------------------+ -| Implication | The Intel=C2=AE DPDK kernel driver wi= ll enable MSI-X by default, | +| Implication | The DPDK kernel driver will enable MS= I-X by default, | | | however if loaded with =E2=80=9Cintr_= mode=3Dlegacy=E2=80=9D on a guest with a Virtio Network Device, | | | a KVM-Qemu guest may crash with the f= ollowing error: =E2=80=9Cvirtio-net header not in first | | | element=E2=80=9D. = | @@ -425,13 +425,13 @@ Unstable system performance across application exec= utions with 2MB pages | Reference # | IXA00372346 = | | | = | +--------------------------------+--------------------------------------= ------------------------------------------------+ -| Description | The performance of an Intel=C2=AE DPD= K application may vary across executions of an | +| Description | The performance of a DPDK application= may vary across executions of an | | | application due to a varying number o= f TLB misses depending on the location of | | | accessed structures in memory. = | | | This situation occurs on rare occasio= ns. | | | = | +--------------------------------+--------------------------------------= ------------------------------------------------+ -| Implication | Occasionally, relatively poor perform= ance of Intel=C2=AE DPDK applications is encountered.| +| Implication | Occasionally, relatively poor perform= ance of DPDK applications is encountered. | | | = | +--------------------------------+--------------------------------------= ------------------------------------------------+ | Resolution/ Workaround | Using 1 GB pages results in lower usa= ge of TLB entries, resolving this issue. | @@ -536,7 +536,7 @@ PMD does not work with --no-huge EAL command line par= ameter | Reference # | IXA00373461 = | | | = | +--------------------------------+--------------------------------------= ------------------------------------------------+ -| Description | Currently, the Intel=C2=AE DPDK does = not store any information about memory allocated by | +| Description | Currently, the DPDK does not store an= y information about memory allocated by | | | malloc() (for example, NUMA node, phy= sical address), hence PMD drivers do not work | | | when the --no-huge command line param= eter is supplied to EAL. | | | = | @@ -547,7 +547,7 @@ PMD does not work with --no-huge EAL command line par= ameter | Resolution/ Workaround | Use huge page memory or use VFIO to m= ap devices. | | | = | +--------------------------------+--------------------------------------= ------------------------------------------------+ -| Affected Environment/ Platform | Systems running the Intel=C2=AE DPDK= on Linux | +| Affected Environment/ Platform | Systems running the DPDK on Linux = | | | = | +--------------------------------+--------------------------------------= ------------------------------------------------+ | Driver/Module | Poll Mode Driver (PMD) = | @@ -701,24 +701,24 @@ Discrepancies between statistics reported by differ= ent NICs | | = | +--------------------------------+--------------------------------------= ------------------------------------------------+ =20 -Error reported opening files on Intel=C2=AE DPDK initialization ----------------------------------------------------------- +Error reported opening files on DPDK initialization +--------------------------------------------------- =20 =20 +--------------------------------+--------------------------------------= ------------------------------------------------+ -| Title | Error reported opening files on Intel= =C2=AE DPDK initialization | +| Title | Error reported opening files on DPDK = initialization | | | = | +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D+=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D+ | Reference # | 91 = | | | = | +--------------------------------+--------------------------------------= ------------------------------------------------+ -| Description | On Intel=C2=AE DPDK application start= up, errors may be reported when opening files as | +| Description | On DPDK application startup, errors m= ay be reported when opening files as | | | part of the initialization process. T= his occurs if a large number, for example, 500 | | | or more, or if hugepages are used, du= e to the per-process limit on the number of | | | open files. = | | | = | +--------------------------------+--------------------------------------= ------------------------------------------------+ -| Implication | The Intel=C2=AE DPDK application may = fail to run. | +| Implication | The DPDK application may fail to run.= | | | = | +--------------------------------+--------------------------------------= ------------------------------------------------+ | Resolution/ Workaround | If using 2 MB hugepages, consider swi= tching to a fewer number of 1 GB pages. | @@ -890,11 +890,11 @@ GCC might generate Intel=C2=AE AVX instructions for= processors without Intel=C2=AE AVX su | Reference # | IXA00382439 = | | | = | +--------------------------------+--------------------------------------= ------------------------------------------------+ -| Description | When compiling Intel=C2=AE DPDK (and= any Intel=C2=AE DPDK app), gcc may generate Intel=C2=AE AVX | +| Description | When compiling Intel=C2=AE DPDK (and= any DPDK app), gcc may generate Intel=C2=AE AVX | | | instructions, even when the processor= does not support Intel=C2=AE AVX. | | | = | +--------------------------------+--------------------------------------= ------------------------------------------------+ -| Implication | Any Intel=C2=AE DPDK app might crash = while starting up. | +| Implication | Any DPDK app might crash while starti= ng up. | | | = | +--------------------------------+--------------------------------------= ------------------------------------------------+ | Resolution/ Workaround | Either compile using icc or set EXTRA= _CFLAGS=3D=E2=80=99-O3=E2=80=99 prior to compilation. | diff --git a/doc/guides/rel_notes/rel_description.rst b/doc/guides/rel_no= tes/rel_description.rst index d159b3c..8da53c4 100644 --- a/doc/guides/rel_notes/rel_description.rst +++ b/doc/guides/rel_notes/rel_description.rst @@ -32,22 +32,14 @@ Description of Release =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 These release notes cover the new features, -fixed bugs and known issues for Intel=C2=AE Data Plane Development Kit (= Intel=C2=AE DPDK) release version 1.7.0. +fixed bugs and known issues for Data Plane Development Kit (DPDK) releas= e version 1.7.0. =20 -For instructions on compiling and running the release, see the *Intel=C2= =AE DPDK Getting Started Guide*. +For instructions on compiling and running the release, see the *DPDK Get= ting Started Guide*. =20 -Important Note --------------- +Using DPDK Upgrade Patches +-------------------------- =20 -All Intel=C2=AE DPDK questions and technical problems including those re= garding the Ethernet* Controllers for the Poll Mode Driver should be repo= rted through the Intel=C2=AE Premier Support site -`http://premier.intel.com/premier `_ -or access your IBL account and click the **Intel=C2=AE Premier Support**= link to enter issues under the Product Name =E2=80=9CData Plane Developm= ent Kit (DPDK)=E2=80=9D, -which are then routed to our support team. - -Using Intel=C2=AE DPDK Upgrade Patches ---------------------------------- - -For minor updates to the main Intel=C2=AE DPDK releases, the software ma= y be made available both as a new full package and as a patch file to be = applied to the previously released package. +For minor updates to the main DPDK releases, the software may be made av= ailable both as a new full package and as a patch file to be applied to t= he previously released package. In the latter case, the following commands should be used to apply the p= atch on top of the already-installed package for the previous release: =20 .. code-block:: console @@ -55,7 +47,7 @@ In the latter case, the following commands should be us= ed to apply the patch on # cd $RTE_SDK # patch =E2=80=93p1 < /path/to/patch/file =20 -Once the patch has been applied cleanly, the Intel=C2=AE DPDK can be rec= ompiled and used as before (described in the *Intel=C2=AE DPDK Getting St= arted Guide*). +Once the patch has been applied cleanly, the DPDK can be recompiled and = used as before (described in the *DPDK Getting Started Guide*). =20 .. note:: =20 @@ -65,25 +57,25 @@ Once the patch has been applied cleanly, the Intel=C2= =AE DPDK can be recompiled and Documentation Roadmap --------------------- =20 -The following is a list of Intel=C2=AE DPDK documents in the suggested r= eading order: +The following is a list of DPDK documents in the suggested reading order= : =20 * **Release Notes** (this document): Provides release-specific information, including su= pported features, limitations, fixed issues, known issues and so on. Also, provides the answers to frequently asked questions in FAQ form= at. =20 * **Getting Started Guide** - : Describes how to install and configure the Intel=C2=AE DPDK softwa= re; designed to get users up and running quickly with the software. + : Describes how to install and configure the DPDK software; designed= to get users up and running quickly with the software. =20 * **FreeBSD* Getting Started Guide** - : A document describing the use of the Intel=C2=AE DPDK with FreeBSD= * has been added in Intel=C2=AE DPDK Release 1.6.0. - Refer to this guide for installation and configuration instructions = to get started using the Intel=C2=AE DPDK with FreeBSD*. + : A document describing the use of the DPDK with FreeBSD* has been a= dded in DPDK Release 1.6.0. + Refer to this guide for installation and configuration instructions = to get started using the DPDK with FreeBSD*. =20 * **Programmer's Guide** : Describes: =20 * The software architecture and how to use it (through examples), = specifically in a Linux* application (linuxapp) environment =20 - * The content of the Intel=C2=AE DPDK, the build system (including= the commands that can be used in the root Intel=C2=AE DPDK Makefile to b= uild the development kit and an application) + * The content of the DPDK, the build system (including the command= s that can be used in the root DPDK Makefile to build the development kit= and an application) and guidelines for porting an application =20 * Optimizations used in the software and those that should be cons= idered for new development @@ -91,7 +83,7 @@ The following is a list of Intel=C2=AE DPDK documents i= n the suggested reading order A glossary of terms is also provided. =20 * **API Reference** - : Provides detailed information about Intel=C2=AE DPDK functions, da= ta structures and other programming constructs. + : Provides detailed information about DPDK functions, data structure= s and other programming constructs. =20 * **Sample Applications User Guide** : Describes a set of sample applications. Each chapter describes a s= ample application that showcases specific functionality and provides inst= ructions on how to compile, @@ -160,11 +152,11 @@ The following is a list of Intel=C2=AE DPDK documen= ts in the suggested reading order =20 Once the libraries are created, they can be found in the build/app d= irectory. =20 - * The test application provides a variety of specific tests for th= e various functions in the Intel=C2=AE DPDK. + * The test application provides a variety of specific tests for th= e various functions in the DPDK. =20 * The testpmd application provides a number of different packet th= roughput tests and examples of features such as how to use the Flow Director found in the Intel=C2=AE 82599 10 G= igabit Ethernet Controller. =20 - The testpmd application is documented in the *Intel=C2=AE DPDK Testp= md Application Note* (525362). + The testpmd application is documented in the *DPDK Testpmd Applicati= on Note* (525362). The test application is not currently documented. However, you should be able to run and use test application with the= command line help that is provided in the application. diff --git a/doc/guides/rel_notes/resolved_issues.rst b/doc/guides/rel_no= tes/resolved_issues.rst index 66afc25..16e1026 100644 --- a/doc/guides/rel_notes/resolved_issues.rst +++ b/doc/guides/rel_notes/resolved_issues.rst @@ -200,7 +200,7 @@ Device initialization failure with Intel=C2=AE Ethern= et Server Adapter X520-T2 | Reference # | 55 = | | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ -| Description | If this device is bound to the Linux= kernel IXGBE driver when the Intel=C2=AE DPDK is | +| Description | If this device is bound to the Linux= kernel IXGBE driver when the DPDK is | | | initialized, DPDK is initialized, th= e device initialization fails with error code -17 | | | =E2=80=9CIXGBE_ERR_PHY_ADDR_INVALID=E2= =80=9D. | | | = | @@ -208,7 +208,7 @@ Device initialization failure with Intel=C2=AE Ethern= et Server Adapter X520-T2 | Implication | The device is not initialized and ca= nnot be used by an application. | | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ -| Resolution/Workaround | Introduced a small delay in device i= nitialization to allow Intel=C2=AE DPDK to always find | +| Resolution/Workaround | Introduced a small delay in device i= nitialization to allow DPDK to always find | | | the device. = | | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ @@ -219,11 +219,11 @@ Device initialization failure with Intel=C2=AE Ethe= rnet Server Adapter X520-T2 | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ =20 -Intel=C2=AE DPDK kernel module is incompatible with Linux kernel version= 3.3 ------------------------------------------------------------------------ +DPDK kernel module is incompatible with Linux kernel version 3.3 +---------------------------------------------------------------- =20 +---------------------------------+-------------------------------------= --------------------------------------------------+ -| Title | Intel=C2=AE DPDK kernel module is in= compatible with Linux kernel version 3.3 | +| Title | DPDK kernel module is incompatible w= ith Linux kernel version 3.3 | | | = | +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D+=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D+ | Reference # | IXA00373232 = | @@ -430,7 +430,7 @@ Port not found issue with Intel=C2=AE 82580 Gigabit E= thernet Controller +---------------------------------+-------------------------------------= --------------------------------------------------+ | Description | After going through multiple driver = unbind/bind cycles, an Intel=C2=AE 82580 | | | Ethernet Controller port may no long= er be found and initialized by the | -| | Intel=C2=AE DPDK. = | +| | DPDK. = | | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ | Implication | The port will be unusable. = | @@ -506,8 +506,8 @@ Promiscuous mode for 82580 NICs can only be enabled a= fter a call to rte_eth_dev_ | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ =20 -Incorrect CPU socket information reported in /proc/cpuinfo can prevent t= he Intel=C2=AE DPDK from running -------------------------------------------------------------------------= --------------------------- +Incorrect CPU socket information reported in /proc/cpuinfo can prevent t= he DPDK from running +------------------------------------------------------------------------= -------------------- =20 +---------------------------------+-------------------------------------= --------------------------------------------------+ | Title | Incorrect CPU socket information rep= orted in /proc/cpuinfo can prevent the Intel=C2=AE | @@ -517,14 +517,14 @@ Incorrect CPU socket information reported in /proc/= cpuinfo can prevent the Intel | Reference # | 63 = | | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ -| Description | The Intel=C2=AE DPDK users informati= on supplied by the Linux kernel to determine the | +| Description | The DPDK users information supplied = by the Linux kernel to determine the | | | hardware properties of the system be= ing used. On rare occasions, information supplied | | | by /proc/cpuinfo does not match that= reported elsewhere. In some cases, it has been | | | observed that the CPU socket numberi= ng given in /proc/cpuinfo is incorrect and this | -| | can prevent Intel=C2=AE DPDK from op= erating. | +| | can prevent DPDK from operating. = | | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ -| Implication | The Intel=C2=AE DPDK cannot run on s= ystems where /proc/cpuinfo does not report the correct | +| Implication | The DPDK cannot run on systems where= /proc/cpuinfo does not report the correct | | | CPU socket topology. = | | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ @@ -578,7 +578,7 @@ L3FWD-VF might lose CRC bytes | Description | Currently, the CRC stripping configu= ration does not affect the VF driver. | | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ -| Implication | Packets transmitted by the Intel=C2=AE= DPDK in the VM may be lacking 4 bytes (packet CRC). | +| Implication | Packets transmitted by the DPDK in t= he VM may be lacking 4 bytes (packet CRC). | | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ | Resolution/ Workaround | Set =E2=80=9Cstrip_crc=E2=80=9D to 1= in the sample applications that use the VF PMD. | @@ -591,8 +591,8 @@ L3FWD-VF might lose CRC bytes | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ =20 -32-bit Intel=C2=AE DPDK sample applications fails when using more than o= ne 1 GB hugepage -------------------------------------------------------------------------= ----------- +32-bit DPDK sample applications fails when using more than one 1 GB huge= page +------------------------------------------------------------------------= ---- =20 +---------------------------------+-------------------------------------= --------------------------------------------------+ | Title | 32-bit Intel=C2=AE DPDK sample appl= ications fails when using more than one 1 GB hugepage | @@ -646,11 +646,11 @@ l2fwd fails to launch if the NIC is the Intel=C2=AE= 82571EB Gigabit Ethernet Control | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ =20 -32-bit Intel=C2=AE DPDK applications may fail to initialize on 64-bit OS -------------------------------------------------------------------- +32-bit DPDK applications may fail to initialize on 64-bit OS +------------------------------------------------------------ =20 +---------------------------------+-------------------------------------= --------------------------------------------------+ -| Title | 32-bit Intel=C2=AE DPDK applications= may fail to initialize on 64-bit OS | +| Title | 32-bit DPDK applications may fail to= initialize on 64-bit OS | | | = | +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D+=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D+ | Reference # | IXA00378513 = | @@ -739,12 +739,12 @@ Config file change can cause build to fail | Reference # | IXA00369247 = | | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ -| Description | If a change in a config file results= in some Intel=C2=AE DPDK files that were needed no | +| Description | If a change in a config file results= in some DPDK files that were needed no | | | longer being needed, the build will = fail. This is because the \*.o file will still | | | exist, and the linker will try to li= nk it. | | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ -| Implication | Intel=C2=AE DPDK compilation failure= | +| Implication | DPDK compilation failure = | | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ | Resolution | The Makefile now provides instructio= ns to clean out old kernel module object files. | @@ -768,8 +768,8 @@ rte_cmdline library should not be used in production = code due to limited testing | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ | Description | The rte_cmdline library provides a c= ommand line interface for use in sample | -| | applications and test applications d= istributed as part of Intel=C2=AE DPDK. However, it is | -| | not validated to the same standard a= s other Intel=C2=AE DPDK libraries. | +| | applications and test applications d= istributed as part of DPDK. However, it is | +| | not validated to the same standard a= s other DPDK libraries. | | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ | Implication | It may contain bugs or errors that c= ould cause issues in production applications. | @@ -1017,18 +1017,18 @@ EAL can silently reserve less memory than request= ed | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ =20 -SSH connectivity with the board may be lost when starting an Intel=C2=AE= DPDK application -------------------------------------------------------------------------= ------------ +SSH connectivity with the board may be lost when starting a DPDK applica= tion +------------------------------------------------------------------------= ---- =20 +---------------------------------+-------------------------------------= --------------------------------------------------+ -| Title | SSH connectivity with the board may = be lost when starting an Intel=C2=AE DPDK application | +| Title | SSH connectivity with the board may = be lost when starting a DPDK application | | | = | +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D+=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D+ | Reference # | 26 = | | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ | Description | Currently, the Intel=C2=AE DPDK tak= es over all the NICs found on the board that are | -| | supported by the Intel=C2=AE DPDK. T= his results in these NICs being removed from the NIC | +| | supported by the DPDK. This results = in these NICs being removed from the NIC | | | set handled by the kernel,which has = the side effect of any SSH connection being | | | terminated. See also issue #27. = | | | = | @@ -1036,8 +1036,8 @@ SSH connectivity with the board may be lost when st= arting an Intel=C2=AE DPDK applic | Implication | Loss of network connectivity to boar= d. | | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ -| Resolution | Intel=C2=AE DPDK now no longer binds= ports on startup. Please refer to the Getting Started | -| | Guide for information on how to bind= /unbind ports from Intel=C2=AE DPDK. | +| Resolution | DPDK now no longer binds ports on st= artup. Please refer to the Getting Started | +| | Guide for information on how to bind= /unbind ports from DPDK. | | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ | Affected Environment/Platform | Systems using a Intel=C2=AEDPDK supp= orted NIC for remote system access | @@ -1065,12 +1065,12 @@ Remote network connections lost when running auto= tests or sample applications | Implication | Loss of network connectivity to boar= d when connected remotely. | | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ -| Resolution | Intel=C2=AE DPDK now no longer binds= ports on startup. | +| Resolution | DPDK now no longer binds ports on st= artup. | | | Please refer to the Getting Started = Guide for information on how to bind/unbind ports | -| | from Intel=C2=AE DPDK. = | +| | from DPDK. = | | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ -| Affected Environment/Platform | Systems using a Intel=C2=AE DPDK sup= ported NIC for remote system access | +| Affected Environment/Platform | Systems using a DPDK supported NIC f= or remote system access | | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ | Driver/Module | Sample applications = | @@ -1089,10 +1089,10 @@ KNI may not work properly in a multi-process envi= ronment +---------------------------------+-------------------------------------= --------------------------------------------------+ | Description | Some of the network interface operat= ions such as, MTU change or link UP/DOWN, when | | | executed on KNI interface, might fai= l in a multi-process environment, although they | -| | are normally successful in the Intel= =C2=AE DPDK single process environment. | +| | are normally successful in the DPDK = single process environment. | | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ -| Implication | Some network interface operations on= KNI cannot be used in an Intel=C2=AE DPDK | +| Implication | Some network interface operations on= KNI cannot be used in a DPDK | | | multi-process environment. = | | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ @@ -1119,14 +1119,14 @@ Hash library cannot be used in multi-process appl= ications with multiple binaries | Description | The hash function used by a given ha= sh-table implementation is referenced in the code | | | by way of a function pointer. This m= eans that it cannot work in cases where the hash | | | function is at a different location = in the code segment in different processes, as is | -| | the case where an Intel=C2=AE DPDK m= ulti-process application uses a number of different | +| | the case where a DPDK multi-process = application uses a number of different | | | binaries, for example, the client-se= rver multi-process example. | | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ | Implication | The Hash library will not work if sh= ared by multiple processes. | | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ -| Resolution/Workaround | New API was added for multiprocess s= cenario. Please refer to Intel=C2=AE DPDK Programmer=E2=80=99s | +| Resolution/Workaround | New API was added for multiprocess s= cenario. Please refer to DPDK Programmer=E2=80=99s | | | Guide for more information. = | | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ @@ -1182,7 +1182,7 @@ Packet reception issues when virtualization is enab= led | Implication | An application requiring packet tran= smission or reception will not function. | | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ -| Resolution/Workaround | Intel=C2=AE DPDK Poll Mode Driver no= w has the ability to map correct physical addresses to | +| Resolution/Workaround | DPDK Poll Mode Driver now has the ab= ility to map correct physical addresses to | | | the device structures. = | | | = | +---------------------------------+-------------------------------------= --------------------------------------------------+ diff --git a/doc/guides/rel_notes/supported_features.rst b/doc/guides/rel= _notes/supported_features.rst index 7efeff3..37e5416 100644 --- a/doc/guides/rel_notes/supported_features.rst +++ b/doc/guides/rel_notes/supported_features.rst @@ -61,7 +61,7 @@ Supported Features =20 * Virtualization (Xen) =20 - * Support for Intel=C2=AE DPDK application running on Xen Domain0 = without hugepages. + * Support for DPDK application running on Xen Domain0 without huge= pages. =20 * Para-virtualization =20 @@ -70,7 +70,7 @@ Supported Features Support userspace packet switching back-end example in host doma= in =20 * FreeBSD* 9.2 support for librte_pmd_e1000, librte_pmd_ixgbe and Virt= ual Function variants. - Please refer to the *Intel=C2=AE DPDK for FreeBSD\* Getting Started = Guide*. + Please refer to the *DPDK for FreeBSD\* Getting Started Guide*. Application support has been added for the following: =20 * multiprocess/symmetric_mp @@ -87,7 +87,7 @@ Supported Features =20 * New VMXNET3 driver for the paravirtual device presented to a VM by t= he VMware* ESXi Hypervisor. =20 -* BETA: example support for basic Netmap applications on Intel=C2=AE D= PDK +* BETA: example support for basic Netmap applications on DPDK =20 * Support for the wireless KASUMI algorithm in the dpdk_qat sample app= lication =20 @@ -157,7 +157,7 @@ Supported Features =20 * Improved scalability for scheduling large numbers of timers using th= e rte_timer library =20 -* Support for building the Intel=C2=AE DPDK as a shared library +* Support for building the DPDK as a shared library =20 * Support for Intel=C2=AE Ethernet Server Bypass Adapter X520-SR2 =20 @@ -362,7 +362,7 @@ Supported Features =20 * Header files for common protocols (IP, SCTP, TCP, UDP) =20 -* Improved multi-process application support, allowing multiple co-ope= rating Intel=C2=AE DPDK +* Improved multi-process application support, allowing multiple co-ope= rating DPDK processes to access the NIC port queues directly. =20 * CPU-specific compiler optimization diff --git a/doc/guides/rel_notes/supported_os.rst b/doc/guides/rel_notes= /supported_os.rst index fb23dda..739cb2c 100644 --- a/doc/guides/rel_notes/supported_os.rst +++ b/doc/guides/rel_notes/supported_os.rst @@ -46,4 +46,4 @@ The following Linux* distributions were successfully us= ed to generate or run the * SUSE Enterprise Linux* 11 SP2 =20 These distributions may need additional packages that are not installed = by default, or a specific kernel. -Refer to the *Intel=C2=AE DPDK Getting Started Guide* for details. +Refer to the *DPDK Getting Started Guide* for details. diff --git a/doc/guides/rel_notes/updating_apps.rst b/doc/guides/rel_note= s/updating_apps.rst index ba8012d..034554d 100644 --- a/doc/guides/rel_notes/updating_apps.rst +++ b/doc/guides/rel_notes/updating_apps.rst @@ -1,11 +1,15 @@ Updating Applications from Previous Versions =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 -Although backward compatibility is being maintained across Intel=C2=AE D= PDK releases, code written for previous versions of the Intel=C2=AE DPDK -may require some code updates to benefit from performance and user exper= ience enhancements provided in later Intel=C2=AE DPDK releases. +Although backward compatibility is being maintained across DPDK releases= , code written for previous versions of the DPDK +may require some code updates to benefit from performance and user exper= ience enhancements provided in later DPDK releases. =20 -Intel=C2=AE DPDK 1.6 to Intel=C2=AE DPDK 1.7 ----------------------------------- +DPDK 1.7 to DPDK 1.8 +-------------------- + + +Intel=C2=AE DPDK 1.6 to DPDK 1.7 +--------------------------- =20 Note the following difference between 1.6 and 1.7: =20 --=20 2.1.0