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