session_fops.c

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.
 *
 */


#define M0_TRACE_SUBSYSTEM M0_TRACE_SUBSYS_RPC
#include "lib/trace.h"
#include "lib/errno.h"
#include "lib/memory.h"
#include "net/net.h"        /* m0_net_end_point_get */
#include "fop/fom.h"
#include "fop/fop.h"
#include "fop/fop_item_type.h"
#include "rpc/rpc_internal.h"

static struct m0_sm_state_descr m0_rpc_fom_sess_conn_term_phases[] = {
        [M0_RPC_CONN_SESS_TERMINATE_INIT] = {
                .sd_name      = "m0_rpc_fom_sess_conn_term_phases init",
                .sd_allowed   = M0_BITS(M0_RPC_CONN_SESS_TERMINATE_WAIT),
                .sd_flags     = M0_SDF_INITIAL
        },
        [M0_RPC_CONN_SESS_TERMINATE_WAIT] = {
                .sd_name      = "m0_rpc_fom_sess_conn_term_phases wait",
                .sd_allowed   = M0_BITS(M0_RPC_CONN_SESS_TERMINATE_WAIT,
                                        M0_RPC_CONN_SESS_TERMINATE_DONE),
        },
        [M0_RPC_CONN_SESS_TERMINATE_DONE] = {
                .sd_name      = "m0_rpc_fom_sess_conn_term_phases done",
                .sd_flags     = M0_SDF_TERMINAL
        }
};

M0_INTERNAL const struct m0_sm_conf m0_rpc_fom_sess_conn_term_phases_sm_conf = {
        .scf_name      = "rpc_fom_session_terminate fom",
        .scf_nr_states = ARRAY_SIZE(m0_rpc_fom_sess_conn_term_phases),
        .scf_state     = m0_rpc_fom_sess_conn_term_phases
};

static void conn_establish_fop_release(struct m0_ref *ref)
{
        struct m0_rpc_fop_conn_establish_ctx *ctx;
        struct m0_fop                        *fop;

        fop = container_of(ref, struct m0_fop, f_ref);
        ctx = container_of(fop, struct m0_rpc_fop_conn_establish_ctx, cec_fop);
        m0_fop_fini(fop);
        if (ctx->cec_sender_ep != NULL)
                /* For all conn-establish items a reference to sender_ep
                   is taken during m0_rpc_fop_conn_establish_ctx_init()
                 */
                m0_net_end_point_put(ctx->cec_sender_ep);
        m0_free(ctx);
}

static int conn_establish_item_decode(const struct m0_rpc_item_type *item_type,
                                      struct m0_rpc_item           **item,
                                      struct m0_bufvec_cursor       *cur)
{
        struct m0_rpc_fop_conn_establish_ctx *ctx;
        struct m0_fop                        *fop;
        int                                   rc;

        M0_ENTRY("item_opcode: %u", item_type->rit_opcode);
        M0_PRE(item_type != NULL && item != NULL && cur != NULL);
        M0_PRE(item_type->rit_opcode == M0_RPC_CONN_ESTABLISH_OPCODE);

        *item = NULL;

        M0_ALLOC_PTR(ctx);
        if (ctx == NULL)
                return M0_ERR(-ENOMEM);

        ctx->cec_sender_ep = NULL;
        fop = &ctx->cec_fop;

        m0_fop_init(fop, &m0_rpc_fop_conn_establish_fopt, NULL,
                    conn_establish_fop_release);

        rc = m0_fop_item_encdec(&fop->f_item, cur, M0_XCODE_DECODE);
        *item = &fop->f_item;

        return M0_RC(rc);
}

static struct m0_rpc_item_type_ops conn_establish_item_type_ops = {
        M0_FOP_DEFAULT_ITEM_TYPE_OPS,
        .rito_decode       = conn_establish_item_decode,
};

struct m0_fop_type m0_rpc_fop_conn_establish_fopt;
struct m0_fop_type m0_rpc_fop_conn_establish_rep_fopt;
struct m0_fop_type m0_rpc_fop_conn_terminate_fopt;
struct m0_fop_type m0_rpc_fop_conn_terminate_rep_fopt;
struct m0_fop_type m0_rpc_fop_session_establish_fopt;
struct m0_fop_type m0_rpc_fop_session_establish_rep_fopt;
struct m0_fop_type m0_rpc_fop_session_terminate_fopt;
struct m0_fop_type m0_rpc_fop_session_terminate_rep_fopt;

M0_INTERNAL void m0_rpc_session_fop_fini(void)
{
        m0_fop_type_fini(&m0_rpc_fop_session_terminate_rep_fopt);
        m0_fop_type_fini(&m0_rpc_fop_session_establish_rep_fopt);
        m0_fop_type_fini(&m0_rpc_fop_conn_terminate_rep_fopt);
        m0_fop_type_fini(&m0_rpc_fop_conn_establish_rep_fopt);
        m0_fop_type_fini(&m0_rpc_fop_session_terminate_fopt);
        m0_fop_type_fini(&m0_rpc_fop_session_establish_fopt);
        m0_fop_type_fini(&m0_rpc_fop_conn_terminate_fopt);
        m0_fop_type_fini(&m0_rpc_fop_conn_establish_fopt);
}

