obj.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_CONF_OBJ_H__
#define __MOTR_CONF_OBJ_H__

#include "conf/schema.h"    /* m0_conf_service_type */
#include "ha/note.h"        /* m0_ha_obj_state */
#include "layout/pdclust.h" /* m0_pdclust_attr */
#include "lib/protocol.h"   /* m0_protocol_id */
#include "lib/bob.h"
#include "fid/fid.h"          /* m0_fid */
#include "conf/schema.h"      /* m0_conf_service_type */
#include "fdmi/filter.h"      /* m0_fdmi_filter */
#include "fdmi/fdmi.h"        /* m0_fdmi_rec_type_id */

struct m0_conf_obj_ops;
struct m0_confx_obj;
struct m0_xcode_type;


enum m0_conf_status {
        M0_CS_MISSING, 
        M0_CS_LOADING, 
        M0_CS_READY    
};

struct m0_conf_obj {
        struct m0_fid                 co_id;

        enum m0_conf_status           co_status;

        const struct m0_conf_obj_ops *co_ops;

        struct m0_conf_obj           *co_parent;

        uint64_t                      co_nrefs;

        struct m0_chan                co_chan;

        enum m0_ha_obj_state          co_ha_state;

        struct m0_chan                co_ha_chan;

        struct m0_conf_cache         *co_cache;

        struct m0_tlink               co_cache_link;

        struct m0_tlink               co_dir_link;

        uint64_t                      co_gen_magic;

        uint64_t                      co_con_magic;

        bool                          co_deleted;

        const char                   *co_name;

        /*
         * XXX TODO: Introduce .co_extra_attrs field --- optional array
         * of {name, value} pairs of strings.
         *
         * Fixed set of conf objects' attributes is expensive to change.
         * To add new attribute to a conf object type, one has to modify:
         * - conf/obj.h and conf.onwire.h data structures,
         * - conf/objs/ *.c files,
         * - Spiel,
         * - m0confgen utility,
         * - Halon code.
         *
         * m0_conf_obj::co_extra_attrs will let us experiment with new
         * sets of attributes without code changes. This may prove useful
         * for testing, debugging, and maintenance.
         */
};

struct m0_conf_obj_type {
        const struct m0_fid_type    cot_ftype;
        struct m0_conf_obj       *(*cot_create)(void);
        uint64_t                    cot_magic;
        struct m0_xcode_type      **cot_xt;
        const char                 *cot_branch;
        void                      (*cot_xc_init)(void);
};

void m0_conf_obj_type_register(const struct m0_conf_obj_type *otype);
void m0_conf_obj_type_unregister(const struct m0_conf_obj_type *otype);

const struct m0_conf_obj_type *m0_conf_obj_type(const struct m0_conf_obj *obj);
const struct m0_conf_obj_type *m0_conf_fid_type(const struct m0_fid *id);
const struct m0_fid           *m0_conf_objx_fid(const struct m0_confx_obj *obj);
const struct m0_conf_obj_type *
m0_conf_objx_type(const struct m0_confx_obj *obj);

bool m0_conf_fid_is_valid(const struct m0_fid *fid);

M0_INTERNAL bool m0_conf_obj_is_stub(const struct m0_conf_obj *obj);

struct m0_conf_obj *m0_conf_obj_grandparent(const struct m0_conf_obj *obj);

enum { M0_CONF_OBJ_TYPE_MAX = 256 };

/* ------------------------------------------------------------------
 * Concrete configuration objects
 * ------------------------------------------------------------------ */

struct m0_conf_dir {
        struct m0_conf_obj             cd_obj;
        struct m0_tl                   cd_items;
        const struct m0_conf_obj_type *cd_item_type;
        struct m0_fid                  cd_relfid;
};

struct m0_conf_root {
        struct m0_conf_obj    rt_obj;
        struct m0_conf_dir   *rt_nodes;
        struct m0_conf_dir   *rt_sites;
        struct m0_conf_dir   *rt_pools;
        struct m0_conf_dir   *rt_profiles;
        struct m0_conf_dir   *rt_fdmi_flt_grps;
/* configuration data (for the application) */
        uint64_t              rt_verno;
        struct m0_fid         rt_rootfid;
        struct m0_fid         rt_mdpool;  // XXX-MULTIPOOLS: DELETEME
        struct m0_fid         rt_imeta_pver;
        uint32_t              rt_mdredundancy;
        const char          **rt_params;
        struct m0_protocol_id rt_protocol;
};

struct m0_conf_profile {
        struct m0_conf_obj cp_obj;
/* configuration data (for the application) */
        struct m0_fid_arr  cp_pools; 
};

struct m0_conf_pool {
        struct m0_conf_obj  pl_obj;
        struct m0_conf_dir *pl_pvers;
/* configuration data (for the application) */
        uint32_t            pl_pver_policy;
};

