rm_rwlock.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2015-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_RM_RWLOCK_H__
#define __MOTR_RM_RWLOCK_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"

enum m0_rm_rwlock_req_type {
        RM_RWLOCK_READ,
        RM_RWLOCK_WRITE
};

struct m0_rw_lockable {
        const struct m0_fid   *rwl_fid;
        struct m0_rm_resource  rwl_resource;
};

M0_INTERNAL void m0_rw_lockable_init(struct m0_rw_lockable *lockable,
                                     const struct m0_fid   *fid,
                                     struct m0_rm_domain   *dom);

M0_INTERNAL void m0_rw_lockable_fini(struct m0_rw_lockable *lockable);

M0_INTERNAL void m0_rm_rwlock_owner_init(struct m0_rm_owner    *owner,
                                         struct m0_fid         *fid,
                                         struct m0_rw_lockable *lockable,
                                         struct m0_rm_remote   *creditor);

M0_INTERNAL void m0_rm_rwlock_owner_fini(struct m0_rm_owner *owner);

M0_INTERNAL void m0_rm_rwlock_req_init(struct m0_rm_incoming           *req,
                                       struct m0_rm_owner              *owner,
                                       const struct m0_rm_incoming_ops *ops,
                                       enum m0_rm_incoming_flags        flags,
                                       enum m0_rm_rwlock_req_type       type);

M0_INTERNAL void m0_rm_rwlock_req_fini(struct m0_rm_incoming *req);

M0_INTERNAL int m0_rw_lockable_type_register(struct m0_rm_domain        *dom,
                                             struct m0_rm_resource_type *rtype);
M0_INTERNAL
void m0_rw_lockable_type_deregister(struct m0_rm_resource_type *rtype);

extern const struct m0_fid M0_RWLOCK_FID;

M0_INTERNAL int
m0_rwlockable_domain_type_init(struct m0_rm_domain        *rwl_dom,
                               struct m0_rm_resource_type *rwl_rt);

M0_INTERNAL void
m0_rwlockable_domain_type_fini(struct m0_rm_domain        *rwl_dom,
                               struct m0_rm_resource_type *rwl_rt);

#endif /* __MOTR_RM_RWLOCK_H__ */

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