lnet_core.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2012-2020 Seagate Technology LLC and/or its Affiliates
 *
 * 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.
 *
 * For any questions about this software or licensing,
 * please email opensource@seagate.com or cortx-questions@seagate.com.
 *
 */


#pragma once

#ifndef __MOTR_NET_LNET_CORE_H__
#define __MOTR_NET_LNET_CORE_H__

#include "net/lnet/lnet.h"
#include "net/lnet/lnet_core_types.h"

static int nlx_core_dom_init(struct m0_net_domain *dom,
                             struct nlx_core_domain *lcdom);

static void nlx_core_dom_fini(struct nlx_core_domain *lcdom);

static m0_bcount_t nlx_core_get_max_buffer_size(struct nlx_core_domain *lcdom);

static m0_bcount_t nlx_core_get_max_buffer_segment_size(
                                                struct nlx_core_domain *lcdom);

static int32_t nlx_core_get_max_buffer_segments(struct nlx_core_domain *lcdom);

static int nlx_core_buf_register(struct nlx_core_domain *lcdom,
                                 nlx_core_opaque_ptr_t buffer_id,
                                 const struct m0_bufvec *bvec,
                                 struct nlx_core_buffer *lcbuf);

static void nlx_core_buf_deregister(struct nlx_core_domain *lcdom,
                                    struct nlx_core_buffer *lcbuf);

static int nlx_core_buf_msg_recv(struct nlx_core_domain *lcdom,
                                 struct nlx_core_transfer_mc *lctm,
                                 struct nlx_core_buffer *lcbuf);

static int nlx_core_buf_msg_send(struct nlx_core_domain *lcdom,
                                 struct nlx_core_transfer_mc *lctm,
                                 struct nlx_core_buffer *lcbuf);

static int nlx_core_buf_active_recv(struct nlx_core_domain *lcdom,
                                    struct nlx_core_transfer_mc *lctm,
                                    struct nlx_core_buffer *lcbuf);

static int nlx_core_buf_active_send(struct nlx_core_domain *lcdom,
                                    struct nlx_core_transfer_mc *lctm,
                                    struct nlx_core_buffer *lcbuf);

static void nlx_core_buf_desc_encode(struct nlx_core_transfer_mc *lctm,
                                     struct nlx_core_buffer *lcbuf,
                                     struct nlx_core_buf_desc *cbd);

static int nlx_core_buf_desc_decode(struct nlx_core_transfer_mc *lctm,
                                    struct nlx_core_buffer *lcbuf,
                                    struct nlx_core_buf_desc *cbd);

static int nlx_core_buf_passive_recv(struct nlx_core_domain *lcdom,
                                     struct nlx_core_transfer_mc *lctm,
                                     struct nlx_core_buffer *lcbuf);

static int nlx_core_buf_passive_send(struct nlx_core_domain *lcdom,
                                     struct nlx_core_transfer_mc *lctm,
                                     struct nlx_core_buffer *lcbuf);

static int nlx_core_buf_del(struct nlx_core_domain *lcdom,
                            struct nlx_core_transfer_mc *lctm,
                            struct nlx_core_buffer *lcbuf);

static int nlx_core_buf_event_wait(struct nlx_core_domain *lcdom,
                                   struct nlx_core_transfer_mc *lctm,
                                   m0_time_t timeout);

static bool nlx_core_buf_event_get(struct nlx_core_transfer_mc *lctm,
                                   struct nlx_core_buffer_event *lcbe);

static int nlx_core_ep_addr_decode(struct nlx_core_domain *lcdom,
                                   const char *ep_addr,
                                   struct nlx_core_ep_addr *cepa);

static void nlx_core_ep_addr_encode(struct nlx_core_domain *lcdom,
                                    const struct nlx_core_ep_addr *cepa,
                                    char buf[M0_NET_LNET_XEP_ADDR_LEN]);

static int nlx_core_nidstrs_get(struct nlx_core_domain   *lcdom,
                                char                   ***nidary);

static void nlx_core_nidstrs_put(struct nlx_core_domain   *lcdom,
                                 char                   ***nidary);

static int nlx_core_tm_start(struct nlx_core_domain *lcdom,
                             struct m0_net_transfer_mc *tm,
                             struct nlx_core_transfer_mc *lctm);

static void nlx_core_tm_stop(struct nlx_core_domain *lcdom,
                             struct nlx_core_transfer_mc *lctm);

static inline bool nlx_core_ep_eq(const struct nlx_core_ep_addr *cep1,
                                  const struct nlx_core_ep_addr *cep2)
{
        return cep1->cepa_nid == cep2->cepa_nid &&
                cep1->cepa_pid == cep2->cepa_pid &&
                cep1->cepa_portal == cep2->cepa_portal &&
                cep1->cepa_tmid == cep2->cepa_tmid;
}

static int nlx_core_bevq_provision(struct nlx_core_domain *lcdom,
                                   struct nlx_core_transfer_mc *lctm,
                                   size_t need);

static void nlx_core_bevq_release(struct nlx_core_transfer_mc *lctm,
                                  size_t release);

static int nlx_core_new_blessed_bev(struct nlx_core_domain *lcdom,
                                    struct nlx_core_transfer_mc *lctm,
                                    struct nlx_core_buffer_event **bevp);

static void *nlx_core_mem_alloc(size_t size, unsigned shift);

static void nlx_core_mem_free(void *data, size_t size, unsigned shift);

static void nlx_core_dom_set_debug(struct nlx_core_domain *lcdom, unsigned dbg);
static void nlx_core_tm_set_debug(struct nlx_core_transfer_mc *lctm,
                                  unsigned dbg);

#define NLX_PO2_SHIFT(n)                                                \
        (((n) <= 8) ? 3 : ((n) <= 16) ? 4 : ((n) <= 32) ? 5 :           \
         ((n) <= 64) ? 6 : ((n) <= 128) ? 7 : ((n) <= 256) ? 8 :        \
         ((n) <= 512) ? 9 : ((n) / 0))
#define NLX_ALLOC_ALIGNED_PTR(ptr) \
        ((ptr) = nlx_core_mem_alloc(sizeof ((ptr)[0]),                  \
                                    NLX_PO2_SHIFT(sizeof ((ptr)[0]))))
#define NLX_FREE_ALIGNED_PTR(ptr) \
        nlx_core_mem_free((ptr), sizeof ((ptr)[0]), \
                          NLX_PO2_SHIFT(sizeof ((ptr)[0])))

#define NLX_ALLOC(ptr, len) ({ ptr = m0_alloc(len); })
#define NLX_ALLOC_PTR(ptr) M0_ALLOC_PTR(ptr)
#define NLX_ALLOC_ARR(ptr, nr) M0_ALLOC_ARR(ptr, nr)
 /* LNetCore */

#endif /* __MOTR_NET_LNET_CORE_H__ */

/*
 *  Local variables:
 *  c-indentation-style: "K&R"
 *  c-basic-offset: 8
 *  tab-width: 8
 *  fill-column: 79
 *  scroll-step: 1
 *  End:
 */