rconfc.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2015-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_CONF_RCONFC_H__
#define __MOTR_CONF_RCONFC_H__

#include "lib/mutex.h"
#include "lib/chan.h"
#include "lib/tlist.h"
#include "fop/fop.h"    /* m0_fop */
#include "sm/sm.h"
#include "conf/confc.h"
#include "ha/entrypoint_fops.h" /* m0_ha_entrypoint_rep */

struct m0_rconfc;
struct m0_rpc_machine;
struct m0_rpc_item;


enum m0_rconfc_state {
        M0_RCS_INIT,
        M0_RCS_ENTRYPOINT_WAIT,
        M0_RCS_ENTRYPOINT_CONSUME,
        M0_RCS_CREDITOR_SETUP,
        M0_RCS_GET_RLOCK,
        M0_RCS_VERSION_ELECT,
        M0_RCS_IDLE,
        M0_RCS_RLOCK_CONFLICT,
        M0_RCS_CONDUCTOR_DRAIN,
        M0_RCS_CONDUCTOR_DISCONNECT,
        M0_RCS_STOPPING,
        M0_RCS_FAILURE,
        M0_RCS_FINAL
};

struct rconfc_load_ctx {
        struct m0_sm_group rx_grp;
        struct rconfc_load_ast {
                bool             run;
                struct m0_thread thread;
        }                  rx_ast;
        int                rx_rc;
};

typedef void (*m0_rconfc_cb_t)(struct m0_rconfc *rconfc);

struct m0_rconfc {
        struct m0_confc           rc_confc;
        struct m0_sm              rc_sm;
        uint64_t                  rc_ver;
        uint32_t                  rc_quorum;

        /* Private part. Consumer is not welcomed to access the data below. */

        m0_rconfc_cb_t            rc_expired_cb;

        m0_rconfc_cb_t            rc_ready_cb;

        m0_rconfc_cb_t            rc_fatal_cb;

        struct m0_rpc_machine    *rc_rmach;
        struct m0_confc_gate_ops  rc_gops;
        struct m0_sm_ast          rc_ast;
        int                       rc_datum;
        struct m0_sm_ast          rc_stop_ast;
        struct m0_sm_ast          rc_cctx_fini_ast;
        struct m0_tl              rc_herd;
        struct m0_tl              rc_active;
        struct m0_clink           rc_unpinned_cl;
        struct m0_clink           rc_ha_entrypoint_cl;
        struct m0_clink           rc_herd_cl;
        struct m0_clink           rc_ha_update_cl;
        struct m0_ha_nvec         rc_nvec;

        void                     *rc_qctx;
        void                     *rc_rlock_ctx;
        bool                      rc_stopping;
        bool                      rc_rlock_conflict;
        struct m0_confc           rc_phony;
        char                     *rc_local_conf;
        struct m0_fid             rc_profile;
        struct rconfc_load_ctx    rc_rx;
        struct m0_sm_ast          rc_load_ast;
        struct m0_sm_ast          rc_load_fini_ast;
        struct m0_mutex           rc_herd_lock;
        struct m0_chan            rc_herd_chan;
        struct m0_clink           rc_conductor_clink;
        struct m0_ha_entrypoint_rep rc_ha_entrypoint_rep;
        uint32_t                    rc_ha_entrypoint_retries;
        uint32_t                    rc_sm_state_on_abort;
        bool                        rc_quorum_decision_is_made;
};

M0_INTERNAL int m0_rconfc_init(struct m0_rconfc      *rconfc,
                               const struct m0_fid   *profile,
                               struct m0_sm_group    *sm_group,
                               struct m0_rpc_machine *rmach,
                               m0_rconfc_cb_t         expired_cb,
                               m0_rconfc_cb_t         ready_cb);

M0_INTERNAL int m0_rconfc_start(struct m0_rconfc *rconfc);

M0_INTERNAL int m0_rconfc_start_wait(struct m0_rconfc *rconfc,
                                     uint64_t          timeout_ns);

static inline int m0_rconfc_start_sync(struct m0_rconfc *rconfc)
{
        return m0_rconfc_start_wait(rconfc, M0_TIME_NEVER);
}

M0_INTERNAL void m0_rconfc_stop(struct m0_rconfc *rconfc);

M0_INTERNAL void m0_rconfc_stop_sync(struct m0_rconfc *rconfc);

M0_INTERNAL void m0_rconfc_fini(struct m0_rconfc *rconfc);

M0_INTERNAL void m0_rconfc_lock(struct m0_rconfc *rconfc);
M0_INTERNAL void m0_rconfc_unlock(struct m0_rconfc *rconfc);

M0_INTERNAL uint64_t m0_rconfc_ver_max_read(struct m0_rconfc *rconfc);

M0_INTERNAL void m0_rconfc_fatal_cb_set(struct m0_rconfc *rconfc,
                                        m0_rconfc_cb_t    cb);

M0_INTERNAL int m0_rconfc_confd_endpoints(struct m0_rconfc   *rconfc,
                                          const char       ***eps);

M0_INTERNAL int m0_rconfc_rm_endpoint(struct m0_rconfc *rconfc, char **ep);

M0_INTERNAL void m0_rconfc_rm_fid(struct m0_rconfc *rconfc, struct m0_fid *out);

M0_INTERNAL bool m0_rconfc_is_preloaded(struct m0_rconfc *rconfc);

M0_INTERNAL bool m0_rconfc_reading_is_allowed(const struct m0_rconfc *rconfc);

#endif /* __MOTR_CONF_RCONFC_H__ */

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