From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from NAM01-BN3-obe.outbound.protection.outlook.com (mail-eopbgr740117.outbound.protection.outlook.com [40.107.74.117]) by dpdk.org (Postfix) with ESMTP id 643A71B39F for ; Tue, 26 Mar 2019 17:33:45 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=Hns34J52TTSBfdcCq/6pYl/ubdSYvxfZk7megZalNxE=; b=Q1JjKCXhWoEHPC/P49bdXP8SXUtyFvvucia/rP3RRffto0ndlKWB0D18bOD//ciO4JxBpftY8likVBdHj7eNaEaYgaTu2u4F8/hYntsERth9DwemZRDayXUs2mD4qerJLEfTwxWRWheloYxO++Lnbus3k0OLkBmXKBLFJsC6SgE= Received: from MWHPR21MB0638.namprd21.prod.outlook.com (10.175.141.139) by MWHPR21MB0767.namprd21.prod.outlook.com (10.173.51.21) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.20.1750.3; Tue, 26 Mar 2019 16:33:43 +0000 Received: from MWHPR21MB0638.namprd21.prod.outlook.com ([fe80::c4e7:ece1:887e:b983]) by MWHPR21MB0638.namprd21.prod.outlook.com ([fe80::c4e7:ece1:887e:b983%3]) with mapi id 15.20.1771.002; Tue, 26 Mar 2019 16:33:43 +0000 From: Harini Ramakrishnan To: Anand Rawat , "dev@dpdk.org" CC: "pallavi.kadam@intel.com" , "ranjit.menon@intel.com" , "jeffrey.b.shaw@intel.com" , "bruce.richardson@intel.com" , "thomas@monjalon.net" Thread-Topic: [dpdk-dev] [PATCH v5 7/8] doc: add documention for windows Thread-Index: AQHU45mx2LsEHyMjik61m6B9lqAbcqYeG/qw Date: Tue, 26 Mar 2019 16:33:43 +0000 Message-ID: References: <20190306041634.12976-1-anand.rawat@intel.com> <20190326060238.9884-1-anand.rawat@intel.com> <20190326060238.9884-8-anand.rawat@intel.com> In-Reply-To: <20190326060238.9884-8-anand.rawat@intel.com> Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: msip_labels: MSIP_Label_f42aa342-8706-4288-bd11-ebb85995028c_Enabled=True; MSIP_Label_f42aa342-8706-4288-bd11-ebb85995028c_SiteId=72f988bf-86f1-41af-91ab-2d7cd011db47; MSIP_Label_f42aa342-8706-4288-bd11-ebb85995028c_Owner=haramakr@microsoft.com; MSIP_Label_f42aa342-8706-4288-bd11-ebb85995028c_SetDate=2019-03-26T16:33:41.0853016Z; MSIP_Label_f42aa342-8706-4288-bd11-ebb85995028c_Name=General; MSIP_Label_f42aa342-8706-4288-bd11-ebb85995028c_Application=Microsoft Azure Information Protection; MSIP_Label_f42aa342-8706-4288-bd11-ebb85995028c_ActionId=20f4d916-b89d-4404-8e46-3804c293f7c5; MSIP_Label_f42aa342-8706-4288-bd11-ebb85995028c_Extended_MSFT_Method=Automatic x-originating-ip: [131.107.147.44] x-ms-publictraffictype: Email x-ms-office365-filtering-correlation-id: 089a364a-6edc-42e8-ec70-08d6b208d005 x-ms-office365-filtering-ht: Tenant x-microsoft-antispam: BCL:0; PCL:0; RULEID:(2390118)(7020095)(4652040)(8989299)(4534185)(4627221)(201703031133081)(201702281549075)(8990200)(5600127)(711020)(4605104)(4618075)(2017052603328)(7193020); SRVR:MWHPR21MB0767; x-ms-traffictypediagnostic: MWHPR21MB0767: x-ms-exchange-purlcount: 6 x-microsoft-antispam-prvs: x-ms-oob-tlc-oobclassifiers: OLM:7691; x-forefront-prvs: 09888BC01D x-forefront-antispam-report: SFV:NSPM; SFS:(10019020)(39860400002)(396003)(346002)(376002)(136003)(366004)(199004)(189003)(13464003)(174874002)(10090500001)(476003)(106356001)(68736007)(8676002)(4326008)(81156014)(81166006)(6116002)(71190400001)(2501003)(11346002)(8990500004)(25786009)(256004)(105586002)(10290500003)(14444005)(2906002)(55016002)(86362001)(3846002)(6346003)(66066001)(186003)(486006)(446003)(478600001)(52536014)(6246003)(14454004)(110136005)(99286004)(316002)(33656002)(22452003)(71200400001)(7696005)(102836004)(74316002)(53936002)(86612001)(26005)(72206003)(7736002)(6306002)(305945005)(229853002)(9686003)(8936002)(54906003)(6436002)(97736004)(5660300002)(76176011)(53546011)(6506007)(460985005); DIR:OUT; SFP:1102; SCL:1; SRVR:MWHPR21MB0767; H:MWHPR21MB0638.namprd21.prod.outlook.com; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; A:1; MX:1; received-spf: None (protection.outlook.com: microsoft.com does not designate permitted sender hosts) authentication-results: spf=none (sender IP is ) smtp.mailfrom=Harini.Ramakrishnan@microsoft.com; x-ms-exchange-senderadcheck: 1 x-microsoft-antispam-message-info: t5Vm8DO8qKqboO6aXXbXR6X7j4u0Ou5lZCxK3+HojUTtuOA4alwxa8Qkw8k4wDrxDAKAymQhlkqclwVtSgsv0ecPYnrRVLPfLdkQ/AUSHwiEhgS2nzdAD/V64CyGgOHao0kp1kLGU0Nw8b2MZBQS/cKHBBDplwOqxC/k3bgNa5nWBb2NmKm77YKzAjfhQiNONWt1cVI1TsfiWc8q1lfNmdL9o7r2ZtCezgevmrfxZ+VNBTmRxa4bJBpm+xPVF2Zmgk7EocqCj5dDehkaM9CK5yCrk5IZrYCaRyPWBPKAh7hFnjTgB62dJ+7gnWNpajnAgeC8g/8eSrRSQdZ0THKnS0h+dieqx8z6FvHMK71sISBU3PllmEZ00KaG8amho7Ki9E+MRwlWPDcU8zvsMXI/lxAorsXLEyiKKWDsXGZB7bU= Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-OriginatorOrg: microsoft.com X-MS-Exchange-CrossTenant-Network-Message-Id: 089a364a-6edc-42e8-ec70-08d6b208d005 X-MS-Exchange-CrossTenant-originalarrivaltime: 26 Mar 2019 16:33:43.7784 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 72f988bf-86f1-41af-91ab-2d7cd011db47 X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-Transport-CrossTenantHeadersStamped: MWHPR21MB0767 Subject: Re: [dpdk-dev] [PATCH v5 7/8] doc: add documention for windows 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: Tue, 26 Mar 2019 16:33:45 -0000 -----Original Message----- From: dev On Behalf Of Anand Rawat Sent: Monday, March 25, 2019 11:03 PM To: dev@dpdk.org Cc: anand.rawat@intel.com; pallavi.kadam@intel.com; ranjit.menon@intel.com;= jeffrey.b.shaw@intel.com; bruce.richardson@intel.com; thomas@monjalon.net Subject: [dpdk-dev] [PATCH v5 7/8] doc: add documention for windows Added documentation to build helloworld example on windows using meson and = clang. Updated the maintainers list to include windows maintainers. Signed-off-by: Pallavi Kadam Signed-off-by: Anand Rawat Reviewed-by: Jeff Shaw Reviewed-by: Ranjit Menon Acked-by: Harini Ramakrishnan --- MAINTAINERS | 7 +++ doc/guides/index.rst | 3 +- doc/guides/windows_gsg/build_dpdk.rst | 73 +++++++++++++++++++++++++++ doc/guides/windows_gsg/index.rst | 14 +++++ doc/guides/windows_gsg/intro.rst | 20 ++++++++ 5 files changed, 116 insertions(+), 1 deletion(-) create mode 100644 doc/= guides/windows_gsg/build_dpdk.rst create mode 100644 doc/guides/windows_gsg/index.rst create mode 100644 do= c/guides/windows_gsg/intro.rst diff --git a/MAINTAINERS b/MAINTAINERS index 452b8eb82..0080c8f4c 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -272,6 +272,13 @@ FreeBSD UIO M: Bruce Richardson F: kernel/freebsd/nic_uio/ =20 +Windows support +M: Harini Ramakrishnan +M: Omar Cardona +M: Anand Rawat +M: Ranjit Menon +F: lib/librte_eal/windows/ + =20 Core Libraries -------------- diff --git a/doc/guides/index.rst b/doc/guides/index.rst index 8a9ed65c8..8= a1601b27 100644 --- a/doc/guides/index.rst +++ b/doc/guides/index.rst @@ -1,5 +1,5 @@ .. SPDX-License-Identifier: BSD-3-Clause - Copyright(c) 2010-2014 Intel Corporation. + Copyright(c) 2010-2019 Intel Corporation. =20 DPDK documentation =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D @@ -9,6 +9,7 @@ DPDK documentation =20 linux_gsg/index freebsd_gsg/index + windows_gsg/index sample_app_ug/index prog_guide/index howto/index diff --git a/doc/guides/windows_gsg/build_dpdk.rst b/doc/guides/windows_gsg= /build_dpdk.rst new file mode 100644 index 000000000..b88eb76c9 --- /dev/null +++ b/doc/guides/windows_gsg/build_dpdk.rst @@ -0,0 +1,73 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2019 Intel Corporation. + +Compiling the DPDK Target from Source +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +System Requirements +------------------- + +The DPDK and its applications require the Clang-LLVM* C compiler and MSVC*= linker. +The Meson* Build system is used to prepare the sources for compilation wit= h the Ninja backend. + +\*Other names and brands may be claimed as the property of others. + +Install the Compiler +-------------------- + +Download and install the clang compiler from `LLVM* website `_. +For example, Clang-LLVM direct download link:: + +=09 +https://nam06.safelinks.protection.outlook.com/?url=3Dhttp%3A%2F%2Freleas +es.llvm.org%2F7.0.1%2FLLVM-7.0.1-win64.exe&data=3D02%7C01%7CHarini.Ra +makrishnan%40microsoft.com%7Cc15cbeeecc1444e67dd508d6b1b0d207%7C72f988b +f86f141af91ab2d7cd011db47%7C1%7C0%7C636891770331298978&sdata=3DJYeD4D +hXDwjW7dIpJYGCNHFPbTKkKXY6IAzXtdI5%2BTk%3D&reserved=3D0 + + +Install the Linker +------------------ + +Download and install the Build Tools for Visual Studio to link and build t= he files on windows, from `Microsoft* website `_. +When installing build tools, select the "Visual C++ build tools" option an= d ensure the Windows SDK is selected. + + +Install the Build System +------------------------ + +Download and install the build system from `Meson* website `_. +A good option to choose is the MSI installer for both meson and ninja toge= ther:: + +=09 +https://nam06.safelinks.protection.outlook.com/?url=3Dhttp%3A%2F%2Fmesonb +uild.com%2FGetting-meson.html%23installing-meson-and-ninja-with-the-msi +-installer%2522&data=3D02%7C01%7CHarini.Ramakrishnan%40microsoft.com% +7Cc15cbeeecc1444e67dd508d6b1b0d207%7C72f988bf86f141af91ab2d7cd011db47%7 +C1%7C0%7C636891770331298978&sdata=3DCsFkIeLQM9XK4P1lWAAdo%2FeSXDP7WDe +5BCdmhb8CMfA%3D&reserved=3D0 + +Install the Backend +------------------- + +If using Ninja, download and install the backend from `Ninja* website=20 +`_ or install along with the meson build system. + +Build the code +-------------- + +The build environment is setup to build the EAL and the helloworld=20 +example by default. + +Using the ninja backend +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + cd C:\Users\me\dpdk + meson build + cd build + ninja + +Run the helloworld example +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D + +Navigate to the build directory and run `dpdk-helloworld.exe`. + +.. code-block:: console + + cd C:\Users\me\dpdk\build + helloworld.exe + hello from core 1 + hello from core 3 + hello from core 0 + hello from core 2 diff --git a/doc/guides/windows_gsg/index.rst b/doc/guides/windows_gsg/inde= x.rst new file mode 100644 index 000000000..d9b7990a8 --- /dev/null +++ b/doc/guides/windows_gsg/index.rst @@ -0,0 +1,14 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2019 Intel Corporation. + +.. _windows_gsg: + +Getting Started Guide for Windows +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D + +.. toctree:: + :maxdepth: 2 + :numbered: + + intro + build_dpdk diff --git a/doc/guides/windows_gsg/intro.rst b/doc/guides/windows_gsg/intr= o.rst new file mode 100644 index 000000000..a0285732d --- /dev/null +++ b/doc/guides/windows_gsg/intro.rst @@ -0,0 +1,20 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2019 Intel Corporation. + +Introduction +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +This document contains instructions for installing and configuring the=20 +Data Plane Development Kit (DPDK) software. The document describes how=20 +to compile and run a DPDK application in a Windows* OS application=20 +environment, without going deeply into detail. + +\*Other names and brands may be claimed as the property of others. + +Limitations +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +DPDK for Windows is currently a work in progress. Not all DPDK source=20 +files compile. Support is being added in pieces so as to limit the=20 +overall scope of any individual patch series. The goal is to be able to=20 +run any DPDK application natively on Windows. -- 2.17.1.windows.2 From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by dpdk.space (Postfix) with ESMTP id 4BFA2A05D3 for ; Tue, 26 Mar 2019 17:33:47 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 12D5D1B3E8; Tue, 26 Mar 2019 17:33:47 +0100 (CET) Received: from NAM01-BN3-obe.outbound.protection.outlook.com (mail-eopbgr740117.outbound.protection.outlook.com [40.107.74.117]) by dpdk.org (Postfix) with ESMTP id 643A71B39F for ; Tue, 26 Mar 2019 17:33:45 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=Hns34J52TTSBfdcCq/6pYl/ubdSYvxfZk7megZalNxE=; b=Q1JjKCXhWoEHPC/P49bdXP8SXUtyFvvucia/rP3RRffto0ndlKWB0D18bOD//ciO4JxBpftY8likVBdHj7eNaEaYgaTu2u4F8/hYntsERth9DwemZRDayXUs2mD4qerJLEfTwxWRWheloYxO++Lnbus3k0OLkBmXKBLFJsC6SgE= Received: from MWHPR21MB0638.namprd21.prod.outlook.com (10.175.141.139) by MWHPR21MB0767.namprd21.prod.outlook.com (10.173.51.21) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.20.1750.3; Tue, 26 Mar 2019 16:33:43 +0000 Received: from MWHPR21MB0638.namprd21.prod.outlook.com ([fe80::c4e7:ece1:887e:b983]) by MWHPR21MB0638.namprd21.prod.outlook.com ([fe80::c4e7:ece1:887e:b983%3]) with mapi id 15.20.1771.002; Tue, 26 Mar 2019 16:33:43 +0000 From: Harini Ramakrishnan To: Anand Rawat , "dev@dpdk.org" CC: "pallavi.kadam@intel.com" , "ranjit.menon@intel.com" , "jeffrey.b.shaw@intel.com" , "bruce.richardson@intel.com" , "thomas@monjalon.net" Thread-Topic: [dpdk-dev] [PATCH v5 7/8] doc: add documention for windows Thread-Index: AQHU45mx2LsEHyMjik61m6B9lqAbcqYeG/qw Date: Tue, 26 Mar 2019 16:33:43 +0000 Message-ID: References: <20190306041634.12976-1-anand.rawat@intel.com> <20190326060238.9884-1-anand.rawat@intel.com> <20190326060238.9884-8-anand.rawat@intel.com> In-Reply-To: <20190326060238.9884-8-anand.rawat@intel.com> Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: msip_labels: MSIP_Label_f42aa342-8706-4288-bd11-ebb85995028c_Enabled=True; MSIP_Label_f42aa342-8706-4288-bd11-ebb85995028c_SiteId=72f988bf-86f1-41af-91ab-2d7cd011db47; MSIP_Label_f42aa342-8706-4288-bd11-ebb85995028c_Owner=haramakr@microsoft.com; MSIP_Label_f42aa342-8706-4288-bd11-ebb85995028c_SetDate=2019-03-26T16:33:41.0853016Z; MSIP_Label_f42aa342-8706-4288-bd11-ebb85995028c_Name=General; MSIP_Label_f42aa342-8706-4288-bd11-ebb85995028c_Application=Microsoft Azure Information Protection; MSIP_Label_f42aa342-8706-4288-bd11-ebb85995028c_ActionId=20f4d916-b89d-4404-8e46-3804c293f7c5; MSIP_Label_f42aa342-8706-4288-bd11-ebb85995028c_Extended_MSFT_Method=Automatic x-originating-ip: [131.107.147.44] x-ms-publictraffictype: Email x-ms-office365-filtering-correlation-id: 089a364a-6edc-42e8-ec70-08d6b208d005 x-ms-office365-filtering-ht: Tenant x-microsoft-antispam: BCL:0; PCL:0; RULEID:(2390118)(7020095)(4652040)(8989299)(4534185)(4627221)(201703031133081)(201702281549075)(8990200)(5600127)(711020)(4605104)(4618075)(2017052603328)(7193020); SRVR:MWHPR21MB0767; x-ms-traffictypediagnostic: MWHPR21MB0767: x-ms-exchange-purlcount: 6 x-microsoft-antispam-prvs: x-ms-oob-tlc-oobclassifiers: OLM:7691; x-forefront-prvs: 09888BC01D x-forefront-antispam-report: SFV:NSPM; SFS:(10019020)(39860400002)(396003)(346002)(376002)(136003)(366004)(199004)(189003)(13464003)(174874002)(10090500001)(476003)(106356001)(68736007)(8676002)(4326008)(81156014)(81166006)(6116002)(71190400001)(2501003)(11346002)(8990500004)(25786009)(256004)(105586002)(10290500003)(14444005)(2906002)(55016002)(86362001)(3846002)(6346003)(66066001)(186003)(486006)(446003)(478600001)(52536014)(6246003)(14454004)(110136005)(99286004)(316002)(33656002)(22452003)(71200400001)(7696005)(102836004)(74316002)(53936002)(86612001)(26005)(72206003)(7736002)(6306002)(305945005)(229853002)(9686003)(8936002)(54906003)(6436002)(97736004)(5660300002)(76176011)(53546011)(6506007)(460985005); DIR:OUT; SFP:1102; SCL:1; SRVR:MWHPR21MB0767; H:MWHPR21MB0638.namprd21.prod.outlook.com; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; A:1; MX:1; received-spf: None (protection.outlook.com: microsoft.com does not designate permitted sender hosts) authentication-results: spf=none (sender IP is ) smtp.mailfrom=Harini.Ramakrishnan@microsoft.com; x-ms-exchange-senderadcheck: 1 x-microsoft-antispam-message-info: t5Vm8DO8qKqboO6aXXbXR6X7j4u0Ou5lZCxK3+HojUTtuOA4alwxa8Qkw8k4wDrxDAKAymQhlkqclwVtSgsv0ecPYnrRVLPfLdkQ/AUSHwiEhgS2nzdAD/V64CyGgOHao0kp1kLGU0Nw8b2MZBQS/cKHBBDplwOqxC/k3bgNa5nWBb2NmKm77YKzAjfhQiNONWt1cVI1TsfiWc8q1lfNmdL9o7r2ZtCezgevmrfxZ+VNBTmRxa4bJBpm+xPVF2Zmgk7EocqCj5dDehkaM9CK5yCrk5IZrYCaRyPWBPKAh7hFnjTgB62dJ+7gnWNpajnAgeC8g/8eSrRSQdZ0THKnS0h+dieqx8z6FvHMK71sISBU3PllmEZ00KaG8amho7Ki9E+MRwlWPDcU8zvsMXI/lxAorsXLEyiKKWDsXGZB7bU= Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-OriginatorOrg: microsoft.com X-MS-Exchange-CrossTenant-Network-Message-Id: 089a364a-6edc-42e8-ec70-08d6b208d005 X-MS-Exchange-CrossTenant-originalarrivaltime: 26 Mar 2019 16:33:43.7784 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 72f988bf-86f1-41af-91ab-2d7cd011db47 X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-Transport-CrossTenantHeadersStamped: MWHPR21MB0767 Subject: Re: [dpdk-dev] [PATCH v5 7/8] doc: add documention for windows 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: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Message-ID: <20190326163343.1xUaZ2S4RiC7elumrT_eDwVdkrGfoCBX7sf9Ks5eIeA@z> -----Original Message----- From: dev On Behalf Of Anand Rawat Sent: Monday, March 25, 2019 11:03 PM To: dev@dpdk.org Cc: anand.rawat@intel.com; pallavi.kadam@intel.com; ranjit.menon@intel.com;= jeffrey.b.shaw@intel.com; bruce.richardson@intel.com; thomas@monjalon.net Subject: [dpdk-dev] [PATCH v5 7/8] doc: add documention for windows Added documentation to build helloworld example on windows using meson and = clang. Updated the maintainers list to include windows maintainers. Signed-off-by: Pallavi Kadam Signed-off-by: Anand Rawat Reviewed-by: Jeff Shaw Reviewed-by: Ranjit Menon Acked-by: Harini Ramakrishnan --- MAINTAINERS | 7 +++ doc/guides/index.rst | 3 +- doc/guides/windows_gsg/build_dpdk.rst | 73 +++++++++++++++++++++++++++ doc/guides/windows_gsg/index.rst | 14 +++++ doc/guides/windows_gsg/intro.rst | 20 ++++++++ 5 files changed, 116 insertions(+), 1 deletion(-) create mode 100644 doc/= guides/windows_gsg/build_dpdk.rst create mode 100644 doc/guides/windows_gsg/index.rst create mode 100644 do= c/guides/windows_gsg/intro.rst diff --git a/MAINTAINERS b/MAINTAINERS index 452b8eb82..0080c8f4c 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -272,6 +272,13 @@ FreeBSD UIO M: Bruce Richardson F: kernel/freebsd/nic_uio/ =20 +Windows support +M: Harini Ramakrishnan +M: Omar Cardona +M: Anand Rawat +M: Ranjit Menon +F: lib/librte_eal/windows/ + =20 Core Libraries -------------- diff --git a/doc/guides/index.rst b/doc/guides/index.rst index 8a9ed65c8..8= a1601b27 100644 --- a/doc/guides/index.rst +++ b/doc/guides/index.rst @@ -1,5 +1,5 @@ .. SPDX-License-Identifier: BSD-3-Clause - Copyright(c) 2010-2014 Intel Corporation. + Copyright(c) 2010-2019 Intel Corporation. =20 DPDK documentation =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D @@ -9,6 +9,7 @@ DPDK documentation =20 linux_gsg/index freebsd_gsg/index + windows_gsg/index sample_app_ug/index prog_guide/index howto/index diff --git a/doc/guides/windows_gsg/build_dpdk.rst b/doc/guides/windows_gsg= /build_dpdk.rst new file mode 100644 index 000000000..b88eb76c9 --- /dev/null +++ b/doc/guides/windows_gsg/build_dpdk.rst @@ -0,0 +1,73 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2019 Intel Corporation. + +Compiling the DPDK Target from Source +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +System Requirements +------------------- + +The DPDK and its applications require the Clang-LLVM* C compiler and MSVC*= linker. +The Meson* Build system is used to prepare the sources for compilation wit= h the Ninja backend. + +\*Other names and brands may be claimed as the property of others. + +Install the Compiler +-------------------- + +Download and install the clang compiler from `LLVM* website `_. +For example, Clang-LLVM direct download link:: + +=09 +https://nam06.safelinks.protection.outlook.com/?url=3Dhttp%3A%2F%2Freleas +es.llvm.org%2F7.0.1%2FLLVM-7.0.1-win64.exe&data=3D02%7C01%7CHarini.Ra +makrishnan%40microsoft.com%7Cc15cbeeecc1444e67dd508d6b1b0d207%7C72f988b +f86f141af91ab2d7cd011db47%7C1%7C0%7C636891770331298978&sdata=3DJYeD4D +hXDwjW7dIpJYGCNHFPbTKkKXY6IAzXtdI5%2BTk%3D&reserved=3D0 + + +Install the Linker +------------------ + +Download and install the Build Tools for Visual Studio to link and build t= he files on windows, from `Microsoft* website `_. +When installing build tools, select the "Visual C++ build tools" option an= d ensure the Windows SDK is selected. + + +Install the Build System +------------------------ + +Download and install the build system from `Meson* website `_. +A good option to choose is the MSI installer for both meson and ninja toge= ther:: + +=09 +https://nam06.safelinks.protection.outlook.com/?url=3Dhttp%3A%2F%2Fmesonb +uild.com%2FGetting-meson.html%23installing-meson-and-ninja-with-the-msi +-installer%2522&data=3D02%7C01%7CHarini.Ramakrishnan%40microsoft.com% +7Cc15cbeeecc1444e67dd508d6b1b0d207%7C72f988bf86f141af91ab2d7cd011db47%7 +C1%7C0%7C636891770331298978&sdata=3DCsFkIeLQM9XK4P1lWAAdo%2FeSXDP7WDe +5BCdmhb8CMfA%3D&reserved=3D0 + +Install the Backend +------------------- + +If using Ninja, download and install the backend from `Ninja* website=20 +`_ or install along with the meson build system. + +Build the code +-------------- + +The build environment is setup to build the EAL and the helloworld=20 +example by default. + +Using the ninja backend +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + cd C:\Users\me\dpdk + meson build + cd build + ninja + +Run the helloworld example +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D + +Navigate to the build directory and run `dpdk-helloworld.exe`. + +.. code-block:: console + + cd C:\Users\me\dpdk\build + helloworld.exe + hello from core 1 + hello from core 3 + hello from core 0 + hello from core 2 diff --git a/doc/guides/windows_gsg/index.rst b/doc/guides/windows_gsg/inde= x.rst new file mode 100644 index 000000000..d9b7990a8 --- /dev/null +++ b/doc/guides/windows_gsg/index.rst @@ -0,0 +1,14 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2019 Intel Corporation. + +.. _windows_gsg: + +Getting Started Guide for Windows +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D + +.. toctree:: + :maxdepth: 2 + :numbered: + + intro + build_dpdk diff --git a/doc/guides/windows_gsg/intro.rst b/doc/guides/windows_gsg/intr= o.rst new file mode 100644 index 000000000..a0285732d --- /dev/null +++ b/doc/guides/windows_gsg/intro.rst @@ -0,0 +1,20 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2019 Intel Corporation. + +Introduction +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +This document contains instructions for installing and configuring the=20 +Data Plane Development Kit (DPDK) software. The document describes how=20 +to compile and run a DPDK application in a Windows* OS application=20 +environment, without going deeply into detail. + +\*Other names and brands may be claimed as the property of others. + +Limitations +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +DPDK for Windows is currently a work in progress. Not all DPDK source=20 +files compile. Support is being added in pieces so as to limit the=20 +overall scope of any individual patch series. The goal is to be able to=20 +run any DPDK application natively on Windows. -- 2.17.1.windows.2