Update the BrotliCompress module

Oct 13, 2025 by thesweetdesigns.com 38 views

Introduction

This article describes a bug in the edk2 repository, specifically in the BrotliCompress module, which causes a build error when compiling edk2 on Ubuntu 24.04 using the stable/202011 branch. The bug is related to undefined references to certain symbols in the BrotliCompress code.

Background

The edk2 repository is a collection of open-source firmware and tools for building UEFI firmware. The BrotliCompress module is a part of the edk2 repository and is used for compressing data. The stable/202011 branch is a specific version of the edk2 repository that is known to work on Ubuntu 24.04.

Problem Description

When trying to compile edk2 on Ubuntu 24.04 using the stable/202011 branch, the build process fails with a series of undefined reference errors in the BrotliCompress module. The errors are related to symbols such as _kBrotliPrefixCodeRanges, _kBrotliContextLookupTable, and kBrotliLog2Table, which are not defined in the BrotliCompress code.

Steps to Reproduce

To reproduce the bug, follow these steps:

Install Ubuntu 24.04 and update it completely.
Clone the edk2 repository using the stable/202011 branch.
Navigate to the edk2/BaseTools/Source/C/BrotliCompress directory.
Run the make command to build the BrotliCompress module.
Observe the undefined reference errors in the build output.

Expected Behavior

The expected behavior is that the BrotliCompress module should build successfully without any undefined reference errors.

Build Environment

The build environment is as follows:

OS: Ubuntu 24.04
Tool Chain:
- automake: 1:1.16.5-1.3ubuntu1
- build-essential: 12.10ubuntu1
- clang: 1:18.0-59~exp2
- clang-18: 1:18.1.3-1ubuntu1
- cmake: 3.28.3-1build7
- cmake-data: 3.28.3-1build7
- gcc: 4:13.2.0-7ubuntu1
- gcc-13: 13.3.0-6ubuntu2~24.04
- gcc-13-base:amd64: 13.3.0-6ubuntu2~24.04
- gcc-13-x86-64-linux-gnu: 13.3.0-6ubuntu2~24.04
- gcc-14-base:amd64: 14.2.0-4ubuntu2~24.04
- gcc-x86-64-linux-gnu: 4:13.2.0-7ubuntu1
- git: 1:2.43.0-1ubuntu7.2
- git-man: 1:2.43.0-1ubuntu7.2
- nasm: 2.16.01-1build1
- python-is-python3: 3.11.4-1
- python3-pip: 24.0+dfsg-1ubuntu1.1
- python3-setuptools: 68.1.2-2ubuntu1.1
- uuid-dev:amd64: 2.39.3-9ubuntu6.2

Version Information

The version of the edk2 repository being used is stable/202011.

Urgency

The urgency of this bug is low, as it only affects the BrotliCompress module and does not prevent the entire edk2 repository from building.

Are you going to fix this?

No, someone else needs to fix this bug.

Do you need maintainer feedback?

Yes, maintainer feedback is requested to resolve this issue.

Anything else?

No additional information is available.

Conclusion

In conclusion, the bug in the edk2 repository, specifically in the BrotliCompress module, causes a build error when compiling edk2 on Ubuntu 24.04 using the stable/202011 branch. The bug is related to undefined references to certain symbols in the BrotliCompress code. To resolve this issue, the maintainer of the edk2 repository needs to fix the BrotliCompress module to define the missing symbols or update the build process to handle the undefined references.

Possible Solutions

Update the BrotliCompress module: Update the BrotliCompress module to define the missing symbols or update the build process to handle the undefined references.
Use a different version of the edk2 repository: Use a different version of the edk2 repository that does not have this issue.
Patch the BrotliCompress module: Patch the BrotliCompress module to fix the undefined reference errors.

Future Work

In the future, it would be beneficial to:

Improve the build process: Improve the build process to handle undefined references and other build errors.
Update the BrotliCompress module: Update the BrotliCompress module to use a more modern and stable compression algorithm.
Add more testing: Add more testing to the edk2 repository to catch build errors and other issues earlier.
Q&A: [Bug]: compile edk2 on Ubuntu 24.04 using stable/202011 fails due to BrotliCompress build error

Q: What is the issue with the BrotliCompress module in the edk2 repository?

A: The issue is that the BrotliCompress module is causing a build error when compiling edk2 on Ubuntu 24.04 using the stable/202011 branch. The error is related to undefined references to certain symbols in the BrotliCompress code.

Q: What are the specific symbols that are causing the undefined reference errors?

A: The specific symbols that are causing the undefined reference errors are _kBrotliPrefixCodeRanges, _kBrotliContextLookupTable, and kBrotliLog2Table.

Q: Why are these symbols not defined in the BrotliCompress code?

A: The symbols are not defined in the BrotliCompress code because they are not implemented in the current version of the module.

Q: How can I fix this issue?

A: To fix this issue, you can either update the BrotliCompress module to define the missing symbols or update the build process to handle the undefined references.

Q: What are the possible solutions to this issue?

A: The possible solutions to this issue are:

Update the BrotliCompress module: Update the BrotliCompress module to define the missing symbols or update the build process to handle the undefined references.
Use a different version of the edk2 repository: Use a different version of the edk2 repository that does not have this issue.
Patch the BrotliCompress module: Patch the BrotliCompress module to fix the undefined reference errors.

Q: What are the benefits of updating the BrotliCompress module?

A: The benefits of updating the BrotliCompress module are:

Improved build process: Updating the BrotliCompress module will improve the build process by fixing the undefined reference errors.
More stable compression algorithm: Updating the BrotliCompress module will use a more modern and stable compression algorithm.
Better performance: Updating the BrotliCompress module will improve the performance of the edk2 repository.

Q: What are the benefits of using a different version of the edk2 repository?

A: The benefits of using a different version of the edk2 repository are:

Avoid build errors: Using a different version of the edk2 repository will avoid the build errors caused by the BrotliCompress module.
More stable repository: Using a different version of the edk2 repository will use a more stable repository.
Easier maintenance: Using a different version of the edk2 repository will make it easier to maintain the repository.

Q: What are the benefits of patching the BrotliCompress module?

A: The benefits of patching the BrotliCompress module are:

Quick fix: Patching the BrotliCompress module will provide a quick fix to the issue.
Less maintenance: Patching the BrotliCompress module will require less maintenance than updating the entire module.
Temporary solution: Patching the BrotliCompress module will provide a temporary solution to the issue until a more permanent solution is found.

Q: What are the next steps to resolve this issue?

A: The next steps to resolve this issue are:

Update the BrotliCompress module: Update the BrotliCompress module to define the missing symbols or update the build process to handle the undefined references.
Test the updated module: Test the updated module to ensure that it works correctly.
Merge the updated module: Merge the updated module into the edk2 repository.

Q: Who should fix this issue?

A: The maintainer of the edk2 repository should fix this issue.

Q: Do you need maintainer feedback?

A: Yes, maintainer feedback is requested to resolve this issue.