ha.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2016-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_HA_HA_H__
#define __MOTR_HA_HA_H__

#include "lib/tlist.h"          /* m0_tl */
#include "lib/types.h"          /* uint64_t */
#include "lib/mutex.h"          /* m0_mutex */

#include "fid/fid.h"            /* m0_fid */
#include "module/module.h"      /* m0_module */
#include "ha/entrypoint.h"      /* m0_ha_entrypoint_client */
#include "ha/cookie.h"          /* m0_ha_cookie */

struct m0_uint128;
struct m0_rpc_machine;
struct m0_reqh;
struct m0_ha;
struct m0_ha_msg;
struct m0_ha_link;
struct m0_ha_entrypoint_req;

enum m0_ha_level {
        M0_HA_LEVEL_ASSIGNS,
        M0_HA_LEVEL_ADDR_STRDUP,
        M0_HA_LEVEL_LINK_SERVICE,
        M0_HA_LEVEL_ENTRYPOINT_SERVER_INIT,
        M0_HA_LEVEL_ENTRYPOINT_CLIENT_INIT,
        M0_HA_LEVEL_INIT,
        M0_HA_LEVEL_ENTRYPOINT_SERVER_START,
        M0_HA_LEVEL_INCOMING_LINKS,
        M0_HA_LEVEL_START,
        M0_HA_LEVEL_LINK_CTX_ALLOC,
        M0_HA_LEVEL_LINK_CTX_INIT,
        M0_HA_LEVEL_ENTRYPOINT_CLIENT_START,
        M0_HA_LEVEL_ENTRYPOINT_CLIENT_WAIT,
        M0_HA_LEVEL_LINK_ASSIGN,
        M0_HA_LEVEL_CONNECT,
};

struct m0_ha_ops {
        void (*hao_entrypoint_request)
                (struct m0_ha                      *ha,
                 const struct m0_ha_entrypoint_req *req,
                 const struct m0_uint128           *req_id);
        void (*hao_entrypoint_replied)(struct m0_ha                *ha,
                                       struct m0_ha_entrypoint_rep *rep);
        void (*hao_msg_received)(struct m0_ha      *ha,
                                 struct m0_ha_link *hl,
                                 struct m0_ha_msg  *msg,
                                 uint64_t           tag);
        void (*hao_msg_is_delivered)(struct m0_ha      *ha,
                                     struct m0_ha_link *hl,
                                     uint64_t           tag);
        void (*hao_msg_is_not_delivered)(struct m0_ha      *ha,
                                         struct m0_ha_link *hl,
                                         uint64_t           tag);
        void (*hao_link_connected)(struct m0_ha            *ha,
                                   const struct m0_uint128 *req_id,
                                   struct m0_ha_link       *hl);
        void (*hao_link_reused)(struct m0_ha            *ha,
                                const struct m0_uint128 *req_id,
                                struct m0_ha_link       *hl);
        void (*hao_link_absent)(struct m0_ha            *ha,
                                const struct m0_uint128 *req_id);
        void (*hao_link_is_disconnecting)(struct m0_ha      *ha,
                                          struct m0_ha_link *hl);
        void (*hao_link_disconnected)(struct m0_ha      *ha,
                                      struct m0_ha_link *hl);
        /* not implemented yet */
        void (*hao_error_no_memory)(struct m0_ha *ha, int unused);
};

struct m0_ha_cfg {
        struct m0_ha_ops                    hcf_ops;
        struct m0_rpc_machine              *hcf_rpc_machine;
        struct m0_reqh                     *hcf_reqh;
        const char                         *hcf_addr;
        struct m0_fid                       hcf_process_fid;

        /* m0_ha is resposible for the next fields */

        struct m0_ha_entrypoint_client_cfg  hcf_entrypoint_client_cfg;
        struct m0_ha_entrypoint_server_cfg  hcf_entrypoint_server_cfg;
};

struct ha_link_ctx;

