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 #include <linux/lustre_dlm.h>
  35 #include <linux/obd_lov.h> /* for lov_md */
  36
  37 #define LUSTRE_MDS_NAME "mds"
  38 #define LUSTRE_MDC_NAME "mdc"
  39
  40 struct mds_update_record {
  41         __u32 ur_opcode;
  42         struct ll_fid *ur_fid1;
  43         struct ll_fid *ur_fid2;
  44         int ur_namelen;
  45         char *ur_name;
  46         int ur_tgtlen;
  47         char *ur_tgt;
  48         struct iattr ur_iattr;
  49         __u64 ur_rdev;
  50         __u32 ur_mode;
  51         __u32 ur_uid;
  52         __u32 ur_gid;
  53         __u64 ur_time;
  54 };
  55
  56 struct mds_objid {
  57         __u64 mo_magic;
  58         struct lov_md mo_lov_md;
  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, int offset,
 105                   struct ptlrpc_request *req);
 106 struct mds_client_info *mds_uuid_to_mci(struct mds_obd *mds, __u8 *uuid);
 107
 108 /* lib/mds_updates.c */
 109 void mds_unpack_body(struct mds_body *b);
 110 void mds_pack_req_body(struct ptlrpc_request *);
 111 void mds_pack_rep_body(struct ptlrpc_request *);
 112 int mds_update_unpack(struct ptlrpc_request *, int offset,
 113                       struct mds_update_record *);
 114
 115 void mds_getattr_pack(struct ptlrpc_request *req, int offset,
 116                       struct inode *inode,
 117                       const char *name, int namelen);
 118 void mds_setattr_pack(struct ptlrpc_request *, int offset, struct inode *,
 119                       struct iattr *, const char *name, int namelen);
 120 void mds_create_pack(struct ptlrpc_request *, int offset, struct inode *,
 121                      __u32 mode, __u64 id, __u32 uid, __u32 gid, __u64 time,
 122                      const char *name, int namelen, const char *tgt,
 123                      int tgtlen);
 124 void mds_unlink_pack(struct ptlrpc_request *, int offset, struct inode *inode,
 125                      struct inode *child, const char *name, int namelen);
 126 void mds_link_pack(struct ptlrpc_request *, int offset, struct inode *ino,
 127                    struct inode *dir, const char *name, int namelen);
 128 void mds_rename_pack(struct ptlrpc_request *, int offset, struct inode *srcdir,
 129                      struct inode *tgtdir, const char *name, int namelen,
 130                      const char *tgt, int tgtlen);
 131 void mds_pack_inode2fid(struct ll_fid *fid, struct inode *inode);
 132 void mds_pack_inode2body(struct mds_body *body, struct inode *inode);
 133
 134 /* mds/handler.c */
 135 struct dentry *mds_fid2dentry(struct mds_obd *mds, struct ll_fid *fid, struct vfsmount **mnt);
 136 int mds_lock_callback(struct ldlm_lock *lock, struct ldlm_lock *new,
 137                       void *data, int data_len, struct ptlrpc_request **req);
 138 int mds_reint(int offset, struct ptlrpc_request *req);
 139
 140 /* mdc/mdc_request.c */
 141 static inline struct mdc_obd *mdc_conn2mdc(struct obd_conn *conn)
 142 {
 143         return &conn->oc_dev->u.mdc;
 144 }
 145
 146 int mdc_enqueue(struct obd_conn *conn, int lock_type, struct lookup_intent *it,
 147                 int lock_mode, struct inode *dir, struct dentry *de,
 148                 struct lustre_handle *h, __u64 id, char *tgt, int tgtlen,
 149                 void *data, int datalen);
 150 int mdc_getstatus(struct obd_conn *conn,
 151                 struct ll_fid *rootfid, __u64 *last_committed, __u64 *last_rcvd,
 152                 __u32 *last_xid, struct ptlrpc_request **);
 153 int mdc_getattr(struct obd_conn *conn,
 154                 ino_t ino, int type, unsigned long valid, size_t ea_size,
 155                 struct ptlrpc_request **request);
 156 int mdc_setattr(struct obd_conn *conn,
 157                 struct inode *, struct iattr *iattr, struct ptlrpc_request **);
 158 int mdc_open(struct obd_conn *conn,
 159              ino_t ino, int type, int flags, struct obdo *obdo, __u64 cookie,
 160              __u64 *fh, struct ptlrpc_request **request);
 161 int mdc_close(struct obd_conn *conn,
 162               ino_t ino, int type, __u64 fh,  struct ptlrpc_request **req);
 163 int mdc_readpage(struct obd_conn *conn, ino_t ino,
 164                  int type, __u64 offset, char *addr, struct ptlrpc_request **);
 165 int mdc_create(struct obd_conn *conn,
 166                struct inode *dir, const char *name, int namelen,
 167                const char *tgt, int tgtlen, int mode, __u32 uid, __u32 gid,
 168                __u64 time, __u64 rdev, struct obdo *obdo,
 169                struct ptlrpc_request **);
 170 int mdc_unlink(struct obd_conn *conn,
 171                struct inode *dir, struct inode *child, const char *name,
 172                int namelen, struct ptlrpc_request **);
 173 int mdc_link(struct obd_conn *conn,
 174              struct dentry *src, struct inode *dir, const char *name,
 175              int namelen, struct ptlrpc_request **);
 176 int mdc_rename(struct obd_conn *conn,
 177                struct inode *src, struct inode *tgt, const char *old,
 178                int oldlen, const char *new, int newlen,
 179                struct ptlrpc_request **);
 180 int mdc_create_client(char *uuid, struct ptlrpc_client *cl);
 181
 182 extern int mds_client_add(struct mds_obd *mds, struct mds_client_data *mcd,
 183                           int cl_off);
 184
 185 /* mds/mds_fs.c */
 186 struct mds_fs_operations {
 187         void   *(* fs_start)(struct inode *inode, int op);
 188         int     (* fs_commit)(struct inode *inode, void *handle);
 189         int     (* fs_setattr)(struct dentry *dentry, void *handle,
 190                                struct iattr *iattr);
 191         int     (* fs_set_obdo)(struct inode *inode, void *handle,
 192                                 struct obdo *obdo);
 193         int     (* fs_get_obdo)(struct inode *inode, struct obdo *obdo);
 194         ssize_t (* fs_readpage)(struct file *file, char *buf, size_t count,
 195                                 loff_t *offset);
 196         void    (* fs_delete_inode)(struct inode *inode);
 197         void    (* cl_delete_inode)(struct inode *inode);
 198         int     (* fs_journal_data)(struct file *file);
 199         int     (* fs_set_last_rcvd)(struct mds_obd *mds, void *handle);
 200 };
 201
 202 extern int mds_register_fs_type(struct mds_fs_operations *op, const char *name);
 203 extern void mds_unregister_fs_type(const char *name);
 204 extern int mds_fs_setup(struct mds_obd *mds, struct vfsmount *mnt);
 205 extern void mds_fs_cleanup(struct mds_obd *mds);
 206
 207 static inline void *mds_fs_start(struct mds_obd *mds, struct inode *inode,
 208                                  int op)
 209 {
 210         return mds->mds_fsops->fs_start(inode, op);
 211 }
 212
 213 static inline int mds_fs_commit(struct mds_obd *mds, struct inode *inode,
 214                                 void *handle)
 215 {
 216         return mds->mds_fsops->fs_commit(inode, handle);
 217 }
 218
 219 static inline int mds_fs_setattr(struct mds_obd *mds, struct dentry *dentry,
 220                                  void *handle, struct iattr *iattr)
 221 {
 222         /*
 223          * NOTE: we probably don't need to take i_sem here when changing
 224          *       ATTR_SIZE because the MDS never needs to truncate a file.
 225          *       The ext2/ext3 code never truncates a directory, and files
 226          *       stored on the MDS are entirely sparse (no data blocks).
 227          *       If we do need to get it, we can do it here.
 228          */
 229         return mds->mds_fsops->fs_setattr(dentry, handle, iattr);
 230 }
 231
 232 static inline int mds_fs_set_obdo(struct mds_obd *mds, struct inode *inode,
 233                                   void *handle, struct obdo *obdo)
 234 {
 235         return mds->mds_fsops->fs_set_obdo(inode, handle, obdo);
 236 }
 237
 238 static inline int mds_fs_get_obdo(struct mds_obd *mds, struct inode *inode,
 239                                   struct obdo *obdo)
 240 {
 241         return mds->mds_fsops->fs_get_obdo(inode, obdo);
 242 }
 243
 244 static inline ssize_t mds_fs_readpage(struct mds_obd *mds, struct file *file,
 245                                       char *buf, size_t count, loff_t *offset)
 246 {
 247         return mds->mds_fsops->fs_readpage(file, buf, count, offset);
 248 }
 249
 250 /* Set up callback to update mds->mds_last_committed with the current
 251  * value of mds->mds_last_recieved when this transaction is on disk.
 252  */
 253 static inline int mds_fs_set_last_rcvd(struct mds_obd *mds, void *handle)
 254 {
 255         return mds->mds_fsops->fs_set_last_rcvd(mds, handle);
 256 }
 257
 258 /* Enable data journaling on the given file */
 259 static inline ssize_t mds_fs_journal_data(struct mds_obd *mds,
 260                                           struct file *file)
 261 {
 262         return mds->mds_fsops->fs_journal_data(file);
 263 }
 264
 265 #define MDS_FSOP_UNLINK         1
 266 #define MDS_FSOP_RMDIR          2
 267 #define MDS_FSOP_RENAME         3
 268 #define MDS_FSOP_CREATE         4
 269 #define MDS_FSOP_MKDIR          5
 270 #define MDS_FSOP_SYMLINK        6
 271 #define MDS_FSOP_MKNOD          7
 272 #define MDS_FSOP_SETATTR        8
 273 #define MDS_FSOP_LINK           9
 274
 275 #endif /* __KERNEL__ */
 276
 277 /* ioctls for trying requests */
 278 #define IOC_REQUEST_TYPE                   'f'
 279 #define IOC_REQUEST_MIN_NR                 30
 280
 281 #define IOC_REQUEST_GETATTR             _IOWR('f', 30, long)
 282 #define IOC_REQUEST_READPAGE            _IOWR('f', 31, long)
 283 #define IOC_REQUEST_SETATTR             _IOWR('f', 32, long)
 284 #define IOC_REQUEST_CREATE              _IOWR('f', 33, long)
 285 #define IOC_REQUEST_OPEN                _IOWR('f', 34, long)
 286 #define IOC_REQUEST_CLOSE               _IOWR('f', 35, long)
 287 #define IOC_REQUEST_MAX_NR               35
 288
 289 #endif