iter.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * 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_DIX_CM_ITER_H__
#define __MOTR_DIX_CM_ITER_H__

#include "fop/fom.h"       /* m0_fom */
#include "lib/buf.h"       /* m0_buf */
#include "fid/fid.h"       /* m0_fid */
#include "sm/sm.h"         /* m0_sm_ast */
#include "dix/layout.h"    /* m0_dix_ldesc */
#include "cas/ctg_store.h" /* m0_ctg_op */

/* Import */
struct m0_dix_cm_type;
struct m0_reqh;

struct m0_dix_cm_iter {
        struct m0_fom              di_fom;

        struct m0_fid              di_cctg_fid;

        struct m0_fid              di_prev_cctg_fid;

        bool                       di_meta_modified;

        struct m0_clink            di_meta_clink;

        struct m0_cas_ctg         *di_cctg;

        uint64_t                   di_cctg_processed_recs_nr;

        uint64_t                   di_processed_recs_nr;

        struct m0_dix_ldesc        di_ldesc;

        struct m0_buf              di_key;

        struct m0_buf              di_val;

        struct m0_buf              di_prev_key;

        struct m0_ctg_op           di_ctidx_op;

        struct m0_ctg_op           di_ctg_op;

        struct m0_ctg_op           di_ctg_del_op;

        int                        di_ctg_del_op_rc;

        struct m0_long_lock_link   di_lock_link;

        struct m0_long_lock_link   di_meta_lock_link;

        struct m0_long_lock_link   di_del_lock_link;

        struct m0_long_lock_addb2  di_lock_addb2;

        struct m0_long_lock_addb2  di_meta_lock_addb2;

        struct m0_long_lock_addb2  di_del_lock_addb2;

        struct m0_sm_ast           di_ast;

        bool                       di_stop;

        struct m0_chan             di_completed;

        struct m0_mutex            di_ch_guard;

        uint64_t                  *di_tgts;

        uint64_t                   di_tgts_cur;

        uint64_t                   di_tgts_nr;

        m0_bcount_t                di_cutoff;
};

M0_INTERNAL void m0_dix_cm_iter_type_register(struct m0_dix_cm_type *dcmt);

M0_INTERNAL int m0_dix_cm_iter_start(struct m0_dix_cm_iter *iter,
                                     struct m0_dix_cm_type *dcmt,
                                     struct m0_reqh        *reqh,
                                     m0_bcount_t            rpc_cutoff);

M0_INTERNAL void m0_dix_cm_iter_next(struct m0_dix_cm_iter *iter);

M0_INTERNAL int m0_dix_cm_iter_get(struct m0_dix_cm_iter *iter,
                                   struct m0_buf         *key,
                                   struct m0_buf         *val,
                                   uint32_t              *sdev_id);

M0_INTERNAL void m0_dix_cm_iter_stop(struct m0_dix_cm_iter *iter);

M0_INTERNAL
void m0_dix_cm_iter_cur_pos(struct m0_dix_cm_iter *iter,
                            struct m0_fid         *cctg_fid,
                            uint64_t              *cctg_proc_recs_nr);

M0_INTERNAL
void m0_dix_cm_iter_processed_num(struct m0_dix_cm_iter *iter,
                                  uint64_t              *proc_recs_nr);

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