Whamcloud - gitweb
- documentation updates for the collaborative cache
[fs/lustre-release.git] / 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. <info@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/fs.h>
32 #include <linux/lustre_idl.h>
33
34 struct ldlm_lock_desc;
35 struct lov_stripe_md;
36 struct mds_obd;
37 struct ptlrpc_connection;
38 struct ptlrpc_client;
39 struct obd_export;
40 struct ptlrpc_request;
41 struct obd_device;
42
43 #define LUSTRE_MDS_NAME "mds"
44 #define LUSTRE_MDC_NAME "mdc"
45
46 struct mds_update_record {
47         __u32 ur_fsuid;
48         __u32 ur_fsgid;
49         __u32 ur_opcode;
50         struct ll_fid *ur_fid1;
51         struct ll_fid *ur_fid2;
52         int ur_namelen;
53         char *ur_name;
54         int ur_tgtlen;
55         char *ur_tgt;
56         struct iattr ur_iattr;
57         __u64 ur_rdev;
58         __u32 ur_mode;
59         __u32 ur_uid;
60         __u32 ur_gid;
61         __u64 ur_time;
62 };
63
64 #define MDS_LR_CLIENT  8192
65 #define MDS_LR_SIZE     128
66
67 #define MDS_CLIENT_SLOTS 17
68
69 #define MDS_MOUNT_RECOV 2
70
71 /* Data stored per server at the head of the last_rcvd file.  In le32 order. */
72 struct mds_server_data {
73         __u8 msd_uuid[37];      /* server UUID */
74         __u8 uuid_padding[3];   /* unused */
75         __u64 msd_last_rcvd;    /* last completed transaction ID */
76         __u64 msd_mount_count;  /* MDS incarnation number */
77         __u8 padding[512 - 56];
78 };
79
80 /* Data stored per client in the last_rcvd file.  In le32 order. */
81 struct mds_client_data {
82         __u8 mcd_uuid[37];      /* client UUID */
83         __u8 uuid_padding[3];   /* unused */
84         __u64 mcd_last_rcvd;    /* last completed transaction ID */
85         __u64 mcd_mount_count;  /* MDS incarnation number */
86         __u64 mcd_last_xid;     /* client RPC xid for the last transaction */
87         __u8 padding[MDS_LR_SIZE - 64];
88 };
89
90 /* In-memory access to client data from MDS struct */
91 struct mds_export_data {
92         struct list_head        med_open_head;
93         struct mds_client_data *med_mcd;
94         int                     med_off;
95 };
96
97 /* file data for open files on MDS */
98 struct mds_file_data {
99         struct list_head  mfd_list;
100         struct file      *mfd_file;
101         __u64             mfd_clientfd;
102         __u32             mfd_clientcookie;
103 };
104
105 /* mds/mds_reint.c  */
106 int mds_reint_rec(struct mds_update_record *r, int offset,
107                   struct ptlrpc_request *req);
108
109 /* lib/mds_updates.c */
110 void mds_unpack_body(struct mds_body *b);
111 void mds_unpack_fid(struct ll_fid *fid);
112 void mds_pack_fid(struct ll_fid *fid);
113 void mds_pack_req_body(struct ptlrpc_request *);
114 void mds_pack_rep_body(struct ptlrpc_request *);
115 int mds_update_unpack(struct ptlrpc_request *, int offset,
116                       struct mds_update_record *);
117
118 void mds_getattr_pack(struct ptlrpc_request *req, int offset,
119                       struct inode *inode, const char *name, int namelen);
120 void mds_setattr_pack(struct ptlrpc_request *, int offset, struct inode *,
121                       struct iattr *, const char *name, int namelen);
122 void mds_create_pack(struct ptlrpc_request *, int offset, struct inode *,
123                      __u32 mode, __u64 id, __u32 uid, __u32 gid, __u64 time,
124                      const char *name, int namelen, const char *tgt,
125                      int tgtlen);
126 void mds_unlink_pack(struct ptlrpc_request *, int offset, struct inode *inode,
127                      struct inode *child, __u32 mode, const char *name,
128                      int namelen);
129 void mds_link_pack(struct ptlrpc_request *, int offset, struct inode *ino,
130                    struct inode *dir, const char *name, int namelen);
131 void mds_rename_pack(struct ptlrpc_request *, int offset, struct inode *srcdir,
132                      struct inode *tgtdir, const char *name, int namelen,
133                      const char *tgt, int tgtlen);
134 void mds_pack_inode2fid(struct ll_fid *fid, struct inode *inode);
135 void mds_pack_inode2body(struct mds_body *body, struct inode *inode);
136
137 /* mds/handler.c */
138 struct dentry *mds_name2locked_dentry(struct obd_device *, struct dentry *dir,
139                                       struct vfsmount **mnt, char *name,
140                                       int namelen, int lock_mode,
141                                       struct lustre_handle *lockh,
142                                       int dir_lock_mode);
143 struct dentry *mds_fid2locked_dentry(struct obd_device *obd, struct ll_fid *fid,
144                                      struct vfsmount **mnt, int lock_mode,
145                                      struct lustre_handle *lockh);
146 struct dentry *mds_fid2dentry(struct mds_obd *mds, struct ll_fid *fid,
147                               struct vfsmount **mnt);
148 int mds_reint(int offset, struct ptlrpc_request *req);
149
150 /* mdc/mdc_request.c */
151 int mdc_enqueue(struct lustre_handle *conn, int lock_type,
152                 struct lookup_intent *it, int lock_mode, struct inode *dir,
153                 struct dentry *de, struct lustre_handle *lockh, char *tgt,
154                 int tgtlen, void *data, int datalen);
155 int mdc_getlovinfo(struct obd_device *obd, struct lustre_handle *mdc_connh,
156                    struct ptlrpc_request **request);
157 int mdc_getstatus(struct lustre_handle *conn,
158                   struct ll_fid *rootfid, __u64 *last_committed,
159                   __u64 *last_xid, struct ptlrpc_request **);
160 int mdc_getattr(struct lustre_handle *conn,
161                 obd_id ino, int type, unsigned long valid, size_t ea_size,
162                 struct ptlrpc_request **request);
163 int mdc_statfs(struct lustre_handle *conn, struct obd_statfs *osfs,
164                struct ptlrpc_request **request);
165 int mdc_setattr(struct lustre_handle *conn,
166                 struct inode *, struct iattr *iattr, struct ptlrpc_request **);
167 int mdc_open(struct lustre_handle *conn, obd_id ino, int type, int flags,
168              struct lov_stripe_md *, __u64 cookie,  __u64 *fh,
169              struct ptlrpc_request **);
170 int mdc_close(struct lustre_handle *conn,
171               obd_id ino, int type, __u64 fh,  struct ptlrpc_request **req);
172 int mdc_readpage(struct lustre_handle *conn, obd_id ino,
173                  int type, __u64 offset, char *addr, struct ptlrpc_request **);
174 int mdc_create(struct lustre_handle *conn,
175                struct inode *dir, const char *name, int namelen,
176                const char *tgt, int tgtlen, int mode, __u32 uid, __u32 gid,
177                __u64 time, __u64 rdev, struct lov_stripe_md *md,
178                struct ptlrpc_request **);
179 int mdc_unlink(struct lustre_handle *, struct inode *dir, struct inode *child,
180                __u32 mode, const char *name, int namelen,
181                struct ptlrpc_request **);
182 int mdc_link(struct lustre_handle *conn,
183              struct dentry *src, struct inode *dir, const char *name,
184              int namelen, struct ptlrpc_request **);
185 int mdc_rename(struct lustre_handle *conn,
186                struct inode *src, struct inode *tgt, const char *old,
187                int oldlen, const char *new, int newlen,
188                struct ptlrpc_request **);
189 int mdc_create_client(obd_uuid_t uuid, struct ptlrpc_client *cl);
190
191 extern int mds_client_add(struct mds_export_data *med, int cl_off);
192 extern int mds_client_free(struct obd_export *exp);
193
194 /* mds/mds_fs.c */
195 struct mds_fs_operations {
196         struct module *fs_owner;
197         void   *(* fs_start)(struct inode *inode, int op);
198         int     (* fs_commit)(struct inode *inode, void *handle);
199         int     (* fs_setattr)(struct dentry *dentry, void *handle,
200                                struct iattr *iattr);
201         int     (* fs_set_md)(struct inode *inode, void *handle,
202                               struct lov_mds_md *md);
203         int     (* fs_get_md)(struct inode *inode,
204                               struct lov_mds_md *md);
205         ssize_t (* fs_readpage)(struct file *file, char *buf, size_t count,
206                                 loff_t *offset);
207         void    (* fs_delete_inode)(struct inode *inode);
208         void    (* cl_delete_inode)(struct inode *inode);
209         int     (* fs_journal_data)(struct file *file);
210         int     (* fs_set_last_rcvd)(struct mds_obd *mds, void *handle);
211         int     (* fs_statfs)(struct super_block *sb, struct statfs *sfs);
212 };
213
214 extern int mds_register_fs_type(struct mds_fs_operations *op, const char *name);
215 extern void mds_unregister_fs_type(const char *name);
216 extern int mds_fs_setup(struct obd_device *obddev, struct vfsmount *mnt);
217 extern void mds_fs_cleanup(struct obd_device *obddev);
218
219 #define MDS_FSOP_UNLINK         1
220 #define MDS_FSOP_RMDIR          2
221 #define MDS_FSOP_RENAME         3
222 #define MDS_FSOP_CREATE         4
223 #define MDS_FSOP_MKDIR          5
224 #define MDS_FSOP_SYMLINK        6
225 #define MDS_FSOP_MKNOD          7
226 #define MDS_FSOP_SETATTR        8
227 #define MDS_FSOP_LINK           9
228
229 #endif /* __KERNEL__ */
230
231 /* ioctls for trying requests */
232 #define IOC_REQUEST_TYPE                   'f'
233 #define IOC_REQUEST_MIN_NR                 30
234
235 #define IOC_REQUEST_GETATTR             _IOWR('f', 30, long)
236 #define IOC_REQUEST_READPAGE            _IOWR('f', 31, long)
237 #define IOC_REQUEST_SETATTR             _IOWR('f', 32, long)
238 #define IOC_REQUEST_CREATE              _IOWR('f', 33, long)
239 #define IOC_REQUEST_OPEN                _IOWR('f', 34, long)
240 #define IOC_REQUEST_CLOSE               _IOWR('f', 35, long)
241 #define IOC_REQUEST_MAX_NR               35
242
243 #endif