systems.hpp - initial multi-host implementation

.clang-tidy

@@ -280,7 +280,6 @@ google-explicit-constructor,
 misc-coroutine-hostile-raii,
 misc-definitions-in-headers,
 misc-header-include-cycle,
-misc-include-cleaner,
 misc-misleading-bidirectional,
 misc-misleading-identifier,
 misc-misplaced-const,

AGGREGATION.md

@@ -42,9 +42,9 @@ reject satellite configs that do not comply with these requirements.
 
 ## Satellite BMC Restrictions
 
-- Can only aggregate a single satellite BMC
 - HTTP only connection to satellite BMC
 - No authentication on satellite BMC
+- Each satellite BMC must have a unique "Name" property in its configuration
 
 ## Supported Resources
 
@@ -79,18 +79,19 @@ not appear when querying the Service Root.
 
 Aggregated resources will have a prefix appended to their URIs in order to
 distinguish them from resources that are local to the aggregating BMC. The
-aggregation prefix is planned to be derived from the uuid of the aggregating
-BMC. This should result in the aggregation prefix being unique to each
-aggregating BMC.
+prefix is derived from the "Name" property specified in the satellite BMC's
+configuration in Entity Manager. This allows for meaningful and unique prefixes
+for each satellite BMC.
 
 The general URI format for aggregated resources is
 
 ```bash
-/redfish/v1/<resource_collection>/<prefix>_<resource_id>
+/redfish/v1/<resource_collection>/<name>_<resource_id>
 ```
 
-When support is added for aggregating more than one satellite BMC, then each
-satellite will be assigned its own unique satellite prefix.
+Where `<name>` is the value of the "Name" property from the satellite's
+configuration. For example, if a satellite is configured with `"Name": "sat0"`,
+its resources would appear as `/redfish/v1/Systems/sat0_system`.
 
 ### Aggregating Collections
 
@@ -122,10 +123,13 @@ curl -k -H "X-Auth-Token: $token" https://${bmc}/redfish/v1/Systems
       "@odata.id": "/redfish/v1/Systems/system"
     },
     {
-      "@odata.id": "/redfish/v1/Systems/5B247A_system"
+      "@odata.id": "/redfish/v1/Systems/sat0_system"
+    },
+    {
+      "@odata.id": "/redfish/v1/Systems/sat1_system"
     }
   ],
-  "Members@odata.count": 2,
+  "Members@odata.count": 3,
   "Name": "Computer System Collection"
 }
 ```
@@ -150,18 +154,16 @@ The following steps are used to retrieve the requested aggregated resource:
 5. Return the updated response from the satellite BMC
 
 ```bash
