Skip to content

Commit

Permalink
update the doc
Browse files Browse the repository at this point in the history
Signed-off-by: Ric Li <[email protected]>
  • Loading branch information
ricmli committed Nov 16, 2023
1 parent 698ed12 commit d95804e
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 2 deletions.
1 change: 1 addition & 0 deletions lib/src/mt_instance.c
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ int mt_instance_get_lcore(struct mtl_main_impl* impl, unsigned int lcore_id) {

int response = msg.body.response_msg.response;

/* retuen negative value incase user check with < 0 */
return -response;
}

Expand Down
19 changes: 17 additions & 2 deletions manager/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,31 @@
# MTL Manager
# MTL Manager Documentation

Manager is a daemon server running under root privilege. It is responsible for managing the instances of MTL and handling control plane configurations which require high privileges.
## Overview

![design](manager-design.svg)

MTL Manager is a daemon server designed to operate with root privileges. Its primary role is to manage the lifecycle and configurations of MTL instances. It addresses a variety of administrative tasks, including:

- Lcore Management: Ensures that MTL instances are aware of the lcores used by others, optimizing resource allocation.
- eBPF/XDP Loader: Dynamically loads and manages eBPF/XDP programs for advanced packet processing and performance tuning.
- NIC Configuration: Configures Network Interface Cards (NICs) with capabilities like adding or deleting flow and queue settings.
- Instances Monitor: Continuously monitors MTL instances, providing status reporting and clearing mechanisms.

## Build

To compile the MTL Manager, use the following commands:

```bash
meson setup build
meson compile -C build
```

## Run

To run the MTL Manager, execute:

```bash
sudo ./build/MtlManager
```

This command will start the MTL Manager with root privileges, which are necessary for the advanced eBPF and network configurations and management tasks it performs.
4 changes: 4 additions & 0 deletions manager/manager-design.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d95804e

Please sign in to comment.