Add initial libstd support for Xous #104101

xobs · 2022-11-07T11:30:03Z

This patchset adds some minimal support to the tier-3 target riscv32imac-unknown-xous-elf. The following features are supported:

alloc
thread creation and joining
thread sleeping
thread_local
panic_abort
mutex
condvar
stdout

Additionally, internal support for the various Xous primitives surrounding IPC have been added as part of the Xous FFI. These may be exposed as part of std::os::xous::ffi in the future, however for now they are not public.

This represents the minimum viable product. A future patchset will add support for networking and filesystem support.

rustbot · 2022-11-07T11:30:09Z

r? @m-ou-se

(rustbot has picked a reviewer for you, use r? to override)

rustbot · 2022-11-07T11:30:13Z

Hey! It looks like you've submitted a new PR for the library teams!

If this PR contains changes to any rust-lang/rust public library APIs then please comment with @rustbot label +T-libs-api -T-libs to tag it appropriately. If this PR contains changes to any unstable APIs please edit the PR description to add a link to the relevant API Change Proposal or create one if you haven't already. If you're unsure where your change falls no worries, just leave it as is and the reviewer will take a look and make a decision to forward on if necessary.

Examples of T-libs-api changes:

Stabilizing library features
Introducing insta-stable changes such as new implementations of existing stable traits on existing stable types
Introducing new or changing existing unstable library APIs (excluding permanently unstable features / features without a tracking issue)
Changing public documentation in ways that create new stability guarantees
Changing observable runtime behavior of library APIs

xobs · 2022-11-07T11:32:38Z

Please let me know if there is anything I should do in order to make this merge easier, please let me know. This is my first relatively major change to libstd.

Note that this will not build unless you have the latest llvm-project which includes llvm/llvm-project@7c80e7a but it does not require any external dependencies beyond a C compiler capable of building RISC-V code.

library/std/src/sys/xous/locks/rwlock.rs

rustbot · 2022-11-08T01:37:02Z

Some changes occurred in compiler/rustc_codegen_gcc

cc @antoyo

These commits modify compiler targets.
(See the Target Tier Policy.)

Some changes occurred in HTML/CSS/JS.

cc @GuillaumeGomez, @Folyd, @jsha

Some changes occurred in src/librustdoc/clean/types.rs

cc @camelid

A change occurred in the Ayu theme.

cc @Cldfire

Some changes occurred in HTML/CSS themes.

cc @GuillaumeGomez

bors · 2022-11-09T17:52:49Z

