From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from na01-obe.outbound.protection.outlook.com (na01-obe.outbound.protection.outlook.com [40.93.13.10]) by mx.groups.io with SMTP id smtpd.web09.31824.1637979642402940886 for ; Fri, 26 Nov 2021 18:20:43 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@microsoft.com header.s=selector2 header.b=DG7UR2Mi; spf=pass (domain: microsoft.com, ip: 40.93.13.10, mailfrom: bret.barkelew@microsoft.com) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=nob3Yzzy7QTdJw65VjFJrxY4df+rSeCynFHeLA0Q0FGUS1hDw5glwOduufv85lICCIS6SG7zPHS4b3m7NUC78u5alXVseDmcgBJN1C5PpcZfulb48vCxGC0TM1+gDiItBV7W7cc5d3QaSvetyqJfaykn7mDrC5Q3oS8QWzZyV6DfgvzT+ap+IxtPkp7RHKn1aiUvQEn8B6j3KIujsv3dvvTY/Dx8sZKYo9jVIGZXNLTjHwBpC/GiAE+vH3SdBG9eaz0nuD/BTR0wxLL/HUh3jIiLWb+003VJlqEr3s8e1SDT4ZxNGyanLuG7ytqRSymcmvHuYznDDZEonFwyxi004A== 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=S2Mdt7ZahufjlMYIwj51GK2oUBk0UPRR0jZyNFjzgA4=; b=KpCzb4zxVmyhYn7K0yNMDlg6HI2wa/w6o7K9gmn2IYZ5b+ldQsXD945NLkpA7dnUnegcnWukANhiArtNiFnJcHS15I8t4pd9smYrq4yHnpxz+KjLw9B32ITwC0+mXz0juhlWe8J9v2+IXHIww3lyhn3865mC+hhIEalkizqWyKppC4iik4aVqaLg+bGX5Pr/maOR7I9OH0WMrGqGlNMwCSwDVjuXHm/YQR1j3tuJ0ZxtuCiceQoDoZ/ij9il8pVSJ0+P6Z+r0ei27DosStmbLvtbTnsngCyqG7r4eRLk/0B7BosztBhEp4QprqfMFRyvwx99LBMSlnzcme/XI9WtLA== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=microsoft.com; dmarc=pass action=none header.from=microsoft.com; dkim=pass header.d=microsoft.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=selector2; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=S2Mdt7ZahufjlMYIwj51GK2oUBk0UPRR0jZyNFjzgA4=; b=DG7UR2MixKwnWtfbDuLlLlRjrWADxH5Zln9Jh/xckIKxEeBB26NqHuT6jbK6ge7esmJ7tuBP93cZNebhO6MREmBzEXKYw3H6oO1FehVOnvQoLe2OwFAMoNK2/kj+1+IYaxnx3q9vMflqtr9jDSDrhpfq/7u8OGlA/bXbgi9OHXU= Received: from MW4PR21MB1907.namprd21.prod.outlook.com (2603:10b6:303:71::8) by MW2PR2101MB1852.namprd21.prod.outlook.com (2603:10b6:302:2::13) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4755.9; Sat, 27 Nov 2021 02:20:35 +0000 Received: from MW4PR21MB1907.namprd21.prod.outlook.com ([fe80::f1d8:9f56:5807:dee0]) by MW4PR21MB1907.namprd21.prod.outlook.com ([fe80::f1d8:9f56:5807:dee0%5]) with mapi id 15.20.4755.009; Sat, 27 Nov 2021 02:20:35 +0000 From: "Bret Barkelew" To: "mikuback@linux.microsoft.com" , "devel@edk2.groups.io" CC: "Kinney, Michael D" , Liming Gao , Sean Brogan Subject: Re: [PATCH v5 1/1] .pytool/Plugin/UncrustifyCheck: Add Uncrustify CI plugin Thread-Topic: [PATCH v5 1/1] .pytool/Plugin/UncrustifyCheck: Add Uncrustify CI plugin Thread-Index: AQHX4Za8WotCYXxWlkqM56DKLrzGIqwWp3/j Date: Sat, 27 Nov 2021 02:20:35 +0000 Message-ID: References: <20211125005207.2814-1-mikuback@linux.microsoft.com> In-Reply-To: <20211125005207.2814-1-mikuback@linux.microsoft.com> Accept-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_SetDate=2021-11-27T02:20:25.5173523Z;MSIP_Label_f42aa342-8706-4288-bd11-ebb85995028c_ContentBits=0;MSIP_Label_f42aa342-8706-4288-bd11-ebb85995028c_Method=Standard authentication-results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=microsoft.com; x-ms-publictraffictype: Email x-ms-office365-filtering-correlation-id: 0ec2f7ca-f35c-486e-3e5c-08d9b14c7f06 x-ms-traffictypediagnostic: MW2PR2101MB1852: x-ld-processed: 72f988bf-86f1-41af-91ab-2d7cd011db47,ExtAddr x-microsoft-antispam-prvs: x-ms-oob-tlc-oobclassifiers: OLM:10000; x-ms-exchange-senderadcheck: 1 x-ms-exchange-antispam-relay: 0 x-microsoft-antispam: BCL:0; x-microsoft-antispam-message-info: 1C8d3SNsxO9pLIqCj2zVWqE7Q8mj72G928eWZitglN9n8t/4iP9YMoPtBUq9r0ctt96ZaQbAzAd63vDJxT7GhUTcQCB074YvsFeZo43KyN0cX7RhPBczhaI5HSbKdzqSM1IovVyNpsfPgf77uWuC/BpCXiT967Ou66DZQEsx2hwfZe5vwGDFJDfbMCtUrGjN1V40tYbIVtgxw8gYJmpdCwahSDzy9m39o0QMPmh2r8fTC8VXfSGgv7GgE0IRmX8HAaJIlsdKQofq62ZnmiGZH82PTEwjY1g90ynZh0XcLbIpggfxP1hW56mXeWIpXgC9+IXrhDnxqZBpEt088rzTaOTq4IfvBW5Tq9eK9lZRXxTQjVrg4W/3DSYYHGx0clePRsB8pYfGKcSioFpccg03jLHhLAaAxj8NZWxmora2sZosDxXlhSmPIwWXX765N6/FyvlzzNnKw2MWvMXfFmvvsLnbPnIK/FBsXhPalTh5DP2oq20X/d3zL6h5lzxzfymoG2jsxPVJWDgjuXm7XCT3DjtjDMhWSAwmdb2DNh0vJUOjG7+6x3USxA8ekydsqXei6v07Wn7Z3+4C6XXIbrW/ooEdSU7Vy9qcmnwjUcoPCd5aSolRCGAU0AdJx522H/2j3NmIRIuiAvEnunY77vNUgXVYzIQBZeBSdh3tE/JITaZ31S8GedGy+MOMJ+cvK+fY5jRW+LSRvLgwuvI390zBjaf60yfSr7qzQhtoOZyWhK/t2sBj9MkBcs+2EDXTp7XOawGwNxwWlOp4CvsgE7dlBtxO2VP7cr5X/aI60j5HRUq0496/buAm5T+G6RnKC5IZH2rTtmO7OeMcgziqbHL4xKQ8zuVd0Hbh86ba8uKwUjwxbUNEEZ+BCGglPEtp7hb4 x-forefront-antispam-report: CIP:255.255.255.255;CTRY:;LANG:en;SCL:1;SRV:;IPV:NLI;SFV:NSPM;H:MW4PR21MB1907.namprd21.prod.outlook.com;PTR:;CAT:NONE;SFS:(13230001)(4636009)(366004)(33656002)(66946007)(107886003)(76116006)(110136005)(54906003)(8676002)(8936002)(6506007)(52536014)(186003)(26005)(83380400001)(7696005)(53546011)(71200400001)(10290500003)(316002)(64756008)(9686003)(66446008)(66556008)(66476007)(966005)(508600001)(2906002)(82950400001)(82960400001)(38100700002)(4326008)(5660300002)(30864003)(55016003)(86362001)(122000001)(166002)(8990500004)(38070700005)(559001)(579004)(20210929001);DIR:OUT;SFP:1102; x-ms-exchange-antispam-messagedata-chunkcount: 1 x-ms-exchange-antispam-messagedata-0: =?us-ascii?Q?TkAqxwBNXUkAE+u2HkwDk/LXcyDFMWATPp9ouLBUs9eHp0HOteAamRBHWxx+?= =?us-ascii?Q?y1+Gxedb4Ozux6f9FOlIv4wod+sMFC92yLxmv65t34p306QFIvfhSLuHG42G?= =?us-ascii?Q?yRgV36M+KKrLaw9NpzZZE9vFiynH5kMoZVsmOFCxo7J1SiKR7Fd4WGr9YSJI?= =?us-ascii?Q?vCMpyLr4Y67eHSgs9u6GMG+HQu4nizjZQJNTZmJmq2ewlJERIvQkIQfULkSH?= =?us-ascii?Q?SV0bPa6D8F3Q67Wo8tINcTDOkyXlHlOwPBmhQbwfV9uDV8N4T3UBCOJaeY1U?= =?us-ascii?Q?T5yglLfCA9YwhlK+beAtzU6fmdF9RwayvYfk/0XGyv3DRQEvNMQeWMXAb/7C?= =?us-ascii?Q?egwRPY0ui5eKGS7y4DTAuoIcte1Ok0KafEWPMCqqOZitaspJbemzCogT3Dy0?= =?us-ascii?Q?4enIUIYqouKt9ecRQoPqlYThmBysGXAtdhb/M003k3WJW8Tp+FZlAZak6KJL?= =?us-ascii?Q?OMnRI5lE7sK09DKKbB2rL5Db6bqcfNM1NauPl+ghB+MJnq+UVteXcwvWuuIq?= =?us-ascii?Q?EOJHSLtk6Q9tsK+I2ZNl0luTSRk5mnDjPWkIATxq/8olUbM230Gl9CGuPSQI?= =?us-ascii?Q?aDOGE4DV9mioWpG3IolOIBraYXIUGjKn+ZofpMD2L0G6R8I+/6VDMOdiKCL+?= =?us-ascii?Q?lr6efbZmGQqky6wzZgQZ+zBHi3fEctBus8w9Kx9/ihp1/usFFQJLw0yKl3fN?= =?us-ascii?Q?2C63vwslRWT0W8qB5L3/FTj9FZ4jlCNM1cXF4EAJ5t5caqXbrjz0pXwEnwC0?= =?us-ascii?Q?QVTrax4aV0wcD3SW/7CUX+I0pCYZbIKSuhRACvetpu/p6hRUZtkcATuqokw3?= =?us-ascii?Q?NMqhx2GsVmDacpPW6FNfETrbit8T1wUQ0PqiBqQCqfQrzMLwr0FA2o4NAhAD?= =?us-ascii?Q?ksYdoTnxuGqW5dbbaatliVV0kW2gpKf0DUqQuXo3vPNUCaIXKkdyLu1FNzDr?= =?us-ascii?Q?V5PExaZuGfKM8hFaWkZnYTH2uz9oAWKWgtUGuaTY8lnd6G7RWwRRH4FNblof?= =?us-ascii?Q?+cjjBn5atQ9L8pGqxfD0jvjJqppJP8iChFFBEK/MMKFoGbXZceg3TsKNlaTJ?= =?us-ascii?Q?8IkhZy2NRENvVVqnyRaCRZUsi3/SDqScafqaON2rPYecyAKHyfk/jP3ONzHV?= =?us-ascii?Q?Kky6T3Ryl+hhF11laxSuYp3OxwvNuRg/roWv4CGPOzPsZGdum/cnHKH4c+68?= =?us-ascii?Q?u5IsZ+uVAW0sY+myn1oUHvMgOWb/VnhfcwvAsxdQ1Jk4Ob89jtRM1UoaQd7W?= =?us-ascii?Q?ACN5zB9LCyjFcCGzhZNkkxZBRwgdwnXn2RV/Gn52fP5sF2IK3H0oDDNYrV1d?= =?us-ascii?Q?FpatWx4viraZwPl7uZd0zyyiWDdt2WsFl4r19fgf7/GosODucamTLz0+Iftn?= =?us-ascii?Q?qLFaPVhs0VGBSY6lwGXoi5fitumhS3AVxqr1Hv/H1dTBL/xrwwg17qvk+BV+?= =?us-ascii?Q?X7yAWmdt8feU8yLmA9b6D0qC38qJjDwDQEEl9MQDMof8IAJ0c2ZtV96X/r1S?= =?us-ascii?Q?07+uLIVnokZAXSYTevjuzio3m5xakaABL5H0KZjsIlo3ra7uwkR1mOWDq33Z?= =?us-ascii?Q?BIhzy4na2G1rm1FltoYXUEHxKF/dwXu3MZ7opuE0DLsvDOYOYqxd8jH4p+dt?= =?us-ascii?Q?htAc2dg+1D5oYaGMz+Q5y2pBGzCrxudq0I2DD+csylO4?= MIME-Version: 1.0 X-OriginatorOrg: microsoft.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-AuthSource: MW4PR21MB1907.namprd21.prod.outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: 0ec2f7ca-f35c-486e-3e5c-08d9b14c7f06 X-MS-Exchange-CrossTenant-originalarrivaltime: 27 Nov 2021 02:20:35.4532 (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-CrossTenant-userprincipalname: XLyXj7JRh7PaudgBm0/6GzTn1Rnqj+GnB0tJIAtZHLD7/aJxrvucU6q7Iz9m3I6vuOb4OxNZckn77Z+YSuyD2w== X-MS-Exchange-Transport-CrossTenantHeadersStamped: MW2PR2101MB1852 Content-Language: en-US Content-Type: multipart/alternative; boundary="_000_MW4PR21MB19076D07A1A80DBDA33C3201EF649MW4PR21MB1907namp_" --_000_MW4PR21MB19076D07A1A80DBDA33C3201EF649MW4PR21MB1907namp_ Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Reviewed-by: Bret Barkelew - Bret From: mikuback@linux.microsoft.com Sent: Wednesday, November 24, 2021 4:52 PM To: devel@edk2.groups.io Cc: Kinney, Michael D; Liming Gao; Sean Brogan; = Bret Barkelew Subject: [PATCH v5 1/1] .pytool/Plugin/UncrustifyCheck: Add Uncrustify CI p= lugin From: Michael Kubacki REF:https://nam06.safelinks.protection.outlook.com/?url=3Dhttps%3A%2F%2Fbug= zilla.tianocore.org%2Fshow_bug.cgi%3Fid%3D3748&data=3D04%7C01%7CBret.Ba= rkelew%40microsoft.com%7Cccfe5bfffa354589afb308d9afaddcc3%7C72f988bf86f141a= f91ab2d7cd011db47%7C1%7C0%7C637733983563562870%7CUnknown%7CTWFpbGZsb3d8eyJW= IjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&s= data=3Ds4fnIyCIL8NTcjwaboh7Nb23EqqTwM83wd9BNdLe%2Bdo%3D&reserved=3D0 Adds a new CI plugin for Uncrustify. This is used to check coding standard compliance of source code to the EDK II C Coding Standards Specification. An external dependency is added in the plugin directory to retrieve the Uncrustify executable. Currently, the executable is from an edk2 fork of the application host in this repository: https://nam06.safelinks.protection.outlook.com/?url=3Dhttps%3A%2F%2Fdev.azu= re.com%2Fprojectmu%2FUncrustify%2F&data=3D04%7C01%7CBret.Barkelew%40mic= rosoft.com%7Cccfe5bfffa354589afb308d9afaddcc3%7C72f988bf86f141af91ab2d7cd01= 1db47%7C1%7C0%7C637733983563562870%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAw= MDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=3DC66K4= wDVoQFKviSvVWsY9WAzDCbEYj8q8Ru26TQdwoI%3D&reserved=3D0 Note that the Uncrustify application outputs the commit ID that the application was built from when given the --version parameter. This ID can be mapped to the version specified in the Uncrustify CI plugin external dependency file (uncrustify_ext_dep.yaml) such as 73.0.3 by visiting the Uncrustify edk2 fork release pipeline page which associates the NuGet package version with the commit ID it was built from: https://nam06.safelinks.protection.outlook.com/?url=3Dhttps%3A%2F%2Fdev.azu= re.com%2Fprojectmu%2FUncrustify%2F_build&data=3D04%7C01%7CBret.Barkelew= %40microsoft.com%7Cccfe5bfffa354589afb308d9afaddcc3%7C72f988bf86f141af91ab2= d7cd011db47%7C1%7C0%7C637733983563562870%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC= 4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata= =3DWEgFY0wLhjdNYHdO6m7uu%2B%2FE58vX8JFN2npYZeSt0b4%3D&reserved=3D0 The default Uncrustify configuration files are added in the plugin directory. Additional details are in the Readme.md file added in the Uncrustify plugin directory. Cc: Michael D Kinney Cc: Liming Gao Cc: Sean Brogan Cc: Bret Barkelew Signed-off-by: Michael Kubacki --- Notes: V5 changes: 1. Disable (comment out the setting in the Uncrustify config file) for file and function header templates due to the large number of failures that will take time to resolve. These settings can be enabled in the future after packages are updated to not fail the check. V4 changes: 1. Updated commit subject to use the new plugin name. 2. Enabled file and function header templates to be placed in files missing a file or function header (comment block). 3. Added support to detect whether a file header or function header is missing in a file by searching files modified by Uncrustify for the template file text. 4. Updated the plugin name displayed in some log output messages. V3 changes: 1. Renamed the CI plugin to "UncrustifyCheck" from "Uncrustify" to follow similar naming conventions used in other plugins that check files 2. Added a clarifying paragraph to the beginning of the Uncrustify CI plugin Readme.md file that the plugin is enabled by default and test results can be ignored by enabling "AuditOnly" mode. 3. Added instructions in the commit message on how to map the version reported by the Uncrustify application (--version) to the version specified in the CI plugin external dependency YAML file. V2 changes: 1. Changed plugin temp directory to Build/.pytool/Plugin/Uncrustify 2. Added TCBZ REF in patch commit message .pytool/Plugin/UncrustifyCheck/Readme.md | 120 ++++ .pytool/Plugin/UncrustifyCheck/UncrustifyCheck.py | 617 +++++++++= +++++++++++ .pytool/Plugin/UncrustifyCheck/default_file_header.txt | 9 + .pytool/Plugin/UncrustifyCheck/default_function_header.txt | 15 + .pytool/Plugin/UncrustifyCheck/uncrustify.cfg | 462 +++++++++= ++++++ .pytool/Plugin/UncrustifyCheck/uncrustify_ext_dep.yaml | 16 + .pytool/Plugin/UncrustifyCheck/uncrustify_plug_in.yaml | 11 + .pytool/Readme.md | 4 + 8 files changed, 1254 insertions(+) diff --git a/.pytool/Plugin/UncrustifyCheck/Readme.md b/.pytool/Plugin/Uncr= ustifyCheck/Readme.md new file mode 100644 index 000000000000..bb263bcc87d7 --- /dev/null +++ b/.pytool/Plugin/UncrustifyCheck/Readme.md @@ -0,0 +1,120 @@ +# UncrustifyCheck Plugin + +This CiBuildPlugin scans all the files in a given package and checks for c= oding standard compliance issues. + +This plugin is enabled by default. If a package would like to prevent the = plugin from reporting errors, it can do +so by enabling [`AuditOnly`](#auditonly) mode. + +This plugin requires the directory containing the Uncrustify executable th= at should be used for this plugin to +be specified in an environment variable named `UNCRUSTIFY_CI_PATH`. This u= nique variable name is used to avoid confusion +with other paths to Uncrustify which might not be the expected build for u= se by this plugin. + +By default, an Uncrustify configuration file named "uncrustify.cfg" locate= d in the same directory as the plugin is +used. The value can be overridden to a package-specific path with the `Con= figFilePath` configuration file option. + +* Uncrustify source code and documentation: https://nam06.safelinks.protec= tion.outlook.com/?url=3Dhttps%3A%2F%2Fgithub.com%2Funcrustify%2Funcrustify&= amp;data=3D04%7C01%7CBret.Barkelew%40microsoft.com%7Cccfe5bfffa354589afb308= d9afaddcc3%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637733983563562870%= 7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWw= iLCJXVCI6Mn0%3D%7C3000&sdata=3DxIkDRtWWVcN0%2BesJ%2B0gqT4bWoGkkdMBotBb8= H8TSk5U%3D&reserved=3D0 +* Project Mu Uncrustify fork source code and documentation: https://nam06.= safelinks.protection.outlook.com/?url=3Dhttps%3A%2F%2Fdev.azure.com%2Fproje= ctmu%2FUncrustify&data=3D04%7C01%7CBret.Barkelew%40microsoft.com%7Cccfe= 5bfffa354589afb308d9afaddcc3%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C6= 37733983563562870%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luM= zIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=3DM0vWXls8JO6uHUwJAprS94= eVOWD219C%2BzvHBq68YhhY%3D&reserved=3D0 + +## Files Checked in a Package + +By default, this plugin will discover all files in the package with the fo= llowing default paths: + +```python +[ +# C source +"*.c", +"*.h" +] +``` + +From this list of files, any files ignored by Git or residing in a Git sub= module will be removed. If Git is not +found, submodules are not found, or ignored files are not found no changes= are made to the list of discovered files. + +To control the paths checked in a given package, review the configuration = options described in this file. + +## Configuration + +The plugin can be configured with a few optional configuration options. + +``` yaml + "UncrustifyCheck": { + "AdditionalIncludePaths": [], # Additional paths to check formatting= (wildcards supported). + "AuditOnly": False, # Don't fail the build if there are er= rors. Just log them. + "ConfigFilePath": "", # Custom path to an Uncrustify config = file. + "IgnoreStandardPaths": [], # Standard Plugin defined paths that s= hould be ignored. + "OutputFileDiffs": False, # Output chunks of formatting diffs in= the test case log. + # This can significantly slow down the= plugin on very large packages. + "SkipGitExclusions": False # Don't exclude git ignored files and = files in git submodules. + } +``` + +### `AdditionalIncludePaths` + +A package configuration file can specify any additional paths to be includ= ed with this option. + +At this time, it is recommended all files run against the plugin be writte= n in the C or C++ language. + +### `AuditOnly` + +`Boolean` - Default is `False`. + +If `True`, run the test in an "audit only mode" which will log all errors = but instead of failing the build, it will set +the test as skipped. This allows visibility into the failures without brea= king the build. + +### `ConfigFilePath` + +`String` - Default is `"uncrustify.cfg"` + +When specified in the config file, this is a package relative path to the = Uncrustify configuration file. + +### `IgnoreStandardPaths` + +This plugin by default will check the below standard paths. A package conf= iguration file can specify any of these paths +to be ignored. + +```python +[ +# C source +"*.c", +"*.h" +] +``` + +### `OutputFileDiffs` + +`Boolean` - Default is `False`. + +If `True`, output diffs of formatting changes into the test case log. This= is helpful to exactly understand what changes +need to be made to the source code in order to fix a coding standard compl= iance issue. + +Note that calculating the file diffs on a very large set of of results (e.= g. >100 files) can significantly slow down +plugin execution. + +### `SkipGitExclusions` + +`Boolean` - Default is `False`. + +By default, files in paths matched in a .gitignore file or a recognized gi= t submodule are excluded. If this option +is `True`, the plugin will not attempt to recognize these files and exclud= e them. + +## High-Level Plugin Operation + +This plugin generates two main sets of temporary files: + + 1. A working directory in the directory `Build/.pytool/Plugin/Uncrustify= ` + 2. For each source file with formatting errors, a sibling file with the = `.uncrustify_plugin` extension + +The working directory contains temporary files unique to operation of the = plugin. All of these files are removed on +exit of the plugin including successful or unsuccessful execution (such as= a Python exception occurring). If for any +reason, any files in the package exist prior to running the plugin with th= e `.uncrustify_plugin` extension, the plugin +will inform the user to remove these files and exit before running Uncrust= ify. This is to ensure the accuracy of the +results reported from each execution instance of the plugin. + +The plugin determines the list of relevant files to check with Uncrustify = and then invokes Uncrustify with that file +list. For any files not compliant to the configuration file provided, Uncr= ustify will generate a corresponding file +with the `.uncrustify_plugin` extension. The plugin discovers all of these= files. If any such files are present, this +indicates a formatting issue was found and the test is marked failed (unle= ss `AuditOnly` mode is enabled). + +The test case log will contain a report of which files failed to format pr= operly, allowing the user to run Uncrustify +against the file locally to fix the issue. If the `OutputFileDiffs` config= uration option is set to `True`, the plugin +will output diff chunks for all code formatting issues in the test case lo= g. diff --git a/.pytool/Plugin/UncrustifyCheck/UncrustifyCheck.py b/.pytool/Pl= ugin/UncrustifyCheck/UncrustifyCheck.py new file mode 100644 index 000000000000..59534469a2d3 --- /dev/null +++ b/.pytool/Plugin/UncrustifyCheck/UncrustifyCheck.py @@ -0,0 +1,617 @@ +# @file UncrustifyCheck.py +# +# An edk2-pytool based plugin wrapper for Uncrustify +# +# Copyright (c) Microsoft Corporation. +# SPDX-License-Identifier: BSD-2-Clause-Patent +## +import configparser +import difflib +import errno +import logging +import os +import pathlib +import shutil +import timeit +from edk2toolext.environment import version_aggregator +from edk2toolext.environment.plugin_manager import PluginManager +from edk2toolext.environment.plugintypes.ci_build_plugin import ICiBuildPl= ugin +from edk2toolext.environment.plugintypes.uefi_helper_plugin import HelperF= unctions +from edk2toolext.environment.var_dict import VarDict +from edk2toollib.log.junit_report_format import JunitReportTestCase +from edk2toollib.uefi.edk2.path_utilities import Edk2Path +from edk2toollib.utility_functions import RunCmd +from io import StringIO +from typing import Any, Dict, List, Tuple + +# +# Provide more user friendly messages for certain scenarios +# +class UncrustifyException(Exception): + def __init__(self, message, exit_code): + super().__init__(message) + self.exit_code =3D exit_code + + +class UncrustifyAppEnvVarNotFoundException(UncrustifyException): + def __init__(self, message): + super().__init__(message, -101) + + +class UncrustifyAppVersionErrorException(UncrustifyException): + def __init__(self, message): + super().__init__(message, -102) + + +class UncrustifyAppExecutionException(UncrustifyException): + def __init__(self, message): + super().__init__(message, -103) + + +class UncrustifyStalePluginFormattedFilesException(UncrustifyException): + def __init__(self, message): + super().__init__(message, -120) + + +class UncrustifyInputFileCreationErrorException(UncrustifyException): + def __init__(self, message): + super().__init__(message, -121) + +class UncrustifyInvalidIgnoreStandardPathsException(UncrustifyException): + def __init__(self, message): + super().__init__(message, -122) + +class UncrustifyGitIgnoreFileException(UncrustifyException): + def __init__(self, message): + super().__init__(message, -140) + + +class UncrustifyGitSubmoduleException(UncrustifyException): + def __init__(self, message): + super().__init__(message, -141) + + +class UncrustifyCheck(ICiBuildPlugin): + """ + A CiBuildPlugin that uses Uncrustify to check the source files in the + package being tested for coding standard issues. + + By default, the plugin runs against standard C source file extensions = but + its configuration can be modified through its configuration file. + + Configuration options: + "UncrustifyCheck": { + "AdditionalIncludePaths": [], # Additional paths to check formatti= ng (wildcards supported). + "AuditOnly": False, # Don't fail the build if there are = errors. Just log them. + "ConfigFilePath": "", # Custom path to an Uncrustify confi= g file. + "IgnoreStandardPaths": [], # Standard Plugin defined paths that= should be ignored. + "OutputFileDiffs": False, # Output chunks of formatting diffs = in the test case log. + # This can significantly slow down t= he plugin on very large packages. + "SkipGitExclusions": False # Don't exclude git ignored files an= d files in git submodules. + } + """ + + # + # By default, use an "uncrustify.cfg" config file in the plugin direct= ory + # A package can override this path via "ConfigFilePath" + # + # Note: Values specified via "ConfigFilePath" are relative to the pack= age + # + DEFAULT_CONFIG_FILE_PATH =3D os.path.join( + pathlib.Path(__file__).parent.resolve(), "uncrustify.cfg") + + # + # The extension used for formatted files produced by this plugin + # + FORMATTED_FILE_EXTENSION =3D ".uncrustify_plugin" + + # + # A package can add any additional paths with "AdditionalIncludePaths" + # A package can remove any of these paths with "IgnoreStandardPaths" + # + STANDARD_PLUGIN_DEFINED_PATHS =3D ("*.c", "*.h") + + # + # The Uncrustify application path should set in this environment varia= ble + # + UNCRUSTIFY_PATH_ENV_KEY =3D "UNCRUSTIFY_CI_PATH" + + def GetTestName(self, packagename: str, environment: VarDict) -> Tuple= : + """ Provide the testcase name and classname for use in reporting + + Args: + packagename: string containing name of package to build + environment: The VarDict for the test to run in + Returns: + A tuple containing the testcase name and the classname + (testcasename, classname) + testclassname: a descriptive string for the testcase can i= nclude whitespace + classname: should be patterned .. + """ + return ("Check file coding standard compliance in " + packagename,= packagename + ".UncrustifyCheck") + + def RunBuildPlugin(self, package_rel_path: str, edk2_path: Edk2Path, p= ackage_config: Dict[str, List[str]], environment_config: Any, plugin_manage= r: PluginManager, plugin_manager_helper: HelperFunctions, tc: JunitReportTe= stCase, output_stream=3DNone) -> int: + """ + External function of plugin. This function is used to perform the = task of the CiBuild Plugin. + + Args: + - package_rel_path: edk2 workspace relative path to the package + - edk2_path: Edk2Path object with workspace and packages paths + - package_config: Dictionary with the package configuration + - environment_config: Environment configuration + - plugin_manager: Plugin Manager Instance + - plugin_manager_helper: Plugin Manager Helper Instance + - tc: JUnit test case + - output_stream: The StringIO output stream from this plugin (lo= gging) + + Returns + >0 : Number of errors found + 0 : Passed successfully + -1 : Skipped for missing prereq + """ + try: + # Initialize plugin and check pre-requisites. + self._initialize_environment_info( + package_rel_path, edk2_path, package_config, tc) + self._initialize_configuration() + self._check_for_preexisting_formatted_files() + + # Log important context information. + self._log_uncrustify_app_info() + + # Get template file contents if specified + self._get_template_file_contents() + + # Create meta input files & directories + self._create_temp_working_directory() + self._create_uncrustify_file_list_file() + + self._run_uncrustify() + + # Post-execution actions. + self._process_uncrustify_results() + + except UncrustifyException as e: + self._tc.LogStdError( + f"Uncrustify error {e.exit_code}. Details:\n\n{str(e)}") + logging.warning( + f"Uncrustify error {e.exit_code}. Details:\n\n{str(e)}") + return -1 + else: + if self._formatted_file_error_count > 0: + if self._audit_only_mode: + logging.info( + "Setting test as skipped since AuditOnly is enable= d") + self._tc.SetSkipped() + return -1 + else: + self._tc.SetFailed( + f"{self._plugin_name} failed due to {self._formatt= ed_file_error_count} incorrectly formatted files.", "CHECK_FAILED") + else: + self._tc.SetSuccess() + return self._formatted_file_error_count + finally: + self._cleanup_temporary_formatted_files() + self._cleanup_temporary_directory() + + def _initialize_configuration(self) -> None: + """ + Initializes plugin configuration. + """ + self._initialize_app_info() + self._initialize_config_file_info() + self._initialize_file_to_format_info() + self._initialize_test_case_output_options() + + def _check_for_preexisting_formatted_files(self) -> None: + """ + Checks if any formatted files from prior execution are present. + + Existence of such files is an unexpected condition. This might res= ult + from an error that occurred during a previous run or a premature e= xit from a debug scenario. In any case, the package should be clean before = starting a new run. + """ + pre_existing_formatted_file_count =3D len( + [str(path.resolve()) for path in pathlib.Path(self._abs_packag= e_path).rglob(f'*{UncrustifyCheck.FORMATTED_FILE_EXTENSION}')]) + + if pre_existing_formatted_file_count > 0: + raise UncrustifyStalePluginFormattedFilesException( + f"{pre_existing_formatted_file_count} formatted files alre= ady exist. To prevent overwriting these files, please remove them before ru= nning this plugin.") + + def _cleanup_temporary_directory(self) -> None: + """ + Cleans up the temporary directory used for this execution instance= . + + This removes the directory and all files created during this insta= nce. + """ + if hasattr(self, '_working_dir'): + self._remove_tree(self._working_dir) + + def _cleanup_temporary_formatted_files(self) -> None: + """ + Cleans up the temporary formmatted files produced by Uncrustify. + + This will recursively remove all formatted files generated by Uncr= ustify + during this execution instance. + """ + if hasattr(self, '_abs_package_path'): + formatted_files =3D [str(path.resolve()) for path in pathlib.P= ath( + self._abs_package_path).rglob(f'*{UncrustifyCheck.FORMATTE= D_FILE_EXTENSION}')] + + for formatted_file in formatted_files: + os.remove(formatted_file) + + def _create_temp_working_directory(self) -> None: + """ + Creates the temporary directory used for this execution instance. + """ + self._working_dir =3D os.path.join( + self._abs_workspace_path, "Build", ".pytool", "Plugin", f"{sel= f._plugin_name}") + + try: + pathlib.Path(self._working_dir).mkdir(parents=3DTrue, exist_ok= =3DTrue) + except OSError as e: + raise UncrustifyInputFileCreationErrorException( + f"Error creating plugin directory {self._working_dir}.\n\n= {repr(e)}.") + + def _create_uncrustify_file_list_file(self) -> None: + """ + Creates the file with the list of source files for Uncrustify to p= rocess. + """ + self._app_input_file_path =3D os.path.join( + self._working_dir, "uncrustify_file_list.txt") + + with open(self._app_input_file_path, 'w', encoding=3D'utf8') as f: + f.writelines(f"\n".join(self._abs_file_paths_to_format)) + + def _execute_uncrustify(self) -> None: + """ + Executes Uncrustify with the initialized configuration. + """ + output =3D StringIO() + self._app_exit_code =3D RunCmd( + self._app_path, + f"-c {self._app_config_file} -F {self._app_input_file_path} --= if-changed --suffix {UncrustifyCheck.FORMATTED_FILE_EXTENSION}", outstream= =3Doutput) + self._app_output =3D output.getvalue().strip().splitlines() + + def _get_git_ignored_paths(self) -> List[str]: + """" + Returns a list of file absolute path strings to all files ignored = in this git repository. + + If git is not found, an empty list will be returned. + """ + if not shutil.which("git"): + logging.warn( + "Git is not found on this system. Git submodule paths will= not be considered.") + return [] + + outstream_buffer =3D StringIO() + exit_code =3D RunCmd("git", "ls-files --other", + workingdir=3Dself._abs_workspace_path, outstrea= m=3Doutstream_buffer, logging_level=3Dlogging.NOTSET) + if (exit_code !=3D 0): + raise UncrustifyGitIgnoreFileException( + f"An error occurred reading git ignore settings. This will= prevent Uncrustify from running against the expected set of files.") + + # Note: This will potentially be a large list, but at least sorted + return outstream_buffer.getvalue().strip().splitlines() + + def _get_git_submodule_paths(self) -> List[str]: + """ + Returns a list of directory absolute path strings to the root of e= ach submodule in the workspace repository. + + If git is not found, an empty list will be returned. + """ + if not shutil.which("git"): + logging.warn( + "Git is not found on this system. Git submodule paths will= not be considered.") + return [] + + if os.path.isfile(os.path.join(self._abs_workspace_path, ".gitmodu= les")): + logging.info( + f".gitmodules file found. Excluding submodules in {self._p= ackage_name}.") + + outstream_buffer =3D StringIO() + exit_code =3D RunCmd("git", "config --file .gitmodules --get-r= egexp path", workingdir=3Dself._abs_workspace_path, outstream=3Doutstream_b= uffer, logging_level=3Dlogging.NOTSET) + if (exit_code !=3D 0): + raise UncrustifyGitSubmoduleException( + f".gitmodule file detected but an error occurred readi= ng the file. Cannot proceed with unknown submodule paths.") + + submodule_paths =3D [] + for line in outstream_buffer.getvalue().strip().splitlines(): + submodule_paths.append( + os.path.normpath(os.path.join(self._abs_workspace_path= , line.split()[1]))) + + return submodule_paths + else: + return [] + + def _get_template_file_contents(self) -> None: + """ + Gets the contents of Uncrustify template files if they are specifi= ed + in the Uncrustify configuration file. + """ + + self._file_template_contents =3D None + self._func_template_contents =3D None + + # Allow no value to allow "set" statements in the config file whic= h do + # not specify value assignment + parser =3D configparser.ConfigParser(allow_no_value=3DTrue) + with open(self._app_config_file, 'r') as cf: + parser.read_string("[dummy_section]\n" + cf.read()) + + try: + file_template_name =3D parser["dummy_section"]["cmt_insert_fil= e_header"] + + file_template_path =3D pathlib.Path(file_template_name) + + if not file_template_path.is_file(): + file_template_path =3D pathlib.Path(os.path.join(self._plu= gin_path, file_template_name)) + self._file_template_contents =3D file_template_path.read_t= ext() + except KeyError: + logging.warn("A file header template is not specified in the c= onfig file.") + except FileNotFoundError: + logging.warn("The specified file header template file was not = found.") + try: + func_template_name =3D parser["dummy_section"]["cmt_insert_fun= c_header"] + + func_template_path =3D pathlib.Path(func_template_name) + + if not func_template_path.is_file(): + func_template_path =3D pathlib.Path(os.path.join(self._plu= gin_path, func_template_name)) + self._func_template_contents =3D func_template_path.read_t= ext() + except KeyError: + logging.warn("A function header template is not specified in t= he config file.") + except FileNotFoundError: + logging.warn("The specified function header template file was = not found.") + + def _initialize_app_info(self) -> None: + """ + Initialize Uncrustify application information. + + This function will determine the application path and version. + """ + # Verify Uncrustify is specified in the environment. + if UncrustifyCheck.UNCRUSTIFY_PATH_ENV_KEY not in os.environ: + raise UncrustifyAppEnvVarNotFoundException( + f"Uncrustify environment variable {UncrustifyCheck.UNCRUST= IFY_PATH_ENV_KEY} is not present.") + + self._app_path =3D shutil.which('uncrustify', path=3Dos.environ[Un= crustifyCheck.UNCRUSTIFY_PATH_ENV_KEY]) + + if self._app_path is None: + raise FileNotFoundError( + errno.ENOENT, os.strerror(errno.ENOENT), self._app_path) + + self._app_path =3D os.path.normcase(os.path.normpath(self._app_pat= h)) + + if not os.path.isfile(self._app_path): + raise FileNotFoundError( + errno.ENOENT, os.strerror(errno.ENOENT), self._app_path) + + # Verify Uncrustify is present at the expected path. + return_buffer =3D StringIO() + ret =3D RunCmd(self._app_path, "--version", outstream=3Dreturn_buf= fer) + if (ret !=3D 0): + raise UncrustifyAppVersionErrorException( + f"Error occurred executing --version: {ret}.") + + # Log Uncrustify version information. + self._app_version =3D return_buffer.getvalue().strip() + self._tc.LogStdOut(f"Uncrustify version: {self._app_version}") + version_aggregator.GetVersionAggregator().ReportVersion( + "Uncrustify", self._app_version, version_aggregator.VersionTyp= es.INFO) + + def _initialize_config_file_info(self) -> None: + """ + Initialize Uncrustify configuration file info. + + The config file path is relative to the package root. + """ + self._app_config_file =3D UncrustifyCheck.DEFAULT_CONFIG_FILE_PATH + if "ConfigFilePath" in self._package_config: + self._app_config_file =3D self._package_config["ConfigFilePath= "].strip() + + self._app_config_file =3D os.path.normpath( + os.path.join(self._abs_package_path, self._app_config_file= )) + + if not os.path.isfile(self._app_config_file): + raise FileNotFoundError( + errno.ENOENT, os.strerror(errno.ENOENT), self._app_config_= file) + + def _initialize_environment_info(self, package_rel_path: str, edk2_pat= h: Edk2Path, package_config: Dict[str, List[str]], tc: JunitReportTestCase)= -> None: + """ + Initializes plugin environment information. + """ + self._abs_package_path =3D edk2_path.GetAbsolutePathOnThisSytemFro= mEdk2RelativePath( + package_rel_path) + self._abs_workspace_path =3D edk2_path.WorkspacePath + self._package_config =3D package_config + self._package_name =3D os.path.basename( + os.path.normpath(package_rel_path)) + self._plugin_name =3D self.__class__.__name__ + self._plugin_path =3D os.path.dirname(os.path.realpath(__file__)) + self._rel_package_path =3D package_rel_path + self._tc =3D tc + + def _initialize_file_to_format_info(self) -> None: + """ + Forms the list of source files for Uncrustify to process. + """ + # Create a list of all the package relative file paths in the pack= age to run against Uncrustify. + rel_file_paths_to_format =3D list( + UncrustifyCheck.STANDARD_PLUGIN_DEFINED_PATHS) + + # Allow the ci.yaml to remove any of the pre-defined standard path= s + if "IgnoreStandardPaths" in self._package_config: + for a in self._package_config["IgnoreStandardPaths"]: + if a.strip() in rel_file_paths_to_format: + self._tc.LogStdOut( + f"Ignoring standard path due to ci.yaml ignore: {a= }") + rel_file_paths_to_format.remove(a.strip()) + else: + raise UncrustifyInvalidIgnoreStandardPathsException(f"= Invalid IgnoreStandardPaths value: {a}") + + # Allow the ci.yaml to specify additional include paths for this p= ackage + if "AdditionalIncludePaths" in self._package_config: + rel_file_paths_to_format.extend( + self._package_config["AdditionalIncludePaths"]) + + self._abs_file_paths_to_format =3D [] + for path in rel_file_paths_to_format: + self._abs_file_paths_to_format.extend( + [str(path.resolve()) for path in pathlib.Path(self._abs_pa= ckage_path).rglob(path)]) + + if not "SkipGitExclusions" in self._package_config or not self._pa= ckage_config["SkipGitExclusions"]: + # Remove files ignored by git + logging.info( + f"{self._package_name} file count before git ignore file e= xclusion: {len(self._abs_file_paths_to_format)}") + + ignored_paths =3D self._get_git_ignored_paths() + self._abs_file_paths_to_format =3D list( + set(self._abs_file_paths_to_format).difference(ignored_pat= hs)) + + logging.info( + f"{self._package_name} file count after git ignore file ex= clusion: {len(self._abs_file_paths_to_format)}") + + # Remove files in submodules + logging.info( + f"{self._package_name} file count before submodule exclusi= on: {len(self._abs_file_paths_to_format)}") + + submodule_paths =3D tuple(self._get_git_submodule_paths()) + for path in submodule_paths: + logging.info(f" submodule path: {path}") + + self._abs_file_paths_to_format =3D [ + f for f in self._abs_file_paths_to_format if not f.startsw= ith(submodule_paths)] + + logging.info( + f"{self._package_name} file count after submodule exclusio= n: {len(self._abs_file_paths_to_format)}") + + # Sort the files for more consistent results + self._abs_file_paths_to_format.sort() + + def _initialize_test_case_output_options(self) -> None: + """ + Initializes options that influence test case output. + """ + self._audit_only_mode =3D False + self._output_file_diffs =3D False + + if "AuditOnly" in self._package_config and self._package_config["A= uditOnly"]: + self._audit_only_mode =3D True + + if "OutputFileDiffs" in self._package_config and self._package_con= fig["OutputFileDiffs"]: + self._output_file_diffs =3D True + + def _log_uncrustify_app_info(self) -> None: + """ + Logs Uncrustify application information. + """ + self._tc.LogStdOut(f"Found Uncrustify at {self._app_path}") + self._tc.LogStdOut(f"Uncrustify version: {self._app_version}") + self._tc.LogStdOut('\n') + logging.info(f"Found Uncrustify at {self._app_path}") + logging.info(f"Uncrustify version: {self._app_version}") + logging.info('\n') + + def _process_uncrustify_results(self) -> None: + """ + Process the results from Uncrustify. + + Determines whether formatting errors are present and logs failures= . + """ + formatted_files =3D [str(path.resolve()) for path in pathlib.Path( + self._abs_package_path).rglob(f'*{UncrustifyCheck.FORMATTED_FI= LE_EXTENSION}')] + + self._formatted_file_error_count =3D len(formatted_files) + + if self._formatted_file_error_count > 0: + self._tc.LogStdError("Files with formatting errors:\n") + + if self._output_file_diffs: + logging.info("Calculating file diffs. This might take a wh= ile...") + + for formatted_file in formatted_files: + pre_formatted_file =3D formatted_file[:- + len(UncrustifyCheck.FORMAT= TED_FILE_EXTENSION)] + + if (self._output_file_diffs or + self._file_template_contents is not None or + self._func_template_contents is not None): + self._tc.LogStdError( + f"Formatting errors in {os.path.relpath(pre_formatted_= file, self._abs_package_path)}\n") + + with open(formatted_file) as ff: + formatted_file_text =3D ff.read() + + if (self._file_template_contents is not None and + self._file_template_contents in formatted_file= _text): + self._tc.LogStdError(f"File header is missing in {= os.path.relpath(pre_formatted_file, self._abs_package_path)}\n") + + if (self._func_template_contents is not None and + self._func_template_contents in formatted_file= _text): + self._tc.LogStdError(f"A function header is missin= g in {os.path.relpath(pre_formatted_file, self._abs_package_path)}\n") + + if self._output_file_diffs: + with open(pre_formatted_file) as pf: + pre_formatted_file_text =3D pf.read() + + for line in difflib.unified_diff(pre_formatted_fil= e_text.split('\n'), formatted_file_text.split('\n'), fromfile=3Dpre_formatt= ed_file, tofile=3Dformatted_file, n=3D3): + self._tc.LogStdError(line) + + self._tc.LogStdError('\n') + else: + self._tc.LogStdError(pre_formatted_file) + + def _remove_tree(self, dir_path: str, ignore_errors: bool =3D False) -= > None: + """ + Helper for removing a directory. Over time there have been + many private implementations of this due to reliability issues in = the + shutil implementations. To consolidate on a single function this h= elper is added. + + On error try to change file attributes. Also add retry logic. + + This function is temporarily borrowed from edk2toollib.utility_fun= ctions + since the version used in edk2 is not recent enough to include the + function. + + This function should be replaced by "RemoveTree" when it is availa= ble. + + Args: + - dir_path: Path to directory to remove. + - ignore_errors: Whether to ignore errors during removal + """ + + def _remove_readonly(func, path, _): + """ + Private function to attempt to change permissions on file/fold= er being deleted. + """ + os.chmod(path, os.stat.S_IWRITE) + func(path) + + for _ in range(3): # retry up to 3 times + try: + shutil.rmtree(dir_path, ignore_errors=3Dignore_errors, one= rror=3D_remove_readonly) + except OSError as err: + logging.warning(f"Failed to fully remove {dir_path}: {err}= ") + else: + break + else: + raise RuntimeError(f"Failed to remove {dir_path}") + + def _run_uncrustify(self) -> None: + """ + Runs Uncrustify for this instance of plugin execution. + """ + logging.info("Executing Uncrustify. This might take a while...") + start_time =3D timeit.default_timer() + self._execute_uncrustify() + end_time =3D timeit.default_timer() - start_time + + execution_summary =3D f"Uncrustify executed against {len(self._abs= _file_paths_to_format)} files in {self._package_name} in {end_time:.2f} sec= onds.\n" + + self._tc.LogStdOut(execution_summary) + logging.info(execution_summary) + + if self._app_exit_code !=3D 0 and self._app_exit_code !=3D 1: + raise UncrustifyAppExecutionException( + f"Error {str(self._app_exit_code)} returned from Uncrustif= y:\n\n{str(self._app_output)}") diff --git a/.pytool/Plugin/UncrustifyCheck/default_file_header.txt b/.pyto= ol/Plugin/UncrustifyCheck/default_file_header.txt new file mode 100644 index 000000000000..2955a734dfe1 --- /dev/null +++ b/.pytool/Plugin/UncrustifyCheck/default_file_header.txt @@ -0,0 +1,9 @@ +/** @file + Brief description of the file's purpose. + + Detailed description of the file's contents and other useful + information for a person viewing the file for the first time. + + <> + SPDX-License-Identifier: BSD-2-Clause-Patent +**/ diff --git a/.pytool/Plugin/UncrustifyCheck/default_function_header.txt b/.= pytool/Plugin/UncrustifyCheck/default_function_header.txt new file mode 100644 index 000000000000..66edc72e6731 --- /dev/null +++ b/.pytool/Plugin/UncrustifyCheck/default_function_header.txt @@ -0,0 +1,15 @@ +/** + Brief description of this function's purpose. + + Follow it immediately with the detailed description. + + @param[in] Arg1 Description of Arg1. + @param[in] Arg2 Description of Arg2 This is complicated and requir= es + multiple lines to describe. + @param[out] Arg3 Description of Arg3. + @param[in, out] Arg4 Description of Arg4. + + @retval VAL_ONE Description of what VAL_ONE signifies. + @retval OTHER This is the only other return value. If there were othe= r + return values, they would be listed. +**/ diff --git a/.pytool/Plugin/UncrustifyCheck/uncrustify.cfg b/.pytool/Plugin= /UncrustifyCheck/uncrustify.cfg new file mode 100644 index 000000000000..6261eb853690 --- /dev/null +++ b/.pytool/Plugin/UncrustifyCheck/uncrustify.cfg @@ -0,0 +1,462 @@ +## @file +# Uncrustify Configuration File for EDK II C Code +# +# Coding Standard: https://nam06.safelinks.protection.outlook.com/?url=3Dh= ttps%3A%2F%2Fedk2-docs.gitbook.io%2Fedk-ii-c-coding-standards-specification= %2F&data=3D04%7C01%7CBret.Barkelew%40microsoft.com%7Cccfe5bfffa354589af= b308d9afaddcc3%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637733983563562= 870%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1= haWwiLCJXVCI6Mn0%3D%7C3000&sdata=3DMerTF0Kzlnnb15aihVltzsF5yn82vV1k2iG5= oxvLAao%3D&reserved=3D0 +# +# This configuration file is meant to be a "best attempt" to align with th= e +# definitions in the EDK II C Coding Standards Specification. +# +# Copyright (c) Microsoft Corporation. +# SPDX-License-Identifier: BSD-2-Clause-Patent +## + +# Force UTF-8 encoding (no UTF-16) +enable_digraphs =3D false +utf8_byte =3D false +utf8_force =3D true + +# Code width / line splitting +#code_width =3D120 # TODO: This causes non-determ= inistic behaviour in some cases when code wraps +ls_code_width =3Dfalse +ls_for_split_full =3Dtrue +ls_func_split_full =3Dtrue +pos_comma =3Dtrail + +# 5.1.7 All files must end with CRLF +newlines =3D crlf + +# 5.1.2 Do not use tab characters + +cmt_convert_tab_to_spaces =3D true # Whether to convert all tab= s to spaces in comments. If false, tabs in + # comments are left alone, unl= ess used for indenting. +indent_columns =3D 2 # Number of spaces for inden= tation +indent_with_tabs =3D 0 # Do not use TAB characters +string_replace_tab_chars =3D true # Replace TAB with SPACE + # Note: This will break .robot= files but is needed for edk2 style + +# 5.2.1.1 There shall be only one statement on a line (statement ends with= ;) +nl_multi_line_cond =3D true # Add a newline between ')' = and '{' if the ')' is on a different line than + # the if/for/etc. +nl_after_semicolon =3D true # Whether to add a newline a= fter semicolons, except in 'for' statements. + +# 5.2.1.3 An open brace '{' goes on the same line as the closing parenthes= is ')' of simple predicate expressions +mod_full_brace_do =3D add # Add or remove braces on a = single-line 'do' statement. +mod_full_brace_for =3D add +mod_full_brace_function =3D add # Add or remove braces on a = single-line function definition. +mod_full_brace_if =3D add # Add or remove braces on a = single-line 'if' statement. Braces will not be + # removed if the braced statem= ent contains an 'else'. +mod_full_brace_if_chain =3D false +mod_full_brace_while =3D add + +# 5.2.1.4 A close brace '}' always goes at the beginning of the last line = of the body +eat_blanks_after_open_brace =3D true +eat_blanks_before_close_brace =3D true # Whether to remove blank li= nes before '}'. + +# 5.2.2.2 Always put space before and after binary operators. +sp_assign =3D add # Add or remove space around= assignment operator '=3D', '+=3D', etc. +sp_assign_default =3D add +sp_bool =3D add # Add or remove space around= boolean operators '&&' and '||'. +sp_compare =3D add # Add or remove space around= compare operator '<', '>', '=3D=3D', etc. + +# 5.2.2.3 Do not put space between unary operators and their object +sp_addr =3D remove # A or remove space after th= e '&' (address-of) unary operator. +sp_incdec =3D remove # Add or remove space betwee= n '++' and '--' the word to which it is being + # applied, as in '(--x)' or 'y= ++;'. +sp_inv =3D remove # Add or remove space after = the '~' (invert) unary operator. +sp_not =3D remove # Add or remove space after = the '!' (not) unary operator. +sp_sign =3D remove # Add or remove space after = '+' or '-', as in 'x =3D -5' or 'y =3D +7'. + +# 5.2.2.4 Subsequent lines of multi-line function calls should line up two= spaces from the beginning of the function +# name +nl_func_call_args_multi_line =3D true # Whether to add a newline a= fter each ',' in a function call if '(' and ')' + # are in different lines. +nl_func_call_args_multi_line_ignore_closures =3D false + +# - Indent each argument 2 spaces from the start of the function name. If = a +# function is called through a structure or union member, of type +# pointer-to-function, then indent each argument 2 spaces from the start= of the +# member name. +indent_func_call_edk2_style =3D true # Use EDK2 indentation style= for function calls (**CUSTOM SETTING**) +indent_paren_after_func_call =3D true # Whether to indent the open= parenthesis of a function call, if the + # parenthesis is on its own li= ne. + +# - Align the close parenthesis with the start of the last argument +indent_paren_close =3D 0 # How to indent a close pare= nthesis after a newline. + # (0: Body, 1: Openparenthesis= , 2: Brace level) + + +# 5.2.2.5 Always put space after commas or semicolons that separate items +sp_after_comma =3D force # Add or remove space after = ',', i.e. 'a,b' vs. 'a, b'. +sp_before_comma =3D remove # Add or remove space before= ','. + +# 5.2.2.6 Always put space before an open parenthesis +sp_after_sparen =3D add # Add or remove space after = ')' of control statements. +sp_attribute_paren =3D add # Add or remove space betwee= n '__attribute__' and '('. +sp_before_sparen =3D force # Add or remove space before= '(' of control statements + # ('if', 'for', 'switch', 'whi= le', etc.). +sp_defined_paren =3D force # Add or remove space betwee= n 'defined' and '(' in '#if defined (FOO)'. +sp_func_call_paren =3D force # Add or remove space betwee= n function name and '(' on function calls. +sp_func_call_paren_empty =3D force # Add or remove space betwee= n function name and '()' on function calls + # without parameters. If set t= o ignore (the default), sp_func_call_paren is + # used. +sp_func_def_paren =3D add # Add or remove space betwee= n alias name and '(' of a non-pointer function + # type typedef. +sp_func_proto_paren =3D add # Add or remove space betwee= n function name and '()' on function declaration +sp_sizeof_paren =3D force # Add or remove space betwee= n 'sizeof' and '('. +sp_type_func =3D add # Add or remove space betwee= n return type and function name. A minimum of 1 + # is forced except for pointer= return types. + +# Not specified, but also good style to remove spaces inside parentheses (= Optional) +sp_cparen_oparen =3D remove # Add or remove space betwee= n back-to-back parentheses, i.e. ')(' vs. ') ('. +sp_inside_fparen =3D remove # Add or remove space inside= function '(' and ')'. +sp_inside_fparens =3D remove # Add or remove space inside= empty function '()'. +sp_inside_paren =3D remove # Add or remove space inside= '(' and ')'. +sp_inside_paren_cast =3D remove # Add or remove spaces insid= e cast parentheses. '(int)x' +sp_inside_square =3D remove # Add or remove space inside= a non-empty '[' and ']'. +sp_paren_paren =3D remove # Add or remove space betwee= n nested parentheses, i.e. '((' vs. ') )'. +sp_square_fparen =3D remove # Add or remove space betwee= n ']' and '(' when part of a function call. + +# 5.2.2.7 Put a space before an open brace if it is not on its own line +sp_do_brace_open =3D force # Add or remove space betwee= n 'do' and '{'. +sp_paren_brace =3D force # Add or remove space betwee= n ')' and '{'. +sp_sparen_brace =3D force # Add or remove space betwee= n ')' and '{' of of control statements. + +# 5.2.2.8 Do not put spaces around structure member and pointer operators +sp_after_byref =3D remove # Add or remove space after = reference sign '&', if followed by a word. +sp_before_byref =3D add # Add or remove space before= a reference sign '&'. +sp_deref =3D remove # Add or remove space after = the '*' (dereference) unary operator. This does + # not affect the spacing after= a '*' that is part of a type. +sp_member =3D remove # Add or remove space around= the '.' or '->' operators. + +# 5.2.2.9 Do not put spaces before open brackets of array subscripts +sp_before_square =3D remove # Add or remove space before= '[' (except '[]'). +sp_before_squares =3D remove # Add or remove space before= '[]'. +sp_before_vardef_square =3D remove # Add or remove space before= '[' for a variable definition. + +# 5.2.2.10 Use extra parentheses rather than depending on in-depth knowled= ge of the order of precedence of C +mod_full_paren_if_bool =3D true # Whether to fully parenthes= ize Boolean expressions in 'while' and 'if' + # statement, as in 'if (a && b= > c)' =3D> 'if (a && (b > c))'. + +# 5.2.2.11 Align a continuation line with the part of the line that it con= tinues. +use_indent_continue_only_once =3D true + +# Additional '{}' bracing rules (Optional) +# NOTE - The style guide specifies two different styles for braces, +# so these are ignored for now to allow developers some flexibility. +nl_after_brace_close =3D true # Whether to add a newline a= fter '}'. Does not apply if followed by a + # necessary ';'. +nl_brace_else =3D remove # Add or remove newline betw= een '}' and 'else'. +nl_brace_while =3D remove # Add or remove newline betw= een '}' and 'while' of 'do' statement. +nl_do_brace =3D remove # Add or remove newline betw= een 'do' and '{'. +nl_else_brace =3D remove # Add or remove newline betw= een 'else' and '{'. +nl_else_if =3D remove # Add or remove newline betw= een 'else' and 'if'. +nl_elseif_brace =3D remove # Add or remove newline betw= een 'else if' and '{'. +nl_enum_brace =3D remove # Add or remove newline betw= een 'enum' and '{'. +nl_fcall_brace =3D remove # Add or remove newline betw= een a function call's ')' and '{', + # as in 'list_for_each(item, &= list) { }'. +nl_for_brace =3D remove # Add or remove newline betw= een 'for' and '{'. +nl_if_brace =3D remove # Add or remove newline betw= een 'if' and '{'. +nl_struct_brace =3D remove # Add or remove newline betw= een 'struct and '{'. +nl_switch_brace =3D remove # Add or remove newline betw= een 'switch' and '{'. +nl_union_brace =3D remove # Add or remove newline betw= een 'union' and '{'. +nl_while_brace =3D remove # Add or remove newline betw= een 'while' and '{'. + +# Additional whitespace rules (Optional) +sp_after_ptr_star =3D remove # Add or remove space after = pointer star '*', if followed by a word. + # Useful when paired with alig= n_var_def_star_style=3D=3D2 +sp_after_ptr_star_func =3D remove # Add or remove space after = a pointer star '*', if followed by a function + # prototype or function defini= tion. +sp_after_semi =3D remove # Add or remove space after = ';', except when followed by a comment. +sp_before_case_colon =3D remove # Add or remove space before= case ':'. +sp_before_ptr_star =3D add # Add or remove space before= pointer star '*'. +sp_before_ptr_star_func =3D add # Add or remove space before= a pointer star '*', if followed by a function + # prototype or function defini= tion. +sp_before_semi =3D remove # Add or remove space before= ';' +sp_before_semi_for =3D remove # Add or remove space before= ';' in non-empty 'for' statements. +sp_before_semi_for_empty =3D add # Add or remove space before= a semicolon of an empty part of a for statement +sp_between_ptr_star =3D remove # Add or remove space betwee= n pointer stars '*'. (ie, 'VOID **') +sp_brace_close_while =3D force # Add or remove space betwee= n '}' and 'while'. + +sp_after_cast =3D remove +sp_after_type =3D add +sp_balance_nested_parens =3D false +sp_before_nl_cont =3D add +sp_before_square_asm_block =3D ignore +sp_before_unnamed_byref =3D add +sp_brace_brace =3D ignore +sp_brace_else =3D force +sp_brace_typedef =3D add +sp_case_label =3D force +sp_cmt_cpp_doxygen =3D true +sp_cond_colon =3D add +sp_cond_question =3D add +sp_cpp_cast_paren =3D force +sp_else_brace =3D force +sp_endif_cmt =3D force +sp_enum_assign =3D add +sp_inside_braces =3D force +sp_inside_braces_empty =3D force +sp_inside_braces_enum =3D force +sp_inside_braces_struct =3D force +sp_pp_concat =3D add +sp_pp_stringify =3D add +sp_return_paren =3D add +sp_special_semi =3D force +sp_while_paren_open =3D force + +# Additional Indentation Rules +indent_access_spec =3D 1 +indent_access_spec_body =3D false +indent_align_assign =3D true +indent_align_string =3D true +indent_bool_paren =3D true +indent_brace_parent =3D false +indent_braces =3D false +indent_braces_no_class =3D false +indent_braces_no_func =3D true +indent_braces_no_struct =3D false +indent_class =3D false +indent_class_colon =3D false +indent_cmt_with_tabs =3D false # Whether to indent comm= ents that are not at a brace level with tabs on + # a tabstop. Requires inde= nt_with_tabs=3D2. If false, will use spaces. +indent_col1_comment =3D true +indent_col1_multi_string_literal=3D true +indent_comma_paren =3D true +indent_else_if =3D true +indent_extern =3D false +indent_first_bool_expr =3D true + +indent_func_def_param_paren_pos_threshold =3D 0 +indent_func_param_double =3D false +indent_func_proto_param =3D true +indent_ignore_asm_block =3D true +indent_label =3D 1 +indent_member =3D 2 +indent_namespace =3D false +indent_param =3D 2 +indent_paren_nl =3D false +indent_paren_open_brace =3D false +indent_preserve_sql =3D false +indent_relative_single_line_comments =3D false +indent_sing_line_comments =3D 0 +indent_single_newlines =3D false +indent_square_nl =3D false +indent_switch_case =3D 2 +indent_template_param =3D true +indent_var_def_blk =3D 0 +indent_var_def_cont =3D false + +# Tidy-up rules (Optional) +mod_move_case_break =3D true # Whether to move a 'break' = that appears after a fully braced 'case' + # before the close brace, as i= n 'case X: { ... } break;' =3D> + # 'case X: { ... break; }'. +mod_pawn_semicolon =3D false +mod_remove_empty_return =3D false # Whether to remove a void '= return;' that appears as the last statement + # in a function. +mod_remove_extra_semicolon =3D true +mod_sort_import =3D false +mod_sort_include =3D false +mod_sort_using =3D false +nl_after_case =3D false # Whether to add a newline a= fter a 'case' statement. +nl_end_of_file =3D force # Add or remove newline at t= he end of the file. +nl_end_of_file_min =3D 1 # The minimum number of newl= ines at the end of the file +nl_max =3D 2 # The maximum number of cons= ecutive newlines (3 =3D 2 blank lines). +nl_start_of_file =3D remove # Add or remove newlines at = the start of the file. + +# Code alignment rules (Optional) +align_asm_colon =3D false +align_assign_span =3D 1 # The span for aligning on '= =3D' in assignments. +align_assign_thresh =3D 4 +align_edk2_style =3D true # Whether to apply edk2-spec= ific alignment formatting +align_enum_equ_span =3D 1 # The span for aligning on '= =3D' in enums. +align_func_params =3D true # Whether to align variable = definitions in prototypes and functions. +align_func_params_gap =3D 2 +align_func_params_span =3D 2 # The span for aligning para= meter definitions in function on parameter name. +align_func_params_thresh =3D 0 +align_func_proto_span =3D 0 +align_keep_tabs =3D false +align_left_shift =3D false +align_mix_var_proto =3D false +align_nl_cont =3D false +align_oc_decl_colon =3D false +align_on_operator =3D false +align_on_tabstop =3D false +align_pp_define_gap =3D 2 +align_pp_define_span =3D 1 +align_right_cmt_at_col =3D 0 # Align trailing comment at = or beyond column N; 'pulls in' comments as + # a bonus side effect (0=3Dign= ore) +align_right_cmt_gap =3D 0 # If a trailing comment is m= ore than this number of columns away from the + # text it follows, + # it will qualify for being al= igned. This has to be > 0 to do anything. +align_right_cmt_mix =3D false # If aligning comments, mix = with comments after '}' and #endif with less + # than 3 spaces before the com= ment +align_right_cmt_same_level =3D true # Whether to only align trai= ling comments that are at the same brace level. +align_right_cmt_span =3D 2 # The span for aligning comm= ents that end lines. +align_same_func_call_params =3D false +align_single_line_brace =3D true +align_single_line_func =3D true +align_struct_init_span =3D 1 # The span for aligning stru= ct initializer values. +align_typedef_amp_style =3D 1 +align_typedef_func =3D 1 # How to align typedef'd fun= ctions with other typedefs. + # (0: No align, 1: Align open = paranthesis, 2: Align function type name) +align_typedef_gap =3D 2 +align_typedef_span =3D 1 # The span for aligning sing= le-line typedefs. +align_typedef_star_style =3D 1 +align_var_def_amp_style =3D 1 +align_var_def_attribute =3D true +align_var_def_colon =3D true # Whether to align the colon= in struct bit fields. +align_var_def_gap =3D 2 # The gap (minimum spacing f= or aligned items) for variable definitions. +align_var_def_inline =3D false +align_var_def_span =3D 1 # The span (lines needed to = align) for aligning variable definitions. +align_var_def_star_style =3D 1 # How to consider (or treat)= the '*' in the alignment of variable + # definitions. + # 0: Part of the type 'voi= d * foo;' (default) + # 1: Part of the variable 'voi= d *foo;' + # 2: Dangling 'voi= d *foo;' + # (Note - should also set sp_a= fter_ptr_star=3Dremove) +align_var_struct_gap =3D 4 +align_var_struct_span =3D 8 # The span for aligning stru= ct/union member definitions. +align_var_struct_thresh =3D 0 +align_with_tabs =3D false + +# Comment formatting +cmt_align_doxygen_javadoc_tags =3D true # Whether to align doxygen j= avadoc-style tags ('@param', '@return', etc.) + # TODO: Eats '[' in '[in]' +cmt_c_group =3D false +cmt_c_nl_end =3D true # Whether to add a newline b= efore the closing '*/' of the combined c-comment. +cmt_c_nl_start =3D true +cmt_cpp_group =3D false +cmt_cpp_nl_end =3D true +cmt_cpp_nl_start =3D true +cmt_cpp_to_c =3D false +cmt_indent_multi =3D false # Whether to apply changes t= o multi-line comments, including cmt_width, + # keyword substitution and lea= ding chars. +cmt_insert_before_preproc =3D false +#cmt_insert_file_header =3D default_file_header.txt +#cmt_insert_func_header =3D default_function_header.txt +cmt_multi_check_last =3D false +cmt_multi_first_len_minimum =3D 2 +cmt_reflow_mode =3D 1 # How to reflow comments. + # (0:No reflow, 1:No touching = at all, 2: Full reflow) +cmt_sp_after_star_cont =3D 0 # The number of spaces to in= sert after the star on subsequent comment lines. +cmt_sp_before_star_cont =3D 0 # The number of spaces to in= sert at the start of subsequent comment lines. +cmt_star_cont =3D false # Whether to put a star on s= ubsequent comment lines. +cmt_width =3D 120 # Try to wrap comments at N = columns. +sp_cmt_cpp_start =3D add # Add or remove space after = the opening of a C++ comment, as in + # '// A'. NOTE: Breaks= indentation within comments. + +# Function definitions / declarations +indent_func_call_param =3D false # Whether to indent continue= d function call parameters one indent level, + # rather than aligning paramet= ers under the open parenthesis. +indent_func_class_param =3D false # Whether to indent continue= d function call declaration one indent level, + # rather than aligning paramet= ers under the open parenthesis. +indent_func_ctor_var_param =3D false # Whether to indent continue= d class variable constructors one indent level, + # rather than aligning paramet= ers under the open parenthesis. +indent_func_def_param =3D true # Whether to indent continue= d function definition parameters one indent + # level, rather than aligning = parameters under the open parenthesis. +nl_fdef_brace =3D add # Add or remove newline betw= een function signature and '{'. +nl_func_call_end_multi_line =3D true # Whether to add a newline b= efore ')' in a function call if '(' and ')' are + # in different lines. +nl_func_call_paren =3D remove # Add or remove newline betw= een a function name and the opening '(' in the + # call. +nl_func_call_start_multi_line =3D true # Whether to add a newline a= fter '(' in a function call if '(' and ')' are + # in different lines. +nl_func_decl_args =3D force # Add or remove newline afte= r each ',' in a function declaration. +nl_func_decl_empty =3D add # Add or remove newline betw= een '()' in a function declaration. +nl_func_def_args =3D force # Add or remove newline afte= r each ',' in a function definition. +nl_func_def_empty =3D add # Add or remove newline betw= een '()' in a function definition. +nl_func_def_paren =3D remove # Add or remove newline betw= een a function name and the opening '(' + # in the definition. +nl_func_paren =3D remove # Add or remove newline betw= een a function name and the opening '(' in + # the declaration. +nl_func_type_name =3D add # Add or remove newline betw= een return type and function name in a function + # definition. +sp_fparen_brace =3D force # Add or remove space betwee= n ')' and '{' of function. +use_indent_func_call_param =3D true # indent_func_call_param wil= l be used + +# Additional Newline Rules +nl_after_brace_open =3D true # Whether to add= a newline after '{'. This also adds a newline + # before the match= ing '}'. +nl_after_brace_open_cmt =3D true # Whether to add= a newline between the open brace and a + # trailing single-= line comment. + # Requires nl_afte= r_brace_open =3D true. +nl_after_do =3D add # Add or remove = blank line after 'do/while' statement. +nl_after_for =3D add # Add or remove = blank line after 'for' statement. +nl_after_func_body =3D 2 # The number of = newlines after '}' of a multi-line function body +nl_after_func_body_one_liner =3D 2 +nl_after_func_proto =3D 2 +nl_after_func_proto_group =3D 2 +nl_after_if =3D add +nl_after_multiline_comment =3D false +nl_after_return =3D false +nl_after_struct =3D 2 +nl_after_switch =3D add +nl_after_vbrace_close =3D true +nl_after_vbrace_open =3D true +nl_after_vbrace_open_empty =3D true +nl_after_while =3D add +nl_assign_leave_one_liners =3D true +nl_before_block_comment =3D 2 +nl_before_case =3D false +nl_before_do =3D ignore +nl_before_for =3D ignore +nl_before_if =3D ignore +nl_before_switch =3D ignore +nl_before_while =3D ignore +nl_before_whole_file_ifdef =3D 2 +nl_brace_brace =3D force +nl_brace_struct_var =3D remove +nl_case_colon_brace =3D add +nl_class_leave_one_liners =3D false +nl_collapse_empty_body =3D false +nl_comment_func_def =3D 1 +nl_create_for_one_liner =3D false +nl_create_if_one_liner =3D false +nl_create_while_one_liner =3D false +nl_define_macro =3D false +nl_ds_struct_enum_close_brace =3D true +nl_ds_struct_enum_cmt =3D false +nl_enum_leave_one_liners =3D false +nl_func_decl_end =3D add +nl_func_decl_start =3D add +nl_func_def_end =3D add +nl_func_def_start =3D add +nl_func_leave_one_liners =3D false +nl_func_proto_type_name =3D add +nl_func_var_def_blk =3D 1 +nl_getset_leave_one_liners =3D false +nl_if_leave_one_liners =3D false +nl_multi_line_define =3D false +nl_squeeze_ifdef =3D false +nl_var_def_blk_end =3D 0 +nl_var_def_blk_start =3D 0 + +# Preprocessor Rules +pp_define_at_level =3D true +pp_if_indent_code =3D false +pp_indent_func_def =3D false +pp_indent_extern =3D false +pp_ignore_define_body =3D true # Workaround: Turn off pro= cessing for #define body + # (current rules do not work= for some defines) +pp_indent =3D add +pp_indent_at_level =3D true +pp_indent_count =3D 2 +pp_indent_if =3D 2 +pp_indent_region =3D 2 +pp_region_indent_code =3D false +pp_space =3D remove + +# +# The tokens below are assigned specific types so they are always recogniz= ed properly. +# + +# Explicitly define EDK II qualifiers +set QUALIFIER CONST +set QUALIFIER EFIAPI +set QUALIFIER IN +set QUALIFIER OPTIONAL +set QUALIFIER OUT + +# Explicitly define EDK II types +set TYPE EFI_STATUS +set TYPE VOID diff --git a/.pytool/Plugin/UncrustifyCheck/uncrustify_ext_dep.yaml b/.pyto= ol/Plugin/UncrustifyCheck/uncrustify_ext_dep.yaml new file mode 100644 index 000000000000..d8c22403b4b1 --- /dev/null +++ b/.pytool/Plugin/UncrustifyCheck/uncrustify_ext_dep.yaml @@ -0,0 +1,16 @@ +## @file +# Downloads the Uncrustify application from a Project Mu NuGet package. +# +# Copyright (c) Microsoft Corporation. +# SPDX-License-Identifier: BSD-2-Clause-Patent +## +{ + "id": "uncrustify-ci-1", + "scope": "cibuild", + "type": "nuget", + "name": "mu-uncrustify-release", + "source": "https://nam06.safelinks.protection.outlook.com/?url=3Dhttps%3= A%2F%2Fpkgs.dev.azure.com%2Fprojectmu%2FUncrustify%2F_packaging%2Fmu_uncrus= tify%2Fnuget%2Fv3%2Findex.json&data=3D04%7C01%7CBret.Barkelew%40microso= ft.com%7Cccfe5bfffa354589afb308d9afaddcc3%7C72f988bf86f141af91ab2d7cd011db4= 7%7C1%7C0%7C637733983563562870%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAi= LCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=3D98mGcyUQH= SPBuYACxle%2BLOqIdKwKWrVTm1DOynzDaSs%3D&reserved=3D0", + "version": "73.0.3", + "flags": ["set_shell_var", "host_specific"], + "var_name": "UNCRUSTIFY_CI_PATH" +} diff --git a/.pytool/Plugin/UncrustifyCheck/uncrustify_plug_in.yaml b/.pyto= ol/Plugin/UncrustifyCheck/uncrustify_plug_in.yaml new file mode 100644 index 000000000000..06c76af02759 --- /dev/null +++ b/.pytool/Plugin/UncrustifyCheck/uncrustify_plug_in.yaml @@ -0,0 +1,11 @@ +## @file +# CiBuildPlugin used to check coding standard compliance of EDK II style C= source code +# +# Copyright (c) Microsoft Corporation. +# SPDX-License-Identifier: BSD-2-Clause-Patent +## +{ + "scope": "cibuild", + "name": "Uncrustify Coding Standard Test", + "module": "UncrustifyCheck" +} diff --git a/.pytool/Readme.md b/.pytool/Readme.md index f6505507966a..e0d07f317049 100644 --- a/.pytool/Readme.md +++ b/.pytool/Readme.md @@ -264,6 +264,10 @@ BSD-2-Clause-Patent. Run the Ecc tool on the package. The Ecc tool is available in the BaseTool= s package. It checks that the code complies to the EDKII coding standard. +### Coding Standard Compliance - UncrustifyCheck + +Runs the Uncrustify application to check for coding standard compliance is= sues. + ## PyTool Scopes Scopes are how the PyTool ext_dep, path_env, and plugins are activated. M= eaning -- 2.28.0.windows.1 --_000_MW4PR21MB19076D07A1A80DBDA33C3201EF649MW4PR21MB1907namp_ Content-Type: text/html; charset="us-ascii" Content-Transfer-Encoding: quoted-printable

Reviewed-by: Bret Barkelew <bret.barkelew@microso= ft.com>

 

- Bret

 

From: mikuback@linux.microsoft.com=
Sent: Wednesday, November 24, 2021 4:52 PM
To: devel@edk2.groups.io=
Cc: Kinney, Michael D<= /a>; Liming Gao; Sean Brogan; Bret Barkelew
Subject: [PATCH v5 1/1] .pytool/Plugin/UncrustifyCheck: Add Uncrusti= fy CI plugin

 

From: Michael Kubacki= <michael.kubacki@microsoft.com>

REF:https://nam06.safelinks.protection.outlook.com/?url=3Dhttps%3A%2F%2Fbug= zilla.tianocore.org%2Fshow_bug.cgi%3Fid%3D3748&amp;data=3D04%7C01%7CBre= t.Barkelew%40microsoft.com%7Cccfe5bfffa354589afb308d9afaddcc3%7C72f988bf86f= 141af91ab2d7cd011db47%7C1%7C0%7C637733983563562870%7CUnknown%7CTWFpbGZsb3d8= eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&a= mp;amp;sdata=3Ds4fnIyCIL8NTcjwaboh7Nb23EqqTwM83wd9BNdLe%2Bdo%3D&amp;res= erved=3D0

Adds a new CI plugin for Uncrustify. This is used to check
coding standard compliance of source code to the EDK II C Coding
Standards Specification.

An external dependency is added in the plugin directory to retrieve
the Uncrustify executable. Currently, the executable is from an edk2
fork of the application host in this repository:

https://nam06.safelinks.protection.outlook.com/?url=3Dhttps%3A%2F%2= Fdev.azure.com%2Fprojectmu%2FUncrustify%2F&amp;data=3D04%7C01%7CBret.Ba= rkelew%40microsoft.com%7Cccfe5bfffa354589afb308d9afaddcc3%7C72f988bf86f141a= f91ab2d7cd011db47%7C1%7C0%7C637733983563562870%7CUnknown%7CTWFpbGZsb3d8eyJW= IjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&a= mp;sdata=3DC66K4wDVoQFKviSvVWsY9WAzDCbEYj8q8Ru26TQdwoI%3D&amp;reserved= =3D0

Note that the Uncrustify application outputs the commit ID that the
application was built from when given the --version parameter.

This ID can be mapped to the version specified in the Uncrustify CI
plugin external dependency file (uncrustify_ext_dep.yaml) such as
73.0.3 by visiting the Uncrustify edk2 fork release pipeline page
which associates the NuGet package version with the commit ID it was
built from:

https://nam06.safelinks.protection.outlook.com/?url=3Dhtt= ps%3A%2F%2Fdev.azure.com%2Fprojectmu%2FUncrustify%2F_build&amp;data=3D0= 4%7C01%7CBret.Barkelew%40microsoft.com%7Cccfe5bfffa354589afb308d9afaddcc3%7= C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637733983563562870%7CUnknown%7C= TWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0= %3D%7C3000&amp;sdata=3DWEgFY0wLhjdNYHdO6m7uu%2B%2FE58vX8JFN2npYZeSt0b4%= 3D&amp;reserved=3D0

The default Uncrustify configuration files are added in the plugin
directory. Additional details are in the Readme.md file added in
the Uncrustify plugin directory.

Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Bret Barkelew <Bret.Barkelew@microsoft.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
---

Notes:
    V5 changes:
   
    1. Disable (comment out the setting in the Uncrustify co= nfig file)
       for file and function header templates= due to the large number
       of failures that will take time to res= olve.
   
       These settings can be enabled in the f= uture after packages are
       updated to not fail the check.
   
    V4 changes:
   
    1. Updated commit subject to use the new plugin name.     2. Enabled file and function header templates to be plac= ed in
       files missing a file or function heade= r (comment block).
    3. Added support to detect whether a file header or func= tion
       header is missing in a file by searchi= ng files modified by
       Uncrustify for the template file text.=
    4. Updated the plugin name displayed in some log output = messages.
   
    V3 changes:
   
    1. Renamed the CI plugin to "UncrustifyCheck" = from "Uncrustify"
       to follow similar naming conventions u= sed in other plugins
       that check files
    2. Added a clarifying paragraph to the beginning of the = Uncrustify
       CI plugin Readme.md file that the plug= in is enabled by default
       and test results can be ignored by ena= bling "AuditOnly" mode.
    3. Added instructions in the commit message on how to ma= p the
       version reported by the Uncrustify app= lication (--version) to
       the version specified in the CI plugin= external dependency
       YAML file.
   
    V2 changes:
   
    1. Changed plugin temp directory to Build/.pytool/Plugin= /Uncrustify
    2. Added TCBZ REF in patch commit message

 .pytool/Plugin/UncrustifyCheck/Readme.md     = ;            &n= bsp; | 120 ++++
 .pytool/Plugin/UncrustifyCheck/UncrustifyCheck.py   &n= bsp;      | 617 ++++++++++++++++++++
 .pytool/Plugin/UncrustifyCheck/default_file_header.txt  &nb= sp;  |   9 +
 .pytool/Plugin/UncrustifyCheck/default_function_header.txt |  15= +
 .pytool/Plugin/UncrustifyCheck/uncrustify.cfg    =           | 462 ++++++++++++++= +
 .pytool/Plugin/UncrustifyCheck/uncrustify_ext_dep.yaml  &nb= sp;  |  16 +
 .pytool/Plugin/UncrustifyCheck/uncrustify_plug_in.yaml  &nb= sp;  |  11 +
 .pytool/Readme.md        &nbs= p;            &= nbsp;           &nbs= p;        |   4 +
 8 files changed, 1254 insertions(+)

diff --git a/.pytool/Plugin/UncrustifyCheck/Readme.md b/.pytool/Plugin/Uncr= ustifyCheck/Readme.md
new file mode 100644
index 000000000000..bb263bcc87d7
--- /dev/null
+++ b/.pytool/Plugin/UncrustifyCheck/Readme.md
@@ -0,0 +1,120 @@
+# UncrustifyCheck Plugin
+
+This CiBuildPlugin scans all the files in a given package and checks for c= oding standard compliance issues.
+
+This plugin is enabled by default. If a package would like to prevent the = plugin from reporting errors, it can do
+so by enabling [`AuditOnly`](#auditonly) mode.
+
+This plugin requires the directory containing the Uncrustify executable th= at should be used for this plugin to
+be specified in an environment variable named `UNCRUSTIFY_CI_PATH`. This u= nique variable name is used to avoid confusion
+with other paths to Uncrustify which might not be the expected build for u= se by this plugin.
+
+By default, an Uncrustify configuration file named "uncrustify.cfg&qu= ot; located in the same directory as the plugin is
+used. The value can be overridden to a package-specific path with the `Con= figFilePath` configuration file option.
+
+* Uncrustify source code and documentation: https://nam06.safelinks.protection.outlook.com/?url=3Dhttps%3A%2F%2Fgithub.= com%2Funcrustify%2Funcrustify&amp;data=3D04%7C01%7CBret.Barkelew%40micr= osoft.com%7Cccfe5bfffa354589afb308d9afaddcc3%7C72f988bf86f141af91ab2d7cd011= db47%7C1%7C0%7C637733983563562870%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwM= DAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&amp;sdata=3DxI= kDRtWWVcN0%2BesJ%2B0gqT4bWoGkkdMBotBb8H8TSk5U%3D&amp;reserved=3D0 +* Project Mu Uncrustify fork source code and documentation: https://nam06.safelinks.protection.outlook.com/?url=3Dhttps%3A%2F%2Fdev.azu= re.com%2Fprojectmu%2FUncrustify&amp;data=3D04%7C01%7CBret.Barkelew%40mi= crosoft.com%7Cccfe5bfffa354589afb308d9afaddcc3%7C72f988bf86f141af91ab2d7cd0= 11db47%7C1%7C0%7C637733983563562870%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjA= wMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&amp;sdata=3D= M0vWXls8JO6uHUwJAprS94eVOWD219C%2BzvHBq68YhhY%3D&amp;reserved=3D0 +
+## Files Checked in a Package
+
+By default, this plugin will discover all files in the package with the fo= llowing default paths:
+
+```python
+[
+# C source
+"*.c",
+"*.h"
+]
+```
+
+From this list of files, any files ignored by Git or residing in a Git sub= module will be removed. If Git is not
+found, submodules are not found, or ignored files are not found no changes= are made to the list of discovered files.
+
+To control the paths checked in a given package, review the configuration = options described in this file.
+
+## Configuration
+
+The plugin can be configured with a few optional configuration options. +
+``` yaml
+  "UncrustifyCheck": {
+      "AdditionalIncludePaths": [], # A= dditional paths to check formatting (wildcards supported).
+      "AuditOnly": False,  &n= bsp;        # Don't fail the build if th= ere are errors.  Just log them.
+      "ConfigFilePath": "",&n= bsp;        # Custom path to an Uncrusti= fy config file.
+      "IgnoreStandardPaths": [], &= nbsp;  # Standard Plugin defined paths that should be ignored.
+      "OutputFileDiffs": False, &n= bsp;   # Output chunks of formatting diffs in the test case log.<= br> +            &n= bsp;            = ;           # This can si= gnificantly slow down the plugin on very large packages.
+      "SkipGitExclusions": False &= nbsp;  # Don't exclude git ignored files and files in git submodules.<= br> +  }
+```
+
+### `AdditionalIncludePaths`
+
+A package configuration file can specify any additional paths to be includ= ed with this option.
+
+At this time, it is recommended all files run against the plugin be writte= n in the C or C++ language.
+
+### `AuditOnly`
+
+`Boolean` - Default is `False`.
+
+If `True`, run the test in an "audit only mode" which will log a= ll errors but instead of failing the build, it will set
+the test as skipped. This allows visibility into the failures without brea= king the build.
+
+### `ConfigFilePath`
+
+`String` - Default is `"uncrustify.cfg"`
+
+When specified in the config file, this is a package relative path to the = Uncrustify configuration file.
+
+### `IgnoreStandardPaths`
+
+This plugin by default will check the below standard paths. A package conf= iguration file can specify any of these paths
+to be ignored.
+
+```python
+[
+# C source
+"*.c",
+"*.h"
+]
+```
+
+### `OutputFileDiffs`
+
+`Boolean` - Default is `False`.
+
+If `True`, output diffs of formatting changes into the test case log. This= is helpful to exactly understand what changes
+need to be made to the source code in order to fix a coding standard compl= iance issue.
+
+Note that calculating the file diffs on a very large set of of results (e.= g. >100 files) can significantly slow down
+plugin execution.
+
+### `SkipGitExclusions`
+
+`Boolean` - Default is `False`.
+
+By default, files in paths matched in a .gitignore file or a recognized gi= t submodule are excluded. If this option
+is `True`, the plugin will not attempt to recognize these files and exclud= e them.
+
+## High-Level Plugin Operation
+
+This plugin generates two main sets of temporary files:
+
+  1. A working directory in the directory `Build/.pytool/Plugin/Uncru= stify`
+  2. For each source file with formatting errors, a sibling file with= the `.uncrustify_plugin` extension
+
+The working directory contains temporary files unique to operation of the = plugin. All of these files are removed on
+exit of the plugin including successful or unsuccessful execution (such as= a Python exception occurring). If for any
+reason, any files in the package exist prior to running the plugin with th= e `.uncrustify_plugin` extension, the plugin
+will inform the user to remove these files and exit before running Uncrust= ify. This is to ensure the accuracy of the
+results reported from each execution instance of the plugin.
+
+The plugin determines the list of relevant files to check with Uncrustify = and then invokes Uncrustify with that file
+list. For any files not compliant to the configuration file provided, Uncr= ustify will generate a corresponding file
+with the `.uncrustify_plugin` extension. The plugin discovers all of these= files. If any such files are present, this
+indicates a formatting issue was found and the test is marked failed (unle= ss `AuditOnly` mode is enabled).
+
+The test case log will contain a report of which files failed to format pr= operly, allowing the user to run Uncrustify
+against the file locally to fix the issue. If the `OutputFileDiffs` config= uration option is set to `True`, the plugin
+will output diff chunks for all code formatting issues in the test case lo= g.
diff --git a/.pytool/Plugin/UncrustifyCheck/UncrustifyCheck.py b/.pytool/Pl= ugin/UncrustifyCheck/UncrustifyCheck.py
new file mode 100644
index 000000000000..59534469a2d3
--- /dev/null
+++ b/.pytool/Plugin/UncrustifyCheck/UncrustifyCheck.py
@@ -0,0 +1,617 @@
+# @file UncrustifyCheck.py
+#
+# An edk2-pytool based plugin wrapper for Uncrustify
+#
+# Copyright (c) Microsoft Corporation.
+# SPDX-License-Identifier: BSD-2-Clause-Patent
+##
+import configparser
+import difflib
+import errno
+import logging
+import os
+import pathlib
+import shutil
+import timeit
+from edk2toolext.environment import version_aggregator
+from edk2toolext.environment.plugin_manager import PluginManager
+from edk2toolext.environment.plugintypes.ci_build_plugin import ICiBuildPl= ugin
+from edk2toolext.environment.plugintypes.uefi_helper_plugin import HelperF= unctions
+from edk2toolext.environment.var_dict import VarDict
+from edk2toollib.log.junit_report_format import JunitReportTestCase
+from edk2toollib.uefi.edk2.path_utilities import Edk2Path
+from edk2toollib.utility_functions import  RunCmd
+from io import StringIO
+from typing import Any, Dict, List, Tuple
+
+#
+# Provide more user friendly messages for certain scenarios
+#
+class UncrustifyException(Exception):
+    def __init__(self, message, exit_code):
+        super().__init__(message)
+        self.exit_code =3D exit_code +
+
+class UncrustifyAppEnvVarNotFoundException(UncrustifyException):
+    def __init__(self, message):
+        super().__init__(message, -101)=
+
+
+class UncrustifyAppVersionErrorException(UncrustifyException):
+    def __init__(self, message):
+        super().__init__(message, -102)=
+
+
+class UncrustifyAppExecutionException(UncrustifyException):
+    def __init__(self, message):
+        super().__init__(message, -103)=
+
+
+class UncrustifyStalePluginFormattedFilesException(UncrustifyException): +    def __init__(self, message):
+        super().__init__(message, -120)=
+
+
+class UncrustifyInputFileCreationErrorException(UncrustifyException):
+    def __init__(self, message):
+        super().__init__(message, -121)=
+
+class UncrustifyInvalidIgnoreStandardPathsException(UncrustifyException):<= br> +    def __init__(self, message):
+        super().__init__(message, -122)=
+
+class UncrustifyGitIgnoreFileException(UncrustifyException):
+    def __init__(self, message):
+        super().__init__(message, -140)=
+
+
+class UncrustifyGitSubmoduleException(UncrustifyException):
+    def __init__(self, message):
+        super().__init__(message, -141)=
+
+
+class UncrustifyCheck(ICiBuildPlugin):
+    """
+    A CiBuildPlugin that uses Uncrustify to check the sourc= e files in the
+    package being tested for coding standard issues.
+
+    By default, the plugin runs against standard C source f= ile extensions but
+    its configuration can be modified through its configura= tion file.
+
+    Configuration options:
+    "UncrustifyCheck": {
+        "AdditionalIncludePaths&qu= ot;: [], # Additional paths to check formatting (wildcards supported).
+        "AuditOnly": False,&n= bsp;          # Don't fail the= build if there are errors.  Just log them.
+        "ConfigFilePath": &qu= ot;",         # Custom path to= an Uncrustify config file.
+        "IgnoreStandardPaths"= : [],    # Standard Plugin defined paths that should be igno= red.
+        "OutputFileDiffs": Fa= lse,     # Output chunks of formatting diffs in the tes= t case log.
+            &n= bsp;            = ;             #= This can significantly slow down the plugin on very large packages.
+        "SkipGitExclusions": = False    # Don't exclude git ignored files and files in git = submodules.
+    }
+    """
+
+    #
+    # By default, use an "uncrustify.cfg" config = file in the plugin directory
+    # A package can override this path via "ConfigFile= Path"
+    #
+    # Note: Values specified via "ConfigFilePath"= are relative to the package
+    #
+    DEFAULT_CONFIG_FILE_PATH =3D os.path.join(
+        pathlib.Path(__file__).parent.r= esolve(), "uncrustify.cfg")
+
+    #
+    # The extension used for formatted files produced by th= is plugin
+    #
+    FORMATTED_FILE_EXTENSION =3D ".uncrustify_plugin&q= uot;
+
+    #
+    # A package can add any additional paths with "Add= itionalIncludePaths"
+    # A package can remove any of these paths with "Ig= noreStandardPaths"
+    #
+    STANDARD_PLUGIN_DEFINED_PATHS =3D ("*.c", &qu= ot;*.h")
+
+    #
+    # The Uncrustify application path should set in this en= vironment variable
+    #
+    UNCRUSTIFY_PATH_ENV_KEY =3D "UNCRUSTIFY_CI_PATH&qu= ot;
+
+    def GetTestName(self, packagename: str, environment: Va= rDict) -> Tuple:
+        """ Provide the = testcase name and classname for use in reporting
+
+            Args: +            &n= bsp; packagename: string containing name of package to build
+            &n= bsp; environment: The VarDict for the test to run in
+            Returns= :
+            &n= bsp;   A tuple containing the testcase name and the classname
+            &n= bsp;   (testcasename, classname)
+            &n= bsp;   testclassname: a descriptive string for the testcase can i= nclude whitespace
+            &n= bsp;   classname: should be patterned <packagename>.<plu= gin>.<optionally any unique condition>
+        """
+        return ("Check file coding= standard compliance in " + packagename, packagename + ".Uncrusti= fyCheck")
+
+    def RunBuildPlugin(self, package_rel_path: str, edk2_pa= th: Edk2Path, package_config: Dict[str, List[str]], environment_config: Any= , plugin_manager: PluginManager, plugin_manager_helper: HelperFunctions, tc= : JunitReportTestCase, output_stream=3DNone) -> int:
+        """
+        External function of plugin. Th= is function is used to perform the task of the CiBuild Plugin.
+
+        Args:
+          - package_rel_path:= edk2 workspace relative path to the package
+          - edk2_path: Edk2Pa= th object with workspace and packages paths
+          - package_config: D= ictionary with the package configuration
+          - environment_confi= g: Environment configuration
+          - plugin_manager: P= lugin Manager Instance
+          - plugin_manager_he= lper: Plugin Manager Helper Instance
+          - tc: JUnit test ca= se
+          - output_stream: Th= e StringIO output stream from this plugin (logging)
+
+        Returns
+          >0 : Number of e= rrors found
+          0  : Passed su= ccessfully
+          -1 : Skipped for mi= ssing prereq
+        """
+        try:
+            # Initi= alize plugin and check pre-requisites.
+            self._i= nitialize_environment_info(
+            &n= bsp;   package_rel_path, edk2_path, package_config, tc)
+            self._i= nitialize_configuration()
+            self._c= heck_for_preexisting_formatted_files()
+
+            # Log i= mportant context information.
+            self._l= og_uncrustify_app_info()
+
+            # Get t= emplate file contents if specified
+            self._g= et_template_file_contents()
+
+            # Creat= e meta input files & directories
+            self._c= reate_temp_working_directory()
+            self._c= reate_uncrustify_file_list_file()
+
+            self._r= un_uncrustify()
+
+            # Post-= execution actions.
+            self._p= rocess_uncrustify_results()
+
+        except UncrustifyException as e= :
+            self._t= c.LogStdError(
+            &n= bsp;   f"Uncrustify error {e.exit_code}. Details:\n\n{str(e)= }")
+            logging= .warning(
+            &n= bsp;   f"Uncrustify error {e.exit_code}. Details:\n\n{str(e)= }")
+            return = -1
+        else:
+            if self= ._formatted_file_error_count > 0:
+            &n= bsp;   if self._audit_only_mode:
+            &n= bsp;       logging.info(
+            &n= bsp;           "Sett= ing test as skipped since AuditOnly is enabled")
+            &n= bsp;       self._tc.SetSkipped()
+            &n= bsp;       return -1
+            &n= bsp;   else:
+            &n= bsp;       self._tc.SetFailed(
+            &n= bsp;           f"{se= lf._plugin_name} failed due to {self._formatted_file_error_count} incorrect= ly formatted files.", "CHECK_FAILED")
+            else: +            &n= bsp;   self._tc.SetSuccess()
+            return = self._formatted_file_error_count
+        finally:
+            self._c= leanup_temporary_formatted_files()
+            self._c= leanup_temporary_directory()
+
+    def _initialize_configuration(self) -> None:
+        """
+        Initializes plugin configuratio= n.
+        """
+        self._initialize_app_info()
+        self._initialize_config_file_in= fo()
+        self._initialize_file_to_format= _info()
+        self._initialize_test_case_outp= ut_options()
+
+    def _check_for_preexisting_formatted_files(self) -> = None:
+        """
+        Checks if any formatted files f= rom prior execution are present.
+
+        Existence of such files is an u= nexpected condition. This might result
+        from an error that occurred dur= ing a previous run or a premature exit from a debug scenario. In any case, = the package should be clean before starting a new run.
+        """
+        pre_existing_formatted_file_cou= nt =3D len(
+            [str(pa= th.resolve()) for path in pathlib.Path(self._abs_package_path).rglob(f'*{Un= crustifyCheck.FORMATTED_FILE_EXTENSION}')])
+
+        if pre_existing_formatted_file_= count > 0:
+            raise U= ncrustifyStalePluginFormattedFilesException(
+            &n= bsp;   f"{pre_existing_formatted_file_count} formatted files= already exist. To prevent overwriting these files, please remove them befo= re running this plugin.")
+
+    def _cleanup_temporary_directory(self) -> None:
+        """
+        Cleans up the temporary directo= ry used for this execution instance.
+
+        This removes the directory and = all files created during this instance.
+        """
+        if hasattr(self, '_working_dir'= ):
+            self._r= emove_tree(self._working_dir)
+
+    def _cleanup_temporary_formatted_files(self) -> None= :
+        """
+        Cleans up the temporary formmat= ted files produced by Uncrustify.
+
+        This will recursively remove al= l formatted files generated by Uncrustify
+        during this execution instance.=
+        """
+        if hasattr(self, '_abs_package_= path'):
+            formatt= ed_files =3D [str(path.resolve()) for path in pathlib.Path(
+            &n= bsp;   self._abs_package_path).rglob(f'*{UncrustifyCheck.FORMATTE= D_FILE_EXTENSION}')]
+
+            for for= matted_file in formatted_files:
+            &n= bsp;   os.remove(formatted_file)
+
+    def _create_temp_working_directory(self) -> None: +        """
+        Creates the temporary directory= used for this execution instance.
+        """
+        self._working_dir =3D os.path.j= oin(
+            self._a= bs_workspace_path, "Build", ".pytool", "Plugin&quo= t;, f"{self._plugin_name}")
+
+        try:
+            pathlib= .Path(self._working_dir).mkdir(parents=3DTrue, exist_ok=3DTrue)
+        except OSError as e:
+            raise U= ncrustifyInputFileCreationErrorException(
+            &n= bsp;   f"Error creating plugin directory {self._working_dir}= .\n\n{repr(e)}.")
+
+    def _create_uncrustify_file_list_file(self) -> None:=
+        """
+        Creates the file with the list = of source files for Uncrustify to process.
+        """
+        self._app_input_file_path =3D o= s.path.join(
+            self._w= orking_dir, "uncrustify_file_list.txt")
+
+        with open(self._app_input_file_= path, 'w', encoding=3D'utf8') as f:
+            f.write= lines(f"\n".join(self._abs_file_paths_to_format))
+
+    def _execute_uncrustify(self) -> None:
+        """
+        Executes Uncrustify with the in= itialized configuration.
+        """
+        output =3D StringIO()
+        self._app_exit_code =3D RunCmd(=
+            self._a= pp_path,
+            f"= -c {self._app_config_file} -F {self._app_input_file_path} --if-changed --su= ffix {UncrustifyCheck.FORMATTED_FILE_EXTENSION}", outstream=3Doutput)<= br> +        self._app_output =3D output.get= value().strip().splitlines()
+
+    def _get_git_ignored_paths(self) -> List[str]:
+        """"
+        Returns a list of file absolute= path strings to all files ignored in this git repository.
+
+        If git is not found, an empty l= ist will be returned.
+        """
+        if not shutil.which("git&q= uot;):
+            logging= .warn(
+            &n= bsp;   "Git is not found on this system. Git submodule paths= will not be considered.")
+            return = []
+
+        outstream_buffer =3D StringIO()=
+        exit_code =3D RunCmd("git&= quot;, "ls-files --other",
+            &n= bsp;            = ;  workingdir=3Dself._abs_workspace_path, outstream=3Doutstream_buffer= , logging_level=3Dlogging.NOTSET)
+        if (exit_code !=3D 0):
+            raise U= ncrustifyGitIgnoreFileException(
+            &n= bsp;   f"An error occurred reading git ignore settings. This= will prevent Uncrustify from running against the expected set of files.&qu= ot;)
+
+        # Note: This will potentially b= e a large list, but at least sorted
+        return outstream_buffer.getvalu= e().strip().splitlines()
+
+    def _get_git_submodule_paths(self) -> List[str]:
+        """
+        Returns a list of directory abs= olute path strings to the root of each submodule in the workspace repositor= y.
+
+        If git is not found, an empty l= ist will be returned.
+        """
+        if not shutil.which("git&q= uot;):
+            logging= .warn(
+            &n= bsp;   "Git is not found on this system. Git submodule paths= will not be considered.")
+            return = []
+
+        if os.path.isfile(os.path.join(= self._abs_workspace_path, ".gitmodules")):
+            logging= .info(
+            &n= bsp;   f".gitmodules file found. Excluding submodules in {se= lf._package_name}.")
+
+            outstre= am_buffer =3D StringIO()
+            exit_co= de =3D RunCmd("git", "config --file .gitmodules --get-regexp= path", workingdir=3Dself._abs_workspace_path, outstream=3Doutstream_b= uffer, logging_level=3Dlogging.NOTSET)
+            if (exi= t_code !=3D 0):
+            &n= bsp;   raise UncrustifyGitSubmoduleException(
+            &n= bsp;       f".gitmodule file detected bu= t an error occurred reading the file. Cannot proceed with unknown submodule= paths.")
+
+            submodu= le_paths =3D []
+            for lin= e in outstream_buffer.getvalue().strip().splitlines():
+            &n= bsp;   submodule_paths.append(
+            &n= bsp;       os.path.normpath(os.path.join(self= ._abs_workspace_path, line.split()[1])))
+
+            return = submodule_paths
+        else:
+            return = []
+
+    def _get_template_file_contents(self) -> None:
+        """
+        Gets the contents of Uncrustify= template files if they are specified
+        in the Uncrustify configuration= file.
+        """
+
+        self._file_template_contents = =3D None
+        self._func_template_contents = =3D None
+
+        # Allow no value to allow "= ;set" statements in the config file which do
+        # not specify value assignment<= br> +        parser =3D configparser.ConfigP= arser(allow_no_value=3DTrue)
+        with open(self._app_config_file= , 'r') as cf:
+            parser.= read_string("[dummy_section]\n" + cf.read())
+
+        try:
+            file_te= mplate_name =3D parser["dummy_section"]["cmt_insert_file_hea= der"]
+
+            file_te= mplate_path =3D pathlib.Path(file_template_name)
+
+            if not = file_template_path.is_file():
+            &n= bsp;   file_template_path =3D pathlib.Path(os.path.join(self._plu= gin_path, file_template_name))
+            &n= bsp;   self._file_template_contents =3D file_template_path.read_t= ext()
+        except KeyError:
+            logging= .warn("A file header template is not specified in the config file.&quo= t;)
+        except FileNotFoundError:
+            logging= .warn("The specified file header template file was not found.") +        try:
+            func_te= mplate_name =3D parser["dummy_section"]["cmt_insert_func_hea= der"]
+
+            func_te= mplate_path =3D pathlib.Path(func_template_name)
+
+            if not = func_template_path.is_file():
+            &n= bsp;   func_template_path =3D pathlib.Path(os.path.join(self._plu= gin_path, func_template_name))
+            &n= bsp;   self._func_template_contents =3D func_template_path.read_t= ext()
+        except KeyError:
+            logging= .warn("A function header template is not specified in the config file.= ")
+        except FileNotFoundError:
+            logging= .warn("The specified function header template file was not found."= ;)
+
+    def _initialize_app_info(self) -> None:
+        """
+        Initialize Uncrustify applicati= on information.
+
+        This function will determine th= e application path and version.
+        """
+        # Verify Uncrustify is specifie= d in the environment.
+        if UncrustifyCheck.UNCRUSTIFY_P= ATH_ENV_KEY not in os.environ:
+            raise U= ncrustifyAppEnvVarNotFoundException(
+            &n= bsp;   f"Uncrustify environment variable {UncrustifyCheck.UN= CRUSTIFY_PATH_ENV_KEY} is not present.")
+
+        self._app_path =3D shutil.which= ('uncrustify', path=3Dos.environ[UncrustifyCheck.UNCRUSTIFY_PATH_ENV_KEY])<= br> +
+        if self._app_path is None:
+            raise F= ileNotFoundError(
+            &n= bsp;   errno.ENOENT, os.strerror(errno.ENOENT), self._app_path) +
+        self._app_path =3D os.path.norm= case(os.path.normpath(self._app_path))
+
+        if not os.path.isfile(self._app= _path):
+            raise F= ileNotFoundError(
+            &n= bsp;   errno.ENOENT, os.strerror(errno.ENOENT), self._app_path) +
+        # Verify Uncrustify is present = at the expected path.
+        return_buffer =3D StringIO() +        ret =3D RunCmd(self._app_path, = "--version", outstream=3Dreturn_buffer)
+        if (ret !=3D 0):
+            raise U= ncrustifyAppVersionErrorException(
+            &n= bsp;   f"Error occurred executing --version: {ret}.") +
+        # Log Uncrustify version inform= ation.
+        self._app_version =3D return_bu= ffer.getvalue().strip()
+        self._tc.LogStdOut(f"Uncru= stify version: {self._app_version}")
+        version_aggregator.GetVersionAg= gregator().ReportVersion(
+            "U= ncrustify", self._app_version, version_aggregator.VersionTypes.INFO) +
+    def _initialize_config_file_info(self) -> None:
+        """
+        Initialize Uncrustify configura= tion file info.
+
+        The config file path is relativ= e to the package root.
+        """
+        self._app_config_file =3D Uncru= stifyCheck.DEFAULT_CONFIG_FILE_PATH
+        if "ConfigFilePath" i= n self._package_config:
+            self._a= pp_config_file =3D self._package_config["ConfigFilePath"].strip()=
+
+            self._a= pp_config_file =3D os.path.normpath(
+            &n= bsp;   os.path.join(self._abs_package_path, self._app_config_file= ))
+
+        if not os.path.isfile(self._app= _config_file):
+            raise F= ileNotFoundError(
+            &n= bsp;   errno.ENOENT, os.strerror(errno.ENOENT), self._app_config_= file)
+
+    def _initialize_environment_info(self, package_rel_path= : str, edk2_path: Edk2Path, package_config: Dict[str, List[str]], tc: Junit= ReportTestCase) -> None:
+        """
+        Initializes plugin environment = information.
+        """
+        self._abs_package_path =3D edk2= _path.GetAbsolutePathOnThisSytemFromEdk2RelativePath(
+            package= _rel_path)
+        self._abs_workspace_path =3D ed= k2_path.WorkspacePath
+        self._package_config =3D packag= e_config
+        self._package_name =3D os.path.= basename(
+            os.path= .normpath(package_rel_path))
+        self._plugin_name =3D self.__cl= ass__.__name__
+        self._plugin_path =3D os.path.d= irname(os.path.realpath(__file__))
+        self._rel_package_path =3D pack= age_rel_path
+        self._tc =3D tc
+
+    def _initialize_file_to_format_info(self) -> None: +        """
+        Forms the list of source files = for Uncrustify to process.
+        """
+        # Create a list of all the pack= age relative file paths in the package to run against Uncrustify.
+        rel_file_paths_to_format =3D li= st(
+            Uncrust= ifyCheck.STANDARD_PLUGIN_DEFINED_PATHS)
+
+        # Allow the ci.yaml to remove a= ny of the pre-defined standard paths
+        if "IgnoreStandardPaths&qu= ot; in self._package_config:
+            for a i= n self._package_config["IgnoreStandardPaths"]:
+            &n= bsp;   if a.strip() in rel_file_paths_to_format:
+            &n= bsp;       self._tc.LogStdOut(
+            &n= bsp;           f"Ign= oring standard path due to ci.yaml ignore: {a}")
+            &n= bsp;       rel_file_paths_to_format.remove(a.= strip())
+            &n= bsp;   else:
+            &n= bsp;       raise UncrustifyInvalidIgnoreStand= ardPathsException(f"Invalid IgnoreStandardPaths value: {a}")
+
+        # Allow the ci.yaml to specify = additional include paths for this package
+        if "AdditionalIncludePaths= " in self._package_config:
+            rel_fil= e_paths_to_format.extend(
+            &n= bsp;   self._package_config["AdditionalIncludePaths"])<= br> +
+        self._abs_file_paths_to_format = =3D []
+        for path in rel_file_paths_to_f= ormat:
+            self._a= bs_file_paths_to_format.extend(
+            &n= bsp;   [str(path.resolve()) for path in pathlib.Path(self._abs_pa= ckage_path).rglob(path)])
+
+        if not "SkipGitExclusions&= quot; in self._package_config or not self._package_config["SkipGitExcl= usions"]:
+            # Remov= e files ignored by git
+            logging= .info(
+            &n= bsp;   f"{self._package_name} file count before git ignore f= ile exclusion: {len(self._abs_file_paths_to_format)}")
+
+            ignored= _paths =3D self._get_git_ignored_paths()
+            self._a= bs_file_paths_to_format =3D list(
+            &n= bsp;   set(self._abs_file_paths_to_format).difference(ignored_pat= hs))
+
+            logging= .info(
+            &n= bsp;   f"{self._package_name} file count after git ignore fi= le exclusion: {len(self._abs_file_paths_to_format)}")
+
+            # Remov= e files in submodules
+            logging= .info(
+            &n= bsp;   f"{self._package_name} file count before submodule ex= clusion: {len(self._abs_file_paths_to_format)}")
+
+            submodu= le_paths =3D tuple(self._get_git_submodule_paths())
+            for pat= h in submodule_paths:
+            &n= bsp;   logging.info(f"  submodule path: {path}") +
+            self._a= bs_file_paths_to_format =3D [
+            &n= bsp;   f for f in self._abs_file_paths_to_format if not f.startsw= ith(submodule_paths)]
+
+            logging= .info(
+            &n= bsp;   f"{self._package_name} file count after submodule exc= lusion: {len(self._abs_file_paths_to_format)}")
+
+        # Sort the files for more consi= stent results
+        self._abs_file_paths_to_format.= sort()
+
+    def _initialize_test_case_output_options(self) -> No= ne:
+        """
+        Initializes options that influe= nce test case output.
+        """
+        self._audit_only_mode =3D False=
+        self._output_file_diffs =3D Fal= se
+
+        if "AuditOnly" in sel= f._package_config and self._package_config["AuditOnly"]:
+            self._a= udit_only_mode =3D True
+
+        if "OutputFileDiffs" = in self._package_config and self._package_config["OutputFileDiffs"= ;]:
+            self._o= utput_file_diffs =3D True
+
+    def _log_uncrustify_app_info(self) -> None:
+        """
+        Logs Uncrustify application inf= ormation.
+        """
+        self._tc.LogStdOut(f"Found= Uncrustify at {self._app_path}")
+        self._tc.LogStdOut(f"Uncru= stify version: {self._app_version}")
+        self._tc.LogStdOut('\n')
+        logging.info(f"Found Uncru= stify at {self._app_path}")
+        logging.info(f"Uncrustify = version: {self._app_version}")
+        logging.info('\n')
+
+    def _process_uncrustify_results(self) -> None:
+        """
+        Process the results from Uncrus= tify.
+
+        Determines whether formatting e= rrors are present and logs failures.
+        """
+        formatted_files =3D [str(path.r= esolve()) for path in pathlib.Path(
+            self._a= bs_package_path).rglob(f'*{UncrustifyCheck.FORMATTED_FILE_EXTENSION}')]
+
+        self._formatted_file_error_coun= t =3D len(formatted_files)
+
+        if self._formatted_file_error_c= ount > 0:
+            self._t= c.LogStdError("Files with formatting errors:\n")
+
+            if self= ._output_file_diffs:
+            &n= bsp;   logging.info("Calculating file diffs. This might take= a while...")
+
+        for formatted_file in formatted= _files:
+            pre_for= matted_file =3D formatted_file[:-
+            &n= bsp;            = ;            &n= bsp;          len(UncrustifyCh= eck.FORMATTED_FILE_EXTENSION)]
+
+            if (sel= f._output_file_diffs or
+            &n= bsp;       self._file_template_contents is no= t None or
+            &n= bsp;       self._func_template_contents is no= t None):
+            &n= bsp;   self._tc.LogStdError(
+            &n= bsp;       f"Formatting errors in {os.pa= th.relpath(pre_formatted_file, self._abs_package_path)}\n")
+
+            &n= bsp;   with open(formatted_file) as ff:
+            &n= bsp;       formatted_file_text =3D ff.read()<= br> +
+            &n= bsp;       if (self._file_template_contents i= s not None and
+            &n= bsp;            = ;   self._file_template_contents in formatted_file_text):
+            &n= bsp;           self._tc.L= ogStdError(f"File header is missing in {os.path.relpath(pre_formatted_= file, self._abs_package_path)}\n")
+
+            &n= bsp;       if (self._func_template_contents i= s not None and
+            &n= bsp;            = ;   self._func_template_contents in formatted_file_text):
+            &n= bsp;           self._tc.L= ogStdError(f"A function header is missing in {os.path.relpath(pre_form= atted_file, self._abs_package_path)}\n")
+
+            &n= bsp;       if self._output_file_diffs:
+            &n= bsp;           with open(= pre_formatted_file) as pf:
+            &n= bsp;            = ;   pre_formatted_file_text =3D pf.read()
+
+            &n= bsp;           for line i= n difflib.unified_diff(pre_formatted_file_text.split('\n'), formatted_file_= text.split('\n'), fromfile=3Dpre_formatted_file, tofile=3Dformatted_file, n= =3D3):
+            &n= bsp;            = ;   self._tc.LogStdError(line)
+
+            &n= bsp;           self._tc.L= ogStdError('\n')
+            else: +            &n= bsp;   self._tc.LogStdError(pre_formatted_file)
+
+    def _remove_tree(self, dir_path: str, ignore_errors: bo= ol =3D False) -> None:
+        """
+        Helper for removing a directory= . Over time there have been
+        many private implementations of= this due to reliability issues in the
+        shutil implementations. To cons= olidate on a single function this helper is added.
+
+        On error try to change file att= ributes. Also add retry logic.
+
+        This function is temporarily bo= rrowed from edk2toollib.utility_functions
+        since the version used in edk2 = is not recent enough to include the
+        function.
+
+        This function should be replace= d by "RemoveTree" when it is available.
+
+        Args:
+          - dir_path: Path to= directory to remove.
+          - ignore_errors: Wh= ether to ignore errors during removal
+        """
+
+        def _remove_readonly(func, path= , _):
+            "&= quot;"
+            Private= function to attempt to change permissions on file/folder being deleted. +            "&= quot;"
+            os.chmo= d(path, os.stat.S_IWRITE)
+            func(pa= th)
+
+        for _ in range(3):  # retr= y up to 3 times
+            try: +            &n= bsp;   shutil.rmtree(dir_path, ignore_errors=3Dignore_errors, one= rror=3D_remove_readonly)
+            except = OSError as err:
+            &n= bsp;   logging.warning(f"Failed to fully remove {dir_path}: = {err}")
+            else: +            &n= bsp;   break
+        else:
+            raise R= untimeError(f"Failed to remove {dir_path}")
+
+    def _run_uncrustify(self) -> None:
+        """
+        Runs Uncrustify for this instan= ce of plugin execution.
+        """
+        logging.info("Executing Un= crustify. This might take a while...")
+        start_time =3D timeit.default_t= imer()
+        self._execute_uncrustify()
+        end_time =3D timeit.default_tim= er() - start_time
+
+        execution_summary =3D f"Un= crustify executed against {len(self._abs_file_paths_to_format)} files in {s= elf._package_name} in {end_time:.2f} seconds.\n"
+
+        self._tc.LogStdOut(execution_su= mmary)
+        logging.info(execution_summary)=
+
+        if self._app_exit_code !=3D 0 a= nd self._app_exit_code !=3D 1:
+            raise U= ncrustifyAppExecutionException(
+            &n= bsp;   f"Error {str(self._app_exit_code)} returned from Uncr= ustify:\n\n{str(self._app_output)}")
diff --git a/.pytool/Plugin/UncrustifyCheck/default_file_header.txt b/.pyto= ol/Plugin/UncrustifyCheck/default_file_header.txt
new file mode 100644
index 000000000000..2955a734dfe1
--- /dev/null
+++ b/.pytool/Plugin/UncrustifyCheck/default_file_header.txt
@@ -0,0 +1,9 @@
+/** @file
+  Brief description of the file's purpose.
+
+  Detailed description of the file's contents and other useful
+  information for a person viewing the file for the first time.
+
+  <<Copyright>>
+  SPDX-License-Identifier: BSD-2-Clause-Patent
+**/
diff --git a/.pytool/Plugin/UncrustifyCheck/default_function_header.txt b/.= pytool/Plugin/UncrustifyCheck/default_function_header.txt
new file mode 100644
index 000000000000..66edc72e6731
--- /dev/null
+++ b/.pytool/Plugin/UncrustifyCheck/default_function_header.txt
@@ -0,0 +1,15 @@
+/**
+  Brief description of this function's purpose.
+
+  Follow it immediately with the detailed description.
+
+  @param[in]      Arg1  Description of = Arg1.
+  @param[in]      Arg2  Description of = Arg2 This is complicated and requires
+            &n= bsp;           multiple l= ines to describe.
+  @param[out]     Arg3  Description of Arg3.=
+  @param[in, out] Arg4  Description of Arg4.
+
+  @retval VAL_ONE  Description of what VAL_ONE signifies.
+  @retval OTHER    This is the only other return value= . If there were other
+            &n= bsp;      return values, they would be listed.
+**/
diff --git a/.pytool/Plugin/UncrustifyCheck/uncrustify.cfg b/.pytool/Plugin= /UncrustifyCheck/uncrustify.cfg
new file mode 100644
index 000000000000..6261eb853690
--- /dev/null
+++ b/.pytool/Plugin/UncrustifyCheck/uncrustify.cfg
@@ -0,0 +1,462 @@
+## @file
+# Uncrustify Configuration File for EDK II C Code
+#
+# Coding Standard: https://nam06.safelinks.protection.outlook.com/?url=3Dhttps%3A%2F%2Fedk2-do= cs.gitbook.io%2Fedk-ii-c-coding-standards-specification%2F&amp;data=3D0= 4%7C01%7CBret.Barkelew%40microsoft.com%7Cccfe5bfffa354589afb308d9afaddcc3%7= C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637733983563562870%7CUnknown%7C= TWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0= %3D%7C3000&amp;sdata=3DMerTF0Kzlnnb15aihVltzsF5yn82vV1k2iG5oxvLAao%3D&a= mp;amp;reserved=3D0
+#
+# This configuration file is meant to be a "best attempt" to ali= gn with the
+# definitions in the EDK II C Coding Standards Specification.
+#
+# Copyright (c) Microsoft Corporation.
+# SPDX-License-Identifier: BSD-2-Clause-Patent
+##
+
+# Force UTF-8 encoding (no UTF-16)
+enable_digraphs          = ;       =3D false
+utf8_byte           = ;            =3D fal= se
+utf8_force          &nbs= p;           =3D true
+
+# Code width / line splitting
+#code_width          &nb= sp;           =3D120 = ;    # TODO: This causes non-deterministic behaviour in some= cases when code wraps
+ls_code_width          &= nbsp;        =3Dfalse
+ls_for_split_full         &nb= sp;     =3Dtrue
+ls_func_split_full         &n= bsp;    =3Dtrue
+pos_comma           = ;            =3Dtrai= l
+
+# 5.1.7  All files must end with CRLF
+newlines           =              = =3D crlf
+
+# 5.1.2 Do not use tab characters
+
+cmt_convert_tab_to_spaces       =3D true&nbs= p;     # Whether to convert all tabs to spaces in comme= nts. If false, tabs in
+            &n= bsp;            = ;            &n= bsp;      # comments are left alone, unless used f= or indenting.
+indent_columns          =         =3D 2    &nb= sp;    # Number of spaces for indentation
+indent_with_tabs         &nbs= p;      =3D 0      &= nbsp;  # Do not use TAB characters
+string_replace_tab_chars        =3D tru= e      # Replace TAB with SPACE
+            &n= bsp;            = ;            &n= bsp;      # Note: This will break .robot files but= is needed for edk2 style
+
+# 5.2.1.1 There shall be only one statement on a line (statement ends with= ;)
+nl_multi_line_cond         &n= bsp;    =3D true      # Add a newli= ne between ')' and '{' if the ')' is on a different line than
+            &n= bsp;            = ;            &n= bsp;      # the if/for/etc.
+nl_after_semicolon         &n= bsp;    =3D true      # Whether to = add a newline after semicolons, except in 'for' statements.
+
+# 5.2.1.3 An open brace '{' goes on the same line as the closing parenthes= is ')' of simple predicate expressions
+mod_full_brace_do         &nb= sp;     =3D add       # A= dd or remove braces on a single-line 'do' statement.
+mod_full_brace_for         &n= bsp;    =3D add
+mod_full_brace_function         = =3D add       # Add or remove braces on a sin= gle-line function definition.
+mod_full_brace_if         &nb= sp;     =3D add       # A= dd or remove braces on a single-line 'if' statement. Braces will not be
+            &n= bsp;            = ;            &n= bsp;      # removed if the braced statement contai= ns an 'else'.
+mod_full_brace_if_chain         = =3D false
+mod_full_brace_while         =    =3D add
+
+# 5.2.1.4 A close brace '}' always goes at the beginning of the last line = of the body
+eat_blanks_after_open_brace     =3D true
+eat_blanks_before_close_brace   =3D true    =   # Whether to remove blank lines before '}'.
+
+# 5.2.2.2 Always put space before and after binary operators.
+sp_assign           = ;            =3D add=        # Add or remove space around assignmen= t operator '=3D', '+=3D', etc.
+sp_assign_default         &nb= sp;     =3D add
+sp_bool           &= nbsp;           &nbs= p; =3D add       # Add or remove space around= boolean operators '&&' and '||'.
+sp_compare          &nbs= p;           =3D add = ;      # Add or remove space around compare operat= or '<', '>', '=3D=3D', etc.
+
+# 5.2.2.3 Do not put space between unary operators and their object
+sp_addr           &= nbsp;           &nbs= p; =3D remove    # A or remove space after the '&' (addr= ess-of) unary operator.
+sp_incdec           = ;            =3D rem= ove    # Add or remove space between '++' and '--' the word = to which it is being
+            &n= bsp;            = ;            &n= bsp;      # applied, as in '(--x)' or 'y++;'.
+sp_inv           &n= bsp;            = ;  =3D remove    # Add or remove space after the '~' (i= nvert) unary operator.
+sp_not           &n= bsp;            = ;  =3D remove    # Add or remove space after the '!' (n= ot) unary operator.
+sp_sign           &= nbsp;           &nbs= p; =3D remove    # Add or remove space after '+' or '-', as = in 'x =3D -5' or 'y =3D +7'.
+
+# 5.2.2.4 Subsequent lines of multi-line function calls should line up two= spaces from the beginning of the function
+#         name
+nl_func_call_args_multi_line    =3D true   &= nbsp;  # Whether to add a newline after each ',' in a function call if= '(' and ')'
+            &n= bsp;            = ;            &n= bsp;      # are in different lines.
+nl_func_call_args_multi_line_ignore_closures =3D false
+
+# - Indent each argument 2 spaces from the start of the function name. If = a
+#   function is called through a structure or union member, of t= ype
+#   pointer-to-function, then indent each argument 2 spaces from= the start of the
+#   member name.
+indent_func_call_edk2_style     =3D true  &n= bsp;   # Use EDK2 indentation style for function calls  (**C= USTOM SETTING**)
+indent_paren_after_func_call    =3D true   &= nbsp;  # Whether to indent the open parenthesis of a function call, if= the
+            &n= bsp;            = ;            &n= bsp;      # parenthesis is on its own line.
+
+# - Align the close parenthesis with the start of the last argument
+indent_paren_close         &n= bsp;    =3D 0        = ; # How to indent a close parenthesis after a newline.
+            &n= bsp;            = ;            &n= bsp;      # (0: Body, 1: Openparenthesis, 2: Brace= level)
+
+
+# 5.2.2.5 Always put space after commas or semicolons that separate items<= br> +sp_after_comma          =         =3D force    = ; # Add or remove space after ',', i.e. 'a,b' vs. 'a, b'.
+sp_before_comma          = ;       =3D remove    # Add or= remove space before ','.
+
+# 5.2.2.6 Always put space before an open parenthesis
+sp_after_sparen          = ;       =3D add     =   # Add or remove space after ')' of control statements.
+sp_attribute_paren         &n= bsp;    =3D add       # Add or= remove space between '__attribute__' and '('.
+sp_before_sparen         &nbs= p;      =3D force     # Add or= remove space before '(' of control statements
+            &n= bsp;            = ;            &n= bsp;      # ('if', 'for', 'switch', 'while', etc.)= .
+sp_defined_paren         &nbs= p;      =3D force     # Add or= remove space between 'defined' and '(' in '#if defined (FOO)'.
+sp_func_call_paren         &n= bsp;    =3D force     # Add or remove sp= ace between function name and '(' on function calls.
+sp_func_call_paren_empty        =3D for= ce     # Add or remove space between function name and = '()' on function calls
+            &n= bsp;            = ;            &n= bsp;      # without parameters. If set to ignore (= the default), sp_func_call_paren is
+            &n= bsp;            = ;            &n= bsp;      # used.
+sp_func_def_paren         &nb= sp;     =3D add       # A= dd or remove space between alias name and '(' of a non-pointer function
+            &n= bsp;            = ;            &n= bsp;      # type typedef.
+sp_func_proto_paren         &= nbsp;   =3D add       # Add or remo= ve space between function name and '()' on function declaration
+sp_sizeof_paren          = ;       =3D force     # A= dd or remove space between 'sizeof' and '('.
+sp_type_func          &n= bsp;         =3D add  &nb= sp;    # Add or remove space between return type and functio= n name. A minimum of 1
+            &n= bsp;            = ;            &n= bsp;      # is forced except for pointer return ty= pes.
+
+# Not specified, but also good style to remove spaces inside parentheses (= Optional)
+sp_cparen_oparen         &nbs= p;      =3D remove    # Add or remo= ve space between back-to-back parentheses, i.e. ')(' vs. ') ('.
+sp_inside_fparen         &nbs= p;      =3D remove    # Add or remo= ve space inside function '(' and ')'.
+sp_inside_fparens         &nb= sp;     =3D remove    # Add or remove sp= ace inside empty function '()'.
+sp_inside_paren          = ;       =3D remove    # Add or= remove space inside '(' and ')'.
+sp_inside_paren_cast         =    =3D remove    # Add or remove spaces inside cas= t parentheses. '(int)x'
+sp_inside_square         &nbs= p;      =3D remove    # Add or remo= ve space inside a non-empty '[' and ']'.
+sp_paren_paren          =         =3D remove    # A= dd or remove space between nested parentheses, i.e. '((' vs. ') )'.
+sp_square_fparen         &nbs= p;      =3D remove    # Add or remo= ve space between ']' and '(' when part of a function call.
+
+# 5.2.2.7 Put a space before an open brace if it is not on its own line +sp_do_brace_open         &nbs= p;      =3D force     # Add or= remove space between 'do' and '{'.
+sp_paren_brace          =         =3D force    = ; # Add or remove space between ')' and '{'.
+sp_sparen_brace          = ;       =3D force     # A= dd or remove space between ')' and '{' of of control statements.
+
+# 5.2.2.8 Do not put spaces around structure member and pointer operators<= br> +sp_after_byref          =         =3D remove    # A= dd or remove space after reference sign '&', if followed by a word.
+sp_before_byref          = ;       =3D add     =   # Add or remove space before a reference sign '&'.
+sp_deref           =              = =3D remove    # Add or remove space after the '*' (dereferen= ce) unary operator. This does
+            &n= bsp;            = ;            &n= bsp;      # not affect the spacing after a '*' tha= t is part of a type.
+sp_member           = ;            =3D rem= ove    # Add or remove space around the '.' or '->' opera= tors.
+
+# 5.2.2.9 Do not put spaces before open brackets of array subscripts
+sp_before_square         &nbs= p;      =3D remove    # Add or remo= ve space before '[' (except '[]').
+sp_before_squares         &nb= sp;     =3D remove    # Add or remove sp= ace before '[]'.
+sp_before_vardef_square         = =3D remove    # Add or remove space before '[' for a variabl= e definition.
+
+# 5.2.2.10 Use extra parentheses rather than depending on in-depth knowled= ge of the order of precedence of C
+mod_full_paren_if_bool        &nbs= p; =3D true      # Whether to fully parenthesize B= oolean expressions in 'while' and 'if'
+            &n= bsp;            = ;            &n= bsp;      # statement, as in 'if (a && b &= gt; c)' =3D> 'if (a && (b > c))'.
+
+# 5.2.2.11 Align a continuation line with the part of the line that it con= tinues.
+use_indent_continue_only_once   =3D true
+
+# Additional '{}' bracing rules (Optional)
+# NOTE - The style guide specifies two different styles for braces,
+# so these are ignored for now to allow developers some flexibility.
+nl_after_brace_close         =    =3D true      # Whether to add a newl= ine after '}'. Does not apply if followed by a
+            &n= bsp;            = ;            &n= bsp;      # necessary ';'.
+nl_brace_else          &= nbsp;        =3D remove   = ; # Add or remove newline between '}' and 'else'.
+nl_brace_while          =         =3D remove    # A= dd or remove newline between '}' and 'while' of 'do' statement.
+nl_do_brace          &nb= sp;          =3D remove &= nbsp;  # Add or remove newline between 'do' and '{'.
+nl_else_brace          &= nbsp;        =3D remove   = ; # Add or remove newline between 'else' and '{'.
+nl_else_if          &nbs= p;           =3D remove&n= bsp;   # Add or remove newline between 'else' and 'if'.
+nl_elseif_brace          = ;       =3D remove    # Add or= remove newline between 'else if' and '{'.
+nl_enum_brace          &= nbsp;        =3D remove   = ; # Add or remove newline between 'enum' and '{'.
+nl_fcall_brace          =         =3D remove    # A= dd or remove newline between a function call's ')' and '{',
+            &n= bsp;            = ;            &n= bsp;      # as in 'list_for_each(item, &list) = { }'.
+nl_for_brace          &n= bsp;         =3D remove  =   # Add or remove newline between 'for' and '{'.
+nl_if_brace          &nb= sp;          =3D remove &= nbsp;  # Add or remove newline between 'if' and '{'.
+nl_struct_brace          = ;       =3D remove    # Add or= remove newline between 'struct and '{'.
+nl_switch_brace          = ;       =3D remove    # Add or= remove newline between 'switch' and '{'.
+nl_union_brace          =         =3D remove    # A= dd or remove newline between 'union' and '{'.
+nl_while_brace          =         =3D remove    # A= dd or remove newline between 'while' and '{'.
+
+# Additional whitespace rules (Optional)
+sp_after_ptr_star         &nb= sp;     =3D remove    # Add or remove sp= ace after pointer star '*', if followed by a word.
+            &n= bsp;            = ;            &n= bsp;      # Useful when paired with align_var_def_= star_style=3D=3D2
+sp_after_ptr_star_func        &nbs= p; =3D remove    # Add or remove space after a pointer star = '*', if followed by a function
+            &n= bsp;            = ;            &n= bsp;      # prototype or function definition.
+sp_after_semi          &= nbsp;        =3D remove   = ; # Add or remove space after ';', except when followed by a comment.
+sp_before_case_colon         =    =3D remove    # Add or remove space before case= ':'.
+sp_before_ptr_star         &n= bsp;    =3D add       # Add or= remove space before pointer star '*'.
+sp_before_ptr_star_func         = =3D add       # Add or remove space before a = pointer star '*', if followed by a function
+            &n= bsp;            = ;            &n= bsp;      # prototype or function definition.
+sp_before_semi          =         =3D remove    # A= dd or remove space before ';'
+sp_before_semi_for         &n= bsp;    =3D remove    # Add or remove space b= efore ';' in non-empty 'for' statements.
+sp_before_semi_for_empty        =3D add=        # Add or remove space before a semicol= on of an empty part of a for statement
+sp_between_ptr_star         &= nbsp;   =3D remove    # Add or remove space betwee= n pointer stars '*'. (ie, 'VOID **')
+sp_brace_close_while         =    =3D force     # Add or remove space betwee= n '}' and 'while'.
+
+sp_after_cast          &= nbsp;        =3D remove
+sp_after_type          &= nbsp;        =3D add
+sp_balance_nested_parens        =3D fal= se
+sp_before_nl_cont         &nb= sp;     =3D add
+sp_before_square_asm_block      =3D ignore
+sp_before_unnamed_byref         = =3D add
+sp_brace_brace          =         =3D ignore
+sp_brace_else          &= nbsp;        =3D force
+sp_brace_typedef         &nbs= p;      =3D add
+sp_case_label          &= nbsp;        =3D force
+sp_cmt_cpp_doxygen         &n= bsp;    =3D true
+sp_cond_colon          &= nbsp;        =3D add
+sp_cond_question         &nbs= p;      =3D add
+sp_cpp_cast_paren         &nb= sp;     =3D force
+sp_else_brace          &= nbsp;        =3D force
+sp_endif_cmt          &n= bsp;         =3D force
+sp_enum_assign          =         =3D add
+sp_inside_braces         &nbs= p;      =3D force
+sp_inside_braces_empty        &nbs= p; =3D force
+sp_inside_braces_enum         = ;  =3D force
+sp_inside_braces_struct         = =3D force
+sp_pp_concat          &n= bsp;         =3D add
+sp_pp_stringify          = ;       =3D add
+sp_return_paren          = ;       =3D add
+sp_special_semi          = ;       =3D force
+sp_while_paren_open         &= nbsp;   =3D force
+
+# Additional Indentation Rules
+indent_access_spec         &n= bsp;    =3D 1
+indent_access_spec_body         = =3D false
+indent_align_assign         &= nbsp;   =3D true
+indent_align_string         &= nbsp;   =3D true
+indent_bool_paren         &nb= sp;     =3D true
+indent_brace_parent         &= nbsp;   =3D false
+indent_braces          &= nbsp;        =3D false
+indent_braces_no_class        &nbs= p; =3D false
+indent_braces_no_func         = ;  =3D true
+indent_braces_no_struct         = =3D false
+indent_class          &n= bsp;         =3D false
+indent_class_colon         &n= bsp;    =3D false
+indent_cmt_with_tabs         =    =3D false         # Wh= ether to indent comments that are not at a brace level with tabs on
+            &n= bsp;            = ;            &n= bsp;          # a tabstop. Req= uires indent_with_tabs=3D2. If false, will use spaces.
+indent_col1_comment         &= nbsp;   =3D true
+indent_col1_multi_string_literal=3D true
+indent_comma_paren         &n= bsp;    =3D true
+indent_else_if          =         =3D true
+indent_extern          &= nbsp;        =3D false
+indent_first_bool_expr        &nbs= p; =3D true
+
+indent_func_def_param_paren_pos_threshold =3D 0
+indent_func_param_double        &n= bsp;         =3D false
+indent_func_proto_param        &nb= sp;          =3D true
+indent_ignore_asm_block        &nb= sp;          =3D true
+indent_label          &n= bsp;            = ;       =3D 1
+indent_member          &= nbsp;           &nbs= p;      =3D 2
+indent_namespace         &nbs= p;            &= nbsp;   =3D false
+indent_param          &n= bsp;            = ;       =3D 2
+indent_paren_nl          = ;            &n= bsp;    =3D false
+indent_paren_open_brace        &nb= sp;          =3D false
+indent_preserve_sql         &= nbsp;           &nbs= p; =3D false
+indent_relative_single_line_comments      =3D fal= se
+indent_sing_line_comments        &= nbsp;        =3D 0
+indent_single_newlines        &nbs= p;           =3D false +indent_square_nl         &nbs= p;            &= nbsp;   =3D false
+indent_switch_case         &n= bsp;            = ;  =3D 2
+indent_template_param         = ;            =3D tru= e
+indent_var_def_blk         &n= bsp;            = ;  =3D 0
+indent_var_def_cont         &= nbsp;           &nbs= p; =3D false
+
+# Tidy-up rules (Optional)
+mod_move_case_break         &= nbsp;   =3D true      # Whether to move = a 'break' that appears after a fully braced 'case'
+            &n= bsp;            = ;            &n= bsp;      # before the close brace, as in 'case X:= { ... } break;' =3D>
+            &n= bsp;            = ;            &n= bsp;      # 'case X: { ... break; }'.
+mod_pawn_semicolon         &n= bsp;    =3D false
+mod_remove_empty_return         = =3D false     # Whether to remove a void 'return;' that= appears as the last statement
+            &n= bsp;            = ;            &n= bsp;      # in a function.
+mod_remove_extra_semicolon      =3D true
+mod_sort_import          = ;       =3D false
+mod_sort_include         &nbs= p;      =3D false
+mod_sort_using          =         =3D false
+nl_after_case          &= nbsp;        =3D false   =   # Whether to add a newline after a 'case' statement.
+nl_end_of_file          =         =3D force    = ; # Add or remove newline at the end of the file.
+nl_end_of_file_min         &n= bsp;    =3D 1        = ; # The minimum number of newlines at the end of the file
+nl_max           &n= bsp;            = ;  =3D 2         # The maximum= number of consecutive newlines (3 =3D 2 blank lines).
+nl_start_of_file         &nbs= p;      =3D remove    # Add or remo= ve newlines at the start of the file.
+
+# Code alignment rules (Optional)
+align_asm_colon          = ;       =3D false
+align_assign_span         &nb= sp;     =3D 1       =   # The span for aligning on '=3D' in assignments.
+align_assign_thresh         &= nbsp;   =3D 4
+align_edk2_style         &nbs= p;      =3D true      # W= hether to apply edk2-specific alignment formatting
+align_enum_equ_span         &= nbsp;   =3D 1         # T= he span for aligning on '=3D' in enums.
+align_func_params         &nb= sp;     =3D true      # Whethe= r to align variable definitions in prototypes and functions.
+align_func_params_gap         = ;  =3D 2
+align_func_params_span        &nbs= p; =3D 2         # The span for ali= gning parameter definitions in function on parameter name.
+align_func_params_thresh        =3D 0 +align_func_proto_span         = ;  =3D 0
+align_keep_tabs          = ;       =3D false
+align_left_shift         &nbs= p;      =3D false
+align_mix_var_proto         &= nbsp;   =3D false
+align_nl_cont          &= nbsp;        =3D false
+align_oc_decl_colon         &= nbsp;   =3D false
+align_on_operator         &nb= sp;     =3D false
+align_on_tabstop         &nbs= p;      =3D false
+align_pp_define_gap         &= nbsp;   =3D 2
+align_pp_define_span         =    =3D 1
+align_right_cmt_at_col        &nbs= p; =3D 0         # Align trailing c= omment at or beyond column N; 'pulls in' comments as
+            &n= bsp;            = ;            &n= bsp;      # a bonus side effect (0=3Dignore)
+align_right_cmt_gap         &= nbsp;   =3D 0         # I= f a trailing comment is more than this number of columns away from the
+            &n= bsp;            = ;            &n= bsp;      # text it follows,
+            &n= bsp;            = ;            &n= bsp;      # it will qualify for being aligned. Thi= s has to be > 0 to do anything.
+align_right_cmt_mix         &= nbsp;   =3D false     # If aligning comments,= mix with comments after '}' and #endif with less
+            &n= bsp;            = ;            &n= bsp;      # than 3 spaces before the comment
+align_right_cmt_same_level      =3D true &nb= sp;    # Whether to only align trailing comments that are at= the same brace level.
+align_right_cmt_span         =    =3D 2         # The sp= an for aligning comments that end lines.
+align_same_func_call_params     =3D false
+align_single_line_brace         = =3D true
+align_single_line_func        &nbs= p; =3D true
+align_struct_init_span        &nbs= p; =3D 1         # The span for ali= gning struct initializer values.
+align_typedef_amp_style         = =3D 1
+align_typedef_func         &n= bsp;    =3D 1        = ; # How to align typedef'd functions with other typedefs.
+            &n= bsp;            = ;            &n= bsp;      # (0: No align, 1: Align open paranthesi= s, 2: Align function type name)
+align_typedef_gap         &nb= sp;     =3D 2
+align_typedef_span         &n= bsp;    =3D 1        = ; # The span for aligning single-line typedefs.
+align_typedef_star_style        =3D 1 +align_var_def_amp_style         = =3D 1
+align_var_def_attribute         = =3D true
+align_var_def_colon         &= nbsp;   =3D true      # Whether to align= the colon in struct bit fields.
+align_var_def_gap         &nb= sp;     =3D 2       =   # The gap (minimum spacing for aligned items) for variable definitio= ns.
+align_var_def_inline         =    =3D false
+align_var_def_span         &n= bsp;    =3D 1        = ; # The span (lines needed to align) for aligning variable definitions.
+align_var_def_star_style        =3D 1&n= bsp;        # How to consider (or treat)= the '*' in the alignment of variable
+            &n= bsp;            = ;            &n= bsp;      # definitions.
+            &n= bsp;            = ;            &n= bsp;      # 0: Part of the type   &= nbsp; 'void *   foo;' (default)
+            &n= bsp;            = ;            &n= bsp;      # 1: Part of the variable 'void &nb= sp;   *foo;'
+            &n= bsp;            = ;            &n= bsp;      # 2: Dangling    &nb= sp;        'void    *foo;= '
+            &n= bsp;            = ;            &n= bsp;      # (Note - should also set sp_after_ptr_s= tar=3Dremove)
+align_var_struct_gap         =    =3D 4
+align_var_struct_span         = ;  =3D 8         # The span fo= r aligning struct/union member definitions.
+align_var_struct_thresh         = =3D 0
+align_with_tabs          = ;       =3D false
+
+# Comment formatting
+cmt_align_doxygen_javadoc_tags  =3D true     = ; # Whether to align doxygen javadoc-style tags ('@param', '@return', etc.)=
+            &n= bsp;            = ;            &n= bsp;      # TODO: Eats '[' in '[in]'
+cmt_c_group          &nb= sp;          =3D false
+cmt_c_nl_end          &n= bsp;         =3D true  &n= bsp;   # Whether to add a newline before the closing '*/' of the = combined c-comment.
+cmt_c_nl_start          =         =3D true
+cmt_cpp_group          &= nbsp;        =3D false
+cmt_cpp_nl_end          =         =3D true
+cmt_cpp_nl_start         &nbs= p;      =3D true
+cmt_cpp_to_c          &n= bsp;         =3D false
+cmt_indent_multi         &nbs= p;      =3D false     # Whethe= r to apply changes to multi-line comments, including cmt_width,
+            &n= bsp;            = ;            &n= bsp;      # keyword substitution and leading chars= .
+cmt_insert_before_preproc       =3D false +#cmt_insert_file_header        &nb= sp; =3D default_file_header.txt
+#cmt_insert_func_header        &nb= sp; =3D default_function_header.txt
+cmt_multi_check_last         =    =3D false
+cmt_multi_first_len_minimum     =3D 2
+cmt_reflow_mode          = ;       =3D 1     &n= bsp;   # How to reflow comments.
+            &n= bsp;            = ;            &n= bsp;      # (0:No reflow, 1:No touching at all, 2:= Full reflow)
+cmt_sp_after_star_cont        &nbs= p; =3D 0         # The number of sp= aces to insert after the star on subsequent comment lines.
+cmt_sp_before_star_cont         = =3D 0         # The number of space= s to insert at the start of subsequent comment lines.
+cmt_star_cont          &= nbsp;        =3D false   =   # Whether to put a star on subsequent comment lines.
+cmt_width           = ;            =3D 120=        # Try to wrap comments at N columns. +sp_cmt_cpp_start         &nbs= p;      =3D add      = ; # Add or remove space after the opening of a C++ comment, as in
+            &n= bsp;            = ;            &n= bsp;      # '// <here> A'.  NOTE: Break= s indentation within comments.
+
+# Function definitions / declarations
+indent_func_call_param        &nbs= p; =3D false     # Whether to indent continued function= call parameters one indent level,
+            &n= bsp;            = ;            &n= bsp;      # rather than aligning parameters under = the open parenthesis.
+indent_func_class_param         = =3D false     # Whether to indent continued function ca= ll declaration one indent level,
+            &n= bsp;            = ;            &n= bsp;      # rather than aligning parameters under = the open parenthesis.
+indent_func_ctor_var_param      =3D false &n= bsp;   # Whether to indent continued class variable constructors = one indent level,
+            &n= bsp;            = ;            &n= bsp;      # rather than aligning parameters under = the open parenthesis.
+indent_func_def_param         = ;  =3D true      # Whether to indent continue= d function definition parameters one indent
+            &n= bsp;            = ;            &n= bsp;      # level, rather than aligning parameters= under the open parenthesis.
+nl_fdef_brace          &= nbsp;        =3D add   &n= bsp;   # Add or remove newline between function signature and '{'= .
+nl_func_call_end_multi_line     =3D true  &n= bsp;   # Whether to add a newline before ')' in a function call i= f '(' and ')' are
+            &n= bsp;            = ;            &n= bsp;      # in different lines.
+nl_func_call_paren         &n= bsp;    =3D remove    # Add or remove newline= between a function name and the opening '(' in the
+            &n= bsp;            = ;            &n= bsp;      # call.
+nl_func_call_start_multi_line   =3D true    =   # Whether to add a newline after '(' in a function call if '(' and '= )' are
+            &n= bsp;            = ;            &n= bsp;      # in different lines.
+nl_func_decl_args         &nb= sp;     =3D force     # Add or remo= ve newline after each ',' in a function declaration.
+nl_func_decl_empty         &n= bsp;    =3D add       # Add or= remove newline between '()' in a function declaration.
+nl_func_def_args         &nbs= p;      =3D force     # Add or= remove newline after each ',' in a function definition.
+nl_func_def_empty         &nb= sp;     =3D add       # A= dd or remove newline between '()' in a function definition.
+nl_func_def_paren         &nb= sp;     =3D remove    # Add or remove ne= wline between a function name and the opening '('
+            &n= bsp;            = ;            &n= bsp;      # in the definition.
+nl_func_paren          &= nbsp;        =3D remove   = ; # Add or remove newline between a function name and the opening '(' in +            &n= bsp;            = ;            &n= bsp;      # the declaration.
+nl_func_type_name         &nb= sp;     =3D add       # A= dd or remove newline between return type and function name in a function +            &n= bsp;            = ;            &n= bsp;      # definition.
+sp_fparen_brace          = ;       =3D force     # A= dd or remove space between ')' and '{' of function.
+use_indent_func_call_param      =3D true &nb= sp;    # indent_func_call_param will be used
+
+# Additional Newline Rules
+nl_after_brace_open         &= nbsp;           &nbs= p;    =3D true     # Whether to add a ne= wline after '{'. This also adds a newline
+            &n= bsp;            = ;            &n= bsp;            = ;      # before the matching '}'.
+nl_after_brace_open_cmt        &nb= sp;            = =3D true     # Whether to add a newline between the op= en brace and a
+            &n= bsp;            = ;            &n= bsp;            = ;      # trailing single-line comment.
+            &n= bsp;            = ;            &n= bsp;            = ;      # Requires nl_after_brace_open =3D true. +nl_after_do          &nb= sp;            =            =3D add &= nbsp;    # Add or remove blank line after 'do/while' stateme= nt.
+nl_after_for          &n= bsp;            = ;          =3D add  =     # Add or remove blank line after 'for' statement.
+nl_after_func_body         &n= bsp;            = ;     =3D 2        #= The number of newlines after '}' of a multi-line function body
+nl_after_func_body_one_liner       &nbs= p;         =3D 2
+nl_after_func_proto         &= nbsp;           &nbs= p;    =3D 2
+nl_after_func_proto_group        &= nbsp;           =3D 2
+nl_after_if          &nb= sp;            =            =3D add
+nl_after_multiline_comment        =            =3D false
+nl_after_return          = ;            &n= bsp;       =3D false
+nl_after_struct          = ;            &n= bsp;       =3D 2
+nl_after_switch          = ;            &n= bsp;       =3D add
+nl_after_vbrace_close         = ;            &n= bsp;  =3D true
+nl_after_vbrace_open         =             &nb= sp;   =3D true
+nl_after_vbrace_open_empty        =            =3D true
+nl_after_while          =             &nb= sp;        =3D add
+nl_assign_leave_one_liners        =            =3D true
+nl_before_block_comment        &nb= sp;            = =3D 2
+nl_before_case          =             &nb= sp;        =3D false
+nl_before_do          &n= bsp;            = ;          =3D ignore
+nl_before_for          &= nbsp;           &nbs= p;         =3D ignore
+nl_before_if          &n= bsp;            = ;          =3D ignore
+nl_before_switch         &nbs= p;            &= nbsp;      =3D ignore
+nl_before_while          = ;            &n= bsp;       =3D ignore
+nl_before_whole_file_ifdef        =            =3D 2
+nl_brace_brace          =             &nb= sp;        =3D force
+nl_brace_struct_var         &= nbsp;           &nbs= p;    =3D remove
+nl_case_colon_brace         &= nbsp;           &nbs= p;    =3D add
+nl_class_leave_one_liners        &= nbsp;           =3D false=
+nl_collapse_empty_body        &nbs= p;            &= nbsp; =3D false
+nl_comment_func_def         &= nbsp;           &nbs= p;    =3D 1
+nl_create_for_one_liner        &nb= sp;            = =3D false
+nl_create_if_one_liner        &nbs= p;            &= nbsp; =3D false
+nl_create_while_one_liner        &= nbsp;           =3D false=
+nl_define_macro          = ;            &n= bsp;       =3D false
+nl_ds_struct_enum_close_brace       &nb= sp;        =3D true
+nl_ds_struct_enum_cmt         = ;            &n= bsp;  =3D false
+nl_enum_leave_one_liners        &n= bsp;            =3D = false
+nl_func_decl_end         &nbs= p;            &= nbsp;      =3D add
+nl_func_decl_start         &n= bsp;            = ;     =3D add
+nl_func_def_end          = ;            &n= bsp;       =3D add
+nl_func_def_start         &nb= sp;            =       =3D add
+nl_func_leave_one_liners        &n= bsp;            =3D = false
+nl_func_proto_type_name        &nb= sp;            = =3D add
+nl_func_var_def_blk         &= nbsp;           &nbs= p;    =3D 1
+nl_getset_leave_one_liners        =            =3D false
+nl_if_leave_one_liners        &nbs= p;            &= nbsp; =3D false
+nl_multi_line_define         =             &nb= sp;   =3D false
+nl_squeeze_ifdef         &nbs= p;            &= nbsp;      =3D false
+nl_var_def_blk_end         &n= bsp;            = ;     =3D 0
+nl_var_def_blk_start         =             &nb= sp;   =3D 0
+
+# Preprocessor Rules
+pp_define_at_level      =3D true
+pp_if_indent_code       =3D false
+pp_indent_func_def      =3D false
+pp_indent_extern        =3D false
+pp_ignore_define_body   =3D true     &n= bsp;          # Workaround: Tu= rn off processing for #define body
+            &n= bsp;            = ;            &n= bsp;        # (current rules do not work= for some defines)
+pp_indent           = ;    =3D add
+pp_indent_at_level      =3D true
+pp_indent_count         =3D 2
+pp_indent_if          &n= bsp; =3D 2
+pp_indent_region        =3D 2
+pp_region_indent_code   =3D false
+pp_space           =      =3D remove
+
+#
+# The tokens below are assigned specific types so they are always recogniz= ed properly.
+#
+
+# Explicitly define EDK II qualifiers
+set QUALIFIER CONST
+set QUALIFIER EFIAPI
+set QUALIFIER IN
+set QUALIFIER OPTIONAL
+set QUALIFIER OUT
+
+# Explicitly define EDK II types
+set TYPE EFI_STATUS
+set TYPE VOID
diff --git a/.pytool/Plugin/UncrustifyCheck/uncrustify_ext_dep.yaml b/.pyto= ol/Plugin/UncrustifyCheck/uncrustify_ext_dep.yaml
new file mode 100644
index 000000000000..d8c22403b4b1
--- /dev/null
+++ b/.pytool/Plugin/UncrustifyCheck/uncrustify_ext_dep.yaml
@@ -0,0 +1,16 @@
+## @file
+# Downloads the Uncrustify application from a Project Mu NuGet package. +#
+# Copyright (c) Microsoft Corporation.
+# SPDX-License-Identifier: BSD-2-Clause-Patent
+##
+{
+  "id": "uncrustify-ci-1",
+  "scope": "cibuild",
+  "type": "nuget",
+  "name": "mu-uncrustify-release",
+  "source": "https://nam06.safelinks.protection.outlook.com/?= url=3Dhttps%3A%2F%2Fpkgs.dev.azure.com%2Fprojectmu%2FUncrustify%2F_packagin= g%2Fmu_uncrustify%2Fnuget%2Fv3%2Findex.json&amp;data=3D04%7C01%7CBret.B= arkelew%40microsoft.com%7Cccfe5bfffa354589afb308d9afaddcc3%7C72f988bf86f141= af91ab2d7cd011db47%7C1%7C0%7C637733983563562870%7CUnknown%7CTWFpbGZsb3d8eyJ= WIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&= amp;sdata=3D98mGcyUQHSPBuYACxle%2BLOqIdKwKWrVTm1DOynzDaSs%3D&amp;reserv= ed=3D0",
+  "version": "73.0.3",
+  "flags": ["set_shell_var", "host_specific&= quot;],
+  "var_name": "UNCRUSTIFY_CI_PATH"
+}
diff --git a/.pytool/Plugin/UncrustifyCheck/uncrustify_plug_in.yaml b/.pyto= ol/Plugin/UncrustifyCheck/uncrustify_plug_in.yaml
new file mode 100644
index 000000000000..06c76af02759
--- /dev/null
+++ b/.pytool/Plugin/UncrustifyCheck/uncrustify_plug_in.yaml
@@ -0,0 +1,11 @@
+## @file
+# CiBuildPlugin used to check coding standard compliance of EDK II style C= source code
+#
+# Copyright (c) Microsoft Corporation.
+# SPDX-License-Identifier: BSD-2-Clause-Patent
+##
+{
+  "scope": "cibuild",
+  "name": "Uncrustify Coding Standard Test",
+  "module": "UncrustifyCheck"
+}
diff --git a/.pytool/Readme.md b/.pytool/Readme.md
index f6505507966a..e0d07f317049 100644
--- a/.pytool/Readme.md
+++ b/.pytool/Readme.md
@@ -264,6 +264,10 @@ BSD-2-Clause-Patent.
 Run the Ecc tool on the package. The Ecc tool is available in the Bas= eTools
 package. It checks that the code complies to the EDKII coding standar= d.
 
+### Coding Standard Compliance - UncrustifyCheck
+
+Runs the Uncrustify application to check for coding standard compliance is= sues.
+
 ## PyTool Scopes
 
 Scopes are how the PyTool ext_dep, path_env, and plugins are activate= d.  Meaning
--
2.28.0.windows.1

 

--_000_MW4PR21MB19076D07A1A80DBDA33C3201EF649MW4PR21MB1907namp_--