Reorganize kernel/ Crate by bradjc · Pull Request #2659 · tock/tock

bradjc · 2021-07-09T14:34:58Z

Pull Request Overview

This PR is the updated version of #2545 and #2551.

It does a holistic reorganization of the entire kernel crate.

Highlights:

Almost everything is now exported as kernel::module::Type rather than kernel::Type.
/common is split up into /utilities and /collections
trait Chip has been updated to only include operations that a hardware microcontroller chip crate should provide.
Things that were in trait Chip or passed ad-hoc are now part of trait KernelResources. This new trait is now the de-facto way that a board configures the kernel.
Driver is now SyscallDriver.

Testing Strategy

todo

TODO or Help Wanted

A whole lot of other code has to change (in largely mechanical ways) to work with these changes. But it would be easier to make sure this looks good to everyone first.
Decide on a filename for mem.rs. It was going to be appslice.rs, but now it would ostensibly be process_buffer.rs. However, that somewhat collides with the process_*.rs family of files, which are all about processes themselves.
Rebase after Support aliasing of process-allowed memory #2632 is merged.

Documentation Updated

Updated the relevant files in /docs, or no updates are required.

Formatting

Ran make prepush.

bradjc · 2021-07-13T15:22:35Z

* Decide on a filename for `mem.rs`. It was going to be `appslice.rs`, but now it would ostensibly be `process_buffer.rs`. However, that somewhat collides with the `process_*.rs` family of files, which are all about processes themselves.

We were going to have "appslice.rs", and we have "errorcode.rs", so I propose we use "processbuffer.rs" instead of "mem.rs".

lschuermann · 2021-07-13T15:56:35Z

I propose we use "processbuffer.rs" instead of "mem.rs".

I'm in favor. mem is really vague when talking about a kernel.

bradjc · 2021-07-14T13:51:15Z

Updates:

mem.rs is now processbuffer.rs
SyscallDriver and CommandReturn are now exported through kernel::syscall::. This mirrors how process_X.rs works.
Capsules have been largely updated.

hudson-ayers · 2021-07-14T22:09:34Z

Chiming in to say all the changes so far look good to me.

Looks like the remaining work is mostly porting stuff in chips/ and arch/ to use the new organization / names?

bradjc · 2021-07-15T13:50:28Z

Hail, nano33ble, and artye21 now compile.

This is going to take a while to do all of the boards. If you want to help, please add commits to this PR and I will rebase them. See 47eca24, 7ef79ea, or f982756 as a template for what needs to change for boards, and c5737e3, c4f5dc1, and 81098da for chips.

alexandruradovici · 2021-07-16T06:49:59Z

I will update raspberry, stms and microbit today.

alexandruradovici · 2021-07-16T08:50:31Z

As I don't think I can push to this branch, I opened PRs for:

