Whamcloud - gitweb
LU-14487 modules: remove references to Sun Trademark.
[fs/lustre-release.git] / lustre / llite / vvp_dev.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.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2012, 2016, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  *
31  * cl_device and cl_device_type implementation for VVP layer.
32  *
33  *   Author: Nikita Danilov <nikita.danilov@sun.com>
34  *   Author: Jinshan Xiong <jinshan.xiong@intel.com>
35  */
36
37 #define DEBUG_SUBSYSTEM S_LLITE
38
39 #include <obd.h>
40 #include "llite_internal.h"
41 #include "vvp_internal.h"
42 #include <linux/kallsyms.h>
43
44 /*****************************************************************************
45  *
46  * Vvp device and device type functions.
47  *
48  */
49
50 /*
51  * vvp_ prefix stands for "Vfs Vm Posix". It corresponds to historical
52  * "llite_" (var. "ll_") prefix.
53  */
54
55 static struct kmem_cache *ll_thread_kmem;
56 struct kmem_cache *vvp_object_kmem;
57 static struct kmem_cache *vvp_session_kmem;
58 static struct kmem_cache *vvp_thread_kmem;
59
60 static struct lu_kmem_descr vvp_caches[] = {
61         {
62                 .ckd_cache = &ll_thread_kmem,
63                 .ckd_name  = "ll_thread_kmem",
64                 .ckd_size  = sizeof(struct ll_thread_info),
65         },
66         {
67                 .ckd_cache = &vvp_object_kmem,
68                 .ckd_name  = "vvp_object_kmem",
69                 .ckd_size  = sizeof(struct vvp_object),
70         },
71         {
72                 .ckd_cache = &vvp_session_kmem,
73                 .ckd_name  = "vvp_session_kmem",
74                 .ckd_size  = sizeof (struct vvp_session)
75         },
76         {
77                 .ckd_cache = &vvp_thread_kmem,
78                 .ckd_name  = "vvp_thread_kmem",
79                 .ckd_size  = sizeof(struct vvp_thread_info),
80         },
81         {
82                 .ckd_cache = NULL
83         }
84 };
85
86 static void *ll_thread_key_init(const struct lu_context *ctx,
87                                 struct lu_context_key *key)
88 {
89         struct ll_thread_info *lti;
90
91         OBD_SLAB_ALLOC_PTR_GFP(lti, ll_thread_kmem, GFP_NOFS);
92         if (lti == NULL)
93                 lti = ERR_PTR(-ENOMEM);
94
95         return lti;
96 }
97
98 static void ll_thread_key_fini(const struct lu_context *ctx,
99                                struct lu_context_key *key, void *data)
100 {
101         struct ll_thread_info *lti = data;
102
103         OBD_SLAB_FREE_PTR(lti, ll_thread_kmem);
104 }
105
106 struct lu_context_key ll_thread_key = {
107         .lct_tags = LCT_CL_THREAD,
108         .lct_init = ll_thread_key_init,
109         .lct_fini = ll_thread_key_fini,
110 };
111
112 static void *vvp_session_key_init(const struct lu_context *ctx,
113                                   struct lu_context_key *key)
114 {
115         struct vvp_session *session;
116
117         OBD_SLAB_ALLOC_PTR_GFP(session, vvp_session_kmem, GFP_NOFS);
118         if (session == NULL)
119                 session = ERR_PTR(-ENOMEM);
120         return session;
121 }
122
123 static void vvp_session_key_fini(const struct lu_context *ctx,
124                                  struct lu_context_key *key, void *data)
125 {
126         struct vvp_session *session = data;
127         OBD_SLAB_FREE_PTR(session, vvp_session_kmem);
128 }
129
130 struct lu_context_key vvp_session_key = {
131         .lct_tags = LCT_SESSION,
132         .lct_init = vvp_session_key_init,
133         .lct_fini = vvp_session_key_fini
134 };
135
136 static void *vvp_thread_key_init(const struct lu_context *ctx,
137                                  struct lu_context_key *key)
138 {
139         struct vvp_thread_info *vti;
140
141         OBD_SLAB_ALLOC_PTR_GFP(vti, vvp_thread_kmem, GFP_NOFS);
142         if (vti == NULL)
143                 vti = ERR_PTR(-ENOMEM);
144         return vti;
145 }
146
147 static void vvp_thread_key_fini(const struct lu_context *ctx,
148                                 struct lu_context_key *key, void *data)
149 {
150         struct vvp_thread_info *vti = data;
151         OBD_SLAB_FREE_PTR(vti, vvp_thread_kmem);
152 }
153
154 struct lu_context_key vvp_thread_key = {
155         .lct_tags = LCT_CL_THREAD,
156         .lct_init = vvp_thread_key_init,
157         .lct_fini = vvp_thread_key_fini,
158 };
159
160 /* type constructor/destructor: vvp_type_{init,fini,start,stop}(). */
161 LU_TYPE_INIT_FINI(vvp, &ll_thread_key, &vvp_session_key, &vvp_thread_key);
162
163 static const struct lu_device_operations vvp_lu_ops = {
164         .ldo_object_alloc      = vvp_object_alloc
165 };
166
167 static struct lu_device *vvp_device_free(const struct lu_env *env,
168                                          struct lu_device *d)
169 {
170         struct vvp_device *vdv  = lu2vvp_dev(d);
171         struct cl_site    *site = lu2cl_site(d->ld_site);
172         struct lu_device  *next = cl2lu_dev(vdv->vdv_next);
173
174         if (d->ld_site != NULL) {
175                 cl_site_fini(site);
176                 OBD_FREE_PTR(site);
177         }
178
179         cl_device_fini(lu2cl_dev(d));
180         OBD_FREE_PTR(vdv);
181         return next;
182 }
183
184 static struct lu_device *vvp_device_alloc(const struct lu_env *env,
185                                           struct lu_device_type *t,
186                                           struct lustre_cfg *cfg)
187 {
188         struct vvp_device *vdv;
189         struct lu_device *lud;
190         struct cl_site *site;
191         int rc;
192         ENTRY;
193
194         OBD_ALLOC_PTR(vdv);
195         if (vdv == NULL)
196                 RETURN(ERR_PTR(-ENOMEM));
197
198         lud = &vdv->vdv_cl.cd_lu_dev;
199         cl_device_init(&vdv->vdv_cl, t);
200         vvp2lu_dev(vdv)->ld_ops = &vvp_lu_ops;
201
202         OBD_ALLOC_PTR(site);
203         if (site != NULL) {
204                 rc = cl_site_init(site, &vdv->vdv_cl);
205                 if (rc == 0)
206                         rc = lu_site_init_finish(&site->cs_lu);
207                 else {
208                         LASSERT(lud->ld_site == NULL);
209                         CERROR("Cannot init lu_site, rc %d.\n", rc);
210                         OBD_FREE_PTR(site);
211                 }
212         } else
213                 rc = -ENOMEM;
214         if (rc != 0) {
215                 vvp_device_free(env, lud);
216                 lud = ERR_PTR(rc);
217         }
218         RETURN(lud);
219 }
220
221 static int vvp_device_init(const struct lu_env *env, struct lu_device *d,
222                            const char *name, struct lu_device *next)
223 {
224         struct vvp_device  *vdv;
225         int rc;
226         ENTRY;
227
228         vdv = lu2vvp_dev(d);
229         vdv->vdv_next = lu2cl_dev(next);
230
231         LASSERT(d->ld_site != NULL && next->ld_type != NULL);
232         next->ld_site = d->ld_site;
233         rc = next->ld_type->ldt_ops->ldto_device_init(
234                 env, next, next->ld_type->ldt_name, NULL);
235         if (rc == 0) {
236                 lu_device_get(next);
237                 lu_ref_add(&next->ld_reference, "lu-stack", &lu_site_init);
238         }
239         RETURN(rc);
240 }
241
242 static struct lu_device *vvp_device_fini(const struct lu_env *env,
243                                          struct lu_device *d)
244 {
245         return cl2lu_dev(lu2vvp_dev(d)->vdv_next);
246 }
247
248 static const struct lu_device_type_operations vvp_device_type_ops = {
249         .ldto_init = vvp_type_init,
250         .ldto_fini = vvp_type_fini,
251
252         .ldto_start = vvp_type_start,
253         .ldto_stop  = vvp_type_stop,
254
255         .ldto_device_alloc      = vvp_device_alloc,
256         .ldto_device_free       = vvp_device_free,
257         .ldto_device_init       = vvp_device_init,
258         .ldto_device_fini       = vvp_device_fini,
259 };
260
261 struct lu_device_type vvp_device_type = {
262         .ldt_tags     = LU_DEVICE_CL,
263         .ldt_name     = LUSTRE_VVP_NAME,
264         .ldt_ops      = &vvp_device_type_ops,
265         .ldt_ctx_tags = LCT_CL_THREAD
266 };
267
268 #ifndef HAVE_ACCOUNT_PAGE_DIRTIED_EXPORT
269 unsigned int (*vvp_account_page_dirtied)(struct page *page,
270                                          struct address_space *mapping);
271 #endif
272
273 /**
274  * A mutex serializing calls to vvp_inode_fini() under extreme memory
275  * pressure, when environments cannot be allocated.
276  */
277 int vvp_global_init(void)
278 {
279         int rc;
280
281         rc = lu_kmem_init(vvp_caches);
282         if (rc != 0)
283                 return rc;
284
285         rc = lu_device_type_init(&vvp_device_type);
286         if (rc != 0)
287                 goto out_kmem;
288
289 #ifndef HAVE_ACCOUNT_PAGE_DIRTIED_EXPORT
290         /*
291          * Kernel v5.2-5678-gac1c3e4 no longer exports account_page_dirtied
292          */
293         vvp_account_page_dirtied = (void *)
294                 kallsyms_lookup_name("account_page_dirtied");
295         BUG_ON(!vvp_account_page_dirtied);
296 #endif
297
298         return 0;
299
300 out_kmem:
301         lu_kmem_fini(vvp_caches);
302
303         return rc;
304 }
305
306 void vvp_global_fini(void)
307 {
308         lu_device_type_fini(&vvp_device_type);
309         lu_kmem_fini(vvp_caches);
310 }
311
312 /*****************************************************************************
313  *
314  * mirror obd-devices into cl devices.
315  *
316  */
317
318 int cl_sb_init(struct super_block *sb)
319 {
320         struct ll_sb_info *sbi;
321         struct cl_device  *cl;
322         struct lu_env     *env;
323         int rc = 0;
324         __u16 refcheck;
325
326         sbi  = ll_s2sbi(sb);
327         env = cl_env_get(&refcheck);
328         if (!IS_ERR(env)) {
329                 cl = cl_type_setup(env, NULL, &vvp_device_type,
330                                    sbi->ll_dt_exp->exp_obd->obd_lu_dev);
331                 if (!IS_ERR(cl)) {
332                         sbi->ll_cl = cl;
333                         sbi->ll_site = cl2lu_dev(cl)->ld_site;
334                 }
335                 cl_env_put(env, &refcheck);
336         } else
337                 rc = PTR_ERR(env);
338         RETURN(rc);
339 }
340
341 int cl_sb_fini(struct super_block *sb)
342 {
343         struct ll_sb_info *sbi;
344         struct lu_env     *env;
345         struct cl_device  *cld;
346         __u16              refcheck;
347         int                result;
348
349         ENTRY;
350         sbi = ll_s2sbi(sb);
351         env = cl_env_get(&refcheck);
352         if (!IS_ERR(env)) {
353                 cld = sbi->ll_cl;
354
355                 if (cld != NULL) {
356                         cl_stack_fini(env, cld);
357                         sbi->ll_cl = NULL;
358                         sbi->ll_site = NULL;
359                 }
360                 cl_env_put(env, &refcheck);
361                 result = 0;
362         } else {
363                 CERROR("Cannot cleanup cl-stack due to memory shortage.\n");
364                 result = PTR_ERR(env);
365         }
366
367         RETURN(result);
368 }
369
370 /****************************************************************************
371  *
372  * debugfs/lustre/llite/$MNT/dump_page_cache
373  *
374  ****************************************************************************/
375
376 struct vvp_seq_private {
377         struct ll_sb_info       *vsp_sbi;
378         struct lu_env           *vsp_env;
379         u16                     vsp_refcheck;
380         struct cl_object        *vsp_clob;
381         struct rhashtable_iter  vsp_iter;
382         u32                     vsp_page_index;
383         /*
384          * prev_pos is the 'pos' of the last object returned
385          * by ->start of ->next.
386          */
387         loff_t                  vvp_prev_pos;
388 };
389
390 static struct page *vvp_pgcache_current(struct vvp_seq_private *priv)
391 {
392         struct lu_device *dev = &priv->vsp_sbi->ll_cl->cd_lu_dev;
393         struct lu_object_header *h;
394         struct page *vmpage = NULL;
395
396         rhashtable_walk_start(&priv->vsp_iter);
397         while ((h = rhashtable_walk_next(&priv->vsp_iter)) != NULL) {
398                 struct inode *inode;
399                 int nr;
400
401                 if (!priv->vsp_clob) {
402                         struct lu_object *lu_obj;
403
404                         lu_obj = lu_object_get_first(h, dev);
405                         if (!lu_obj)
406                                 continue;
407
408                         priv->vsp_clob = lu2cl(lu_obj);
409                         lu_object_ref_add(lu_obj, "dump", current);
410                         priv->vsp_page_index = 0;
411                 }
412
413                 inode = vvp_object_inode(priv->vsp_clob);
414                 nr = find_get_pages_contig(inode->i_mapping,
415                                            priv->vsp_page_index, 1, &vmpage);
416                 if (nr > 0) {
417                         priv->vsp_page_index = vmpage->index;
418                         break;
419                 }
420                 lu_object_ref_del(&priv->vsp_clob->co_lu, "dump", current);
421                 cl_object_put(priv->vsp_env, priv->vsp_clob);
422                 priv->vsp_clob = NULL;
423                 priv->vsp_page_index = 0;
424         }
425         rhashtable_walk_stop(&priv->vsp_iter);
426         return vmpage;
427 }
428
429 #define seq_page_flag(seq, page, flag, has_flags) do {                  \
430         if (test_bit(PG_##flag, &(page)->flags)) {                  \
431                 seq_printf(seq, "%s"#flag, has_flags ? "|" : "");       \
432                 has_flags = 1;                                          \
433         }                                                               \
434 } while(0)
435
436 static void vvp_pgcache_page_show(const struct lu_env *env,
437                                   struct seq_file *seq, struct cl_page *page)
438 {
439         struct vvp_page *vpg;
440         struct page      *vmpage;
441         int              has_flags;
442
443         vpg = cl2vvp_page(cl_page_at(page, &vvp_device_type));
444         vmpage = vpg->vpg_page;
445         seq_printf(seq, " %5i | %p %p %s %s %s | %p "DFID"(%p) %lu %u [",
446                    0 /* gen */,
447                    vpg, page,
448                    "none",
449                    vpg->vpg_defer_uptodate ? "du" : "- ",
450                    PageWriteback(vmpage) ? "wb" : "-",
451                    vmpage,
452                    PFID(ll_inode2fid(vmpage->mapping->host)),
453                    vmpage->mapping->host, vmpage->index,
454                    page_count(vmpage));
455         has_flags = 0;
456         seq_page_flag(seq, vmpage, locked, has_flags);
457         seq_page_flag(seq, vmpage, error, has_flags);
458         seq_page_flag(seq, vmpage, referenced, has_flags);
459         seq_page_flag(seq, vmpage, uptodate, has_flags);
460         seq_page_flag(seq, vmpage, dirty, has_flags);
461         seq_page_flag(seq, vmpage, writeback, has_flags);
462         seq_printf(seq, "%s]\n", has_flags ? "" : "-");
463 }
464
465 static int vvp_pgcache_show(struct seq_file *f, void *v)
466 {
467         struct vvp_seq_private *priv = f->private;
468         struct page *vmpage = v;
469         struct cl_page *page;
470
471         seq_printf(f, "%8lx@" DFID ": ", vmpage->index,
472                    PFID(lu_object_fid(&priv->vsp_clob->co_lu)));
473         lock_page(vmpage);
474         page = cl_vmpage_page(vmpage, priv->vsp_clob);
475         unlock_page(vmpage);
476         put_page(vmpage);
477
478         if (page) {
479                 vvp_pgcache_page_show(priv->vsp_env, f, page);
480                 cl_page_put(priv->vsp_env, page);
481         } else {
482                 seq_puts(f, "missing\n");
483         }
484
485         return 0;
486 }
487
488 static void vvp_pgcache_rewind(struct vvp_seq_private *priv)
489 {
490         if (priv->vvp_prev_pos) {
491                 struct lu_site *s = priv->vsp_sbi->ll_cl->cd_lu_dev.ld_site;
492
493                 rhashtable_walk_exit(&priv->vsp_iter);
494                 rhashtable_walk_enter(&s->ls_obj_hash, &priv->vsp_iter);
495                 priv->vvp_prev_pos = 0;
496                 if (priv->vsp_clob) {
497                         lu_object_ref_del(&priv->vsp_clob->co_lu, "dump",
498                                           current);
499                         cl_object_put(priv->vsp_env, priv->vsp_clob);
500                 }
501                 priv->vsp_clob = NULL;
502         }
503 }
504
505 static struct page *vvp_pgcache_next_page(struct vvp_seq_private *priv)
506 {
507         priv->vsp_page_index += 1;
508         return vvp_pgcache_current(priv);
509 }
510
511 static void *vvp_pgcache_start(struct seq_file *f, loff_t *pos)
512 {
513         struct vvp_seq_private *priv = f->private;
514
515         if (*pos == 0) {
516                 vvp_pgcache_rewind(priv);
517         } else if (*pos == priv->vvp_prev_pos) {
518                 /* Return the current item */;
519         } else {
520                 WARN_ON(*pos != priv->vvp_prev_pos + 1);
521                 priv->vsp_page_index += 1;
522         }
523
524         priv->vvp_prev_pos = *pos;
525         return vvp_pgcache_current(priv);
526 }
527
528 static void *vvp_pgcache_next(struct seq_file *f, void *v, loff_t *pos)
529 {
530         struct vvp_seq_private *priv = f->private;
531
532         WARN_ON(*pos != priv->vvp_prev_pos);
533         *pos += 1;
534         priv->vvp_prev_pos = *pos;
535         return vvp_pgcache_next_page(priv);
536 }
537
538 static void vvp_pgcache_stop(struct seq_file *f, void *v)
539 {
540         /* Nothing to do */
541 }
542
543 static const struct seq_operations vvp_pgcache_ops = {
544         .start = vvp_pgcache_start,
545         .next  = vvp_pgcache_next,
546         .stop  = vvp_pgcache_stop,
547         .show  = vvp_pgcache_show
548 };
549
550 static int vvp_dump_pgcache_seq_open(struct inode *inode, struct file *filp)
551 {
552         struct vvp_seq_private *priv;
553         struct lu_site *s;
554
555         priv = __seq_open_private(filp, &vvp_pgcache_ops, sizeof(*priv));
556         if (!priv)
557                 return -ENOMEM;
558
559         priv->vsp_sbi = inode->i_private;
560         priv->vsp_env = cl_env_get(&priv->vsp_refcheck);
561         priv->vsp_clob = NULL;
562         if (IS_ERR(priv->vsp_env)) {
563                 int err = PTR_ERR(priv->vsp_env);
564
565                 seq_release_private(inode, filp);
566                 return err;
567         }
568
569         s = priv->vsp_sbi->ll_cl->cd_lu_dev.ld_site;
570         rhashtable_walk_enter(&s->ls_obj_hash, &priv->vsp_iter);
571
572         return 0;
573 }
574
575 static int vvp_dump_pgcache_seq_release(struct inode *inode, struct file *file)
576 {
577         struct seq_file *seq = file->private_data;
578         struct vvp_seq_private *priv = seq->private;
579
580         if (priv->vsp_clob) {
581                 lu_object_ref_del(&priv->vsp_clob->co_lu, "dump", current);
582                 cl_object_put(priv->vsp_env, priv->vsp_clob);
583         }
584         cl_env_put(priv->vsp_env, &priv->vsp_refcheck);
585         rhashtable_walk_exit(&priv->vsp_iter);
586         return seq_release_private(inode, file);
587 }
588
589 const struct file_operations vvp_dump_pgcache_file_ops = {
590         .owner   = THIS_MODULE,
591         .open    = vvp_dump_pgcache_seq_open,
592         .read    = seq_read,
593         .llseek  = seq_lseek,
594         .release = vvp_dump_pgcache_seq_release,
595 };