Whamcloud - gitweb
LU-5971 llite: rename ccc_object to vvp_object
[fs/lustre-release.git] / lustre / llite / 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, 2014, 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 #include <libcfs/libcfs.h>
45 #include <linux/fs.h>
46 #include <linux/sched.h>
47 #include <linux/mm.h>
48 #include <linux/quotaops.h>
49 #include <linux/highmem.h>
50 #include <linux/pagemap.h>
51 #include <linux/rbtree.h>
52
53 #include <obd.h>
54 #include <obd_support.h>
55 #include <lustre_fid.h>
56 #include <lustre_dlm.h>
57 #include <lustre_ver.h>
58 #include <lustre_mdc.h>
59 #include <cl_object.h>
60
61 #include "llite_internal.h"
62
63 static const struct cl_req_operations ccc_req_ops;
64
65 /*
66  * ccc_ prefix stands for "Common Client Code".
67  */
68
69 static struct kmem_cache *ccc_lock_kmem;
70 static struct kmem_cache *ccc_thread_kmem;
71 static struct kmem_cache *ccc_session_kmem;
72 static struct kmem_cache *ccc_req_kmem;
73
74 static struct lu_kmem_descr ccc_caches[] = {
75         {
76                 .ckd_cache = &ccc_lock_kmem,
77                 .ckd_name  = "ccc_lock_kmem",
78                 .ckd_size  = sizeof (struct ccc_lock)
79         },
80         {
81                 .ckd_cache = &ccc_thread_kmem,
82                 .ckd_name  = "ccc_thread_kmem",
83                 .ckd_size  = sizeof (struct ccc_thread_info),
84         },
85         {
86                 .ckd_cache = &ccc_session_kmem,
87                 .ckd_name  = "ccc_session_kmem",
88                 .ckd_size  = sizeof (struct ccc_session)
89         },
90         {
91                 .ckd_cache = &ccc_req_kmem,
92                 .ckd_name  = "ccc_req_kmem",
93                 .ckd_size  = sizeof (struct ccc_req)
94         },
95         {
96                 .ckd_cache = NULL
97         }
98 };
99
100 /*****************************************************************************
101  *
102  * Vvp device and device type functions.
103  *
104  */
105
106 void *ccc_key_init(const struct lu_context *ctx, struct lu_context_key *key)
107 {
108         struct ccc_thread_info *info;
109
110         OBD_SLAB_ALLOC_PTR_GFP(info, ccc_thread_kmem, GFP_NOFS);
111         if (info == NULL)
112                 info = ERR_PTR(-ENOMEM);
113         return info;
114 }
115
116 void ccc_key_fini(const struct lu_context *ctx,
117                          struct lu_context_key *key, void *data)
118 {
119         struct ccc_thread_info *info = data;
120         OBD_SLAB_FREE_PTR(info, ccc_thread_kmem);
121 }
122
123 void *ccc_session_key_init(const struct lu_context *ctx,
124                            struct lu_context_key *key)
125 {
126         struct ccc_session *session;
127
128         OBD_SLAB_ALLOC_PTR_GFP(session, ccc_session_kmem, GFP_NOFS);
129         if (session == NULL)
130                 session = ERR_PTR(-ENOMEM);
131         return session;
132 }
133
134 void ccc_session_key_fini(const struct lu_context *ctx,
135                                  struct lu_context_key *key, void *data)
136 {
137         struct ccc_session *session = data;
138         OBD_SLAB_FREE_PTR(session, ccc_session_kmem);
139 }
140
141 struct lu_context_key ccc_key = {
142         .lct_tags = LCT_CL_THREAD,
143         .lct_init = ccc_key_init,
144         .lct_fini = ccc_key_fini
145 };
146
147 struct lu_context_key ccc_session_key = {
148         .lct_tags = LCT_SESSION,
149         .lct_init = ccc_session_key_init,
150         .lct_fini = ccc_session_key_fini
151 };
152
153 int ccc_req_init(const struct lu_env *env, struct cl_device *dev,
154                  struct cl_req *req)
155 {
156         struct ccc_req *vrq;
157         int result;
158
159         OBD_SLAB_ALLOC_PTR_GFP(vrq, ccc_req_kmem, GFP_NOFS);
160         if (vrq != NULL) {
161                 cl_req_slice_add(req, &vrq->crq_cl, dev, &ccc_req_ops);
162                 result = 0;
163         } else
164                 result = -ENOMEM;
165         return result;
166 }
167
168 /**
169  * An `emergency' environment used by ccc_inode_fini() when cl_env_get()
170  * fails. Access to this environment is serialized by ccc_inode_fini_guard
171  * mutex.
172  */
173 static struct lu_env *ccc_inode_fini_env = NULL;
174
175 /**
176  * A mutex serializing calls to slp_inode_fini() under extreme memory
177  * pressure, when environments cannot be allocated.
178  */
179 static DEFINE_MUTEX(ccc_inode_fini_guard);
180 static int dummy_refcheck;
181
182 int ccc_global_init(struct lu_device_type *device_type)
183 {
184         int result;
185
186         result = lu_kmem_init(ccc_caches);
187         if (result)
188                 return result;
189
190         result = lu_device_type_init(device_type);
191         if (result)
192                 goto out_kmem;
193
194         ccc_inode_fini_env = cl_env_alloc(&dummy_refcheck,
195                                           LCT_REMEMBER|LCT_NOREF);
196         if (IS_ERR(ccc_inode_fini_env)) {
197                 result = PTR_ERR(ccc_inode_fini_env);
198                 goto out_device;
199         }
200
201         ccc_inode_fini_env->le_ctx.lc_cookie = 0x4;
202         return 0;
203 out_device:
204         lu_device_type_fini(device_type);
205 out_kmem:
206         lu_kmem_fini(ccc_caches);
207         return result;
208 }
209
210 void ccc_global_fini(struct lu_device_type *device_type)
211 {
212         if (ccc_inode_fini_env != NULL) {
213                 cl_env_put(ccc_inode_fini_env, &dummy_refcheck);
214                 ccc_inode_fini_env = NULL;
215         }
216         lu_device_type_fini(device_type);
217         lu_kmem_fini(ccc_caches);
218 }
219
220 int ccc_lock_init(const struct lu_env *env,
221                   struct cl_object *obj, struct cl_lock *lock,
222                   const struct cl_io *unused,
223                   const struct cl_lock_operations *lkops)
224 {
225         struct ccc_lock *clk;
226         int result;
227
228         CLOBINVRNT(env, obj, vvp_object_invariant(obj));
229
230         OBD_SLAB_ALLOC_PTR_GFP(clk, ccc_lock_kmem, GFP_NOFS);
231         if (clk != NULL) {
232                 cl_lock_slice_add(lock, &clk->clk_cl, obj, lkops);
233                 result = 0;
234         } else
235                 result = -ENOMEM;
236         return result;
237 }
238
239 static void vvp_object_size_lock(struct cl_object *obj)
240 {
241         struct inode *inode = vvp_object_inode(obj);
242
243         ll_inode_size_lock(inode);
244         cl_object_attr_lock(obj);
245 }
246
247 static void vvp_object_size_unlock(struct cl_object *obj)
248 {
249         struct inode *inode = vvp_object_inode(obj);
250
251         cl_object_attr_unlock(obj);
252         ll_inode_size_unlock(inode);
253 }
254
255 /*****************************************************************************
256  *
257  * Page operations.
258  *
259  */
260
261 int ccc_fail(const struct lu_env *env, const struct cl_page_slice *slice)
262 {
263         /*
264          * Cached read?
265          */
266         LBUG();
267         return 0;
268 }
269
270 void ccc_transient_page_verify(const struct cl_page *page)
271 {
272 }
273
274 int ccc_transient_page_own(const struct lu_env *env,
275                                    const struct cl_page_slice *slice,
276                                    struct cl_io *unused,
277                                    int nonblock)
278 {
279         ccc_transient_page_verify(slice->cpl_page);
280         return 0;
281 }
282
283 void ccc_transient_page_assume(const struct lu_env *env,
284                                       const struct cl_page_slice *slice,
285                                       struct cl_io *unused)
286 {
287         ccc_transient_page_verify(slice->cpl_page);
288 }
289
290 void ccc_transient_page_unassume(const struct lu_env *env,
291                                         const struct cl_page_slice *slice,
292                                         struct cl_io *unused)
293 {
294         ccc_transient_page_verify(slice->cpl_page);
295 }
296
297 void ccc_transient_page_disown(const struct lu_env *env,
298                                       const struct cl_page_slice *slice,
299                                       struct cl_io *unused)
300 {
301         ccc_transient_page_verify(slice->cpl_page);
302 }
303
304 void ccc_transient_page_discard(const struct lu_env *env,
305                                        const struct cl_page_slice *slice,
306                                        struct cl_io *unused)
307 {
308         struct cl_page *page = slice->cpl_page;
309
310         ccc_transient_page_verify(slice->cpl_page);
311
312         /*
313          * For transient pages, remove it from the radix tree.
314          */
315         cl_page_delete(env, page);
316 }
317
318 int ccc_transient_page_prep(const struct lu_env *env,
319                                    const struct cl_page_slice *slice,
320                                    struct cl_io *unused)
321 {
322         ENTRY;
323         /* transient page should always be sent. */
324         RETURN(0);
325 }
326
327 /*****************************************************************************
328  *
329  * Lock operations.
330  *
331  */
332
333 void ccc_lock_fini(const struct lu_env *env, struct cl_lock_slice *slice)
334 {
335         struct ccc_lock *clk = cl2ccc_lock(slice);
336         OBD_SLAB_FREE_PTR(clk, ccc_lock_kmem);
337 }
338
339 int ccc_lock_enqueue(const struct lu_env *env,
340                      const struct cl_lock_slice *slice,
341                      struct cl_io *unused, struct cl_sync_io *anchor)
342 {
343         CLOBINVRNT(env, slice->cls_obj, vvp_object_invariant(slice->cls_obj));
344         return 0;
345 }
346
347 /*****************************************************************************
348  *
349  * io operations.
350  *
351  */
352
353 void ccc_io_fini(const struct lu_env *env, const struct cl_io_slice *ios)
354 {
355         struct cl_io *io = ios->cis_io;
356
357         CLOBINVRNT(env, io->ci_obj, vvp_object_invariant(io->ci_obj));
358 }
359
360 int ccc_io_one_lock_index(const struct lu_env *env, struct cl_io *io,
361                           __u32 enqflags, enum cl_lock_mode mode,
362                           pgoff_t start, pgoff_t end)
363 {
364         struct ccc_io          *cio   = ccc_env_io(env);
365         struct cl_lock_descr   *descr = &cio->cui_link.cill_descr;
366         struct cl_object       *obj   = io->ci_obj;
367
368         CLOBINVRNT(env, obj, vvp_object_invariant(obj));
369         ENTRY;
370
371         CDEBUG(D_VFSTRACE, "lock: %d [%lu, %lu]\n", mode, start, end);
372
373         memset(&cio->cui_link, 0, sizeof cio->cui_link);
374
375         if (cio->cui_fd && (cio->cui_fd->fd_flags & LL_FILE_GROUP_LOCKED)) {
376                 descr->cld_mode = CLM_GROUP;
377                 descr->cld_gid  = cio->cui_fd->fd_grouplock.cg_gid;
378         } else {
379                 descr->cld_mode  = mode;
380         }
381         descr->cld_obj   = obj;
382         descr->cld_start = start;
383         descr->cld_end   = end;
384         descr->cld_enq_flags = enqflags;
385
386         cl_io_lock_add(env, io, &cio->cui_link);
387         RETURN(0);
388 }
389
390 void ccc_io_update_iov(const struct lu_env *env,
391                        struct ccc_io *cio, struct cl_io *io)
392 {
393         int i;
394         size_t size = io->u.ci_rw.crw_count;
395
396         cio->cui_iov_olen = 0;
397         if (!cl_is_normalio(env, io) || cio->cui_tot_nrsegs == 0)
398                 return;
399
400         for (i = 0; i < cio->cui_tot_nrsegs; i++) {
401                 struct iovec *iv = &cio->cui_iov[i];
402
403                 if (iv->iov_len < size)
404                         size -= iv->iov_len;
405                 else {
406                         if (iv->iov_len > size) {
407                                 cio->cui_iov_olen = iv->iov_len;
408                                 iv->iov_len = size;
409                         }
410                         break;
411                 }
412         }
413
414         cio->cui_nrsegs = i + 1;
415         LASSERTF(cio->cui_tot_nrsegs >= cio->cui_nrsegs,
416                  "tot_nrsegs: %lu, nrsegs: %lu\n",
417                  cio->cui_tot_nrsegs, cio->cui_nrsegs);
418 }
419
420 int ccc_io_one_lock(const struct lu_env *env, struct cl_io *io,
421                     __u32 enqflags, enum cl_lock_mode mode,
422                     loff_t start, loff_t end)
423 {
424         struct cl_object *obj = io->ci_obj;
425         return ccc_io_one_lock_index(env, io, enqflags, mode,
426                                      cl_index(obj, start), cl_index(obj, end));
427 }
428
429 void ccc_io_end(const struct lu_env *env, const struct cl_io_slice *ios)
430 {
431         CLOBINVRNT(env, ios->cis_io->ci_obj,
432                    vvp_object_invariant(ios->cis_io->ci_obj));
433 }
434
435 void ccc_io_advance(const struct lu_env *env,
436                     const struct cl_io_slice *ios,
437                     size_t nob)
438 {
439         struct ccc_io    *cio = cl2ccc_io(env, ios);
440         struct cl_io     *io  = ios->cis_io;
441         struct cl_object *obj = ios->cis_io->ci_obj;
442
443         CLOBINVRNT(env, obj, vvp_object_invariant(obj));
444
445         if (!cl_is_normalio(env, io))
446                 return;
447
448         LASSERT(cio->cui_tot_nrsegs >= cio->cui_nrsegs);
449         LASSERT(cio->cui_tot_count  >= nob);
450
451         cio->cui_iov        += cio->cui_nrsegs;
452         cio->cui_tot_nrsegs -= cio->cui_nrsegs;
453         cio->cui_tot_count  -= nob;
454
455         /* update the iov */
456         if (cio->cui_iov_olen > 0) {
457                 struct iovec *iv;
458
459                 cio->cui_iov--;
460                 cio->cui_tot_nrsegs++;
461                 iv = &cio->cui_iov[0];
462                 if (io->ci_continue) {
463                         iv->iov_base += iv->iov_len;
464                         LASSERT(cio->cui_iov_olen > iv->iov_len);
465                         iv->iov_len = cio->cui_iov_olen - iv->iov_len;
466                 } else {
467                         /* restore the iov_len, in case of restart io. */
468                         iv->iov_len = cio->cui_iov_olen;
469                 }
470                 cio->cui_iov_olen = 0;
471         }
472 }
473
474 /**
475  * Helper function that if necessary adjusts file size (inode->i_size), when
476  * position at the offset \a pos is accessed. File size can be arbitrary stale
477  * on a Lustre client, but client at least knows KMS. If accessed area is
478  * inside [0, KMS], set file size to KMS, otherwise glimpse file size.
479  *
480  * Locking: cl_isize_lock is used to serialize changes to inode size and to
481  * protect consistency between inode size and cl_object
482  * attributes. cl_object_size_lock() protects consistency between cl_attr's of
483  * top-object and sub-objects.
484  */
485 int ccc_prep_size(const struct lu_env *env, struct cl_object *obj,
486                   struct cl_io *io, loff_t start, size_t count, int *exceed)
487 {
488         struct cl_attr *attr  = ccc_env_thread_attr(env);
489         struct inode   *inode = vvp_object_inode(obj);
490         loff_t          pos   = start + count - 1;
491         loff_t kms;
492         int result;
493
494         /*
495          * Consistency guarantees: following possibilities exist for the
496          * relation between region being accessed and real file size at this
497          * moment:
498          *
499          *  (A): the region is completely inside of the file;
500          *
501          *  (B-x): x bytes of region are inside of the file, the rest is
502          *  outside;
503          *
504          *  (C): the region is completely outside of the file.
505          *
506          * This classification is stable under DLM lock already acquired by
507          * the caller, because to change the class, other client has to take
508          * DLM lock conflicting with our lock. Also, any updates to ->i_size
509          * by other threads on this client are serialized by
510          * ll_inode_size_lock(). This guarantees that short reads are handled
511          * correctly in the face of concurrent writes and truncates.
512          */
513         vvp_object_size_lock(obj);
514         result = cl_object_attr_get(env, obj, attr);
515         if (result == 0) {
516                 kms = attr->cat_kms;
517                 if (pos > kms) {
518                         /*
519                          * A glimpse is necessary to determine whether we
520                          * return a short read (B) or some zeroes at the end
521                          * of the buffer (C)
522                          */
523                         vvp_object_size_unlock(obj);
524                         result = cl_glimpse_lock(env, io, inode, obj, 0);
525                         if (result == 0 && exceed != NULL) {
526                                 /* If objective page index exceed end-of-file
527                                  * page index, return directly. Do not expect
528                                  * kernel will check such case correctly.
529                                  * linux-2.6.18-128.1.1 miss to do that.
530                                  * --bug 17336 */
531                                 loff_t size = i_size_read(inode);
532                                 unsigned long cur_index = start >>
533                                                           PAGE_CACHE_SHIFT;
534
535                                 if ((size == 0 && cur_index != 0) ||
536                                     (((size - 1) >> PAGE_CACHE_SHIFT) <
537                                      cur_index))
538                                 *exceed = 1;
539                         }
540                         return result;
541                 } else {
542                         /*
543                          * region is within kms and, hence, within real file
544                          * size (A). We need to increase i_size to cover the
545                          * read region so that generic_file_read() will do its
546                          * job, but that doesn't mean the kms size is
547                          * _correct_, it is only the _minimum_ size. If
548                          * someone does a stat they will get the correct size
549                          * which will always be >= the kms value here.
550                          * b=11081
551                          */
552                         if (i_size_read(inode) < kms) {
553                                 i_size_write(inode, kms);
554                                 CDEBUG(D_VFSTRACE,
555                                        DFID" updating i_size "LPU64"\n",
556                                        PFID(lu_object_fid(&obj->co_lu)),
557                                        (__u64)i_size_read(inode));
558
559                         }
560                 }
561         }
562
563         vvp_object_size_unlock(obj);
564
565         return result;
566 }
567
568 /*****************************************************************************
569  *
570  * Transfer operations.
571  *
572  */
573
574 void ccc_req_completion(const struct lu_env *env,
575                         const struct cl_req_slice *slice, int ioret)
576 {
577         struct ccc_req *vrq;
578
579         if (ioret > 0)
580                 cl_stats_tally(slice->crs_dev, slice->crs_req->crq_type, ioret);
581
582         vrq = cl2ccc_req(slice);
583         OBD_SLAB_FREE_PTR(vrq, ccc_req_kmem);
584 }
585
586 /**
587  * Implementation of struct cl_req_operations::cro_attr_set() for ccc
588  * layer. ccc is responsible for
589  *
590  *    - o_[mac]time
591  *
592  *    - o_mode
593  *
594  *    - o_parent_seq
595  *
596  *    - o_[ug]id
597  *
598  *    - o_parent_oid
599  *
600  *    - o_parent_ver
601  *
602  *    - o_ioepoch,
603  *
604  *  and capability.
605  */
606 void ccc_req_attr_set(const struct lu_env *env,
607                       const struct cl_req_slice *slice,
608                       const struct cl_object *obj,
609                       struct cl_req_attr *attr, obd_valid flags)
610 {
611         struct inode *inode;
612         struct obdo  *oa;
613         obd_flag      valid_flags;
614
615         oa = attr->cra_oa;
616         inode = vvp_object_inode(obj);
617         valid_flags = OBD_MD_FLTYPE;
618
619         if ((flags & OBD_MD_FLOSSCAPA) != 0) {
620                 LASSERT(attr->cra_capa == NULL);
621                 attr->cra_capa = cl_capa_lookup(inode,
622                                                 slice->crs_req->crq_type);
623         }
624
625         if (slice->crs_req->crq_type == CRT_WRITE) {
626                 if (flags & OBD_MD_FLEPOCH) {
627                         oa->o_valid |= OBD_MD_FLEPOCH;
628                         oa->o_ioepoch = ll_i2info(inode)->lli_ioepoch;
629                         valid_flags |= OBD_MD_FLMTIME | OBD_MD_FLCTIME |
630                                        OBD_MD_FLUID | OBD_MD_FLGID;
631                 }
632         }
633         obdo_from_inode(oa, inode, valid_flags & flags);
634         obdo_set_parent_fid(oa, &ll_i2info(inode)->lli_fid);
635         if (OBD_FAIL_CHECK(OBD_FAIL_LFSCK_INVALID_PFID))
636                 oa->o_parent_oid++;
637         memcpy(attr->cra_jobid, ll_i2info(inode)->lli_jobid,
638                LUSTRE_JOBID_SIZE);
639 }
640
641 static const struct cl_req_operations ccc_req_ops = {
642         .cro_attr_set   = ccc_req_attr_set,
643         .cro_completion = ccc_req_completion
644 };
645
646 int cl_setattr_ost(struct inode *inode, const struct iattr *attr,
647                    struct obd_capa *capa)
648 {
649         struct lu_env *env;
650         struct cl_io  *io;
651         int            result;
652         int            refcheck;
653
654         ENTRY;
655
656         env = cl_env_get(&refcheck);
657         if (IS_ERR(env))
658                 RETURN(PTR_ERR(env));
659
660         io = ccc_env_thread_io(env);
661         io->ci_obj = ll_i2info(inode)->lli_clob;
662
663         io->u.ci_setattr.sa_attr.lvb_atime = LTIME_S(attr->ia_atime);
664         io->u.ci_setattr.sa_attr.lvb_mtime = LTIME_S(attr->ia_mtime);
665         io->u.ci_setattr.sa_attr.lvb_ctime = LTIME_S(attr->ia_ctime);
666         io->u.ci_setattr.sa_attr.lvb_size = attr->ia_size;
667         io->u.ci_setattr.sa_valid = attr->ia_valid;
668         io->u.ci_setattr.sa_capa = capa;
669
670 again:
671         if (cl_io_init(env, io, CIT_SETATTR, io->ci_obj) == 0) {
672                 struct ccc_io *cio = ccc_env_io(env);
673
674                 if (attr->ia_valid & ATTR_FILE)
675                         /* populate the file descriptor for ftruncate to honor
676                          * group lock - see LU-787 */
677                         cio->cui_fd = LUSTRE_FPRIVATE(attr->ia_file);
678
679                 result = cl_io_loop(env, io);
680         } else {
681                 result = io->ci_result;
682         }
683         cl_io_fini(env, io);
684         if (unlikely(io->ci_need_restart))
685                 goto again;
686         /* HSM import case: file is released, cannot be restored
687          * no need to fail except if restore registration failed
688          * with -ENODATA */
689         if (result == -ENODATA && io->ci_restore_needed &&
690             io->ci_result != -ENODATA)
691                 result = 0;
692         cl_env_put(env, &refcheck);
693         RETURN(result);
694 }
695
696 /*****************************************************************************
697  *
698  * Type conversions.
699  *
700  */
701
702 struct ccc_lock *cl2ccc_lock(const struct cl_lock_slice *slice)
703 {
704         return container_of(slice, struct ccc_lock, clk_cl);
705 }
706
707 struct ccc_io *cl2ccc_io(const struct lu_env *env,
708                          const struct cl_io_slice *slice)
709 {
710         struct ccc_io *cio;
711
712         cio = container_of(slice, struct ccc_io, cui_cl);
713         LASSERT(cio == ccc_env_io(env));
714         return cio;
715 }
716
717 struct ccc_req *cl2ccc_req(const struct cl_req_slice *slice)
718 {
719         return container_of0(slice, struct ccc_req, crq_cl);
720 }
721
722 struct page *cl2vm_page(const struct cl_page_slice *slice)
723 {
724         return cl2ccc_page(slice)->cpg_page;
725 }
726
727 /**
728  * Returns a pointer to cl_page associated with \a vmpage, without acquiring
729  * additional reference to the resulting page. This is an unsafe version of
730  * cl_vmpage_page() that can only be used under vmpage lock.
731  */
732 struct cl_page *ccc_vmpage_page_transient(struct page *vmpage)
733 {
734         KLASSERT(PageLocked(vmpage));
735         return (struct cl_page *)vmpage->private;
736 }
737
738 /**
739  * Initialize or update CLIO structures for regular files when new
740  * meta-data arrives from the server.
741  *
742  * \param inode regular file inode
743  * \param md    new file metadata from MDS
744  * - allocates cl_object if necessary,
745  * - updated layout, if object was already here.
746  */
747 int cl_file_inode_init(struct inode *inode, struct lustre_md *md)
748 {
749         struct lu_env        *env;
750         struct ll_inode_info *lli;
751         struct cl_object     *clob;
752         struct lu_site       *site;
753         struct lu_fid        *fid;
754         struct cl_object_conf conf = {
755                 .coc_inode = inode,
756                 .u = {
757                         .coc_md    = md
758                 }
759         };
760         int result = 0;
761         int refcheck;
762
763         LASSERT(md->body->mbo_valid & OBD_MD_FLID);
764         LASSERT(S_ISREG(inode->i_mode));
765
766         env = cl_env_get(&refcheck);
767         if (IS_ERR(env))
768                 return PTR_ERR(env);
769
770         site = ll_i2sbi(inode)->ll_site;
771         lli  = ll_i2info(inode);
772         fid  = &lli->lli_fid;
773         LASSERT(fid_is_sane(fid));
774
775         if (lli->lli_clob == NULL) {
776                 /* clob is slave of inode, empty lli_clob means for new inode,
777                  * there is no clob in cache with the given fid, so it is
778                  * unnecessary to perform lookup-alloc-lookup-insert, just
779                  * alloc and insert directly. */
780                 LASSERT(inode->i_state & I_NEW);
781                 conf.coc_lu.loc_flags = LOC_F_NEW;
782                 clob = cl_object_find(env, lu2cl_dev(site->ls_top_dev),
783                                       fid, &conf);
784                 if (!IS_ERR(clob)) {
785                         /*
786                          * No locking is necessary, as new inode is
787                          * locked by I_NEW bit.
788                          */
789                         lli->lli_clob = clob;
790                         lli->lli_has_smd = lsm_has_objects(md->lsm);
791                         lu_object_ref_add(&clob->co_lu, "inode", inode);
792                 } else
793                         result = PTR_ERR(clob);
794         } else {
795                 result = cl_conf_set(env, lli->lli_clob, &conf);
796         }
797
798         cl_env_put(env, &refcheck);
799
800         if (result != 0)
801                 CERROR("Failure to initialize cl object "DFID": %d\n",
802                        PFID(fid), result);
803         return result;
804 }
805
806 /**
807  * Wait for others drop their references of the object at first, then we drop
808  * the last one, which will lead to the object be destroyed immediately.
809  * Must be called after cl_object_kill() against this object.
810  *
811  * The reason we want to do this is: destroying top object will wait for sub
812  * objects being destroyed first, so we can't let bottom layer (e.g. from ASTs)
813  * to initiate top object destroying which may deadlock. See bz22520.
814  */
815 static void cl_object_put_last(struct lu_env *env, struct cl_object *obj)
816 {
817         struct lu_object_header *header = obj->co_lu.lo_header;
818         wait_queue_t           waiter;
819
820         if (unlikely(atomic_read(&header->loh_ref) != 1)) {
821                 struct lu_site *site = obj->co_lu.lo_dev->ld_site;
822                 struct lu_site_bkt_data *bkt;
823
824                 bkt = lu_site_bkt_from_fid(site, &header->loh_fid);
825
826                 init_waitqueue_entry_current(&waiter);
827                 add_wait_queue(&bkt->lsb_marche_funebre, &waiter);
828
829                 while (1) {
830                         set_current_state(TASK_UNINTERRUPTIBLE);
831                         if (atomic_read(&header->loh_ref) == 1)
832                                 break;
833                         waitq_wait(&waiter, TASK_UNINTERRUPTIBLE);
834                 }
835
836                 set_current_state(TASK_RUNNING);
837                 remove_wait_queue(&bkt->lsb_marche_funebre, &waiter);
838         }
839
840         cl_object_put(env, obj);
841 }
842
843 void cl_inode_fini(struct inode *inode)
844 {
845         struct lu_env           *env;
846         struct ll_inode_info    *lli  = ll_i2info(inode);
847         struct cl_object        *clob = lli->lli_clob;
848         int refcheck;
849         int emergency;
850
851         if (clob != NULL) {
852                 void                    *cookie;
853
854                 cookie = cl_env_reenter();
855                 env = cl_env_get(&refcheck);
856                 emergency = IS_ERR(env);
857                 if (emergency) {
858                         mutex_lock(&ccc_inode_fini_guard);
859                         LASSERT(ccc_inode_fini_env != NULL);
860                         cl_env_implant(ccc_inode_fini_env, &refcheck);
861                         env = ccc_inode_fini_env;
862                 }
863                 /*
864                  * cl_object cache is a slave to inode cache (which, in turn
865                  * is a slave to dentry cache), don't keep cl_object in memory
866                  * when its master is evicted.
867                  */
868                 cl_object_kill(env, clob);
869                 lu_object_ref_del(&clob->co_lu, "inode", inode);
870                 cl_object_put_last(env, clob);
871                 lli->lli_clob = NULL;
872                 if (emergency) {
873                         cl_env_unplant(ccc_inode_fini_env, &refcheck);
874                         mutex_unlock(&ccc_inode_fini_guard);
875                 } else
876                         cl_env_put(env, &refcheck);
877                 cl_env_reexit(cookie);
878         }
879 }
880
881 /**
882  * return IF_* type for given lu_dirent entry.
883  * IF_* flag shld be converted to particular OS file type in
884  * platform llite module.
885  */
886 __u16 ll_dirent_type_get(struct lu_dirent *ent)
887 {
888         __u16 type = 0;
889         struct luda_type *lt;
890         int len = 0;
891
892         if (le32_to_cpu(ent->lde_attrs) & LUDA_TYPE) {
893                 const unsigned align = sizeof(struct luda_type) - 1;
894
895                 len = le16_to_cpu(ent->lde_namelen);
896                 len = (len + align) & ~align;
897                 lt = (void *)ent->lde_name + len;
898                 type = IFTODT(le16_to_cpu(lt->lt_type));
899         }
900         return type;
901 }
902
903 /**
904  * build inode number from passed @fid */
905 __u64 cl_fid_build_ino(const struct lu_fid *fid, int api32)
906 {
907         if (BITS_PER_LONG == 32 || api32)
908                 RETURN(fid_flatten32(fid));
909         else
910                 RETURN(fid_flatten(fid));
911 }
912
913 /**
914  * build inode generation from passed @fid.  If our FID overflows the 32-bit
915  * inode number then return a non-zero generation to distinguish them. */
916 __u32 cl_fid_build_gen(const struct lu_fid *fid)
917 {
918         __u32 gen;
919         ENTRY;
920
921         if (fid_is_igif(fid)) {
922                 gen = lu_igif_gen(fid);
923                 RETURN(gen);
924         }
925
926         gen = (fid_flatten(fid) >> 32);
927         RETURN(gen);
928 }
929
930 /* lsm is unreliable after hsm implementation as layout can be changed at
931  * any time. This is only to support old, non-clio-ized interfaces. It will
932  * cause deadlock if clio operations are called with this extra layout refcount
933  * because in case the layout changed during the IO, ll_layout_refresh() will
934  * have to wait for the refcount to become zero to destroy the older layout.
935  *
936  * Notice that the lsm returned by this function may not be valid unless called
937  * inside layout lock - MDS_INODELOCK_LAYOUT. */
938 struct lov_stripe_md *ccc_inode_lsm_get(struct inode *inode)
939 {
940         return lov_lsm_get(ll_i2info(inode)->lli_clob);
941 }
942
943 void inline ccc_inode_lsm_put(struct inode *inode, struct lov_stripe_md *lsm)
944 {
945         lov_lsm_put(ll_i2info(inode)->lli_clob, lsm);
946 }