Whamcloud - gitweb
LU-1876 hsm: revise ll_setattr_raw to not check stripe data
[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         cl_object_page_init(&vob->cob_cl, sizeof(struct ccc_page));
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 static void ccc_object_size_lock(struct cl_object *obj)
461 {
462         struct inode *inode = ccc_object_inode(obj);
463
464         cl_isize_lock(inode);
465         cl_object_attr_lock(obj);
466 }
467
468 static void ccc_object_size_unlock(struct cl_object *obj)
469 {
470         struct inode *inode = ccc_object_inode(obj);
471
472         cl_object_attr_unlock(obj);
473         cl_isize_unlock(inode);
474 }
475
476 /*****************************************************************************
477  *
478  * Page operations.
479  *
480  */
481
482 cfs_page_t *ccc_page_vmpage(const struct lu_env *env,
483                             const struct cl_page_slice *slice)
484 {
485         return cl2vm_page(slice);
486 }
487
488 int ccc_page_is_under_lock(const struct lu_env *env,
489                            const struct cl_page_slice *slice,
490                            struct cl_io *io)
491 {
492         struct ccc_io        *cio  = ccc_env_io(env);
493         struct cl_lock_descr *desc = &ccc_env_info(env)->cti_descr;
494         struct cl_page       *page = slice->cpl_page;
495
496         int result;
497
498         ENTRY;
499
500         if (io->ci_type == CIT_READ || io->ci_type == CIT_WRITE ||
501             io->ci_type == CIT_FAULT) {
502                 if (cio->cui_fd->fd_flags & LL_FILE_GROUP_LOCKED)
503                         result = -EBUSY;
504                 else {
505                         desc->cld_start = page->cp_index;
506                         desc->cld_end   = page->cp_index;
507                         desc->cld_obj   = page->cp_obj;
508                         desc->cld_mode  = CLM_READ;
509                         result = cl_queue_match(&io->ci_lockset.cls_done,
510                                                 desc) ? -EBUSY : 0;
511                 }
512         } else
513                 result = 0;
514         RETURN(result);
515 }
516
517 int ccc_fail(const struct lu_env *env, const struct cl_page_slice *slice)
518 {
519         /*
520          * Cached read?
521          */
522         LBUG();
523         return 0;
524 }
525
526 void ccc_transient_page_verify(const struct cl_page *page)
527 {
528 }
529
530 int ccc_transient_page_own(const struct lu_env *env,
531                                    const struct cl_page_slice *slice,
532                                    struct cl_io *unused,
533                                    int nonblock)
534 {
535         ccc_transient_page_verify(slice->cpl_page);
536         return 0;
537 }
538
539 void ccc_transient_page_assume(const struct lu_env *env,
540                                       const struct cl_page_slice *slice,
541                                       struct cl_io *unused)
542 {
543         ccc_transient_page_verify(slice->cpl_page);
544 }
545
546 void ccc_transient_page_unassume(const struct lu_env *env,
547                                         const struct cl_page_slice *slice,
548                                         struct cl_io *unused)
549 {
550         ccc_transient_page_verify(slice->cpl_page);
551 }
552
553 void ccc_transient_page_disown(const struct lu_env *env,
554                                       const struct cl_page_slice *slice,
555                                       struct cl_io *unused)
556 {
557         ccc_transient_page_verify(slice->cpl_page);
558 }
559
560 void ccc_transient_page_discard(const struct lu_env *env,
561                                        const struct cl_page_slice *slice,
562                                        struct cl_io *unused)
563 {
564         struct cl_page *page = slice->cpl_page;
565
566         ccc_transient_page_verify(slice->cpl_page);
567
568         /*
569          * For transient pages, remove it from the radix tree.
570          */
571         cl_page_delete(env, page);
572 }
573
574 int ccc_transient_page_prep(const struct lu_env *env,
575                                    const struct cl_page_slice *slice,
576                                    struct cl_io *unused)
577 {
578         ENTRY;
579         /* transient page should always be sent. */
580         RETURN(0);
581 }
582
583 /*****************************************************************************
584  *
585  * Lock operations.
586  *
587  */
588
589 void ccc_lock_delete(const struct lu_env *env,
590                      const struct cl_lock_slice *slice)
591 {
592         CLOBINVRNT(env, slice->cls_obj, ccc_object_invariant(slice->cls_obj));
593 }
594
595 void ccc_lock_fini(const struct lu_env *env, struct cl_lock_slice *slice)
596 {
597         struct ccc_lock *clk = cl2ccc_lock(slice);
598         OBD_SLAB_FREE_PTR(clk, ccc_lock_kmem);
599 }
600
601 int ccc_lock_enqueue(const struct lu_env *env,
602                      const struct cl_lock_slice *slice,
603                      struct cl_io *unused, __u32 enqflags)
604 {
605         CLOBINVRNT(env, slice->cls_obj, ccc_object_invariant(slice->cls_obj));
606         return 0;
607 }
608
609 int ccc_lock_unuse(const struct lu_env *env, const struct cl_lock_slice *slice)
610 {
611         CLOBINVRNT(env, slice->cls_obj, ccc_object_invariant(slice->cls_obj));
612         return 0;
613 }
614
615 int ccc_lock_wait(const struct lu_env *env, const struct cl_lock_slice *slice)
616 {
617         CLOBINVRNT(env, slice->cls_obj, ccc_object_invariant(slice->cls_obj));
618         return 0;
619 }
620
621 /**
622  * Implementation of cl_lock_operations::clo_fits_into() methods for ccc
623  * layer. This function is executed every time io finds an existing lock in
624  * the lock cache while creating new lock. This function has to decide whether
625  * cached lock "fits" into io.
626  *
627  * \param slice lock to be checked
628  * \param io    IO that wants a lock.
629  *
630  * \see lov_lock_fits_into().
631  */
632 int ccc_lock_fits_into(const struct lu_env *env,
633                        const struct cl_lock_slice *slice,
634                        const struct cl_lock_descr *need,
635                        const struct cl_io *io)
636 {
637         const struct cl_lock       *lock  = slice->cls_lock;
638         const struct cl_lock_descr *descr = &lock->cll_descr;
639         const struct ccc_io        *cio   = ccc_env_io(env);
640         int                         result;
641
642         ENTRY;
643         /*
644          * Work around DLM peculiarity: it assumes that glimpse
645          * (LDLM_FL_HAS_INTENT) lock is always LCK_PR, and returns reads lock
646          * when asked for LCK_PW lock with LDLM_FL_HAS_INTENT flag set. Make
647          * sure that glimpse doesn't get CLM_WRITE top-lock, so that it
648          * doesn't enqueue CLM_WRITE sub-locks.
649          */
650         if (cio->cui_glimpse)
651                 result = descr->cld_mode != CLM_WRITE;
652
653         /*
654          * Also, don't match incomplete write locks for read, otherwise read
655          * would enqueue missing sub-locks in the write mode.
656          */
657         else if (need->cld_mode != descr->cld_mode)
658                 result = lock->cll_state >= CLS_ENQUEUED;
659         else
660                 result = 1;
661         RETURN(result);
662 }
663
664 /**
665  * Implements cl_lock_operations::clo_state() method for ccc layer, invoked
666  * whenever lock state changes. Transfers object attributes, that might be
667  * updated as a result of lock acquiring into inode.
668  */
669 void ccc_lock_state(const struct lu_env *env,
670                     const struct cl_lock_slice *slice,
671                     enum cl_lock_state state)
672 {
673         struct cl_lock *lock = slice->cls_lock;
674         ENTRY;
675
676         /*
677          * Refresh inode attributes when the lock is moving into CLS_HELD
678          * state, and only when this is a result of real enqueue, rather than
679          * of finding lock in the cache.
680          */
681         if (state == CLS_HELD && lock->cll_state < CLS_HELD) {
682                 struct cl_object *obj;
683                 struct inode     *inode;
684
685                 obj   = slice->cls_obj;
686                 inode = ccc_object_inode(obj);
687
688                 /* vmtruncate() sets the i_size
689                  * under both a DLM lock and the
690                  * ll_inode_size_lock().  If we don't get the
691                  * ll_inode_size_lock() here we can match the DLM lock and
692                  * reset i_size.  generic_file_write can then trust the
693                  * stale i_size when doing appending writes and effectively
694                  * cancel the result of the truncate.  Getting the
695                  * ll_inode_size_lock() after the enqueue maintains the DLM
696                  * -> ll_inode_size_lock() acquiring order. */
697                 if (lock->cll_descr.cld_start == 0 &&
698                     lock->cll_descr.cld_end == CL_PAGE_EOF)
699                         cl_merge_lvb(env, inode);
700         }
701         EXIT;
702 }
703
704 /*****************************************************************************
705  *
706  * io operations.
707  *
708  */
709
710 void ccc_io_fini(const struct lu_env *env, const struct cl_io_slice *ios)
711 {
712         struct cl_io *io = ios->cis_io;
713
714         CLOBINVRNT(env, io->ci_obj, ccc_object_invariant(io->ci_obj));
715 }
716
717 int ccc_io_one_lock_index(const struct lu_env *env, struct cl_io *io,
718                           __u32 enqflags, enum cl_lock_mode mode,
719                           pgoff_t start, pgoff_t end)
720 {
721         struct ccc_io          *cio   = ccc_env_io(env);
722         struct cl_lock_descr   *descr = &cio->cui_link.cill_descr;
723         struct cl_object       *obj   = io->ci_obj;
724
725         CLOBINVRNT(env, obj, ccc_object_invariant(obj));
726         ENTRY;
727
728         CDEBUG(D_VFSTRACE, "lock: %d [%lu, %lu]\n", mode, start, end);
729
730         memset(&cio->cui_link, 0, sizeof cio->cui_link);
731
732         if (cio->cui_fd && (cio->cui_fd->fd_flags & LL_FILE_GROUP_LOCKED)) {
733                 descr->cld_mode = CLM_GROUP;
734                 descr->cld_gid  = cio->cui_fd->fd_grouplock.cg_gid;
735         } else {
736                 descr->cld_mode  = mode;
737         }
738         descr->cld_obj   = obj;
739         descr->cld_start = start;
740         descr->cld_end   = end;
741         descr->cld_enq_flags = enqflags;
742
743         cl_io_lock_add(env, io, &cio->cui_link);
744         RETURN(0);
745 }
746
747 void ccc_io_update_iov(const struct lu_env *env,
748                        struct ccc_io *cio, struct cl_io *io)
749 {
750         int i;
751         size_t size = io->u.ci_rw.crw_count;
752
753         cio->cui_iov_olen = 0;
754         if (!cl_is_normalio(env, io) || cio->cui_tot_nrsegs == 0)
755                 return;
756
757         for (i = 0; i < cio->cui_tot_nrsegs; i++) {
758                 struct iovec *iv = &cio->cui_iov[i];
759
760                 if (iv->iov_len < size)
761                         size -= iv->iov_len;
762                 else {
763                         if (iv->iov_len > size) {
764                                 cio->cui_iov_olen = iv->iov_len;
765                                 iv->iov_len = size;
766                         }
767                         break;
768                 }
769         }
770
771         cio->cui_nrsegs = i + 1;
772         LASSERTF(cio->cui_tot_nrsegs >= cio->cui_nrsegs,
773                  "tot_nrsegs: %lu, nrsegs: %lu\n",
774                  cio->cui_tot_nrsegs, cio->cui_nrsegs);
775 }
776
777 int ccc_io_one_lock(const struct lu_env *env, struct cl_io *io,
778                     __u32 enqflags, enum cl_lock_mode mode,
779                     loff_t start, loff_t end)
780 {
781         struct cl_object *obj = io->ci_obj;
782         return ccc_io_one_lock_index(env, io, enqflags, mode,
783                                      cl_index(obj, start), cl_index(obj, end));
784 }
785
786 void ccc_io_end(const struct lu_env *env, const struct cl_io_slice *ios)
787 {
788         CLOBINVRNT(env, ios->cis_io->ci_obj,
789                    ccc_object_invariant(ios->cis_io->ci_obj));
790 }
791
792 void ccc_io_advance(const struct lu_env *env,
793                     const struct cl_io_slice *ios,
794                     size_t nob)
795 {
796         struct ccc_io    *cio = cl2ccc_io(env, ios);
797         struct cl_io     *io  = ios->cis_io;
798         struct cl_object *obj = ios->cis_io->ci_obj;
799
800         CLOBINVRNT(env, obj, ccc_object_invariant(obj));
801
802         if (!cl_is_normalio(env, io))
803                 return;
804
805         LASSERT(cio->cui_tot_nrsegs >= cio->cui_nrsegs);
806         LASSERT(cio->cui_tot_count  >= nob);
807
808         cio->cui_iov        += cio->cui_nrsegs;
809         cio->cui_tot_nrsegs -= cio->cui_nrsegs;
810         cio->cui_tot_count  -= nob;
811
812         /* update the iov */
813         if (cio->cui_iov_olen > 0) {
814                 struct iovec *iv;
815
816                 cio->cui_iov--;
817                 cio->cui_tot_nrsegs++;
818                 iv = &cio->cui_iov[0];
819                 if (io->ci_continue) {
820                         iv->iov_base += iv->iov_len;
821                         LASSERT(cio->cui_iov_olen > iv->iov_len);
822                         iv->iov_len = cio->cui_iov_olen - iv->iov_len;
823                 } else {
824                         /* restore the iov_len, in case of restart io. */
825                         iv->iov_len = cio->cui_iov_olen;
826                 }
827                 cio->cui_iov_olen = 0;
828         }
829 }
830
831 /**
832  * Helper function that if necessary adjusts file size (inode->i_size), when
833  * position at the offset \a pos is accessed. File size can be arbitrary stale
834  * on a Lustre client, but client at least knows KMS. If accessed area is
835  * inside [0, KMS], set file size to KMS, otherwise glimpse file size.
836  *
837  * Locking: cl_isize_lock is used to serialize changes to inode size and to
838  * protect consistency between inode size and cl_object
839  * attributes. cl_object_size_lock() protects consistency between cl_attr's of
840  * top-object and sub-objects.
841  */
842 int ccc_prep_size(const struct lu_env *env, struct cl_object *obj,
843                   struct cl_io *io, loff_t start, size_t count, int *exceed)
844 {
845         struct cl_attr *attr  = ccc_env_thread_attr(env);
846         struct inode   *inode = ccc_object_inode(obj);
847         loff_t          pos   = start + count - 1;
848         loff_t kms;
849         int result;
850
851         /*
852          * Consistency guarantees: following possibilities exist for the
853          * relation between region being accessed and real file size at this
854          * moment:
855          *
856          *  (A): the region is completely inside of the file;
857          *
858          *  (B-x): x bytes of region are inside of the file, the rest is
859          *  outside;
860          *
861          *  (C): the region is completely outside of the file.
862          *
863          * This classification is stable under DLM lock already acquired by
864          * the caller, because to change the class, other client has to take
865          * DLM lock conflicting with our lock. Also, any updates to ->i_size
866          * by other threads on this client are serialized by
867          * ll_inode_size_lock(). This guarantees that short reads are handled
868          * correctly in the face of concurrent writes and truncates.
869          */
870         ccc_object_size_lock(obj);
871         result = cl_object_attr_get(env, obj, attr);
872         if (result == 0) {
873                 kms = attr->cat_kms;
874                 if (pos > kms) {
875                         /*
876                          * A glimpse is necessary to determine whether we
877                          * return a short read (B) or some zeroes at the end
878                          * of the buffer (C)
879                          */
880                         ccc_object_size_unlock(obj);
881                         result = cl_glimpse_lock(env, io, inode, obj, 0);
882                         if (result == 0 && exceed != NULL) {
883                                 /* If objective page index exceed end-of-file
884                                  * page index, return directly. Do not expect
885                                  * kernel will check such case correctly.
886                                  * linux-2.6.18-128.1.1 miss to do that.
887                                  * --bug 17336 */
888                                 loff_t size = cl_isize_read(inode);
889                                 unsigned long cur_index = start >> CFS_PAGE_SHIFT;
890
891                                 if ((size == 0 && cur_index != 0) ||
892                                     (((size - 1) >> CFS_PAGE_SHIFT) < cur_index))
893                                 *exceed = 1;
894                         }
895                         return result;
896                 } else {
897                         /*
898                          * region is within kms and, hence, within real file
899                          * size (A). We need to increase i_size to cover the
900                          * read region so that generic_file_read() will do its
901                          * job, but that doesn't mean the kms size is
902                          * _correct_, it is only the _minimum_ size. If
903                          * someone does a stat they will get the correct size
904                          * which will always be >= the kms value here.
905                          * b=11081
906                          */
907                         if (cl_isize_read(inode) < kms) {
908                                 cl_isize_write_nolock(inode, kms);
909                                 CDEBUG(D_VFSTRACE,
910                                        DFID" updating i_size "LPU64"\n",
911                                        PFID(lu_object_fid(&obj->co_lu)),
912                                        (__u64)cl_isize_read(inode));
913
914                         }
915                 }
916         }
917         ccc_object_size_unlock(obj);
918         return result;
919 }
920
921 /*****************************************************************************
922  *
923  * Transfer operations.
924  *
925  */
926
927 void ccc_req_completion(const struct lu_env *env,
928                         const struct cl_req_slice *slice, int ioret)
929 {
930         struct ccc_req *vrq;
931
932         if (ioret > 0)
933                 cl_stats_tally(slice->crs_dev, slice->crs_req->crq_type, ioret);
934
935         vrq = cl2ccc_req(slice);
936         OBD_SLAB_FREE_PTR(vrq, ccc_req_kmem);
937 }
938
939 /**
940  * Implementation of struct cl_req_operations::cro_attr_set() for ccc
941  * layer. ccc is responsible for
942  *
943  *    - o_[mac]time
944  *
945  *    - o_mode
946  *
947  *    - o_parent_seq
948  *
949  *    - o_[ug]id
950  *
951  *    - o_parent_oid
952  *
953  *    - o_parent_ver
954  *
955  *    - o_ioepoch,
956  *
957  *  and capability.
958  */
959 void ccc_req_attr_set(const struct lu_env *env,
960                       const struct cl_req_slice *slice,
961                       const struct cl_object *obj,
962                       struct cl_req_attr *attr, obd_valid flags)
963 {
964         struct inode *inode;
965         struct obdo  *oa;
966         obd_flag      valid_flags;
967
968         oa = attr->cra_oa;
969         inode = ccc_object_inode(obj);
970         valid_flags = OBD_MD_FLTYPE;
971
972         if ((flags & OBD_MD_FLOSSCAPA) != 0) {
973                 LASSERT(attr->cra_capa == NULL);
974                 attr->cra_capa = cl_capa_lookup(inode,
975                                                 slice->crs_req->crq_type);
976         }
977
978         if (slice->crs_req->crq_type == CRT_WRITE) {
979                 if (flags & OBD_MD_FLEPOCH) {
980                         oa->o_valid |= OBD_MD_FLEPOCH;
981                         oa->o_ioepoch = cl_i2info(inode)->lli_ioepoch;
982                         valid_flags |= OBD_MD_FLMTIME | OBD_MD_FLCTIME |
983                                        OBD_MD_FLUID | OBD_MD_FLGID;
984                 }
985         }
986         obdo_from_inode(oa, inode, valid_flags & flags);
987         obdo_set_parent_fid(oa, &cl_i2info(inode)->lli_fid);
988 #ifdef __KERNEL__
989         memcpy(attr->cra_jobid, cl_i2info(inode)->lli_jobid,
990                JOBSTATS_JOBID_SIZE);
991 #endif
992 }
993
994 const struct cl_req_operations ccc_req_ops = {
995         .cro_attr_set   = ccc_req_attr_set,
996         .cro_completion = ccc_req_completion
997 };
998
999 int cl_setattr_ost(struct inode *inode, const struct iattr *attr,
1000                    struct obd_capa *capa)
1001 {
1002         struct lu_env *env;
1003         struct cl_io  *io;
1004         int            result;
1005         int            refcheck;
1006
1007         ENTRY;
1008
1009         env = cl_env_get(&refcheck);
1010         if (IS_ERR(env))
1011                 RETURN(PTR_ERR(env));
1012
1013         io = ccc_env_thread_io(env);
1014         io->ci_obj = cl_i2info(inode)->lli_clob;
1015
1016         io->u.ci_setattr.sa_attr.lvb_atime = LTIME_S(attr->ia_atime);
1017         io->u.ci_setattr.sa_attr.lvb_mtime = LTIME_S(attr->ia_mtime);
1018         io->u.ci_setattr.sa_attr.lvb_ctime = LTIME_S(attr->ia_ctime);
1019         io->u.ci_setattr.sa_attr.lvb_size = attr->ia_size;
1020         io->u.ci_setattr.sa_valid = attr->ia_valid;
1021         io->u.ci_setattr.sa_capa = capa;
1022
1023 again:
1024         if (cl_io_init(env, io, CIT_SETATTR, io->ci_obj) == 0) {
1025                 struct ccc_io *cio = ccc_env_io(env);
1026
1027                 if (attr->ia_valid & ATTR_FILE)
1028                         /* populate the file descriptor for ftruncate to honor
1029                          * group lock - see LU-787 */
1030                         cio->cui_fd = cl_iattr2fd(inode, attr);
1031
1032                 result = cl_io_loop(env, io);
1033         } else {
1034                 result = io->ci_result;
1035         }
1036         cl_io_fini(env, io);
1037         if (unlikely(io->ci_need_restart))
1038                 goto again;
1039         cl_env_put(env, &refcheck);
1040         RETURN(result);
1041 }
1042
1043 /*****************************************************************************
1044  *
1045  * Type conversions.
1046  *
1047  */
1048
1049 struct lu_device *ccc2lu_dev(struct ccc_device *vdv)
1050 {
1051         return &vdv->cdv_cl.cd_lu_dev;
1052 }
1053
1054 struct ccc_device *lu2ccc_dev(const struct lu_device *d)
1055 {
1056         return container_of0(d, struct ccc_device, cdv_cl.cd_lu_dev);
1057 }
1058
1059 struct ccc_device *cl2ccc_dev(const struct cl_device *d)
1060 {
1061         return container_of0(d, struct ccc_device, cdv_cl);
1062 }
1063
1064 struct lu_object *ccc2lu(struct ccc_object *vob)
1065 {
1066         return &vob->cob_cl.co_lu;
1067 }
1068
1069 struct ccc_object *lu2ccc(const struct lu_object *obj)
1070 {
1071         return container_of0(obj, struct ccc_object, cob_cl.co_lu);
1072 }
1073
1074 struct ccc_object *cl2ccc(const struct cl_object *obj)
1075 {
1076         return container_of0(obj, struct ccc_object, cob_cl);
1077 }
1078
1079 struct ccc_lock *cl2ccc_lock(const struct cl_lock_slice *slice)
1080 {
1081         return container_of(slice, struct ccc_lock, clk_cl);
1082 }
1083
1084 struct ccc_io *cl2ccc_io(const struct lu_env *env,
1085                          const struct cl_io_slice *slice)
1086 {
1087         struct ccc_io *cio;
1088
1089         cio = container_of(slice, struct ccc_io, cui_cl);
1090         LASSERT(cio == ccc_env_io(env));
1091         return cio;
1092 }
1093
1094 struct ccc_req *cl2ccc_req(const struct cl_req_slice *slice)
1095 {
1096         return container_of0(slice, struct ccc_req, crq_cl);
1097 }
1098
1099 cfs_page_t *cl2vm_page(const struct cl_page_slice *slice)
1100 {
1101         return cl2ccc_page(slice)->cpg_page;
1102 }
1103
1104 /*****************************************************************************
1105  *
1106  * Accessors.
1107  *
1108  */
1109 int ccc_object_invariant(const struct cl_object *obj)
1110 {
1111         struct inode         *inode = ccc_object_inode(obj);
1112         struct cl_inode_info *lli   = cl_i2info(inode);
1113
1114         return (S_ISREG(cl_inode_mode(inode)) ||
1115                 /* i_mode of unlinked inode is zeroed. */
1116                 cl_inode_mode(inode) == 0) && lli->lli_clob == obj;
1117 }
1118
1119 struct inode *ccc_object_inode(const struct cl_object *obj)
1120 {
1121         return cl2ccc(obj)->cob_inode;
1122 }
1123
1124 /**
1125  * Returns a pointer to cl_page associated with \a vmpage, without acquiring
1126  * additional reference to the resulting page. This is an unsafe version of
1127  * cl_vmpage_page() that can only be used under vmpage lock.
1128  */
1129 struct cl_page *ccc_vmpage_page_transient(cfs_page_t *vmpage)
1130 {
1131         KLASSERT(PageLocked(vmpage));
1132         return (struct cl_page *)vmpage->private;
1133 }
1134
1135 /**
1136  * Initialize or update CLIO structures for regular files when new
1137  * meta-data arrives from the server.
1138  *
1139  * \param inode regular file inode
1140  * \param md    new file metadata from MDS
1141  * - allocates cl_object if necessary,
1142  * - updated layout, if object was already here.
1143  */
1144 int cl_file_inode_init(struct inode *inode, struct lustre_md *md)
1145 {
1146         struct lu_env        *env;
1147         struct cl_inode_info *lli;
1148         struct cl_object     *clob;
1149         struct lu_site       *site;
1150         struct lu_fid        *fid;
1151         struct cl_object_conf conf = {
1152                 .coc_inode = inode,
1153                 .u = {
1154                         .coc_md    = md
1155                 }
1156         };
1157         int result = 0;
1158         int refcheck;
1159
1160         LASSERT(md->body->valid & OBD_MD_FLID);
1161         LASSERT(S_ISREG(cl_inode_mode(inode)));
1162
1163         env = cl_env_get(&refcheck);
1164         if (IS_ERR(env))
1165                 return PTR_ERR(env);
1166
1167         site = cl_i2sbi(inode)->ll_site;
1168         lli  = cl_i2info(inode);
1169         fid  = &lli->lli_fid;
1170         LASSERT(fid_is_sane(fid));
1171
1172         if (lli->lli_clob == NULL) {
1173                 /* clob is slave of inode, empty lli_clob means for new inode,
1174                  * there is no clob in cache with the given fid, so it is
1175                  * unnecessary to perform lookup-alloc-lookup-insert, just
1176                  * alloc and insert directly. */
1177 #ifdef __KERNEL__
1178                 LASSERT(inode->i_state & I_NEW);
1179 #endif
1180                 conf.coc_lu.loc_flags = LOC_F_NEW;
1181                 clob = cl_object_find(env, lu2cl_dev(site->ls_top_dev),
1182                                       fid, &conf);
1183                 if (!IS_ERR(clob)) {
1184                         /*
1185                          * No locking is necessary, as new inode is
1186                          * locked by I_NEW bit.
1187                          */
1188                         lli->lli_clob = clob;
1189                         lli->lli_has_smd = md->lsm != NULL;
1190                         lu_object_ref_add(&clob->co_lu, "inode", inode);
1191                 } else
1192                         result = PTR_ERR(clob);
1193         } else {
1194                 result = cl_conf_set(env, lli->lli_clob, &conf);
1195         }
1196
1197         cl_env_put(env, &refcheck);
1198
1199         if (result != 0)
1200                 CERROR("Failure to initialize cl object "DFID": %d\n",
1201                        PFID(fid), result);
1202         return result;
1203 }
1204
1205 /**
1206  * Wait for others drop their references of the object at first, then we drop
1207  * the last one, which will lead to the object be destroyed immediately.
1208  * Must be called after cl_object_kill() against this object.
1209  *
1210  * The reason we want to do this is: destroying top object will wait for sub
1211  * objects being destroyed first, so we can't let bottom layer (e.g. from ASTs)
1212  * to initiate top object destroying which may deadlock. See bz22520.
1213  */
1214 static void cl_object_put_last(struct lu_env *env, struct cl_object *obj)
1215 {
1216         struct lu_object_header *header = obj->co_lu.lo_header;
1217         cfs_waitlink_t           waiter;
1218
1219         if (unlikely(cfs_atomic_read(&header->loh_ref) != 1)) {
1220                 struct lu_site *site = obj->co_lu.lo_dev->ld_site;
1221                 struct lu_site_bkt_data *bkt;
1222
1223                 bkt = lu_site_bkt_from_fid(site, &header->loh_fid);
1224
1225                 cfs_waitlink_init(&waiter);
1226                 cfs_waitq_add(&bkt->lsb_marche_funebre, &waiter);
1227
1228                 while (1) {
1229                         cfs_set_current_state(CFS_TASK_UNINT);
1230                         if (cfs_atomic_read(&header->loh_ref) == 1)
1231                                 break;
1232                         cfs_waitq_wait(&waiter, CFS_TASK_UNINT);
1233                 }
1234
1235                 cfs_set_current_state(CFS_TASK_RUNNING);
1236                 cfs_waitq_del(&bkt->lsb_marche_funebre, &waiter);
1237         }
1238
1239         cl_object_put(env, obj);
1240 }
1241
1242 void cl_inode_fini(struct inode *inode)
1243 {
1244         struct lu_env           *env;
1245         struct cl_inode_info    *lli  = cl_i2info(inode);
1246         struct cl_object        *clob = lli->lli_clob;
1247         int refcheck;
1248         int emergency;
1249
1250         if (clob != NULL) {
1251                 void                    *cookie;
1252
1253                 cookie = cl_env_reenter();
1254                 env = cl_env_get(&refcheck);
1255                 emergency = IS_ERR(env);
1256                 if (emergency) {
1257                         mutex_lock(&ccc_inode_fini_guard);
1258                         LASSERT(ccc_inode_fini_env != NULL);
1259                         cl_env_implant(ccc_inode_fini_env, &refcheck);
1260                         env = ccc_inode_fini_env;
1261                 }
1262                 /*
1263                  * cl_object cache is a slave to inode cache (which, in turn
1264                  * is a slave to dentry cache), don't keep cl_object in memory
1265                  * when its master is evicted.
1266                  */
1267                 cl_object_kill(env, clob);
1268                 lu_object_ref_del(&clob->co_lu, "inode", inode);
1269                 cl_object_put_last(env, clob);
1270                 lli->lli_clob = NULL;
1271                 if (emergency) {
1272                         cl_env_unplant(ccc_inode_fini_env, &refcheck);
1273                         mutex_unlock(&ccc_inode_fini_guard);
1274                 } else
1275                         cl_env_put(env, &refcheck);
1276                 cl_env_reexit(cookie);
1277         }
1278 }
1279
1280 /**
1281  * return IF_* type for given lu_dirent entry.
1282  * IF_* flag shld be converted to particular OS file type in
1283  * platform llite module.
1284  */
1285 __u16 ll_dirent_type_get(struct lu_dirent *ent)
1286 {
1287         __u16 type = 0;
1288         struct luda_type *lt;
1289         int len = 0;
1290
1291         if (le32_to_cpu(ent->lde_attrs) & LUDA_TYPE) {
1292                 const unsigned align = sizeof(struct luda_type) - 1;
1293
1294                 len = le16_to_cpu(ent->lde_namelen);
1295                 len = (len + align) & ~align;
1296                 lt = (void *)ent->lde_name + len;
1297                 type = IFTODT(le16_to_cpu(lt->lt_type));
1298         }
1299         return type;
1300 }
1301
1302 /**
1303  * build inode number from passed @fid */
1304 __u64 cl_fid_build_ino(const struct lu_fid *fid, int api32)
1305 {
1306         if (BITS_PER_LONG == 32 || api32)
1307                 RETURN(fid_flatten32(fid));
1308         else
1309                 RETURN(fid_flatten(fid));
1310 }
1311
1312 /**
1313  * build inode generation from passed @fid.  If our FID overflows the 32-bit
1314  * inode number then return a non-zero generation to distinguish them. */
1315 __u32 cl_fid_build_gen(const struct lu_fid *fid)
1316 {
1317         __u32 gen;
1318         ENTRY;
1319
1320         if (fid_is_igif(fid)) {
1321                 gen = lu_igif_gen(fid);
1322                 RETURN(gen);
1323         }
1324
1325         gen = (fid_flatten(fid) >> 32);
1326         RETURN(gen);
1327 }
1328
1329 /* lsm is unreliable after hsm implementation as layout can be changed at
1330  * any time. This is only to support old, non-clio-ized interfaces. It will
1331  * cause deadlock if clio operations are called with this extra layout refcount
1332  * because in case the layout changed during the IO, ll_layout_refresh() will
1333  * have to wait for the refcount to become zero to destroy the older layout.
1334  *
1335  * Notice that the lsm returned by this function may not be valid unless called
1336  * inside layout lock - MDS_INODELOCK_LAYOUT. */
1337 struct lov_stripe_md *ccc_inode_lsm_get(struct inode *inode)
1338 {
1339         return lov_lsm_get(cl_i2info(inode)->lli_clob);
1340 }
1341
1342 void inline ccc_inode_lsm_put(struct inode *inode, struct lov_stripe_md *lsm)
1343 {
1344         lov_lsm_put(cl_i2info(inode)->lli_clob, lsm);
1345 }