☔ The latest upstream changes (presumably #103723) made this pull request unmergeable. Please resolve the merge conflicts.

library/std/src/sys/xous/time.rs

xobs · 2022-11-13T10:57:52Z

I rebased to the latest master branch and incorporated the suggestions that were recommended.

albertlarsan68 · 2023-01-18T08:30:00Z

This does not affect the bootstrap code, do @rustbot label -A-bootstrap.

xobs · 2023-02-17T07:23:02Z

I'm in the process of reworking this so that it passes tests. I've gotten libunwind functioning, and now I can actually run the Rust libstd test suite.

I've discovered some issues in the TLS implementation, as well as potential issues in the Condvar or Mutex implementation. I will work on those issues and remove the Draft status once they are addressed.

bors · 2023-02-25T23:30:54Z

☔ The latest upstream changes (presumably #107405) made this pull request unmergeable. Please resolve the merge conflicts.

Dylan-DPC · 2023-07-28T17:15:24Z

@xobs any updates on this?

The xous filesystem support is not yet ready for merging. Signed-off-by: Sean Cross <sean@xobs.io>

Xous does not yet support spawning processes. Signed-off-by: Sean Cross <sean@xobs.io>

Don't add the origin rpath when calling the linker. This is unnecessary on Xous since there is no dynamic linker, and Xous can use an ordinary bare-metal linker with no rpath options. As part of this patch, the logic was inverted so that the "else" clause contains everything except "windows" and "xous". Signed-off-by: Sean Cross <sean@xobs.io>

Basic alloc support on Xous is supported by the `dlmalloc` crate. This necessitates bumping the dlmalloc version to 0.2.4. Signed-off-by: Sean Cross <sean@xobs.io>

Xous does not properly handle invalid instructions. Instead, call `__rust_abort` and exit normally. Signed-off-by: Sean Cross <sean@xobs.io>

Xous has a concept of `services` that provide various features. Processes may connect to these services by name or by address. Most services require a name server in order to connect. Add a file with the most common services, and provide a way to connect to a service by querying the name server. Signed-off-by: Sean Cross <sean@xobs.io>

Add support for stdout. This enables basic console printing via `println!()`. Output is written to the log server. Signed-off-by: Sean Cross <sean@xobs.io>

Add support for determining the current time. This connects to the ticktimer server in order to get the system uptime. Signed-off-by: Sean Cross <sean@xobs.io>

Add initial support for threads on Xous. This includes thread creation and joining. Signed-off-by: Sean Cross <sean@xobs.io>

Add an implementation of thread local storage. This uses a container that is pointed to by the otherwise-unsed `$tp` register. This container is allocated on-demand, so threads that use no TLS will not allocate this extra memory. Signed-off-by: Sean Cross <sean@xobs.io>

Add support for Condvar, Mutex, and RWLock. These are all backed by the ticktimer server. Signed-off-by: Sean Cross <sean@xobs.io>

The Xous operating system has no libc, and relies on `compiler_builtins` to supply basic functions such as `memcpy`. Bump the version to 0.1.101 to pull in a version of this crate with the flag enabled for Xous. Signed-off-by: Sean Cross <sean@xobs.io>

Xous passes slice pointers around in order to manipulate memory. This is feature-gated behind `slice_ptr_len`. Xous is currently the only target to use this feature, so gate it behind an OS flag. Signed-off-by: Sean Cross <sean@xobs.io>

bjorn3

LGTM, but @m-ou-se may want to take a look at it too. If not r=me.

xobs · 2023-09-19T02:28:16Z

What are the next steps to getting this merged?

bjorn3 · 2023-09-19T07:02:06Z

Given that @m-ou-se hasn't taken a look yet:

@bors r+

bors · 2023-09-19T07:02:08Z

📌 Commit 6c32a64 has been approved by bjorn3

It is now in the queue for this repository.

bors · 2023-09-19T07:38:24Z

⌛ Testing commit 6c32a64 with merge ae9c330...

bors · 2023-09-19T09:25:11Z

☀️ Test successful - checks-actions
Approved by: bjorn3
Pushing ae9c330 to master...

rust-timer · 2023-09-19T10:47:24Z

Finished benchmarking commit (ae9c330): comparison URL.

Overall result: no relevant changes - no action needed

@rustbot label: -perf-regression

Instruction count

This benchmark run did not return any relevant results for this metric.

Max RSS (memory usage)

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	1.9%	[1.9%, 1.9%]	1
Improvements ✅ (primary)	-2.6%	[-4.1%, -1.0%]	2
Improvements ✅ (secondary)	-4.4%	[-4.4%, -4.4%]	1
All ❌✅ (primary)	-2.6%	[-4.1%, -1.0%]	2

Cycles

This benchmark run did not return any relevant results for this metric.

Binary size

This benchmark run did not return any relevant results for this metric.

Bootstrap: 631.926s -> 631.537s (-0.06%)
Artifact size: 317.94 MiB -> 317.91 MiB (-0.01%)

rustbot assigned m-ou-se Nov 7, 2022

rustbot added T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Nov 7, 2022

Noratrieb reviewed Nov 7, 2022

View reviewed changes

library/std/src/sys/xous/locks/rwlock.rs Outdated Show resolved Hide resolved

xobs force-pushed the xous-libstd-initial branch from 766e1f8 to b535859 Compare November 8, 2022 01:36

xobs force-pushed the xous-libstd-initial branch 2 times, most recently from f4db122 to 2664881 Compare November 9, 2022 02:26

rustbot added the A-meta Area: Issues & PRs about the rust-lang/rust repository itself label Nov 9, 2022

xobs mentioned this pull request Nov 9, 2022

riscv32imac-unknown-xous-elf: rust-lld gives offset is outside the section errors #103949

Open

fbstj reviewed Nov 9, 2022

View reviewed changes

library/std/src/sys/xous/time.rs Outdated Show resolved Hide resolved

xobs force-pushed the xous-libstd-initial branch from 2664881 to 3b3a32f Compare November 13, 2022 10:48

xobs mentioned this pull request Dec 15, 2022

rust-lld: lto="fat" prunes symbols that are used #105734

Closed

rustbot removed the T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) label Jan 18, 2023

xobs marked this pull request as draft February 17, 2023 07:21

Dylan-DPC added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels May 17, 2023

xobs force-pushed the xous-libstd-initial branch from 3b3a32f to 3978372 Compare July 31, 2023 12:22

rustbot added the T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) label Jul 31, 2023

