dbus/server/dbus_agent.cpp

/*
 *    Copyright (c) 2020, The OpenThread Authors.
 *    All rights reserved.
 *
 *    Redistribution and use in source and binary forms, with or without
 *    modification, are permitted provided that the following conditions are met:
 *    1. Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *    2. Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *    3. Neither the name of the copyright holder nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 *    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *    POSSIBILITY OF SUCH DAMAGE.
 */

#define OTBR_LOG_TAG "DBUS"

#include "dbus/server/dbus_agent.hpp"

#include <chrono>
#include <thread>
#include <unistd.h>

#include "common/logging.hpp"
#include "dbus/common/constants.hpp"
#include "dbus/server/dbus_thread_object_ncp.hpp"
#include "dbus/server/dbus_thread_object_rcp.hpp"
#include "mdns/mdns.hpp"

namespace otbr {
namespace DBus {

const struct timeval           DBusAgent::kPollTimeout = {0, 0};
constexpr std::chrono::seconds DBusAgent::kDBusWaitAllowance;

DBusAgent::DBusAgent(otbr::Ncp::ThreadHost &aHost, Mdns::Publisher &aPublisher)
    : mInterfaceName(aHost.GetInterfaceName())
    , mHost(aHost)
    , mPublisher(aPublisher)
{
}

void DBusAgent::Init(otbr::BorderAgent &aBorderAgent)
{
    otbrError error = OTBR_ERROR_NONE;

    auto connection_deadline = Clock::now() + kDBusWaitAllowance;

    while ((mConnection = PrepareDBusConnection()) == nullptr && Clock::now() < connection_deadline)
    {
        otbrLogWarning("Failed to setup DBus connection, will retry after 1 second");
        std::this_thread::sleep_for(std::chrono::seconds(1));
    }

    VerifyOrDie(mConnection != nullptr, "Failed to get DBus connection");

    switch (mHost.GetCoprocessorType())
    {
    case OT_COPROCESSOR_RCP:
        mThreadObject = MakeUnique<DBusThreadObjectRcp>(*mConnection, mInterfaceName,
                                                        static_cast<Ncp::RcpHost &>(mHost), &mPublisher, aBorderAgent);
        break;

    case OT_COPROCESSOR_NCP:
        mThreadObject =
            MakeUnique<DBusThreadObjectNcp>(*mConnection, mInterfaceName, static_cast<Ncp::NcpHost &>(mHost));
        break;

    default:
        DieNow("Unknown coprocessor type!");
        break;
    }

    error = mThreadObject->Init();
    VerifyOrDie(error == OTBR_ERROR_NONE, "Failed to initialize DBus Agent");
}

DBusAgent::UniqueDBusConnection DBusAgent::PrepareDBusConnection(void)
{
    DBusError            dbusError;
    DBusConnection      *conn = nullptr;
    UniqueDBusConnection uniqueConn;
    int                  requestReply;
    std::string          serverName = OTBR_DBUS_SERVER_PREFIX + mInterfaceName;

    dbus_error_init(&dbusError);

    conn = dbus_bus_get(DBUS_BUS_SYSTEM, &dbusError);

    uniqueConn = UniqueDBusConnection(conn, [](DBusConnection *aConnection) { dbus_connection_unref(aConnection); });

    VerifyOrExit(uniqueConn != nullptr,
                 otbrLogWarning("Failed to get DBus connection: %s: %s", dbusError.name, dbusError.message));
    dbus_bus_register(uniqueConn.get(), &dbusError);

    requestReply =
        dbus_bus_request_name(uniqueConn.get(), serverName.c_str(), DBUS_NAME_FLAG_REPLACE_EXISTING, &dbusError);
    VerifyOrExit(requestReply == DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER ||
                     requestReply == DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER,
                 {
                     otbrLogWarning("Failed to request DBus name: %s: %s", dbusError.name, dbusError.message);
                     uniqueConn = nullptr;
                 });
    VerifyOrExit(
        dbus_connection_set_watch_functions(uniqueConn.get(), AddDBusWatch, RemoveDBusWatch, nullptr, this, nullptr),
        uniqueConn = nullptr);

exit:
    dbus_error_free(&dbusError);

    return uniqueConn;
}

dbus_bool_t DBusAgent::AddDBusWatch(struct DBusWatch *aWatch, void *aContext)
{
    static_cast<DBusAgent *>(aContext)->mWatches.insert(aWatch);
    return TRUE;
}

void DBusAgent::RemoveDBusWatch(struct DBusWatch *aWatch, void *aContext)
{
    static_cast<DBusAgent *>(aContext)->mWatches.erase(aWatch);
}

void DBusAgent::Update(MainloopContext &aMainloop)
{
    unsigned int flags;
    int          fd;
    uint8_t      fdSetMask = MainloopContext::kErrorFdSet;

    if (dbus_connection_get_dispatch_status(mConnection.get()) == DBUS_DISPATCH_DATA_REMAINS)
    {
        aMainloop.mTimeout = {0, 0};
    }

    for (const auto &watch : mWatches)
    {
        if (!dbus_watch_get_enabled(watch))
        {
            continue;
        }

        flags = dbus_watch_get_flags(watch);
        fd    = dbus_watch_get_unix_fd(watch);

        if (fd < 0)
        {
            continue;
        }

        if (flags & DBUS_WATCH_READABLE)
        {
            fdSetMask |= MainloopContext::kReadFdSet;
        }

        if ((flags & DBUS_WATCH_WRITABLE))
        {
            fdSetMask |= MainloopContext::kWriteFdSet;
        }

        aMainloop.AddFdToSet(fd, fdSetMask);
    }
}

void DBusAgent::Process(const MainloopContext &aMainloop)
{
    unsigned int flags;
    int          fd;

    for (const auto &watch : mWatches)
    {
        if (!dbus_watch_get_enabled(watch))
        {
            continue;
        }

        flags = dbus_watch_get_flags(watch);
        fd    = dbus_watch_get_unix_fd(watch);

        if (fd < 0)
        {
            continue;
        }

        if ((flags & DBUS_WATCH_READABLE) && !FD_ISSET(fd, &aMainloop.mReadFdSet))
        {
            flags &= static_cast<unsigned int>(~DBUS_WATCH_READABLE);
        }

        if ((flags & DBUS_WATCH_WRITABLE) && !FD_ISSET(fd, &aMainloop.mWriteFdSet))
        {
            flags &= static_cast<unsigned int>(~DBUS_WATCH_WRITABLE);
        }

        if (FD_ISSET(fd, &aMainloop.mErrorFdSet))
        {
            flags |= DBUS_WATCH_ERROR;
        }

        dbus_watch_handle(watch, flags);
    }

    while (DBUS_DISPATCH_DATA_REMAINS == dbus_connection_dispatch(mConnection.get()))
        ;
}

} // namespace DBus
} // namespace otbr