Whamcloud - gitweb
b=18881
[fs/lustre-release.git] / lustre / lclient / lcommon_cl.c
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 2008 Sun Microsystems, Inc.  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  * cl code shared between vvp and liblustre (and other Lustre clients in the
37  * future).
38  *
39  *   Author: Nikita Danilov <nikita.danilov@sun.com>
40  */
41
42 #define DEBUG_SUBSYSTEM S_LLITE
43
44 #ifdef __KERNEL__
45 # include <libcfs/libcfs.h>
46 # include <linux/fs.h>
47 # include <linux/sched.h>
48 # include <linux/mm.h>
49 # include <linux/smp_lock.h>
50 # include <linux/quotaops.h>
51 # include <linux/highmem.h>
52 # include <linux/pagemap.h>
53 # include <linux/rbtree.h>
54 #else /* __KERNEL__ */
55 #include <stdlib.h>
56 #include <string.h>
57 #include <assert.h>
58 #include <time.h>
59 #include <sys/types.h>
60 #include <sys/stat.h>
61 #include <sys/queue.h>
62 #include <fcntl.h>
63 # include <sysio.h>
64 # ifdef HAVE_XTIO_H
65 #  include <xtio.h>
66 # endif
67 # include <fs.h>
68 # include <mount.h>
69 # include <inode.h>
70 # ifdef HAVE_FILE_H
71 #  include <file.h>
72 # endif
73 # include <liblustre.h>
74 #endif
75
76 #include <obd.h>
77 #include <obd_support.h>
78 #include <lustre_fid.h>
79 #include <lustre_lite.h>
80 #include <lustre_dlm.h>
81 #include <lustre_ver.h>
82 #include <lustre_mdc.h>
83 #include <cl_object.h>
84
85 #include <lclient.h>
86
87 #ifdef __KERNEL__
88 #include "../llite/llite_internal.h"
89 #else
90 #include "../liblustre/llite_lib.h"
91 #endif
92
93 const struct cl_req_operations ccc_req_ops;
94
95 /*
96  * ccc_ prefix stands for "Common Client Code".
97  */
98
99 static cfs_mem_cache_t *ccc_lock_kmem;
100 static cfs_mem_cache_t *ccc_object_kmem;
101 static cfs_mem_cache_t *ccc_thread_kmem;
102 static cfs_mem_cache_t *ccc_session_kmem;
103 static cfs_mem_cache_t *ccc_req_kmem;
104
105 static struct lu_kmem_descr ccc_caches[] = {
106         {
107                 .ckd_cache = &ccc_lock_kmem,
108                 .ckd_name  = "ccc_lock_kmem",
109                 .ckd_size  = sizeof (struct ccc_lock)
110         },
111         {
112                 .ckd_cache = &ccc_object_kmem,
113                 .ckd_name  = "ccc_object_kmem",
114                 .ckd_size  = sizeof (struct ccc_object)
115         },
116         {
117                 .ckd_cache = &ccc_thread_kmem,
118                 .ckd_name  = "ccc_thread_kmem",
119                 .ckd_size  = sizeof (struct ccc_thread_info),
120         },
121         {
122                 .ckd_cache = &ccc_session_kmem,
123                 .ckd_name  = "ccc_session_kmem",
124                 .ckd_size  = sizeof (struct ccc_session)
125         },
126         {
127                 .ckd_cache = &ccc_req_kmem,
128                 .ckd_name  = "ccc_req_kmem",
129                 .ckd_size  = sizeof (struct ccc_req)
130         },
131         {
132                 .ckd_cache = NULL
133         }
134 };
135
136 /*****************************************************************************
137  *
138  * Vvp device and device type functions.
139  *
140  */
141
142 void *ccc_key_init(const struct lu_context *ctx,
143                           struct lu_context_key *key)
144 {
145         struct ccc_thread_info *info;
146
147         OBD_SLAB_ALLOC_PTR_GFP(info, ccc_thread_kmem, CFS_ALLOC_IO);
148         if (info == NULL)
149                 info = ERR_PTR(-ENOMEM);
150         return info;
151 }
152
153 void ccc_key_fini(const struct lu_context *ctx,
154                          struct lu_context_key *key, void *data)
155 {
156         struct ccc_thread_info *info = data;
157         OBD_SLAB_FREE_PTR(info, ccc_thread_kmem);
158 }
159
160 void *ccc_session_key_init(const struct lu_context *ctx,
161                                   struct lu_context_key *key)
162 {
163         struct ccc_session *session;
164
165         OBD_SLAB_ALLOC_PTR_GFP(session, ccc_session_kmem, CFS_ALLOC_IO);
166         if (session == NULL)
167                 session = ERR_PTR(-ENOMEM);
168         return session;
169 }
170
171 void ccc_session_key_fini(const struct lu_context *ctx,
172                                  struct lu_context_key *key, void *data)
173 {
174         struct ccc_session *session = data;
175         OBD_SLAB_FREE_PTR(session, ccc_session_kmem);
176 }
177
178 struct lu_context_key ccc_key = {
179         .lct_tags = LCT_CL_THREAD,
180         .lct_init = ccc_key_init,
181         .lct_fini = ccc_key_fini
182 };
183
184 struct lu_context_key ccc_session_key = {
185         .lct_tags = LCT_SESSION,
186         .lct_init = ccc_session_key_init,
187         .lct_fini = ccc_session_key_fini
188 };
189
190
191 /* type constructor/destructor: ccc_type_{init,fini,start,stop}(). */
192 // LU_TYPE_INIT_FINI(ccc, &ccc_key, &ccc_session_key);
193
194 int ccc_device_init(const struct lu_env *env, struct lu_device *d,
195                            const char *name, struct lu_device *next)
196 {
197         struct ccc_device  *vdv;
198         int rc;
199         ENTRY;
200
201         vdv = lu2ccc_dev(d);
202         vdv->cdv_next = lu2cl_dev(next);
203
204         LASSERT(d->ld_site != NULL && next->ld_type != NULL);
205         next->ld_site = d->ld_site;
206         rc = next->ld_type->ldt_ops->ldto_device_init(
207                         env, next, next->ld_type->ldt_name, NULL);
208         if (rc == 0) {
209                 lu_device_get(next);
210                 lu_ref_add(&next->ld_reference, "lu-stack", &lu_site_init);
211         }
212         RETURN(rc);
213 }
214
215 struct lu_device *ccc_device_fini(const struct lu_env *env,
216                                          struct lu_device *d)
217 {
218         return cl2lu_dev(lu2ccc_dev(d)->cdv_next);
219 }
220
221 struct lu_device *ccc_device_alloc(const struct lu_env *env,
222                                    struct lu_device_type *t,
223                                    struct lustre_cfg *cfg,
224                                    const struct lu_device_operations *luops,
225                                    const struct cl_device_operations *clops)
226 {
227         struct ccc_device *vdv;
228         struct lu_device  *lud;
229         struct cl_site    *site;
230         int rc;
231         ENTRY;
232
233         OBD_ALLOC_PTR(vdv);
234         if (vdv == NULL)
235                 RETURN(ERR_PTR(-ENOMEM));
236
237         lud = &vdv->cdv_cl.cd_lu_dev;
238         cl_device_init(&vdv->cdv_cl, t);
239         ccc2lu_dev(vdv)->ld_ops = luops;
240         vdv->cdv_cl.cd_ops = clops;
241
242         OBD_ALLOC_PTR(site);
243         if (site != NULL) {
244                 rc = cl_site_init(site, &vdv->cdv_cl);
245                 if (rc == 0)
246                         rc = lu_site_init_finish(&site->cs_lu);
247                 else {
248                         LASSERT(lud->ld_site == NULL);
249                         CERROR("Cannot init lu_site, rc %d.\n", rc);
250                         OBD_FREE_PTR(site);
251                 }
252         } else
253                 rc = -ENOMEM;
254         if (rc != 0) {
255                 ccc_device_free(env, lud);
256                 lud = ERR_PTR(rc);
257         }
258         RETURN(lud);
259 }
260
261 struct lu_device *ccc_device_free(const struct lu_env *env,
262                                          struct lu_device *d)
263 {
264         struct ccc_device *vdv  = lu2ccc_dev(d);
265         struct cl_site    *site = lu2cl_site(d->ld_site);
266         struct lu_device  *next = cl2lu_dev(vdv->cdv_next);
267
268         if (d->ld_site != NULL) {
269                 cl_site_fini(site);
270                 OBD_FREE_PTR(site);
271         }
272         cl_device_fini(lu2cl_dev(d));
273         OBD_FREE_PTR(vdv);
274         return next;
275 }
276
277 int ccc_req_init(const struct lu_env *env, struct cl_device *dev,
278                         struct cl_req *req)
279 {
280         struct ccc_req *vrq;
281         int result;
282
283         OBD_SLAB_ALLOC_PTR_GFP(vrq, ccc_req_kmem, CFS_ALLOC_IO);
284         if (vrq != NULL) {
285                 cl_req_slice_add(req, &vrq->crq_cl, dev, &ccc_req_ops);
286                 result = 0;
287         } else
288                 result = -ENOMEM;
289         return result;
290 }
291
292 /**
293  * An `emergency' environment used by ccc_inode_fini() when cl_env_get()
294  * fails. Access to this environment is serialized by ccc_inode_fini_guard
295  * mutex.
296  */
297 static struct lu_env *ccc_inode_fini_env = NULL;
298
299 /**
300  * A mutex serializing calls to slp_inode_fini() under extreme memory
301  * pressure, when environments cannot be allocated.
302  */
303 static DEFINE_MUTEX(ccc_inode_fini_guard);
304 static int dummy_refcheck;
305
306 int ccc_global_init(struct lu_device_type *device_type)
307 {
308         int result;
309
310         result = lu_kmem_init(ccc_caches);
311         if (result == 0) {
312                 result = lu_device_type_init(device_type);
313                 ccc_inode_fini_env = cl_env_alloc(&dummy_refcheck,
314                                                   LCT_REMEMBER|LCT_NOREF);
315                 if (IS_ERR(ccc_inode_fini_env))
316                         result = PTR_ERR(ccc_inode_fini_env);
317                 else
318                         ccc_inode_fini_env->le_ctx.lc_cookie = 0x4;
319         }
320         return result;
321 }
322
323 void ccc_global_fini(struct lu_device_type *device_type)
324 {
325         if (ccc_inode_fini_env != NULL) {
326                 cl_env_put(ccc_inode_fini_env, &dummy_refcheck);
327                 ccc_inode_fini_env = NULL;
328         }
329         lu_device_type_fini(device_type);
330         lu_kmem_fini(ccc_caches);
331 }
332
333 /*****************************************************************************
334  *
335  * Object operations.
336  *
337  */
338
339 struct lu_object *ccc_object_alloc(const struct lu_env *env,
340                                    const struct lu_object_header *unused,
341                                    struct lu_device *dev,
342                                    const struct cl_object_operations *clops,
343                                    const struct lu_object_operations *luops)
344 {
345         struct ccc_object *vob;
346         struct lu_object  *obj;
347
348         OBD_SLAB_ALLOC_PTR_GFP(vob, ccc_object_kmem, CFS_ALLOC_IO);
349         if (vob != NULL) {
350                 struct cl_object_header *hdr;
351
352                 obj = ccc2lu(vob);
353                 hdr = &vob->cob_header;
354                 cl_object_header_init(hdr);
355                 lu_object_init(obj, &hdr->coh_lu, dev);
356                 lu_object_add_top(&hdr->coh_lu, obj);
357
358                 vob->cob_cl.co_ops = clops;
359                 obj->lo_ops = luops;
360         } else
361                 obj = NULL;
362         return obj;
363 }
364
365 int ccc_object_init0(const struct lu_env *env,
366                             struct ccc_object *vob,
367                             const struct cl_object_conf *conf)
368 {
369         vob->cob_inode = conf->coc_inode;
370         vob->cob_transient_pages = 0;
371         return 0;
372 }
373
374 int ccc_object_init(const struct lu_env *env, struct lu_object *obj,
375                            const struct lu_object_conf *conf)
376 {
377         struct ccc_device *dev = lu2ccc_dev(obj->lo_dev);
378         struct ccc_object *vob = lu2ccc(obj);
379         struct lu_object  *below;
380         struct lu_device  *under;
381         int result;
382
383         under = &dev->cdv_next->cd_lu_dev;
384         below = under->ld_ops->ldo_object_alloc(env, obj->lo_header, under);
385         if (below != NULL) {
386                 const struct cl_object_conf *cconf;
387
388                 cconf = lu2cl_conf(conf);
389                 CFS_INIT_LIST_HEAD(&vob->cob_pending_list);
390                 lu_object_add(obj, below);
391                 result = ccc_object_init0(env, vob, cconf);
392         } else
393                 result = -ENOMEM;
394         return result;
395 }
396
397 void ccc_object_free(const struct lu_env *env, struct lu_object *obj)
398 {
399         struct ccc_object *vob = lu2ccc(obj);
400
401         lu_object_fini(obj);
402         lu_object_header_fini(obj->lo_header);
403         OBD_SLAB_FREE_PTR(vob, ccc_object_kmem);
404 }
405
406 int ccc_lock_init(const struct lu_env *env,
407                   struct cl_object *obj, struct cl_lock *lock,
408                   const struct cl_io *unused,
409                   const struct cl_lock_operations *lkops)
410 {
411         struct ccc_lock *clk;
412         int result;
413
414         CLOBINVRNT(env, obj, ccc_object_invariant(obj));
415
416         OBD_SLAB_ALLOC_PTR_GFP(clk, ccc_lock_kmem, CFS_ALLOC_IO);
417         if (clk != NULL) {
418                 cl_lock_slice_add(lock, &clk->clk_cl, obj, lkops);
419                 result = 0;
420         } else
421                 result = -ENOMEM;
422         return result;
423 }
424
425 int ccc_attr_set(const struct lu_env *env, struct cl_object *obj,
426                  const struct cl_attr *attr, unsigned valid)
427 {
428         return 0;
429 }
430
431 int ccc_object_glimpse(const struct lu_env *env,
432                        const struct cl_object *obj, struct ost_lvb *lvb)
433 {
434         struct inode *inode = ccc_object_inode(obj);
435
436         ENTRY;
437         lvb->lvb_mtime = cl_inode_mtime(inode);
438         lvb->lvb_atime = cl_inode_atime(inode);
439         lvb->lvb_ctime = cl_inode_ctime(inode);
440         RETURN(0);
441 }
442
443
444
445 int ccc_conf_set(const struct lu_env *env, struct cl_object *obj,
446                         const struct cl_object_conf *conf)
447 {
448         /* TODO: destroy all pages attached to this object. */
449         return 0;
450 }
451
452 /*****************************************************************************
453  *
454  * Page operations.
455  *
456  */
457
458 cfs_page_t *ccc_page_vmpage(const struct lu_env *env,
459                             const struct cl_page_slice *slice)
460 {
461         return cl2vm_page(slice);
462 }
463
464 int ccc_page_is_under_lock(const struct lu_env *env,
465                            const struct cl_page_slice *slice,
466                            struct cl_io *io)
467 {
468         struct ccc_io        *cio  = ccc_env_io(env);
469         struct cl_lock_descr *desc = &ccc_env_info(env)->cti_descr;
470         struct cl_page       *page = slice->cpl_page;
471
472         int result;
473
474         ENTRY;
475
476         if (io->ci_type == CIT_READ || io->ci_type == CIT_WRITE ||
477             io->ci_type == CIT_FAULT) {
478                 if (cio->cui_fd->fd_flags & LL_FILE_GROUP_LOCKED)
479                         result = -EBUSY;
480                 else {
481                         desc->cld_start = page->cp_index;
482                         desc->cld_end   = page->cp_index;
483                         desc->cld_obj   = page->cp_obj;
484                         desc->cld_mode  = CLM_READ;
485                         result = cl_queue_match(&io->ci_lockset.cls_done,
486                                                 desc) ? -EBUSY : 0;
487                 }
488         } else
489                 result = 0;
490         RETURN(result);
491 }
492
493 int ccc_fail(const struct lu_env *env, const struct cl_page_slice *slice)
494 {
495         /*
496          * Cached read?
497          */
498         LBUG();
499         return 0;
500 }
501
502 void ccc_transient_page_verify(const struct cl_page *page)
503 {
504 }
505
506 int ccc_transient_page_own(const struct lu_env *env,
507                                    const struct cl_page_slice *slice,
508                                    struct cl_io *unused,
509                                    int nonblock)
510 {
511         ccc_transient_page_verify(slice->cpl_page);
512         return 0;
513 }
514
515 void ccc_transient_page_assume(const struct lu_env *env,
516                                       const struct cl_page_slice *slice,
517                                       struct cl_io *unused)
518 {
519         ccc_transient_page_verify(slice->cpl_page);
520 }
521
522 void ccc_transient_page_unassume(const struct lu_env *env,
523                                         const struct cl_page_slice *slice,
524                                         struct cl_io *unused)
525 {
526         ccc_transient_page_verify(slice->cpl_page);
527 }
528
529 void ccc_transient_page_disown(const struct lu_env *env,
530                                       const struct cl_page_slice *slice,
531                                       struct cl_io *unused)
532 {
533         ccc_transient_page_verify(slice->cpl_page);
534 }
535
536 void ccc_transient_page_discard(const struct lu_env *env,
537                                        const struct cl_page_slice *slice,
538                                        struct cl_io *unused)
539 {
540         struct cl_page *page = slice->cpl_page;
541
542         ccc_transient_page_verify(slice->cpl_page);
543
544         /*
545          * For transient pages, remove it from the radix tree.
546          */
547         cl_page_delete(env, page);
548 }
549
550 int ccc_transient_page_prep(const struct lu_env *env,
551                                    const struct cl_page_slice *slice,
552                                    struct cl_io *unused)
553 {
554         ENTRY;
555         /* transient page should always be sent. */
556         RETURN(0);
557 }
558
559 /*****************************************************************************
560  *
561  * Lock operations.
562  *
563  */
564
565 void ccc_lock_delete(const struct lu_env *env,
566                      const struct cl_lock_slice *slice)
567 {
568         CLOBINVRNT(env, slice->cls_obj, ccc_object_invariant(slice->cls_obj));
569 }
570
571 void ccc_lock_fini(const struct lu_env *env, struct cl_lock_slice *slice)
572 {
573         struct ccc_lock *clk = cl2ccc_lock(slice);
574         OBD_SLAB_FREE_PTR(clk, ccc_lock_kmem);
575 }
576
577 int ccc_lock_enqueue(const struct lu_env *env,
578                      const struct cl_lock_slice *slice,
579                      struct cl_io *unused, __u32 enqflags)
580 {
581         CLOBINVRNT(env, slice->cls_obj, ccc_object_invariant(slice->cls_obj));
582         return 0;
583 }
584
585 int ccc_lock_unuse(const struct lu_env *env, const struct cl_lock_slice *slice)
586 {
587         CLOBINVRNT(env, slice->cls_obj, ccc_object_invariant(slice->cls_obj));
588         return 0;
589 }
590
591 int ccc_lock_wait(const struct lu_env *env, const struct cl_lock_slice *slice)
592 {
593         CLOBINVRNT(env, slice->cls_obj, ccc_object_invariant(slice->cls_obj));
594         return 0;
595 }
596
597 /**
598  * Implementation of cl_lock_operations::clo_fits_into() methods for ccc
599  * layer. This function is executed every time io finds an existing lock in
600  * the lock cache while creating new lock. This function has to decide whether
601  * cached lock "fits" into io.
602  *
603  * \param slice lock to be checked
604  *
605  * \param io    IO that wants a lock.
606  *
607  * \see lov_lock_fits_into().
608  */
609 int ccc_lock_fits_into(const struct lu_env *env,
610                        const struct cl_lock_slice *slice,
611                        const struct cl_lock_descr *need,
612                        const struct cl_io *io)
613 {
614         const struct cl_lock       *lock  = slice->cls_lock;
615         const struct cl_lock_descr *descr = &lock->cll_descr;
616         const struct ccc_io        *cio   = ccc_env_io(env);
617         int                         result;
618
619         ENTRY;
620         /*
621          * Work around DLM peculiarity: it assumes that glimpse
622          * (LDLM_FL_HAS_INTENT) lock is always LCK_PR, and returns reads lock
623          * when asked for LCK_PW lock with LDLM_FL_HAS_INTENT flag set. Make
624          * sure that glimpse doesn't get CLM_WRITE top-lock, so that it
625          * doesn't enqueue CLM_WRITE sub-locks.
626          */
627         if (cio->cui_glimpse)
628                 result = descr->cld_mode != CLM_WRITE;
629         /*
630          * Also, don't match incomplete write locks for read, otherwise read
631          * would enqueue missing sub-locks in the write mode.
632          *
633          * XXX this is a candidate for generic locking policy, to be moved
634          * into cl_lock_lookup().
635          */
636         else if (need->cld_mode != descr->cld_mode)
637                 result = lock->cll_state >= CLS_ENQUEUED;
638         else
639                 result = 1;
640         RETURN(result);
641 }
642
643 /**
644  * Implements cl_lock_operations::clo_state() method for ccc layer, invoked
645  * whenever lock state changes. Transfers object attributes, that might be
646  * updated as a result of lock acquiring into inode.
647  */
648 void ccc_lock_state(const struct lu_env *env,
649                     const struct cl_lock_slice *slice,
650                     enum cl_lock_state state)
651 {
652         struct cl_lock   *lock;
653         struct cl_object *obj;
654         struct inode     *inode;
655         struct cl_attr   *attr;
656
657         ENTRY;
658         lock = slice->cls_lock;
659
660         /*
661          * Refresh inode attributes when the lock is moving into CLS_HELD
662          * state, and only when this is a result of real enqueue, rather than
663          * of finding lock in the cache.
664          */
665         if (state == CLS_HELD && lock->cll_state < CLS_HELD) {
666                 int rc;
667
668                 obj   = slice->cls_obj;
669                 inode = ccc_object_inode(obj);
670                 attr  = ccc_env_thread_attr(env);
671
672                 /* vmtruncate()->ll_truncate() first sets the i_size and then
673                  * the kms under both a DLM lock and the
674                  * ll_inode_size_lock().  If we don't get the
675                  * ll_inode_size_lock() here we can match the DLM lock and
676                  * reset i_size from the kms before the truncating path has
677                  * updated the kms.  generic_file_write can then trust the
678                  * stale i_size when doing appending writes and effectively
679                  * cancel the result of the truncate.  Getting the
680                  * ll_inode_size_lock() after the enqueue maintains the DLM
681                  * -> ll_inode_size_lock() acquiring order. */
682                 cl_isize_lock(inode, 0);
683                 cl_object_attr_lock(obj);
684                 rc = cl_object_attr_get(env, obj, attr);
685                 if (rc == 0) {
686                         if (lock->cll_descr.cld_start == 0 &&
687                             lock->cll_descr.cld_end == CL_PAGE_EOF) {
688                                 cl_isize_write(inode, attr->cat_kms);
689                                 CDEBUG(D_INODE, DFID" updating i_size %llu\n",
690                                        PFID(lu_object_fid(&obj->co_lu)),
691                                        (__u64)cl_isize_read(inode));
692                         }
693                         cl_inode_mtime(inode) = attr->cat_mtime;
694                         cl_inode_atime(inode) = attr->cat_atime;
695                         cl_inode_ctime(inode) = attr->cat_ctime;
696                 } else
697                         CL_LOCK_DEBUG(D_ERROR, env, lock, "attr_get: %i\n", rc);
698                 cl_object_attr_unlock(obj);
699                 cl_isize_unlock(inode, 0);
700         }
701         EXIT;
702 }
703
704 /*****************************************************************************
705  *
706  * io operations.
707  *
708  */
709
710 void ccc_io_fini(const struct lu_env *env, const struct cl_io_slice *ios)
711 {
712         struct cl_io *io = ios->cis_io;
713
714         CLOBINVRNT(env, io->ci_obj, ccc_object_invariant(io->ci_obj));
715 }
716
717 int ccc_io_one_lock_index(const struct lu_env *env, struct cl_io *io,
718                           __u32 enqflags, enum cl_lock_mode mode,
719                           pgoff_t start, pgoff_t end)
720 {
721         struct ccc_io          *cio   = ccc_env_io(env);
722         struct cl_lock_descr   *descr = &cio->cui_link.cill_descr;
723         struct cl_object       *obj   = io->ci_obj;
724
725         CLOBINVRNT(env, obj, ccc_object_invariant(obj));
726         ENTRY;
727
728         CDEBUG(D_VFSTRACE, "lock: %i [%lu, %lu]\n", mode, start, end);
729
730         memset(&cio->cui_link, 0, sizeof cio->cui_link);
731         descr->cld_mode  = mode;
732         descr->cld_obj   = obj;
733         descr->cld_start = start;
734         descr->cld_end   = end;
735
736         cio->cui_link.cill_enq_flags = enqflags;
737         cl_io_lock_add(env, io, &cio->cui_link);
738         RETURN(0);
739 }
740
741 void ccc_io_update_iov(const struct lu_env *env,
742                        struct ccc_io *cio, struct cl_io *io)
743 {
744         int i;
745         size_t size = io->u.ci_rw.crw_count;
746
747         cio->cui_iov_olen = 0;
748         if (cl_io_is_sendfile(io) || size == cio->cui_tot_count)
749                 return;
750
751         if (cio->cui_tot_nrsegs == 0)
752                 cio->cui_tot_nrsegs =  cio->cui_nrsegs;
753
754         for (i = 0; i < cio->cui_tot_nrsegs; i++) {
755                 struct iovec *iv = &cio->cui_iov[i];
756
757                 if (iv->iov_len < size)
758                         size -= iv->iov_len;
759                 else {
760                         if (iv->iov_len > size) {
761                                 cio->cui_iov_olen = iv->iov_len;
762                                 iv->iov_len = size;
763                         }
764                         break;
765                 }
766         }
767
768         cio->cui_nrsegs = i + 1;
769 }
770
771 int ccc_io_one_lock(const struct lu_env *env, struct cl_io *io,
772                     __u32 enqflags, enum cl_lock_mode mode,
773                     loff_t start, loff_t end)
774 {
775         struct cl_object *obj = io->ci_obj;
776         return ccc_io_one_lock_index(env, io, enqflags, mode,
777                                      cl_index(obj, start), cl_index(obj, end));
778 }
779
780 void ccc_io_end(const struct lu_env *env, const struct cl_io_slice *ios)
781 {
782         CLOBINVRNT(env, ios->cis_io->ci_obj,
783                    ccc_object_invariant(ios->cis_io->ci_obj));
784 }
785
786 void ccc_io_advance(const struct lu_env *env,
787                     const struct cl_io_slice *ios,
788                     size_t nob)
789 {
790         struct ccc_io    *cio = cl2ccc_io(env, ios);
791         struct cl_io     *io  = ios->cis_io;
792         struct cl_object *obj = ios->cis_io->ci_obj;
793
794         CLOBINVRNT(env, obj, ccc_object_invariant(obj));
795
796         if (!cl_io_is_sendfile(io) && io->ci_continue) {
797                 /* update the iov */
798                 LASSERT(cio->cui_tot_nrsegs >= cio->cui_nrsegs);
799                 LASSERT(cio->cui_tot_count  >= nob);
800
801                 cio->cui_iov        += cio->cui_nrsegs;
802                 cio->cui_tot_nrsegs -= cio->cui_nrsegs;
803                 cio->cui_tot_count  -= nob;
804
805                 if (cio->cui_iov_olen) {
806                         struct iovec *iv;
807
808                         cio->cui_iov--;
809                         cio->cui_tot_nrsegs++;
810                         iv = &cio->cui_iov[0];
811                         iv->iov_base += iv->iov_len;
812                         LASSERT(cio->cui_iov_olen > iv->iov_len);
813                         iv->iov_len = cio->cui_iov_olen - iv->iov_len;
814                 }
815         }
816 }
817
818 static void ccc_object_size_lock(struct cl_object *obj, int vfslock)
819 {
820         struct inode *inode = ccc_object_inode(obj);
821
822         if (vfslock)
823                 cl_isize_lock(inode, 0);
824         cl_object_attr_lock(obj);
825 }
826
827 static void ccc_object_size_unlock(struct cl_object *obj, int vfslock)
828 {
829         struct inode *inode = ccc_object_inode(obj);
830
831         cl_object_attr_unlock(obj);
832         if (vfslock)
833                 cl_isize_unlock(inode, 0);
834 }
835
836 /**
837  * Helper function that if necessary adjusts file size (inode->i_size), when
838  * position at the offset \a pos is accessed. File size can be arbitrary stale
839  * on a Lustre client, but client at least knows KMS. If accessed area is
840  * inside [0, KMS], set file size to KMS, otherwise glimpse file size.
841  *
842  * Locking: cl_isize_lock is used to serialize changes to inode size and to
843  * protect consistency between inode size and cl_object
844  * attributes. cl_object_size_lock() protects consistency between cl_attr's of
845  * top-object and sub-objects.
846  *
847  * In page fault path cl_isize_lock cannot be taken, client has to live with
848  * the resulting races.
849  */
850 int ccc_prep_size(const struct lu_env *env, struct cl_object *obj,
851                   struct cl_io *io, loff_t start, size_t count, int vfslock,
852                   int *exceed)
853 {
854         struct cl_attr *attr  = ccc_env_thread_attr(env);
855         struct inode   *inode = ccc_object_inode(obj);
856         loff_t          pos   = start + count - 1;
857         loff_t kms;
858         int result;
859
860         /*
861          * Consistency guarantees: following possibilities exist for the
862          * relation between region being accessed and real file size at this
863          * moment:
864          *
865          *  (A): the region is completely inside of the file;
866          *
867          *  (B-x): x bytes of region are inside of the file, the rest is
868          *  outside;
869          *
870          *  (C): the region is completely outside of the file.
871          *
872          * This classification is stable under DLM lock already acquired by
873          * the caller, because to change the class, other client has to take
874          * DLM lock conflicting with our lock. Also, any updates to ->i_size
875          * by other threads on this client are serialized by
876          * ll_inode_size_lock(). This guarantees that short reads are handled
877          * correctly in the face of concurrent writes and truncates.
878          */
879         ccc_object_size_lock(obj, vfslock);
880         result = cl_object_attr_get(env, obj, attr);
881         if (result == 0) {
882                 kms = attr->cat_kms;
883                 if (pos > kms) {
884                         /*
885                          * A glimpse is necessary to determine whether we
886                          * return a short read (B) or some zeroes at the end
887                          * of the buffer (C)
888                          */
889                         ccc_object_size_unlock(obj, vfslock);
890                         result = cl_glimpse_lock(env, io, inode, obj);
891                         if (result == 0 && exceed != NULL) {
892                                 /* If objective page index exceed end-of-file
893                                  * page index, return directly. Do not expect
894                                  * kernel will check such case correctly.
895                                  * linux-2.6.18-128.1.1 miss to do that.
896                                  * --bug 17336 */
897                                 loff_t size = cl_isize_read(inode);
898                                 unsigned long cur_index = start >> CFS_PAGE_SHIFT;
899
900                                 if ((size == 0 && cur_index != 0) ||
901                                     (((size - 1) >> CFS_PAGE_SHIFT) < cur_index))
902                                 *exceed = 1;
903                         }
904                         return result;
905                 } else {
906                         /*
907                          * region is within kms and, hence, within real file
908                          * size (A). We need to increase i_size to cover the
909                          * read region so that generic_file_read() will do its
910                          * job, but that doesn't mean the kms size is
911                          * _correct_, it is only the _minimum_ size. If
912                          * someone does a stat they will get the correct size
913                          * which will always be >= the kms value here.
914                          * b=11081
915                          */
916                         /*
917                          * XXX in a page fault path, change inode size without
918                          * ll_inode_size_lock() held!  there is a race
919                          * condition with truncate path. (see ll_extent_lock)
920                          */
921                         /*
922                          * XXX i_size_write() is not used because it is not
923                          * safe to take the ll_inode_size_lock() due to a
924                          * potential lock inversion (bug 6077).  And since
925                          * it's not safe to use i_size_write() without a
926                          * covering mutex we do the assignment directly.  It
927                          * is not critical that the size be correct.
928                          */
929                         if (cl_isize_read(inode) < kms) {
930                                 if (vfslock)
931                                         cl_isize_write(inode, kms);
932                                 else
933                                         cl_isize_write_nolock(inode, kms);
934                         }
935                 }
936         }
937         ccc_object_size_unlock(obj, vfslock);
938         return result;
939 }
940
941 /*****************************************************************************
942  *
943  * Transfer operations.
944  *
945  */
946
947 void ccc_req_completion(const struct lu_env *env,
948                         const struct cl_req_slice *slice, int ioret)
949 {
950         struct ccc_req *vrq;
951
952         vrq = cl2ccc_req(slice);
953         OBD_SLAB_FREE_PTR(vrq, ccc_req_kmem);
954 }
955
956 /**
957  * Implementation of struct cl_req_operations::cro_attr_set() for ccc
958  * layer. ccc is responsible for
959  *
960  *    - o_[mac]time
961  *
962  *    - o_mode
963  *
964  *    - o_fid (filled with inode number?!)
965  *
966  *    - o_[ug]id
967  *
968  *    - o_generation
969  *
970  *    - and IO epoch (stored in o_easize),
971  *
972  *  and capability.
973  */
974 void ccc_req_attr_set(const struct lu_env *env,
975                       const struct cl_req_slice *slice,
976                       const struct cl_object *obj,
977                       struct cl_req_attr *attr, obd_valid flags)
978 {
979         struct inode *inode;
980         struct obdo  *oa;
981         obd_flag      valid_flags;
982
983         oa = attr->cra_oa;
984         inode = ccc_object_inode(obj);
985         valid_flags = OBD_MD_FLTYPE|OBD_MD_FLATIME;
986
987         if (flags != (obd_valid)~0ULL)
988                 valid_flags |= OBD_MD_FLMTIME|OBD_MD_FLCTIME|OBD_MD_FLATIME;
989         else {
990                 LASSERT(attr->cra_capa == NULL);
991                 attr->cra_capa = cl_capa_lookup(inode,
992                                                 slice->crs_req->crq_type);
993         }
994
995         if (slice->crs_req->crq_type == CRT_WRITE) {
996                 if (flags & OBD_MD_FLEPOCH) {
997                         oa->o_valid |= OBD_MD_FLEPOCH;
998                         oa->o_easize = cl_i2info(inode)->lli_ioepoch;
999                         valid_flags |= OBD_MD_FLMTIME|OBD_MD_FLCTIME|
1000                                 OBD_MD_FLUID|OBD_MD_FLGID|
1001                                 OBD_MD_FLFID|OBD_MD_FLGENER;
1002                 }
1003         }
1004         obdo_from_inode(oa, inode, valid_flags & flags);
1005 }
1006
1007 const struct cl_req_operations ccc_req_ops = {
1008         .cro_attr_set   = ccc_req_attr_set,
1009         .cro_completion = ccc_req_completion
1010 };
1011
1012 /* Setattr helpers */
1013 int cl_setattr_do_truncate(struct inode *inode, loff_t size,
1014                            struct obd_capa *capa)
1015 {
1016         struct lu_env *env;
1017         struct cl_io  *io;
1018         int            result;
1019         int            refcheck;
1020
1021         ENTRY;
1022
1023         env = cl_env_get(&refcheck);
1024         if (IS_ERR(env))
1025                 RETURN(PTR_ERR(env));
1026
1027         io = &ccc_env_info(env)->cti_io;
1028         io->ci_obj = cl_i2info(inode)->lli_clob;
1029         io->u.ci_truncate.tr_size = size;
1030         io->u.ci_truncate.tr_capa = capa;
1031         if (cl_io_init(env, io, CIT_TRUNC, io->ci_obj) == 0)
1032                 result = cl_io_loop(env, io);
1033         else
1034                 result = io->ci_result;
1035         cl_io_fini(env, io);
1036         cl_env_put(env, &refcheck);
1037         RETURN(result);
1038 }
1039
1040 int cl_setattr_ost(struct inode *inode, struct obd_capa *capa)
1041 {
1042         struct cl_inode_info *lli = cl_i2info(inode);
1043         struct lov_stripe_md *lsm = lli->lli_smd;
1044         int rc;
1045         obd_flag flags;
1046         struct obd_info oinfo = { { { 0 } } };
1047         struct obdo *oa;
1048
1049         OBDO_ALLOC(oa);
1050         if (oa) {
1051                 oa->o_id = lsm->lsm_object_id;
1052                 oa->o_gr = lsm->lsm_object_gr;
1053                 oa->o_valid = OBD_MD_FLID | OBD_MD_FLGROUP;
1054
1055                 flags = OBD_MD_FLTYPE | OBD_MD_FLATIME |
1056                         OBD_MD_FLMTIME | OBD_MD_FLCTIME |
1057                         OBD_MD_FLFID | OBD_MD_FLGENER |
1058                         OBD_MD_FLGROUP;
1059
1060                 obdo_from_inode(oa, inode, flags);
1061
1062                 oinfo.oi_oa = oa;
1063                 oinfo.oi_md = lsm;
1064                 oinfo.oi_capa = capa;
1065
1066                 /* XXX: this looks unnecessary now. */
1067                 rc = obd_setattr_rqset(cl_i2sbi(inode)->ll_dt_exp, &oinfo,
1068                                        NULL);
1069                 if (rc)
1070                         CERROR("obd_setattr_async fails: rc=%d\n", rc);
1071                 OBDO_FREE(oa);
1072         } else {
1073                 rc = -ENOMEM;
1074         }
1075         return rc;
1076 }
1077
1078
1079 /*****************************************************************************
1080  *
1081  * Type conversions.
1082  *
1083  */
1084
1085 struct lu_device *ccc2lu_dev(struct ccc_device *vdv)
1086 {
1087         return &vdv->cdv_cl.cd_lu_dev;
1088 }
1089
1090 struct ccc_device *lu2ccc_dev(const struct lu_device *d)
1091 {
1092         return container_of0(d, struct ccc_device, cdv_cl.cd_lu_dev);
1093 }
1094
1095 struct ccc_device *cl2ccc_dev(const struct cl_device *d)
1096 {
1097         return container_of0(d, struct ccc_device, cdv_cl);
1098 }
1099
1100 struct lu_object *ccc2lu(struct ccc_object *vob)
1101 {
1102         return &vob->cob_cl.co_lu;
1103 }
1104
1105 struct ccc_object *lu2ccc(const struct lu_object *obj)
1106 {
1107         return container_of0(obj, struct ccc_object, cob_cl.co_lu);
1108 }
1109
1110 struct ccc_object *cl2ccc(const struct cl_object *obj)
1111 {
1112         return container_of0(obj, struct ccc_object, cob_cl);
1113 }
1114
1115 struct ccc_lock *cl2ccc_lock(const struct cl_lock_slice *slice)
1116 {
1117         return container_of(slice, struct ccc_lock, clk_cl);
1118 }
1119
1120 struct ccc_io *cl2ccc_io(const struct lu_env *env,
1121                          const struct cl_io_slice *slice)
1122 {
1123         struct ccc_io *cio;
1124
1125         cio = container_of(slice, struct ccc_io, cui_cl);
1126         LASSERT(cio == ccc_env_io(env));
1127         return cio;
1128 }
1129
1130 struct ccc_req *cl2ccc_req(const struct cl_req_slice *slice)
1131 {
1132         return container_of0(slice, struct ccc_req, crq_cl);
1133 }
1134
1135 cfs_page_t *cl2vm_page(const struct cl_page_slice *slice)
1136 {
1137         return cl2ccc_page(slice)->cpg_page;
1138 }
1139
1140 /*****************************************************************************
1141  *
1142  * Accessors.
1143  *
1144  */
1145 int ccc_object_invariant(const struct cl_object *obj)
1146 {
1147         struct inode         *inode = ccc_object_inode(obj);
1148         struct cl_inode_info *lli   = cl_i2info(inode);
1149
1150         return (S_ISREG(cl_inode_mode(inode)) ||
1151                 /* i_mode of unlinked inode is zeroed. */
1152                 cl_inode_mode(inode) == 0) && lli->lli_clob == obj;
1153 }
1154
1155 struct inode *ccc_object_inode(const struct cl_object *obj)
1156 {
1157         return cl2ccc(obj)->cob_inode;
1158 }
1159
1160 /**
1161  * Returns a pointer to cl_page associated with \a vmpage, without acquiring
1162  * additional reference to the resulting page. This is an unsafe version of
1163  * cl_vmpage_page() that can only be used under vmpage lock.
1164  */
1165 struct cl_page *ccc_vmpage_page_transient(cfs_page_t *vmpage)
1166 {
1167         KLASSERT(PageLocked(vmpage));
1168         return (struct cl_page *)vmpage->private;
1169 }
1170
1171 /**
1172  * Initializes or updates CLIO part when new meta-data arrives from the
1173  * server.
1174  *
1175  *     - allocates cl_object if necessary,
1176  *     - updated layout, if object was already here.
1177  */
1178 int cl_inode_init(struct inode *inode, struct lustre_md *md)
1179 {
1180         struct lu_env        *env;
1181         struct cl_inode_info *lli;
1182         struct cl_object     *clob;
1183         struct lu_site       *site;
1184         struct lu_fid        *fid;
1185         const struct cl_object_conf conf = {
1186                 .coc_inode = inode,
1187                 .u = {
1188                         .coc_md    = md
1189                 }
1190         };
1191         int result = 0;
1192         int refcheck;
1193
1194         /* LASSERT(inode->i_state & I_NEW); */
1195         LASSERT(md->body->valid & OBD_MD_FLID);
1196
1197         if (!S_ISREG(cl_inode_mode(inode)))
1198                 return 0;
1199
1200         env = cl_env_get(&refcheck);
1201         if (IS_ERR(env))
1202                 return PTR_ERR(env);
1203
1204         site = cl_i2sbi(inode)->ll_site;
1205         lli  = cl_i2info(inode);
1206         fid  = &lli->lli_fid;
1207         LASSERT(fid_is_sane(fid));
1208
1209         if (lli->lli_clob == NULL) {
1210                 clob = cl_object_find(env, lu2cl_dev(site->ls_top_dev),
1211                                       fid, &conf);
1212                 if (!IS_ERR(clob)) {
1213                         /*
1214                          * No locking is necessary, as new inode is
1215                          * locked by I_NEW bit.
1216                          *
1217                          * XXX not true for call from ll_update_inode().
1218                          */
1219                         lli->lli_clob = clob;
1220                         lu_object_ref_add(&clob->co_lu, "inode", inode);
1221                 } else
1222                         result = PTR_ERR(clob);
1223         } else
1224                 result = cl_conf_set(env, lli->lli_clob, &conf);
1225         cl_env_put(env, &refcheck);
1226
1227         if (result != 0)
1228                 CERROR("Failure to initialize cl object "DFID": %d\n",
1229                        PFID(fid), result);
1230         return result;
1231 }
1232
1233 void cl_inode_fini(struct inode *inode)
1234 {
1235         struct lu_env           *env;
1236         struct cl_inode_info    *lli  = cl_i2info(inode);
1237         struct cl_object        *clob = lli->lli_clob;
1238         int refcheck;
1239         int emergency;
1240
1241         if (clob != NULL) {
1242                 void                    *cookie;
1243
1244                 cookie = cl_env_reenter();
1245                 env = cl_env_get(&refcheck);
1246                 emergency = IS_ERR(env);
1247                 if (emergency) {
1248                         mutex_lock(&ccc_inode_fini_guard);
1249                         LASSERT(ccc_inode_fini_env != NULL);
1250                         cl_env_implant(ccc_inode_fini_env, &refcheck);
1251                         env = ccc_inode_fini_env;
1252                 }
1253                 /*
1254                  * cl_object cache is a slave to inode cache (which, in turn
1255                  * is a slave to dentry cache), don't keep cl_object in memory
1256                  * when its master is evicted.
1257                  */
1258                 cl_object_kill(env, clob);
1259                 lu_object_ref_del(&clob->co_lu, "inode", inode);
1260                 cl_object_put(env, clob);
1261                 lli->lli_clob = NULL;
1262                 if (emergency) {
1263                         cl_env_unplant(ccc_inode_fini_env, &refcheck);
1264                         mutex_unlock(&ccc_inode_fini_guard);
1265                 } else
1266                         cl_env_put(env, &refcheck);
1267                 cl_env_reexit(cookie);
1268         }
1269 }
1270
1271 /**
1272  * return IF_* type for given lu_dirent entry.
1273  * IF_* flag shld be converted to particular OS file type in
1274  * platform llite module.
1275  */
1276 __u16 ll_dirent_type_get(struct lu_dirent *ent)
1277 {
1278         __u16 type = 0;
1279         struct luda_type *lt;
1280         int len = 0;
1281
1282         if (le32_to_cpu(ent->lde_attrs) & LUDA_TYPE) {
1283                 const unsigned align = sizeof(struct luda_type) - 1;
1284
1285                 len = le16_to_cpu(ent->lde_namelen);
1286                 len = (len + align) & ~align;
1287                 lt = (void *) ent->lde_name + len;
1288                 type = CFS_IFTODT(le16_to_cpu(lt->lt_type));
1289         }
1290         return type;
1291 }