Whamcloud - gitweb
efc130b5201ab84c67e6a35e3ea30dccfdf3bf17
[fs/lustre-release.git] / lustre / liblustre / llite_lib.h
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  * GPL HEADER START
5  *
6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 only,
10  * as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License version 2 for more details (a copy is included
16  * in the LICENSE file that accompanied this code).
17  *
18  * You should have received a copy of the GNU General Public License
19  * version 2 along with this program; If not, see
20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
21  *
22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23  * CA 95054 USA or visit www.sun.com if you need additional information or
24  * have any questions.
25  *
26  * GPL HEADER END
27  */
28 /*
29  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
30  * Use is subject to license terms.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  */
36
37 #ifndef __LLU_H_
38 #define __LLU_H_
39 #include <fcntl.h>
40 #include <sys/queue.h>
41 #include <sysio.h>
42 #ifdef HAVE_XTIO_H
43 #include <xtio.h>
44 #endif
45 #include <fs.h>
46 #include <mount.h>
47 #include <inode.h>
48 #ifdef HAVE_FILE_H
49 #include <file.h>
50 #endif
51
52 #include <liblustre.h>
53 #include <obd.h>
54 #include <obd_class.h>
55 #include <lustre_mdc.h>
56 #include <lustre_lite.h>
57 #include <lustre_ver.h>
58
59 #include <sys/types.h>
60 #include <sys/stat.h>
61
62 /* for struct cl_lock_descr and struct cl_io */
63 #include <cl_object.h>
64 #include <lclient.h>
65
66 /* This should not be "optimized" use ~0ULL because page->index is a long and
67  * 32-bit systems are therefore limited to 16TB in a mapping */
68 #define PAGE_CACHE_MAXBYTES ((__u64)(~0UL) << CFS_PAGE_SHIFT)
69 struct ll_file_data {
70         struct obd_client_handle fd_mds_och;
71         __u32 fd_flags;
72         struct ccc_grouplock fd_grouplock;
73 };
74
75 struct llu_sb_info {
76         struct obd_uuid          ll_sb_uuid;
77         struct obd_export       *ll_md_exp;
78         struct obd_export       *ll_dt_exp;
79         struct lu_fid            ll_root_fid;
80         int                      ll_flags;
81         struct lustre_client_ocd ll_lco;
82         cfs_list_t               ll_conn_chain;
83
84         struct obd_uuid          ll_mds_uuid;
85         struct obd_uuid          ll_mds_peer_uuid;
86         char                    *ll_instance;
87         struct lu_site           *ll_site;
88         struct cl_device         *ll_cl;
89 };
90
91 #define LL_SBI_NOLCK            0x1
92
93 enum lli_flags {
94         /* MDS has an authority for the Size-on-MDS attributes. */
95         LLIF_MDS_SIZE_LOCK      = (1 << 0),
96 };
97
98 struct llu_inode_info {
99         struct llu_sb_info     *lli_sbi;
100         struct lu_fid           lli_fid;
101
102         struct lov_stripe_md   *lli_smd;
103         char                   *lli_symlink_name;
104         cfs_semaphore_t         lli_open_sem;
105         __u64                   lli_maxbytes;
106         unsigned long           lli_flags;
107         __u64                   lli_ioepoch;
108
109         /* for libsysio */
110         struct file_identifier  lli_sysio_fid;
111
112         struct lookup_intent   *lli_it;
113
114         /* XXX workaround for libsysio readdir */
115         loff_t                  lli_dir_pos;
116
117         /* in libsysio we have no chance to store data in file,
118          * so place it here. since it's possible that an file
119          * was opened several times without close, we track an
120          * open_count here */
121         struct ll_file_data    *lli_file_data;
122         int                     lli_open_flags;
123         int                     lli_open_count;
124
125         /* not for stat, change it later */
126         int                     lli_st_flags;
127         unsigned long           lli_st_generation;
128         struct cl_object       *lli_clob;
129         /* the most recent timestamps obtained from mds */
130         struct ost_lvb          lli_lvb;
131 };
132
133 static inline struct llu_sb_info *llu_fs2sbi(struct filesys *fs)
134 {
135         return (struct llu_sb_info*)(fs->fs_private);
136 }
137
138 static inline struct llu_inode_info *llu_i2info(struct inode *inode)
139 {
140         return (struct llu_inode_info*)(inode->i_private);
141 }
142
143 static inline int ll_inode_flags(struct inode *inode)
144 {
145         return llu_i2info(inode)->lli_st_flags;
146 }
147
148 static inline struct intnl_stat *llu_i2stat(struct inode *inode)
149 {
150         return &inode->i_stbuf;
151 }
152
153 #define ll_inode_blksize(inode)     (llu_i2stat(inode)->st_blksize)
154
155 static inline struct llu_sb_info *llu_i2sbi(struct inode *inode)
156 {
157         return llu_i2info(inode)->lli_sbi;
158 }
159
160 static inline struct obd_export *llu_i2obdexp(struct inode *inode)
161 {
162         return llu_i2info(inode)->lli_sbi->ll_dt_exp;
163 }
164
165 static inline struct obd_export *llu_i2mdexp(struct inode *inode)
166 {
167         return llu_i2info(inode)->lli_sbi->ll_md_exp;
168 }
169
170 static inline int llu_is_root_inode(struct inode *inode)
171 {
172         return (fid_seq(&llu_i2info(inode)->lli_fid) ==
173                 fid_seq(&llu_i2info(inode)->lli_sbi->ll_root_fid) &&
174                 fid_oid(&llu_i2info(inode)->lli_fid) ==
175                 fid_oid(&llu_i2info(inode)->lli_sbi->ll_root_fid));
176 }
177
178 #define LL_SAVE_INTENT(inode, it)                                              \
179 do {                                                                           \
180         struct lookup_intent *temp;                                            \
181         LASSERT(llu_i2info(inode)->lli_it == NULL);                            \
182         OBD_ALLOC(temp, sizeof(*temp));                                        \
183         memcpy(temp, it, sizeof(*temp));                                       \
184         llu_i2info(inode)->lli_it = temp;                                      \
185         CDEBUG(D_DENTRY, "alloc intent %p to inode %p(ino %llu)\n",            \
186                         temp, inode, (long long)llu_i2stat(inode)->st_ino);    \
187 } while(0)
188
189
190 #define LL_GET_INTENT(inode, it)                                               \
191 do {                                                                           \
192         it = llu_i2info(inode)->lli_it;                                        \
193                                                                                \
194         LASSERT(it);                                                           \
195         llu_i2info(inode)->lli_it = NULL;                                      \
196         CDEBUG(D_DENTRY, "dettach intent %p from inode %p(ino %llu)\n",        \
197                         it, inode, (long long)llu_i2stat(inode)->st_ino);      \
198 } while(0)
199
200 /* interpet return codes from intent lookup */
201 #define LL_LOOKUP_POSITIVE 1
202 #define LL_LOOKUP_NEGATIVE 2
203
204 static inline struct lu_fid *ll_inode2fid(struct inode *inode)
205 {
206         LASSERT(inode != NULL);
207         return &llu_i2info(inode)->lli_fid;
208 }
209
210 struct it_cb_data {
211         struct inode *icbd_parent;
212         struct pnode *icbd_child;
213         obd_id hash;
214 };
215
216 void ll_i2gids(__u32 *suppgids, struct inode *i1,struct inode *i2);
217
218 typedef int (*intent_finish_cb)(struct ptlrpc_request *,
219                                 struct inode *parent, struct pnode *pnode,
220                                 struct lookup_intent *, int offset, obd_id ino);
221 int llu_intent_lock(struct inode *parent, struct pnode *pnode,
222                     struct lookup_intent *, int flags, intent_finish_cb);
223
224 static inline __u64 ll_file_maxbytes(struct inode *inode)
225 {
226         return llu_i2info(inode)->lli_maxbytes;
227 }
228
229 struct mount_option_s
230 {
231         char *md_uuid;
232         char *dt_uuid;
233 };
234
235 #define IS_BAD_PTR(ptr)         \
236         ((unsigned long)(ptr) == 0 || (unsigned long)(ptr) > -1000UL)
237
238 /* llite_lib.c */
239 int liblustre_process_log(struct config_llog_instance *cfg, char *mgsnid,
240                           char *profile, int allow_recov);
241 int ll_parse_mount_target(const char *target, char **mgsnid,
242                           char **fsname);
243
244 extern struct mount_option_s mount_option;
245
246 /* super.c */
247 void llu_update_inode(struct inode *inode, struct lustre_md *md);
248 void obdo_to_inode(struct inode *dst, struct obdo *src, obd_flag valid);
249 int ll_it_open_error(int phase, struct lookup_intent *it);
250 struct inode *llu_iget(struct filesys *fs, struct lustre_md *md);
251 int llu_inode_getattr(struct inode *inode, struct obdo *obdo,
252                       __u64 ioepoch, int sync);
253 int llu_md_setattr(struct inode *inode, struct md_op_data *op_data,
254                    struct md_open_data **mod);
255 int llu_setattr_raw(struct inode *inode, struct iattr *attr);
256 int llu_put_grouplock(struct inode *inode, unsigned long arg);
257
258 extern struct fssw_ops llu_fssw_ops;
259
260 /* file.c */
261 void llu_prep_md_op_data(struct md_op_data *op_data, struct inode *i1,
262                          struct inode *i2, const char *name, int namelen,
263                          int mode, __u32 opc);
264 void llu_finish_md_op_data(struct md_op_data *op_data);
265 int llu_create(struct inode *dir, struct pnode_base *pnode, int mode);
266 int llu_local_open(struct llu_inode_info *lli, struct lookup_intent *it);
267 int llu_iop_open(struct pnode *pnode, int flags, mode_t mode);
268 void llu_done_writing_attr(struct inode *inode, struct md_op_data *op_data);
269 int llu_md_close(struct obd_export *md_exp, struct inode *inode);
270 void llu_pack_inode2opdata(struct inode *inode, struct md_op_data *op_data,
271                            struct lustre_handle *fh);
272 int llu_file_release(struct inode *inode);
273 int llu_som_update(struct inode *inode, struct md_op_data *op_data);
274 int llu_iop_close(struct inode *inode);
275 _SYSIO_OFF_T llu_iop_pos(struct inode *ino, _SYSIO_OFF_T off);
276 int llu_vmtruncate(struct inode * inode, loff_t offset, obd_flag obd_flags);
277 void obdo_refresh_inode(struct inode *dst, struct obdo *src, obd_flag valid);
278 int llu_objects_destroy(struct ptlrpc_request *request, struct inode *dir);
279 void llu_ioepoch_open(struct llu_inode_info *lli, __u64 ioepoch);
280
281 /* rw.c */
282 int llu_iop_read(struct inode *ino, struct ioctx *ioctxp);
283 int llu_iop_write(struct inode *ino, struct ioctx *ioctxp);
284 int llu_iop_iodone(struct ioctx *ioctxp);
285 int llu_glimpse_size(struct inode *inode);
286 int llu_extent_lock(struct ll_file_data *fd, struct inode *inode,
287                     struct lov_stripe_md *lsm, int mode,
288                     ldlm_policy_data_t *policy, struct lustre_handle *lockh,
289                     int ast_flags);
290 int llu_extent_unlock(struct ll_file_data *fd, struct inode *inode,
291                       struct lov_stripe_md *lsm, int mode,
292                       struct lustre_handle *lockh);
293
294 /* namei.c */
295 int llu_iop_lookup(struct pnode *pnode,
296                    struct inode **inop,
297                    struct intent *intnt,
298                    const char *path);
299 void unhook_stale_inode(struct pnode *pno);
300 struct inode *llu_inode_from_lock(struct ldlm_lock *lock);
301 int llu_md_blocking_ast(struct ldlm_lock *lock,
302                         struct ldlm_lock_desc *desc,
303                         void *data, int flag);
304
305 /* dir.c */
306 ssize_t llu_iop_filldirentries(struct inode *ino, _SYSIO_OFF_T *basep,
307                                char *buf, size_t nbytes);
308
309 /* liblustre/llite_fid.c*/
310 unsigned long llu_fid_build_ino(struct llu_sb_info *sbi,
311                                 struct lu_fid *fid);
312
313 /* ext2 related */
314 #define EXT2_NAME_LEN (255)
315
316 struct ext2_dirent {
317         __u32   inode;
318         __u16   rec_len;
319         __u8    name_len;
320         __u8    file_type;
321         char    name[EXT2_NAME_LEN];
322 };
323
324 #define EXT2_DIR_PAD                    4
325 #define EXT2_DIR_ROUND                  (EXT2_DIR_PAD - 1)
326 #define EXT2_DIR_REC_LEN(name_len)      (((name_len) + 8 + EXT2_DIR_ROUND) & \
327                                          ~EXT2_DIR_ROUND)
328
329 static inline struct ext2_dirent *ext2_next_entry(struct ext2_dirent *p)
330 {
331         return (struct ext2_dirent*)((char*) p + le16_to_cpu(p->rec_len));
332 }
333
334 int llu_merge_lvb(struct inode *inode);
335
336 static inline void inode_init_lvb(struct inode *inode, struct ost_lvb *lvb)
337 {
338         struct intnl_stat *st = llu_i2stat(inode);
339         lvb->lvb_size = st->st_size;
340         lvb->lvb_blocks = st->st_blocks;
341         lvb->lvb_mtime = st->st_mtime;
342         lvb->lvb_atime = st->st_atime;
343         lvb->lvb_ctime = st->st_ctime;
344 }
345
346 #define LLU_IO_GROUP_SIZE(x) \
347         (sizeof(struct llu_io_group) + \
348          (sizeof(struct ll_async_page) + \
349           sizeof(cfs_page_t) + \
350           llap_cookie_size) * (x))
351
352 struct llu_io_session {
353         struct inode           *lis_inode;
354         int                     lis_cmd;
355         int                     lis_max_groups;
356         int                     lis_ngroups;
357         int                     lis_rc;
358         __u64                   lis_rwcount;
359 };
360
361 struct llu_io_group
362 {
363         struct lustre_rw_params *lig_params;
364         int                     lig_rc;
365         __u64                   lig_rwcount;
366 };
367
368 struct llu_io_session;
369 void put_io_group(struct llu_io_group *group);
370
371 int cl_sb_init(struct llu_sb_info *sbi);
372 int cl_sb_fini(struct llu_sb_info *sbi);
373 int cl_inode_init(struct inode *inode, struct lustre_md *md);
374 void cl_inode_fini(struct inode *inode);
375
376 void llu_io_init(struct cl_io *io, struct inode *inode, int write);
377
378 struct slp_io {
379         struct llu_io_session *sio_session;
380 };
381
382 struct slp_session {
383         struct slp_io ss_ios;
384 };
385
386 static inline struct slp_session *slp_env_session(const struct lu_env *env)
387 {
388         extern struct lu_context_key slp_session_key;
389         struct slp_session *ses;
390         ses = lu_context_key_get(env->le_ses, &slp_session_key);
391         LASSERT(ses != NULL);
392         return ses;
393 }
394 static inline struct slp_io *slp_env_io(const struct lu_env *env)
395 {
396         return &slp_env_session(env)->ss_ios;
397 }
398
399 /* lclient compat stuff */
400 #define cl_inode_info llu_inode_info
401 #define cl_i2info(info) llu_i2info(info)
402 #define cl_inode_mode(inode) (llu_i2stat(inode)->st_mode)
403 #define cl_i2sbi llu_i2sbi
404 #define cl_isize_read(inode)             (llu_i2stat(inode)->st_size)
405 #define cl_isize_write(inode,kms)        do{llu_i2stat(inode)->st_size = kms;}while(0)
406 #define cl_isize_write_nolock(inode,kms) cl_isize_write(inode,kms)
407
408 static inline void cl_isize_lock(struct inode *inode, int lsmlock)
409 {
410 }
411
412 static inline void cl_isize_unlock(struct inode *inode, int lsmlock)
413 {
414 }
415
416 static inline int cl_merge_lvb(struct inode *inode)
417 {
418         return llu_merge_lvb(inode);
419 }
420
421 #define cl_inode_atime(inode) (llu_i2stat(inode)->st_atime)
422 #define cl_inode_ctime(inode) (llu_i2stat(inode)->st_ctime)
423 #define cl_inode_mtime(inode) (llu_i2stat(inode)->st_mtime)
424
425 static inline struct obd_capa *cl_capa_lookup(struct inode *inode,
426                                               enum cl_req_type crt)
427 {
428         return NULL;
429 }
430
431 #endif