req.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_REQ_H__
#define __MOTR_DIX_REQ_H__

#include "fid/fid.h"           /* m0_fid */
#include "sm/sm.h"             /* m0_sm */
#include "pool/pool_machine.h" /* m0_poolmach_versions */
#include "dix/layout.h"        /* m0_dix_layout */
#include "dix/req_internal.h"  /* m0_dix_idxop_ctx */

/* Import */
struct m0_bufvec;
struct m0_dix_ldesc;
struct m0_dtx;
struct m0_dix_meta_req;
struct m0_dix_cli;
struct m0_cas_req;

enum m0_dix_req_state {
        DIXREQ_INVALID,
        DIXREQ_INIT,
        DIXREQ_LAYOUT_DISCOVERY,
        DIXREQ_LID_DISCOVERY,
        DIXREQ_DISCOVERY_DONE,
        DIXREQ_META_UPDATE,
        DIXREQ_INPROGRESS,
        DIXREQ_GET_RESEND,
        DIXREQ_DEL_PHASE2,
        DIXREQ_FINAL,
        DIXREQ_FAILURE,
        DIXREQ_NR
};

struct m0_dix {
        struct m0_fid        dd_fid;
        struct m0_dix_layout dd_layout;
};

struct m0_dix_next_sort_ctx {
        struct m0_cas_req        *sc_creq;
        struct m0_cas_next_reply *sc_reps;
        uint32_t                  sc_reps_nr;
        bool                      sc_stop;
        bool                      sc_done;
        uint32_t                  sc_pos;
};

struct m0_dix_next_sort_ctx_arr {
        struct m0_dix_next_sort_ctx *sca_ctx;
        uint32_t                     sca_nr;
};

struct m0_dix_next_results {
        struct m0_cas_next_reply  **drs_reps;
        uint32_t                    drs_nr;
        uint32_t                    drs_pos;
};

struct m0_dix_next_resultset {
        struct m0_dix_next_results      *nrs_res;
        uint32_t                         nrs_res_nr;
        struct m0_dix_next_sort_ctx_arr  nrs_sctx_arr;
};

enum dix_req_type {
        DIX_CREATE,
        DIX_CCTGS_LOOKUP,
        DIX_DELETE,
        DIX_NEXT,
        DIX_GET,
        DIX_PUT,
        DIX_DEL
} M0_XCA_ENUM;

struct m0_dix_req {
        struct m0_sm                  dr_sm;
        struct m0_dix_cli            *dr_cli;
        struct m0_dix_meta_req       *dr_meta_req;
        struct m0_clink               dr_clink;
        struct m0_dix                *dr_orig_indices;
        struct m0_dix                *dr_indices;
        uint32_t                      dr_indices_nr;
        bool                          dr_is_meta;
        struct m0_dix_item           *dr_items;
        uint64_t                      dr_items_nr;
        const struct m0_bufvec       *dr_keys;
        const struct m0_bufvec       *dr_vals;
        struct m0_dtx                *dr_dtx;
        struct m0_dix_idxop_ctx       dr_idxop;
        struct m0_dix_rop_ctx        *dr_rop;
        struct m0_sm_ast              dr_ast;
        enum dix_req_type             dr_type;
        struct m0_dix_next_resultset  dr_rs;
        uint32_t                     *dr_recs_nr;
        uint32_t                      dr_flags;

        void                         *dr_sync_datum;
};

struct m0_dix_get_reply {
        int           dgr_rc;
        struct m0_buf dgr_val;
};

struct m0_dix_next_reply {
        struct m0_buf dnr_key;
        struct m0_buf dnr_val;
};

M0_INTERNAL void m0_dix_req_init(struct m0_dix_req  *req,
                                 struct m0_dix_cli  *cli,
                                 struct m0_sm_group *grp);

M0_INTERNAL void m0_dix_mreq_init(struct m0_dix_req  *req,
                                  struct m0_dix_cli  *cli,
                                  struct m0_sm_group *grp);

