From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 6DD744262C; Mon, 25 Sep 2023 13:52:38 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 532A740DCB; Mon, 25 Sep 2023 13:52:38 +0200 (CEST) Received: from NAM10-DM6-obe.outbound.protection.outlook.com (mail-dm6nam10on2077.outbound.protection.outlook.com [40.107.93.77]) by mails.dpdk.org (Postfix) with ESMTP id 43FA3402DE for ; Mon, 25 Sep 2023 13:52:36 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=YexrClZ7V3a3cS/1rWVKRwmO5kP/JsMW7U5wURoxxhoFqkCGN61PruWFvKAkuMDTOREBna+bCEfLEFU4pRsph+lZRJ/g87amomOSZGEc8woKs9Kl9EbfFreyOAm2NRlu4lGdLxpafVH6t2FH/LGxgJN/v3KOS82gdGoHtKkr4IDHtkHd46NgsMwzbMoBPsOLHOa2qZnSdsxjj+ZGfDMaYjPajIMz6WA9J4IvsEwcQkuRNZc+uBDazo6+HLpQLcHHPfATuH52oM9oxdK6ONCbhNEFV32MxZ79EtCO55U0SdooRMd0YI8hwRL/WpKG/P6vI+o0yaizfHlNRHlREp6hFQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=AxDGKN7DCPnrpmIXgTl3s+vO6tEQAks8snyMQLNyhTE=; b=k4P3RlyLspj5+G8en/e6mnmoI6T+czwiaxj06dhT4QYE2ez3QD6LN9jLY/A39wV2tcNuuKkRCCQ+/vDcj3c2nWuSdX1VwP4KPeQixauz9ZZhp/G++MtscV+H3rFE+qepgCUIjlDsTnpRHpQx8uhcNTSu5QIlrQIc5suV0gbGk7wSkRZ9DjMQv1tGqBMhfeItyi2CyR6rEGgTGepdE4yxYDNyP8QpcmPB6EV20OvTpq2LHCEJfNq6PEQsfDnLaFoRDNLjoKfpZCNyQM63Z99gAWivaMIoe5on7PbIHTlvNMjDN5On/eDSmUvBDZ+hQSfP8awZxNYQw7icSXZlojztqw== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=amd.com; dmarc=pass action=none header.from=amd.com; dkim=pass header.d=amd.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=amd.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=AxDGKN7DCPnrpmIXgTl3s+vO6tEQAks8snyMQLNyhTE=; b=jInR6FdBDoWOG1jtXalDo20si4RRvzA9ht5Y7Lytl8DZEk/re25+8b1fD7z2QtGbhVq5doz5bowS4YGALDHDMwym6zRy6QVlab7kV1aTy6LNsAOy+sTfsUuxnrhpC4LS2AlIJC6AQSKX69PQgxvR8coPz9dwFFEF3L5nEZUMClk= Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=amd.com; Received: from CH2PR12MB4294.namprd12.prod.outlook.com (2603:10b6:610:a9::11) by MW4PR12MB7288.namprd12.prod.outlook.com (2603:10b6:303:223::15) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6813.28; Mon, 25 Sep 2023 11:52:30 +0000 Received: from CH2PR12MB4294.namprd12.prod.outlook.com ([fe80::102f:c69b:d3e5:7fe8]) by CH2PR12MB4294.namprd12.prod.outlook.com ([fe80::102f:c69b:d3e5:7fe8%4]) with mapi id 15.20.6813.027; Mon, 25 Sep 2023 11:52:30 +0000 Message-ID: <2b3818ff-5ce0-4b41-a35e-d0ed3db8e7f8@amd.com> Date: Mon, 25 Sep 2023 12:52:25 +0100 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH 5/6] Section 5: Appendix Content-Language: en-US From: Ferruh Yigit To: David Young , dev@dpdk.org Cc: Bruce Richardson References: <20230920154817.617-1-dave@youngcopy.com> <20230920154817.617-6-dave@youngcopy.com> <2d67e056-8020-4153-9494-08c264496254@amd.com> Autocrypt: addr=ferruh.yigit@amd.com; keydata= xsFNBGJDD3EBEAC/M7Tk/DfQSmP1K96vyzdhfSBzlCaGtcxNXorq4fALruqVsD3oi0yfyEz9 4YN8x7py0o9EL8ZdpOX0skc0AMCDAaw033uWhCn0GLMeGRKUbfOAPvL6ecSDvGD7CJIO9j0J eZUvasBgPdM/435PEr9DmC6Ggzdzt8IuG4PoLi5jpFSfcqxZFCCxLUDEo/w0nuguk2FTuYJg B2zEZ4JTBZrw7hIHiFh8D8hr6YA6a5uTofq1tr+l048lbtdFUl8TR0aIExVzE4Z8qKZlcE+9 RQaewjK5Al1jLE4sHdmd3GN+IvgDF3D/fLsi25SKJDeGSdeHkOmaX0qGeM4WKIfU6iARRCiQ N3AmBIxZ/A7UXBKLaOyZ+/i3sE6Wb53nrO4i8+0K2Qwyh6LjTeiJAIjYKN43ppxz3DaI+QwQ vI+uyHr4Gg0Da9EPPz/YyKauSeOZCfCB5gIfICO0j6x0SCl8uQ2nLpjxcZkf0gjcwUzP3h+S 3x6NfDji9YEij0zczW/dcSpGgZ6vsFpPrtnP9ZXy6J53yp0kJtOJoOlkEFFdU2yCZnCDseum CoudmGLZVvS0/DzHDJejq+3kK3FDGktZBOxZIIpal+nFqS7lVgOZc4+huVv3jyhzoAUOEyXA XK5j6o7g8STUY+z33QNnHpdLvecMwuzmvqy0jR54yAbZ64mB9QARAQABzSNGZXJydWggWWln aXQgPGZlcnJ1aC55aWdpdEBhbWQuY29tPsLBlwQTAQgAQQIbAwULCQgHAgYVCgkICwIEFgID AQIeAQIXgAIZARYhBEm7aYjps5XGsPHCElRTPtCKKm/6BQJjb9DJBQkC+3/YAAoJEFRTPtCK Km/6d94P/irGq3mPa7LamXMIioQ8i6ppMSjpr8g+SxH9RnzbmoUjUY6hVzCpXYxEejiJHubg 7lwD+bOocYpiU8Pe0UncVBhIPNk/dIWQAyH0IWK1nd+hOnjxHv3AQpP80Be2o1mUn3oq/b+B QYiyvvre2gIugYq0hzLcG7z4zREeT+Nl0DMDfnLx+Tj2FAOHrOfudUqjdr/VjF5PoTK0bxnb Brqulp0I0ft7hNsufhzf+TlqaB5l0eQO4gDo5xGTP97TT1cGYsXVMsyDhHqW6P3cuj8kkLkO Ch4oq8OLL8GElgRy5y5svU6CJu3f8hT9aiqIoaRpfNv6N8iEk6g4/HNN+uydb9YCA+1pbwBx skmDhtxQrmXpI+Fmfq0aX2NmqHcy6JR8Ekm/nfwLAW/aDpwoMImVN5pPXtOBSjYi4pj7hiJk UA0ZFi8HCW+fic85p8MXn1GPDmbO82Mm3JVJ1uJNAzGsBbW5SP1ol6+XTeaSxcmzFlrDs8vL XQJMRTpcG6Pti7GbbsOtldvmxRQpq9PmCgQg9IrPXpMoaKE3WwtiSiCALs0kYj4F+hhgAfjI RsOuaAJTnKYW31pC/QdroMNAEqIpLveql03jj+xD9ntJIVAsXiCitsLIXzKP0L5tcHkoVLC3 NAjVYq6XkAEssPF4mMRLoEwpvxOytHe1BCJoRl0YA0aQzsFNBGJDD3EBEAC8fBFQHej8qgIG CBzoIEd1cZgPIARlIhRudODXoNDbwA+zJMKtOVwol3Hh1qJ2/yZP11nZsqrP4fyUvMxrwhDe WBWFVDbWHLnqXMnKuUU1vQMujbzgq/4Rb9wSMW5vBL6YxhZng+h71JgS/9nVtzyaTtsOTrJi 6nzFSDx6Wbza2jYvL9rlK0yxJcMEiKwZQ/if4KcOesD0rtxomU/iSEv6DATcJbGXP6T93nPl 90XksijRKAmOwvdu3A8IIlxiSSVRP0lxiHOeR35y6PjHY2usfEDZZOVOfDfhlCVAIBZUZALv VmFOVSTYXeKgYa6Ooaf72+cHM3SgJIbYnevJfFv8YQW0MEAJ/IXE7B1Lk+pHNxwU3VBCrKnA fd/PTvviesuYRkrRD6qqZnINeu3b2DouVGGt2fVcGA38BujCd3p8i7azoGc7A6cgF7z9ETnr ANrbg1/dJyDmkDxOxVrVquTBbxJbDy2HaIe9wyJTEK2Sznpy62DaHVY+gfDQzexBXM10geHC IIUhEnOUYVaq65X3ZDjyAQnNDBQ4uMqSHZk8DpJ22X+T+IMzWzWl+VyU4UZXjkLKPvlqPjJk 1RbKScek5L2GhxHQbPaD76Hx4Jiel0vm2G+4wei8Ay1+0YRFkhySxogU/uQVXHTv63KzQMak oIfnN/V2R0ucarsvMBW+gwARAQABwsF8BBgBCAAmAhsMFiEESbtpiOmzlcaw8cISVFM+0Ioq b/oFAmNv0PAFCQL7f/8ACgkQVFM+0Ioqb/oU9hAAisAJJ09j/kiEeA1HGKUg3DyFnYW22zRL z1IHYmcHQanMx4+FAwsb1bonVldQMIYNJ9z69UNIU16zIqLZt3D5QK7Je5F5q4NZgfP2jtjX rc3jyu0PuDerFZQyxNcYhhmlF9JO9NV976WYbBAM3AAr0TDohUk+YicYTKab+ZHYOABXbqHX qi+bzDCH1vKBDfpJviprthhK1tIABUK5lsp9aFwFU2jfu2J3XX3pwQhPMjtn2C4v37XUnOqM SJPr2HLU27IW5I3BBpJn7dZE/BkmDmnceHF8E4tRlXCQ/cf81+eErL832sfhVJo1MpubKh3B j89ZLmw0cDXZP2hqlC9vdXnoWWHI8PDPkiw9z11yLrT9Wd4cTJTjFV49Z9G96rgnOtWDcZ1J xHBAnXYQ7V2k9abY+ZqY1PtAPr/smqzQfPHXyTAhRVZp2f3yQmj7UqB07FJuLQjJ4CGk97Qx ///qeSg7D8x/sGEA8Yp2jgIj6u7tspuz+RgBYrWpfI0VIHhWED0jNXzqztrVX18CzA6r0ReY SG+CSyycKkco6UI9ZeUrXFwnoUJqIJY9wTJo5gD9EgGIbItv3qWTq29dihLYpzd6dqB708k7 4RBz9051oLaFVGkguFw/tXmA17nx+c2uR5jx8wb4j68umG2X++0dSta5eHAVhmtXvrqPW6Ku 3FQ= In-Reply-To: <2d67e056-8020-4153-9494-08c264496254@amd.com> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-ClientProxiedBy: LO2P265CA0421.GBRP265.PROD.OUTLOOK.COM (2603:10a6:600:a0::25) To CH2PR12MB4294.namprd12.prod.outlook.com (2603:10b6:610:a9::11) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: CH2PR12MB4294:EE_|MW4PR12MB7288:EE_ X-MS-Office365-Filtering-Correlation-Id: 1e901945-6034-429a-184d-08dbbdbde597 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: WFhnFIdU6V1WNK/YpINJtfxDDOYM6+GHOZ1zVwKqyFVWOiVdZOI4Wbv1iKNv8mhgxUhTav0qQX7OYFBpTMwNd8YmIXtLNgh38BUOWPvVQKQR+bJZiCTsRLt8+u5XjZ5FZ6JoiAEI0LXPV0r8BaFgpVm12hT3thVAU1WZxGvg1qlujSjF19oE5Qll4gGyvVtieWdF0b+AU2pDayd/agdQmlvOktvuwheoD7sqUEbx15eZQEaoOZ7LlJD1PMH5R4soa9vgQMe3Xwfa1IbAJQlW2yngxWRNWZFBLdl19Jlc62VrwKX2qGBw6M356xaRagiR0p/lsFE+WVic3+uZh/StmULj5vd/4xO7/wzfhCLn8B82ue74hfykGWQB4/gZmQiD+S9wZ4cGvF4uAP1kvUu4urxsFaDKhfr+DVuKH+Wzp0WYIq54RdQJkQc7ifaP7wdcknARokZmib0hAg8bCtMQmrUronbjrBYewBkMv1rzXa2B5DG6wmbnC9czVgUjwWV2G3otkvgUw3+XtoMHAGAA1rE3AvgYbkKX9jbYEzwt6eu2VU4fo0+scofc8l+2tJjauzHXKVan26Imzyv3BELnXssgThiGF+1+wCpv8exQVuWxbiXn5n0kaNMjdZMLfEwoAmfkzh3cQ1i5LjSEOcHW5w== X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:CH2PR12MB4294.namprd12.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230031)(366004)(39860400002)(396003)(376002)(346002)(136003)(230922051799003)(1800799009)(186009)(451199024)(2906002)(478600001)(6486002)(36756003)(6666004)(26005)(86362001)(38100700002)(83380400001)(53546011)(6506007)(2616005)(31696002)(6512007)(8936002)(41300700001)(8676002)(4326008)(316002)(5660300002)(44832011)(31686004)(66946007)(66556008)(66476007)(45980500001)(43740500002); DIR:OUT; SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?MGRGc1htNzJRR1NZbU5rTHR3Q3BxSjkyMXZ4SldKTk11Z0R4OWlwT0IxUEo5?= =?utf-8?B?bXhUbnJiMUpMWmZKbHNJWmdhSTJJRDcwSGd0Y3F2Q2JFbkxpQzAydFNqeVJa?= =?utf-8?B?UC9BcHJjWnJLdEpQU2RLOEhDd2RmUzIyR2ZCUlJBR1lWelZuYXBXSW1QTTNL?= =?utf-8?B?NkZqRm5VWTJKcXlMSDNTYjdzLzFYMUdnMjVJMVFpZVdtQ21tMHFMd0FQUGR4?= =?utf-8?B?Z1k3N1JsL0ViMm5pWjZEU3p1eWtaNmpjRDN0T1NnU2xJTCtjRGpJcmJsNXY1?= =?utf-8?B?YWdiV0JaYnJ6UXNjNWsrSTBmZERWSHJNaHAwQXFaL2JRb2g0T2JGM3JMUXJh?= =?utf-8?B?SzIvTjI0TEVEbDdzR0FXNzFKMytqTHdHNXNqamFGZlJxV1lxLzBSc002SHhE?= =?utf-8?B?MHZxUkJPRmt6Z3BxYkNUMmFtdGQyL284SUVwNE9qbWJDWnhtTjF5WlFtWjZ0?= =?utf-8?B?eHIvakxWMjZCdDd6M0pxbEpTcGx2VlQzUGExWVdEQmdkcDdUdE5aOGdqT0Fi?= =?utf-8?B?UG9UZ1pBb0NiUXg2QnJUY0ZWM3J3NTQvbDlZMWdacWVycDBKYnZjdnBkSjZF?= =?utf-8?B?TFRvc2F1T1NLeWhOV3FLUVluOWhQMVE4MnAxN3VJTFJZOUhKM0dwNEJzUk9C?= =?utf-8?B?dFZ3d2FpNDYzNE1rVGlwb0d6QVlRc2d1SHlGSjVFTnIxaUUrWmxHOXVqT0pv?= =?utf-8?B?R1hVaTN2WTVLK3RKbzNxVlRNVUJURDczUityTzd1aFVvOFBkeTVzQWp1ZWdB?= =?utf-8?B?V0R0L3RoUC84TERkWEM0L3BWaWxiRVhINlIzWUMydWhmdXBsanBPVFFxT3Y0?= =?utf-8?B?bnFqZ01BQmRQWlFxWktCdUVwMmYya3U1OXQ3NERVclNoRUtNbmVINlc0OENh?= =?utf-8?B?RUE1aFlQTEJRdjhKR3VFOUROSGdoNUJad0NiSkVJS3hONlFrQjB4endGVjNJ?= =?utf-8?B?YzgrMVUvRVYybklhczc2YzQrVTBWYm9reTZRcWMzS1VKdlRKRXJzU0U4T1ho?= =?utf-8?B?SUtjb051MkhobWpCRElKcDRBK1dITm41RkVkWU9DSkI0K3pYMWlQZXl5cTg1?= =?utf-8?B?aW9COEdsZVBiMXVpdnRndkZZVktaWXZJeklrSE8yZ0xPTnNUMVdxWlEvZ2NB?= =?utf-8?B?aXlHVExvaktCZFpKcFJDUWtuSTNhNDd0MmFoTU5HMzVsaWNBaFcrUWUzdHN4?= =?utf-8?B?OVp4YVVEbHZ3a25DOXdBdlhYUW16K1VnSXNYVHk0K2N1Ym5jTDA1ZVljd25n?= =?utf-8?B?SWZzaUFlTDdtNXhMcnRrSUMvVFE1RW5JTVNyUExvVG5DK0dHeG5ycDZJcVBE?= =?utf-8?B?cmJkMnFLV3E2TldHdWo4aW1xREpoTDlaNTJOckxYcUJnemdkTHpBSE4rZ0Ni?= =?utf-8?B?NXZEM2IvRVNRWXBmTFl5WnNhSEd1cjh5bnF1OHcrVjJnM21ndzVucXZXaU9Z?= =?utf-8?B?SGUvY2lTZFVGNTRhMk5mbFdiaktreDBaZGhkM2ZQSHZVVGtuZTdZTGt0S25q?= =?utf-8?B?Q3VwYWRWb0FFS3phS0w4Z2VDckdUU2tubW5sbE5kWFRPRVdoaDlaaHJQZmg1?= =?utf-8?B?Wk54Z01UV1YxaHhrMjlLVzdEWmRLOXNJQlVHTEpBQXJlaDZkQUlBVVhGWCs4?= =?utf-8?B?OU9QSVd2cHVQeGhhai9nR0puRmM4aWw3Qk5wdTFkU2pjN095QXU3VnRhT2RD?= =?utf-8?B?TXhpUExVQUg1ejdEalpKTlpNWHRwb3lIQTBUaTN0ZitMR1poWTVsMjhKcnZV?= =?utf-8?B?VmQ4ZlAyendHQkRlMlZxWkhTUmJIYXRrM29TU1JkVVR2VXRneUlRMU1QWWdq?= =?utf-8?B?Si9Zc1Q4UmRUczUzSE1jREVqZW5Pbk1QbGFHUTFGK2NIOURPbjZSZlNMQnJY?= =?utf-8?B?ODBoREo5d1lKQ1JEQi93YlBLUUpqQjIwNXdFT2tlTXVyLzQ4WkJQa2NyVmJi?= =?utf-8?B?ekIwRnBwS3pOcTFTNUliOFNRZVVoTmlPNWlmWmlVVFVHaTd4a00welp3b3hz?= =?utf-8?B?Y0duZDBEZ3BISXJPTmhQd0VReW5kSitrTGpUeUsvMEhoRmowLzhCVE0yTmtx?= =?utf-8?B?QlNheDlQT3BBWUsrMFJacjJpYUVOYXJJTFZjcnV5ei9DQ0RiTDNsRkZYeEpV?= =?utf-8?Q?N7FviZRceMqMnJxHKZnleu1+F?= X-OriginatorOrg: amd.com X-MS-Exchange-CrossTenant-Network-Message-Id: 1e901945-6034-429a-184d-08dbbdbde597 X-MS-Exchange-CrossTenant-AuthSource: CH2PR12MB4294.namprd12.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 25 Sep 2023 11:52:30.2520 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d X-MS-Exchange-CrossTenant-MailboxType: HOSTED X-MS-Exchange-CrossTenant-UserPrincipalName: 1f5mufq/GdAeLdReC0xvrcRnsALG9+MKbmrDUybV3O7QgkXcgyRXoaM/34V6dfoS X-MS-Exchange-Transport-CrossTenantHeadersStamped: MW4PR12MB7288 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org On 9/25/2023 12:33 PM, Ferruh Yigit wrote: > On 9/20/2023 4:48 PM, David Young wrote: >> --- >> .../appendix/cross_compile_dpdk.rst | 37 +++ >> .../appendix/dpdk_meson_build_options.rst | 57 ++++ >> .../getting_started_guide/appendix/index.rst | 17 + >> .../running_dpdk_apps_without_root.rst | 36 +++ >> .../appendix/vfio_advanced.rst | 295 ++++++++++++++++++ >> 5 files changed, 442 insertions(+) >> create mode 100644 doc/guides/getting_started_guide/appendix/cross_compile_dpdk.rst >> create mode 100644 doc/guides/getting_started_guide/appendix/dpdk_meson_build_options.rst >> create mode 100644 doc/guides/getting_started_guide/appendix/index.rst >> create mode 100644 doc/guides/getting_started_guide/appendix/running_dpdk_apps_without_root.rst >> create mode 100644 doc/guides/getting_started_guide/appendix/vfio_advanced.rst >> > > These files are put under 'appendix' folder, > and I can see these documents are linked from other 'getting started > guide' documentations, which I assume the reason to put these under > 'appendix' folder. > But these are not limited to getting started, perhaps we can do a better > organization of them out of getting started appendix. > > > >> diff --git a/doc/guides/getting_started_guide/appendix/cross_compile_dpdk.rst b/doc/guides/getting_started_guide/appendix/cross_compile_dpdk.rst >> new file mode 100644 >> index 0000000000..3e4efe23a4 >> --- /dev/null >> +++ b/doc/guides/getting_started_guide/appendix/cross_compile_dpdk.rst >> @@ -0,0 +1,37 @@ >> +.. SPDX-License-Identifier: BSD-3-Clause >> + Copyright(c) 2010-2025 Intel Corporation. >> + >> +.. _cross_compile_dpdk: >> + >> +Cross-compiling DPDK for Different Architectures on Linux >> +========================================================= >> + >> +Cross-compiling DPDK for different architectures follows a similar process. Here are the general steps: >> + >> +1. **Get Compiler and Libraries**: Obtain the cross-compiler toolchain and any required libraries specific to the target architecture. >> + >> +2. **Build Using Cross-File**: Use Meson to set up the build with a cross-file specific to the target architecture, and then build with Ninja. >> + >> +Prerequisites >> +------------- >> + >> +- NUMA Library (if required) >> +- Meson and Ninja >> +- pkg-config for the target architecture >> +- Specific GNU or LLVM/Clang toolchain for the target architecture >> + >> +Cross-Compiling DPDK >> +-------------------- >> + >> +1. **Set Up the Cross Toolchain**: Download and extract the toolchain for the target architecture. Add it to the PATH. >> + >> +2. **Compile Any Required Libraries**: Compile libraries like NUMA if required. >> + >> +3. **Cross-Compile DPDK with Meson**: >> + >> + .. code-block:: bash >> + >> + meson setup cross-build --cross-file >> + ninja -C cross-build >> + >> +Refer to the specific sections for ARM64, LoongArch, and RISC-V for detailed instructions and architecture-specific considerations. Mentioned sections are not in this document, so can be good to provide link for them. >> \ No newline at end of file >> diff --git a/doc/guides/getting_started_guide/appendix/dpdk_meson_build_options.rst b/doc/guides/getting_started_guide/appendix/dpdk_meson_build_options.rst >> new file mode 100644 >> index 0000000000..6669f98371 >> --- /dev/null >> +++ b/doc/guides/getting_started_guide/appendix/dpdk_meson_build_options.rst >> @@ -0,0 +1,57 @@ >> +.. SPDX-License-Identifier: BSD-3-Clause >> + Copyright(c) 2010-2025 Intel Corporation. >> + >> +.. _dpdk_meson_build_options: >> + >> +DPDK Meson Build Configuration Options >> +====================================== >> + >> +DPDK provides a number of build configuration options that can be adjusted using the Meson build system. These options can be listed by running ``meson configure`` inside a configured build >> +folder. >> + >> +Changing the Build Type >> +----------------------- >> + >> +To change the build type from the default "release" to a regular "debug" build, >> +you can either: >> + >> +- Pass ``-Dbuildtype=debug`` or ``--buildtype=debug`` to meson when configuring the build folder initially. >> +- Run ``meson configure -Dbuildtype=debug`` inside the build folder after the initial meson run. >> + >> +Platform Options >> +---------------- >> + >> +The "platform" option specifies a set of configuration parameters that will be used. >> +The valid values are: >> + >> +- ``-Dplatform=native`` will tailor the configuration to the build machine. >> +- ``-Dplatform=generic`` will use configuration that works on all machines of the same architecture as the build machine. >> +- ``-Dplatform=`` will use configuration optimized for a particular SoC. >> + >> +Consult the "socs" dictionary in ``config/arm/meson.build`` to see which SoCs are supported. >> + >> +Overriding Platform Parameters >> +------------------------------ >> + >> +The values determined by the platform parameter may be overwritten. For example, >> +to set the ``max_lcores`` value to 256, you can either: >> + >> +- Pass ``-Dmax_lcores=256`` to meson when configuring the build folder initially. >> +- Run ``meson configure -Dmax_lcores=256`` inside the build folder after the initial meson run. >> + >> +Building Sample Applications >> +---------------------------- >> + >> +Some of the DPDK sample applications in the examples directory can be automatically built as >> +part of a meson build. To do so, pass a comma-separated list of the examples to build to the >> +``-Dexamples`` meson option as below:: >> + >> + meson setup -Dexamples=l2fwd,l3fwd build >> + >> +There is also a special value "all" to request that all example applications whose dependencies >> +are met on the current system are built. When ``-Dexamples=all`` is set as a meson option, >> +meson will check each example application to see if it can be built, and add all which can be >> +built to the list of tasks in the ninja build configuration file. >> + >> +For a complete list of options, run ``meson configure`` inside your configured build >> +folder. >> \ No newline at end of file >> diff --git a/doc/guides/getting_started_guide/appendix/index.rst b/doc/guides/getting_started_guide/appendix/index.rst >> new file mode 100644 >> index 0000000000..23bb1fcf78 >> --- /dev/null >> +++ b/doc/guides/getting_started_guide/appendix/index.rst >> @@ -0,0 +1,17 @@ >> +.. SPDX-License-Identifier: BSD-3-Clause >> + Copyright(c) 2010-2025 Intel Corporation. >> + >> +.. _appendix: >> + >> +Appendix >> +======== >> + >> +This section covers specific guides related to DPDK. >> + >> +.. toctree:: >> + :maxdepth: 2 >> + >> + dpdk_meson_build_options >> + running_dpdk_apps_without_root >> + vfio_advanced >> + cross_compile_dpdk >> \ No newline at end of file >> diff --git a/doc/guides/getting_started_guide/appendix/running_dpdk_apps_without_root.rst b/doc/guides/getting_started_guide/appendix/running_dpdk_apps_without_root.rst >> new file mode 100644 >> index 0000000000..9f214bbdc8 >> --- /dev/null >> +++ b/doc/guides/getting_started_guide/appendix/running_dpdk_apps_without_root.rst >> @@ -0,0 +1,36 @@ >> +.. SPDX-License-Identifier: BSD-3-Clause >> + Copyright(c) 2010-2025 Intel Corporation. >> + >> +.. _running_dpdk_apps_without_root: >> + >> +Running DPDK Applications Without Root Privileges >> +================================================= >> + >> +Although applications using the DPDK use network ports and other hardware resources >> +directly, with a number of small permission adjustments, >> +it is possible to run these applications as a user other than “root”. >> +To do so, the ownership, or permissions, on the following file system objects should be >> +adjusted so the user account being used to run the DPDK application has >> +access to them: >> + >> +Linux >> +----- >> + >> +1. **Create a DPDK User Group**: Create a new user group for DPDK and add the desired user to this group. >> + >> +2. **Set Up Hugepages**: Configure hugepages for the user. >> + >> +3. **Bind the NIC to a User-Space Driver**: Use the DPDK tool ``dpdk-devbind.py`` to bind the NIC to a user-space driver like ``vfio-pci`` or ``igb_uio``. >> + >> +4. **Set Permissions for UIO/VFIO Devices**: Change the ownership and permissions of the UIO or VFIO devices to allow access by the DPDK user group. >> + >> +5. **Run the DPDK Application**: Run the desired DPDK application as the user who has been added to the DPDK group. >> + >> > > I think we need a sample commands, additional to description, on how to > run an application as a non-priviledged user. > > >> +FreeBSD >> +------- >> + >> +- The userspace-io device files in ``/dev``, for example, ``/dev/uio0``, ``/dev/uio1``, and so on >> +- The userspace contiguous memory device: ``/dev/contigmem`` >> + >> + >> +Refer to the `DPDK Release Notes `_ for supported applications. >> > > Applications that run without root privileges? Do we have that kind of > list in release notes? > > > >> \ No newline at end of file >> diff --git a/doc/guides/getting_started_guide/appendix/vfio_advanced.rst b/doc/guides/getting_started_guide/appendix/vfio_advanced.rst >> new file mode 100644 >> index 0000000000..1cdb138eb7 >> --- /dev/null >> +++ b/doc/guides/getting_started_guide/appendix/vfio_advanced.rst >> @@ -0,0 +1,295 @@ >> +.. SPDX-License-Identifier: BSD-3-Clause >> + Copyright(c) 2010-2025 Intel Corporation. >> + >> +.. _vfio_advanced: >> + >> +.. |reg| unicode:: U+000AE >> + >> +VFIO Advanced >> +============= >> + >> + >> +.. contents:: Table of Contents >> + :local: >> + >> +.. _vfio_no_iommu_mode: >> + >> +VFIO no-IOMMU mode >> +------------------ >> + > > I guess this is the only documentation specific to "VFIO", (and title is > VFIO advanced), I think it can be better to start with describing VFIO, > instead of starting with no-iommu mode. > >