rm_fops.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_RM_FOPS_H__
#define __MOTR_RM_FOPS_H__

#include "lib/buf.h"
#include "lib/buf_xc.h"
#include "lib/cookie.h"
#include "lib/cookie_xc.h"

#include "fop/fom_generic.h"
#include "fop/fom_generic_xc.h"
#include "fop/fop.h"
#include "xcode/xcode_attr.h"

struct m0_rm_fop_owner {
        struct m0_cookie ow_cookie;
        struct m0_buf    ow_resource;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_rm_fop_loan {
        struct m0_cookie lo_cookie;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_rm_fop_credit {
        struct m0_buf cr_opaque;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_rm_fop_req {
        /* Could either be debtor or creditor */
        struct m0_rm_fop_owner  rrq_owner;
        struct m0_rm_fop_credit rrq_credit;
        uint64_t                rrq_policy;
        uint64_t                rrq_flags;
        /* Next three fields determine request reserve priority.
         * @see m0_rm_incoming, m0_rm_reserve_prio
         */
        struct m0_fid           rrq_orig_owner;
        m0_time_t               rrq_orig_time;
        uint64_t                rrq_orig_seq;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_rm_fop_borrow {
        struct m0_rm_fop_req   bo_base;
        struct m0_rm_fop_owner bo_creditor;
        struct m0_uint128      bo_group_id;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_rm_fop_borrow_rep {
        int32_t                     br_rc;
        struct m0_rm_fop_loan       br_loan;
        struct m0_rm_fop_credit     br_credit;
        struct m0_buf               br_lvb;
        struct m0_cookie            br_creditor_cookie;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_rm_fop_revoke {
        struct m0_rm_fop_req  fr_base;
        struct m0_rm_fop_loan fr_loan;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_rm_fop_revoke_rep {
        int32_t                     rr_rc;
        struct m0_cookie            rr_debtor_cookie;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_rm_fop_cancel {
        struct m0_rm_fop_loan fc_loan;
        struct m0_cookie      fc_creditor_cookie;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

extern struct m0_fop_type m0_rm_fop_borrow_fopt;
extern struct m0_fop_type m0_rm_fop_borrow_rep_fopt;
extern struct m0_fop_type m0_rm_fop_revoke_fopt;
extern struct m0_fop_type m0_rm_fop_revoke_rep_fopt;
extern struct m0_fop_type m0_rm_fop_cancel_fopt;
extern struct m0_fop_type m0_fop_generic_reply_fopt;

M0_INTERNAL int m0_rm_fop_init(void);
M0_INTERNAL void m0_rm_fop_fini(void);

/* __MOTR_RM_FOPS_H__ */
#endif