md_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_MDSERVICE_MD_FOPS_H__
#define __MOTR_MDSERVICE_MD_FOPS_H__

#include "fop/fop.h"
#include "fop/fop_xc.h"
#include "fop/fom_generic.h"
#include "fop/fom_generic_xc.h"
#include "lib/types.h"
#include "xcode/xcode_attr.h"
#include "fid/fid_xc.h"
#include "fid/fid.h"
#include "lib/string.h"
#include "lib/string_xc.h"

extern struct m0_fop_type m0_fop_create_fopt;
extern struct m0_fop_type m0_fop_lookup_fopt;
extern struct m0_fop_type m0_fop_link_fopt;
extern struct m0_fop_type m0_fop_unlink_fopt;
extern struct m0_fop_type m0_fop_open_fopt;
extern struct m0_fop_type m0_fop_close_fopt;
extern struct m0_fop_type m0_fop_setattr_fopt;
extern struct m0_fop_type m0_fop_getattr_fopt;
extern struct m0_fop_type m0_fop_setxattr_fopt;
extern struct m0_fop_type m0_fop_getxattr_fopt;
extern struct m0_fop_type m0_fop_delxattr_fopt;
extern struct m0_fop_type m0_fop_listxattr_fopt;
extern struct m0_fop_type m0_fop_statfs_fopt;
extern struct m0_fop_type m0_fop_rename_fopt;
extern struct m0_fop_type m0_fop_readdir_fopt;

extern struct m0_fop_type m0_fop_create_rep_fopt;
extern struct m0_fop_type m0_fop_lookup_rep_fopt;
extern struct m0_fop_type m0_fop_link_rep_fopt;
extern struct m0_fop_type m0_fop_unlink_rep_fopt;
extern struct m0_fop_type m0_fop_open_rep_fopt;
extern struct m0_fop_type m0_fop_close_rep_fopt;
extern struct m0_fop_type m0_fop_setattr_rep_fopt;
extern struct m0_fop_type m0_fop_getattr_rep_fopt;
extern struct m0_fop_type m0_fop_setxattr_rep_fopt;
extern struct m0_fop_type m0_fop_getxattr_rep_fopt;
extern struct m0_fop_type m0_fop_delxattr_rep_fopt;
extern struct m0_fop_type m0_fop_listxattr_rep_fopt;
extern struct m0_fop_type m0_fop_statfs_rep_fopt;
extern struct m0_fop_type m0_fop_rename_rep_fopt;
extern struct m0_fop_type m0_fop_readdir_rep_fopt;

struct m0_fop_cob {
        uint32_t      b_rc;
        uint64_t      b_index;
        uint64_t      b_version;
        uint32_t      b_flags;
        uint32_t      b_valid;
        uint32_t      b_mode;
        uint64_t      b_size;
        uint64_t      b_blksize;
        uint64_t      b_blocks;
        uint32_t      b_nlink;
        uint32_t      b_uid;
        uint32_t      b_gid;
        uint32_t      b_sid;
        uint64_t      b_nid;
        uint32_t      b_rdev;
        uint32_t      b_atime;
        uint32_t      b_mtime;
        uint32_t      b_ctime;
        uint64_t      b_lid;
        struct m0_fid b_pfid;
        struct m0_fid b_tfid;
        struct m0_fid b_pver;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_buf {
        uint32_t b_count;
        uint8_t *b_addr;
} M0_XCA_SEQUENCE M0_XCA_DOMAIN(rpc);

struct m0_fop_create {
        struct m0_fop_cob c_body;
        struct m0_fop_str c_target;
        struct m0_fop_str c_path;
        struct m0_fop_str c_name;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_create_rep {
        int32_t                 c_rc;
        struct m0_fop_cob       c_body;
        struct m0_fop_mod_rep   c_mod_rep;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_lookup {
        struct m0_fop_cob l_body;
        struct m0_fop_str l_path;
        struct m0_fop_str l_name;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_lookup_rep {
        int32_t           l_rc;
        struct m0_fop_cob l_body;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_link {
        struct m0_fop_cob l_body;
        struct m0_fop_str l_spath;
        struct m0_fop_str l_tpath;
        struct m0_fop_str l_name;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_link_rep {
        int32_t                 l_rc;
        struct m0_fop_cob       l_body;
        struct m0_fop_mod_rep   l_mod_rep;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_unlink {
        struct m0_fop_cob u_body;
        struct m0_fop_str u_path;
        struct m0_fop_str u_name;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_unlink_rep {
        int32_t                 u_rc;
        struct m0_fop_cob       u_body;
        struct m0_fop_mod_rep   u_mod_rep;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_rename {
        struct m0_fop_cob r_sbody;
        struct m0_fop_cob r_tbody;
        struct m0_fop_str r_spath;
        struct m0_fop_str r_tpath;
        struct m0_fop_str r_sname;
        struct m0_fop_str r_tname;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_rename_rep {
        int32_t                 r_rc;
        struct m0_fop_cob       r_body;
        struct m0_fop_mod_rep   r_mod_rep;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_open {
        struct m0_fop_str o_path;
        struct m0_fop_cob o_body;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_open_rep {
        int32_t                 o_rc;
        struct m0_fop_cob       o_body;
        struct m0_fop_mod_rep   o_mod_rep;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_close {
        struct m0_fop_cob c_body;
        struct m0_fop_str c_path;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_close_rep {
        int32_t           c_rc;
        struct m0_fop_cob c_body;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_setattr {
        struct m0_fop_cob s_body;
        struct m0_fop_str s_path;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_setattr_rep {
        int32_t                 s_rc;
        struct m0_fop_cob       s_body;
        struct m0_fop_mod_rep   s_mod_rep;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_getattr {
        struct m0_fop_cob g_body;
        struct m0_fop_str g_path;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_getattr_rep {
        int32_t           g_rc;
        struct m0_fop_cob g_body;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_getxattr {
        struct m0_fop_cob g_body;
        struct m0_fop_str g_key;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_getxattr_rep {
        int32_t           g_rc;
        struct m0_fop_cob g_body;
        struct m0_fop_str g_value;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_setxattr {
        struct m0_fop_cob s_body;
        struct m0_fop_str s_key;
        struct m0_fop_str s_value;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_setxattr_rep {
        int32_t                 s_rc;
        struct m0_fop_cob       s_body;
        struct m0_fop_mod_rep   s_mod_rep;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_delxattr {
        struct m0_fop_cob d_body;
        struct m0_fop_str d_key;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_delxattr_rep {
        int32_t                 d_rc;
        struct m0_fop_cob       d_body;
        struct m0_fop_mod_rep   d_mod_rep;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_listxattr {
        struct m0_fop_cob l_body;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_listxattr_rep {
        int32_t           l_rc;
        struct m0_fop_str l_end;
        struct m0_fop_cob l_body;
        struct m0_fop_buf l_buf;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_readdir {
        struct m0_fop_cob r_body;
        struct m0_fop_str r_path;
        struct m0_fop_str r_pos;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_readdir_rep {
        int32_t           r_rc;
        struct m0_fop_str r_end;
        struct m0_fop_cob r_body;
        struct m0_fop_buf r_buf;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_statfs {
        uint64_t          f_flags;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_statfs_rep {
        int32_t    f_rc;
        uint64_t          f_type;
        uint32_t          f_bsize;
        uint64_t          f_blocks;
        uint64_t          f_bfree;
        uint64_t          f_bavail;
        uint64_t          f_files;
        uint64_t          f_ffree;
        uint32_t          f_namelen;
        struct m0_fid     f_root;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

M0_INTERNAL int m0_mdservice_fop_init(void);
M0_INTERNAL void m0_mdservice_fop_fini(void);

struct m0_cob_attr;
M0_INTERNAL void m0_md_cob_wire2mem(struct m0_cob_attr *attr,
                                    const struct m0_fop_cob *body);

M0_INTERNAL void m0_md_cob_mem2wire(struct m0_fop_cob *body,
                                    const struct m0_cob_attr *attr);

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