lustre/include/linux/obd.h

   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) 1999, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, 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
  37 #ifndef __LINUX_OBD_H
  38 #define __LINUX_OBD_H
  39
  40 #ifndef __OBD_H
  41 #error Do not #include this file directly. #include <obd.h> instead
  42 #endif
  43
  44 #include <obd_support.h>
  45
  46 #include <linux/fs.h>
  47 #include <linux/list.h>
  48 #include <linux/sched.h>  /* for struct task_struct, for current.h */
  49 #include <linux/proc_fs.h>
  50 #include <linux/mount.h>
  51
  52 #define CLIENT_OBD_LIST_LOCK_DEBUG 1
  53
  54 typedef struct {
  55         spinlock_t              lock;
  56
  57 #ifdef CLIENT_OBD_LIST_LOCK_DEBUG
  58         unsigned long       time;
  59         struct task_struct *task;
  60         const char         *func;
  61         int                 line;
  62 #endif
  63 } client_obd_lock_t;
  64
  65 #ifdef CLIENT_OBD_LIST_LOCK_DEBUG
  66 static inline void __client_obd_list_lock(client_obd_lock_t *lock,
  67                                           const char *func, int line)
  68 {
  69         unsigned long cur = jiffies;
  70         while (1) {
  71                 if (spin_trylock(&lock->lock)) {
  72                         LASSERT(lock->task == NULL);
  73                         lock->task = current;
  74                         lock->func = func;
  75                         lock->line = line;
  76                         lock->time = jiffies;
  77                         break;
  78                 }
  79
  80                 if ((jiffies - cur > msecs_to_jiffies(5 * MSEC_PER_SEC)) &&
  81                     (jiffies - lock->time >
  82                      msecs_to_jiffies(5 * MSEC_PER_SEC))) {
  83                         struct task_struct *task = lock->task;
  84
  85                         if (task == NULL)
  86                                 continue;
  87
  88                         LCONSOLE_WARN("%s:%d: lock %p was acquired"
  89                                       " by <%s:%d:%s:%d> for %lu seconds.\n",
  90                                       current->comm, current->pid,
  91                                       lock, task->comm, task->pid,
  92                                       lock->func, lock->line,
  93                                       jiffies_to_msecs(jiffies - lock->time) /
  94                                       MSEC_PER_SEC);
  95                         LCONSOLE_WARN("====== for process holding the "
  96                                       "lock =====\n");
  97                         libcfs_debug_dumpstack(task);
  98                         LCONSOLE_WARN("====== for current process =====\n");
  99                         libcfs_debug_dumpstack(NULL);
 100                         LCONSOLE_WARN("====== end =======\n");
 101                         cfs_pause(msecs_to_jiffies(1000 * MSEC_PER_SEC));
 102                 }
 103                 cpu_relax();
 104         }
 105 }
 106
 107 #define client_obd_list_lock(lock) \
 108         __client_obd_list_lock(lock, __FUNCTION__, __LINE__)
 109
 110 static inline void client_obd_list_unlock(client_obd_lock_t *lock)
 111 {
 112         LASSERT(lock->task != NULL);
 113         lock->task = NULL;
 114         lock->time = jiffies;
 115         spin_unlock(&lock->lock);
 116 }
 117
 118 #else /* CLIENT_OBD_LIST_LOCK_DEBUG */
 119 static inline void client_obd_list_lock(client_obd_lock_t *lock)
 120 {
 121         spin_lock(&lock->lock);
 122 }
 123
 124 static inline void client_obd_list_unlock(client_obd_lock_t *lock)
 125 {
 126         spin_unlock(&lock->lock);
 127 }
 128
 129 #endif /* !CLIENT_OBD_LIST_LOCK_DEBUG */
 130
 131 static inline void client_obd_list_lock_init(client_obd_lock_t *lock)
 132 {
 133         spin_lock_init(&lock->lock);
 134 }
 135
 136 static inline void client_obd_list_lock_done(client_obd_lock_t *lock)
 137 {}
 138
 139 #ifndef HAVE_ADLER
 140 /* zlib_adler() is an inline function defined in zutil.h */
 141 # define HAVE_ADLER
 142 #endif /* !HAVE_ADLER */
 143 #endif /* __LINUX_OBD_H */