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 static inline void l_dput(struct dentry *de)
  36 {
  37         if (!de || IS_ERR(de))
  38                 return;
  39         shrink_dcache_parent(de);
  40         dput(de);
  41 }
  42
  43 #define LUSTRE_MDS_NAME "mds"
  44
  45 struct mds_update_record {
  46         __u32 ur_opcode;
  47         struct ll_fid *ur_fid1;
  48         struct ll_fid *ur_fid2;
  49         int ur_namelen;
  50         char *ur_name;
  51         int ur_tgtlen;
  52         char *ur_tgt;
  53         struct iattr ur_iattr;
  54         __u64 ur_id;
  55         __u32 ur_mode;
  56         __u32 ur_uid;
  57         __u32 ur_gid;
  58         __u64 ur_time;
  59 };
  60
  61 #define MDS_LR_CLIENT  8192
  62 #define MDS_LR_SIZE     128
  63
  64 #define MDS_CLIENT_SLOTS 17
  65
  66 #define MDS_MOUNT_RECOV 2
  67
  68 /* Data stored per server at the head of the last_rcvd file.  In le32 order. */
  69 struct mds_server_data {
  70         __u8 msd_uuid[37];      /* server UUID */
  71         __u8 uuid_padding[3];   /* unused */
  72         __u64 msd_last_rcvd;    /* last completed transaction ID */
  73         __u64 msd_mount_count;  /* MDS incarnation number */
  74         __u8 padding[512 - 56];
  75 };
  76
  77 /* Data stored per client in the last_rcvd file.  In le32 order. */
  78 struct mds_client_data {
  79         __u8 mcd_uuid[37];      /* client UUID */
  80         __u8 uuid_padding[3];   /* unused */
  81         __u64 mcd_last_rcvd;    /* last completed transaction ID */
  82         __u64 mcd_mount_count;  /* MDS incarnation number */
  83         __u32 mcd_last_xid;     /* client RPC xid for the last transaction */
  84         __u8 padding[MDS_LR_SIZE - 60];
  85 };
  86
  87 /* In-memory access to client data from MDS struct */
  88 struct mds_client_info {
  89         struct list_head mci_list;
  90         struct list_head mci_open_head;
  91         struct mds_client_data *mci_mcd;
  92         int mci_off;
  93 };
  94
  95 /* file data for open files on MDS */
  96 struct mds_file_data {
  97         struct list_head mfd_list;
  98         struct file * mfd_file;
  99         __u64             mfd_clientfd;
 100         __u32             mfd_clientcookie;
 101 };
 102
 103 /* mds/mds_reint.c  */
 104 int mds_reint_rec(struct mds_update_record *r, struct ptlrpc_request *req);
 105 struct mds_client_info *mds_uuid_to_mci(struct mds_obd *mds, __u8 *uuid);
 106
 107 /* lib/mds_updates.c */
 108 void mds_pack_req_body(struct ptlrpc_request *);
 109 void mds_pack_rep_body(struct ptlrpc_request *);
 110 void mds_unpack_req_body(struct ptlrpc_request *);
 111 void mds_unpack_rep_body(struct ptlrpc_request *);
 112 int mds_update_unpack(struct ptlrpc_request *, struct mds_update_record *);
 113
 114 void mds_setattr_pack(struct mds_rec_setattr *, struct inode *, struct iattr *);
 115 void mds_create_pack(struct mds_rec_create *, struct inode *,  __u32 mode,
 116                      __u64 id, __u32 uid, __u32 gid, __u64 time);
 117 void mds_unlink_pack(struct mds_rec_unlink *, struct inode *inode,
 118                      struct inode *child);
 119 void mds_link_pack(struct mds_rec_link *, struct inode *ino, struct inode *dir);
 120 void mds_rename_pack(struct mds_rec_rename *, struct inode *srcdir,
 121                      struct inode *tgtdir);
 122
 123 /* mds/handler.c */
 124 struct dentry *mds_fid2dentry(struct mds_obd *mds, struct ll_fid *fid, struct vfsmount **mnt);
 125
 126 /* mdc/mdc_request.c */
 127 int mdc_connect(struct ptlrpc_client *, struct ptlrpc_connection *,
 128                 struct ll_fid *rootfid, __u64 *last_committed, __u64 *last_rcvd,
 129                 __u32 *last_xid, struct ptlrpc_request **);
 130 int mdc_getattr(struct ptlrpc_client *, struct ptlrpc_connection *, ino_t ino,
 131                 int type, unsigned long valid, size_t ea_size,
 132                 struct ptlrpc_request **);
 133 int mdc_setattr(struct ptlrpc_client *, struct ptlrpc_connection *,
 134                 struct inode *, struct iattr *iattr, struct ptlrpc_request **);
 135 int mdc_open(struct ptlrpc_client *, struct ptlrpc_connection *, ino_t ino,
 136              int type, int flags, __u64 cookie, __u64 *fh, struct ptlrpc_request **req);
 137 int mdc_close(struct ptlrpc_client *cl, struct ptlrpc_connection *peer,
 138               ino_t ino, int type, __u64 fh,  struct ptlrpc_request **req);
 139 int mdc_readpage(struct ptlrpc_client *, struct ptlrpc_connection *, ino_t ino,
 140                  int type, __u64 offset, char *addr, struct ptlrpc_request **);
 141 int mdc_create(struct ptlrpc_client *, struct ptlrpc_connection *,
 142                struct inode *dir, const char *name, int namelen,
 143                const char *tgt, int tgtlen,
 144                int mode, __u64 id, __u32 uid, __u32 gid, __u64 time,
 145                struct ptlrpc_request **);
 146 int mdc_unlink(struct ptlrpc_client *, struct ptlrpc_connection *,
 147                struct inode *dir, struct inode *child, const char *name,
 148                int namelen, struct ptlrpc_request **);
 149 int mdc_link(struct ptlrpc_client *, struct ptlrpc_connection *,
 150              struct dentry *src, struct inode *dir, const char *name,
 151              int namelen, struct ptlrpc_request **);
 152 int mdc_rename(struct ptlrpc_client *, struct ptlrpc_connection *,
 153                struct inode *src, struct inode *tgt, const char *old,
 154                int oldlen, const char *new, int newlen,
 155                struct ptlrpc_request **);
 156 int mdc_create_client(char *uuid, struct ptlrpc_client *cl);
 157
 158 struct mds_fs_operations {
 159         void   *(* fs_start)(struct inode *inode, int op);
 160         int     (* fs_commit)(struct inode *inode, void *handle);
 161         int     (* fs_setattr)(struct dentry *dentry, void *handle,
 162                                struct iattr *iattr);
 163         int     (* fs_set_objid)(struct inode *inode, void *handle, obd_id id);
 164         void    (* fs_get_objid)(struct inode *inode, obd_id *id);
 165         ssize_t (* fs_readpage)(struct file *file, char *buf, size_t count,
 166                                 loff_t *offset);
 167         void    (* fs_delete_inode)(struct inode *inode);
 168         void    (* cl_delete_inode)(struct inode *inode);
 169         int     (* fs_journal_data)(struct file *file);
 170         int     (* fs_set_last_rcvd)(struct mds_obd *mds, void *handle);
 171 };
 172
 173 #define MDS_FSOP_UNLINK         1
 174 #define MDS_FSOP_RMDIR          2
 175 #define MDS_FSOP_RENAME         3
 176 #define MDS_FSOP_CREATE         4
 177 #define MDS_FSOP_MKDIR          5
 178 #define MDS_FSOP_SYMLINK        6
 179 #define MDS_FSOP_MKNOD          7
 180 #define MDS_FSOP_SETATTR        8
 181 #define MDS_FSOP_LINK           9
 182
 183 static inline void *mds_fs_start(struct mds_obd *mds, struct inode *inode,
 184                                  int op)
 185 {
 186         return mds->mds_fsops->fs_start(inode, op);
 187 }
 188
 189 static inline int mds_fs_commit(struct mds_obd *mds, struct inode *inode,
 190                                 void *handle)
 191 {
 192         return mds->mds_fsops->fs_commit(inode, handle);
 193 }
 194
 195 static inline int mds_fs_setattr(struct mds_obd *mds, struct dentry *dentry,
 196                                  void *handle, struct iattr *iattr)
 197 {
 198         /*
 199          * NOTE: we probably don't need to take i_sem here when changing
 200          *       ATTR_SIZE because the MDS never needs to truncate a file.
 201          *       The ext2/ext3 code never truncates a directory, and files
 202          *       stored on the MDS are entirely sparse (no data blocks).
 203          *       If we do need to get it, we can do it here.
 204          */
 205         return mds->mds_fsops->fs_setattr(dentry, handle, iattr);
 206 }
 207
 208 static inline int mds_fs_set_objid(struct mds_obd *mds, struct inode *inode,
 209                                    void *handle, __u64 id)
 210 {
 211         return mds->mds_fsops->fs_set_objid(inode, handle, id);
 212 }
 213
 214 static inline void mds_fs_get_objid(struct mds_obd *mds, struct inode *inode,
 215                                     __u64 *id)
 216 {
 217         mds->mds_fsops->fs_get_objid(inode, id);
 218 }
 219
 220 static inline ssize_t mds_fs_readpage(struct mds_obd *mds, struct file *file,
 221                                       char *buf, size_t count, loff_t *offset)
 222 {
 223         return mds->mds_fsops->fs_readpage(file, buf, count, offset);
 224 }
 225
 226 /* Set up callback to update mds->mds_last_committed with the current
 227  * value of mds->mds_last_recieved when this transaction is on disk.
 228  */
 229 static inline int mds_fs_set_last_rcvd(struct mds_obd *mds, void *handle)
 230 {
 231         return mds->mds_fsops->fs_set_last_rcvd(mds, handle);
 232 }
 233
 234 /* Enable data journaling on the given file */
 235 static inline ssize_t mds_fs_journal_data(struct mds_obd *mds,
 236                                           struct file *file)
 237 {
 238         return mds->mds_fsops->fs_journal_data(file);
 239 }
 240
 241 extern struct mds_fs_operations mds_ext2_fs_ops;
 242 extern struct mds_fs_operations mds_ext3_fs_ops;
 243 extern struct mds_fs_operations mds_extN_fs_ops;
 244
 245 #endif /* __KERNEL__ */
 246
 247 /* ioctls for trying requests */
 248 #define IOC_REQUEST_TYPE                   'f'
 249 #define IOC_REQUEST_MIN_NR                 30
 250
 251 #define IOC_REQUEST_GETATTR             _IOWR('f', 30, long)
 252 #define IOC_REQUEST_READPAGE            _IOWR('f', 31, long)
 253 #define IOC_REQUEST_SETATTR             _IOWR('f', 32, long)
 254 #define IOC_REQUEST_CREATE              _IOWR('f', 33, long)
 255 #define IOC_REQUEST_OPEN                _IOWR('f', 34, long)
 256 #define IOC_REQUEST_CLOSE               _IOWR('f', 35, long)
 257 #define IOC_REQUEST_MAX_NR               35
 258
 259 #endif