conn_internal.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_CONN_INT_H__
#define __MOTR_RPC_CONN_INT_H__

#include "rpc/conn.h"

/* Imports */
struct m0_rpc_session;
struct m0_rpc_item;
struct m0_rpc_item_source;

enum {
        SENDER_ID_INVALID = UINT64_MAX,
};

M0_INTERNAL bool m0_rpc_conn_invariant(const struct m0_rpc_conn *conn);
M0_INTERNAL int m0_rpc_conn_ha_timer_start(struct m0_rpc_conn *conn);
M0_INTERNAL void m0_rpc_conn_ha_timer_stop(struct m0_rpc_conn *conn);

struct m0_rpc_conn_ha_ops {
        void (*cho_ha_timer_cb)(struct m0_sm_timer *timer);
        void (*cho_ha_notify)(struct m0_rpc_conn *conn, uint8_t state);
};

struct m0_rpc_conn_ha_cfg {
        struct m0_rpc_conn_ha_ops rchc_ops;
        m0_time_t                 rchc_ha_interval;
};

static inline int conn_state(const struct m0_rpc_conn *conn)
{
        return conn->c_sm.sm_state;
}

static inline void conn_flag_set(struct m0_rpc_conn *conn, uint64_t flag)
{
        conn->c_flags |= flag;
}

static inline void conn_flag_unset(struct m0_rpc_conn *conn, uint64_t flag)
{
        conn->c_flags &= ~flag;
}

static inline bool conn_flag_is_set(const struct m0_rpc_conn *conn,
                                    uint64_t                  flag)
{
        return conn->c_flags & flag;
}

M0_INTERNAL void conn_state_set(struct m0_rpc_conn *conn, int state);

M0_INTERNAL struct m0_rpc_session *m0_rpc_session_search(const struct
                                                         m0_rpc_conn *conn,
                                                         uint64_t session_id);

M0_INTERNAL struct m0_rpc_session *m0_rpc_session_search_and_pop(
        const struct m0_rpc_conn *conn, uint64_t session_id);

M0_INTERNAL struct m0_rpc_session *m0_rpc_session_pop(
        const struct m0_rpc_conn *conn);

M0_INTERNAL struct m0_rpc_session *m0_rpc_conn_session0(const struct m0_rpc_conn
                                                        *conn);

M0_INTERNAL void m0_rpc_conn_fini_locked(struct m0_rpc_conn *conn);

M0_INTERNAL int m0_rpc_rcv_conn_init(struct m0_rpc_conn *conn,
                                     struct m0_net_end_point *ep,
                                     struct m0_rpc_machine *machine,
                                     const struct m0_uint128 *uuid);
M0_INTERNAL int m0_rpc_rcv_conn_terminate(struct m0_rpc_conn *conn);

M0_INTERNAL void m0_rpc_conn_establish_reply_received(struct m0_rpc_item *req);

M0_INTERNAL void m0_rpc_conn_terminate_reply_sent(struct m0_rpc_conn *conn);

M0_INTERNAL void m0_rpc_conn_terminate_reply_received(struct m0_rpc_item *req);

M0_INTERNAL bool m0_rpc_item_is_conn_establish(const struct m0_rpc_item *item);

M0_INTERNAL bool m0_rpc_item_is_sess_establish(const struct m0_rpc_item *item);

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

M0_INTERNAL bool m0_rpc_conn_is_snd(const struct m0_rpc_conn *conn);

M0_INTERNAL bool m0_rpc_conn_is_rcv(const struct m0_rpc_conn *conn);

M0_INTERNAL void m0_rpc_conn_add_session(struct m0_rpc_conn *conn,
                                         struct m0_rpc_session *session);
M0_INTERNAL void m0_rpc_conn_remove_session(struct m0_rpc_session *session);

M0_INTERNAL void m0_rpc_conn_cleanup_all_sessions(struct m0_rpc_conn *conn);

#endif /* __MOTR_RPC_CONN_INT_H__ */