Implement cable monitor
Cable monitor consumes a cable configuration file which mentions which
cables are expected to be connected. This configuration file would be
staged by an external service running in the DC. Cable monitor also
consumes the Cable inventory from EM and compares that against the
expected cables from configuration file. Based on this, it generates
cable connected/disconnected events. For more information, refer to
design https://gerrit.openbmc.org/c/openbmc/docs/+/74799.
Related PRs:
https://gerrit.openbmc.org/c/openbmc/phosphor-dbus-interfaces/+/74397
Tested:
Testing has been performed with simulated configuration.
```
>> busctl tree xyz.openbmc_project.EntityManager
`- /xyz
`- /xyz/openbmc_project
|- /xyz/openbmc_project/EntityManager
`- /xyz/openbmc_project/inventory
`- /xyz/openbmc_project/inventory/system
`- /xyz/openbmc_project/inventory/system/cable
|- /xyz/openbmc_project/inventory/system/cable/Yosemite_4_Tray_Cable
| |- /xyz/openbmc_project/inventory/system/cable/Yosemite_4_Tray_Cable/TrayDetector1
| `- /xyz/openbmc_project/inventory/system/cable/Yosemite_4_Tray_Cable/TrayDetector2
`- /xyz/openbmc_project/inventory/system/cable/Yosemite_4_Tray_Cable_2
|- /xyz/openbmc_project/inventory/system/cable/Yosemite_4_Tray_Cable_2/TrayDetector3
`- /xyz/openbmc_project/inventory/system/cable/Yosemite_4_Tray_Cable_2/TrayDetector4
>> cat /var/lib/cablemonitor.d/cable-config.json
{
"ConnectedCables": ["Yosemite 4 Tray Cable", "Yosemite 4 Tray Cable 2"]
}
>> busctl tree xyz.openbmc_project.EntityManager
`- /xyz
`- /xyz/openbmc_project
|- /xyz/openbmc_project/EntityManager
`- /xyz/openbmc_project/inventory
`- /xyz/openbmc_project/inventory/system
`- /xyz/openbmc_project/inventory/system/cable
`- /xyz/openbmc_project/inventory/system/cable/Yosemite_4_Tray_Cable
|- /xyz/openbmc_project/inventory/system/cable/Yosemite_4_Tray_Cable/TrayDetector1
`- /xyz/openbmc_project/inventory/system/cable/Yosemite_4_Tray_Cable/TrayDetector2
>> curl -k -H "X-Auth-Token: $token" -X GET https://${bmc}/redfish/v1/Systems/system/LogServices/EventLog/Entries
{
"@odata.id": "/redfish/v1/Systems/system/LogServices/EventLog/Entries",
"@odata.type": "#LogEntryCollection.LogEntryCollection",
"Description": "Collection of System Event Log Entries",
"Members": [
...
{
"@odata.id": "/redfish/v1/Systems/system/LogServices/EventLog/Entries/3",
"@odata.type": "#LogEntry.v1_9_0.LogEntry",
"AdditionalDataURI": "/redfish/v1/Systems/system/LogServices/EventLog/Entries/3/attachment",
"Created": "2024-05-10T08:53:12.409+00:00",
"EntryType": "Event",
"Id": "3",
"Message": "xyz.openbmc_project.State.Cable.CableDisconnected",
"Modified": "2024-05-10T08:53:12.409+00:00",
"Name": "System Event Log Entry",
"Resolved": false,
"Severity": "Warning"
}
],
"Members@odata.count": 2,
"Name": "System Event Log Entries"
}
>> curl -k -H "X-Auth-Token: $token" -X GET https://${bmc}/redfish/v1/Systems/system/LogServices/EventLog/Entries
{
"@odata.id": "/redfish/v1/Systems/system/LogServices/EventLog/Entries",
"@odata.type": "#LogEntryCollection.LogEntryCollection",
"Description": "Collection of System Event Log Entries",
"Members": [
...
{
"@odata.id": "/redfish/v1/Systems/system/LogServices/EventLog/Entries/3",
"@odata.type": "#LogEntry.v1_9_0.LogEntry",
"AdditionalDataURI": "/redfish/v1/Systems/system/LogServices/EventLog/Entries/3/attachment",
"Created": "2024-05-10T08:53:12.409+00:00",
"EntryType": "Event",
"Id": "3",
"Message": "xyz.openbmc_project.State.Cable.CableDisconnected",
"Modified": "2024-05-10T08:54:13.691+00:00",
"Name": "System Event Log Entry",
"Resolved": true,
"Severity": "Warning"
},
{
"@odata.id": "/redfish/v1/Systems/system/LogServices/EventLog/Entries/5",
"@odata.type": "#LogEntry.v1_9_0.LogEntry",
"AdditionalDataURI": "/redfish/v1/Systems/system/LogServices/EventLog/Entries/5/attachment",
"Created": "2024-05-10T08:54:13.743+00:00",
"EntryType": "Event",
"Id": "5",
"Message": "xyz.openbmc_project.State.Cable.CableConnected",
"Modified": "2024-05-10T08:54:13.743+00:00",
"Name": "System Event Log Entry",
"Resolved": false,
"Severity": "OK"
}
],
"Members@odata.count": 4,
"Name": "System Event Log Entries"
}
```
Change-Id: Ic0552962406a95cc46d4dd1d83d72e68e0bd28b4
Signed-off-by: Jagpal Singh Gill <paligill@gmail.com>
diff --git a/src/cable-monitor/CableMonitor.hpp b/src/cable-monitor/CableMonitor.hpp
new file mode 100644
index 0000000..3a2d0a0
--- /dev/null
+++ b/src/cable-monitor/CableMonitor.hpp
@@ -0,0 +1,66 @@
+#pragma once
+
+#include "CableConfig.hpp"
+#include "CableEvents.hpp"
+#include "EntityManagerInterface.hpp"
+#include "NotifyWatch.hpp"
+
+#include <sdbusplus/async.hpp>
+#include <sdbusplus/message/native_types.hpp>
+#include <xyz/openbmc_project/Inventory/Item/Cable/client.hpp>
+
+#include <string>
+
+namespace cable
+{
+
+class Monitor;
+
+using CableInventoryIntf =
+ sdbusplus::client::xyz::openbmc_project::inventory::item::Cable<>;
+
+class Monitor
+{
+ public:
+ Monitor() = delete;
+
+ explicit Monitor(sdbusplus::async::context& ctx);
+
+ private:
+ /** @brief Callback handler for new interfaces added to inventory */
+ auto inventoryAddedHandler(
+ const sdbusplus::message::object_path& objectPath,
+ const std::string& interfaceName) -> void;
+
+ /** @brief Callback handler for interfaces removed from inventory */
+ auto inventoryRemovedHandler(
+ const sdbusplus::message::object_path& objectPath,
+ const std::string& interfaceName) -> void;
+
+ /** @brief Callback handler for async updates to cable JSON configuration */
+ auto configUpdateHandler(std::string configFileName)
+ -> sdbusplus::async::task<>;
+
+ /** @brief Start the Cable Monitor */
+ auto start() -> sdbusplus::async::task<>;
+
+ /** @brief Asynchronously process cable inventory added */
+ auto processCableAddedAsync(sdbusplus::message::object_path objectPath)
+ -> sdbusplus::async::task<>;
+
+ /** @brief Asynchronously process cable inventory removed */
+ auto processCableRemovedAsync(sdbusplus::message::object_path objectPath)
+ -> sdbusplus::async::task<>;
+
+ /** @brief Reconcile connected and expected cable data */
+ auto reconcileCableData() -> void;
+
+ sdbusplus::async::context& ctx;
+ Config::Cables connectedCables;
+ Config::Cables expectedCables;
+ Events cableEvents;
+ entity_manager::EntityManagerInterface entityManager;
+ notify_watch::NotifyWatch notifyWatch;
+};
+
+} // namespace cable