M0_INTERNAL void m0_dix_req_lock(struct m0_dix_req *req);

M0_INTERNAL void m0_dix_req_unlock(struct m0_dix_req *req);

M0_INTERNAL bool m0_dix_req_is_locked(const struct m0_dix_req *req);

M0_INTERNAL int m0_dix_req_wait(struct m0_dix_req *req, uint64_t states,
                                m0_time_t to);

M0_INTERNAL int m0_dix_create(struct m0_dix_req   *req,
                              const struct m0_dix *indices,
                              uint32_t             indices_nr,
                              struct m0_dtx       *dtx,
                              uint32_t             flags);

M0_INTERNAL int m0_dix_cctgs_lookup(struct m0_dix_req   *req,
                                    const struct m0_dix *indices,
                                    uint32_t             indices_nr);

M0_INTERNAL int m0_dix_delete(struct m0_dix_req   *req,
                              const struct m0_dix *indices,
                              uint64_t             indices_nr,
                              struct m0_dtx       *dtx,
                              uint32_t             flags);

M0_INTERNAL int m0_dix_put(struct m0_dix_req      *req,
                           const struct m0_dix    *index,
                           const struct m0_bufvec *keys,
                           const struct m0_bufvec *vals,
                           struct m0_dtx          *dtx,
                           uint32_t                flags);

M0_INTERNAL int m0_dix_get(struct m0_dix_req      *req,
                           const struct m0_dix    *index,
                           const struct m0_bufvec *keys);

M0_INTERNAL void m0_dix_get_rep(const struct m0_dix_req *req,
                                uint64_t                 idx,
                                struct m0_dix_get_reply *rep);

M0_INTERNAL int m0_dix_del(struct m0_dix_req      *req,
                           const struct m0_dix    *index,
                           const struct m0_bufvec *keys,
                           struct m0_dtx          *dtx,
                           uint32_t                flags);

M0_INTERNAL int m0_dix_next(struct m0_dix_req      *req,
                            const struct m0_dix    *index,
                            const struct m0_bufvec *start_keys,
                            const uint32_t         *recs_nr,
                            uint32_t                flags);

M0_INTERNAL void m0_dix_next_rep(const struct m0_dix_req  *req,
                                 uint64_t                  key_idx,
                                 uint64_t                  val_idx,
                                 struct m0_dix_next_reply *rep);


M0_INTERNAL void m0_dix_req_cancel(struct m0_dix_req *req);

M0_INTERNAL uint32_t m0_dix_next_rep_nr(const struct m0_dix_req *req,
                                        uint64_t                 key_idx);

M0_INTERNAL void m0_dix_next_rep_mlock(struct m0_dix_req *req,
                                       uint32_t           key_idx,
                                       uint32_t           val_idx);

M0_INTERNAL int m0_dix_generic_rc(const struct m0_dix_req *req);

M0_INTERNAL int m0_dix_item_rc(const struct m0_dix_req *req,
                               uint64_t                 idx);

M0_INTERNAL int m0_dix_req_rc(const struct m0_dix_req *req);

M0_INTERNAL uint64_t m0_dix_req_nr(const struct m0_dix_req *req);

M0_INTERNAL void m0_dix_get_rep_mlock(struct m0_dix_req *req, uint64_t idx);

M0_INTERNAL void m0_dix_req_fini(struct m0_dix_req *req);

M0_INTERNAL void m0_dix_req_fini_lock(struct m0_dix_req *req);

M0_INTERNAL int m0_dix_desc_set(struct m0_dix             *dix,
                                const struct m0_dix_ldesc *desc);

M0_INTERNAL int m0_dix_copy(struct m0_dix *dst, const struct m0_dix *src);

M0_INTERNAL void m0_dix_fini(struct m0_dix *dix);

M0_INTERNAL int  m0_dix_sm_conf_init(void);
M0_INTERNAL void m0_dix_sm_conf_fini(void);

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