Create `bevy_platform_support` Crate by bushrat011899 · Pull Request #17250 · bevyengine/bevy

bushrat011899 · 2025-01-09T02:13:44Z

Objective

Contributes to Reorganise Platform Support Dependencies #16877

Solution

Initial creation of bevy_platform_support crate.
Moved bevy_utils::Instant into new bevy_platform_support crate.
Moved portable-atomic, portable-atomic-util, and critical-section into new bevy_platform_support crate.

Testing

CI

Showcase

Instead of needing code like this to import an Arc:

#[cfg(feature = "portable-atomic")]
use portable_atomic_util::Arc;

#[cfg(not(feature = "portable-atomic"))]
use alloc::sync::Arc;

We can now use:

use bevy_platform_support::sync::Arc;

This applies to many other types, but the goal is overall the same: allowing crates to use std-like types without the boilerplate of conditional compilation and platform-dependencies.

Migration Guide

Replace imports of bevy_utils::Instant with bevy_platform_support::time::Instant
Replace imports of bevy::utils::Instant with bevy::platform_support::time::Instant

Notes

bevy_platform_support hasn't been reserved on crates.io
bevy_platform_support is not re-exported from bevy at this time. It may be worthwhile exporting this crate, but I am unsure of a reasonable name to export it under (platform_support may be a bit wordy for user-facing).
I've included an implementation of Instant which is suitable for no_std platforms that are not Wasm for the sake of eliminating feature gates around its use. It may be a controversial inclusion, so I'm happy to remove it if required.
There are many other items (spin, bevy_utils::Sync(Unsafe)Cell, etc.) which should be added to this crate. I have kept the initial scope small to demonstrate utility without making this too unwieldy.

alice-i-cecile · 2025-01-09T02:25:12Z

bevy_platform_support is not re-exported from bevy at this time. It may be worthwhile exporting this crate, but I am unsure of a reasonable name to export it under (platform_support may be a bit wordy for user-facing).

Just re-export it as is, the name is fine and this is less surprising.

bushrat011899 · 2025-01-09T02:33:44Z

Just re-export it as is, the name is fine and this is less surprising.

Done!

alice-i-cecile · 2025-01-09T05:45:37Z

Marking as blessed due to this comment by @cart. I agree with it too!

…InitialSplit

TimJentzsch

I don't really understand the fallback implementation for Instant, but the rest looks good to me

crates/bevy_platform_support/README.md

Provide instructions more robust to changing version numbers. Co-Authored-By: TimJentzsch <[email protected]>

bushrat011899 · 2025-01-12T21:53:15Z

I don't really understand the fallback implementation for Instant, but the rest looks good to me

I should update the documentation to be more clear on how this works. Basically it's a straight copy of the Instant from std, but it includes two key changes:

Instant::set_elapsed is a new method that lets you tell Instant how to know how much time has elapsed. Since we don't have an OS, we can't use the typical syscalls. A simpler alternative would be to just provide Instant with the elapsed time directly, rather than giving it a function to determine elapsed time. But the benefit here is now Instant can update itself only when it needs to, instead of the user needing to eagerly update it (e.g., in the mainloop)
Instant::now calls the method provided to Instant::set_elapsed to determine how much time has elapsed, instead of using a syscall directly like in std.

For the sake of convenience, I've included an unset_getter method, which is the default function called by Instant::now if you haven't set one yourself. If you're on x86 or aarch64, we have access to a built-in instruction for getting a system tick in nanoseconds, so we can actually provide a working default implementation on those platforms. For all others, this method panics, explaining that you need to call Instant::set_elapsed before Instant::now is called.

BenjaminBrienen

Pretty straightforward and well done!

crates/bevy_platform_support/Cargo.toml

crates/bevy_reflect/src/func/dynamic_function.rs

crates/bevy_tasks/src/single_threaded_task_pool.rs

crates/bevy_platform_support/src/time.rs

Bleachfuel · 2025-01-16T10:13:05Z

Why not just call it bevy_platform? It is already reserved on crates.io

crates/bevy_platform_support/src/time.rs

Co-Authored-By: TimJentzsch <[email protected]>

Co-Authored-By: Chris Russell <[email protected]>

…InitialSplit

bushrat011899 · 2025-01-16T20:44:39Z

Why not just call it bevy_platform? It is already reserved on crates.io

It could be called that, but that's a pretty prime crate name that'd have a lot of uses. platform_support, while verbose, is pretty specific to the idea of providing cross-platform support utilities.

mockersf · 2025-01-16T20:56:12Z

could you add the new crate (in the correct order by depdendency) in https://github.com/bevyengine/bevy/blob/main/tools/publish.sh?

Co-Authored-By: François Mockers <[email protected]>

bushrat011899 · 2025-01-16T21:07:52Z

could you add the new crate (in the correct order by depdendency) in https://github.com/bevyengine/bevy/blob/main/tools/publish.sh?

Done! bevy_platform_support is required by bevy_utils, so I've placed it at the very top of the list directly above it.

BD103 · 2025-01-17T04:16:34Z

bevy_platform_support hasn't been reserved on crates.io

Once this PR is merged, we should add the crate to bevy-crate-reservations.

cc @cart :)

cart · 2025-01-20T21:49:08Z

Reserved!

