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 struct ll_iattr {
  53         struct iattr    iattr;
  54         unsigned int    ia_attr_flags;
  55 };
  56
  57 #define CLIENT_OBD_LIST_LOCK_DEBUG 1
  58
  59 typedef struct {
  60         spinlock_t              lock;
  61
  62 #ifdef CLIENT_OBD_LIST_LOCK_DEBUG
  63         unsigned long       time;
  64         struct task_struct *task;
  65         const char         *func;
  66         int                 line;
  67 #endif
  68 } client_obd_lock_t;
  69
  70 #ifdef CLIENT_OBD_LIST_LOCK_DEBUG
  71 static inline void __client_obd_list_lock(client_obd_lock_t *lock,
  72                                           const char *func, int line)
  73 {
  74         unsigned long cur = jiffies;
  75         while (1) {
  76                 if (spin_trylock(&lock->lock)) {
  77                         LASSERT(lock->task == NULL);
  78                         lock->task = current;
  79                         lock->func = func;
  80                         lock->line = line;
  81                         lock->time = jiffies;
  82                         break;
  83                 }
  84
  85                 if ((jiffies - cur > 5 * HZ) &&
  86                     (jiffies - lock->time > 5 * HZ)) {
  87                         struct task_struct *task = lock->task;
  88
  89                         if (task == NULL)
  90                                 continue;
  91
  92                         LCONSOLE_WARN("%s:%d: lock %p was acquired"
  93                                       " by <%s:%d:%s:%d> for %lu seconds.\n",
  94                                       current->comm, current->pid,
  95                                       lock, task->comm, task->pid,
  96                                       lock->func, lock->line,
  97                                       (jiffies - lock->time) / HZ);
  98                         LCONSOLE_WARN("====== for process holding the "
  99                                       "lock =====\n");
 100                         libcfs_debug_dumpstack(task);
 101                         LCONSOLE_WARN("====== for current process =====\n");
 102                         libcfs_debug_dumpstack(NULL);
 103                         LCONSOLE_WARN("====== end =======\n");
 104                         cfs_pause(1000 * HZ);
 105                 }
 106                 cpu_relax();
 107         }
 108 }
 109
 110 #define client_obd_list_lock(lock) \
 111         __client_obd_list_lock(lock, __FUNCTION__, __LINE__)
 112
 113 static inline void client_obd_list_unlock(client_obd_lock_t *lock)
 114 {
 115         LASSERT(lock->task != NULL);
 116         lock->task = NULL;
 117         lock->time = jiffies;
 118         spin_unlock(&lock->lock);
 119 }
 120
 121 #else /* CLIENT_OBD_LIST_LOCK_DEBUG */
 122 static inline void client_obd_list_lock(client_obd_lock_t *lock)
 123 {
 124         spin_lock(&lock->lock);
 125 }
 126
 127 static inline void client_obd_list_unlock(client_obd_lock_t *lock)
 128 {
 129         spin_unlock(&lock->lock);
 130 }
 131
 132 #endif /* !CLIENT_OBD_LIST_LOCK_DEBUG */
 133
 134 static inline void client_obd_list_lock_init(client_obd_lock_t *lock)
 135 {
 136         spin_lock_init(&lock->lock);
 137 }
 138
 139 static inline void client_obd_list_lock_done(client_obd_lock_t *lock)
 140 {}
 141
 142 #ifndef HAVE_ADLER
 143 /* zlib_adler() is an inline function defined in zutil.h */
 144 # define HAVE_ADLER
 145 #endif /* !HAVE_ADLER */
 146 #endif /* __LINUX_OBD_H */