enum {
        M0_CONF_PVER_LVL_SITES = 0,
        M0_CONF_PVER_LVL_RACKS,
        M0_CONF_PVER_LVL_ENCLS,
        M0_CONF_PVER_LVL_CTRLS,
        M0_CONF_PVER_LVL_DRIVES,
        M0_CONF_PVER_HEIGHT
};

struct m0_conf_pver_subtree {
        uint32_t               pvs_recd[M0_CONF_PVER_HEIGHT];
        struct m0_conf_dir    *pvs_sitevs;
/* configuration data (for the application) */
        struct m0_pdclust_attr pvs_attr;
        uint32_t               pvs_tolerance[M0_CONF_PVER_HEIGHT];
};

struct m0_conf_pver_formulaic {
        uint32_t      pvf_id;
        struct m0_fid pvf_base;
        uint32_t      pvf_allowance[M0_CONF_PVER_HEIGHT];
};

enum m0_conf_pver_kind {
        M0_CONF_PVER_ACTUAL,
        M0_CONF_PVER_FORMULAIC,
        /*
         * Virtual pvers exist in local conf cache only, they are not
         * mentioned in the conf database.
         *
         * Virtual pvers are not linked to the conf DAG.
         */
        M0_CONF_PVER_VIRTUAL
};

struct m0_conf_pver {
        struct m0_conf_obj     pv_obj;
/* configuration data (for the application) */
        enum m0_conf_pver_kind pv_kind;
        union {
                struct m0_conf_pver_subtree   subtree;
                struct m0_conf_pver_formulaic formulaic;
        } pv_u;
};

struct m0_conf_objv {
        struct m0_conf_obj  cv_obj;
        struct m0_conf_dir *cv_children;
        int                 cv_ix;
/* configuration data (for the application) */
        struct m0_conf_obj *cv_real;
};

struct m0_conf_node {
        struct m0_conf_obj   cn_obj;
        struct m0_conf_dir  *cn_processes;
/* configuration data (for the application) */
        uint32_t             cn_memsize;
        uint32_t             cn_nr_cpu;
        uint64_t             cn_last_state;
        uint64_t             cn_flags;
};

struct m0_conf_process {
        struct m0_conf_obj  pc_obj;
        struct m0_conf_dir *pc_services;
/* configuration data (for the application) */
        struct m0_bitmap    pc_cores; 
        uint64_t            pc_memlimit_as;
        uint64_t            pc_memlimit_rss;
        uint64_t            pc_memlimit_stack;
        uint64_t            pc_memlimit_memlock;
        const char         *pc_endpoint;
};

struct m0_conf_service {
        struct m0_conf_obj        cs_obj;
        struct m0_conf_dir       *cs_sdevs;
/* configuration data (for the application) */
        enum m0_conf_service_type cs_type;
        const char              **cs_endpoints;
        const char              **cs_params;
};

struct m0_conf_sdev {
        struct m0_conf_obj   sd_obj;
/* configuration data (for the application) */
        struct m0_fid        sd_drive;
        uint32_t             sd_dev_idx;
        uint32_t             sd_iface;
        uint32_t             sd_media;
        uint32_t             sd_bsize;
        uint64_t             sd_size;
        uint64_t             sd_last_state;
        uint64_t             sd_flags;
        const char          *sd_filename;
};

struct m0_conf_site {
        struct m0_conf_obj    ct_obj;
        struct m0_conf_dir   *ct_racks;
/* configuration data (for the application) */
        struct m0_conf_pver **ct_pvers;
};

struct m0_conf_rack {
        struct m0_conf_obj    cr_obj;
        struct m0_conf_dir   *cr_encls;
/* configuration data (for the application) */
        struct m0_conf_pver **cr_pvers;
};

struct m0_conf_enclosure {
        struct m0_conf_obj    ce_obj;
        struct m0_conf_node  *ce_node;
        struct m0_conf_dir   *ce_ctrls;
/* configuration data (for the application) */
        struct m0_conf_pver **ce_pvers;
};

struct m0_conf_controller {
        struct m0_conf_obj    cc_obj;
        struct m0_conf_dir   *cc_drives;
/* configuration data (for the application) */
        struct m0_conf_pver **cc_pvers;
};

struct m0_conf_drive {
        struct m0_conf_obj    ck_obj;
/* configuration data (for the application) */
        struct m0_conf_sdev  *ck_sdev;
        struct m0_conf_pver **ck_pvers;
};

struct m0_conf_fdmi_flt_grp {
        struct m0_conf_obj        ffg_obj;
        /* Type of the record that filters of this group support. */
        enum m0_fdmi_rec_type_id  ffg_rec_type;
        /* Directory of filters for this filters group. */
        struct m0_conf_dir       *ffg_filters;
};

struct m0_conf_fdmi_filter {
        struct m0_conf_obj            ff_obj;
        enum m0_fdmi_filter_type_id   ff_type;
        struct m0_fid                 ff_filter_id;
        struct m0_fdmi_filter         ff_filter;
        struct m0_conf_node          *ff_node;
        struct m0_conf_pver          *ff_dix_pver;
        const char                   **ff_substrings;
        const char                  **ff_endpoints;
        struct m0_tlink               ff_linkage;
        uint64_t                      ff_magic;
};