# Objective - Contributes to bevyengine#16877 ## Solution - Initial creation of `bevy_platform_support` crate. - Moved `bevy_utils::Instant` into new `bevy_platform_support` crate. - Moved `portable-atomic`, `portable-atomic-util`, and `critical-section` into new `bevy_platform_support` crate. ## Testing - CI --- ## Showcase Instead of needing code like this to import an `Arc`: ```rust #[cfg(feature = "portable-atomic")] use portable_atomic_util::Arc; #[cfg(not(feature = "portable-atomic"))] use alloc::sync::Arc; ``` We can now use: ```rust use bevy_platform_support::sync::Arc; ``` This applies to many other types, but the goal is overall the same: allowing crates to use `std`-like types without the boilerplate of conditional compilation and platform-dependencies. ## Migration Guide - Replace imports of `bevy_utils::Instant` with `bevy_platform_support::time::Instant` - Replace imports of `bevy::utils::Instant` with `bevy::platform_support::time::Instant` ## Notes - `bevy_platform_support` hasn't been reserved on `crates.io` - ~~`bevy_platform_support` is not re-exported from `bevy` at this time. It may be worthwhile exporting this crate, but I am unsure of a reasonable name to export it under (`platform_support` may be a bit wordy for user-facing).~~ - I've included an implementation of `Instant` which is suitable for `no_std` platforms that are not Wasm for the sake of eliminating feature gates around its use. It may be a controversial inclusion, so I'm happy to remove it if required. - There are many other items (`spin`, `bevy_utils::Sync(Unsafe)Cell`, etc.) which should be added to this crate. I have kept the initial scope small to demonstrate utility without making this too unwieldy. --------- Co-authored-by: TimJentzsch <[email protected]> Co-authored-by: Chris Russell <[email protected]> Co-authored-by: François Mockers <[email protected]>

Initial Commit

4d98f05

alice-i-cecile added this to the 0.16 milestone Jan 9, 2025

Re-export bevy_platfrom_support as platform_support in bevy

d1fe0c0

Fix CI

f3b9a3e

alice-i-cecile added X-Blessed Has a large architectural impact or tradeoffs, but the design has been endorsed by decision makers and removed X-Needs-SME This type of work requires an SME to approve it. labels Jan 9, 2025

Merge remote-tracking branch 'upstream/main' into BevyPlatformSupport…

a13a311

…InitialSplit

TimJentzsch approved these changes Jan 12, 2025

View reviewed changes

crates/bevy_platform_support/README.md Outdated Show resolved Hide resolved

TimJentzsch added the D-Unsafe Touches with unsafe code in some way label Jan 12, 2025

bushrat011899 and others added 2 commits January 13, 2025 08:43

Update README.md

70d2192

Provide instructions more robust to changing version numbers. Co-Authored-By: TimJentzsch <[email protected]>

Fix typo

e251590

BenjaminBrienen approved these changes Jan 16, 2025

View reviewed changes

crates/bevy_platform_support/Cargo.toml Show resolved Hide resolved

crates/bevy_reflect/src/func/dynamic_function.rs Show resolved Hide resolved

crates/bevy_tasks/src/single_threaded_task_pool.rs Show resolved Hide resolved

BenjaminBrienen added S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it and removed S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Jan 16, 2025

TimJentzsch reviewed Jan 16, 2025

View reviewed changes

crates/bevy_platform_support/src/time.rs Show resolved Hide resolved

chescock reviewed Jan 16, 2025

View reviewed changes

crates/bevy_platform_support/src/time.rs Outdated Show resolved Hide resolved

bushrat011899 and others added 3 commits January 17, 2025 07:36

WASI Compatibility TODO

ef436a5

Co-Authored-By: TimJentzsch <[email protected]>

Switched to Acquire/Release atomic ordering

ee90037

Co-Authored-By: Chris Russell <[email protected]>

Merge remote-tracking branch 'upstream/main' into BevyPlatformSupport…

1ee6203

…InitialSplit

bushrat011899 and others added 2 commits January 17, 2025 08:06

Use bevy_platform_support in bevy_utils

7086f7d

Add bevy_platform_support to publish.sh

61c41c5

Co-Authored-By: François Mockers <[email protected]>

BenjaminBrienen approved these changes Jan 17, 2025

View reviewed changes

alice-i-cecile added this pull request to the merge queue Jan 20, 2025

Merged via the queue into bevyengine:main with commit a64446b Jan 20, 2025

This was referenced Jan 20, 2025

Move hashbrown and foldhash out of bevy_utils #17460

Merged

Move spin to bevy_platform_support out of other crates #17470

Merged

Uh oh!

Conversation

bushrat011899 commented Jan 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Objective

Solution

Testing

Showcase

Migration Guide

Notes

Uh oh!

alice-i-cecile commented Jan 9, 2025

Uh oh!

bushrat011899 commented Jan 9, 2025

Uh oh!

alice-i-cecile commented Jan 9, 2025

Uh oh!

TimJentzsch left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

bushrat011899 commented Jan 12, 2025

Uh oh!

BenjaminBrienen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Bleachfuel commented Jan 16, 2025

Uh oh!

Uh oh!

bushrat011899 commented Jan 16, 2025

Uh oh!

mockersf commented Jan 16, 2025

Uh oh!

bushrat011899 commented Jan 16, 2025

Uh oh!

BD103 commented Jan 17, 2025

Uh oh!

cart commented Jan 20, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

bushrat011899 commented Jan 9, 2025 •

edited

Loading