instance.h

Go to the documentation of this file.

/*
 * Copyright (c) 2014-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_MODULE_INSTANCE_H__
#define __MOTR_MODULE_INSTANCE_H__

#include "module/module.h"         /* m0_module */
#include "lib/bitmap.h"            /* m0_bitmap */
#include "lib/lockers.h"           /* M0_LOCKERS__DECLARE */
#include "stob/module.h"           /* m0_stob_module */
#include "fdmi/module.h"           /* m0_fdmi_module */
#include "ioservice/storage_dev.h" /* m0_storage_devs */
#include "ut/stob.h"               /* m0_ut_stob_module */
#include "motr/process_attr.h"     /* m0_proc_attr */

struct m0_be_domain;

enum m0_module_id {
        M0_MODULE_NET,
        M0_MODULE_UT,
        M0_MODULE_ADDB2,
        M0_MODULE_LOCALITY,
        M0_MODULE_HA,
        M0_MODULE_PROCESSOR,
        M0_MODULE_POOL,
        M0_MODULE_ISC,
        /* XXX ... more to come ... */
        M0_MODULE_NR
};

/* XXX TODO: s/inst/instance/ */
M0_LOCKERS__DECLARE(M0_INTERNAL, m0_inst, m0, 16);

struct m0_ha;
struct m0_ha_module;
struct m0_ha_note_handler;

struct m0 {
        uint64_t                   i_dep_gen;
        struct m0_module           i_self;
        /* *
         * Module-specific data (e.g. addresses) of standard modules.
         *
         * @see m0_module_id
         */
        void                      *i_moddata[M0_MODULE_NR];
        struct m0_inst_lockers     i_lockers;
        struct m0_tl               i_param_sources;

        struct m0_ha_module       *i_ha_module;
        struct m0_ha              *i_ha;
        /* * Link to the HA. It's used in Motr code. */
        struct m0_ha_link         *i_ha_link;
        struct m0_ha_note_handler *i_note_handler;
        struct m0_ha_fvec_handler *i_fvec_handler;

        /*
         * XXX TODO: Get rid of the fields below. Use ->i_moddata[] or
         * ->i_lockers.
         */
        struct m0_fdmi_module      i_fdmi_module;
        struct m0_stob_module      i_stob_module;
        struct m0_stob_ad_module   i_stob_ad_module;
        struct m0_ut_stob_module   i_ut_stob_module;
        struct m0_poolmach_state  *i_pool_module;
        struct m0_storage_devs     i_storage_devs;
        bool                       i_storage_is_fake;
        bool                       i_reqh_uses_ad_stob;
        bool                       i_disable_addb2_storage;
        unsigned                   i_ios_cdom_key;
        unsigned                   i_mds_cdom_key;
        unsigned                   i_actrec_dom_key;
        unsigned                   i_dtm0_log_key;
        struct m0_proc_attr        i_proc_attr;
};

M0_INTERNAL struct m0 *m0_get(void);

M0_INTERNAL void m0_set(struct m0 *instance);

enum {
        M0_LEVEL_INST_PREPARE,
        M0_LEVEL_INST_QUIESCE_SYSTEM,
        M0_LEVEL_INST_ONCE,
        /*
         * XXX DELETEME after the removal of m0_init() function and
         * subsystem[] array in motr/init.c file.
         */
        M0_LEVEL_INST_SUBSYSTEMS,
        M0_LEVEL_INST_READY
};

/*
 *  m0
 * +------------------------------+
 * | M0_LEVEL_INST_READY          |
 * +------------------------------+
 * | M0_LEVEL_INST_SUBSYSTEMS     |
 * +------------------------------+
 * | M0_LEVEL_INST_ONCE           |
 * +------------------------------+
 * | M0_LEVEL_INST_QUIESCE_SYSTEM |
 * +------------------------------+
 * | M0_LEVEL_INST_PREPARE        |
 * +------------------------------+
 */
M0_INTERNAL void m0_instance_setup(struct m0 *instance);


#endif /* __MOTR_MODULE_INSTANCE_H__ */