meta.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_META_H__
#define __MOTR_DIX_META_H__

#include "lib/types.h"
#include "lib/chan.h"
#include "lib/vec.h"
#include "lib/mutex.h"
#include "fid/fid.h"
#include "fid/fid_xc.h"
#include "dix/layout.h"
#include "dix/req.h"

/* Import */
struct m0_sm_group;
struct m0_dix_cli;
struct m0_dix_layout;
struct m0_dix_ldesc;

M0_EXTERN const struct m0_fid m0_dix_root_fid;
M0_EXTERN const struct m0_fid m0_dix_layout_fid;
M0_EXTERN const struct m0_fid m0_dix_ldescr_fid;

struct m0_dix_meta_req {
        struct m0_dix_req dmr_req;
        struct m0_bufvec  dmr_keys;
        struct m0_bufvec  dmr_vals;
        struct m0_chan    dmr_chan;
        struct m0_mutex   dmr_wait_mutex;
        struct m0_clink   dmr_clink;
};

M0_INTERNAL void m0_dix_meta_req_init(struct m0_dix_meta_req *req,
                                      struct m0_dix_cli      *cli,
                                      struct m0_sm_group     *grp);

M0_INTERNAL void m0_dix_meta_req_fini(struct m0_dix_meta_req *req);

M0_INTERNAL void m0_dix_meta_lock(struct m0_dix_meta_req *req);

M0_INTERNAL void m0_dix_meta_unlock(struct m0_dix_meta_req *req);

M0_INTERNAL void m0_dix_meta_req_fini_lock(struct m0_dix_meta_req *req);

M0_INTERNAL int m0_dix_meta_generic_rc(const struct m0_dix_meta_req *req);

M0_INTERNAL int m0_dix_meta_item_rc(const struct m0_dix_meta_req *req,
                                    uint64_t                      idx);

M0_INTERNAL int m0_dix_meta_req_nr(const struct m0_dix_meta_req *req);

M0_INTERNAL int m0_dix_meta_create(struct m0_dix_cli   *cli,
                                   struct m0_sm_group  *grp,
                                   struct m0_dix_ldesc *dld_layout,
                                   struct m0_dix_ldesc *dld_ldescr);

M0_INTERNAL int m0_dix_meta_check(struct m0_dix_cli  *cli,
                                  struct m0_sm_group *grp,
                                  bool               *result);

M0_INTERNAL int m0_dix_meta_destroy(struct m0_dix_cli   *cli,
                                    struct m0_sm_group *grp);

M0_INTERNAL int m0_dix_root_read(struct m0_dix_meta_req *req);

M0_INTERNAL int m0_dix_root_read_rep(struct m0_dix_meta_req *req,
                                     struct m0_dix_ldesc    *layout,
                                     struct m0_dix_ldesc    *ldescr);

M0_INTERNAL int m0_dix_ldescr_put(struct m0_dix_meta_req    *req,
                                  const uint64_t            *lid,
                                  const struct m0_dix_ldesc *ldesc,
                                  uint32_t                   nr);

M0_INTERNAL int m0_dix_ldescr_get(struct m0_dix_meta_req *req,
                                  const uint64_t         *lid,
                                  uint32_t                nr);

M0_INTERNAL int m0_dix_ldescr_rep_get(struct m0_dix_meta_req *req,
                                      uint64_t                idx,
                                      struct m0_dix_ldesc    *ldesc);

M0_INTERNAL int m0_dix_ldescr_del(struct m0_dix_meta_req *req,
                                  const uint64_t         *lid,
                                  uint32_t                nr);

M0_INTERNAL int m0_dix_layout_put(struct m0_dix_meta_req     *req,
                                  const struct m0_fid        *fid,
                                  const struct m0_dix_layout *dlay,
                                  uint32_t                    nr,
                                  uint32_t                    flags);

M0_INTERNAL int m0_dix_layout_get(struct m0_dix_meta_req *req,
                                  const struct m0_fid    *fid,
                                  uint32_t                nr);

M0_INTERNAL int m0_dix_layout_del(struct m0_dix_meta_req *req,
                                  const struct m0_fid    *fid,
                                  uint32_t                nr);

M0_INTERNAL int m0_dix_layout_rep_get(struct m0_dix_meta_req *req,
                                      uint64_t                idx,
                                      struct m0_dix_layout   *dlay);

M0_INTERNAL int m0_dix_index_list(struct m0_dix_meta_req *req,
                                  const struct m0_fid    *start_fid,
                                  uint32_t                indices_nr);

M0_INTERNAL int m0_dix_index_list_rep_nr(struct m0_dix_meta_req *req);

M0_INTERNAL int m0_dix_index_list_rep(struct m0_dix_meta_req *req,
                                      uint32_t                idx,
                                      struct m0_fid          *fid);

M0_INTERNAL int m0_dix__meta_val_enc(const struct m0_fid       *fid,
                                     const struct m0_dix_ldesc *dld,
                                     uint32_t                   nr,
                                     struct m0_bufvec          *vals);
M0_INTERNAL int m0_dix__meta_val_dec(const struct m0_bufvec *vals,
                                     struct m0_fid          *out_fid,
                                     struct m0_dix_ldesc    *out_dld,
                                     uint32_t                nr);

M0_INTERNAL int m0_dix__ldesc_vals_enc(const uint64_t            *lid,
                                       const struct m0_dix_ldesc *ldesc,
                                       uint32_t                   nr,
                                       struct m0_bufvec          *keys,
                                       struct m0_bufvec          *vals);

M0_INTERNAL int m0_dix__ldesc_vals_dec(const struct m0_bufvec *keys,
                                       const struct m0_bufvec *vals,
                                       uint64_t               *out_lid,
                                       struct m0_dix_ldesc    *out_ldesc,
                                       uint32_t                nr);

M0_INTERNAL int m0_dix__layout_vals_enc(const struct m0_fid        *fid,
                                        const struct m0_dix_layout *dlay,
                                        uint32_t                    nr,
                                        struct m0_bufvec           *keys,
                                        struct m0_bufvec           *vals);

M0_INTERNAL int m0_dix__layout_vals_dec(const struct m0_bufvec *keys,
                                        const struct m0_bufvec *vals,
                                        struct m0_fid          *out_fid,
                                        struct m0_dix_layout   *out_dlay,
                                        uint32_t                nr);

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