reqh.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2013-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_REQH_REQH_H__
#define __MOTR_REQH_REQH_H__

#include "lib/tlist.h"
#include "lib/lockers.h"
#include "lib/bob.h"

#include "conf/confc.h"
#include "conf/rconfc.h"     /* m0_rconfc */
#include "sm/sm.h"
#include "fop/fom.h"
#include "layout/layout.h"
#include "ha/epoch.h"
#include "rpc/session.h"

enum {
        DEFAULT_ADDB2_RECORD_SIZE = 128ULL << 20,
        MIN_ADDB2_RECORD_SIZE = 10ULL << 20,
        MAX_ADDB2_RECORD_SIZE = 10ULL << 30,
        DEFAULT_CLIENT_ADDB2_RECORD_SIZE = 128ULL << 20,
};

struct m0_fop;
struct m0_rpc_machine;
struct m0_addb2_storage;
struct m0_confc_args;

M0_LOCKERS_DECLARE(M0_EXTERN, m0_reqh, 256);

enum m0_reqh_states {
        M0_REQH_ST_INIT,
        M0_REQH_ST_NORMAL,
        M0_REQH_ST_DRAIN,
        M0_REQH_ST_SVCS_STOP,
        M0_REQH_ST_STOPPED,
        M0_REQH_ST_NR
};

struct m0_reqh {
        uint64_t                      rh_magic;

        struct m0_sm                  rh_sm;

        struct m0_sm_group            rh_sm_grp;

        struct m0_dtm                *rh_dtm;

        struct m0_be_seg             *rh_beseg;

        struct m0_mdstore            *rh_mdstore;

        /* Initialized pools */
        struct m0_pools_common       *rh_pools;

        struct m0_fol                 rh_fol;
        struct m0_tl                  rh_services;
        struct m0_tl                  rh_rpc_machines;
        struct m0_reqh_service       *rh_rpc_service;

        struct m0_rwlock              rh_rwlock;

        struct m0_addb2_storage      *rh_addb2_stor;
        struct m0_semaphore           rh_addb2_stor_idle;
        struct m0_addb2_net          *rh_addb2_net;
        struct m0_semaphore           rh_addb2_net_idle;

        struct m0_layout_domain       rh_ldom;

        struct m0_ha_domain           rh_hadom;

        struct m0_reqh_lockers        rh_lockers;

        struct m0_rconfc              rh_rconfc;

        bool                          rh_oostore;

        struct m0_reqh_service_ctx   *rh_ha_rsctx;

        struct m0_fid                 rh_fid;

        struct m0_mutex               rh_guard;

        struct m0_mutex               rh_guard_async;

        struct m0_chan                rh_conf_cache_exp;

        struct m0_chan                rh_conf_cache_ready;

        struct m0_chan                rh_conf_cache_ready_async;

        struct m0_sm_ast              rh_conf_cache_ast;
};

struct m0_reqh_init_args {
        struct m0_dtm           *rhia_dtm;
        struct m0_be_seg        *rhia_db;
        struct m0_mdstore       *rhia_mdstore;
        struct m0_pools_common  *rhia_pc;
        const struct m0_fid     *rhia_fid; /* fid of m0_conf_process */
};

M0_INTERNAL int m0_reqh_init(struct m0_reqh *reqh,
                             const struct m0_reqh_init_args *args);

M0_INTERNAL bool m0_reqh_invariant(const struct m0_reqh *reqh);

#define M0_REQH_INIT(reqh, ...)                                 \
        m0_reqh_init((reqh), &(const struct m0_reqh_init_args) { \
                     __VA_ARGS__ })

M0_INTERNAL void m0_reqh_fini(struct m0_reqh *reqh);

M0_INTERNAL int m0_reqh_be_init(struct m0_reqh *reqh,
                                struct m0_be_seg *seg);

M0_INTERNAL void m0_reqh_be_fini(struct m0_reqh *reqh);

M0_INTERNAL void m0_reqh_layouts_cleanup(struct m0_reqh *reqh);

M0_INTERNAL int m0_reqh_addb2_init(struct m0_reqh *reqh, const char *location,
                                   uint64_t key, bool mkfs, bool force,
                                   m0_bcount_t size);
M0_INTERNAL void m0_reqh_addb2_fini(struct m0_reqh *reqh);

M0_INTERNAL int m0_reqh_addb2_submit(struct m0_reqh *reqh,
                                     struct m0_addb2_trace_obj *tobj);

M0_INTERNAL int m0_reqh_state_get(struct m0_reqh *reqh);

M0_INTERNAL int m0_reqh_fop_allow(struct m0_reqh *reqh, struct m0_fop *fop);

M0_INTERNAL int m0_reqh_fop_handle(struct m0_reqh *reqh, struct m0_fop *fop);

M0_INTERNAL void m0_reqh_idle_wait(struct m0_reqh *reqh);

M0_INTERNAL void m0_reqh_idle_wait_for(struct m0_reqh *reqh,
                                       struct m0_reqh_service *service);

M0_INTERNAL void m0_reqh_start(struct m0_reqh *reqh);

M0_INTERNAL int m0_reqh_services_state_count(struct m0_reqh *reqh, int state);

M0_INTERNAL void m0_reqh_services_prepare_to_stop(struct m0_reqh *reqh,
                                                  unsigned        level);

M0_INTERNAL void m0_reqh_shutdown(struct m0_reqh *reqh);

M0_INTERNAL void m0_reqh_shutdown_wait(struct m0_reqh *reqh);

M0_INTERNAL void m0_reqh_services_terminate(struct m0_reqh *reqh);
M0_INTERNAL void m0_reqh_pre_storage_fini_svcs_stop(struct m0_reqh *reqh);
M0_INTERNAL void m0_reqh_post_storage_fini_svcs_stop(struct m0_reqh *reqh);

M0_INTERNAL int m0_reqhs_init(void);

M0_INTERNAL void m0_reqhs_fini(void);

M0_INTERNAL uint64_t m0_reqh_nr_localities(const struct m0_reqh *reqh);

M0_INTERNAL int m0_reqh_conf_setup(struct m0_reqh *reqh,
                                   struct m0_confc_args *args);

M0_TL_DESCR_DECLARE(m0_reqh_svc, M0_EXTERN);
M0_TL_DECLARE(m0_reqh_svc, M0_INTERNAL, struct m0_reqh_service);
M0_BOB_DECLARE(M0_EXTERN, m0_reqh_service);

M0_TL_DESCR_DECLARE(m0_reqh_rpc_mach, extern);
M0_TL_DECLARE(m0_reqh_rpc_mach, , struct m0_rpc_machine);

M0_INTERNAL int m0_reqh_mdpool_layout_build(struct m0_reqh *reqh);
M0_INTERNAL struct m0_rpc_session *
m0_reqh_mdpool_service_index_to_session(const struct m0_reqh *reqh,
                                        const struct m0_fid *gfid,
                                        uint32_t index);

M0_INTERNAL struct m0_confc *m0_reqh2confc(struct m0_reqh *reqh);
M0_INTERNAL struct m0_fid *m0_reqh2profile(struct m0_reqh *reqh);

/* __MOTR_REQH_REQH_H__ */
#endif

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