Leak Detection sensor support added As part of this commit, following changes have been made: 1. Support set leak detection thresholds command from type-3. 2. Support get leak detection info command from type-3. 3. Support for nsmtool for both commands. 4. Support for mockupResponder for both commands. 5. Support for adding inventory and sensor objects for leak detection. 6. Support for performing patch operations on leak detection thresholds. Applicable on device: SMA/MCU ''' Spec: https://docs.google.com/spreadsheets/d/12d4OYNn7qg3FpKdBPrwSwd7h-FHJGREr/edit?usp=sharing&ouid=114969439290552447702&rtpof=true&sd=true IT: https://docs.google.com/spreadsheets/d/12d4OYNn7qg3FpKdBPrwSwd7h-FHJGREr/edit?usp=sharing&ouid=114969439290552447702&rtpof=true&sd=true Config required: EG- { "Name": "IO_Board_$INSTANCE_NUMBER_LeakDetector", "Type": "NSM_LeakDetection", "SensorIdMap": [2], "SensorNameMap": ["IO_Board_$INSTANCE_NUMBER_LeakDetector_0"], "MaxThresholdsmV": [102], "MinThresholdsmV": [0], "CriticalThresholdsmV": [122], "ChassisPath": "/xyz/openbmc_project/inventory/system/board/IO_Board_$INSTANCE_NUMBER", "UUID": "$UUID" } Tested on VR-BMC: root@vr-nvl144-bmc:~# nsmtool telemetry GetLeakDetectionInfo -m 40 -v nsmtool: <6> EID: 28, TAG: 0b, Tx: 10 de 80 89 03 17 00 00 00 00 00 Success in creating the socket : RC = 5 Success in sending message type as VDM to mctp : RC = 0 nsmtool: <6> EID: 28, TAG: 03, Rx: 10 de 00 89 03 17 00 00 00 16 00 02 03 00 01 a4 00 71 06 16 07 a0 05 01 01 a4 00 71 06 16 07 ce 04 { "Completion Code": 0, "NumberOfSensors": 2, "NumberOfThresholdLevels": 3, "Sensors": [ { "SensorId": 0, "LeakState": 1, "ADCReading": 1440, "Thresholds": [ 164, 1649, 1814 ], "Unit": "mV" }, { "SensorId": 1, "LeakState": 1, "ADCReading": 1230, "Thresholds": [ 164, 1649, 1814 ], "Unit": "mV" } ] } root@vr-nvl144-bmc:~# busctl tree xyz.openbmc_project.NSM | grep -i "leak" | |- /xyz/openbmc_project/inventory/leakdetectors | | |- /xyz/openbmc_project/inventory/leakdetectors/Chassis_0_LeakDetection_0 | | |- /xyz/openbmc_project/inventory/leakdetectors/Chassis_0_LeakDetection_1 | | |- /xyz/openbmc_project/inventory/leakdetectors/IO_Board_0_LeakDetector_0 | | `- /xyz/openbmc_project/inventory/leakdetectors/IO_Board_3_LeakDetector_0 | |- /xyz/openbmc_project/sensors/voltage/Chassis_0_LeakDetection_0 | |- /xyz/openbmc_project/sensors/voltage/Chassis_0_LeakDetection_1 | |- /xyz/openbmc_project/sensors/voltage/IO_Board_0_LeakDetector_0 | `- /xyz/openbmc_project/sensors/voltage/IO_Board_3_LeakDetector_0 `- /xyz/openbmc_project/state/leakdetectors |- /xyz/openbmc_project/state/leakdetectors/Chassis_0_LeakDetection_0 |- /xyz/openbmc_project/state/leakdetectors/Chassis_0_LeakDetection_1 |- /xyz/openbmc_project/state/leakdetectors/IO_Board_0_LeakDetector_0 `- /xyz/openbmc_project/state/leakdetectors/IO_Board_3_LeakDetector_0 root@vr-nvl144-bmc:~# root@vr-nvl144-bmc:~# busctl introspect xyz.openbmc_project.NSM /xyz/openbmc_project/inventory/leakdetectors/Chassis_0_LeakDetection_0 --f NAME TYPE SIGNATURE RESULT/VALUE FLAGS org.freedesktop.DBus.Introspectable interface - - - .Introspect method - s - org.freedesktop.DBus.Peer interface - - - .GetMachineId method - s - .Ping method - - - org.freedesktop.DBus.Properties interface - - - .Get method ss v - .GetAll method s a{sv} - .Set method ssv - - .PropertiesChanged signal sa{sv}as - - xyz.openbmc_project.Association.Definitions interface - - - .Associations property a(sss) 1 "chassis" "contained_by" "/xyz/openbmc_project/inventory/system/chassis/Chassis_0" emits-change writable xyz.openbmc_project.Inventory.Item.LeakDetector interface - - - .LeakDetectorType property s "xyz.openbmc_project.Inventory.Item.LeakDetector.LeakDetectorTypeEnum.Moisture" emits-change root@vr-nvl144-bmc:~# root@vr-nvl144-bmc:~# busctl introspect xyz.openbmc_project.NSM /xyz/openbmc_project/state/leakdetectors/Chassis_0_LeakDetection_0 --f NAME TYPE SIGNATURE RESULT/VALUE FLAGS org.freedesktop.DBus.Introspectable interface - - - .Introspect method - s - org.freedesktop.DBus.Peer interface - - - .GetMachineId method - s - .Ping method - - - org.freedesktop.DBus.Properties interface - - - .Get method ss v - .GetAll method s a{sv} - .Set method ssv - - .PropertiesChanged signal sa{sv}as - - xyz.openbmc_project.Association.Definitions interface - - - .Associations property a(sss) 1 "inventory" "leak_detecting" "/xyz/openbmc_project/inventory/leakdetectors/Chassis_0_LeakDetection_0" emits-change writable xyz.openbmc_project.State.Decorator.OperationalStatus interface - - - .Functional property b true emits-change writable .State property s "xyz.openbmc_project.State.Decorator.OperationalStatus.StateType.Enabled" emits-change writable xyz.openbmc_project.State.LeakDetector interface - - - .DetectorState property s "xyz.openbmc_project.State.LeakDetector.DetectorStateEnum.OK" emits-change root@vr-nvl144-bmc:~# root@vr-nvl144-bmc:~# busctl introspect xyz.openbmc_project.NSM /xyz/openbmc_project/sensors/voltage/Chassis_0_LeakDetection_0 --f NAME TYPE SIGNATURE RESULT/VALUE FLAGS com.nvidia.Async.Set interface - - - .Set method ssv o - org.freedesktop.DBus.Introspectable interface - - - .Introspect method - s - org.freedesktop.DBus.Peer interface - - - .GetMachineId method - s - .Ping method - - - org.freedesktop.DBus.Properties interface - - - .Get method ss v - .GetAll method s a{sv} - .Set method ssv - - .PropertiesChanged signal sa{sv}as - - xyz.openbmc_project.Association.Definitions interface - - - .Associations property a(sss) 1 "chassis" "all_sensors" "/xyz/openbmc_project/inventory/system/chassis/Chassis_0" emits-change writable xyz.openbmc_project.Sensor.Threshold.Critical interface - - - .CriticalAlarmHigh property b false emits-change writable .CriticalAlarmLow property b false emits-change writable .CriticalHigh property d nan emits-change writable .CriticalLow property d 0.099 emits-change writable .CriticalHighAlarmAsserted signal d - - .CriticalHighAlarmDeasserted signal d - - .CriticalLowAlarmAsserted signal d - - .CriticalLowAlarmDeasserted signal d - - xyz.openbmc_project.Sensor.Value interface - - - .MaxAllowableValue property d 3.299 emits-change writable .MaxValue property d inf emits-change writable .MinAllowableValue property d 0.049 emits-change writable .MinValue property d -inf emits-change writable .Unit property s "xyz.openbmc_project.Sensor.Value.Unit.Volts" emits-change writable .Value property d 1.521 emits-change writable root@vr-nvl144-bmc:~# uyadav@uyadav-mlt ~ % curl -k -u root:0penBmc -H 'Expect:' --location --request GET https://$bmc/redfish/v1/Chassis/Chassis_0/Sensors { "@odata.id": "/redfish/v1/Chassis/Chassis_0/Sensors", "@odata.type": "#SensorCollection.SensorCollection", "Description": "Collection of Sensors for this Chassis", "Members": [ { "@odata.id": "/redfish/v1/Chassis/Chassis_0/Sensors/Chassis_0_LeakDetection_0" }, { "@odata.id": "/redfish/v1/Chassis/Chassis_0/Sensors/Chassis_0_LeakDetection_1" } ], "Members@odata.count": 2, "Name": "Sensors" }% uyadav@uyadav-mlt ~ % curl -k -u root:0penBmc -H 'Expect:' --location --request GET https://$bmc/redfish/v1/Chassis/Chassis_0/Sensors/Chassis_0_LeakDetection_0 { "@odata.id": "/redfish/v1/Chassis/Chassis_0/Sensors/Chassis_0_LeakDetection_0", "@odata.type": "#Sensor.v1_7_0.Sensor", "Id": "Chassis_0_LeakDetection_0", "MaxAllowableOperatingValue": 3.299, "MinAllowableOperatingValue": 0.049, "Name": "Chassis 0 LeakDetection 0", "Reading": 1.521, "ReadingType": "Voltage", "ReadingUnits": "V", "RelatedItem": [ { "@odata.id": "/redfish/v1/Chassis/Chassis_0" } ], "Status": { "Conditions": [], "Health": "OK", "HealthRollup": "OK", "State": "Enabled" }, "Thresholds": { "LowerCritical": { "Reading": 0.099 } } }% uyadav@uyadav-mlt ~ % ''' Fixes JIRA https://jirasw.nvidia.com/browse/DGXOPENBMC-22815 Signed-off-by: Utkarsh Yadav <uyadav@nvidia.com>
sudo apt install build-essential gcc-13 g++-13 python3-dev nlohmann-json3-dev pip install --user meson ninja
sudo apt install libboost1.83-all-dev # for Ubuntu 22.04
or
sudo apt install libboost1.84-all-dev # for Ubuntu 24.04
or if it not installed, download and install it from source.
wget https://downloads.sourceforge.net/project/boost/boost/1.84.0/boost_1_84_0.tar.gz tar -xzf boost_1_84_0.tar.gz cd boost_1_84_0 ./bootstrap.sh --prefix=/usr/local ./b2 install
git archive --remote=ssh://git@gitlab-master.nvidia.com:12051/dgx/bmc/libmctp.git develop libmctp-externals.h | tar -x -C common/
# Configure Meson build with debug options and compiler flags (copied from openbmc-build-scripts repo) meson setup --reconfigure -Db_sanitize=address,undefined -Db_lundef=true -Dwerror=true -Dwarning_level=3 -Db_colorout=never -Ddebug=true -Doptimization=g -Dcpp_args="-DBOOST_USE_VALGRIND -Wno-error=invalid-constexpr -Wno-invalid-constexpr -Werror=uninitialized -Wno-error=maybe-uninitialized -Werror=strict-aliasing" builddir # Build all targets ninja -C builddir
# Run all unit tests meson test -C builddir # Run specific unit test meson test -C builddir nsmChassis_test
If you encounter sdbusplus build errors, verify that the revision in subprojects/sdbusplus.wrap matches the version specified in the openbmc-build-scripts repository. Version mismatches can cause build failures.
For other subproject-related errors, you can update all subproject repositories to their latest commits using:
cd subprojects
find -L . -type d -name ".git" | while read gitdir; do
repo=$(dirname "$gitdir")
echo "Pulling updates in $repo"
cd "$repo"
git pull
cd - > /dev/null
done
# Debug all tests meson test -C builddir --gdb # Debug specific test meson test -C builddir nsmChassis_test --gdb
{ "version": "0.2.0", "configurations": [ { "name": "Debug file with Meson", "type": "cppdbg", "request": "launch", "program": "${workspaceFolder}/builddir/${relativeFileDirname}/${fileBasenameNoExtension}", "cwd": "${workspaceFolder}/builddir/${relativeFileDirname}", "preLaunchTask": "Compile meson test" } ] }
{ "version": "2.0.0", "tasks": [ { "label": "Compile meson test", "type": "shell", "command": "meson compile -C builddir ${fileBasenameNoExtension}", "group": "build", } ] }
To ensure code consistency and formatting standards in the CI pipeline, clang-format-19 needs to be installed. Follow the steps below to install clang-format-19 on your system:
# Update the package list sudo apt update # Install clang-format-19 sudo apt install clang-format-19
This will install clang-format-19 on your system, enabling it for use in the CI pipeline.
To automatically format your code before each commit, create a pre-commit hook with the following steps:
cat > .git/hooks/pre-commit << EOL
#!/bin/sh
# Get list of staged files that are C/C++ source files
files=$(git diff --cached --name-only --diff-filter=ACMR | grep ".*\.[ch]\(pp\)\?$")
if [ -n "$files" ]; then
# Format the files
clang-format-19 -i $files
# Add the formatted files back to staging
git add $files
# Check if any files were modified after formatting
if ! git diff --cached --quiet; then
echo "Formatted C/C++ files were automatically fixed up"
fi
fi
exit 0
EOL
chmod +x .git/hooks/pre-commit
The NSM daemon tracks various sensor polling operations using progress counters. These counters are stored in a memory-mapped file descriptor (memfd) and can be accessed via D-Bus for duming, monitoring and debugging purposes.
Each counter type tracks a specific aspect of sensor polling operations:
sensorManager.cpp::pollPrioritySensors()nsmGpmOemFactory.cpp when creating GPM sensorssensorManager.cpp::updateLongRunningSensor()sensorManager.cpp::pollNonPrioritySensors() when pollingType == StaticsensorManager.cpp::pollNonPrioritySensors() when pollingType == RoundRobinSENSOR_POLLING_TIME (typically 150ms)sensorManager.cpp::pollPrioritySensors() when (t1 - t0) > pollingTimeInUsecnsmDevice.cpp::postPatchIO()nsmEvent.cpp::DelegatingEventHandler::delegate()NSM_SUCCESS or NSM_SW_ERROR_TIMEOUTprogressCounters.cpp::increment() when rc != NSM_SUCCESS and rc != NSM_SW_ERROR_TIMEOUTNSM_SW_ERROR_TIMEOUT)progressCounters.cpp::increment() when rc == NSM_SW_ERROR_TIMEOUTProgress counters can be configured via meson options:
progressCounter: Enable/disable progress counter functionality (default: enabled)sensor-progress-counters-dump-count-threshold: Number of counter updates before dumping to memfd (default: 100000)sensor-progress-counters-dump-time-threshold: Time threshold in microseconds before dumping (default: 600000000 = 10 minutes)sensor-progress-counters-memfd-size: Size of the memory-mapped file in bytes (default: 65536)Counter data is exposed via D-Bus at:
/xyz/openbmc_project/progress_counters/<device_eid>
Use the nsmProgressCountersReader tool to read counter data:
# Read counters for all devices nsmProgressCountersReader # Read counters for specific device nsmProgressCountersReader <device_eid>
To add a new progress counter type, follow these steps:
Add your new counter type to nsmd/nsmProgressCounters/progressCounterType.hpp:
enum class ProgressCounterType { Priority, GpuPerformanceMonitoring, // ... existing counters ... YourNewCounter, // Add here, before EnumCount (must be last) EnumCount, };
Important: Always add new counters before EnumCount, as EnumCount must remain the last entry for the CountersCount calculation.
Add comprehensive documentation for your new counter in the nsmd/nsmProgressCounters/progressCounterType.hpp file:
/** * @brief Your new counter description * * Incremented when: Describe when this counter is incremented * * Location: File.cpp::functionName() */ YourNewCounter,
Add your new counter to the “Counter Types and When They Are Incremented” section in this README with:
Add your counter name to the counterNames array in nsmd/nsmProgressCounters/progressCounterReader.cpp:
static constexpr std::array<std::string_view, CountersCount> counterNames = { "Priority", "GPM", "LongRunning", "Static", "RoundRobin", "PriorityTimeExceeded", "PostPatch", "Event", "Error", "Timeout", "YourNewCounter", // Add your counter name here };
Important: The order must match the enum order in ProgressCounterType. This array is used by nsmProgressCountersReader to display counter names in CSV output.
In the appropriate location in your code, increment the counter:
// For successful operations nsmDevice->progressCounters.increment(ProgressCounterType::YourNewCounter, rc, timestamp); // Or directly without return code checking nsmDevice->progressCounters.increment(ProgressCounterType::YourNewCounter, timestamp);
Counters are stored in a packed structure for efficient memory usage:
struct __attribute__((packed)) CounterDataRow { uint32_t key; // Iteration/dump key uint64_t timestamp; // Timestamp in microseconds CountersArray counters; // Array of counter values };
The data rotates in the memfd using key % maxRows to ensure bounded memory usage.
Successful build should generate three binary artifacts.
A Daemon that can discover NSM endpoint, gather telemetry data from the endpoints, and can publish them to D-Bus or similar IPC services, for consumer services like bmcweb.
nsmtool is a client tool that acts as a NSM requester which can be invoked from the BMC. nsmtool sends the request message and parse the response message & display it in readable format.
A mockup NSM responder that can be used for development purpose. Its primary usage is to test nsmd and nsmtool features on an emulator like QEMU.
Follow this steps to run nsmMockupResponder: Step 1 - On the QEMU instance, restart the nsmd service.
Step 2 Assign an address to the loopback (lo) interface $ mctp addr add 12 dev lo
Step 3 Immediately start the mock responder using the assigned address $ nsmMockupResponder -v -d Baseboard -i 0 -e 12
Run Step 3 right after Step 2. If there is any delay, nsmd will fail to detect the endpoint. If detection fails, repeat all steps from the beginning.