src/lib/address_resolve/tool.cpp

/*
 *
 *    Copyright (c) 2022 Project CHIP Authors
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

#include "AddressResolve.h"

#include <TracingCommandLineArgument.h>
#include <lib/support/CHIPMem.h>
#include <lib/support/logging/CHIPLogging.h>
#include <platform/CHIPDeviceLayer.h>

#include <condition_variable>
#include <mutex>
#include <stdlib.h>
#include <strings.h>

namespace {

using namespace chip;
using chip::Inet::InterfaceId;
using chip::Transport::PeerAddress;

// clang-format off
const char * const sHelp =
    "Usage: address-resolve-tool [<options...>] <command> [ <args...> ]\n"
    "\n"
    "Options:\n"
    "   --trace-to <dest> -- Trace to the given destination (" SUPPORTED_COMMAND_LINE_TRACING_TARGETS ")\n"
    "Commands:\n"
    "\n"
    "    node <nodeid> <compressed_fabricid> -- Find the node for the given node/fabric.\n"
    "\n";
// clang-format on

class PrintOutNodeListener : public chip::AddressResolve::NodeListener
{
public:
    PrintOutNodeListener() { mSelfHandle.SetListener(this); }

    void OnNodeAddressResolved(const PeerId & peerId, const AddressResolve::ResolveResult & result) override
    {
        char addr_string[PeerAddress::kMaxToStringSize];
        result.address.ToString(addr_string);

        ChipLogProgress(Discovery, "Resolve completed: %s", addr_string);
        ChipLogProgress(Discovery, " Supports TCP Client: %s", result.supportsTcpClient ? "YES" : "NO");
        ChipLogProgress(Discovery, " Supports TCP Server: %s", result.supportsTcpServer ? "YES" : "NO");
        ChipLogProgress(Discovery, "   MRP IDLE retransmit timeout:   %u ms", result.mrpRemoteConfig.mIdleRetransTimeout.count());
        ChipLogProgress(Discovery, "   MRP ACTIVE retransmit timeout: %u ms", result.mrpRemoteConfig.mActiveRetransTimeout.count());
        ChipLogProgress(Discovery, "   MRP ACTIVE Threshold time:     %u ms", result.mrpRemoteConfig.mActiveThresholdTime.count());
        ChipLogProgress(Discovery, "   ICD is operating as a:         %s", result.isICDOperatingAsLIT ? "LIT" : "SIT");

        NotifyDone();
    }

    void OnNodeAddressResolutionFailed(const PeerId & peerId, CHIP_ERROR reason) override
    {
        ChipLogError(Discovery, "Failed to resolve: %s", reason.AsString());
        NotifyDone();
    }

    AddressResolve::NodeLookupHandle & Handle() { return mSelfHandle; }

    void NotifyDone() { DeviceLayer::PlatformMgr().StopEventLoopTask(); }

private:
    AddressResolve::NodeLookupHandle mSelfHandle;
};

PrintOutNodeListener gListener;

CHIP_ERROR Initialize()
{
    ReturnErrorOnFailure(DeviceLayer::PlatformMgr().InitChipStack());
    ReturnErrorOnFailure(Dnssd::Resolver::Instance().Init(DeviceLayer::UDPEndPointManager()));
    ReturnErrorOnFailure(AddressResolve::Resolver::Instance().Init(&DeviceLayer::SystemLayer()));
    return CHIP_NO_ERROR;
}

void Shutdown()
{
    chip::AddressResolve::Resolver::Instance().Shutdown();
    Dnssd::Resolver::Instance().Shutdown();
    DeviceLayer::PlatformMgr().Shutdown();
}

bool Cmd_Node(int argc, const char ** argv)
{
    if (argc != 2)
    {
        ChipLogError(NotSpecified, "Please provide nodeid and fabricid as arguments");
        return false;
    }

    uint64_t node = strtoull(argv[0], nullptr, 0 /* auto-detect base */);

    if (node == 0)
    {
        ChipLogError(NotSpecified, "Node ID %s not supported", argv[0]);
        return false;
    }

    uint64_t fabric = strtoull(argv[1], nullptr, 0 /* auto-detect base */);
    if (node == 0)
    {
        ChipLogError(NotSpecified, "Compressed fabric ID %s not supported", argv[1]);
        return false;
    }

    ChipLogProgress(NotSpecified, "Will search for node 0x" ChipLogFormatX64 " on fabric 0x" ChipLogFormatX64,
                    ChipLogValueX64(node), ChipLogValueX64(fabric));

    AddressResolve::NodeLookupRequest request(PeerId().SetNodeId(node).SetCompressedFabricId(fabric));

    CHIP_ERROR err = AddressResolve::Resolver::Instance().LookupNode(request, gListener.Handle());

    if (err != CHIP_NO_ERROR)
    {
        ChipLogError(Discovery, "Lookup request failed: %s", err.AsString());
        return false;
    }
    ChipLogProgress(NotSpecified, "Running chip event loop and waiting for finish...");

    DeviceLayer::PlatformMgr().RunEventLoop();
    Shutdown();
    return true;
}

extern "C" void StopSignalHandler(int signal)
{
    // no lint below because StopEventLoopTask is assumed to be async safe.
    DeviceLayer::PlatformMgr().StopEventLoopTask(); // NOLINT(bugprone-signal-handler)
}

} // namespace

extern "C" int main(int argc, const char ** argv)
{
    Platform::MemoryInit();

    signal(SIGTERM, StopSignalHandler);
    signal(SIGINT, StopSignalHandler);

    // skip binary name
    argc--;
    argv++;

    chip::CommandLineApp::TracingSetup tracing_setup;

    while (argc > 0)
    {
        if (strcasecmp(argv[0], "--help") == 0 || strcasecmp(argv[0], "-h") == 0)
        {
            fputs(sHelp, stdout);
            return 0;
        }

        if (strcasecmp(argv[0], "--trace-to") == 0)
        {
            if (argc > 1)
            {
                tracing_setup.EnableTracingFor(argv[1]);
                argc -= 2;
                argv += 2;
            }
            else
            {
                ChipLogError(NotSpecified, "Missing trace to argument.");
                return -1;
            }
        }
        else
        {
            break;
        }
    }

    if (argc < 1)
    {
        ChipLogError(NotSpecified, "Please specify a command, or 'help' for help.");
        return -1;
    }

    if (strcasecmp(argv[0], "help") == 0)
    {
        fputs(sHelp, stdout);
        return 0;
    }

    CHIP_ERROR err = Initialize();
    if (err != CHIP_NO_ERROR)
    {
        ChipLogError(NotSpecified, "Initialization failed: %s", err.AsString());
        return 1;
    }

    if (strcasecmp(argv[0], "node") == 0)
    {
        return Cmd_Node(argc - 1, argv + 1) ? 0 : 1;
    }

    ChipLogError(NotSpecified, "Unrecognized command: %s", argv[1]);
    return 1;
}