-
Notifications
You must be signed in to change notification settings - Fork 253
pkg/architecture: Add architecture support validation #1783
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
Open
DaliborKr
wants to merge
6
commits into
containers:main
Choose a base branch
from
DaliborKr:pr04-arch-validation
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+520
−13
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
7cad7ed
pkg/shell: Preserve error types in shell command execution
DaliborKr fae8f4a
cmd/create: Extract spinner setup into helper functions
DaliborKr ddebd00
pkg/utils: Add IsSupportedDistroImage for image to supported distro m…
DaliborKr 211ab94
pkg/architecture: Define core architecture types and constants
DaliborKr a0a4ede
pkg/architecture: Add sandboxed binfmt_misc registration support
DaliborKr 8fe8ef5
pkg/architecture: Add architecture support validation
DaliborKr File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,293 @@ | ||||||
| /* | ||||||
| * Copyright © 2019 – 2026 Red Hat Inc. | ||||||
| * | ||||||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||||||
| * you may not use this file except in compliance with the License. | ||||||
| * You may obtain a copy of the License at | ||||||
| * | ||||||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||||||
| * | ||||||
| * Unless required by applicable law or agreed to in writing, software | ||||||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||||||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||||||
| * See the License for the specific language governing permissions and | ||||||
| * limitations under the License. | ||||||
| */ | ||||||
|
|
||||||
| package architecture | ||||||
|
|
||||||
| import ( | ||||||
| "debug/elf" | ||||||
| "errors" | ||||||
| "fmt" | ||||||
| "os" | ||||||
| "os/exec" | ||||||
| "runtime" | ||||||
| "strings" | ||||||
|
|
||||||
| "github.com/containers/toolbox/pkg/utils" | ||||||
| "github.com/sirupsen/logrus" | ||||||
| ) | ||||||
|
|
||||||
| type Architecture struct { | ||||||
| ID int | ||||||
| NameBinfmt string | ||||||
| NameOCI string | ||||||
| Aliases []string | ||||||
| ELFMagic []byte | ||||||
| ELFMask []byte | ||||||
|
|
||||||
| BinfmtFlags string | ||||||
| BinfmtName string | ||||||
| BinfmtMagicType string | ||||||
| BinfmtOffset string | ||||||
| } | ||||||
|
|
||||||
| type Config struct { | ||||||
| ID int | ||||||
| QemuEmulatorPath string | ||||||
| } | ||||||
|
|
||||||
| const ( | ||||||
| NotSpecified = iota | ||||||
| Aarch64 | ||||||
| Ppc64le | ||||||
| X86_64 | ||||||
| ) | ||||||
|
|
||||||
| var supportedArchitectures = map[int]Architecture{ | ||||||
| Aarch64: { | ||||||
| ID: Aarch64, | ||||||
| NameBinfmt: "aarch64", | ||||||
| NameOCI: "arm64", | ||||||
| Aliases: []string{"aarch64", "arm64"}, | ||||||
| ELFMagic: []byte{0x7f, 0x45, 0x4c, 0x46, 0x02, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0x00, 0xb7, 0x00}, | ||||||
| ELFMask: []byte{0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xfe, 0xff, 0xff, 0xff}, | ||||||
| }, | ||||||
| Ppc64le: { | ||||||
| ID: Ppc64le, | ||||||
| NameBinfmt: "ppc64le", | ||||||
| NameOCI: "ppc64le", | ||||||
| Aliases: []string{"ppc64le"}, | ||||||
| ELFMagic: []byte{0x7f, 0x45, 0x4c, 0x46, 0x02, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0x00, 0x15, 0x00}, | ||||||
| ELFMask: []byte{0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xfe, 0xff, 0xff, 0x00}, | ||||||
| }, | ||||||
| X86_64: { | ||||||
| ID: X86_64, | ||||||
| NameBinfmt: "x86_64", | ||||||
| NameOCI: "amd64", | ||||||
| Aliases: []string{"x86_64", "amd64"}, | ||||||
| ELFMagic: []byte{0x7f, 0x45, 0x4c, 0x46, 0x02, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0x00, 0x3e, 0x00}, | ||||||
| ELFMask: []byte{0xff, 0xff, 0xff, 0xff, 0xff, 0xfe, 0xfe, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xfe, 0xff, 0xff, 0xff}, | ||||||
| }, | ||||||
| } | ||||||
|
|
||||||
| var ( | ||||||
| HostArchID int | ||||||
| supportedArgArchValues map[string]int | ||||||
| ) | ||||||
|
|
||||||
| func init() { | ||||||
| supportedArgArchValues = make(map[string]int) | ||||||
| for archID, arch := range supportedArchitectures { | ||||||
| for _, alias := range arch.Aliases { | ||||||
| supportedArgArchValues[alias] = archID | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| HostArchID, _ = ParseArgArchValue(runtime.GOARCH) | ||||||
| } | ||||||
|
|
||||||
| func GetArchConfigDefault() Config { | ||||||
| return Config{ | ||||||
| ID: HostArchID, | ||||||
| QemuEmulatorPath: "", | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| func getArchitecture(archID int) (Architecture, bool) { | ||||||
| arch, exists := supportedArchitectures[archID] | ||||||
| return arch, exists | ||||||
| } | ||||||
|
|
||||||
| func getArchNameBinfmt(arch int) string { | ||||||
| if arch == NotSpecified { | ||||||
| logrus.Warnf("Getting arch name for not specified architecture") | ||||||
| return "arch_not_specified" | ||||||
| } | ||||||
| if archObj, exists := supportedArchitectures[arch]; exists { | ||||||
| return archObj.NameBinfmt | ||||||
| } | ||||||
| return "" | ||||||
| } | ||||||
|
|
||||||
| func GetArchNameOCI(arch int) string { | ||||||
| if arch == NotSpecified { | ||||||
| logrus.Warnf("Getting arch name for not specified architecture") | ||||||
| return "arch_not_specified" | ||||||
| } | ||||||
| if archObj, exists := supportedArchitectures[arch]; exists { | ||||||
| return archObj.NameOCI | ||||||
| } | ||||||
| return "" | ||||||
| } | ||||||
|
|
||||||
| func HasContainerNativeArch(archID int) bool { | ||||||
| return archID == HostArchID | ||||||
| } | ||||||
|
|
||||||
| func ImageReferenceGetArchFromTag(image string) int { | ||||||
| tag := utils.ImageReferenceGetTag(image) | ||||||
|
|
||||||
| if tag == "" { | ||||||
| return NotSpecified | ||||||
| } | ||||||
|
|
||||||
| i := strings.LastIndexByte(tag, '-') | ||||||
| if i == -1 { | ||||||
| return NotSpecified | ||||||
| } | ||||||
|
|
||||||
| archInTag := tag[i+1:] | ||||||
|
|
||||||
| for archID, arch := range supportedArchitectures { | ||||||
| if arch.NameBinfmt == archInTag || arch.NameOCI == archInTag { | ||||||
| return archID | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| return NotSpecified | ||||||
| } | ||||||
|
|
||||||
| func IsArchSupportedOnCreation(archID int) (string, error) { | ||||||
| archName := getArchNameBinfmt(archID) | ||||||
| archNameDebug := GetArchNameOCI(archID) | ||||||
| logrus.Debugf("Checking QEMU emulation support for architecture %s", archNameDebug) | ||||||
|
|
||||||
| qemuBinaryPossibleNames := []string{ | ||||||
| fmt.Sprintf("qemu-%s-static", archName), | ||||||
| fmt.Sprintf("qemu-%s", archName), | ||||||
| } | ||||||
|
|
||||||
| foundQemuBinaryPath := "" | ||||||
| for _, qemuName := range qemuBinaryPossibleNames { | ||||||
| qemuBinaryPath, err := exec.LookPath(qemuName) | ||||||
|
|
||||||
| if err != nil { | ||||||
| if errors.Is(err, exec.ErrNotFound) { | ||||||
| continue | ||||||
| } | ||||||
|
|
||||||
| return "", fmt.Errorf("failed to look up binary '%s': %w", qemuName, err) | ||||||
| } | ||||||
|
|
||||||
| if isStaticallyLinkedELF(qemuBinaryPath) { | ||||||
| foundQemuBinaryPath = qemuBinaryPath | ||||||
| break | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| if foundQemuBinaryPath == "" { | ||||||
| err := fmt.Errorf("The host system does not have the required support: No %s statically linked QEMU emulator binary found", archNameDebug) | ||||||
| return "", err | ||||||
| } | ||||||
|
|
||||||
| if !validateBinfmtRegistration(archID, false) { | ||||||
| err := fmt.Errorf("The host system does not have the required support: No %s binfmt_misc registration found", archNameDebug) | ||||||
| return "", err | ||||||
| } | ||||||
|
|
||||||
| return foundQemuBinaryPath, nil | ||||||
| } | ||||||
|
|
||||||
| func IsArchSupportedOnInitialization(archID int, interpreterPath string) (string, error) { | ||||||
| archName := getArchNameBinfmt(archID) | ||||||
| archNameDebug := GetArchNameOCI(archID) | ||||||
| logrus.Debugf("Checking QEMU emulation support for architecture %s", archNameDebug) | ||||||
|
|
||||||
| if isStaticallyLinkedELF(interpreterPath) { | ||||||
| if !validateBinfmtRegistration(archID, true) { | ||||||
| return "", fmt.Errorf("The host system does not have the required support: No %s binfmt_misc registration found", archNameDebug) | ||||||
| } | ||||||
| return interpreterPath, nil | ||||||
| } | ||||||
|
|
||||||
| // Fallback: check standard locations on the host | ||||||
| logrus.Debugf("Interpreter at %s not found or not statically linked, checking fallback locations in '/run/host/usr/bin/'", interpreterPath) | ||||||
| fmt.Fprintf(os.Stderr, "Warning: QEMU emulator not found at expected path '%s', using fallback at '/run/host/usr/bin/'\n", interpreterPath) | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Bypassing the logging system by writing directly to
Suggested change
|
||||||
|
|
||||||
| qemuBinaryPossiblePaths := []string{ | ||||||
| fmt.Sprintf("/run/host/usr/bin/qemu-%s-static", archName), | ||||||
| fmt.Sprintf("/run/host/usr/bin/qemu-%s", archName), | ||||||
| } | ||||||
|
|
||||||
| for _, qemuPath := range qemuBinaryPossiblePaths { | ||||||
| if isStaticallyLinkedELF(qemuPath) { | ||||||
| logrus.Debugf("Found valid QEMU binary at %s", qemuPath) | ||||||
|
|
||||||
| if !validateBinfmtRegistration(archID, true) { | ||||||
| return "", fmt.Errorf("The host system does not have the required support: No %s binfmt_misc registration found", archNameDebug) | ||||||
| } | ||||||
| return qemuPath, nil | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| return "", fmt.Errorf("The host system does not have the required support: No %s statically linked QEMU emulator binary found", archNameDebug) | ||||||
| } | ||||||
|
|
||||||
| func isStaticallyLinkedELF(filePath string) bool { | ||||||
| if !utils.PathExists(filePath) { | ||||||
| logrus.Debugf("File '%s' does not exist\n", filePath) | ||||||
| return false | ||||||
| } | ||||||
|
|
||||||
| f, err := elf.Open(filePath) | ||||||
| if err != nil { | ||||||
| logrus.Debugf("File '%s' is not an ELF file\n", filePath) | ||||||
| return false | ||||||
| } | ||||||
| defer f.Close() | ||||||
|
|
||||||
| // Check for PT_INTERP program header | ||||||
| for _, prog := range f.Progs { | ||||||
| if prog.Type == elf.PT_INTERP { | ||||||
| // Dynamically linked | ||||||
| logrus.Debugf("File '%s' is dynamically linked\n", filePath) | ||||||
| return false | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| // Statically linked | ||||||
| return true | ||||||
| } | ||||||
|
|
||||||
| func ParseArgArchValue(value string) (int, error) { | ||||||
| archID, exists := supportedArgArchValues[value] | ||||||
| if !exists { | ||||||
| return NotSpecified, fmt.Errorf("architecture '%s' is not supported by Toolbx", value) | ||||||
| } | ||||||
|
|
||||||
| return archID, nil | ||||||
| } | ||||||
|
|
||||||
| func validateBinfmtRegistration(archID int, withinContainer bool) bool { | ||||||
| archName := getArchNameBinfmt(archID) | ||||||
| inContainerPathPrefix := "" | ||||||
|
|
||||||
| if withinContainer { | ||||||
| inContainerPathPrefix = "/run/host" | ||||||
| } | ||||||
|
|
||||||
| qemuBinfmtPossiblePaths := []string{ | ||||||
| fmt.Sprintf("%s/proc/sys/fs/binfmt_misc/qemu-%s", inContainerPathPrefix, archName), | ||||||
| fmt.Sprintf("%s/proc/sys/fs/binfmt_misc/qemu-%s-static", inContainerPathPrefix, archName), | ||||||
| } | ||||||
|
|
||||||
| for _, binfmtPath := range qemuBinfmtPossiblePaths { | ||||||
| if utils.PathExists(binfmtPath) { | ||||||
| logrus.Debugf("Architecture %s is supported", archName) | ||||||
| return true | ||||||
| } | ||||||
| } | ||||||
| return false | ||||||
| } | ||||||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If
archIDisNotSpecified, this function proceeds to look for a binary namedqemu-arch_not_specified-static, which will fail and result in a confusing error message for the user. It would be better to validate thatarchIDis a supported architecture at the beginning of the function.