Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/64193/?format=api
{ "id": 64193, "url": "http://patches.dpdk.org/api/patches/64193/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/20200103153256.2895527-3-bruce.richardson@intel.com/", "project": { "id": 1, "url": "http://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": "<20200103153256.2895527-3-bruce.richardson@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20200103153256.2895527-3-bruce.richardson@intel.com", "date": "2020-01-03T15:32:53", "name": "[2/5] doc: document installing from FreeBSD package", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": true, "hash": "c49d99dbad8505d190ff07a03f194ca9e7f55f4b", "submitter": { "id": 20, "url": "http://patches.dpdk.org/api/people/20/?format=api", "name": "Bruce Richardson", "email": "bruce.richardson@intel.com" }, "delegate": { "id": 1, "url": "http://patches.dpdk.org/api/users/1/?format=api", "username": "tmonjalo", "first_name": "Thomas", "last_name": "Monjalon", "email": "thomas@monjalon.net" }, "mbox": "http://patches.dpdk.org/project/dpdk/patch/20200103153256.2895527-3-bruce.richardson@intel.com/mbox/", "series": [ { "id": 7980, "url": "http://patches.dpdk.org/api/series/7980/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=7980", "date": "2020-01-03T15:32:51", "name": "Update docs for installing on FreeBSD", "version": 1, "mbox": "http://patches.dpdk.org/series/7980/mbox/" } ], "comments": "http://patches.dpdk.org/api/patches/64193/comments/", "check": "success", "checks": "http://patches.dpdk.org/api/patches/64193/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 dpdk.org (dpdk.org [92.243.14.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id E05BCA04F3;\n\tFri, 3 Jan 2020 16:33:26 +0100 (CET)", "from [92.243.14.124] (localhost [127.0.0.1])\n\tby dpdk.org (Postfix) with ESMTP id E27B81D455;\n\tFri, 3 Jan 2020 16:33:14 +0100 (CET)", "from mga18.intel.com (mga18.intel.com [134.134.136.126])\n by dpdk.org (Postfix) with ESMTP id D5CEA1D44C\n for <dev@dpdk.org>; Fri, 3 Jan 2020 16:33:12 +0100 (CET)", "from orsmga003.jf.intel.com ([10.7.209.27])\n by orsmga106.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;\n 03 Jan 2020 07:33:12 -0800", "from silpixa00399126.ir.intel.com (HELO\n silpixa00399126.ger.corp.intel.com) ([10.237.223.2])\n by orsmga003.jf.intel.com with ESMTP; 03 Jan 2020 07:33:11 -0800" ], "X-Amp-Result": "SKIPPED(no attachment in message)", "X-Amp-File-Uploaded": "False", "X-ExtLoop1": "1", "X-IronPort-AV": "E=Sophos;i=\"5.69,391,1571727600\"; d=\"scan'208\";a=\"222192964\"", "From": "Bruce Richardson <bruce.richardson@intel.com>", "To": "john.mcnamara@intel.com,\n\tmarko.kovacevic@intel.com", "Cc": "anatoly.burakov@intel.com, dev@dpdk.org,\n Bruce Richardson <bruce.richardson@intel.com>", "Date": "Fri, 3 Jan 2020 15:32:53 +0000", "Message-Id": "<20200103153256.2895527-3-bruce.richardson@intel.com>", "X-Mailer": "git-send-email 2.24.1", "In-Reply-To": "<20200103153256.2895527-1-bruce.richardson@intel.com>", "References": "<20200103153256.2895527-1-bruce.richardson@intel.com>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "Subject": "[dpdk-dev] [PATCH 2/5] doc: document installing from FreeBSD package", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.15", "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", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "Update the FreeBSD GSG to cover installing from the pre-built package as\nwell as installing from a port.\n\nAlso, since the port is now based on meson, update the instructions for\ncompiling and running the example applications.\n\nSigned-off-by: Bruce Richardson <bruce.richardson@intel.com>\n---\nNote: at this stage, DPDK is in the \"latest\" package snapshot, but has\nnot yet made it's way into the quarterly snapshot used by default by\nstable releases. This is hopefully only a matter of time.\n---\n doc/guides/freebsd_gsg/install_from_ports.rst | 73 +++++++++----------\n 1 file changed, 36 insertions(+), 37 deletions(-)", "diff": "diff --git a/doc/guides/freebsd_gsg/install_from_ports.rst b/doc/guides/freebsd_gsg/install_from_ports.rst\nindex 29f16cc6c..36dc4a417 100644\n--- a/doc/guides/freebsd_gsg/install_from_ports.rst\n+++ b/doc/guides/freebsd_gsg/install_from_ports.rst\n@@ -7,29 +7,31 @@ Installing DPDK from the Ports Collection\n =========================================\n \n The easiest way to get up and running with the DPDK on FreeBSD is to\n-install it from the ports collection. Details of getting and using the ports\n-collection are documented in the\n-`FreeBSD Handbook <http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/index.html>`_.\n+install it using the FreeBSD `pkg` utility or from the ports collection.\n+Details of installing applications from packages or the ports collection are documented in the\n+`FreeBSD Handbook <http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/index.html>`_,\n+chapter `Installing Applications: Packages and Ports <https://www.freebsd.org/doc/handbook/ports.html>`_.\n \n-Installing the DPDK FreeBSD Port\n---------------------------------\n+.. note::\n \n-On a system with the ports collection installed in ``/usr/ports``, the DPDK\n-can be installed using the commands:\n+ Please ensure that the latest patches are applied to third party libraries\n+ and software to avoid any known vulnerabilities.\n \n-.. code-block:: console\n \n- cd /usr/ports/net/dpdk\n+Installing the DPDK Package for FreeBSD\n+---------------------------------------\n \n- make install\n+DPDK can be installed on FreeBSD using the command::\n+\n+\tpkg install dpdk\n \n-After the installation of the DPDK port, instructions will be printed on\n+After the installation of the DPDK package, instructions will be printed on\n how to install the kernel modules required to use the DPDK. A more\n complete version of these instructions can be found in the sections\n :ref:`loading_contigmem` and :ref:`loading_nic_uio`. Normally, lines like\n those below would be added to the file ``/boot/loader.conf``.\n \n-.. code-block:: console\n+.. code-block:: shell\n \n # Reserve 2 x 1G blocks of contiguous memory using contigmem driver:\n hw.contigmem.num_buffers=2\n@@ -40,24 +42,32 @@ those below would be added to the file ``/boot/loader.conf``.\n hw.nic_uio.bdfs=\"2:0:0,2:0:1\"\n nic_uio_load=\"YES\"\n \n-.. note::\n \n- Please ensure that the latest patches are applied to third party libraries\n- and software to avoid any known vulnerabilities.\n+Installing the DPDK FreeBSD Port\n+--------------------------------\n+\n+If so desired, the user can install DPDK using the ports collection rather than from\n+a pre-compiled binary package.\n+On a system with the ports collection installed in ``/usr/ports``, the DPDK\n+can be installed using the commands::\n+\n+ cd /usr/ports/net/dpdk\n+\n+ make install\n \n \n Compiling and Running the Example Applications\n ----------------------------------------------\n \n When the DPDK has been installed from the ports collection it installs\n-its example applications in ``/usr/local/share/dpdk/examples`` - also accessible via\n-symlink as ``/usr/local/share/examples/dpdk``. These examples can be compiled and\n-run as described in :ref:`compiling_sample_apps`. In this case, the required\n-environmental variables should be set as below:\n+its example applications in ``/usr/local/share/dpdk/examples``.\n+These examples can be compiled and run as described in :ref:`compiling_sample_apps`.\n \n-* ``RTE_SDK=/usr/local/share/dpdk``\n+.. note::\n \n-* ``RTE_TARGET=x86_64-native-freebsd-clang``\n+ DPDK example applications must be complied using `gmake` rather than\n+ BSD `make`. To detect the installed DPDK libraries, `pkg-config` should\n+ also be installed on the system.\n \n .. note::\n \n@@ -66,25 +76,18 @@ environmental variables should be set as below:\n the instructions given in the next chapter, :ref:`building_from_source`\n \n An example application can therefore be copied to a user's home directory and\n-compiled and run as below:\n-\n-.. code-block:: console\n-\n- export RTE_SDK=/usr/local/share/dpdk\n-\n- export RTE_TARGET=x86_64-native-freebsd-clang\n+compiled and run as below, where we have 2 memory blocks of size 1G reserved\n+via the contigmem module, and 4 NIC ports bound to the nic_uio module::\n \n cp -r /usr/local/share/dpdk/examples/helloworld .\n \n cd helloworld/\n \n gmake\n- CC main.o\n- LD helloworld\n- INSTALL-APP helloworld\n- INSTALL-MAP helloworld.map\n+ cc -O3 -I/usr/local/include -include rte_config.h -march=corei7 -D__BSD_VISIBLE main.c -o build/helloworld-shared -L/usr/local/lib -lrte_bpf -lrte_flow_classify -lrte_pipeline -lrte_table -lrte_port -lrte_fib -lrte_ipsec -lrte_stack -lrte_security -lrte_sched -lrte_reorder -lrte_rib -lrte_rcu -lrte_rawdev -lrte_pdump -lrte_member -lrte_lpm -lrte_latencystats -lrte_jobstats -lrte_ip_frag -lrte_gso -lrte_gro -lrte_eventdev -lrte_efd -lrte_distributor -lrte_cryptodev -lrte_compressdev -lrte_cfgfile -lrte_bitratestats -lrte_bbdev -lrte_acl -lrte_timer -lrte_hash -lrte_metrics -lrte_cmdline -lrte_pci -lrte_ethdev -lrte_meter -lrte_net -lrte_mbuf -lrte_mempool -lrte_ring -lrte_eal -lrte_kvargs\n+ ln -sf helloworld-shared build/helloworld\n \n- sudo ./build//helloworld -l 0-3\n+ sudo ./build/helloworld -l 0-3\n EAL: Sysctl reports 8 cpus\n EAL: Detected 8 lcore(s)\n EAL: Detected 1 NUMA nodes\n@@ -98,16 +101,12 @@ compiled and run as below:\n EAL: 0000:00:19.0 not managed by UIO driver, skipping\n EAL: PCI device 0000:01:00.0 on NUMA socket 0\n EAL: probe driver: 8086:1572 net_i40e\n- EAL: 0000:01:00.0 not managed by UIO driver, skipping\n EAL: PCI device 0000:01:00.1 on NUMA socket 0\n EAL: probe driver: 8086:1572 net_i40e\n- EAL: 0000:01:00.1 not managed by UIO driver, skipping\n EAL: PCI device 0000:01:00.2 on NUMA socket 0\n EAL: probe driver: 8086:1572 net_i40e\n- EAL: 0000:01:00.2 not managed by UIO driver, skipping\n EAL: PCI device 0000:01:00.3 on NUMA socket 0\n EAL: probe driver: 8086:1572 net_i40e\n- EAL: 0000:01:00.3 not managed by UIO driver, skipping\n hello from core 1\n hello from core 2\n hello from core 3\n", "prefixes": [ "2/5" ] }