Skip to content
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

refactor(storage): combine frontend and backend messages #380

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

refactor(storage): combine frontend and backend messages #380

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
bd0c6ab
refactor(storage): use FabricsEndpoint in FabricsPath
artek-koltun Oct 2, 2023
31fdaf6
refactor(storage): use oneof for pcie and fabrics in NvmePath
artek-koltun Oct 2, 2023
2256f9e
feat(storage): add domain_id to PciEndpoint
artek-koltun Oct 5, 2023
da48621
refactor(storage): move subnqn and hostnqn to NvmeRemoteController
artek-koltun Nov 8, 2023
1cea6f7
refactor(storage): remove FabricsPath
artek-koltun Nov 8, 2023
60cc80e
chore(storage): auto-generated protos
artek-koltun Nov 8, 2023
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
44 changes: 18 additions & 26 deletions storage/v1alpha1/autogen.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@
- [CreateNvmeRemoteControllerRequest](#opi_api-storage-v1-CreateNvmeRemoteControllerRequest)
- [DeleteNvmePathRequest](#opi_api-storage-v1-DeleteNvmePathRequest)
- [DeleteNvmeRemoteControllerRequest](#opi_api-storage-v1-DeleteNvmeRemoteControllerRequest)
- [FabricsPath](#opi_api-storage-v1-FabricsPath)
- [GetNvmePathRequest](#opi_api-storage-v1-GetNvmePathRequest)
- [GetNvmeRemoteControllerRequest](#opi_api-storage-v1-GetNvmeRemoteControllerRequest)
- [GetNvmeRemoteNamespaceRequest](#opi_api-storage-v1-GetNvmeRemoteNamespaceRequest)
Expand Down Expand Up @@ -630,26 +629,6 @@ Represents a request to delete an Nvme Remote Controller.



<a name="opi_api-storage-v1-FabricsPath"></a>

### FabricsPath
Represents Fabrics transport path parameters


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| trsvcid | [int64](#int64) | | Destination service id (e.g. Port) |
| subnqn | [string](#string) | | Subsystem NQN |
| adrfam | [NvmeAddressFamily](#opi_api-storage-v1-NvmeAddressFamily) | | Address family |
| source_traddr | [string](#string) | | Source address (e.g. IP of local NIC) |
| source_trsvcid | [int64](#int64) | | Source port (e.g. Port of local NIC) |
| hostnqn | [string](#string) | | Host NQN |






<a name="opi_api-storage-v1-GetNvmePathRequest"></a>

### GetNvmePathRequest
Expand Down Expand Up @@ -805,8 +784,8 @@ Represents a specific path to target controller
| name | [string](#string) | | name is an opaque object handle that is not user settable. name will be returned with created object user can only set {resource}_id on the Create request object |
| controller_name_ref | [string](#string) | | Nvme Remote Controller this path corresponds to |
| trtype | [NvmeTransportType](#opi_api-storage-v1-NvmeTransportType) | | Transport type |
| traddr | [string](#string) | | Destination address (e.g. IP address, BDF for local PCIe) |
| fabrics | [FabricsPath](#opi_api-storage-v1-FabricsPath) | | Not applicable for local PCIe. Required for Nvme over fabrics transport types |
| pcie | [PciEndpoint](#opi_api-storage-v1-PciEndpoint) | | Required for pcie transport type. |
| fabrics | [FabricsEndpoint](#opi_api-storage-v1-FabricsEndpoint) | | Required for Nvme over fabrics transport types |



Expand All @@ -823,6 +802,8 @@ Represents a target controller
| ----- | ---- | ----- | ----------- |
| name | [string](#string) | | name is an opaque object handle that is not user settable. name will be returned with created object user can only set {resource}_id on the Create request object |
| multipath | [NvmeMultipath](#opi_api-storage-v1-NvmeMultipath) | | Multipath mode |
| subnqn | [string](#string) | | Subsystem NQN |
| hostnqn | [string](#string) | | Host NQN |
| io_queues_count | [int64](#int64) | | IO queues count |
| queue_size | [int64](#int64) | | Queue size |
| tcp | [TcpController](#opi_api-storage-v1-TcpController) | | Nvme over TCP specific fields |
Expand Down Expand Up @@ -2702,6 +2683,8 @@ Represents Fabrics Endpoint
| traddr | [string](#string) | | ip address for TCP and RDMA |
| trsvcid | [string](#string) | | port for TCP and RDMA |
| adrfam | [NvmeAddressFamily](#opi_api-storage-v1-NvmeAddressFamily) | | address family |
| source_traddr | [string](#string) | | source address (e.g. IP of local NIC) not used for frontend |
| source_trsvcid | [string](#string) | | source port (e.g. Port of local NIC) not used for frontend |



Expand All @@ -2723,9 +2706,18 @@ confusion with storage &#34;devices&#34;.

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| port_id | [google.protobuf.Int32Value](#google-protobuf-Int32Value) | | The &#34;port&#34; or &#34;device&#34;. In other words, the connector/cable that&#39;s plugged into a particular host. This number may end up matching the host-assigned &#34;device&#34; value in the bus:device:function identifier, but it does not strictly have to and that should not be relied upon. |
| physical_function | [google.protobuf.Int32Value](#google-protobuf-Int32Value) | | Physical function index. This may end up matching the host-assigned &#34;function&#34; value in the bus:device:function identifier, but it does not strictly have to and that should not be relied upon. |
| virtual_function | [google.protobuf.Int32Value](#google-protobuf-Int32Value) | | Virtual function index. 1-based index. The value 0 is reserved to represent the PCI physical &#34;device&#34;. This may end up matching the host-assigned &#34;function&#34; value in the bus:device:function identifier, but it does not strictly have to and that should not be relied upon. |
| port_id | [google.protobuf.Int32Value](#google-protobuf-Int32Value) | | for frontend: The &#34;port&#34; or &#34;device&#34;. In other words, the connector/cable that&#39;s plugged into a particular host. This number may end up matching the host-assigned &#34;device&#34; value in the bus:device:function identifier, but it does not strictly have to and that should not be relied upon.

for backend: Corresponds to &#34;bus&#34; part of BDF |
| physical_function | [google.protobuf.Int32Value](#google-protobuf-Int32Value) | | for frontend: Physical function index. This may end up matching the host-assigned &#34;function&#34; value in the bus:device:function identifier, but it does not strictly have to and that should not be relied upon.

for backend: Corresponds to &#34;device&#34; part of BDF |
| virtual_function | [google.protobuf.Int32Value](#google-protobuf-Int32Value) | | for frontend: Virtual function index. 1-based index. The value 0 is reserved to represent the PCI physical &#34;device&#34;. This may end up matching the host-assigned &#34;function&#34; value in the bus:device:function identifier, but it does not strictly have to and that should not be relied upon.

for backend: Corresponds to &#34;function&#34; part of BDF |
| domain_id | [google.protobuf.Int32Value](#google-protobuf-Int32Value) | | for frontend: Not used

for backend: Corresponds to pci domain value |



Expand Down
46 changes: 18 additions & 28 deletions storage/v1alpha1/backend_nvme.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,14 +153,20 @@ message NvmeRemoteController {
// Multipath mode
NvmeMultipath multipath = 2 [(google.api.field_behavior) = REQUIRED];

// Subsystem NQN
string subnqn = 3 [(google.api.field_behavior) = OPTIONAL];

// Host NQN
string hostnqn = 4 [(google.api.field_behavior) = OPTIONAL];

// IO queues count
int64 io_queues_count = 3 [(google.api.field_behavior) = OPTIONAL];
int64 io_queues_count = 5 [(google.api.field_behavior) = OPTIONAL];

// Queue size
int64 queue_size = 4 [(google.api.field_behavior) = OPTIONAL];
int64 queue_size = 6 [(google.api.field_behavior) = OPTIONAL];

// Nvme over TCP specific fields
TcpController tcp = 5 [(google.api.field_behavior) = OPTIONAL];
TcpController tcp = 7 [(google.api.field_behavior) = OPTIONAL];
}

// Represents parameters specific for TCP target controller
Expand Down Expand Up @@ -206,32 +212,16 @@ message NvmePath {
// Transport type
NvmeTransportType trtype = 3 [(google.api.field_behavior) = REQUIRED];

// Destination address (e.g. IP address, BDF for local PCIe)
string traddr = 4 [(google.api.field_behavior) = REQUIRED];

// Not applicable for local PCIe. Required for Nvme over fabrics transport types
FabricsPath fabrics = 5 [(google.api.field_behavior) = OPTIONAL];
}

// Represents Fabrics transport path parameters
message FabricsPath {
// Destination service id (e.g. Port)
int64 trsvcid = 1 [(google.api.field_behavior) = REQUIRED];
// xPU's PCI/Fabrics endpoint for the controller.
// One of the values is required
// see https://github.com/aip-dev/google.aip.dev/issues/1147 for field_behavior annotations
oneof endpoint {
// Required for pcie transport type.
PciEndpoint pcie = 4 [(google.api.field_behavior) = OPTIONAL];

// Subsystem NQN
string subnqn = 2 [(google.api.field_behavior) = REQUIRED];

// Address family
NvmeAddressFamily adrfam = 3 [(google.api.field_behavior) = REQUIRED];

// Source address (e.g. IP of local NIC)
string source_traddr = 4 [(google.api.field_behavior) = OPTIONAL];

// Source port (e.g. Port of local NIC)
int64 source_trsvcid = 5 [(google.api.field_behavior) = OPTIONAL];

// Host NQN
string hostnqn = 6 [(google.api.field_behavior) = OPTIONAL];
// Required for Nvme over fabrics transport types
FabricsEndpoint fabrics = 5 [(google.api.field_behavior) = OPTIONAL];
}
}

// Represent Nvme namespace created on bridge after connection to a target
Expand Down
Loading
Loading