module.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * 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_MODULE_H__
#define __MOTR_MODULE_MODULE_H__

struct m0_module;

enum {
        M0_MODLEV_NONE = -1,
        M0_MODLEV_MAX  = 64,
        M0_MODDEP_MAX  = 128
};

struct m0_modlev {
        const char *ml_name;
        int       (*ml_enter)(struct m0_module *module);
        void      (*ml_leave)(struct m0_module *module);
};

struct m0_moddep {
        struct m0_module *md_other;
        int               md_src;
        int               md_dst;
};

#define M0_MODDEP_INIT(other, src, dst) \
        { .md_other = (other), .md_src = (src), .md_dst = (dst) }

struct m0_module {
        const char             *m_name;
        struct m0              *m_m0;
        int                     m_cur;
        const struct m0_modlev *m_level;
        int                     m_level_nr;
        unsigned                m_level_nrefs[M0_MODLEV_MAX];
        struct m0_moddep        m_dep[M0_MODDEP_MAX];
        unsigned                m_dep_nr;
        struct m0_moddep        m_inv[M0_MODDEP_MAX];
        unsigned                m_inv_nr;
};

struct m0_module_type {
        const char         *mt_name;
        struct m0_module *(*mt_create)(struct m0 *instance);
};

M0_INTERNAL int m0_module_init(struct m0_module *module, int level);

M0_INTERNAL void m0_module_fini(struct m0_module *module, int level);

M0_INTERNAL void m0_module_dep_add(struct m0_module *m0, int l0,
                                   struct m0_module *m1, int l1);

M0_INTERNAL void m0_module_setup(struct m0_module *module, const char *name,
                                 const struct m0_modlev *level, int level_nr,
                                 struct m0 *instance);

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