Skip to content

Add IoRing implementation plan for Windows high-performance transport #185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

Add IoRing implementation plan for Windows high-performance transport #185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9abd12a
Initial plan
Copilot Feb 12, 2026
ace328e
Add Magma.IoRing implementation plan and project structure
Copilot Feb 12, 2026
6ffb9f8
Update documentation to reference IoRing implementation plan
Copilot Feb 12, 2026
55a838a
Fix IoRing project to target .NET 10 and correct documentation
Copilot Feb 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ Magma is organized into modular components corresponding to different layers of
- **Magma.NetMap** - Integration with NetMap for high-performance packet I/O on Linux
- **Magma.AF_XDP** - Modern Linux kernel-native XDP socket support (4.18+) for zero-copy packet processing
- **Magma.WinTun** - Windows TUN/TAP interface for VPN and tunnel applications using WireGuard's WinTun driver
- **Magma.IoRing** - Windows 11+ IoRing API integration for high-performance networking (Planned - see [implementation plan](src/Magma.IoRing/IMPLEMENTATION_PLAN.md))
- **Magma.PCap** - Packet capture support for network monitoring

## Key Features
Expand All @@ -64,7 +65,9 @@ Magma is organized into modular components corresponding to different layers of
- NetMap kernel module (legacy support)
- AF_XDP (XDP sockets) - Modern kernel-native approach (recommended for Linux 4.18+)
- DPDK support ready (for extreme performance requirements)
- **Windows**: WinTun driver from WireGuard project (actively maintained)
- **Windows**: Multiple options for high-performance networking
- WinTun driver from WireGuard project (actively maintained)
- IoRing API for Windows 11+ (planned - high-performance native Windows transport)
- .NET 10 compatibility

### Integration-Ready
Expand Down
10 changes: 10 additions & 0 deletions docs/ARCHITECTURE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,10 @@ Magma is designed as a modular, layered network stack that provides direct acces
│ └────────────────┴──────────────────┴────────────────┘ │
│ │
│ ┌────────────────────────────────────────────────────┐ │
│ │ Magma.IoRing (Windows 11+ - Planned) │ │
│ └────────────────────────────────────────────────────┘ │
│ │
│ ┌────────────────────────────────────────────────────┐ │
│ │ Magma.PCap (Packet Capture) │ │
│ └────────────────────────────────────────────────────┘ │
└────────────────────────────────────────────────────────────────┘
Expand Down Expand Up @@ -111,6 +115,12 @@ Platform integrations provide the bridge between Magma and the underlying OS ker
- Maintained by the WireGuard project
- Used for VPN and tunnel applications

- **Magma.IoRing**: Windows 11+ integration using IoRing API (Planned)
- High-performance asynchronous I/O via ring buffers
- Requires Windows 11 Build 22000+ or Windows Server 2022+
- Native Windows API, no third-party drivers needed
- See [src/Magma.IoRing/IMPLEMENTATION_PLAN.md](../src/Magma.IoRing/IMPLEMENTATION_PLAN.md) for details

- **Magma.PCap**: Packet capture support
- PCAP file format writer
- Network monitoring and debugging
Expand Down
Loading