edk2/BaseTools
Oliver Smith-Denny 361cd6b3bd BaseTools: tools_def: Add support for CLANGPDB with AARCH64
This change adds the support for building AARCH64 target platforms using
CLANGPDB.

This applies a 4KB section alignment for all AArch64 modules built
with CLANGPDB for multiple reasons:
  - DXE and Standalone MM modules should have memory protections applied
  - There is a bug in llvm that allows for code generation that ends up
    requiring 4KB section alignment, see
    https://github.com/llvm/llvm-project/issues/172660.

This also adds a build rule to use DLINK_XIPFLAGS to ensure a file
alignment of 4KB for SEC/PEI modules to ensure file alignment and
section alignment match.

Signed-off-by: Oliver Smith-Denny <osde@microsoft.com>
2026-01-15 17:10:46 +00:00
..
Bin BaseTools: Update nasm to 2.16.01 2025-12-09 04:56:10 +00:00
BinWrappers BaseTools: Add FMMT Python Tool 2022-05-06 04:22:21 +00:00
Conf BaseTools: tools_def: Add support for CLANGPDB with AARCH64 2026-01-15 17:10:46 +00:00
Plugin BaseTools: Add VS2026 support. 2026-01-07 20:19:12 +00:00
Scripts BaseTools/PatchCheck.py: Disallow commit subject lines that end with period 2026-01-12 12:37:59 +00:00
Source BaseTools/Source/C/Makefiles: Detect cycle in pids 2026-01-06 06:27:41 +00:00
Tests BaseTools: GNUMakefiles must use CMD.EXE in Windows 2025-12-24 02:03:38 +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: Add CLANG support to Edk2ToolsBuild.py 2025-12-26 18:47:08 +00:00
get_vsvars.bat BaseTools: Remove VS2008-VS2013 remnants 2023-05-05 11:41:35 +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: Add VS2026 support. 2026-01-07 20:19:12 +00:00
toolsetup.bat BaseTools: Add VS2026 support. 2026-01-07 20:19:12 +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