microbit v2 (Update microbit_v2 #2666)
raspberry pi pico (Update raspberry pi pico #2668)
stm32f3 discovery (Update stm32f3 discovery #2667)
stm32f412g discovery (Update stm32f412gdiscovery #2671)
nucleo_f429zi and nucleo_f446re (Update nucleo #2672)
imxrt1050 evk (Update imxrt to use new kernel exports #2673)
teensy40 (Update imxrt to use new kernel exports #2673)

bradjc · 2021-07-26T17:59:54Z

Ok all boards compile and I changed SyscallDispatch to SyscallDriverLookup.

hudson-ayers

I reviewed all the changes to the kernel crate and am happy with them. I then reviewed changes to a few random capsules, chip, and arch files and they were all straightforward changes where the compiler would catch any breakages. So I am pretty happy with this as-is!

Thanks for taking this on, it was clearly a huge undertaking but I think it makes Tock a lot more approachable.

phil-levis · 2021-07-27T00:14:54Z

bors r+

hudson-ayers · 2021-07-27T13:26:20Z

I rebased this on master to minimize the diff in #2696 , but now #2696 needs to be rebased as well and I cannot push to it.

Changes will need to be made to the esp-32 chip and board now as well, since that was also merged.

alexandruradovici · 2021-07-27T13:45:33Z

I rebased this on master to minimize the diff in #2696 , but now #2696 needs to be rebased as well and I cannot push to it.

I rebased it.

Changes will need to be made to the esp-32 chip and board now as well, since that was also merged.

Update in #2700

bradjc · 2021-07-27T14:31:09Z

I forgot to change the function name in KernelResources so I did that as well.

hudson-ayers · 2021-07-27T14:59:09Z

lets try this again:

bors r+

bors · 2021-07-27T15:11:29Z

Build succeeded:

tock/tock#2659 renamed the Tock kernel's `Driver` trait to `SyscallDriver`, because the term "driver" has too many different meanings in Tock. This change does the same, but `libtock_unittest`'s fake version of the trait.

352: Rename `fake::driver` to `fake::SyscallDriver`. r=jrvanwhy a=jrvanwhy tock/tock#2659 renamed the Tock kernel's `Driver` trait to `SyscallDriver`, because the term "driver" has too many different meanings in Tock. This change does the same, but `libtock_unittest`'s fake version of the trait. Co-authored-by: Johnathan Van Why <jrvanwhy@google.com>

2659: Reorganize kernel/ Crate r=hudson-ayers a=bradjc ### Pull Request Overview This PR is the updated version of tock#2545 and tock#2551. It does a holistic reorganization of the entire kernel crate. Highlights: - Almost everything is now exported as `kernel::module::Type` rather than `kernel::Type`. - /common is split up into /utilities and /collections - `trait Chip` has been updated to only include operations that a hardware microcontroller chip crate should provide. - Things that were in `trait Chip` or passed ad-hoc are now part of `trait KernelResources`. This new trait is now the de-facto way that a board configures the kernel. - `Driver` is now `SyscallDriver`. ### Testing Strategy todo ### TODO or Help Wanted - A whole lot of other code has to change (in largely mechanical ways) to work with these changes. But it would be easier to make sure this looks good to everyone first. - [x] Decide on a filename for `mem.rs`. It was going to be `appslice.rs`, but now it would ostensibly be `process_buffer.rs`. However, that somewhat collides with the `process_*.rs` family of files, which are all about processes themselves. - [x] Rebase after tock#2632 is merged. ### Documentation Updated - [x] Updated the relevant files in `/docs`, or no updates are required. ### Formatting - [x] Ran `make prepush`. Co-authored-by: Brad Campbell <bradjc5@gmail.com> Co-authored-by: Alexandru Radovici <alexandru.radovici@wyliodrin.com> Co-authored-by: Alexandru Radovici <msg4alex@gmail.com>

github-actions Bot added HIL This affects a Tock HIL interface. kernel labels Jul 9, 2021

bradjc force-pushed the kernel-reorg branch from 46599be to f5a4fb2 Compare July 9, 2021 15:18

bradjc added the tock-2.0 Issues and PRs related to Tock version 2.0. label Jul 9, 2021

alexandruradovici reviewed Jul 9, 2021

View reviewed changes

Comment thread kernel/src/syscall_driver.rs

alexandruradovici reviewed Jul 9, 2021

View reviewed changes

Comment thread kernel/src/platform/platform.rs

Comment thread kernel/src/platform/platform.rs Outdated

bradjc force-pushed the kernel-reorg branch from 1c1c9df to 5431b26 Compare July 14, 2021 13:49

bradjc changed the base branch from pr/2632 to master July 14, 2021 13:49

This was referenced Jul 14, 2021

Kernel "platform" module reorganization #2545

Closed

kernel: Reorganize crate exports #2551

Closed

bradjc force-pushed the kernel-reorg branch from 5431b26 to ca896e9 Compare July 15, 2021 00:06

github-actions Bot added chips/nrf Change pertains to the nRF5x family of MCUs. arch/risc-v RISC-V architecture chips/sam4l Change pertains to the SAM4L MCU. chips/stm32 Change pertains to the stm32 family of MCUSs WG-OpenTitan In the purview of the OpenTitan working group. labels Jul 15, 2021

bradjc force-pushed the kernel-reorg branch from ca896e9 to f982756 Compare July 15, 2021 13:47

bradjc force-pushed the kernel-reorg branch from b4f654f to d841c1c Compare July 16, 2021 02:45

hudson-ayers linked an issue Jul 26, 2021 that may be closed by this pull request

Allow SysTick trait to be configured from boards crate #1998

Closed

bradjc force-pushed the kernel-reorg branch from acb85d6 to 0d0312d Compare July 26, 2021 17:52

hudson-ayers previously approved these changes Jul 26, 2021

View reviewed changes

bradjc added 10 commits July 27, 2021 13:04

apollo3: update to new kernel exports/traits

98535d8

swervolf update to new kernel exports/traits

d861c97

weact: update to new kernel exports and traits

b68d8b6

msp432: update to new kernel exports and traits

7838d63

earlgrey: update new kernel exports and traits

e982377

litex: update to new kernel traits

fc77e6e

rename "SyscallDispatch" to "SyscallDriverLookup"

35111d0

kernel: fix comment paths

48da27a

capsules: fix example

e66d14b

kernel: syscall: doc links

e048e0c

hudson-ayers dismissed their stale review via e048e0c July 27, 2021 13:06

hudson-ayers force-pushed the kernel-reorg branch from e6a995a to e048e0c Compare July 27, 2021 13:06

update the pico explorer base

89f64de

bradjc added 3 commits July 27, 2021 10:28

chips: esp32: update new kernel exports

4200fbc

boards: esp32: update new kernel exports

a269454

kernel: finish changing to syscall_driver_lookup

677a182

bradjc force-pushed the kernel-reorg branch from cd18645 to 677a182 Compare July 27, 2021 14:29

hudson-ayers approved these changes Jul 27, 2021

View reviewed changes

bors Bot merged commit 823d235 into master Jul 27, 2021

bors Bot deleted the kernel-reorg branch July 27, 2021 15:11

bradjc mentioned this pull request Jul 27, 2021

Tracking: Revisit what is exported from the kernel crate #1088

Closed

6 tasks

jrvanwhy mentioned this pull request Dec 23, 2021

Rename fake::driver to fake::SyscallDriver. tock/libtock-rs#352

Merged

Uh oh!

Conversation

bradjc commented Jul 9, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Overview

Testing Strategy

TODO or Help Wanted

Documentation Updated

Formatting

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bradjc commented Jul 13, 2021

Uh oh!

lschuermann commented Jul 13, 2021

Uh oh!

bradjc commented Jul 14, 2021

Uh oh!

hudson-ayers commented Jul 14, 2021

Uh oh!

bradjc commented Jul 15, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alexandruradovici commented Jul 16, 2021

Uh oh!

alexandruradovici commented Jul 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bradjc commented Jul 26, 2021

Uh oh!

hudson-ayers left a comment

Choose a reason for hiding this comment

Uh oh!

phil-levis commented Jul 27, 2021

Uh oh!

hudson-ayers commented Jul 27, 2021

Uh oh!

alexandruradovici commented Jul 27, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bradjc commented Jul 27, 2021

Uh oh!

hudson-ayers commented Jul 27, 2021

Uh oh!

bors Bot commented Jul 27, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

bradjc commented Jul 9, 2021 •

edited

Loading

bradjc commented Jul 15, 2021 •

edited

Loading

alexandruradovici commented Jul 16, 2021 •

edited

Loading

alexandruradovici commented Jul 27, 2021 •

edited

Loading