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

feat(gnovm/pkg/gnolang): add build constraints to fail on 32-bit architectures #3643

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

odeke-em
Copy link
Contributor

This change adds build constraints so as to panic if built for 32-bit architectures as it is a project wide decision not to support them.

This allows the mainnet launch without sweating trying to make a bunch of runtime changes for the gnovm.

Updates #3288

@github-actions github-actions bot added the 📦 🤖 gnovm Issues or PRs gnovm related label Jan 30, 2025
@Gno2D2 Gno2D2 requested a review from a team January 30, 2025 10:53
@Gno2D2 Gno2D2 added the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Jan 30, 2025
@Gno2D2
Copy link
Collaborator

Gno2D2 commented Jan 30, 2025

🛠 PR Checks Summary

All Automated Checks passed. ✅

Manual Checks (for Reviewers):
  • IGNORE the bot requirements for this PR (force green CI check)
  • The pull request description provides enough details (checked by @aeddi)
Read More

🤖 This bot helps streamline PR reviews by verifying automated checks and providing guidance for contributors and reviewers.

✅ Automated Checks (for Contributors):

🟢 Maintainers must be able to edit this pull request (more info)
🟢 Pending initial approval by a review team member, or review from tech-staff

☑️ Contributor Actions:
  1. Fix any issues flagged by automated checks.
  2. Follow the Contributor Checklist to ensure your PR is ready for review.
    • Add new tests, or document why they are unnecessary.
    • Provide clear examples/screenshots, if necessary.
    • Update documentation, if required.
    • Ensure no breaking changes, or include BREAKING CHANGE notes.
    • Link related issues/PRs, where applicable.
☑️ Reviewer Actions:
  1. Complete manual checks for the PR, including the guidelines and additional checks if applicable.
📚 Resources:
Debug
Automated Checks
Maintainers must be able to edit this pull request (more info)

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 The pull request was created from a fork (head branch repo: odeke-em/gno)

Then

🟢 Requirement satisfied
└── 🟢 Maintainer can modify this pull request

Pending initial approval by a review team member, or review from tech-staff

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 Not (🔴 Pull request author is a member of the team: tech-staff)

Then

🟢 Requirement satisfied
└── 🟢 If
    ├── 🟢 Condition
    │   └── 🟢 Or
    │       ├── 🟢 At least 1 user(s) of the organization reviewed the pull request (with state "APPROVED")
    │       ├── 🟢 At least 1 user(s) of the team tech-staff reviewed pull request
    │       └── 🔴 This pull request is a draft
    └── 🟢 Then
        └── 🟢 Not (🔴 This label is applied to pull request: review/triage-pending)

Manual Checks
**IGNORE** the bot requirements for this PR (force green CI check)

If

🟢 Condition met
└── 🟢 On every pull request

Can be checked by

  • Any user with comment edit permission
The pull request description provides enough details

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 Not (🔴 Pull request author is a member of the team: core-contributors)
    └── 🟢 Not (🔴 Pull request author is user: dependabot[bot])

Can be checked by

  • team core-contributors

Copy link

codecov bot commented Jan 31, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

@kristovatlas
Copy link
Contributor

Sounds reasonable. As the gno.land validator set will initially be limited, this probably isn't a pressing action.

…itectures

This change adds build constraints so as to panic if built for 32-bit
architectures as it is a project wide decision not to support them.

This allows the mainnet launch without sweating trying to make a bunch
of runtime changes for the gnovm.

Updates gnolang#3288
@odeke-em odeke-em force-pushed the gnolang-add-build-constraint-to-panic-on-32-bit-architectures branch from b411964 to e746a78 Compare February 1, 2025 13:35
Copy link
Member

@notJoon notJoon left a comment

Choose a reason for hiding this comment

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

LGTM

remove: review/triage-pending flag

@notJoon notJoon removed the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Feb 3, 2025
Copy link
Contributor

@aeddi aeddi left a comment

Choose a reason for hiding this comment

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

The idea looks good to me, but please check the comments for some improvements.

@@ -116,3 +116,6 @@ repository offers more resources to dig into. We are eager to see your first PR!
* [![Go Reference](https://pkg.go.dev/badge/hey/google)](https://gnolang.github.io/gno/github.com/gnolang/gno.html) \
(pkg.go.dev will not show our repository as it has a license it doesn't recognise)
</details>

## Declarations
* Gno is only available for 64-bit architectures!
Copy link
Contributor

Choose a reason for hiding this comment

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

@leohhhn maybe you have a better idea of the right place(s) to add this info?

Copy link
Member

@thehowl thehowl Feb 6, 2025

Choose a reason for hiding this comment

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

definitely shouldn't go in README; maybe in pkg/gnolang/ readme.

Also we should update the goreleaser configuration to avoid 32bit targets.

gnovm/pkg/gnolang/nocompile_386.go Show resolved Hide resolved
gnovm/pkg/gnolang/nocompile_386.go Show resolved Hide resolved
@Gno2D2 Gno2D2 requested a review from a team February 4, 2025 21:57
Copy link
Member

@thehowl thehowl Feb 6, 2025

Choose a reason for hiding this comment

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

suggestion:

package main

import "strconv"

func _() {
	var x [1]struct{}
	_ = x[strconv.IntSize-64]
}

This is a trick used also by stringer. It has the advantage that if the value of strconv.IntSize != 64, then compilation fails entirely (rather than at runtime, as the code in the PR does).

Aside from the code above, you should add some comment to explain the compile error should someone come up with it.

Also the file shouldn't be named _386 to avoid it only building on 386. The code above should be added without any build constraints.

@Gno2D2 Gno2D2 requested a review from a team February 6, 2025 16:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📦 🤖 gnovm Issues or PRs gnovm related
Projects
Status: Triage
Development

Successfully merging this pull request may close these issues.

6 participants