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

Collect namespace ids for NVMe devices #3590

Merged
merged 2 commits into from
Jan 9, 2025
Merged

Collect namespace ids for NVMe devices #3590

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eddd489
Namespace Ids for NVMe devices
SRIKKANTH Jan 8, 2025
7f15d82
Update nvmecli.py
SRIKKANTH Jan 8, 2025
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
69 changes: 65 additions & 4 deletions lisa/tools/nvmecli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT license.
import json
import re
from typing import List, Optional, Type, cast
from typing import Any, Dict, List, Optional, Type, cast

from lisa.executable import Tool
from lisa.operating_system import Posix
Expand Down Expand Up @@ -96,15 +97,74 @@ def support_device_format(self, device_name: str) -> bool:
cmd_result.assert_exit_code()
return self.__format_device_support in cmd_result.stdout

def get_namespaces(self) -> List[str]:
def get_namespaces(self, force_run: bool = False) -> List[str]:
kanchansenlaskar marked this conversation as resolved.
Show resolved Hide resolved
namespaces_cli = []
nvme_list = self.run("list", shell=True, sudo=True)
nvme_list = self.run("list", shell=True, sudo=True, force_run=force_run)
for row in nvme_list.stdout.splitlines():
matched_result = self._namespace_cli_pattern.match(row)
if matched_result:
namespaces_cli.append(matched_result.group("namespace"))
return namespaces_cli

def get_devices(self, force_run: bool = False) -> Any:
nvme_list = self.run("list -o json", shell=True, sudo=True, force_run=force_run)
nvme_devices = json.loads(nvme_list.stdout)
return nvme_devices["Devices"]

def get_disks(self, force_run: bool = False) -> List[str]:
nvme_devices = self.get_devices(force_run=force_run)
return [device["DevicePath"] for device in nvme_devices]

# NVME namespace ids are unique for each disk under any NVME controller.
# These are useful in detecting the lun id of the remote azure disk disks.
# Example output of nvme -list -o json and nvme -list
# root@lisa--170-e0-n0:/home/lisa# nvme -list -o json
# {
# "Devices" : [
# {
# "NameSpace" : 1,
# "DevicePath" : "/dev/nvme0n1",
# "Firmware" : "v1.00000",
# "Index" : 0,
# "ModelNumber" : "MSFT NVMe Accelerator v1.0",
# "ProductName" : "Non-Volatile memory controller: Microsoft Corporation Device 0x00a9", # noqa: E501
# "SerialNumber" : "SN: 000001",
# "UsedBytes" : 536870912000,
# "MaximumLBA" : 1048576000,
# "PhysicalSize" : 536870912000,
# "SectorSize" : 512
# },
# {
# "NameSpace" : 2,
# "DevicePath" : "/dev/nvme0n2",
# "Firmware" : "v1.00000",
# "Index" : 0,
# "ModelNumber" : "MSFT NVMe Accelerator v1.0",
# "ProductName" : "Non-Volatile memory controller: Microsoft Corporation Device 0x00a9", # noqa: E501
# "SerialNumber" : "SN: 000001",
# "UsedBytes" : 4294967296,
# "MaximumLBA" : 8388608,
# "PhysicalSize" : 4294967296,
# "SectorSize" : 512
# }
# ]
# }
# root@lisa--170-e0-n0:/home/lisa# nvme -list
# Node SN Model Namespace Usage Format FW Rev # noqa: E501
# --------------------- -------------------- ---------------------------------------- --------- -------------------------- ---------------- ------- # noqa: E501
# /dev/nvme0n1 SN: 000001 MSFT NVMe Accelerator v1.0 1 536.87 GB / 536.87 GB 512 B + 0 B v1.0000 # noqa: E501
# /dev/nvme0n2 SN: 000001 MSFT NVMe Accelerator v1.0 2 4.29 GB / 4.29 GB 512 B + 0 B v1.0000 # noqa: E501
# /dev/nvme0n3 SN: 000001 MSFT NVMe Accelerator v1.0 15 44.02 GB / 44.02 GB 512 B + 0 B v1.0000 # noqa: E501
# /dev/nvme0n4 SN: 000001 MSFT NVMe Accelerator v1.0 14 6.44 GB / 6.44 GB 512 B + 0 B v1.0000 # noqa: E501
# /dev/nvme1n1 68e8d42a7ed4e5f90002 Microsoft NVMe Direct Disk v2 1 472.45 GB / 472.45 GB 512 B + 0 B NVMDV00 # noqa: E501
# /dev/nvme2n1 68e8d42a7ed4e5f90001 Microsoft NVMe Direct Disk v2 1 472.45 GB / 472.45 GB 512 B + 0 B NVMDV00 # noqa: E501

def get_namespace_ids(self, force_run: bool = False) -> List[Dict[str, int]]:
nvme_devices = self.get_devices(force_run=force_run)
return [
{device["DevicePath"]: int(device["NameSpace"])} for device in nvme_devices
]


class BSDNvmecli(Nvmecli):
# nvme0ns1 (1831420MB)
Expand All @@ -119,13 +179,14 @@ def command(self) -> str:
def can_install(self) -> bool:
return False

def get_namespaces(self) -> List[str]:
def get_namespaces(self, force_run: bool = False) -> List[str]:
output = self.run(
"devlist",
shell=True,
sudo=True,
expected_exit_code=0,
expected_exit_code_failure_message="Unable to get namespaces information",
force_run=force_run,
)
namespaces_cli = []
matched = find_patterns_in_lines(output.stdout, [self._namespace_cli_pattern])
Expand Down
Loading