-curl -k -H "X-Auth-Token: $token" https://${bmc}/redfish/v1/Systems/5B247A_system
-{
-  "@odata.id": "/redfish/v1/Systems/5B247A_system",
-  ...
-  "LogServices": {
-    "@odata.id": "/redfish/v1/Systems/5B247A_system/LogServices"
-  },
-  "Memory": {
-    "@odata.id": "/redfish/v1/Systems/5B247A_system/Memory"
-  },
-  ...
-}
+curl -k -H "X-Auth-Token: $token" https://${bmc}/redfish/v1/Systems/sat0_system
+    {
+        "@odata.id" :
+            "/redfish/v1/Systems/sat0_system",
+            ... "LogServices" :
+            {"@odata.id" : "/redfish/v1/Systems/sat0_system/LogServices"},
+            "Memory" :
+            {"@odata.id" : "/redfish/v1/Systems/sat0_system/Memory"},
+            ...
+    }
 ```
 
 We consider any response to be a valid response code from the satellite BMC. The
@@ -179,9 +181,7 @@ are some features that must still be implemented before that can happen.
 
 1. Add links to satellite only collections in responses from service root and
    other appropriate locations
-2. Generate aggregation prefix from uuid
-3. Aggregate more than one satellite BMC
-4. Support HTTPS connection to satellite BMC
+2. Support HTTPS connection to satellite BMC
 
 Support for the following items should be added as well. However, their
 implementation is not a requirement to being able to enable Redfish aggregation

COMMON_ERRORS.md

@@ -212,7 +212,7 @@ whole.
 ```cpp
 BMCWEB_ROUTE("/myendpoint/<str>",
     [](Request& req, Response& res, const std::string& id){
-     crow::connections::systemBus->async_method_call(
+     dbus::utility::async_method_call(
           [asyncResp](const boost::system::error_code& ec,
                       const std::string& myProperty) {
               if (ec)
@@ -244,7 +244,7 @@ An implementation of the above that handles 404 would look like:
 ```cpp
 BMCWEB_ROUTE("/myendpoint/<str>",
     [](Request& req, Response& res, const std::string& id){
-     crow::connections::systemBus->async_method_call(
+     dbus::utility::async_method_call(
           [asyncResp](const boost::system::error_code& ec,
                       const std::string& myProperty) {
               if (ec == <error code that gets returned by not found>){
@@ -374,7 +374,7 @@ recommendation is aligned with the C++ Core Guidelines.
 ## 15. Using async_method_call where there are existing helper methods
 
 ```cpp
-crow::connections::systemBus->async_method_call(
+dbus::utility::async_method_call(
     respHandler, "xyz.openbmc_project.ObjectMapper",
     "/xyz/openbmc_project/object_mapper",
     "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths",

Redfish.md

@@ -454,6 +454,7 @@ Fields common to all schemas
   - EfficiencyPercent
 - FirmwareVersion
 - Location
+- LocationIndicatorActive
 - Manufacturer
 - Model
 - PartNumber
@@ -1119,6 +1120,7 @@ other.
 - HttpPushUri
 - HttpPushUriOptions
 - MaxImageSizeBytes
+- MultipartHttpPushUri
 - ServiceEnabled
 
 ### /redfish/v1/UpdateService/FirmwareInventory/

config/bmcweb.service.in

@@ -10,7 +10,7 @@ ExecStart=@MESON_INSTALL_PREFIX@/libexec/bmcwebd
 Type=simple
 WorkingDirectory=/home/root
 SyslogLevelPrefix=true
-WatchdogSec=@WATCHDOG_TIMEOUT@s
+WatchdogSec=@BMCWEB_WATCHDOG_TIMEOUT_SECONDS@s
 
 [Install]
 WantedBy=network.target

config/meson.build

@@ -177,7 +177,9 @@ configure_file(
     configuration: configuration_data(
         {
             'MESON_INSTALL_PREFIX': get_option('prefix'),
-            'WATCHDOG_TIMEOUT_SECONDS': get_option('watchdog-timeout-seconds'),
+            'BMCWEB_WATCHDOG_TIMEOUT_SECONDS': get_option(
+                'watchdog-timeout-seconds',
+            ),
         },
     ),
 )

http/http_client.hpp

@@ -219,8 +219,8 @@ class ConnectionInfo : public std::enable_shared_from_this<ConnectionInfo>
         if (ec)
         {
             BMCWEB_LOG_ERROR("Connect {}:{}, id: {} failed: {}",
-                             endpoint.address().to_string(), endpoint.port(),
-                             connId, ec.message());
+                             host.encoded_host_address(), host.port(), connId,
+                             ec.message());
             state = ConnState::connectFailed;
             waitAndRetry();
             return;
@@ -243,13 +243,13 @@ class ConnectionInfo : public std::enable_shared_from_this<ConnectionInfo>
         {
             return;
         }
+        auto& ssl = *sslConn;
         state = ConnState::handshakeInProgress;
         timer.expires_after(std::chrono::seconds(30));
         timer.async_wait(std::bind_front(onTimeout, weak_from_this()));
-        sslConn->async_handshake(
-            boost::asio::ssl::stream_base::client,
-            std::bind_front(&ConnectionInfo::afterSslHandshake, this,
-                            shared_from_this()));
+        ssl.async_handshake(boost::asio::ssl::stream_base::client,
+                            std::bind_front(&ConnectionInfo::afterSslHandshake,
+                                            this, shared_from_this()));
     }
 
     void afterSslHandshake(const std::shared_ptr<ConnectionInfo>& /*self*/,

http/http_connection.hpp

@@ -630,16 +630,17 @@ class Connection :
             BMCWEB_LOG_ERROR("Parser was unexpectedly null");
             return;
         }
+        auto& parse = *parser;
+        const auto& value = parser->get();
 
         if (authenticationEnabled)
         {
-            boost::beast::http::verb method = parser->get().method();
+            boost::beast::http::verb method = value.method();
             userSession = authentication::authenticate(
-                ip, res, method, parser->get().base(), mtlsSession);
+                ip, res, method, value.base(), mtlsSession);
         }
 
-        std::string_view expect =
-            parser->get()[boost::beast::http::field::expect];
+        std::string_view expect = value[boost::beast::http::field::expect];
         if (bmcweb::asciiIEquals(expect, "100-continue"))
         {
             res.result(boost::beast::http::status::continue_);
@@ -652,9 +653,9 @@ class Connection :
             return;
         }
 
-        parser->body_limit(getContentLengthLimit());
+        parse.body_limit(getContentLengthLimit());
 
-        if (parser->is_done())
+        if (parse.is_done())
         {
             handle();
             return;
@@ -749,18 +750,19 @@ class Connection :
         {
             return;
         }
+        auto& parse = *parser;
         startDeadline();
         if (httpType == HttpType::HTTP)
         {
             boost::beast::http::async_read_some(
-                adaptor.next_layer(), buffer, *parser,
+                adaptor.next_layer(), buffer, parse,
                 std::bind_front(&self_type::afterRead, this,
                                 shared_from_this()));
         }
         else
         {
             boost::beast::http::async_read_some(
-                adaptor, buffer, *parser,
+                adaptor, buffer, parse,
                 std::bind_front(&self_type::afterRead, this,
                                 shared_from_this()));
         }

http/http_request.hpp

@@ -40,7 +40,7 @@ struct Request
     std::shared_ptr<persistent_data::UserSession> session;
 
     std::string userRole;
-    Request(Body reqIn, std::error_code& ec) : req(std::move(reqIn))
+    Request(Body&& reqIn, std::error_code& ec) : req(std::move(reqIn))
     {
         if (!setUrlInfo())
         {

include/async_resolve.hpp

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: Copyright OpenBMC Authors
 #pragma once
-#include "dbus_singleton.hpp"
+#include "dbus_utility.hpp"
 #include "logging.hpp"
 
 #include <sys/socket.h>
@@ -90,7 +90,7 @@ class Resolver
         }
 
         uint64_t flag = 0;
-        crow::connections::systemBus->async_method_call(
+        dbus::utility::async_method_call(
             [host{std::string(host)}, portNum,
              handler = std::forward<ResolveHandler>(handler)](
                 const boost::system::error_code& ec,

include/authentication.hpp

@@ -231,8 +231,7 @@ inline bool isOnAllowlist(std::string_view url, boost::beast::http::verb method)
         {
             return true;
         }
-        if (crow::webroutes::routes.find(std::string(url)) !=
-            crow::webroutes::routes.end())
+        if (crow::webroutes::routes.contains(std::string(url)))
         {
             return true;
         }

include/dbus_privileges.hpp

@@ -3,7 +3,6 @@
 #pragma once
 
 #include "async_resp.hpp"
-#include "dbus_singleton.hpp"
 #include "dbus_utility.hpp"
 #include "error_messages.hpp"
 #include "http_request.hpp"
@@ -139,7 +138,8 @@ inline void requestUserInfo(
     std::move_only_function<void(const dbus::utility::DBusPropertiesMap&)>&&
         callback)
 {
-    crow::connections::systemBus->async_method_call(
+    dbus::utility::async_method_call(
+        asyncResp,
         [asyncResp, callback = std::move(callback)](
             const boost::system::error_code& ec,
             const dbus::utility::DBusPropertiesMap& userInfoMap) mutable {

include/dbus_utility.hpp

@@ -3,6 +3,7 @@
 // SPDX-FileCopyrightText: Copyright 2018 Intel Corporation
 #pragma once
 
+#include "async_resp.hpp"
 #include "boost_formatters.hpp"
 #include "dbus_singleton.hpp"
 
@@ -14,6 +15,7 @@
 #include <cstddef>
 #include <cstdint>
 #include <functional>
+#include <memory>
 #include <span>
 #include <string>
 #include <string_view>
@@ -99,6 +101,29 @@ void getAllProperties(const std::string& service, const std::string& objectPath,
                       std::function<void(const boost::system::error_code&,
                                          const DBusPropertiesMap&)>&& callback);
 
+template <typename MessageHandler, typename... InputArgs>
+// NOLINTNEXTLINE(readability-identifier-naming)
+void async_method_call(MessageHandler&& handler, const std::string& service,
+                       const std::string& objpath, const std::string& interf,
+                       const std::string& method, const InputArgs&... a)
+{
+    crow::connections::systemBus->async_method_call(
+        std::forward<MessageHandler>(handler), service, objpath, interf, method,
+        a...);
+}
+
+template <typename MessageHandler, typename... InputArgs>
+// NOLINTNEXTLINE(readability-identifier-naming)
+void async_method_call(const std::shared_ptr<bmcweb::AsyncResp>& /*asyncResp*/,
+                       MessageHandler&& handler, const std::string& service,
+                       const std::string& objpath, const std::string& interf,
+                       const std::string& method, const InputArgs&... a)
+{
+    crow::connections::systemBus->async_method_call(
+        std::forward<MessageHandler>(handler), service, objpath, interf, method,
+        a...);
+}
+
 template <typename PropertyType>
 void getProperty(const std::string& service, const std::string& objectPath,
                  const std::string& interface, const std::string& propertyName,

include/google/google_service_root.hpp

@@ -4,7 +4,6 @@
 
 #include "app.hpp"
 #include "async_resp.hpp"
-#include "dbus_singleton.hpp"
 #include "dbus_utility.hpp"
 #include "error_messages.hpp"
 #include "http_request.hpp"
@@ -188,7 +187,8 @@ inline void invokeRoTCommand(
         return;
     }
 
-    crow::connections::systemBus->async_method_call(
+    dbus::utility::async_method_call(
+        asyncResp,
         [asyncResp{asyncResp}](const boost::system::error_code& ec,
                                const std::vector<uint8_t>& responseBytes) {
             invocationCallback(asyncResp, ec, responseBytes);

include/hostname_monitor.hpp

@@ -35,7 +35,7 @@ static std::unique_ptr<sdbusplus::bus::match_t> hostnameSignalMonitor;
 
 inline void installCertificate(const std::filesystem::path& certPath)
 {
-    crow::connections::systemBus->async_method_call(
+    dbus::utility::async_method_call(
         [certPath](const boost::system::error_code& ec) {
             if (ec)
             {