FairMQ/fairmq/ofi/Context.cxx

/********************************************************************************
 *    Copyright (C) 2018 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
 *                                                                              *
 *              This software is distributed under the terms of the             *
 *              GNU Lesser General Public Licence (LGPL) version 3,             *
 *                  copied verbatim in the file "LICENSE"                       *
 ********************************************************************************/

#include <fairmq/ofi/Context.h>
#include <fairmq/Tools.h>
#include <FairMQLogger.h>

#include <arpa/inet.h>
#include <memory>
#include <rdma/fabric.h>
#include <rdma/fi_domain.h>
#include <rdma/fi_endpoint.h>
#include <rdma/fi_errno.h>
#include <regex>
#include <string>
#include <string.h>
#include <zmq.h>

namespace fair
{
namespace mq
{
namespace ofi
{

using namespace std;

Context::Context(int numberIoThreads)
    : fOfiDomain(nullptr)
    , fOfiFabric(nullptr)
    , fZmqContext(zmq_ctx_new())
{
    if (!fZmqContext)
        throw ContextError{tools::ToString("Failed creating zmq context, reason: ", zmq_strerror(errno))};
}

Context::~Context()
{
    if (zmq_ctx_term(fZmqContext) != 0) {
        LOG(error) << "Failed closing zmq context, reason: " << zmq_strerror(errno);
    }

	if (fOfiFabric) {
        auto ret = fi_close(&fOfiFabric->fid);
        if (ret != FI_SUCCESS)
            LOG(error) << "Failed closing ofi fabric, reason: " << fi_strerror(ret);
    }

	if (fOfiDomain) {
        auto ret = fi_close(&fOfiDomain->fid);
        if (ret != FI_SUCCESS)
            LOG(error) << "Failed closing ofi domain, reason: " << fi_strerror(ret);
    }
}

auto Context::GetZmqVersion() const -> std::string
{
    int major, minor, patch;
    zmq_version(&major, &minor, &patch);
    return tools::ToString(major, ".", minor, ".", patch);
}

auto Context::GetOfiApiVersion() const -> std::string
{
    auto ofi_version{fi_version()};
    return tools::ToString(FI_MAJOR(ofi_version), ".", FI_MINOR(ofi_version));
}

auto Context::InitOfi(ConnectionType type, std::string address) -> void
{
    // Parse address
    string protocol, ip;
    unsigned int port = 0;
    regex address_regex("^([a-z]+)://([0-9]+\\.[0-9]+\\.[0-9]+\\.[0-9]+):([0-9]+).*");
    smatch address_result;
    if (regex_match(address, address_result, address_regex)) {
        protocol = address_result[1];
        ip = address_result[2];
        port = stoul(address_result[3]);
        LOG(debug) << "Parsed '" << protocol << "', '" << ip << "', '" << port << "' fields from '" << address << "'";
    }
    if (protocol != "tcp") throw ContextError{"Wrong protocol: Supplied address must be in format tcp://ip:port"};

    if (!fOfiInfo) {
        sockaddr_in* sa = static_cast<sockaddr_in*>(malloc(sizeof(sockaddr_in)));
        inet_pton(AF_INET, ip.c_str(), &(sa->sin_addr));
        sa->sin_port = port;
        sa->sin_family = AF_INET;

        // Prepare fi_getinfo query
        unique_ptr<fi_info, void(*)(fi_info*)> ofi_hints(fi_allocinfo(), fi_freeinfo);
        ofi_hints->caps = FI_MSG;
        ofi_hints->mode = FI_ASYNC_IOV;
        ofi_hints->addr_format = FI_SOCKADDR_IN;
        ofi_hints->fabric_attr->prov_name = strdup("sockets");
        ofi_hints->ep_attr->type = FI_EP_RDM;
        if (type == ConnectionType::Bind) {
            ofi_hints->src_addr = sa;
            ofi_hints->src_addrlen = sizeof(sockaddr_in);
        } else {
            ofi_hints->dest_addr = sa;
            ofi_hints->dest_addrlen = sizeof(sockaddr_in);
        }

        // Query fi_getinfo for fabric to use
        auto res = fi_getinfo(FI_VERSION(1, 5), nullptr, nullptr, 0, ofi_hints.get(), &fOfiInfo);
        if (res != 0) throw ContextError{tools::ToString("Failed querying fi_getinfo, reason: ", fi_strerror(res))};
        if (!fOfiInfo) throw ContextError{"Could not find any ofi compatible fabric."};

        // for(auto cursor{ofi_info}; cursor->next != nullptr; cursor = cursor->next) {
        //     LOG(debug) << fi_tostr(cursor, FI_TYPE_INFO);
        // }
        //
    } else {
        LOG(debug) << "Ofi info already queried. Skipping.";
    }

    OpenOfiFabric();
    OpenOfiDomain();
}

auto Context::OpenOfiFabric() -> void
{
    if (!fOfiFabric) {
        auto ret = fi_fabric(fOfiInfo->fabric_attr, &fOfiFabric, NULL);
        if (ret != FI_SUCCESS)
            throw ContextError{tools::ToString("Failed opening ofi fabric, reason: ", fi_strerror(ret))};
    } else {
        // TODO Check, if requested fabric matches existing one.
        // TODO Decide, if we want to support more than one fabric simultaneously.
        LOG(debug) << "Ofi fabric already opened. Skipping.";
    }
}

auto Context::OpenOfiDomain() -> void
{
    if (!fOfiDomain) {
        auto ret = fi_domain(fOfiFabric, fOfiInfo, &fOfiDomain, NULL);
        if (ret != FI_SUCCESS)
            throw ContextError{tools::ToString("Failed opening ofi domain, reason: ", fi_strerror(ret))};
    } else {
        LOG(debug) << "Ofi domain already opened. Skipping.";
    }
}

auto Context::CreateOfiEndpoint() -> fid_ep*
{
    fid_ep* ep = nullptr;
    auto ret = fi_endpoint(fOfiDomain, fOfiInfo, &ep, nullptr);
    if (ret != FI_SUCCESS)
        throw ContextError{tools::ToString("Failed creating ofi endpoint, reason: ", fi_strerror(ret))};
    return ep;
}

auto Context::CreateOfiCompletionQueue() -> fid_cq*
{
    fid_cq* cq = nullptr;
    fi_cq_attr attr = {0, 0, FI_CQ_FORMAT_DATA, FI_WAIT_UNSPEC, 0, FI_CQ_COND_NONE, nullptr};
	// size_t               size;      [> # entries for CQ <]
	// uint64_t             flags;     [> operation flags <]
	// enum fi_cq_format    format;    [> completion format <]
	// enum fi_wait_obj     wait_obj;  [> requested wait object <]
	// int                  signaling_vector; [> interrupt affinity <]
	// enum fi_cq_wait_cond wait_cond; [> wait condition format <]
	// struct fid_wait     *wait_set;  [> optional wait set <]
    auto ret = fi_cq_open(fOfiDomain, &attr, &cq, nullptr);
    if (ret != FI_SUCCESS)
        throw ContextError{tools::ToString("Failed creating ofi completion queue, reason: ", fi_strerror(ret))};
    return cq;
}

} /* namespace ofi */
} /* namespace mq */
} /* namespace fair */