mem_xprt_pvt.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_BULK_MEM_XPRT_PVT_H__
#define __MOTR_NET_BULK_MEM_XPRT_PVT_H__

#include "lib/errno.h"
#include "net/net_internal.h"
#include "net/bulk_emulation/mem_xprt.h"

enum {
        M0_NET_BULK_MEM_MAX_SEGMENT_SIZE    = (1 << 18),
        M0_NET_BULK_MEM_MAX_BUFFER_SEGMENTS = 16,
        M0_NET_BULK_MEM_MAX_BUFFER_SIZE     = (1 << 22),
};

struct mem_desc {
        struct sockaddr_in     md_passive;
        enum m0_net_queue_type md_qt;
        m0_bcount_t            md_len;
        int64_t                md_buf_id;
};

/* forward references to other static functions */
static bool mem_dom_invariant(const struct m0_net_domain *dom);
static bool mem_ep_invariant(const struct m0_net_end_point *ep);
static bool mem_buffer_invariant(const struct m0_net_buffer *nb);
static bool mem_tm_invariant(const struct m0_net_transfer_mc *tm);
static int mem_ep_create(struct m0_net_end_point  **epp,
                         struct m0_net_transfer_mc *tm,
                         const struct sockaddr_in  *sa,
                         uint32_t id);
static bool mem_eps_are_equal(const struct m0_net_end_point *ep1,
                              const struct m0_net_end_point *ep2);
static bool mem_ep_equals_addr(const struct m0_net_end_point *ep,
                               const struct sockaddr_in *sa);
static int mem_desc_create(struct m0_net_buf_desc *desc,
                           struct m0_net_transfer_mc *tm,
                           enum m0_net_queue_type qt,
                           m0_bcount_t buflen,
                           int64_t buf_id);
static int mem_desc_decode(struct m0_net_buf_desc *desc,
                           struct mem_desc **p_md);
static bool mem_desc_equal(struct m0_net_buf_desc *d1,
                           struct m0_net_buf_desc *d2);
static m0_bcount_t mem_buffer_length(const struct m0_net_buffer *nb);
static bool mem_buffer_in_bounds(const struct m0_net_buffer *nb);
static int mem_copy_buffer(struct m0_net_buffer *dest_nb,
                           struct m0_net_buffer *src_nb,
                           m0_bcount_t num_bytes);
static void mem_wi_add(struct m0_net_bulk_mem_work_item *wi,
                       struct m0_net_bulk_mem_tm_pvt *tp);
static void mem_post_error(struct m0_net_transfer_mc *tm, int status);
static void mem_wi_post_buffer_event(struct m0_net_bulk_mem_work_item *wi);

static inline int mem_bmo_ep_create(struct m0_net_end_point  **epp,
                                    struct m0_net_transfer_mc *tm,
                                    const struct sockaddr_in  *sa,
                                    uint32_t id)
{
        struct m0_net_bulk_mem_domain_pvt *dp = tm->ntm_dom->nd_xprt_private;
        return dp->xd_ops->bmo_ep_create(epp, tm, sa, id);
}

static inline bool mem_bmo_buffer_in_bounds(const struct m0_net_buffer *nb)
{
        struct m0_net_bulk_mem_domain_pvt *dp = nb->nb_dom->nd_xprt_private;
        return dp->xd_ops->bmo_buffer_in_bounds(nb);
}

static int mem_bmo_desc_create(struct m0_net_buf_desc *desc,
                               struct m0_net_transfer_mc *tm,
                               enum m0_net_queue_type qt,
                               m0_bcount_t buflen,
                               int64_t buf_id)
{
        struct m0_net_bulk_mem_domain_pvt *dp = tm->ntm_dom->nd_xprt_private;
        return dp->xd_ops->bmo_desc_create(desc, tm, qt, buflen, buf_id);
}

#endif /* __MOTR_NET_BULK_MEM_XPRT_PVT_H__ */

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