Skip to content

Conversation

@AlexandruCihodaru
Copy link
Collaborator

  • Add definition of initial structures that are needed by IntervalTree.
  • Add initial documentation of IntervalTree allocation engine.
    Created a new PR as suggested by @gsserge here

@AlexandruCihodaru AlexandruCihodaru force-pushed the interval_tree_doc branch 3 times, most recently from 556c3d7 to 81a6a2a Compare February 7, 2022 18:41
Copy link
Collaborator

@studychao studychao left a comment

Choose a reason for hiding this comment

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

Hi Alex, thanks for your work and here is my comments 😄

gsserge
gsserge previously approved these changes Feb 9, 2022
studychao
studychao previously approved these changes Feb 9, 2022
@AlexandruCihodaru AlexandruCihodaru changed the title Interval tree initial documentation Interval tree initial documentation and structures defintions Feb 9, 2022
Copy link
Member

@andreeaflorescu andreeaflorescu left a comment

Choose a reason for hiding this comment

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

Chatted with @AlexandruCihodaru offline. Before merging the PR:

  • update the allocation_example.png to make it more explicit in terms of state transition and the operations that are generating the change
  • include in the design document the design choices and the reasoning behind them: we want to use an interval tree for performance reasons, what are these reasons? where might it be used?
  • remove the structure definitions from the design document and replace them with text where that makes sense. This helps with having mostly up to date documentation even when implementation details are changing.

For later (i.e. other PRs):

  • examples are better to be placed in src/lib.rs because they are validated at runtime and they don't get so easily outdated.

Copy link
Member

@andreeaflorescu andreeaflorescu left a comment

Choose a reason for hiding this comment

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

There are quite a few typos and other spell errors in the README. Can you please address them in a future PR?

gsserge
gsserge previously approved these changes Feb 10, 2022
AlexandruCihodaru and others added 2 commits February 10, 2022 13:18
* Add initial structures definitions.

Signed-off-by: AlexandruCihodaru <[email protected]>
Co-authored-by: Liu Jiang <[email protected]>
* Started the design and documentation of IntervalTree component of
the AddressAllocator.

Signed-off-by: AlexandruCihodaru <[email protected]>
Co-authored-by: Liu Jiang <[email protected]>
gsserge
gsserge previously approved these changes Feb 10, 2022
Signed-off-by: AlexandruCihodaru <[email protected]>
@andreeaflorescu andreeaflorescu merged commit 6ffc8f9 into rust-vmm:main Feb 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants