Decouple memory-map and related types from boot.rs and put them into mem/memory_map/
the trait improvement discussed inmem: introduce traits MemoryMap and MemoryMapMut #1234 (comment)

IMHO, multiple smaller modules are a better replacement for the gigantic module.

Steps to undraft

mergemem: introduce traits MemoryMap and MemoryMapMut #1234

Checklist

Sensible git history (for example, squash "typo" or "fix" commits). See theRewriting History guide for help.
Update the changelog (if necessary)

phip1611 self-assigned this

Jul 14, 2024

phip1611 changed the title~~cleanup followup mem~~Draft: cleanup followup mem

Jul 14, 2024

phip1611 marked this pull request as draft

July 14, 2024 07:46

phip1611 mentioned this pull request

Jul 14, 2024

mem: introduce traits MemoryMap and MemoryMapMut#1234

Merged

2 tasks

phip1611 force-pushed themem-follow-up branch from229068e to125495cCompare

July 15, 2024 08:49

phip1611 marked this pull request as ready for review

July 15, 2024 08:50

phip1611 changed the title~~Draft: cleanup followup mem~~cleanup followup mem

Jul 15, 2024

phip1611 requested a review fromnicholasbishop

July 15, 2024 08:50

Copy link

Member

nicholasbishop commentedJul 15, 2024

Definitely agree that splitting out some smaller modules is good.

A couple naming thoughts:

How aboutmemory_map or justmemory instead ofmmap? Otherwise it sounds likemmap(2)
Maybe move it up to a top-level module likeuefi::memory. Although the memory map is retrieved with a boot-services function, it continues to be relevant after exiting boot services, so thematically I think it makes sense at the top level.

This was referencedJul 21, 2024

MemoryMapRef/MemoryMapRefMut constructors#1247

Closed

uefi: mem: mem.rs -> mem/mod.rs#1251

Merged

phip1611 force-pushed themem-follow-up branch 2 times, most recently fromb03335a tocfc6b2eCompare

July 27, 2024 10:31

phip1611 changed the title~~cleanup followup mem~~cleanup/follow-up: memory_map

Jul 27, 2024

phip1611 force-pushed themem-follow-up branch fromcfc6b2e to0c464bdCompare

July 27, 2024 10:45

Copy link

MemberAuthor

phip1611 commentedJul 27, 2024•
edited
Loading

This is now ready for the second review round,@nicholasbishop

phip1611 marked this pull request as draft

July 27, 2024 10:54

phip1611 marked this pull request as ready for review

July 27, 2024 12:50

phip1611 force-pushed themem-follow-up branch 3 times, most recently fromc23c1c3 to09a8c42Compare

July 27, 2024 13:03

phip1611 added4 commits

July 27, 2024 15:07

uefi: move memory map types from boot.rs to mem/memory_map/mod.rs

7c36c4b

This is a preliminary step to further split that module down into multipleparts.

uefi: mem: decouple memory_map/mod.rs into multiple smaller modules

51641ca

uefi: MemoryMap: Index as super trait for MemoryMap

3278e5d

uefi: memory_map: streamline documentation

dd14f00

phip1611 force-pushed themem-follow-up branch from09a8c42 to3b2def4Compare

July 27, 2024 13:07

phip1611and others added2 commits

July 27, 2024 20:22

uefi: mem: memory-map: break API

61c00b9

As deprecated re-exports are unsupported [0], we go the hard way andjust make it a breaking change.Along the way, I reordered some statements in some files to follow our typicalorder of:- pub mod- private mod- pub use- private use[0]rust-lang/rust#30827