client.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_CAS_CLIENT_H__
#define __MOTR_CAS_CLIENT_H__

#include "lib/time.h" /* m0_time_t */
#include "lib/chan.h" /* m0_chan */
#include "fid/fid.h"  /* m0_fid */
#include "fop/fop.h"  /* m0_fop */
#include "cas/cas.h"  /* m0_cas_hint, m0_cas_id */

/* Imports */
struct m0_dtx;
struct m0_bufvec;
struct m0_rpc_session;

enum m0_cas_req_state {
        CASREQ_INVALID,
        CASREQ_INIT,
        CASREQ_SENT,
        CASREQ_FRAGM_SENT,
        CASREQ_ASSEMBLY,
        CASREQ_FINAL,
        CASREQ_FAILURE,
        CASREQ_NR
};

struct m0_cas_req {
        struct m0_sm            ccr_sm;

        /* Private fields. */

        struct m0_rpc_session  *ccr_sess;
        struct m0_fop          *ccr_fop;
        struct m0_fop           ccr_asmbl_fop;
        uint64_t                ccr_max_replies_nr;
        struct m0_cas_op       *ccr_req_op;
        struct m0_fop_type     *ccr_ftype;
        bool                    ccr_is_meta;
        struct m0_cas_rep       ccr_reply;
        struct m0_cas_recv      ccr_rec_orig;
        uint64_t                ccr_sent_recs_nr;
        struct m0_rpc_item     *ccr_reply_item;
        struct m0_sm_ast        ccr_replied_ast;
        struct m0_sm_ast        ccr_failure_ast;
        const struct m0_bufvec *ccr_keys;
        uint64_t               *ccr_asmbl_ikeys;
        /* Returned tx REMID inforation from service to update FSYNC records. */
        struct m0_be_tx_remid  ccr_remid;
};

struct m0_cas_rec_reply {
        int                crr_rc;
        struct m0_cas_hint crr_hint;
};

struct m0_cas_ilist_reply {
        int                clr_rc;
        struct m0_fid      clr_fid;
        struct m0_cas_hint clr_hint;
};

struct m0_cas_get_reply {
        int           cge_rc;
        struct m0_buf cge_val;
        struct m0_crv cge_ver;
};

struct m0_cas_next_reply {
        int                cnp_rc;
        struct m0_buf      cnp_key;
        struct m0_cas_hint cnp_hint;
        struct m0_buf      cnp_val;
        struct m0_crv      cnp_ver;
};

M0_INTERNAL void m0_cas_req_init(struct m0_cas_req     *req,
                                 struct m0_rpc_session *sess,
                                 struct m0_sm_group    *grp);

M0_INTERNAL void m0_cas_req_fini(struct m0_cas_req *req);

M0_INTERNAL void m0_cas_req_fini_lock(struct m0_cas_req *req);

M0_INTERNAL void m0_cas_req_lock(struct m0_cas_req *req);

M0_INTERNAL void m0_cas_req_unlock(struct m0_cas_req *req);

M0_INTERNAL bool m0_cas_req_is_locked(const struct m0_cas_req *req);

M0_INTERNAL int m0_cas_req_generic_rc(const struct m0_cas_req *req);

M0_INTERNAL uint64_t m0_cas_req_nr(const struct m0_cas_req *req);

M0_INTERNAL int m0_cas_req_wait(struct m0_cas_req *req, uint64_t states,
                                m0_time_t to);

M0_INTERNAL int m0_cas_index_create(struct m0_cas_req      *req,
                                    const struct m0_cas_id *cids,
                                    uint64_t                cids_nr,
                                    struct m0_dtx          *dtx);

M0_INTERNAL void m0_cas_index_create_rep(const struct m0_cas_req *req,
                                         uint64_t                 idx,
                                         struct m0_cas_rec_reply *rep);

M0_INTERNAL int m0_cas_index_delete(struct m0_cas_req      *req,
                                    const struct m0_cas_id *cids,
                                    uint64_t                cids_nr,
                                    struct m0_dtx          *dtx,
                                    uint32_t                flags);

M0_INTERNAL void m0_cas_index_delete_rep(const struct m0_cas_req *req,
                                         uint64_t                 idx,
                                         struct m0_cas_rec_reply *rep);

M0_INTERNAL int m0_cas_index_lookup(struct m0_cas_req      *req,
                                    const struct m0_cas_id *cids,
                                    uint64_t                cids_nr);

M0_INTERNAL void m0_cas_index_lookup_rep(const struct m0_cas_req *req,
                                         uint64_t                 idx,
                                         struct m0_cas_rec_reply *rep);

M0_INTERNAL int m0_cas_index_list(struct m0_cas_req   *req,
                                  const struct m0_fid *start_fid,
                                  uint32_t             indices_nr,
                                  uint32_t             flags);
M0_INTERNAL void m0_cas_index_list_rep(struct m0_cas_req         *req,
                                       uint32_t                   idx,
                                       struct m0_cas_ilist_reply *rep);

M0_INTERNAL int m0_cas_put(struct m0_cas_req      *req,
                           struct m0_cas_id       *index,
                           const struct m0_bufvec *keys,
                           const struct m0_bufvec *values,
                           struct m0_dtx          *dtx,
                           uint32_t                flags);

M0_INTERNAL void m0_cas_put_rep(struct m0_cas_req       *req,
                                uint64_t                 idx,
                                struct m0_cas_rec_reply *rep);

M0_INTERNAL void m0_cas_rep_mlock(const struct m0_cas_req *req,
                                  uint64_t                 idx);

M0_INTERNAL int m0_cas_get(struct m0_cas_req      *req,
                           struct m0_cas_id       *index,
                           const struct m0_bufvec *keys);

M0_INTERNAL int m0_cas_versioned_get(struct m0_cas_req      *req,
                                     struct m0_cas_id       *index,
                                     const struct m0_bufvec *keys);

M0_INTERNAL void m0_cas_get_rep(const struct m0_cas_req *req,
                                uint64_t                 idx,
                                struct m0_cas_get_reply *rep);

M0_INTERNAL int m0_cas_next(struct m0_cas_req *req,
                            struct m0_cas_id  *index,
                            struct m0_bufvec  *start_keys,
                            uint32_t          *recs_nr,
                            uint32_t           flags);

M0_INTERNAL void m0_cas_next_rep(const struct m0_cas_req  *req,
                                 uint32_t                  idx,
                                 struct m0_cas_next_reply *rep);

M0_INTERNAL int m0_cas_del(struct m0_cas_req *req,
                           struct m0_cas_id  *index,
                           struct m0_bufvec  *keys,
                           struct m0_dtx     *dtx,
                           uint32_t           flags);

M0_INTERNAL void m0_cas_del_rep(struct m0_cas_req       *req,
                                uint64_t                 idx,
                                struct m0_cas_rec_reply *rep);

M0_INTERNAL int  m0_cas_sm_conf_init(void);
M0_INTERNAL void m0_cas_sm_conf_fini(void);

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