libcfs/include/libcfs/linux/linux-lock.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 [sun.com URL with a
  20  * copy of GPLv2].
  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  2008 Sun Microsystems, Inc. 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  * libcfs/include/libcfs/linux/linux-lock.h
  37  *
  38  * Basic library routines.
  39  */
  40
  41 #ifndef __LIBCFS_LINUX_CFS_LOCK_H__
  42 #define __LIBCFS_LINUX_CFS_LOCK_H__
  43
  44 #ifndef __LIBCFS_LIBCFS_H__
  45 #error Do not #include this file directly. #include <libcfs/libcfs.h> instead
  46 #endif
  47
  48 #ifndef __KERNEL__
  49 #error This include is only for kernel use.
  50 #endif
  51
  52 #include <linux/smp_lock.h>
  53
  54 /*
  55  * IMPORTANT !!!!!!!!
  56  *
  57  * All locks' declaration are not guaranteed to be initialized,
  58  * Althought some of they are initialized in Linux. All locks
  59  * declared by CFS_DECL_* should be initialized explicitly.
  60  */
  61
  62
  63 /*
  64  * spin_lock (use Linux kernel's primitives)
  65  *
  66  * - spin_lock_init(x)
  67  * - spin_lock(x)
  68  * - spin_unlock(x)
  69  * - spin_trylock(x)
  70  *
  71  * - spin_lock_irqsave(x, f)
  72  * - spin_unlock_irqrestore(x, f)
  73  */
  74
  75 /*
  76  * rw_semaphore (use Linux kernel's primitives)
  77  *
  78  * - init_rwsem(x)
  79  * - down_read(x)
  80  * - up_read(x)
  81  * - down_write(x)
  82  * - up_write(x)
  83  */
  84
  85 /*
  86  * rwlock_t (use Linux kernel's primitives)
  87  *
  88  * - rwlock_init(x)
  89  * - read_lock(x)
  90  * - read_unlock(x)
  91  * - write_lock(x)
  92  * - write_unlock(x)
  93  */
  94
  95 /*
  96  * mutex:
  97  *
  98  * - init_mutex(x)
  99  * - init_mutex_locked(x)
 100  * - mutex_up(x)
 101  * - mutex_down(x)
 102  */
 103 #define init_mutex(x)                   init_MUTEX(x)
 104 #define init_mutex_locked(x)            init_MUTEX_LOCKED(x)
 105 #define mutex_up(x)                     up(x)
 106 #define mutex_down(x)                   down(x)
 107 #define mutex_down_trylock(x)           down_trylock(x)
 108
 109 /*
 110  * completion (use Linux kernel's primitives)
 111  *
 112  * - init_complition(c)
 113  * - complete(c)
 114  * - wait_for_completion(c)
 115  */
 116
 117 #endif