From 9bdba109baea30e45a4966dedcc689b34956505a Mon Sep 17 00:00:00 2001
From: Michael Kubacki <michael.kubacki@microsoft.com>
Date: Wed, 19 Jun 2024 18:53:19 -0400
Subject: [PATCH] BaseTools/Plugin/FlattenPdbs: Add plugin

A build plugin that copies all PDB file to a single directory this
can make publishing symbols easier and reduce the size of modules
using ALT PDB path.

Co-authored-by: Bret Barkelew <bret.barkelew@microsoft.com>
Co-authored-by: Joey Vagedes <joey.vagedes@gmail.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
---
 BaseTools/Plugin/FlattenPdbs/FlattenPdbs.py   | 48 +++++++++++++++++++
 .../FlattenPdbs/FlattenPdbs_plug_in.yaml      | 13 +++++
 2 files changed, 61 insertions(+)
 create mode 100644 BaseTools/Plugin/FlattenPdbs/FlattenPdbs.py
 create mode 100644 BaseTools/Plugin/FlattenPdbs/FlattenPdbs_plug_in.yaml

diff --git a/BaseTools/Plugin/FlattenPdbs/FlattenPdbs.py b/BaseTools/Plugin/FlattenPdbs/FlattenPdbs.py
new file mode 100644
index 00000000000..14bc874d44a
--- /dev/null
+++ b/BaseTools/Plugin/FlattenPdbs/FlattenPdbs.py
@@ -0,0 +1,48 @@
+# @file FlattenPdbs.py
+# Plugin to support copying all PDBs to 1 directory.
+# This makes symbol publishing easier and with the usage of
+# ALT PDB PATH can shrink the size of each module.
+#
+# Copyright (c) Microsoft Corporation.
+# SPDX-License-Identifier: BSD-2-Clause-Patent
+#
+###
+from edk2toolext.environment.plugintypes.uefi_build_plugin import IUefiBuildPlugin
+import logging
+from pathlib import Path
+
+
+class FlattenPdbs(IUefiBuildPlugin):
+
+    def do_post_build(self, thebuilder):
+        # Path to Build output
+        build_path = Path(thebuilder.env.GetValue("BUILD_OUTPUT_BASE"))
+        # Path to where the PDBs will be stored
+        pdb_path = Path(build_path, "PDB")
+
+        try:
+            if not pdb_path.is_dir():
+                pdb_path.mkdir()
+        except Exception:
+            logging.critical("Error making PDB directory")
+
+        logging.critical("Copying PDBs to flat directory")
+        for file in Path(build_path).rglob("*.pdb"):
+            # PDB exists in DEBUG and OUTPUT directory. Same file.
+            pdb_out = Path(pdb_path / file.name)
+            if file.parent.name != "OUTPUT":
+                continue
+
+            # If it exists and has the same file identifier, skip it.
+            if pdb_out.exists() and file.stat().st_ino == pdb_out.stat().st_ino:
+                continue
+
+            if "vc1" in file.name.lower():
+                continue
+
+            # Hard link it, which is slightly faster, but mainly allows us to tell
+            # if the file has changed (st_ino is different)
+            pdb_out.unlink(missing_ok=True)
+            pdb_out.hardlink_to(file)
+
+        return 0
diff --git a/BaseTools/Plugin/FlattenPdbs/FlattenPdbs_plug_in.yaml b/BaseTools/Plugin/FlattenPdbs/FlattenPdbs_plug_in.yaml
new file mode 100644
index 00000000000..eff678d51f1
--- /dev/null
+++ b/BaseTools/Plugin/FlattenPdbs/FlattenPdbs_plug_in.yaml
@@ -0,0 +1,13 @@
+## @file FlattenPdbs_plug_in.py
+#
+# Build plugin used to flatten PDB files to a single directory.
+#
+# Copyright (c) Microsoft Corporation.
+# SPDX-License-Identifier: BSD-2-Clause-Patent
+##
+
+{
+  "scope": "global",
+  "name": "Flatten PDBs UEFI Build Plugin",
+  "module": "FlattenPdbs"
+}