diter.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2015-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_DITER_H__
#define __MOTR_CONF_DITER_H__

#include "conf/confc.h"


enum m0_diter_lvl_mode {
        M0_DLM_DIR,
        M0_DLM_ENTRY,
        M0_DLM_NR
};

struct m0_conf_diter_lvl_ctx {
        struct m0_confc_ctx  lc_ctx;
        struct m0_conf_obj  *lc_result;
};

struct m0_conf_diter_lvl {
        struct m0_conf_diter         *dl_di;
        struct m0_fid                 dl_rel_fid;
        struct m0_conf_diter_lvl_ctx  dl_cctx[M0_DLM_NR];
        /* See m0_diter_lvl_mode for values. */
        enum m0_diter_lvl_mode        dl_mode;
        uint32_t                      dl_lvl;
        uint32_t                      dl_nr_open;
        uint32_t                      dl_nr_read;
};

struct m0_conf_diter {
        struct m0_confc          *di_confc;
        struct m0_conf_obj       *di_origin;
        struct m0_conf_diter_lvl *di_lvls;
        uint32_t                  di_phase;
        struct m0_clink           di_clink;
        struct m0_chan            di_wait;
        struct m0_mutex           di_wait_mutex;
        /* Total number of configuration directory levels to iterate. */
        uint32_t                  di_nr_lvls;
        uint32_t                  di_lvl;
        bool                      di_locked;
};

#define m0_conf_diter_init(iter, confc, origin, ...)          \
        m0_conf__diter_init(iter, confc, origin,              \
                            M0_COUNT_PARAMS(__VA_ARGS__) + 1, \
                            (const struct m0_fid []){         \
                            __VA_ARGS__, M0_FID0 })

M0_INTERNAL int m0_conf__diter_init(struct m0_conf_diter *it,
                                    struct m0_confc *confc,
                                    struct m0_conf_obj *origin,
                                    uint32_t nr_lvls,
                                    const struct m0_fid *path);
M0_INTERNAL void m0_conf_diter_fini(struct m0_conf_diter *it);

M0_INTERNAL void m0_conf_diter_locked_set(struct m0_conf_diter *it,
                                          bool locked);

M0_INTERNAL int
m0_conf_diter_next(struct m0_conf_diter *it,
                   bool (*filter)(const struct m0_conf_obj *obj));

M0_INTERNAL int
m0_conf_diter_next_sync(struct m0_conf_diter *it,
                        bool (*filter)(const struct m0_conf_obj *obj));

M0_INTERNAL void m0_conf_diter_wait_arm(struct m0_conf_diter *it,
                                        struct m0_clink *clink);

M0_INTERNAL struct m0_conf_obj *m0_conf_diter_result(const struct m0_conf_diter *it);

M0_INTERNAL void m0_conf_diter_lvl_init(struct m0_conf_diter_lvl *l,
                                        struct m0_conf_diter *it,
                                        struct m0_confc *confc, uint32_t lvl,
                                        const struct m0_fid *path);

M0_INTERNAL void m0_conf_diter_lvl_fini(struct m0_conf_diter_lvl *l);

#endif /* __MOTR_CONF_DITER_H__ */