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 E6F5BA0679 for ; Thu, 28 Mar 2019 20:31:44 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id AC94F3572; Thu, 28 Mar 2019 20:31:44 +0100 (CET) Received: from NAM03-BY2-obe.outbound.protection.outlook.com (mail-eopbgr780100.outbound.protection.outlook.com [40.107.78.100]) by dpdk.org (Postfix) with ESMTP id 762E73572 for ; Thu, 28 Mar 2019 20:31:43 +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=MODSvDLPXtFUqa9MhLgQi7UHj/We0hzKcuAg0HhgLcE=; b=CA3IDKjQ5Wafyk9/AbHU2/eAZ2gLFfnSX7hDiAC/+duYFFTq9DKkrWZSSbS4ILOXW+CJpurLNYq6OjJDvx79LhEtl6JCIiXzfWKkbaSVgm/AWUFlc/bpReklyKvaQ+u+75ehEP0xs5ffJ67NXV5ozVU1fSmm0ulFxsI6ENt+xkc= ARC-Seal: i=1; a=rsa-sha256; s=testarcselector01; d=microsoft.com; cv=none; b=s5tN0QOnUskFXk+Oo+RH5UrNYaNSKAVqX2qud5c3J+x9spbBzCEdRQXZlgwNO3S560MHSASPt4P6Mb28CxNIOjuBF3HWApkkB9hqis7jsKreACT+dC93UOsjAfdVX7sLK5A7LiexudMeuSzuoA6P0DaDUMjsjMqyChZCuBaBcAE= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=testarcselector01; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=MODSvDLPXtFUqa9MhLgQi7UHj/We0hzKcuAg0HhgLcE=; b=oAHlzu3CFeIA/MW2MAFqZ5lZgFnRkUlMUlNbMe2QWfDOWh2Vqvr+JJKpKp6g40PNYVOtYje/Nt8XbJXwJjiDFTTmOOPlTGMtHIhGklGMqzUEbLjy8z0QY+KEtfrZ9KFaqtf+VxZ7Y1lztJs3ilHvdBalhqghrINFYUwsLb0GJj8= ARC-Authentication-Results: =?us-ascii?Q?i=3D1; _test.office365.com_1; =0D=0A=09=09dmarc=3Dnone_action?= =?us-ascii?Q?=3Dnone_header.from=3Dmicrosoft.com;=0D=0A=09=09arc=3Dnone?= Received: from MWHPR21MB0638.namprd21.prod.outlook.com (10.175.141.139) by MWHPR21MB0175.namprd21.prod.outlook.com (10.173.52.21) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.1771.3; Thu, 28 Mar 2019 19:31:36 +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; Thu, 28 Mar 2019 19:31:35 +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 v6 7/8] doc: add documentation for windows Thread-Index: AQHU5Q0aFc6QVaDQqE+KPAiTDELJYaYhb3EQ Date: Thu, 28 Mar 2019 19:31:35 +0000 Message-ID: References: <20190306041634.12976-1-anand.rawat@intel.com> <20190328022115.4660-1-anand.rawat@intel.com> <20190328022115.4660-8-anand.rawat@intel.com> In-Reply-To: <20190328022115.4660-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-28T19:31:33.3216080Z; 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=e03d74e3-e430-4c07-a034-c6b99270633e; MSIP_Label_f42aa342-8706-4288-bd11-ebb85995028c_Extended_MSFT_Method=Automatic x-originating-ip: [2001:4898:80e8:a:84e2:1334:627:d48e] x-ms-publictraffictype: Email x-ms-office365-filtering-correlation-id: ab800e88-61af-45c3-c7c5-08d6b3b3fd88 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:MWHPR21MB0175; x-ms-traffictypediagnostic: MWHPR21MB0175: x-ms-exchange-purlcount: 6 x-microsoft-antispam-prvs: x-ms-oob-tlc-oobclassifiers: OLM:7691; x-forefront-prvs: 0990C54589 x-forefront-antispam-report: SFV:NSPM; SFS:(10019020)(366004)(376002)(396003)(346002)(39860400002)(136003)(13464003)(189003)(174874002)(199004)(6506007)(54906003)(33656002)(478600001)(229853002)(76176011)(6116002)(99286004)(9686003)(14454004)(2501003)(52536014)(6346003)(2906002)(46003)(7696005)(7736002)(10290500003)(6436002)(305945005)(97736004)(74316002)(102836004)(81156014)(5660300002)(71190400001)(446003)(105586002)(71200400001)(53546011)(68736007)(72206003)(256004)(6246003)(186003)(106356001)(25786009)(6306002)(86362001)(486006)(55016002)(8936002)(53936002)(11346002)(86612001)(476003)(8676002)(110136005)(4326008)(22452003)(8990500004)(81166006)(14444005)(10090500001)(316002)(460985005); DIR:OUT; SFP:1102; SCL:1; SRVR:MWHPR21MB0175; H:MWHPR21MB0638.namprd21.prod.outlook.com; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; MX:1; A: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: lTjfuNiVzOkNsVez41+ODeBrCyaP9Qww5Pr+cEBTDYFX2AA3oq6OI159Oi93pQBE8gLKZgg/3hgKBas05npaC8QJOBlOILh/ckfIhKzcG4p17yu4+ccU+JhL2XDR0NZFTIygLcYdi6DH8dUqaDOfRUGIRUS/dXYLIiQ1JiSWtJFEPpZ2ssxol9X7TEdBCX2ChU7AYn0zoXSI7gv4QJTannncEjToU2MtWkyABPOboYjZnO4LReiT2xxDKjVsPFzcJ0J98AiQOG+JpFYUM3iQA+PBzK4i4XTzwYvTU8E61yEl/L8MSGJRuR0LMiYH9RZ0yAco2OiDLtrMbol8j0GB3Ibpzk4Np4qK02X5FhLhS7aAV5crL1z5jJCur0nh4bAFJwDqkCBhzpERsKGH4potrYpxCEqdaaLpmS7mLp1VP0k= 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: ab800e88-61af-45c3-c7c5-08d6b3b3fd88 X-MS-Exchange-CrossTenant-originalarrivaltime: 28 Mar 2019 19:31:35.2860 (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: MWHPR21MB0175 Subject: Re: [dpdk-dev] [PATCH v6 7/8] doc: add documentation 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: <20190328193135.kyWMHApoY_WqUH4oDPrQYkDL5JlB9jR4YeRBSJWoxdU@z> Acked-by: Harini Ramakrishnan -----Original Message----- From: dev On Behalf Of Anand Rawat Sent: Wednesday, March 27, 2019 7:21 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 v6 7/8] doc: add documentation 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 --- 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 21e164095..d64d7ceb8 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -278,6 +278,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%7Ce4ffece3a667422d599008d6b3243c0a%7C72f988b +f86f141af91ab2d7cd011db47%7C1%7C0%7C636893365548294922&sdata=3D5v%2Bd +Ne6R%2Fx%2FvDjPvTZdTnwb4ic6aHpyU%2Fg4404wfa3M%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% +7Ce4ffece3a667422d599008d6b3243c0a%7C72f988bf86f141af91ab2d7cd011db47%7 +C1%7C0%7C636893365548294922&sdata=3Ds%2Bth54SiyuA74wD7YQdPVjD3q92HJZS +DO7SbOPJX4ow%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