lustre/obdclass/lu_ref.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) 2012, 2013, 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  * lustre/obdclass/lu_ref.c
  37  *
  38  * Lustre reference.
  39  *
  40  *   Author: Nikita Danilov <nikita.danilov@sun.com>
  41  */
  42
  43 #define DEBUG_SUBSYSTEM S_CLASS
  44
  45 #include <libcfs/libcfs.h>
  46 #include <obd.h>
  47 #include <obd_class.h>
  48 #include <obd_support.h>
  49 #include <lu_ref.h>
  50
  51 #ifdef USE_LU_REF
  52
  53 /**
  54  * Asserts a condition for a given lu_ref. Must be called with
  55  * lu_ref::lf_guard held.
  56  */
  57 #define REFASSERT(ref, expr) do {                                       \
  58         struct lu_ref *__tmp = (ref);                                   \
  59                                                                         \
  60         if (unlikely(!(expr))) {                                        \
  61                 lu_ref_print(__tmp);                                    \
  62                 spin_unlock(&__tmp->lf_guard);                          \
  63                 lu_ref_print_all();                                     \
  64                 LASSERT(0);                                             \
  65                 spin_lock(&__tmp->lf_guard);                            \
  66         }                                                               \
  67 } while (0)
  68
  69 static struct kmem_cache *lu_ref_link_kmem;
  70
  71 static struct lu_kmem_descr lu_ref_caches[] = {
  72         {
  73                 .ckd_cache = &lu_ref_link_kmem,
  74                 .ckd_name  = "lu_ref_link_kmem",
  75                 .ckd_size  = sizeof (struct lu_ref_link)
  76         },
  77         {
  78                 .ckd_cache = NULL
  79         }
  80 };
  81
  82 /**
  83  * Global list of active (initialized, but not finalized) lu_ref's.
  84  *
  85  * Protected by lu_ref_refs_guard.
  86  */
  87 static struct list_head lu_ref_refs;
  88 static spinlock_t lu_ref_refs_guard;
  89 static struct lu_ref lu_ref_marker = {
  90         .lf_guard       = __SPIN_LOCK_UNLOCKED(lu_ref_marker.lf_guard),
  91         .lf_list        = LIST_HEAD_INIT(lu_ref_marker.lf_list),
  92         .lf_linkage     = LIST_HEAD_INIT(lu_ref_marker.lf_linkage)
  93 };
  94
  95 void lu_ref_print(const struct lu_ref *ref)
  96 {
  97         struct lu_ref_link *link;
  98
  99         CERROR("lu_ref: %p %d %d %s:%d\n",
 100                ref, ref->lf_refs, ref->lf_failed, ref->lf_func, ref->lf_line);
 101         list_for_each_entry(link, &ref->lf_list, ll_linkage) {
 102                 CERROR("     link: %s %p\n", link->ll_scope, link->ll_source);
 103         }
 104 }
 105
 106 static int lu_ref_is_marker(const struct lu_ref *ref)
 107 {
 108         return (ref == &lu_ref_marker);
 109 }
 110
 111 void lu_ref_print_all(void)
 112 {
 113         struct lu_ref *ref;
 114
 115         spin_lock(&lu_ref_refs_guard);
 116         list_for_each_entry(ref, &lu_ref_refs, lf_linkage) {
 117                 if (lu_ref_is_marker(ref))
 118                         continue;
 119
 120                 spin_lock(&ref->lf_guard);
 121                 lu_ref_print(ref);
 122                 spin_unlock(&ref->lf_guard);
 123         }
 124         spin_unlock(&lu_ref_refs_guard);
 125 }
 126
 127 void lu_ref_init_loc(struct lu_ref *ref, const char *func, const int line)
 128 {
 129         ref->lf_refs = 0;
 130         ref->lf_func = func;
 131         ref->lf_line = line;
 132         spin_lock_init(&ref->lf_guard);
 133         INIT_LIST_HEAD(&ref->lf_list);
 134         spin_lock(&lu_ref_refs_guard);
 135         list_add(&ref->lf_linkage, &lu_ref_refs);
 136         spin_unlock(&lu_ref_refs_guard);
 137 }
 138
 139 void lu_ref_fini(struct lu_ref *ref)
 140 {
 141         REFASSERT(ref, list_empty(&ref->lf_list));
 142         REFASSERT(ref, ref->lf_refs == 0);
 143         spin_lock(&lu_ref_refs_guard);
 144         list_del_init(&ref->lf_linkage);
 145         spin_unlock(&lu_ref_refs_guard);
 146 }
 147
 148 static struct lu_ref_link *lu_ref_add_context(struct lu_ref *ref,
 149                                               int flags,
 150                                               const char *scope,
 151                                               const void *source)
 152 {
 153         struct lu_ref_link *link;
 154
 155         link = NULL;
 156         if (lu_ref_link_kmem != NULL) {
 157                 OBD_SLAB_ALLOC_PTR_GFP(link, lu_ref_link_kmem, flags);
 158                 if (link != NULL) {
 159                         link->ll_ref    = ref;
 160                         link->ll_scope  = scope;
 161                         link->ll_source = source;
 162                         spin_lock(&ref->lf_guard);
 163                         list_add_tail(&link->ll_linkage, &ref->lf_list);
 164                         ref->lf_refs++;
 165                         spin_unlock(&ref->lf_guard);
 166                 }
 167         }
 168
 169         if (link == NULL) {
 170                 spin_lock(&ref->lf_guard);
 171                 ref->lf_failed++;
 172                 spin_unlock(&ref->lf_guard);
 173                 link = ERR_PTR(-ENOMEM);
 174         }
 175
 176         return link;
 177 }
 178
 179 void lu_ref_add(struct lu_ref *ref, const char *scope, const void *source)
 180 {
 181         might_sleep();
 182         lu_ref_add_context(ref, GFP_IOFS, scope, source);
 183 }
 184
 185 void lu_ref_add_at(struct lu_ref *ref, struct lu_ref_link *link,
 186                    const char *scope, const void *source)
 187 {
 188         link->ll_ref = ref;
 189         link->ll_scope = scope;
 190         link->ll_source = source;
 191         spin_lock(&ref->lf_guard);
 192         list_add_tail(&link->ll_linkage, &ref->lf_list);
 193         ref->lf_refs++;
 194         spin_unlock(&ref->lf_guard);
 195 }
 196
 197 /**
 198  * Version of lu_ref_add() to be used in non-blockable contexts.
 199  */
 200 void lu_ref_add_atomic(struct lu_ref *ref, const char *scope,
 201                        const void *source)
 202 {
 203         lu_ref_add_context(ref, GFP_ATOMIC, scope, source);
 204 }
 205
 206 static inline int lu_ref_link_eq(const struct lu_ref_link *link,
 207                                  const char *scope, const void *source)
 208 {
 209         return link->ll_source == source && !strcmp(link->ll_scope, scope);
 210 }
 211
 212 /**
 213  * Maximal chain length seen so far.
 214  */
 215 static unsigned lu_ref_chain_max_length = 127;
 216
 217 /**
 218  * Searches for a lu_ref_link with given [scope, source] within given lu_ref.
 219  */
 220 static struct lu_ref_link *lu_ref_find(struct lu_ref *ref, const char *scope,
 221                                        const void *source)
 222 {
 223         struct lu_ref_link *link;
 224         unsigned            iterations;
 225
 226         iterations = 0;
 227         list_for_each_entry(link, &ref->lf_list, ll_linkage) {
 228                 ++iterations;
 229                 if (lu_ref_link_eq(link, scope, source)) {
 230                         if (iterations > lu_ref_chain_max_length) {
 231                                 CWARN("Long lu_ref chain %d \"%s\":%p\n",
 232                                       iterations, scope, source);
 233                                 lu_ref_chain_max_length = iterations * 3 / 2;
 234                         }
 235                         return link;
 236                 }
 237         }
 238         return NULL;
 239 }
 240
 241 void lu_ref_del(struct lu_ref *ref, const char *scope, const void *source)
 242 {
 243         struct lu_ref_link *link;
 244
 245         spin_lock(&ref->lf_guard);
 246         link = lu_ref_find(ref, scope, source);
 247         if (link != NULL) {
 248                 list_del(&link->ll_linkage);
 249                 ref->lf_refs--;
 250                 spin_unlock(&ref->lf_guard);
 251                 OBD_SLAB_FREE(link, lu_ref_link_kmem, sizeof(*link));
 252         } else {
 253                 REFASSERT(ref, ref->lf_failed > 0);
 254                 ref->lf_failed--;
 255                 spin_unlock(&ref->lf_guard);
 256         }
 257 }
 258
 259 void lu_ref_set_at(struct lu_ref *ref, struct lu_ref_link *link,
 260                    const char *scope,
 261                    const void *source0, const void *source1)
 262 {
 263         REFASSERT(ref, link != NULL && !IS_ERR(link));
 264
 265         spin_lock(&ref->lf_guard);
 266         REFASSERT(ref, link->ll_ref == ref);
 267         REFASSERT(ref, lu_ref_link_eq(link, scope, source0));
 268         link->ll_source = source1;
 269         spin_unlock(&ref->lf_guard);
 270 }
 271
 272 void lu_ref_del_at(struct lu_ref *ref, struct lu_ref_link *link,
 273                    const char *scope, const void *source)
 274 {
 275         REFASSERT(ref, link != NULL && !IS_ERR(link));
 276         spin_lock(&ref->lf_guard);
 277         REFASSERT(ref, link->ll_ref == ref);
 278         REFASSERT(ref, lu_ref_link_eq(link, scope, source));
 279         list_del(&link->ll_linkage);
 280         ref->lf_refs--;
 281         spin_unlock(&ref->lf_guard);
 282 }
 283
 284 #ifdef CONFIG_PROC_FS
 285
 286 static void *lu_ref_seq_start(struct seq_file *seq, loff_t *pos)
 287 {
 288         struct lu_ref *ref = seq->private;
 289
 290         spin_lock(&lu_ref_refs_guard);
 291         if (list_empty(&ref->lf_linkage))
 292                 ref = NULL;
 293         spin_unlock(&lu_ref_refs_guard);
 294
 295         return ref;
 296 }
 297
 298 static void *lu_ref_seq_next(struct seq_file *seq, void *p, loff_t *pos)
 299 {
 300         struct lu_ref *ref = p;
 301         struct lu_ref *next;
 302
 303         LASSERT(seq->private == p);
 304         LASSERT(!list_empty(&ref->lf_linkage));
 305
 306         spin_lock(&lu_ref_refs_guard);
 307         next = list_entry(ref->lf_linkage.next, struct lu_ref, lf_linkage);
 308         if (&next->lf_linkage == &lu_ref_refs) {
 309                 p = NULL;
 310         } else {
 311                 (*pos)++;
 312                 list_move(&ref->lf_linkage, &next->lf_linkage);
 313         }
 314         spin_unlock(&lu_ref_refs_guard);
 315         return p;
 316 }
 317
 318 static void lu_ref_seq_stop(struct seq_file *seq, void *p)
 319 {
 320         /* Nothing to do */
 321 }
 322
 323
 324 static int lu_ref_seq_show(struct seq_file *seq, void *p)
 325 {
 326         struct lu_ref *ref  = p;
 327         struct lu_ref *next;
 328
 329         spin_lock(&lu_ref_refs_guard);
 330         next = list_entry(ref->lf_linkage.next, struct lu_ref, lf_linkage);
 331         if ((&next->lf_linkage == &lu_ref_refs) || lu_ref_is_marker(next)) {
 332                 spin_unlock(&lu_ref_refs_guard);
 333                 return 0;
 334         }
 335
 336         /* print the entry */
 337         spin_lock(&next->lf_guard);
 338         seq_printf(seq, "lu_ref: %p %d %d %s:%d\n",
 339                    next, next->lf_refs, next->lf_failed,
 340                    next->lf_func, next->lf_line);
 341         if (next->lf_refs > 64) {
 342                 seq_printf(seq, "  too many references, skip\n");
 343         } else {
 344                 struct lu_ref_link *link;
 345                 int i = 0;
 346
 347                 list_for_each_entry(link, &next->lf_list, ll_linkage)
 348                         seq_printf(seq, "  #%d link: %s %p\n",
 349                                    i++, link->ll_scope, link->ll_source);
 350         }
 351         spin_unlock(&next->lf_guard);
 352         spin_unlock(&lu_ref_refs_guard);
 353
 354         return 0;
 355 }
 356
 357 static struct seq_operations lu_ref_seq_ops = {
 358         .start = lu_ref_seq_start,
 359         .stop  = lu_ref_seq_stop,
 360         .next  = lu_ref_seq_next,
 361         .show  = lu_ref_seq_show
 362 };
 363
 364 static int lu_ref_seq_open(struct inode *inode, struct file *file)
 365 {
 366         struct lu_ref *marker = &lu_ref_marker;
 367         int result = 0;
 368
 369         result = seq_open(file, &lu_ref_seq_ops);
 370         if (result == 0) {
 371                 spin_lock(&lu_ref_refs_guard);
 372                 if (!list_empty(&marker->lf_linkage))
 373                         result = -EAGAIN;
 374                 else
 375                         list_add(&marker->lf_linkage, &lu_ref_refs);
 376                 spin_unlock(&lu_ref_refs_guard);
 377
 378                 if (result == 0) {
 379                         struct seq_file *f = file->private_data;
 380                         f->private = marker;
 381                 } else {
 382                         seq_release(inode, file);
 383                 }
 384         }
 385
 386         return result;
 387 }
 388
 389 static int lu_ref_seq_release(struct inode *inode, struct file *file)
 390 {
 391         struct lu_ref *ref = ((struct seq_file *)file->private_data)->private;
 392
 393         spin_lock(&lu_ref_refs_guard);
 394         list_del_init(&ref->lf_linkage);
 395         spin_unlock(&lu_ref_refs_guard);
 396
 397         return seq_release(inode, file);
 398 }
 399
 400 static struct file_operations lu_ref_dump_fops = {
 401         .owner   = THIS_MODULE,
 402         .open    = lu_ref_seq_open,
 403         .read    = seq_read,
 404         .llseek  = seq_lseek,
 405         .release = lu_ref_seq_release
 406 };
 407
 408 #endif /* CONFIG_PROC_FS */
 409
 410 int lu_ref_global_init(void)
 411 {
 412         int result;
 413
 414         CDEBUG(D_CONSOLE,
 415                "lu_ref tracking is enabled. Performance isn't.\n");
 416
 417         INIT_LIST_HEAD(&lu_ref_refs);
 418         spin_lock_init(&lu_ref_refs_guard);
 419         result = lu_kmem_init(lu_ref_caches);
 420
 421 #ifdef CONFIG_PROC_FS
 422         if (result == 0) {
 423                 result = lprocfs_seq_create(proc_lustre_root, "lu_refs",
 424                                             0444, &lu_ref_dump_fops, NULL);
 425                 if (result)
 426                         lu_kmem_fini(lu_ref_caches);
 427         }
 428 #endif /* CONFIG_PROC_FS */
 429
 430         return result;
 431 }
 432
 433 void lu_ref_global_fini(void)
 434 {
 435 #ifdef CONFIG_PROC_FS
 436         lprocfs_remove_proc_entry("lu_refs", proc_lustre_root);
 437 #endif /* CONFIG_PROC_FS */
 438         lu_kmem_fini(lu_ref_caches);
 439 }
 440
 441 #endif /* USE_LU_REF */