glob.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016-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_GLOB_H__
#define __MOTR_CONF_GLOB_H__

#include "conf/cache.h"  /* M0_CONF_PATH_MAX */

enum {
        M0_CONF_GLOB_ERR = 1 << 0,
};

typedef int (*m0_conf_glob_errfunc_t)(int errcode,
                                      const struct m0_conf_obj *obj,
                                      const struct m0_fid *path);

struct m0_conf_glob {
        int                         cg_flags;

        m0_conf_glob_errfunc_t      cg_errfunc;

        int                         cg_errcode;
        const struct m0_conf_obj   *cg_errobj;
        const struct m0_fid        *cg_errpath;

        /* XXX TODO: Drop this field and use .cg_origin->co_cache. */
        const struct m0_conf_cache *cg_cache;

        const struct m0_conf_obj   *cg_origin;

        struct m0_fid               cg_path[M0_CONF_PATH_MAX + 1];

        const struct m0_conf_obj   *cg_trace[M0_CONF_PATH_MAX + 1];

        uint32_t                    cg_depth;

        bool                        cg_down_p;
#ifdef DEBUG

        bool                        cg_debug_print;
#endif
};

#define m0_conf_glob_init(glob, flags, errfunc, cache, origin, ...)       \
        m0_conf__glob_init((glob), (flags), (errfunc), (cache), (origin), \
                           (const struct m0_fid []){ __VA_ARGS__, M0_FID0 })
M0_INTERNAL void m0_conf__glob_init(struct m0_conf_glob *glob,
                                    int flags, m0_conf_glob_errfunc_t errfunc,
                                    const struct m0_conf_cache *cache,
                                    const struct m0_conf_obj *origin,
                                    const struct m0_fid *path);

M0_INTERNAL int m0_conf_glob(struct m0_conf_glob *glob,
                             uint32_t nr, const struct m0_conf_obj **objv);

M0_INTERNAL char *m0_conf_glob_error(const struct m0_conf_glob *glob,
                                     char *buf, size_t buflen);

#endif /* __MOTR_CONF_GLOB_H__ */