helpers.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_CONF_HELPERS_H__
#define __MOTR_CONF_HELPERS_H__

#include "conf/obj.h"

struct m0_confc;
struct m0_rconfc;
struct m0_fid;
struct m0_reqh;

struct m0_confc_args {
        const char            *ca_profile;
        char                  *ca_confstr;
        struct m0_sm_group    *ca_group;
        struct m0_rpc_machine *ca_rmach;
};

M0_INTERNAL int m0_conf_device_cid_to_fid(struct m0_confc *confc, uint64_t cid,
                                          struct m0_fid *out);

M0_INTERNAL int m0_conf_pver_get(struct m0_confc      *confc,
                                 const struct m0_fid  *pool,
                                 struct m0_conf_pver **out);

/*
 * m0_conf_service_get() / m0_conf_sdev_get() / m0_conf_drive_get()
 * finds conf object by its fid and returns this object opened.
 *
 * Caller is responsible for m0_confc_close()ing the returned object.
 */
#define M0_CONF_OBJ_GETTERS \
        X(m0_conf_service); \
        X(m0_conf_sdev);    \
        X(m0_conf_drive)

#define X(type)                                          \
M0_INTERNAL int type ## _get(struct m0_confc     *confc, \
                             const struct m0_fid *fid,   \
                             struct type        **out)
M0_CONF_OBJ_GETTERS;
#undef X

M0_INTERNAL int m0_conf_full_load(struct m0_conf_root *r);

M0_INTERNAL int m0_confc_root_open(struct m0_confc      *confc,
                                   struct m0_conf_root **root);

M0_INTERNAL int m0_confc_profile_open(struct m0_confc         *confc,
                                      const struct m0_fid     *fid,
                                      struct m0_conf_profile **out);

M0_INTERNAL int m0_confc_service_find(struct m0_confc           *confc,
                                      enum m0_conf_service_type  stype,
                                      const char                *ep,
                                      struct m0_conf_obj       **result);

M0_INTERNAL struct m0_reqh *m0_conf_obj2reqh(const struct m0_conf_obj *obj);

M0_INTERNAL struct m0_reqh *m0_confc2reqh(const struct m0_confc *confc);

M0_INTERNAL bool m0_conf_obj_is_pool(const struct m0_conf_obj *obj);

M0_INTERNAL struct m0_conf_pver **m0_conf_pvers(const struct m0_conf_obj *obj);

/* XXX TODO: Move to motr/ha.c as a static function. */
M0_INTERNAL bool m0_conf_service_is_top_rms(const struct m0_conf_service *svc);

M0_INTERNAL bool m0_disk_is_of_type(const struct m0_conf_obj *obj,
                                    uint64_t                  svc_types);
M0_INTERNAL bool m0_is_cas_disk(const struct m0_conf_obj *obj);
M0_INTERNAL bool m0_is_ios_disk(const struct m0_conf_obj *obj);

M0_INTERNAL int m0_conf_devices_count(struct m0_confc *confc,
                                      uint64_t         svc_types,
                                      uint32_t        *nr_devices);

M0_INTERNAL void m0_confc_expired_cb(struct m0_rconfc *rconfc);
M0_INTERNAL void m0_confc_ready_cb(struct m0_rconfc *rconfc);

M0_INTERNAL bool m0_conf_service_ep_is_known(const struct m0_conf_obj *svc_obj,
                                             const char               *ep_addr);

M0_INTERNAL int m0_conf_process2service_get(struct m0_confc *confc,
                                            const struct m0_fid *process_fid,
                                            enum m0_conf_service_type stype,
                                            struct m0_fid *sfid);

/* --------------------------------- >8 --------------------------------- */

M0_INTERNAL int m0_conf_objs_ha_update(struct m0_ha_nvec *nvec);

M0_INTERNAL int m0_conf_obj_ha_update(const struct m0_fid *obj_fid);

M0_INTERNAL int m0_conf_confc_ha_update(struct m0_confc *confc);

M0_INTERNAL int m0_conf_confc_ha_update_async(struct m0_confc *confc,
                                              struct m0_ha_nvec *nvec,
                                              struct m0_chan *chan);

#endif /* __MOTR_CONF_HELPERS_H__ */