file.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2013-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_FILE_H__
#define __MOTR_FILE_H__

#include "lib/errno.h"
#include "lib/misc.h"
#include "lib/memory.h"
#include "fid/fid.h"
#include "rm/rm.h"
#include "rm/rm_internal.h"
#include "file/di.h"

struct m0_file {
        const struct m0_fid    *fi_fid;
        struct m0_rm_resource   fi_res;
        /* Data-integrity operations supported by this file. */
        const struct m0_di_ops *fi_di_ops;
};

M0_INTERNAL void m0_file_init(struct m0_file *file,
                              const struct m0_fid *fid,
                              struct m0_rm_domain *dom,
                              enum m0_di_types     di_type);

M0_INTERNAL void m0_file_fini(struct m0_file *file);

M0_INTERNAL void m0_file_owner_init(struct m0_rm_owner      *owner,
                                    const struct m0_uint128 *grp_id,
                                    struct m0_file          *file,
                                    struct m0_rm_remote     *creditor);

M0_INTERNAL void m0_file_owner_fini(struct m0_rm_owner *owner);

M0_INTERNAL void m0_file_lock(struct m0_rm_owner *owner,
                              struct m0_rm_incoming *req);

M0_INTERNAL void m0_file_unlock(struct m0_rm_incoming *req);

M0_INTERNAL
int m0_file_lock_type_register(struct m0_rm_domain *dom,
                               struct m0_rm_resource_type *flock_rt);

M0_INTERNAL
void m0_file_lock_type_deregister(struct m0_rm_resource_type *flock_rt);

extern const struct m0_fid_type m0_file_fid_type;

M0_INTERNAL int m0_file_mod_init(void);

M0_INTERNAL void m0_file_mod_fini(void);

#endif /*  __MOTR_FILE_H__ */

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