client.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_DIX_CLIENT_H__
#define __MOTR_DIX_CLIENT_H__

#include "lib/chan.h"   /* m0_clink */
#include "sm/sm.h"      /* m0_sm */
#include "dix/layout.h" /* m0_dix_ldesc */
#include "dix/meta.h"   /* m0_dix_meta_req */

/* Import */
struct m0_pools_common;
struct m0_layout_domain;
struct m0_rpc_session;
struct m0_be_tx_remid;
struct m0_dix_req;
struct m0_pool_version;
struct m0_fid;
struct m0_dtm0_service;

enum m0_dix_cli_state {
        DIXCLI_INVALID,
        DIXCLI_INIT,
        DIXCLI_BOOTSTRAP,
        DIXCLI_STARTING,
        DIXCLI_READY,
        DIXCLI_FINAL,
        DIXCLI_FAILURE,
};

struct m0_dix_cli {
        struct m0_sm             dx_sm;
        struct m0_clink          dx_clink;
        struct m0_dix_meta_req   dx_mreq;
        struct m0_pools_common  *dx_pc;
        struct m0_layout_domain *dx_ldom;
        struct m0_pool_version  *dx_pver;
        struct m0_sm_ast         dx_ast;
        struct m0_dix_ldesc      dx_root;
        struct m0_dix_ldesc      dx_layout;
        struct m0_dix_ldesc      dx_ldescr;
        struct m0_dtm0_service  *dx_dtms;

        void  (*dx_sync_rec_update)(struct m0_dix_req *,
                                    struct m0_rpc_session *,
                                    struct m0_be_tx_remid *);
};

M0_INTERNAL int m0_dix_cli_init(struct m0_dix_cli       *cli,
                                struct m0_sm_group      *sm_group,
                                struct m0_pools_common  *pc,
                                struct m0_layout_domain *ldom,
                                const struct m0_fid     *pver);

M0_INTERNAL void m0_dix_cli_lock(struct m0_dix_cli *cli);

M0_INTERNAL bool m0_dix_cli_is_locked(const struct m0_dix_cli *cli);

M0_INTERNAL void m0_dix_cli_unlock(struct m0_dix_cli *cli);

M0_INTERNAL void m0_dix_cli_start(struct m0_dix_cli *cli);

M0_INTERNAL int  m0_dix_cli_start_sync(struct m0_dix_cli *cli);

M0_INTERNAL void m0_dix_cli_bootstrap(struct m0_dix_cli *cli);

M0_INTERNAL void m0_dix_cli_bootstrap_lock(struct m0_dix_cli *cli);

M0_INTERNAL void m0_dix_cli_stop(struct m0_dix_cli *cli);

M0_INTERNAL void m0_dix_cli_stop_lock(struct m0_dix_cli *cli);

M0_INTERNAL void m0_dix_cli_fini(struct m0_dix_cli *cli);

M0_INTERNAL void m0_dix_cli_fini_lock(struct m0_dix_cli *cli);

#endif /* __MOTR_DIX_CLIENT_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
 */