extern struct m0_fom_type_ops m0_rpc_fom_conn_establish_type_ops;
extern struct m0_fom_type_ops m0_rpc_fom_session_establish_type_ops;
extern struct m0_fom_type_ops m0_rpc_fom_conn_terminate_type_ops;
extern struct m0_fom_type_ops m0_rpc_fom_session_terminate_type_ops;
extern struct m0_reqh_service_type m0_rpc_service_type;

M0_INTERNAL int m0_rpc_session_fop_init(void)
{
        M0_FOP_TYPE_INIT(&m0_rpc_fop_conn_establish_fopt,
                         .name      = "Rpc conn establish",
                         .opcode    = M0_RPC_CONN_ESTABLISH_OPCODE,
                         .xt        = m0_rpc_fop_conn_establish_xc,
                         .rpc_flags = M0_RPC_MUTABO_REQ,
                         .rpc_ops   = &conn_establish_item_type_ops,
                         .fom_ops   = &m0_rpc_fom_conn_establish_type_ops,
                         .sm        = &m0_generic_conf,
                         .svc_type  = &m0_rpc_service_type);
        M0_FOP_TYPE_INIT(&m0_rpc_fop_conn_terminate_fopt,
                         .name      = "Rpc conn terminate",
                         .opcode    = M0_RPC_CONN_TERMINATE_OPCODE,
                         .xt        = m0_rpc_fop_conn_terminate_xc,
                         .rpc_flags = M0_RPC_MUTABO_REQ,
                         .fom_ops   = &m0_rpc_fom_conn_terminate_type_ops,
                         .sm        = &m0_rpc_fom_sess_conn_term_phases_sm_conf,
                         .svc_type  = &m0_rpc_service_type);
        M0_FOP_TYPE_INIT(&m0_rpc_fop_session_establish_fopt,
                         .name      = "Rpc session establish",
                         .opcode    = M0_RPC_SESSION_ESTABLISH_OPCODE,
                         .xt        = m0_rpc_fop_session_establish_xc,
                         .rpc_flags = M0_RPC_MUTABO_REQ,
                         .fom_ops   = &m0_rpc_fom_session_establish_type_ops,
                         .sm        = &m0_generic_conf,
                         .svc_type  = &m0_rpc_service_type);
        M0_FOP_TYPE_INIT(&m0_rpc_fop_session_terminate_fopt,
                         .name      = "Rpc session terminate",
                         .opcode    = M0_RPC_SESSION_TERMINATE_OPCODE,
                         .xt        = m0_rpc_fop_session_terminate_xc,
                         .rpc_flags = M0_RPC_MUTABO_REQ,
                         .fom_ops   = &m0_rpc_fom_session_terminate_type_ops,
                         .sm        = &m0_rpc_fom_sess_conn_term_phases_sm_conf,
                         .svc_type  = &m0_rpc_service_type);
        M0_FOP_TYPE_INIT(&m0_rpc_fop_conn_establish_rep_fopt,
                         .name      = "Rpc conn establish reply",
                         .opcode    = M0_RPC_CONN_ESTABLISH_REP_OPCODE,
                         .xt        = m0_rpc_fop_conn_establish_rep_xc,
                         .rpc_flags = M0_RPC_ITEM_TYPE_REPLY,
                         .svc_type  = &m0_rpc_service_type);
        M0_FOP_TYPE_INIT(&m0_rpc_fop_conn_terminate_rep_fopt,
                         .name      = "Rpc conn terminate reply",
                         .opcode    = M0_RPC_CONN_TERMINATE_REP_OPCODE,
                         .xt        = m0_rpc_fop_conn_terminate_rep_xc,
                         .rpc_flags = M0_RPC_ITEM_TYPE_REPLY,
                         .svc_type  = &m0_rpc_service_type);
        M0_FOP_TYPE_INIT(&m0_rpc_fop_session_establish_rep_fopt,
                         .name      = "Rpc session establish reply",
                         .opcode    = M0_RPC_SESSION_ESTABLISH_REP_OPCODE,
                         .xt        = m0_rpc_fop_session_establish_rep_xc,
                         .rpc_flags = M0_RPC_ITEM_TYPE_REPLY,
                         .svc_type  = &m0_rpc_service_type);
        M0_FOP_TYPE_INIT(&m0_rpc_fop_session_terminate_rep_fopt,
                         .name      = "Rpc session terminate reply",
                         .opcode    = M0_RPC_SESSION_TERMINATE_REP_OPCODE,
                         .xt        = m0_rpc_fop_session_terminate_rep_xc,
                         .rpc_flags = M0_RPC_ITEM_TYPE_REPLY,
                         .svc_type  = &m0_rpc_service_type);
        return 0;
}

M0_INTERNAL void m0_rpc_fop_conn_establish_ctx_init(struct m0_rpc_item *item,
                                                    struct m0_net_end_point *ep)
{
        struct m0_rpc_fop_conn_establish_ctx *ctx;

        M0_ENTRY("item: %p, ep_addr: %s", item, (char *)ep->nep_addr);
        M0_PRE(item != NULL && ep != NULL);

        ctx = container_of(item, struct m0_rpc_fop_conn_establish_ctx,
                                cec_fop.f_item);
        /* This reference will be dropped when the item is getting freed i.e.
           conn_establish_fop_release()
         */
        m0_net_end_point_get(ep);
        ctx->cec_sender_ep = ep;
        M0_LEAVE();
}

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