edk2/BaseTools
Chris Fernald 27ac8fac0b BaseTools: Add support for preserving build ID
Adds an optional flag that copies the GNU build-id note from the input
ELF file into the output PE/COFF firmware image as a dedicated ".bldid"
section. The build ID is emitted by the linker as a unique fingerprint
of the binary and allows custom post-build and debugging tools to
reliably match a firmware image against its corresponding unstripped
ELF and debug symbols, without relying on file names, timestamps, or
build paths.

This notable opts to use a non-standard section name ".bldid" to store
the build ID. This approach was chosen to keep genfw and the parsers simple
since the full "build-id" name would require redirecting the section name.
While this breaks from standard conventions, this is not impactful since
GenFW is already creating a non-standard artifact for the PE image with
the associated ELF symbol file.

Signed-off-by: Chris Fernald <chfernal@microsoft.com>
2026-07-22 18:06:03 +00:00
..
Bin BaseTools: Update nasm to 2.16.01 2025-12-09 04:56:10 +00:00
BinWrappers Revert "BaseTools: Add support for out-of-tree builds" 2026-02-11 22:53:29 +00:00
Conf BaseTools: Enable stack protector for LoongArch64 2026-07-07 08:49:21 +00:00
Plugin BaseTools/Plugin/CodeQL: Add CodeQL version update script 2026-07-11 01:26:20 +00:00
Scripts BaseTools: Remove SetVisualStudio.bat 2026-06-30 21:42:50 +00:00
Source BaseTools: Add support for preserving build ID 2026-07-22 18:06:03 +00:00
Tests BaseTools/Tests: Update TC6 for backward-compatible rebase behavior 2026-07-15 21:37:05 +00:00
UserManuals BaseTools: Remove DXE_SAL_DRIVER 2025-10-30 10:00:32 +00:00
.gitignore BaseTools: Adding cross compilation of BaseTool for Windows ARM/ARM64 2024-12-20 22:57:04 +00:00
basetools_calling_path_env.yaml BaseTools: Add YAML files with path env and tool extdeps 2019-11-11 13:01:53 -08:00
basetools_path_env.yaml BaseTools: Add YAML files with path env and tool extdeps 2019-11-11 13:01:53 -08:00
BuildEnv BaseTools: Remove Pip BaseTools 2024-09-10 00:41:53 +00:00
Edk2ToolsBuild.py BaseTools: Edk2BaseToolsBuild.py: Clean Before Building on Windows 2026-05-29 05:28:53 +00:00
get_vsvars.bat BaseTools: Remove VS2017 support 2026-06-30 21:42:50 +00:00
GNUmakefile BaseTools: Replace BSD License with BSD+Patent License 2019-04-09 09:10:20 -07:00
Makefile BaseTools: Add support for mingw-w64 2025-06-07 17:56:04 +00:00
ReadMe.rst BaseTools: Add reference to new build instructions 2022-12-16 22:17:18 +00:00
set_vsprefix_envs.bat BaseTools: Remove VS2017 support 2026-06-30 21:42:50 +00:00
toolsetup.bat BaseTools: Remove VS2017 support 2026-06-30 21:42:50 +00:00

::

  Note: New build instructions are available. It is recommended to start with
  the new instructions if learning how to build edk2 and/or BaseTools for the
  first time. This page is retained for reference.

New instructions: `Build Instructions`_

.. _`Build Instructions`: https://github.com/tianocore/tianocore.github.io/wiki/Build-Instructions

This directory contains the EDK II build tools and template files.
Templates are located in the Conf directory, while the tools executables for
Microsoft Windows Operating Systems are located in the Bin\\Win32 directory, other
directory contains tools source.

Build step to generate the binary tools
---------------------------------------

Windows/Visual Studio Notes
===========================

To build the BaseTools, you should run the standard vsvars32.bat script
from your preferred Visual Studio installation or you can run get_vsvars.bat
to use latest automatically detected version.

In addition to this, you should set the following environment variables::

 * EDK_TOOLS_PATH - Path to the BaseTools sub directory under the edk2 tree
 * BASE_TOOLS_PATH - The directory where the BaseTools source is located.
   (It is the same directory where this README.rst is located.)

After this, you can run the toolsetup.bat file, which is in the same
directory as this file.  It should setup the remainder of the environment,
and build the tools if necessary.

Unix-like operating systems
===========================

To build on Unix-like operating systems, you only need to type ``make`` in
the base directory of the project.

Ubuntu Notes
============

On Ubuntu, the following command should install all the necessary build
packages to build all the C BaseTools::

 sudo apt install build-essential uuid-dev