Skip to content
README.md 2.19 KiB
Newer Older
Lijian Zhang's avatar
Lijian Zhang committed

Robin Shapley's avatar
Robin Shapley committed
Copyright (c) 2022-2025, Arm Limited. All rights reserved.
Lijian Zhang's avatar
Lijian Zhang committed

Lijian Zhang's avatar
Lijian Zhang committed

Luca Vizzarro's avatar
Luca Vizzarro committed
Dataplane Stack aims to provide a high-throughput packet processing software stack and solutions to solve customer and partner use cases in networking applications. It is implemented, validated and deployed on the Arm AArch64 architecture.
Lijian Zhang's avatar
Lijian Zhang committed

Luca Vizzarro's avatar
Luca Vizzarro committed
The Dataplane Stack architecture is shown in the following figure:
Lijian Zhang's avatar
Lijian Zhang committed

![Dataplane Stack solution architecture](doc/images/dataplane-stack-architecture.png "Dataplane Stack solution architecture")
Lijian Zhang's avatar
Lijian Zhang committed

Luca Vizzarro's avatar
Luca Vizzarro committed
The Dataplane Stack solution serves multiple purposes:
* Showcase the integration of various networking components and act as proof of concept
* Allow for performance analysis/optimization with a solution that is close to real world use cases
Luca Vizzarro's avatar
Luca Vizzarro committed
* Provide users with an out-of-the-box reference solution for rapid development
Lijian Zhang's avatar
Lijian Zhang committed

Luca Vizzarro's avatar
Luca Vizzarro committed
The targeted and verified platforms are:
* Ampere Altra (Neoverse-N1) - Functionalities and Performance
Lijian Zhang's avatar
Lijian Zhang committed

## Important Notes
Nathan Brown's avatar
Nathan Brown committed
Arm Neoverse reference design software solutions are example software projects containing downstream versions of open source components. Although the components in these solutions track their upstream versions, users of these solutions are responsible for ensuring that, if necessary, these components are updated before use to ensure they contain any new functional or security fixes that may be required
# Getting Started
Robin Shapley's avatar
Robin Shapley committed
Please refer to the [User Guide](./doc/user_guide/index.rst) to get started using this solution. The same guide and complete documentation generated from this repository are also available in the [Dataplane Stack online documentation](https://dataplane-stack.docs.arm.com).
# Limitations and Known Issues

* Users of this software stack must consider safety and security implications according to their own usage goals
Luca Vizzarro's avatar
Luca Vizzarro committed
* Does not provide a native traffic generator
Luca Vizzarro's avatar
Luca Vizzarro committed
To provide feedback or to request support, please contact the project maintainers
by email at dataplane-stack@arm.com, or check the 'MAINTAINERS' file
in the root of the repository for module/feature/use-case specific maintainers.

Arm licensees may also contact Arm via their partner managers to request support.