xobs marked this pull request as ready for review July 31, 2023 12:22

xobs added 13 commits August 22, 2023 20:25

std: fs: skip fs tests on xous

0b80057

The xous filesystem support is not yet ready for merging. Signed-off-by: Sean Cross <sean@xobs.io>

std: process: skip tests on xous

112d101

Xous does not yet support spawning processes. Signed-off-by: Sean Cross <sean@xobs.io>

std: xous: add alloc support

823cba9

Basic alloc support on Xous is supported by the `dlmalloc` crate. This necessitates bumping the dlmalloc version to 0.2.4. Signed-off-by: Sean Cross <sean@xobs.io>

panic_abort: call __rust_abort on xous

dfff5bf

Xous does not properly handle invalid instructions. Instead, call `__rust_abort` and exit normally. Signed-off-by: Sean Cross <sean@xobs.io>

std: xous: add output support for stdio

4af7d2c

Add support for stdout. This enables basic console printing via `println!()`. Output is written to the log server. Signed-off-by: Sean Cross <sean@xobs.io>

std: xous: add support for time

efa470d

Add support for determining the current time. This connects to the ticktimer server in order to get the system uptime. Signed-off-by: Sean Cross <sean@xobs.io>

std: xous: add thread support

d36e516

Add initial support for threads on Xous. This includes thread creation and joining. Signed-off-by: Sean Cross <sean@xobs.io>

std: xous: add support for locks

6413844

Add support for Condvar, Mutex, and RWLock. These are all backed by the ticktimer server. Signed-off-by: Sean Cross <sean@xobs.io>

std: enable feature(slice_ptr_len) on xous

6c32a64

Xous passes slice pointers around in order to manipulate memory. This is feature-gated behind `slice_ptr_len`. Xous is currently the only target to use this feature, so gate it behind an OS flag. Signed-off-by: Sean Cross <sean@xobs.io>

xobs force-pushed the xous-libstd-initial branch from 00b5e8d to 6c32a64 Compare August 22, 2023 12:32

xobs requested a review from bjorn3 August 22, 2023 12:33

This comment was marked as resolved.

Sign in to view

bjorn3 approved these changes Aug 22, 2023

View reviewed changes

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Sep 19, 2023

bors added the merged-by-bors This PR was explicitly merged by bors. label Sep 19, 2023

bors merged commit ae9c330 into rust-lang:master Sep 19, 2023
12 checks passed

rustbot added this to the 1.74.0 milestone Sep 19, 2023

This was referenced Sep 19, 2023

added support for GNU/Hurd #115230

Merged

Add Minimal Std implementation for UEFI #105861

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add initial libstd support for Xous #104101

Add initial libstd support for Xous #104101

xobs commented Nov 7, 2022

rustbot commented Nov 7, 2022

rustbot commented Nov 7, 2022

xobs commented Nov 7, 2022

rustbot commented Nov 8, 2022

bors commented Nov 9, 2022

xobs commented Nov 13, 2022

albertlarsan68 commented Jan 18, 2023

xobs commented Feb 17, 2023

bors commented Feb 25, 2023

Dylan-DPC commented Jul 28, 2023

This comment was marked as resolved.

bjorn3 left a comment

xobs commented Sep 19, 2023

bjorn3 commented Sep 19, 2023

bors commented Sep 19, 2023

bors commented Sep 19, 2023

bors commented Sep 19, 2023

rust-timer commented Sep 19, 2023

Add initial libstd support for Xous #104101

Add initial libstd support for Xous #104101

Conversation

xobs commented Nov 7, 2022

rustbot commented Nov 7, 2022

rustbot commented Nov 7, 2022

xobs commented Nov 7, 2022

rustbot commented Nov 8, 2022

bors commented Nov 9, 2022

xobs commented Nov 13, 2022

albertlarsan68 commented Jan 18, 2023

xobs commented Feb 17, 2023

bors commented Feb 25, 2023

Dylan-DPC commented Jul 28, 2023

This comment was marked as resolved.

bjorn3 left a comment

Choose a reason for hiding this comment

xobs commented Sep 19, 2023

bjorn3 commented Sep 19, 2023

bors commented Sep 19, 2023

bors commented Sep 19, 2023

bors commented Sep 19, 2023

rust-timer commented Sep 19, 2023

Overall result: no relevant changes - no action needed

Instruction count

Max RSS (memory usage)

Cycles

Binary size