file.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2012-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_SNS_CM_FILE_H__
#define __MOTR_SNS_CM_FILE_H__

enum m0_sns_cm_fctx_state {
        M0_SCFS_INIT = 0,
        M0_SCFS_LOCK_WAIT,
        M0_SCFS_LOCKED,
        M0_SCFS_ATTR_FETCH,
        M0_SCFS_ATTR_FETCHED,
        M0_SCFS_LAYOUT_FETCH,
        M0_SCFS_LAYOUT_FETCHED,
        M0_SCFS_FINI,
        M0_SCFS_NR
};

struct m0_sns_cm_file_ctx {
        uint64_t                    sf_magic;

        struct m0_file              sf_file;

        struct m0_fid               sf_fid;

        struct m0_cob_attr          sf_attr;

        uint64_t                    sf_max_group;

        struct m0_poolmach         *sf_pm;

        struct m0_pooldev          *sf_pd;

        struct m0_layout           *sf_layout;

        struct m0_pdclust_instance *sf_pi;

        struct m0_mutex             sf_lock;

        struct m0_hlink             sf_sc_link;

        struct m0_rm_owner          sf_owner;

        struct m0_rm_remote         sf_creditor;

        struct m0_rm_incoming       sf_rin;

        struct m0_sns_cm           *sf_scm;

        uint64_t                    sf_ag_nr;

        struct m0_ref               sf_ref;

        struct m0_sm                sf_sm;

        struct m0_sm_group         *sf_group;

        struct m0_sm_ast            sf_attr_ast;

        struct m0_sm_ast            sf_fini_ast;

        struct m0_clink             sf_fini_clink;

        uint64_t                    sf_nr_ios_visited;
        int                         sf_rc;
};

M0_INTERNAL int m0_sns_cm_fctx_init(struct m0_sns_cm *scm,
                                    const struct m0_fid *fid,
                                    struct m0_sns_cm_file_ctx **sc_fctx);

M0_INTERNAL void m0_sns_cm_fctx_fini(struct m0_sns_cm_file_ctx *fctx);

/*
 * Invokes async file lock api and adds the given fctx object to
 * m0_sns_cm::sc_file_ctx hash table. Its the responsibility of
 * the caller to wait for the lock on rm's incoming channel where
 * the state changes are announced.
 * @see m0_sns_cm_file_lock_wait()
 * @ret -EAGAIN.
 */
M0_INTERNAL int m0_sns_cm_file_lock(struct m0_sns_cm *scm,
                                    const struct m0_fid *fid,
                                    struct m0_sns_cm_file_ctx **out);
M0_INTERNAL int
m0_sns_cm_file_lock_wait(struct m0_sns_cm_file_ctx *fctx,
                         struct m0_fom *fom);

M0_INTERNAL void m0_sns_cm_file_unlock(struct m0_sns_cm *scm,
                                       struct m0_fid *fid);

M0_INTERNAL struct m0_sns_cm_file_ctx *
m0_sns_cm_fctx_locate(struct m0_sns_cm *scm, struct m0_fid *fid);

M0_INTERNAL  struct m0_sns_cm_file_ctx *
m0_sns_cm_fctx_get(struct m0_sns_cm *scm, const struct m0_cm_ag_id *id);

M0_INTERNAL void m0_sns_cm_fctx_put(struct m0_sns_cm *scm,
                                    const struct m0_cm_ag_id *id);

M0_INTERNAL void m0_sns_cm_fctx_cleanup(struct m0_sns_cm *scm);
M0_INTERNAL void m0_sns_cm_flock_resource_set(struct m0_sns_cm *scm);

M0_INTERNAL int
m0_sns_cm_file_attr_and_layout(struct m0_sns_cm_file_ctx *fctx);

M0_INTERNAL void
m0_sns_cm_file_attr_and_layout_wait(struct m0_sns_cm_file_ctx *fctx,
                                    struct m0_fom *fom);

M0_INTERNAL int m0_sns_cm_fctx_state_get(struct m0_sns_cm_file_ctx *fctx);

M0_INTERNAL struct m0_pool_version *
m0_sns_cm_pool_version_get(struct m0_sns_cm_file_ctx *fctx);

M0_INTERNAL void m0_sns_cm_file_fwd_map(struct m0_sns_cm_file_ctx *fctx,
                                        const struct m0_pdclust_src_addr *sa,
                                        struct m0_pdclust_tgt_addr *ta);

M0_INTERNAL void m0_sns_cm_file_bwd_map(struct m0_sns_cm_file_ctx *fctx,
                                        const struct m0_pdclust_tgt_addr *ta,
                                        struct m0_pdclust_src_addr *sa);

M0_INTERNAL void m0_sns_cm_fctx_lock(struct m0_sns_cm_file_ctx *fctx);
M0_INTERNAL void m0_sns_cm_fctx_unlock(struct m0_sns_cm_file_ctx *fctx);

M0_INTERNAL uint64_t m0_sns_cm_file_data_units(struct m0_sns_cm_file_ctx *fctx);
M0_INTERNAL bool m0_sns_cm_file_unit_is_EOF(struct m0_pdclust_layout *pl,
                                            uint64_t nr_max_data_units,
                                            uint64_t group, uint32_t unit);

M0_HT_DESCR_DECLARE(m0_scmfctx, M0_EXTERN);
M0_HT_DECLARE(m0_scmfctx, M0_EXTERN, struct m0_sns_cm_file_ctx,
              struct m0_fid);

#endif /* __MOTR_SNS_CM_FILE_H__ */
/*
 *  Local variables:
 *  c-indentation-style: "K&R"
 *  c-basic-offset: 8
 *  tab-width: 8
 *  fill-column: 80
 *  scroll-step: 1
 *  End:
 */