GithubHelp home page GithubHelp logo

r3-os / r3 Goto Github PK

View Code? Open in Web Editor NEW
153.0 7.0 6.0 7.83 MB

R3-OS — Experimental static (μITRON-esque) RTOS for deeply embedded systems, testing the limit of Rust's compile-time evaluation and generics

License: Apache License 2.0

Rust 98.23% Nix 0.03% TypeScript 1.46% Promela 0.28%
embedded-systems rtos rust cortex-m cortex-a risc-v kernel memory-safety experimental embedded-rust

r3's People

Contributors

rng-dynamics avatar yvt avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

r3's Issues

Fix GitHub workflow badge

badges/shields#8671

r3/README.md

Line 10 in ecfb4e1

<img src="https://img.shields.io/github/workflow/status/r3-os/r3/CI/%F0%9F%A6%86?style=for-the-badge"> <img src="https://img.shields.io/badge/license-MIT%2FApache--2.0-blue?style=for-the-badge"> <a href="https://crates.io/crates/r3"><img src="https://img.shields.io/crates/v/r3?style=for-the-badge"></a> <a href="https://r3-os.github.io/r3/doc/r3/index.html"><img src="https://r3-os.github.io/r3/doc/badge.svg"></a>

Unsound `transmute` in `get` method for type `List`

impl<Head: 'static + Copy, Tail: ~const Bag> const Bag for List<Head, Tail> {
fn get<T: 'static>(&self) -> Option<&T> {
// Simulate specialization
if TypeId::of::<T>().eq(&TypeId::of::<Head>()) {
Some(unsafe { transmute::<&Head, &T>(&self.0) })
} else {
self.1.get()
}
}

The safe method get used transmute to make conversion from &Head to &T. Here are two problems:

  1. Copy trait bound is not sufficient for us to safely transmute from &Head. Suggest to use trait bound such as Pod.
  2. Transmute has an overloaded return type. If you do not specify the return type it may produce a surprising type to satisfy inference1.

Footnotes

  1. https://doc.rust-lang.org/nomicon/transmutes.html.

Replace `ZeroInit` with `bytemuck::Zeroable`

r3_core::utils::ZeroInit should be replaced by bytemuck::Zeroable. The latter is derivable (which helps us remove some unsafe impls) and has a better Rust ecosystem compatibility.

Zeroable is missing the following implementations:

  • core::atomic::Atomic{Bool,{U,I}{8,16,32,64,size},Ptr<impl Sized>} (Lokathor/bytemuck#74)
  • Option<fn(Args...) -> R>
  • Option<&[mut ]_>
  • UnsafeCell<impl Zeroable> (Lokathor/bytemuck#148)
  • [impl Zeroable + Sized] Zeroable requires Sized

Replace `Init` with `const Default` or something else

Having a local trait Init is problematic for a number of reasons:

  • Init is implemented on some external types, such as ArrayVec and TokenLock, for internal use. However, Init is also exposed to the user to allow for its use with r3::hunk::Hunk, giving access to these internal-use-only trait implementations. This means removing these trait implementations is a breaking change.
  • Implementing Init in an external crate requires a dependency on r3 even if the rest of r3 is not needed at all.

The best course of action is to replace Init with something else provided by an upstream crate or a language feature.

Traitize: Remaining issues

Raw interface specificity:

  • Should the priority-based scheduling be enforced at API level? How should the test suite handle kernels without strict scheduling?
  • Some kernel implementations may prefer not returning BadId and causing an undefined behavior instead.

Raw interface extensibility:

  • MutexProtocol should be non_exhaustive? How is the kernel supposed to deal with unknown values?
  • The same goes for QueueOrder
  • Multi-processing
  • Some properties added to a Bag might be unsafe to ignore. How can we ensure the safety? What properties might fall under this criterion?

API design:

  • Implement object safety
  • The definer methods should be named define to make room for runtime construction.
  • r3::kernel::Cfg isn't a pretty name.
  • Kernel is not a raw trait. KernelMutex is a raw trait. But they are both in traits.
  • Is it really a good idea to require application code to use raw traits in trait bounds but use Kernel for global operations? Kernel being a kitchen sink is actually consistent with higher-level kernel object wrappers (like how Task::set_priority is bound by System: raw::KernelTaskSetPriority). But the real problem is that the raw traits are supposed to be bound by kernel-side semver guarantees.

r3_kernel:

  • r3_kernel::CfgBuilder is an awful name.

Documentation:

  • Update CHANGELOG.md
  • Define the versioning scheme

Object names

Kernel objects should be able to have names for runtime inspection and to improve the configuration-time error reporting.

(It'd be ideal if we could also track their definition sites, but that would require std::backtrace::Backtrace::frames to be usable in const fn.)

New nightly

Please note that with rust-lang/rust#94901 merged, ~const Drop bounds should be changed to ~const core::marker::Destruct. Sorry for the inconvenience.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.