Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix arm64 cross compilation in docker build on amd64 #191

Merged
merged 1 commit into from
Jun 3, 2024

Conversation

isZumpo
Copy link
Contributor

@isZumpo isZumpo commented Jun 2, 2024

As mentioned in v0.5.4 release discussion

There have been issues running the linux/arm64 image since PR #176 which fixed the linux/amd64 build and introduced improvements to the cross-compilation process by utilizing BUILDPLATFORM. Since this PR cross-compilation provided by the build system will be used rather than emulation in the docker build. Unfortunately, this change does require some more changes to the Dockerfile/makefile to work as expected.

Currently, the arm64 image contains the amd64 binaries. Due to how the Dockerfile calls the make file without an argument, leading to this piece of code to be executed:

# Default action
all: $(LABELS_ZIP) $(NATIVE_TARGET)

which depends on this:

# Detect host architecture
UNAME_M := $(shell uname -m)
ifeq ($(UNAME_M),x86_64)
    NATIVE_TARGET := linux_amd64
else ifeq ($(UNAME_M),aarch64)
    NATIVE_TARGET := linux_arm64
else
    $(error Unsupported architecture)
endif

Since this part of the code no longer is being emulated by docker, uname -m will always return x86_64. Causing it to always be built even when --platform arm64 is requested.

This PR fixes that issue by instead calling the correct make target directly from the Dockerfile. Also had to install gcc-aarch64-linux-gnu for cross-compilation support in the dockerfile.

This time I went ahead and tried both arm64 and amd64 to be on the safe side after building with:

docker buildx build --platform=linux/arm64,linux/amd64 --tag test .

docker run --platform linux/arm64 docker.io/library/test:latest
Created default config file at: /root/.config/birdnet-go/config.yaml
BirdNET-Go build date: 2024-06-02T22:32:45Z, using config file: /root/.config/birdnet-go/config.yaml
BirdNET GLOBAL 6K V2.4 FP32 model initialized, using 8 threads of available 8 CPUs
System details: linux debian 12.5 on  hardware
Starting analyzer in realtime mode. Threshold: 0.8, sensitivity: 1, interval: 15
Logging disabled
2024/06/02 22:39:15 Clip retention policy: usage
⇨ http server started on [::]:8080


docker run --platform linux/amd64 docker.io/library/test:latest
Created default config file at: /root/.config/birdnet-go/config.yaml
BirdNET-Go build date: 2024-06-02T22:32:48Z, using config file: /root/.config/birdnet-go/config.yaml
BirdNET GLOBAL 6K V2.4 FP32 model initialized, using 8 threads of available 8 CPUs
System details: linux debian 12.5 on unknown hardware
Starting analyzer in realtime mode. Threshold: 0.8, sensitivity: 1, interval: 15
Logging disabled
⇨ http server started on [::]:8080

Copy link
Contributor

coderabbitai bot commented Jun 2, 2024

Walkthrough

The Dockerfile has been updated to include the installation of the gcc-aarch64-linux-gnu package and to modify the build process to accommodate different platforms using the TARGETPLATFORM argument. This change enhances the Docker build's flexibility and cross-platform compatibility.

Changes

Files Change Summary
Dockerfile Added gcc-aarch64-linux-gnu package installation and modified build process to handle different platforms using TARGETPLATFORM argument.

Poem

In Docker's world, a change we see,
For platforms wide, with glee and spree.
gcc-aarch64 joins the crew,
To build for many, old and new.
Flexibility now our Docker's might,
A future bright, in code's clear light.
🐇✨

Warning

Review ran into problems

Problems (1)
  • Git: Failed to clone repository. Please contact CodeRabbit support.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6bc12a5 and b96b50b.

Files selected for processing (1)
  • Dockerfile (2 hunks)

@@ -9,6 +9,7 @@ RUN apt-get update && apt-get install -y \
git \
sudo \
zip \
gcc-aarch64-linux-gnu \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure gcc-aarch64-linux-gnu is only installed when building for arm64.

To optimize the build process and avoid unnecessary installations on platforms that do not require this package, consider conditionally installing gcc-aarch64-linux-gnu based on the TARGETPLATFORM. Here's a suggested modification:

+ RUN if [ "$TARGETPLATFORM" = "linux/arm64" ]; then \
+     apt-get install -y gcc-aarch64-linux-gnu; \
+ fi
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
gcc-aarch64-linux-gnu \
RUN if [ "$TARGETPLATFORM" = "linux/arm64" ]; then \
apt-get install -y gcc-aarch64-linux-gnu; \
fi

Comment on lines +47 to +53
PLATFORM='unknown'; \
case "${TARGETPLATFORM}" in \
"linux/amd64") PLATFORM='linux_amd64' ;; \
"linux/arm64") PLATFORM='linux_arm64' ;; \
*) echo "Unsupported platform: '${TARGETPLATFORM}'" && exit 1 ;; \
esac; \
cd BirdNET-Go && make ${PLATFORM}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove redundancy in setting the PLATFORM variable.

The PLATFORM variable is set twice in the Dockerfile, which could lead to maintenance issues and makes the file harder to read. Consider setting this variable once in a shared stage or script to ensure consistency and reduce redundancy. Here's a suggested refactor:

- PLATFORM='unknown'; \
- case "${TARGETPLATFORM}" in \
-     "linux/amd64") PLATFORM='linux_amd64' ;; \
-     "linux/arm64") PLATFORM='linux_arm64' ;; \
-     *) echo "Unsupported platform: '${TARGETPLATFORM}'" && exit 1 ;; \
- esac; \
- cd BirdNET-Go && make ${PLATFORM}
+ cd BirdNET-Go && make ${PLATFORM}

Ensure that PLATFORM is correctly set in a previous stage or in a script that is included before this command.

Committable suggestion was skipped due low confidence.

@tphakala tphakala merged commit d6519a6 into tphakala:main Jun 3, 2024
6 checks passed
@isZumpo isZumpo deleted the fix_docker_arm64 branch June 3, 2024 19:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants