lustre/include/linux/lustre_mds.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  *  Copyright (C) 2001 Cluster File Systems, Inc. <braam@clusterfs.com>
   5  *
   6  *   This file is part of Lustre, http://www.lustre.org.
   7  *
   8  *   Lustre is free software; you can redistribute it and/or
   9  *   modify it under the terms of version 2 of the GNU General Public
  10  *   License as published by the Free Software Foundation.
  11  *
  12  *   Lustre is distributed in the hope that it will be useful,
  13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *   GNU General Public License for more details.
  16  *
  17  *   You should have received a copy of the GNU General Public License
  18  *   along with Lustre; if not, write to the Free Software
  19  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  *
  21  * MDS data structures.
  22  * See also lustre_idl.h for wire formats of requests.
  23  *
  24  */
  25
  26 #ifndef _LUSTRE_MDS_H
  27 #define _LUSTRE_MDS_H
  28
  29 #ifdef __KERNEL__
  30
  31 #include <linux/obd_class.h>
  32 #include <linux/lustre_idl.h>
  33 #include <linux/lustre_net.h>
  34
  35 #define LUSTRE_MDS_NAME "mds"
  36
  37 struct mds_update_record {
  38         __u32 ur_opcode;
  39         struct ll_fid *ur_fid1;
  40         struct ll_fid *ur_fid2;
  41         int ur_namelen;
  42         char *ur_name;
  43         int ur_tgtlen;
  44         char *ur_tgt;
  45         struct iattr ur_iattr;
  46         __u64 ur_id;
  47         __u32 ur_mode;
  48         __u32 ur_uid;
  49         __u32 ur_gid;
  50         __u64 ur_time;
  51 };
  52
  53 #define MDS_LR_CLIENT  8192
  54 #define MDS_LR_SIZE     128
  55
  56 #define MDS_CLIENT_SLOTS 17
  57
  58 #define MDS_MOUNT_RECOV 2
  59
  60 /* Data stored per server at the head of the last_rcvd file.  In le32 order. */
  61 struct mds_server_data {
  62         __u8 msd_uuid[37];      /* server UUID */
  63         __u8 uuid_padding[3];   /* unused */
  64         __u64 msd_last_rcvd;    /* last completed transaction ID */
  65         __u64 msd_mount_count;  /* MDS incarnation number */
  66         __u8 padding[512 - 56];
  67 };
  68
  69 /* Data stored per client in the last_rcvd file.  In le32 order. */
  70 struct mds_client_data {
  71         __u8 mcd_uuid[37];      /* client UUID */
  72         __u8 uuid_padding[3];   /* unused */
  73         __u64 mcd_last_rcvd;    /* last completed transaction ID */
  74         __u64 mcd_mount_count;  /* MDS incarnation number */
  75         __u32 mcd_last_xid;     /* client RPC xid for the last transaction */
  76         __u8 padding[MDS_LR_SIZE - 60];
  77 };
  78
  79 /* In-memory access to client data from MDS struct */
  80 struct mds_client_info {
  81         struct list_head mci_list;
  82         struct list_head mci_open_head;
  83         struct mds_client_data *mci_mcd;
  84         int mci_off;
  85 };
  86
  87 /* file data for open files on MDS */
  88 struct mds_file_data {
  89         struct list_head mfd_list;
  90         struct file * mfd_file;
  91         __u64             mfd_clientfd;
  92         __u32             mfd_clientcookie;
  93 };
  94
  95 /* mds/mds_reint.c  */
  96 int mds_reint_rec(struct mds_update_record *r, struct ptlrpc_request *req);
  97 struct mds_client_info *mds_uuid_to_mci(struct mds_obd *mds, __u8 *uuid);
  98
  99 /* lib/mds_updates.c */
 100 void mds_pack_req_body(struct ptlrpc_request *);
 101 void mds_pack_rep_body(struct ptlrpc_request *);
 102 void mds_unpack_req_body(struct ptlrpc_request *);
 103 void mds_unpack_rep_body(struct ptlrpc_request *);
 104 int mds_update_unpack(struct ptlrpc_request *, struct mds_update_record *);
 105
 106 void mds_setattr_pack(struct mds_rec_setattr *, struct inode *, struct iattr *);
 107 void mds_create_pack(struct mds_rec_create *, struct inode *,  __u32 mode,
 108                      __u64 id, __u32 uid, __u32 gid, __u64 time);
 109 void mds_unlink_pack(struct mds_rec_unlink *, struct inode *inode,
 110                      struct inode *child);
 111 void mds_link_pack(struct mds_rec_link *, struct inode *ino, struct inode *dir);
 112 void mds_rename_pack(struct mds_rec_rename *, struct inode *srcdir,
 113                      struct inode *tgtdir);
 114
 115 /* mds/handler.c */
 116 struct dentry *mds_fid2dentry(struct mds_obd *mds, struct ll_fid *fid, struct vfsmount **mnt);
 117
 118 /* mdc/mdc_request.c */
 119 int mdc_connect(struct ptlrpc_client *, struct ptlrpc_connection *,
 120                 struct ll_fid *rootfid, __u64 *last_committed, __u64 *last_rcvd,
 121                 __u32 *last_xid, struct ptlrpc_request **);
 122 int mdc_getattr(struct ptlrpc_client *, struct ptlrpc_connection *, ino_t ino,
 123                 int type, unsigned long valid, size_t ea_size,
 124                 struct ptlrpc_request **);
 125 int mdc_setattr(struct ptlrpc_client *, struct ptlrpc_connection *,
 126                 struct inode *, struct iattr *iattr, struct ptlrpc_request **);
 127 int mdc_open(struct ptlrpc_client *, struct ptlrpc_connection *, ino_t ino,
 128              int type, int flags, __u64 cookie, __u64 *fh, struct ptlrpc_request **req);
 129 int mdc_close(struct ptlrpc_client *cl, struct ptlrpc_connection *peer,
 130               ino_t ino, int type, __u64 fh,  struct ptlrpc_request **req);
 131 int mdc_readpage(struct ptlrpc_client *, struct ptlrpc_connection *, ino_t ino,
 132                  int type, __u64 offset, char *addr, struct ptlrpc_request **);
 133 int mdc_create(struct ptlrpc_client *, struct ptlrpc_connection *,
 134                struct inode *dir, const char *name, int namelen,
 135                const char *tgt, int tgtlen,
 136                int mode, __u64 id, __u32 uid, __u32 gid, __u64 time,
 137                struct ptlrpc_request **);
 138 int mdc_unlink(struct ptlrpc_client *, struct ptlrpc_connection *,
 139                struct inode *dir, struct inode *child, const char *name,
 140                int namelen, struct ptlrpc_request **);
 141 int mdc_link(struct ptlrpc_client *, struct ptlrpc_connection *,
 142              struct dentry *src, struct inode *dir, const char *name,
 143              int namelen, struct ptlrpc_request **);
 144 int mdc_rename(struct ptlrpc_client *, struct ptlrpc_connection *,
 145                struct inode *src, struct inode *tgt, const char *old,
 146                int oldlen, const char *new, int newlen,
 147                struct ptlrpc_request **);
 148 int mdc_create_client(char *uuid, struct ptlrpc_client *cl);
 149
 150 extern int mds_client_add(struct mds_obd *mds, struct mds_client_data *mcd,
 151                           int cl_off);
 152
 153 /* mds/mds_fs.c */
 154 struct mds_fs_operations {
 155         void   *(* fs_start)(struct inode *inode, int op);
 156         int     (* fs_commit)(struct inode *inode, void *handle);
 157         int     (* fs_setattr)(struct dentry *dentry, void *handle,
 158                                struct iattr *iattr);
 159         int     (* fs_set_objid)(struct inode *inode, void *handle, obd_id id);
 160         int     (* fs_get_objid)(struct inode *inode, obd_id *id);
 161         ssize_t (* fs_readpage)(struct file *file, char *buf, size_t count,
 162                                 loff_t *offset);
 163         void    (* fs_delete_inode)(struct inode *inode);
 164         void    (* cl_delete_inode)(struct inode *inode);
 165         int     (* fs_journal_data)(struct file *file);
 166         int     (* fs_set_last_rcvd)(struct mds_obd *mds, void *handle);
 167 };
 168
 169 extern int mds_register_fs_type(struct mds_fs_operations *op, const char *name);
 170 extern void mds_unregister_fs_type(const char *name);
 171 extern int mds_fs_setup(struct mds_obd *mds, struct vfsmount *mnt);
 172 extern void mds_fs_cleanup(struct mds_obd *mds);
 173
 174 static inline void *mds_fs_start(struct mds_obd *mds, struct inode *inode,
 175                                  int op)
 176 {
 177         return mds->mds_fsops->fs_start(inode, op);
 178 }
 179
 180 static inline int mds_fs_commit(struct mds_obd *mds, struct inode *inode,
 181                                 void *handle)
 182 {
 183         return mds->mds_fsops->fs_commit(inode, handle);
 184 }
 185
 186 static inline int mds_fs_setattr(struct mds_obd *mds, struct dentry *dentry,
 187                                  void *handle, struct iattr *iattr)
 188 {
 189         /*
 190          * NOTE: we probably don't need to take i_sem here when changing
 191          *       ATTR_SIZE because the MDS never needs to truncate a file.
 192          *       The ext2/ext3 code never truncates a directory, and files
 193          *       stored on the MDS are entirely sparse (no data blocks).
 194          *       If we do need to get it, we can do it here.
 195          */
 196         return mds->mds_fsops->fs_setattr(dentry, handle, iattr);
 197 }
 198
 199 static inline int mds_fs_set_objid(struct mds_obd *mds, struct inode *inode,
 200                                    void *handle, __u64 id)
 201 {
 202         return mds->mds_fsops->fs_set_objid(inode, handle, id);
 203 }
 204
 205 static inline int mds_fs_get_objid(struct mds_obd *mds, struct inode *inode,
 206                                     __u64 *id)
 207 {
 208         return mds->mds_fsops->fs_get_objid(inode, id);
 209 }
 210
 211 static inline ssize_t mds_fs_readpage(struct mds_obd *mds, struct file *file,
 212                                       char *buf, size_t count, loff_t *offset)
 213 {
 214         return mds->mds_fsops->fs_readpage(file, buf, count, offset);
 215 }
 216
 217 /* Set up callback to update mds->mds_last_committed with the current
 218  * value of mds->mds_last_recieved when this transaction is on disk.
 219  */
 220 static inline int mds_fs_set_last_rcvd(struct mds_obd *mds, void *handle)
 221 {
 222         return mds->mds_fsops->fs_set_last_rcvd(mds, handle);
 223 }
 224
 225 /* Enable data journaling on the given file */
 226 static inline ssize_t mds_fs_journal_data(struct mds_obd *mds,
 227                                           struct file *file)
 228 {
 229         return mds->mds_fsops->fs_journal_data(file);
 230 }
 231
 232 #define MDS_FSOP_UNLINK         1
 233 #define MDS_FSOP_RMDIR          2
 234 #define MDS_FSOP_RENAME         3
 235 #define MDS_FSOP_CREATE         4
 236 #define MDS_FSOP_MKDIR          5
 237 #define MDS_FSOP_SYMLINK        6
 238 #define MDS_FSOP_MKNOD          7
 239 #define MDS_FSOP_SETATTR        8
 240 #define MDS_FSOP_LINK           9
 241
 242 #endif /* __KERNEL__ */
 243
 244 /* ioctls for trying requests */
 245 #define IOC_REQUEST_TYPE                   'f'
 246 #define IOC_REQUEST_MIN_NR                 30
 247
 248 #define IOC_REQUEST_GETATTR             _IOWR('f', 30, long)
 249 #define IOC_REQUEST_READPAGE            _IOWR('f', 31, long)
 250 #define IOC_REQUEST_SETATTR             _IOWR('f', 32, long)
 251 #define IOC_REQUEST_CREATE              _IOWR('f', 33, long)
 252 #define IOC_REQUEST_OPEN                _IOWR('f', 34, long)
 253 #define IOC_REQUEST_CLOSE               _IOWR('f', 35, long)
 254 #define IOC_REQUEST_MAX_NR               35
 255
 256 #endif