/* ------------------------------------------------------------------
 * Cast
 * ------------------------------------------------------------------ */

#define M0_CONF_CAST(ptr, type) \
        bob_of(ptr, struct type, type ## _cast_field, &type ## _bob)

#define m0_conf_dir_cast_field        cd_obj
#define m0_conf_root_cast_field       rt_obj
#define m0_conf_profile_cast_field    cp_obj
#define m0_conf_pool_cast_field       pl_obj
#define m0_conf_pver_cast_field       pv_obj
#define m0_conf_objv_cast_field       cv_obj
#define m0_conf_node_cast_field       cn_obj
#define m0_conf_process_cast_field    pc_obj
#define m0_conf_service_cast_field    cs_obj
#define m0_conf_sdev_cast_field       sd_obj
#define m0_conf_site_cast_field       ct_obj
#define m0_conf_rack_cast_field       cr_obj
#define m0_conf_enclosure_cast_field  ce_obj
#define m0_conf_controller_cast_field cc_obj
#define m0_conf_drive_cast_field      ck_obj
#define m0_conf_fdmi_filter_cast_field  ff_obj
#define m0_conf_fdmi_flt_grp_cast_field ffg_obj

#define M0_CONF_OBJ_TYPES                       \
        X_CONF(root,         ROOT,         't') \
        X_CONF(dir,          DIR,          'D') \
        X_CONF(profile,      PROFILE,      'p') \
        X_CONF(pool,         POOL,         'o') \
        X_CONF(pver,         PVER,         'v') \
        X_CONF(objv,         OBJV,         'j') \
        X_CONF(node,         NODE,         'n') \
        X_CONF(process,      PROCESS,      'r') \
        X_CONF(service,      SERVICE,      's') \
        X_CONF(sdev,         SDEV,         'd') \
        X_CONF(site,         SITE,         'S') \
        X_CONF(rack,         RACK,         'a') \
        X_CONF(enclosure,    ENCLOSURE,    'e') \
        X_CONF(controller,   CONTROLLER,   'c') \
        X_CONF(drive,        DRIVE,        'k') \
        X_CONF(fdmi_flt_grp, FDMI_FLT_GRP, 'g') \
        X_CONF(fdmi_filter,  FDMI_FILTER,  'l')

#define X_CONF(name, NAME, _)                                   \
extern const struct m0_bob_type m0_conf_ ## name ## _bob;       \
extern const struct m0_conf_obj_type M0_CONF_ ## NAME ## _TYPE;

M0_CONF_OBJ_TYPES
#undef X_CONF

/*
 * Relation fids. They represent parent-child relations between
 * conf objects.
 */
#define M0_CONF_REL_FIDS               \
        X_CONF(ANY,                -1) \
                                       \
        X_CONF(ROOT_NODES,          1) \
        X_CONF(ROOT_SITES,          2) \
        X_CONF(ROOT_POOLS,          3) \
        X_CONF(ROOT_PROFILES,       4) \
        X_CONF(ROOT_FDMI_FLT_GRPS,  5) \
        X_CONF(FDMI_FGRP_FILTERS,   6) \
                                       \
        X_CONF(POOL_PVERS,          7) \
        X_CONF(PVER_SITEVS,         8) \
        X_CONF(SITEV_RACKVS,        9) \
        X_CONF(RACKV_ENCLVS,       10) \
        X_CONF(ENCLV_CTRLVS,       11) \
        X_CONF(CTRLV_DRIVEVS,      12) \
                                       \
        X_CONF(NODE_PROCESSES,     13) \
        X_CONF(PROCESS_SERVICES,   14) \
        X_CONF(SERVICE_SDEVS,      15) \
                                       \
        X_CONF(SITE_RACKS,         16) \
        X_CONF(RACK_ENCLS,         17) \
        X_CONF(ENCLOSURE_CTRLS,    18) \
        X_CONF(CONTROLLER_DRIVES,  19)

#define X_CONF(name, _) \
extern const struct m0_fid M0_CONF_ ## name ## _FID;

M0_CONF_REL_FIDS
#undef X_CONF
extern const struct m0_fid_type M0_CONF_RELFID_TYPE;

extern const struct m0_fid M0_CONF_ROOT_FID;

M0_INTERNAL const struct m0_conf_obj_type *
m0_conf_obj_type_next(const struct m0_conf_obj_type *otype);

M0_INTERNAL int m0_conf_obj_init(void);
M0_INTERNAL void m0_conf_obj_fini(void);

M0_INTERNAL void m0_conf_child_adopt(struct m0_conf_obj *parent,
                                     struct m0_conf_obj *child);

#endif /* __MOTR_CONF_OBJ_H__ */