session.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_RPC_SESSION_H__
#define __MOTR_RPC_SESSION_H__

#include "rpc/item.h"

#include "lib/list.h"
#include "lib/tlist.h"
#include "lib/time.h"
#include "sm/sm.h"                /* m0_sm */
#include "rpc/onwire.h"

/* Imports */
struct m0_rpc_conn;

/* Exports */
struct m0_rpc_session;

enum m0_rpc_session_state {
        M0_RPC_SESSION_INITIALISED,
        M0_RPC_SESSION_ESTABLISHING,
        M0_RPC_SESSION_IDLE,
        M0_RPC_SESSION_BUSY,
        M0_RPC_SESSION_FAILED,
        M0_RPC_SESSION_TERMINATING,
        M0_RPC_SESSION_TERMINATED,
        M0_RPC_SESSION_FINALISED
};

M0_INTERNAL const char *
m0_rpc_session_state_to_str(enum m0_rpc_session_state state);

struct m0_rpc_session {
        uint64_t                  s_session_id;

        struct m0_rpc_conn       *s_conn;

        struct m0_tlink           s_link;

        uint32_t                  s_hold_cnt;

        struct m0_sm              s_sm;

        uint64_t                  s_magic;

        uint64_t                  s_xid;

        struct m0_tl              s_xid_list;

        struct m0_rpc_item_cache  s_reply_cache;

        struct m0_rpc_item_cache  s_req_cache;

        bool                      s_cancelled;

        struct m0_tl              s_pending_cache;
};

M0_INTERNAL int m0_rpc_session_init(struct m0_rpc_session *session,
                                    struct m0_rpc_conn *conn);

M0_INTERNAL void m0_rpc_session_reset(struct m0_rpc_session *session);

M0_INTERNAL int m0_rpc_session_establish(struct m0_rpc_session *session,
                                         m0_time_t abs_timeout);

M0_INTERNAL int m0_rpc_session_establish_sync(struct m0_rpc_session *session,
                                              m0_time_t abs_timeout);

M0_INTERNAL int m0_rpc_session_create(struct m0_rpc_session *session,
                                      struct m0_rpc_conn *conn,
                                      m0_time_t abs_timeout);

M0_INTERNAL int m0_rpc_session_terminate(struct m0_rpc_session *session,
                                         m0_time_t abs_timeout);

M0_INTERNAL int m0_rpc_session_terminate_sync(struct m0_rpc_session *session,
                                              m0_time_t abs_timeout);

M0_INTERNAL int m0_rpc_session_timedwait(struct m0_rpc_session *session,
                                         uint64_t states,
                                         const m0_time_t abs_timeout);

M0_INTERNAL int m0_rpc_session_validate(struct m0_rpc_session *session);

M0_INTERNAL void m0_rpc_session_fini(struct m0_rpc_session *session);

int m0_rpc_session_destroy(struct m0_rpc_session *session,
                           m0_time_t abs_timeout);

M0_INTERNAL void m0_rpc_session_cancel(struct m0_rpc_session *session);

M0_INTERNAL bool m0_rpc_session_is_cancelled(struct m0_rpc_session *session);

M0_INTERNAL void m0_rpc_session_quiesce(struct m0_rpc_session *session);

M0_INTERNAL m0_bcount_t
m0_rpc_session_get_max_item_size(const struct m0_rpc_session *session);

M0_INTERNAL m0_bcount_t
m0_rpc_session_get_max_item_payload_size(const struct m0_rpc_session *session);

M0_INTERNAL struct m0_rpc_machine *
session_machine(const struct m0_rpc_session *s);

M0_TL_DESCR_DECLARE(pending_item, M0_EXTERN);
M0_TL_DECLARE(pending_item, M0_INTERNAL, struct m0_rpc_item);

#endif

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