kernel/drivers/staging/lustre/lustre/include/lustre_handles.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) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, 2012, 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 __LUSTRE_HANDLES_H_
  38 #define __LUSTRE_HANDLES_H_
  39
  40 /** \defgroup handles handles
  41  *
  42  * @{
  43  */
  44
  45 #include <linux/atomic.h>
  46 #include <linux/list.h>
  47 #include <linux/rcupdate.h>
  48 #include <linux/spinlock.h>
  49 #include <linux/types.h>
  50
  51 #include "../../include/linux/libcfs/libcfs.h"
  52
  53
  54 struct portals_handle_ops {
  55         void (*hop_addref)(void *object);
  56         void (*hop_free)(void *object, int size);
  57 };
  58
  59 /* These handles are most easily used by having them appear at the very top of
  60  * whatever object that you want to make handles for.  ie:
  61  *
  62  * struct ldlm_lock {
  63  *       struct portals_handle handle;
  64  *       ...
  65  * };
  66  *
  67  * Now you're able to assign the results of cookie2handle directly to an
  68  * ldlm_lock.  If it's not at the top, you'll want to use container_of()
  69  * to compute the start of the structure based on the handle field. */
  70 struct portals_handle {
  71         struct list_head                        h_link;
  72         __u64                           h_cookie;
  73         struct portals_handle_ops       *h_ops;
  74
  75         /* newly added fields to handle the RCU issue. -jxiong */
  76         struct rcu_head                 h_rcu;
  77         spinlock_t                      h_lock;
  78         unsigned int                    h_size:31;
  79         unsigned int                    h_in:1;
  80 };
  81 #define RCU2HANDLE(rcu)    container_of(rcu, struct portals_handle, h_rcu)
  82
  83 /* handles.c */
  84
  85 /* Add a handle to the hash table */
  86 void class_handle_hash(struct portals_handle *,
  87                        struct portals_handle_ops *ops);
  88 void class_handle_unhash(struct portals_handle *);
  89 void class_handle_hash_back(struct portals_handle *);
  90 void *class_handle2object(__u64 cookie);
  91 void class_handle_free_cb(struct rcu_head *rcu);
  92 int class_handle_init(void);
  93 void class_handle_cleanup(void);
  94
  95 /** @} handles */
  96
  97 #endif