struct m0_ha {
        struct m0_ha_cfg                h_cfg;
        struct m0_module                h_module;
        struct m0_mutex                 h_lock;
        struct m0_tl                    h_links_incoming;
        struct m0_tl                    h_links_outgoing;
        struct m0_tl                    h_links_stopping;
        struct m0_ha_link              *h_link;
        struct ha_link_ctx             *h_link_ctx;
        bool                            h_link_started;
        struct m0_reqh_service         *h_hl_service;
        struct m0_ha_entrypoint_client  h_entrypoint_client;
        struct m0_ha_entrypoint_server  h_entrypoint_server;
        struct m0_clink                 h_clink;
        uint64_t                        h_link_id_counter;
        uint64_t                        h_generation_counter;
        bool                            h_warn_local_link_disconnect;
        /*
         * A cookie that belongs to this m0_ha.
         * It's sent in the m0_ha_entrypoint_rep::hae_cookie_actual to every
         * m0_ha that requests entrypoint from this one.
         * It's compared with m0_ha_entrypoint_req::heq_cookie_expected to see
         * if the requester expects exactly this instance of m0_ha.
         */
        struct m0_ha_cookie             h_cookie_local;
        /*
         * The expected cookie of the remote end of m0_ha::h_link.
         * It's sent in m0_ha_entrypoint_req::heq_cookie_expected to tell about
         * the expectations.
         * It's compared with the cookie from the
         * m0_ha_entrypoint_rep::hae_cookie_actual to detect remote restart.
         */
        struct m0_ha_cookie             h_cookie_remote;
};

M0_INTERNAL int m0_ha_init(struct m0_ha *ha, struct m0_ha_cfg *ha_cfg);
M0_INTERNAL int m0_ha_start(struct m0_ha *ha);
M0_INTERNAL void m0_ha_stop(struct m0_ha *ha);
M0_INTERNAL void m0_ha_fini(struct m0_ha *ha);

M0_INTERNAL void
m0_ha_entrypoint_reply(struct m0_ha                       *ha,
                       const struct m0_uint128            *req_id,
                       const struct m0_ha_entrypoint_rep  *rep,
                       struct m0_ha_link                 **hl_ptr);

M0_INTERNAL struct m0_ha_link *m0_ha_connect(struct m0_ha *ha);
M0_INTERNAL void m0_ha_disconnect(struct m0_ha *ha);

M0_INTERNAL void m0_ha_disconnect_incoming(struct m0_ha      *ha,
                                           struct m0_ha_link *hl);

M0_INTERNAL void m0_ha_send(struct m0_ha           *ha,
                            struct m0_ha_link      *hl,
                            const struct m0_ha_msg *msg,
                            uint64_t               *tag);
M0_INTERNAL void m0_ha_delivered(struct m0_ha      *ha,
                                 struct m0_ha_link *hl,
                                 struct m0_ha_msg  *msg);

M0_INTERNAL void m0_ha_flush(struct m0_ha      *ha,
                             struct m0_ha_link *hl);

M0_INTERNAL void m0_ha_process_failed(struct m0_ha        *ha,
                                      const struct m0_fid *process_fid);

M0_INTERNAL struct m0_ha_link *m0_ha_outgoing_link(struct m0_ha *ha);
M0_INTERNAL struct m0_rpc_session *m0_ha_outgoing_session(struct m0_ha *ha);

M0_INTERNAL void m0_ha_rpc_endpoint(struct m0_ha      *ha,
                                    struct m0_ha_link *hl,
                                    char              *buf,
                                    m0_bcount_t        buf_len);

M0_INTERNAL int  m0_ha_mod_init(void);
M0_INTERNAL void m0_ha_mod_fini(void);

#endif /* __MOTR_HA_HA_H__ */

/*
 *  Local variables:
 *  c-indentation-style: "K&R"
 *  c-basic-offset: 8
 *  tab-width: 8
 *  fill-column: 80
 *  scroll-step: 1
 *  End:
 */
/*
 * vim: tabstop=8 shiftwidth=8 noexpandtab textwidth=80 nowrap
 */