edk2/BaseTools/Source/Python/Workspace
Taylor Beebe d77efa2ebe BaseTools: Don't Recurse NULL Includes Not Linked to Module
When collecting the required library instances for modules and
libraries, included libraries will be recursed to ensure the module is
built with all the libraries directly linked to it and indirectly
linked to it via included libraries.

Using the following scenario as an example:

[LibraryClasses.common.DXE_CORE]
NULL|Path/To/Library1.inf // Includes DebugLib

[LibraryClasses.common.DXE_DRIVER]
NULL|Path/To/Library2.inf // Includes DebugLib

[LibraryClasses.common.DXE_CORE, LibraryClasses.common.DXE_DRIVER]
DebugLib|MdePkg/Library/BaseDebugLibSerialPort/BaseDebugLibSerialPort.inf

[Components]
MdeModulePkg/Core/Dxe/DxeMain.inf // Includes DebugLib

The DXE_CORE NULL library will be assigned a fake library class like
NULL1 and the DXE_DRIVER will be assigned NULL2. The recursion logic
will see NULL1 as a directly linked and will add an instance of it to
the list of libraries which need to be included in the module. When
DebugLib is evaluated, the recursion logic will add the libraries
DebugLib depends on to the queue which includes both NULL1 and NULL2.
When NULL2 is unqueued, an instance of it will also be added to the
list of libraries needed to build DxeMain which now means that both
NULL1 and NULL2 have been linked.

NULL includes outside of module overrides are not supported according
to the spec, but we do it anyways so this seems like a case which
should be fixed. This change updates the recursion logic to skip
evaluating NULL libraries unless they are linked directly to the
module/library being evaluated.

Cc: Rebecca Cran <rebecca@bsdio.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Yuwei Chen <yuwei.chen@intel.com>

Signed-off-by: Taylor Beebe <taylor.d.beebe@gmail.com>
Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>
2024-04-15 19:04:08 +00:00
..
__init__.py BaseTools: Replace BSD License with BSD+Patent License 2019-04-09 09:10:20 -07:00
BuildClassObject.py BaseTools: Remove Makefile/MakefileName fields 2021-09-29 14:31:37 +00:00
DecBuildData.py BaseTools: Enable the flag to treat dynamic pcd as dynamicEx 2021-07-12 07:40:07 +00:00
DscBuildData.py BaseTools: Syntax warning invalid escape sequence \C 2024-02-28 00:23:58 +00:00
InfBuildData.py BaseTools: INF should use latest Pcd value instead of default value 2022-07-24 06:46:33 +00:00
MetaDataTable.py BaseTools: Replace BSD License with BSD+Patent License 2019-04-09 09:10:20 -07:00
MetaFileCommentParser.py BaseTools: Replace BSD License with BSD+Patent License 2019-04-09 09:10:20 -07:00
MetaFileParser.py BaseTools: Resolve regex syntax warnings 2023-12-21 00:33:31 +00:00
MetaFileTable.py BaseTools: Correct report the line number in INF file issue 2020-12-22 02:21:26 +00:00
WorkspaceCommon.py BaseTools: Don't Recurse NULL Includes Not Linked to Module 2024-04-15 19:04:08 +00:00
WorkspaceDatabase.py BaseTools: Remove the file timestamp checking during parsing 2020-07-21 04:12:32 +00:00