rpclib.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_RPCLIB_H__
#define __MOTR_RPC_RPCLIB_H__

#ifndef __KERNEL__
#  include <stdio.h>          /* FILE */
#  include "motr/setup.h"     /* m0_motr */
#endif
#include "reqh/reqh.h"
#include "cob/cob.h"          /* m0_cob_domain */
#include "net/net.h"          /* m0_net_end_point */
#include "net/buffer_pool.h"
#include "rpc/rpc.h"

struct m0_fop;
struct m0_net_xprt;
struct m0_net_domain;

enum {
        M0_RPCLIB_MAX_RETRIES = 60,

        M0_RPCLIB_UTIL_CONN_TIMEOUT = 20, /* seconds */
};

#ifndef __KERNEL__

struct m0_reqh;
struct m0_reqh_service_type;

struct m0_rpc_server_ctx {
        struct m0_net_xprt          **rsx_xprts;
        int                           rsx_xprts_nr;

        char                        **rsx_argv;
        int                           rsx_argc;

        const char                   *rsx_log_file_name;

        struct m0_motr                rsx_motr_ctx;

        FILE                         *rsx_log_file;
};

int m0_rpc_server_start(struct m0_rpc_server_ctx *sctx);

void m0_rpc_server_stop(struct m0_rpc_server_ctx *sctx);

M0_INTERNAL struct m0_rpc_machine *
m0_rpc_server_ctx_get_rmachine(struct m0_rpc_server_ctx *sctx);

#endif /* !__KERNEL__ */

struct m0_rpc_client_ctx {
        /*
         * Input parameters.
         *
         * They are initialised and filled by a caller of m0_rpc_client_start().
         */

        struct m0_net_domain      *rcx_net_dom;

        const char                *rcx_local_addr;

        const char                *rcx_remote_addr;

        uint64_t                   rcx_max_rpcs_in_flight;

        /* -------------------------------------------------------------
         * Output parameters.
         *
         * They are initialised and filled by m0_rpc_client_start().
         */

        struct m0_reqh             rcx_reqh;
        struct m0_rpc_machine      rcx_rpc_machine;
        struct m0_rpc_conn         rcx_connection;
        struct m0_rpc_session      rcx_session;

        struct m0_net_buffer_pool  rcx_buffer_pool;

        uint32_t                   rcx_recv_queue_min_length;

        uint32_t                   rcx_max_rpc_msg_size;

        m0_time_t                  rcx_abs_timeout;
        struct m0_fid             *rcx_fid;
};

M0_INTERNAL int m0_rpc_client_connect(struct m0_rpc_conn    *conn,
                                      struct m0_rpc_session *session,
                                      struct m0_rpc_machine *rpc_mach,
                                      const char            *remote_addr,
                                      struct m0_fid         *svc_fid,
                                      uint64_t               max_rpcs_in_flight,
                                      m0_time_t              abs_timeout);

M0_INTERNAL int
m0_rpc_client_find_connect(struct m0_rpc_conn       *conn,
                           struct m0_rpc_session    *session,
                           struct m0_rpc_machine    *rpc_mach,
                           const char               *remote_addr,
                           enum m0_conf_service_type stype,
                           uint64_t                  max_rpcs_in_flight,
                           m0_time_t                 abs_timeout);

int m0_rpc_client_start(struct m0_rpc_client_ctx *cctx);

int m0_rpc_client_stop(struct m0_rpc_client_ctx *cctx);

int m0_rpc_client_stop_stats(struct m0_rpc_client_ctx *cctx,
                             void (*printout)(struct m0_rpc_machine *));

int m0_rpc_post_sync(struct m0_fop                *fop,
                     struct m0_rpc_session        *session,
                     const struct m0_rpc_item_ops *ri_ops,
                     m0_time_t                     deadline);

int m0_rpc_post_with_timeout_sync(struct m0_fop                *fop,
                                  struct m0_rpc_session        *session,
                                  const struct m0_rpc_item_ops *ri_ops,
                                  m0_time_t                     deadline,
                                  m0_time_t                     timeout);

#endif /* __MOTR_RPC_RPCLIB_H__ */