rpc_machine.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_MACHINE_H__
#define __MOTR_RPC_MACHINE_H__

#include "lib/bob.h"
#include "lib/tlist.h"
#include "lib/thread.h"
#include "lib/chan.h"
#include "sm/sm.h"     /* m0_sm_group */
#include "net/net.h"   /* m0_net_transfer_mc, m0_net_domain */

/* Imports */
struct m0_cob_domain;
struct m0_rpc_conn;
struct m0_rpc_session;
struct m0_reqh;
struct m0_dtm;

enum {
        M0_RPC_DEF_MAX_RPC_MSG_SIZE = 1 << 17,
};

struct m0_rpc_stats {
        /* Items */
        uint64_t rs_nr_rcvd_items;
        uint64_t rs_nr_sent_items;
        uint64_t rs_nr_failed_items;
        uint64_t rs_nr_dropped_items;
        uint64_t rs_nr_timedout_items;
        uint64_t rs_nr_sent_items_uniq;
        uint64_t rs_nr_resent_items;
        uint64_t rs_nr_resend_attempts;
        uint64_t rs_nr_ha_timedout_items;
        uint64_t rs_nr_ha_noted_conns;

        /* Packets */
        uint64_t rs_nr_rcvd_packets;
        uint64_t rs_nr_sent_packets;
        uint64_t rs_nr_failed_packets;

        /* Bytes */
        uint64_t rs_nr_sent_bytes;
        uint64_t rs_nr_rcvd_bytes;
};

struct m0_rpc_machine {
        struct m0_sm_group                rm_sm_grp;
        struct m0_tl                      rm_chans;
        struct m0_net_transfer_mc         rm_tm;
        struct m0_tl                      rm_incoming_conns;
        struct m0_tl                      rm_outgoing_conns;
        struct m0_rpc_stats               rm_stats;
        struct m0_reqh                   *rm_reqh;
        struct m0_dtm                    *rm_dtm;
        struct m0_tlink                   rm_rh_linkage;

        struct m0_tl                      rm_services;

        struct m0_tl                      rm_watch;

        struct m0_thread                  rm_worker;

        struct m0_reqh_service           *rm_service;
        bool                              rm_stopping;
        uint64_t                          rm_active_nb;
        struct m0_chan                    rm_nb_idle;
        uint64_t                          rm_magix;

        uint32_t                          rm_min_recv_size;

        struct m0_mutex_addb2             rm_lock_stats;

        m0_bcount_t                       rm_bulk_cutoff;
};

M0_INTERNAL int m0_rpc_machine_init(struct m0_rpc_machine *machine,
                                    struct m0_net_domain *net_dom,
                                    const char *ep_addr,
                                    struct m0_reqh *reqh,
                                    struct m0_net_buffer_pool *receive_pool,
                                    uint32_t colour,
                                    m0_bcount_t msg_size, uint32_t queue_len);

void m0_rpc_machine_fini(struct m0_rpc_machine *machine);

void m0_rpc_machine_get_stats(struct m0_rpc_machine *machine,
                              struct m0_rpc_stats *stats, bool reset);

M0_INTERNAL void
m0_rpc_machine_drain_item_sources(struct m0_rpc_machine *machine,
                                  uint32_t               max_per_source);

M0_INTERNAL const char *m0_rpc_machine_ep(const struct m0_rpc_machine *rmach);

M0_INTERNAL void m0_rpc_machine_lock(struct m0_rpc_machine *machine);
M0_INTERNAL void m0_rpc_machine_unlock(struct m0_rpc_machine *machine);
M0_INTERNAL bool
m0_rpc_machine_is_locked(const struct m0_rpc_machine *machine);
M0_INTERNAL bool
m0_rpc_machine_is_not_locked(const struct m0_rpc_machine *machine);

M0_BOB_DECLARE(extern, m0_rpc_machine);

struct m0_rpc_machine_watch {
        void                  *mw_datum;
        struct m0_rpc_machine *mw_mach;
        struct m0_tlink       mw_linkage;
        void (*mw_conn_added)(struct m0_rpc_machine_watch *w,
                              struct m0_rpc_conn *conn);
        void (*mw_session_added)(struct m0_rpc_machine_watch *w,
                                 struct m0_rpc_session *session);
        void (*mw_mach_terminated)(struct m0_rpc_machine_watch *w);

        uint64_t mw_magic;
};

void m0_rpc_machine_watch_attach(struct m0_rpc_machine_watch *watch);

void m0_rpc_machine_watch_detach(struct m0_rpc_machine_watch *watch);

#endif /* __MOTR_RPC_MACHINE_H__ */

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