lustre/include/linux/obd.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright (c) 1999, 2010, Oracle and/or its affiliates. All rights reserved.
  30  * Use is subject to license terms.
  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 #ifdef __KERNEL__
  47 # include <linux/fs.h>
  48 # include <linux/list.h>
  49 # include <linux/sched.h>  /* for struct task_struct, for current.h */
  50 # include <asm/current.h>  /* for smp_lock.h */
  51 # include <linux/smp_lock.h>
  52 # include <linux/proc_fs.h>
  53 # include <linux/mount.h>
  54 # ifndef HAVE_VFS_INTENT_PATCHES
  55 #  include <linux/lustre_intent.h>
  56 # endif
  57 #endif
  58
  59 typedef struct {
  60         cfs_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
  69 } client_obd_lock_t;
  70
  71 #ifdef CLIENT_OBD_LIST_LOCK_DEBUG
  72 static inline void __client_obd_list_lock(client_obd_lock_t *lock,
  73                                           const char *func,
  74                                           int line)
  75 {
  76         unsigned long cur = jiffies;
  77         while (1) {
  78                 if (cfs_spin_trylock(&lock->lock)) {
  79                         LASSERT(lock->task == NULL);
  80                         lock->task = current;
  81                         lock->func = func;
  82                         lock->line = line;
  83                         lock->time = jiffies;
  84                         break;
  85                 }
  86
  87                 if ((jiffies - cur > 5 * CFS_HZ) &&
  88                     (jiffies - lock->time > 5 * CFS_HZ)) {
  89                         LCONSOLE_WARN("LOCK UP! the lock %p was acquired"
  90                                       " by <%s:%d:%s:%d> %lu time, I'm %s:%d\n",
  91                                       lock, lock->task->comm, lock->task->pid,
  92                                       lock->func, lock->line,
  93                                       (jiffies - lock->time),
  94                                       current->comm, current->pid);
  95                         LCONSOLE_WARN("====== for process holding the "
  96                                       "lock =====\n");
  97                         libcfs_debug_dumpstack(lock->task);
  98                         LCONSOLE_WARN("====== for current process =====\n");
  99                         libcfs_debug_dumpstack(NULL);
 100                         LCONSOLE_WARN("====== end =======\n");
 101                         cfs_pause(1000 * CFS_HZ);
 102                 }
 103         }
 104 }
 105
 106 #define client_obd_list_lock(lock) \
 107         __client_obd_list_lock(lock, __FUNCTION__, __LINE__)
 108
 109 static inline void client_obd_list_unlock(client_obd_lock_t *lock)
 110 {
 111         LASSERT(lock->task != NULL);
 112         lock->task = NULL;
 113         lock->time = jiffies;
 114         cfs_spin_unlock(&lock->lock);
 115 }
 116
 117 #else /* ifdef CLIENT_OBD_LIST_LOCK_DEBUG */
 118 static inline void client_obd_list_lock(client_obd_lock_t *lock)
 119 {
 120         cfs_spin_lock(&lock->lock);
 121 }
 122
 123 static inline void client_obd_list_unlock(client_obd_lock_t *lock)
 124 {
 125         cfs_spin_unlock(&lock->lock);
 126 }
 127
 128 #endif /* ifdef CLIENT_OBD_LIST_LOCK_DEBUG */
 129
 130 static inline void client_obd_list_lock_init(client_obd_lock_t *lock)
 131 {
 132         cfs_spin_lock_init(&lock->lock);
 133 }
 134
 135 static inline void client_obd_list_lock_done(client_obd_lock_t *lock)
 136 {}
 137
 138 #if defined(__KERNEL__) && !defined(HAVE_ADLER)
 139 /* zlib_adler() is an inline function defined in zutil.h */
 140 #define HAVE_ADLER
 141 #endif
 142 #endif /* __LINUX_OBD_H */