Whamcloud - gitweb
LU-657 test: limit the write size in run_dd
[fs/lustre-release.git] / lustre / lclient / lcommon_cl.c
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License version 2 for more details (a copy is included
14  * in the LICENSE file that accompanied this code).
15  *
16  * You should have received a copy of the GNU General Public License
17  * version 2 along with this program; If not, see
18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
19  *
20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21  * CA 95054 USA or visit www.sun.com if you need additional information or
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2011, 2012, Intel Corporation.
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/quotaops.h>
50 # include <linux/highmem.h>
51 # include <linux/pagemap.h>
52 # include <linux/rbtree.h>
53 #else /* __KERNEL__ */
54 #include <stdlib.h>
55 #include <string.h>
56 #include <assert.h>
57 #include <time.h>
58 #include <sys/types.h>
59 #include <sys/stat.h>
60 #include <sys/queue.h>
61 #include <fcntl.h>
62 # include <liblustre.h>
63 #endif
64
65 #include <obd.h>
66 #include <obd_support.h>
67 #include <lustre_fid.h>
68 #include <lustre_lite.h>
69 #include <lustre_dlm.h>
70 #include <lustre_ver.h>
71 #include <lustre_mdc.h>
72 #include <cl_object.h>
73
74 #include <lclient.h>
75
76 #ifdef __KERNEL__
77 #include "../llite/llite_internal.h"
78 #else
79 #include "../liblustre/llite_lib.h"
80 #endif
81
82 const struct cl_req_operations ccc_req_ops;
83
84 /*
85  * ccc_ prefix stands for "Common Client Code".
86  */
87
88 static cfs_mem_cache_t *ccc_lock_kmem;
89 static cfs_mem_cache_t *ccc_object_kmem;
90 static cfs_mem_cache_t *ccc_thread_kmem;
91 static cfs_mem_cache_t *ccc_session_kmem;
92 static cfs_mem_cache_t *ccc_req_kmem;
93
94 static struct lu_kmem_descr ccc_caches[] = {
95         {
96                 .ckd_cache = &ccc_lock_kmem,
97                 .ckd_name  = "ccc_lock_kmem",
98                 .ckd_size  = sizeof (struct ccc_lock)
99         },
100         {
101                 .ckd_cache = &ccc_object_kmem,
102                 .ckd_name  = "ccc_object_kmem",
103                 .ckd_size  = sizeof (struct ccc_object)
104         },
105         {
106                 .ckd_cache = &ccc_thread_kmem,
107                 .ckd_name  = "ccc_thread_kmem",
108                 .ckd_size  = sizeof (struct ccc_thread_info),
109         },
110         {
111                 .ckd_cache = &ccc_session_kmem,
112                 .ckd_name  = "ccc_session_kmem",
113                 .ckd_size  = sizeof (struct ccc_session)
114         },
115         {
116                 .ckd_cache = &ccc_req_kmem,
117                 .ckd_name  = "ccc_req_kmem",
118                 .ckd_size  = sizeof (struct ccc_req)
119         },
120         {
121                 .ckd_cache = NULL
122         }
123 };
124
125 /*****************************************************************************
126  *
127  * Vvp device and device type functions.
128  *
129  */
130
131 void *ccc_key_init(const struct lu_context *ctx,
132                           struct lu_context_key *key)
133 {
134         struct ccc_thread_info *info;
135
136         OBD_SLAB_ALLOC_PTR_GFP(info, ccc_thread_kmem, CFS_ALLOC_IO);
137         if (info == NULL)
138                 info = ERR_PTR(-ENOMEM);
139         return info;
140 }
141
142 void ccc_key_fini(const struct lu_context *ctx,
143                          struct lu_context_key *key, void *data)
144 {
145         struct ccc_thread_info *info = data;
146         OBD_SLAB_FREE_PTR(info, ccc_thread_kmem);
147 }
148
149 void *ccc_session_key_init(const struct lu_context *ctx,
150                                   struct lu_context_key *key)
151 {
152         struct ccc_session *session;
153
154         OBD_SLAB_ALLOC_PTR_GFP(session, ccc_session_kmem, CFS_ALLOC_IO);
155         if (session == NULL)
156                 session = ERR_PTR(-ENOMEM);
157         return session;
158 }
159
160 void ccc_session_key_fini(const struct lu_context *ctx,
161                                  struct lu_context_key *key, void *data)
162 {
163         struct ccc_session *session = data;
164         OBD_SLAB_FREE_PTR(session, ccc_session_kmem);
165 }
166
167 struct lu_context_key ccc_key = {
168         .lct_tags = LCT_CL_THREAD,
169         .lct_init = ccc_key_init,
170         .lct_fini = ccc_key_fini
171 };
172
173 struct lu_context_key ccc_session_key = {
174         .lct_tags = LCT_SESSION,
175         .lct_init = ccc_session_key_init,
176         .lct_fini = ccc_session_key_fini
177 };
178
179
180 /* type constructor/destructor: ccc_type_{init,fini,start,stop}(). */
181 // LU_TYPE_INIT_FINI(ccc, &ccc_key, &ccc_session_key);
182
183 int ccc_device_init(const struct lu_env *env, struct lu_device *d,
184                            const char *name, struct lu_device *next)
185 {
186         struct ccc_device  *vdv;
187         int rc;
188         ENTRY;
189
190         vdv = lu2ccc_dev(d);
191         vdv->cdv_next = lu2cl_dev(next);
192
193         LASSERT(d->ld_site != NULL && next->ld_type != NULL);
194         next->ld_site = d->ld_site;
195         rc = next->ld_type->ldt_ops->ldto_device_init(
196                         env, next, next->ld_type->ldt_name, NULL);
197         if (rc == 0) {
198                 lu_device_get(next);
199                 lu_ref_add(&next->ld_reference, "lu-stack", &lu_site_init);
200         }
201         RETURN(rc);
202 }
203
204 struct lu_device *ccc_device_fini(const struct lu_env *env,
205                                          struct lu_device *d)
206 {
207         return cl2lu_dev(lu2ccc_dev(d)->cdv_next);
208 }
209
210 struct lu_device *ccc_device_alloc(const struct lu_env *env,
211                                    struct lu_device_type *t,
212                                    struct lustre_cfg *cfg,
213                                    const struct lu_device_operations *luops,
214                                    const struct cl_device_operations *clops)
215 {
216         struct ccc_device *vdv;
217         struct lu_device  *lud;
218         struct cl_site    *site;
219         int rc;
220         ENTRY;
221
222         OBD_ALLOC_PTR(vdv);
223         if (vdv == NULL)
224                 RETURN(ERR_PTR(-ENOMEM));
225
226         lud = &vdv->cdv_cl.cd_lu_dev;
227         cl_device_init(&vdv->cdv_cl, t);
228         ccc2lu_dev(vdv)->ld_ops = luops;
229         vdv->cdv_cl.cd_ops = clops;
230
231         OBD_ALLOC_PTR(site);
232         if (site != NULL) {
233                 rc = cl_site_init(site, &vdv->cdv_cl);
234                 if (rc == 0)
235                         rc = lu_site_init_finish(&site->cs_lu);
236                 else {
237                         LASSERT(lud->ld_site == NULL);
238                         CERROR("Cannot init lu_site, rc %d.\n", rc);
239                         OBD_FREE_PTR(site);
240                 }
241         } else
242                 rc = -ENOMEM;
243         if (rc != 0) {
244                 ccc_device_free(env, lud);
245                 lud = ERR_PTR(rc);
246         }
247         RETURN(lud);
248 }
249
250 struct lu_device *ccc_device_free(const struct lu_env *env,
251                                          struct lu_device *d)
252 {
253         struct ccc_device *vdv  = lu2ccc_dev(d);
254         struct cl_site    *site = lu2cl_site(d->ld_site);
255         struct lu_device  *next = cl2lu_dev(vdv->cdv_next);
256
257         if (d->ld_site != NULL) {
258                 cl_site_fini(site);
259                 OBD_FREE_PTR(site);
260         }
261         cl_device_fini(lu2cl_dev(d));
262         OBD_FREE_PTR(vdv);
263         return next;
264 }
265
266 int ccc_req_init(const struct lu_env *env, struct cl_device *dev,
267                         struct cl_req *req)
268 {
269         struct ccc_req *vrq;
270         int result;
271
272         OBD_SLAB_ALLOC_PTR_GFP(vrq, ccc_req_kmem, CFS_ALLOC_IO);
273         if (vrq != NULL) {
274                 cl_req_slice_add(req, &vrq->crq_cl, dev, &ccc_req_ops);
275                 result = 0;
276         } else
277                 result = -ENOMEM;
278         return result;
279 }
280
281 /**
282  * An `emergency' environment used by ccc_inode_fini() when cl_env_get()
283  * fails. Access to this environment is serialized by ccc_inode_fini_guard
284  * mutex.
285  */
286 static struct lu_env *ccc_inode_fini_env = NULL;
287
288 /**
289  * A mutex serializing calls to slp_inode_fini() under extreme memory
290  * pressure, when environments cannot be allocated.
291  */
292 static DEFINE_MUTEX(ccc_inode_fini_guard);
293 static int dummy_refcheck;
294
295 int ccc_global_init(struct lu_device_type *device_type)
296 {
297         int result;
298
299         result = lu_kmem_init(ccc_caches);
300         if (result)
301                 return result;
302
303         result = lu_device_type_init(device_type);
304         if (result)
305                 goto out_kmem;
306
307         ccc_inode_fini_env = cl_env_alloc(&dummy_refcheck,
308                                           LCT_REMEMBER|LCT_NOREF);
309         if (IS_ERR(ccc_inode_fini_env)) {
310                 result = PTR_ERR(ccc_inode_fini_env);
311                 goto out_device;
312         }
313
314         ccc_inode_fini_env->le_ctx.lc_cookie = 0x4;
315         return 0;
316 out_device:
317         lu_device_type_fini(device_type);
318 out_kmem:
319         lu_kmem_fini(ccc_caches);
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         /*
441          * LU-417: Add dirty pages block count lest i_blocks reports 0, some
442          * "cp" or "tar" on remote node may think it's a completely sparse file
443          * and skip it.
444          */
445         if (lvb->lvb_size > 0 && lvb->lvb_blocks == 0)
446                 lvb->lvb_blocks = dirty_cnt(inode);
447         RETURN(0);
448 }
449
450
451
452 int ccc_conf_set(const struct lu_env *env, struct cl_object *obj,
453                         const struct cl_object_conf *conf)
454 {
455         /* TODO: destroy all pages attached to this object. */
456         return 0;
457 }
458
459 static void ccc_object_size_lock(struct cl_object *obj)
460 {
461         struct inode *inode = ccc_object_inode(obj);
462
463         cl_isize_lock(inode);
464         cl_object_attr_lock(obj);
465 }
466
467 static void ccc_object_size_unlock(struct cl_object *obj)
468 {
469         struct inode *inode = ccc_object_inode(obj);
470
471         cl_object_attr_unlock(obj);
472         cl_isize_unlock(inode);
473 }
474
475 /*****************************************************************************
476  *
477  * Page operations.
478  *
479  */
480
481 cfs_page_t *ccc_page_vmpage(const struct lu_env *env,
482                             const struct cl_page_slice *slice)
483 {
484         return cl2vm_page(slice);
485 }
486
487 int ccc_page_is_under_lock(const struct lu_env *env,
488                            const struct cl_page_slice *slice,
489                            struct cl_io *io)
490 {
491         struct ccc_io        *cio  = ccc_env_io(env);
492         struct cl_lock_descr *desc = &ccc_env_info(env)->cti_descr;
493         struct cl_page       *page = slice->cpl_page;
494
495         int result;
496
497         ENTRY;
498
499         if (io->ci_type == CIT_READ || io->ci_type == CIT_WRITE ||
500             io->ci_type == CIT_FAULT) {
501                 if (cio->cui_fd->fd_flags & LL_FILE_GROUP_LOCKED)
502                         result = -EBUSY;
503                 else {
504                         desc->cld_start = page->cp_index;
505                         desc->cld_end   = page->cp_index;
506                         desc->cld_obj   = page->cp_obj;
507                         desc->cld_mode  = CLM_READ;
508                         result = cl_queue_match(&io->ci_lockset.cls_done,
509                                                 desc) ? -EBUSY : 0;
510                 }
511         } else
512                 result = 0;
513         RETURN(result);
514 }
515
516 int ccc_fail(const struct lu_env *env, const struct cl_page_slice *slice)
517 {
518         /*
519          * Cached read?
520          */
521         LBUG();
522         return 0;
523 }
524
525 void ccc_transient_page_verify(const struct cl_page *page)
526 {
527 }
528
529 int ccc_transient_page_own(const struct lu_env *env,
530                                    const struct cl_page_slice *slice,
531                                    struct cl_io *unused,
532                                    int nonblock)
533 {
534         ccc_transient_page_verify(slice->cpl_page);
535         return 0;
536 }
537
538 void ccc_transient_page_assume(const struct lu_env *env,
539                                       const struct cl_page_slice *slice,
540                                       struct cl_io *unused)
541 {
542         ccc_transient_page_verify(slice->cpl_page);
543 }
544
545 void ccc_transient_page_unassume(const struct lu_env *env,
546                                         const struct cl_page_slice *slice,
547                                         struct cl_io *unused)
548 {
549         ccc_transient_page_verify(slice->cpl_page);
550 }
551
552 void ccc_transient_page_disown(const struct lu_env *env,
553                                       const struct cl_page_slice *slice,
554                                       struct cl_io *unused)
555 {
556         ccc_transient_page_verify(slice->cpl_page);
557 }
558
559 void ccc_transient_page_discard(const struct lu_env *env,
560                                        const struct cl_page_slice *slice,
561                                        struct cl_io *unused)
562 {
563         struct cl_page *page = slice->cpl_page;
564
565         ccc_transient_page_verify(slice->cpl_page);
566
567         /*
568          * For transient pages, remove it from the radix tree.
569          */
570         cl_page_delete(env, page);
571 }
572
573 int ccc_transient_page_prep(const struct lu_env *env,
574                                    const struct cl_page_slice *slice,
575                                    struct cl_io *unused)
576 {
577         ENTRY;
578         /* transient page should always be sent. */
579         RETURN(0);
580 }
581
582 /*****************************************************************************
583  *
584  * Lock operations.
585  *
586  */
587
588 void ccc_lock_delete(const struct lu_env *env,
589                      const struct cl_lock_slice *slice)
590 {
591         CLOBINVRNT(env, slice->cls_obj, ccc_object_invariant(slice->cls_obj));
592 }
593
594 void ccc_lock_fini(const struct lu_env *env, struct cl_lock_slice *slice)
595 {
596         struct ccc_lock *clk = cl2ccc_lock(slice);
597         OBD_SLAB_FREE_PTR(clk, ccc_lock_kmem);
598 }
599
600 int ccc_lock_enqueue(const struct lu_env *env,
601                      const struct cl_lock_slice *slice,
602                      struct cl_io *unused, __u32 enqflags)
603 {
604         CLOBINVRNT(env, slice->cls_obj, ccc_object_invariant(slice->cls_obj));
605         return 0;
606 }
607
608 int ccc_lock_unuse(const struct lu_env *env, const struct cl_lock_slice *slice)
609 {
610         CLOBINVRNT(env, slice->cls_obj, ccc_object_invariant(slice->cls_obj));
611         return 0;
612 }
613
614 int ccc_lock_wait(const struct lu_env *env, const struct cl_lock_slice *slice)
615 {
616         CLOBINVRNT(env, slice->cls_obj, ccc_object_invariant(slice->cls_obj));
617         return 0;
618 }
619
620 /**
621  * Implementation of cl_lock_operations::clo_fits_into() methods for ccc
622  * layer. This function is executed every time io finds an existing lock in
623  * the lock cache while creating new lock. This function has to decide whether
624  * cached lock "fits" into io.
625  *
626  * \param slice lock to be checked
627  * \param io    IO that wants a lock.
628  *
629  * \see lov_lock_fits_into().
630  */
631 int ccc_lock_fits_into(const struct lu_env *env,
632                        const struct cl_lock_slice *slice,
633                        const struct cl_lock_descr *need,
634                        const struct cl_io *io)
635 {
636         const struct cl_lock       *lock  = slice->cls_lock;
637         const struct cl_lock_descr *descr = &lock->cll_descr;
638         const struct ccc_io        *cio   = ccc_env_io(env);
639         int                         result;
640
641         ENTRY;
642         /*
643          * Work around DLM peculiarity: it assumes that glimpse
644          * (LDLM_FL_HAS_INTENT) lock is always LCK_PR, and returns reads lock
645          * when asked for LCK_PW lock with LDLM_FL_HAS_INTENT flag set. Make
646          * sure that glimpse doesn't get CLM_WRITE top-lock, so that it
647          * doesn't enqueue CLM_WRITE sub-locks.
648          */
649         if (cio->cui_glimpse)
650                 result = descr->cld_mode != CLM_WRITE;
651
652         /*
653          * Also, don't match incomplete write locks for read, otherwise read
654          * would enqueue missing sub-locks in the write mode.
655          */
656         else if (need->cld_mode != descr->cld_mode)
657                 result = lock->cll_state >= CLS_ENQUEUED;
658         else
659                 result = 1;
660         RETURN(result);
661 }
662
663 /**
664  * Implements cl_lock_operations::clo_state() method for ccc layer, invoked
665  * whenever lock state changes. Transfers object attributes, that might be
666  * updated as a result of lock acquiring into inode.
667  */
668 void ccc_lock_state(const struct lu_env *env,
669                     const struct cl_lock_slice *slice,
670                     enum cl_lock_state state)
671 {
672         struct cl_lock   *lock;
673         struct cl_object *obj;
674         struct inode     *inode;
675         struct cl_attr   *attr;
676
677         ENTRY;
678         lock = slice->cls_lock;
679
680         /*
681          * Refresh inode attributes when the lock is moving into CLS_HELD
682          * state, and only when this is a result of real enqueue, rather than
683          * of finding lock in the cache.
684          */
685         if (state == CLS_HELD && lock->cll_state < CLS_HELD) {
686                 int rc;
687
688                 obj   = slice->cls_obj;
689                 inode = ccc_object_inode(obj);
690                 attr  = ccc_env_thread_attr(env);
691
692                 /* vmtruncate() sets the i_size
693                  * under both a DLM lock and the
694                  * ll_inode_size_lock().  If we don't get the
695                  * ll_inode_size_lock() here we can match the DLM lock and
696                  * reset i_size.  generic_file_write can then trust the
697                  * stale i_size when doing appending writes and effectively
698                  * cancel the result of the truncate.  Getting the
699                  * ll_inode_size_lock() after the enqueue maintains the DLM
700                  * -> ll_inode_size_lock() acquiring order. */
701                 ccc_object_size_lock(obj);
702                 rc = cl_object_attr_get(env, obj, attr);
703                 if (rc == 0) {
704                         if (lock->cll_descr.cld_start == 0 &&
705                             lock->cll_descr.cld_end == CL_PAGE_EOF) {
706                                 cl_isize_write_nolock(inode, attr->cat_kms);
707                                 CDEBUG(D_INODE|D_VFSTRACE,
708                                        DFID" updating i_size "LPU64"\n",
709                                        PFID(lu_object_fid(&obj->co_lu)),
710                                        (__u64)cl_isize_read(inode));
711                         }
712                         cl_inode_mtime(inode) = attr->cat_mtime;
713                         cl_inode_atime(inode) = attr->cat_atime;
714                         cl_inode_ctime(inode) = attr->cat_ctime;
715                 } else {
716                         CL_LOCK_DEBUG(D_INFO, env, lock, "attr_get: %d\n", rc);
717                 }
718                 ccc_object_size_unlock(obj);
719         }
720         EXIT;
721 }
722
723 /*****************************************************************************
724  *
725  * io operations.
726  *
727  */
728
729 void ccc_io_fini(const struct lu_env *env, const struct cl_io_slice *ios)
730 {
731         struct cl_io *io = ios->cis_io;
732
733         CLOBINVRNT(env, io->ci_obj, ccc_object_invariant(io->ci_obj));
734 }
735
736 int ccc_io_one_lock_index(const struct lu_env *env, struct cl_io *io,
737                           __u32 enqflags, enum cl_lock_mode mode,
738                           pgoff_t start, pgoff_t end)
739 {
740         struct ccc_io          *cio   = ccc_env_io(env);
741         struct cl_lock_descr   *descr = &cio->cui_link.cill_descr;
742         struct cl_object       *obj   = io->ci_obj;
743
744         CLOBINVRNT(env, obj, ccc_object_invariant(obj));
745         ENTRY;
746
747         CDEBUG(D_VFSTRACE, "lock: %d [%lu, %lu]\n", mode, start, end);
748
749         memset(&cio->cui_link, 0, sizeof cio->cui_link);
750
751         if (cio->cui_fd && (cio->cui_fd->fd_flags & LL_FILE_GROUP_LOCKED)) {
752                 descr->cld_mode = CLM_GROUP;
753                 descr->cld_gid  = cio->cui_fd->fd_grouplock.cg_gid;
754         } else {
755                 descr->cld_mode  = mode;
756         }
757         descr->cld_obj   = obj;
758         descr->cld_start = start;
759         descr->cld_end   = end;
760         descr->cld_enq_flags = enqflags;
761
762         cl_io_lock_add(env, io, &cio->cui_link);
763         RETURN(0);
764 }
765
766 void ccc_io_update_iov(const struct lu_env *env,
767                        struct ccc_io *cio, struct cl_io *io)
768 {
769         int i;
770         size_t size = io->u.ci_rw.crw_count;
771
772         cio->cui_iov_olen = 0;
773         if (!cl_is_normalio(env, io))
774                 return;
775
776         for (i = 0; i < cio->cui_tot_nrsegs; i++) {
777                 struct iovec *iv = &cio->cui_iov[i];
778
779                 if (iv->iov_len < size)
780                         size -= iv->iov_len;
781                 else {
782                         if (iv->iov_len > size) {
783                                 cio->cui_iov_olen = iv->iov_len;
784                                 iv->iov_len = size;
785                         }
786                         break;
787                 }
788         }
789
790         cio->cui_nrsegs = i + 1;
791 }
792
793 int ccc_io_one_lock(const struct lu_env *env, struct cl_io *io,
794                     __u32 enqflags, enum cl_lock_mode mode,
795                     loff_t start, loff_t end)
796 {
797         struct cl_object *obj = io->ci_obj;
798         return ccc_io_one_lock_index(env, io, enqflags, mode,
799                                      cl_index(obj, start), cl_index(obj, end));
800 }
801
802 void ccc_io_end(const struct lu_env *env, const struct cl_io_slice *ios)
803 {
804         CLOBINVRNT(env, ios->cis_io->ci_obj,
805                    ccc_object_invariant(ios->cis_io->ci_obj));
806 }
807
808 void ccc_io_advance(const struct lu_env *env,
809                     const struct cl_io_slice *ios,
810                     size_t nob)
811 {
812         struct ccc_io    *cio = cl2ccc_io(env, ios);
813         struct cl_io     *io  = ios->cis_io;
814         struct cl_object *obj = ios->cis_io->ci_obj;
815
816         CLOBINVRNT(env, obj, ccc_object_invariant(obj));
817
818         if (cl_is_normalio(env, io) && io->ci_continue) {
819                 /* update the iov */
820                 LASSERT(cio->cui_tot_nrsegs >= cio->cui_nrsegs);
821                 LASSERT(cio->cui_tot_count  >= nob);
822
823                 cio->cui_iov        += cio->cui_nrsegs;
824                 cio->cui_tot_nrsegs -= cio->cui_nrsegs;
825                 cio->cui_tot_count  -= nob;
826
827                 if (cio->cui_iov_olen) {
828                         struct iovec *iv;
829
830                         cio->cui_iov--;
831                         cio->cui_tot_nrsegs++;
832                         iv = &cio->cui_iov[0];
833                         iv->iov_base += iv->iov_len;
834                         LASSERT(cio->cui_iov_olen > iv->iov_len);
835                         iv->iov_len = cio->cui_iov_olen - iv->iov_len;
836                 }
837         }
838 }
839
840 /**
841  * Helper function that if necessary adjusts file size (inode->i_size), when
842  * position at the offset \a pos is accessed. File size can be arbitrary stale
843  * on a Lustre client, but client at least knows KMS. If accessed area is
844  * inside [0, KMS], set file size to KMS, otherwise glimpse file size.
845  *
846  * Locking: cl_isize_lock is used to serialize changes to inode size and to
847  * protect consistency between inode size and cl_object
848  * attributes. cl_object_size_lock() protects consistency between cl_attr's of
849  * top-object and sub-objects.
850  */
851 int ccc_prep_size(const struct lu_env *env, struct cl_object *obj,
852                   struct cl_io *io, loff_t start, size_t count, 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);
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);
890                         result = cl_glimpse_lock(env, io, inode, obj, 0);
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                         if (cl_isize_read(inode) < kms) {
917                                 cl_isize_write_nolock(inode, kms);
918                                 CDEBUG(D_VFSTRACE,
919                                        DFID" updating i_size "LPU64"\n",
920                                        PFID(lu_object_fid(&obj->co_lu)),
921                                        (__u64)cl_isize_read(inode));
922
923                         }
924                 }
925         }
926         ccc_object_size_unlock(obj);
927         return result;
928 }
929
930 /*****************************************************************************
931  *
932  * Transfer operations.
933  *
934  */
935
936 void ccc_req_completion(const struct lu_env *env,
937                         const struct cl_req_slice *slice, int ioret)
938 {
939         struct ccc_req *vrq;
940
941         if (ioret > 0)
942                 cl_stats_tally(slice->crs_dev, slice->crs_req->crq_type, ioret);
943
944         vrq = cl2ccc_req(slice);
945         OBD_SLAB_FREE_PTR(vrq, ccc_req_kmem);
946 }
947
948 /**
949  * Implementation of struct cl_req_operations::cro_attr_set() for ccc
950  * layer. ccc is responsible for
951  *
952  *    - o_[mac]time
953  *
954  *    - o_mode
955  *
956  *    - o_parent_seq
957  *
958  *    - o_[ug]id
959  *
960  *    - o_parent_oid
961  *
962  *    - o_parent_ver
963  *
964  *    - o_ioepoch,
965  *
966  *  and capability.
967  */
968 void ccc_req_attr_set(const struct lu_env *env,
969                       const struct cl_req_slice *slice,
970                       const struct cl_object *obj,
971                       struct cl_req_attr *attr, obd_valid flags)
972 {
973         struct inode *inode;
974         struct obdo  *oa;
975         obd_flag      valid_flags;
976
977         oa = attr->cra_oa;
978         inode = ccc_object_inode(obj);
979         valid_flags = OBD_MD_FLTYPE;
980
981         if ((flags & OBD_MD_FLOSSCAPA) != 0) {
982                 LASSERT(attr->cra_capa == NULL);
983                 attr->cra_capa = cl_capa_lookup(inode,
984                                                 slice->crs_req->crq_type);
985         }
986
987         if (slice->crs_req->crq_type == CRT_WRITE) {
988                 if (flags & OBD_MD_FLEPOCH) {
989                         oa->o_valid |= OBD_MD_FLEPOCH;
990                         oa->o_ioepoch = cl_i2info(inode)->lli_ioepoch;
991                         valid_flags |= OBD_MD_FLMTIME | OBD_MD_FLCTIME |
992                                        OBD_MD_FLUID | OBD_MD_FLGID;
993                 }
994         }
995         obdo_from_inode(oa, inode, valid_flags & flags);
996         obdo_set_parent_fid(oa, &cl_i2info(inode)->lli_fid);
997 #ifdef __KERNEL__
998         memcpy(attr->cra_jobid, cl_i2info(inode)->lli_jobid,
999                JOBSTATS_JOBID_SIZE);
1000 #endif
1001 }
1002
1003 const struct cl_req_operations ccc_req_ops = {
1004         .cro_attr_set   = ccc_req_attr_set,
1005         .cro_completion = ccc_req_completion
1006 };
1007
1008 int cl_setattr_ost(struct inode *inode, const struct iattr *attr,
1009                    struct obd_capa *capa)
1010 {
1011         struct lu_env *env;
1012         struct cl_io  *io;
1013         int            result;
1014         int            refcheck;
1015
1016         ENTRY;
1017
1018         env = cl_env_get(&refcheck);
1019         if (IS_ERR(env))
1020                 RETURN(PTR_ERR(env));
1021
1022         io = ccc_env_thread_io(env);
1023         io->ci_obj = cl_i2info(inode)->lli_clob;
1024
1025         io->u.ci_setattr.sa_attr.lvb_atime = LTIME_S(attr->ia_atime);
1026         io->u.ci_setattr.sa_attr.lvb_mtime = LTIME_S(attr->ia_mtime);
1027         io->u.ci_setattr.sa_attr.lvb_ctime = LTIME_S(attr->ia_ctime);
1028         io->u.ci_setattr.sa_attr.lvb_size = attr->ia_size;
1029         io->u.ci_setattr.sa_valid = attr->ia_valid;
1030         io->u.ci_setattr.sa_capa = capa;
1031
1032 again:
1033         if (cl_io_init(env, io, CIT_SETATTR, io->ci_obj) == 0) {
1034                 struct ccc_io *cio = ccc_env_io(env);
1035
1036                 if (attr->ia_valid & ATTR_FILE)
1037                         /* populate the file descriptor for ftruncate to honor
1038                          * group lock - see LU-787 */
1039                         cio->cui_fd = cl_iattr2fd(inode, attr);
1040
1041                 result = cl_io_loop(env, io);
1042         } else {
1043                 result = io->ci_result;
1044         }
1045         cl_io_fini(env, io);
1046         if (unlikely(io->ci_need_restart))
1047                 goto again;
1048         cl_env_put(env, &refcheck);
1049         RETURN(result);
1050 }
1051
1052 /*****************************************************************************
1053  *
1054  * Type conversions.
1055  *
1056  */
1057
1058 struct lu_device *ccc2lu_dev(struct ccc_device *vdv)
1059 {
1060         return &vdv->cdv_cl.cd_lu_dev;
1061 }
1062
1063 struct ccc_device *lu2ccc_dev(const struct lu_device *d)
1064 {
1065         return container_of0(d, struct ccc_device, cdv_cl.cd_lu_dev);
1066 }
1067
1068 struct ccc_device *cl2ccc_dev(const struct cl_device *d)
1069 {
1070         return container_of0(d, struct ccc_device, cdv_cl);
1071 }
1072
1073 struct lu_object *ccc2lu(struct ccc_object *vob)
1074 {
1075         return &vob->cob_cl.co_lu;
1076 }
1077
1078 struct ccc_object *lu2ccc(const struct lu_object *obj)
1079 {
1080         return container_of0(obj, struct ccc_object, cob_cl.co_lu);
1081 }
1082
1083 struct ccc_object *cl2ccc(const struct cl_object *obj)
1084 {
1085         return container_of0(obj, struct ccc_object, cob_cl);
1086 }
1087
1088 struct ccc_lock *cl2ccc_lock(const struct cl_lock_slice *slice)
1089 {
1090         return container_of(slice, struct ccc_lock, clk_cl);
1091 }
1092
1093 struct ccc_io *cl2ccc_io(const struct lu_env *env,
1094                          const struct cl_io_slice *slice)
1095 {
1096         struct ccc_io *cio;
1097
1098         cio = container_of(slice, struct ccc_io, cui_cl);
1099         LASSERT(cio == ccc_env_io(env));
1100         return cio;
1101 }
1102
1103 struct ccc_req *cl2ccc_req(const struct cl_req_slice *slice)
1104 {
1105         return container_of0(slice, struct ccc_req, crq_cl);
1106 }
1107
1108 cfs_page_t *cl2vm_page(const struct cl_page_slice *slice)
1109 {
1110         return cl2ccc_page(slice)->cpg_page;
1111 }
1112
1113 /*****************************************************************************
1114  *
1115  * Accessors.
1116  *
1117  */
1118 int ccc_object_invariant(const struct cl_object *obj)
1119 {
1120         struct inode         *inode = ccc_object_inode(obj);
1121         struct cl_inode_info *lli   = cl_i2info(inode);
1122
1123         return (S_ISREG(cl_inode_mode(inode)) ||
1124                 /* i_mode of unlinked inode is zeroed. */
1125                 cl_inode_mode(inode) == 0) && lli->lli_clob == obj;
1126 }
1127
1128 struct inode *ccc_object_inode(const struct cl_object *obj)
1129 {
1130         return cl2ccc(obj)->cob_inode;
1131 }
1132
1133 /**
1134  * Returns a pointer to cl_page associated with \a vmpage, without acquiring
1135  * additional reference to the resulting page. This is an unsafe version of
1136  * cl_vmpage_page() that can only be used under vmpage lock.
1137  */
1138 struct cl_page *ccc_vmpage_page_transient(cfs_page_t *vmpage)
1139 {
1140         KLASSERT(PageLocked(vmpage));
1141         return (struct cl_page *)vmpage->private;
1142 }
1143
1144 /**
1145  * Initialize or update CLIO structures for regular files when new
1146  * meta-data arrives from the server.
1147  *
1148  * \param inode regular file inode
1149  * \param md    new file metadata from MDS
1150  * - allocates cl_object if necessary,
1151  * - updated layout, if object was already here.
1152  */
1153 int cl_file_inode_init(struct inode *inode, struct lustre_md *md)
1154 {
1155         struct lu_env        *env;
1156         struct cl_inode_info *lli;
1157         struct cl_object     *clob;
1158         struct lu_site       *site;
1159         struct lu_fid        *fid;
1160         struct cl_object_conf conf = {
1161                 .coc_inode = inode,
1162                 .u = {
1163                         .coc_md    = md
1164                 }
1165         };
1166         int result = 0;
1167         int refcheck;
1168
1169         LASSERT(md->body->valid & OBD_MD_FLID);
1170         LASSERT(S_ISREG(cl_inode_mode(inode)));
1171
1172         env = cl_env_get(&refcheck);
1173         if (IS_ERR(env))
1174                 return PTR_ERR(env);
1175
1176         site = cl_i2sbi(inode)->ll_site;
1177         lli  = cl_i2info(inode);
1178         fid  = &lli->lli_fid;
1179         LASSERT(fid_is_sane(fid));
1180
1181         if (lli->lli_clob == NULL) {
1182                 /* clob is slave of inode, empty lli_clob means for new inode,
1183                  * there is no clob in cache with the given fid, so it is
1184                  * unnecessary to perform lookup-alloc-lookup-insert, just
1185                  * alloc and insert directly. */
1186 #ifdef __KERNEL__
1187                 LASSERT(inode->i_state & I_NEW);
1188 #endif
1189                 conf.coc_lu.loc_flags = LOC_F_NEW;
1190                 clob = cl_object_find(env, lu2cl_dev(site->ls_top_dev),
1191                                       fid, &conf);
1192                 if (!IS_ERR(clob)) {
1193                         /*
1194                          * No locking is necessary, as new inode is
1195                          * locked by I_NEW bit.
1196                          *
1197                          * XXX not true for call from ll_update_inode().
1198                          */
1199                         lli->lli_clob = clob;
1200                         lu_object_ref_add(&clob->co_lu, "inode", inode);
1201                 } else
1202                         result = PTR_ERR(clob);
1203         } else
1204                 result = cl_conf_set(env, lli->lli_clob, &conf);
1205         cl_env_put(env, &refcheck);
1206
1207         if (result != 0)
1208                 CERROR("Failure to initialize cl object "DFID": %d\n",
1209                        PFID(fid), result);
1210         return result;
1211 }
1212
1213 /**
1214  * Wait for others drop their references of the object at first, then we drop
1215  * the last one, which will lead to the object be destroyed immediately.
1216  * Must be called after cl_object_kill() against this object.
1217  *
1218  * The reason we want to do this is: destroying top object will wait for sub
1219  * objects being destroyed first, so we can't let bottom layer (e.g. from ASTs)
1220  * to initiate top object destroying which may deadlock. See bz22520.
1221  */
1222 static void cl_object_put_last(struct lu_env *env, struct cl_object *obj)
1223 {
1224         struct lu_object_header *header = obj->co_lu.lo_header;
1225         cfs_waitlink_t           waiter;
1226
1227         if (unlikely(cfs_atomic_read(&header->loh_ref) != 1)) {
1228                 struct lu_site *site = obj->co_lu.lo_dev->ld_site;
1229                 struct lu_site_bkt_data *bkt;
1230
1231                 bkt = lu_site_bkt_from_fid(site, &header->loh_fid);
1232
1233                 cfs_waitlink_init(&waiter);
1234                 cfs_waitq_add(&bkt->lsb_marche_funebre, &waiter);
1235
1236                 while (1) {
1237                         cfs_set_current_state(CFS_TASK_UNINT);
1238                         if (cfs_atomic_read(&header->loh_ref) == 1)
1239                                 break;
1240                         cfs_waitq_wait(&waiter, CFS_TASK_UNINT);
1241                 }
1242
1243                 cfs_set_current_state(CFS_TASK_RUNNING);
1244                 cfs_waitq_del(&bkt->lsb_marche_funebre, &waiter);
1245         }
1246
1247         cl_object_put(env, obj);
1248 }
1249
1250 void cl_inode_fini(struct inode *inode)
1251 {
1252         struct lu_env           *env;
1253         struct cl_inode_info    *lli  = cl_i2info(inode);
1254         struct cl_object        *clob = lli->lli_clob;
1255         int refcheck;
1256         int emergency;
1257
1258         if (clob != NULL) {
1259                 void                    *cookie;
1260
1261                 cookie = cl_env_reenter();
1262                 env = cl_env_get(&refcheck);
1263                 emergency = IS_ERR(env);
1264                 if (emergency) {
1265                         mutex_lock(&ccc_inode_fini_guard);
1266                         LASSERT(ccc_inode_fini_env != NULL);
1267                         cl_env_implant(ccc_inode_fini_env, &refcheck);
1268                         env = ccc_inode_fini_env;
1269                 }
1270                 /*
1271                  * cl_object cache is a slave to inode cache (which, in turn
1272                  * is a slave to dentry cache), don't keep cl_object in memory
1273                  * when its master is evicted.
1274                  */
1275                 cl_object_kill(env, clob);
1276                 lu_object_ref_del(&clob->co_lu, "inode", inode);
1277                 cl_object_put_last(env, clob);
1278                 lli->lli_clob = NULL;
1279                 if (emergency) {
1280                         cl_env_unplant(ccc_inode_fini_env, &refcheck);
1281                         mutex_unlock(&ccc_inode_fini_guard);
1282                 } else
1283                         cl_env_put(env, &refcheck);
1284                 cl_env_reexit(cookie);
1285         }
1286 }
1287
1288 /**
1289  * return IF_* type for given lu_dirent entry.
1290  * IF_* flag shld be converted to particular OS file type in
1291  * platform llite module.
1292  */
1293 __u16 ll_dirent_type_get(struct lu_dirent *ent)
1294 {
1295         __u16 type = 0;
1296         struct luda_type *lt;
1297         int len = 0;
1298
1299         if (le32_to_cpu(ent->lde_attrs) & LUDA_TYPE) {
1300                 const unsigned align = sizeof(struct luda_type) - 1;
1301
1302                 len = le16_to_cpu(ent->lde_namelen);
1303                 len = (len + align) & ~align;
1304                 lt = (void *) ent->lde_name + len;
1305                 type = CFS_IFTODT(le16_to_cpu(lt->lt_type));
1306         }
1307         return type;
1308 }
1309
1310 /**
1311  * build inode number from passed @fid */
1312 __u64 cl_fid_build_ino(const struct lu_fid *fid, int api32)
1313 {
1314         if (BITS_PER_LONG == 32 || api32)
1315                 RETURN(fid_flatten32(fid));
1316         else
1317                 RETURN(fid_flatten(fid));
1318 }
1319
1320 /**
1321  * build inode generation from passed @fid.  If our FID overflows the 32-bit
1322  * inode number then return a non-zero generation to distinguish them. */
1323 __u32 cl_fid_build_gen(const struct lu_fid *fid)
1324 {
1325         __u32 gen;
1326         ENTRY;
1327
1328         if (fid_is_igif(fid)) {
1329                 gen = lu_igif_gen(fid);
1330                 RETURN(gen);
1331         }
1332
1333         gen = (fid_flatten(fid) >> 32);
1334         RETURN(gen);
1335 }
1336
1337 /* lsm is unreliable after hsm implementation as layout can be changed at
1338  * any time. This is only to support old, non-clio-ized interfaces. It will
1339  * cause deadlock if clio operations are called with this extra layout refcount
1340  * because in case the layout changed during the IO, ll_layout_refresh() will
1341  * have to wait for the refcount to become zero to destroy the older layout.
1342  *
1343  * Notice that the lsm returned by this function may not be valid unless called
1344  * inside layout lock - MDS_INODELOCK_LAYOUT. */
1345 struct lov_stripe_md *ccc_inode_lsm_get(struct inode *inode)
1346 {
1347         return lov_lsm_get(cl_i2info(inode)->lli_clob);
1348 }
1349
1350 void inline ccc_inode_lsm_put(struct inode *inode, struct lov_stripe_md *lsm)
1351 {
1352         lov_lsm_put(cl_i2info(inode)->lli_clob, lsm);
1353 }