layout.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 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_LAYOUT_H__
#define __MOTR_LAYOUT_H__

#include "client.h"
#include "client_internal.h"
#include "lib/types.h"

struct m0_client_layout;
struct m0_op_layout;

#define M0_OBJ_LAYOUT_ID(lid)  (lid & 0x0000ffffffffffff)
#define M0_OBJ_LAYOUT_TYPE(lid) ((lid & 0xffff000000000000) >> 48UL)
#define M0_OBJ_LAYOUT_MAKE_LID(lid, type) \
        ((uint64_t)lid | ((uint64_t)type << 48UL))

extern const struct m0_op_layout_ops m0_op_layout_composite_ops;
extern const struct m0_client_layout_ops layout_composite_ops;
extern struct m0_fid composite_extent_rd_idx_fid;
extern struct m0_fid composite_extent_wr_idx_fid;

struct m0_capture_layout {
        struct m0_client_layout  cl_layout;
        struct m0_uint128        cl_orig_id;
        struct m0_fid            cl_pver;
        uint64_t                 cl_lid;
};

struct m0_client_pdclust_layout {
        struct m0_client_layout pl_layout;
        struct m0_fid           pl_pver;
        uint64_t                pl_lid;
        struct m0_fid           pl_fid;
};

struct m0_composite_extent {
        struct m0_uint128 ce_id;
        m0_bindex_t       ce_off;
        m0_bcount_t       ce_len;

        struct m0_tlink   ce_tlink;
        uint64_t          ce_tlink_magic;
};

struct m0_composite_layer {
        struct m0_uint128 ccr_subobj;
        uint64_t          ccr_lid;

        int               ccr_priority;
        struct m0_tl      ccr_rd_exts;
        struct m0_tl      ccr_wr_exts;

        struct m0_mutex   ccr_lock;
        struct m0_tlink   ccr_tlink;
        uint64_t          ccr_tlink_magic;
};

struct m0_client_composite_layout {
        struct m0_client_layout ccl_layout;
        uint64_t                ccl_nr_layers;
        struct m0_tl            ccl_layers;
        struct m0_mutex         ccl_lock;
};

struct m0_op_layout_ops {
        int (*olo_launch) (struct m0_op_layout *ol);
        int (*olo_copy_to_app)(struct m0_client_layout *to, void *data);
        int (*olo_copy_from_app)(struct m0_client_layout *from, void *data);
};

struct m0_op_layout {
        struct m0_op_common            ol_oc;
        uint64_t                       ol_magic;

        struct m0_sm_group            *ol_sm_grp;
        struct m0_ast_rc               ol_ar;

        struct m0_client_layout       *ol_layout;
        struct m0_entity              *ol_entity;

        const struct m0_op_layout_ops *ol_ops;
};

extern const struct m0_bob_type ol_bobtype;

struct m0_op_composite_io {
        struct m0_op_obj   oci_oo;
        uint64_t           oci_magic;

        int                oci_nr_sub_ops;
        struct m0_op     **oci_sub_ops;

        int                oci_nr_replied;
};

M0_INTERNAL int m0_layout_op_launch(struct m0_op_layout *ol);

M0_INTERNAL int m0_client__layout_get(struct m0_client_layout *layout);
M0_INTERNAL void m0_client__layout_put(struct m0_client_layout *layout);

M0_INTERNAL int m0__composite_container_init(struct m0_client *cinst);

M0_INTERNAL int m0__obj_layout_send(struct m0_obj *obj,
                                    struct m0_op_layout *ol);

M0_INTERNAL int m0__dix_layout_get_sync(struct m0_obj *obj,
                                        struct m0_dix_layout *dlayout);
M0_INTERNAL struct m0_dix_cli *ent_dixc(const struct m0_entity *ent);
M0_INTERNAL struct m0_dix_cli *ol_dixc(const struct m0_op_layout *ol);

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