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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2011, 2012, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  */
  32
  33 #ifndef __LUSTRE_HANDLES_H_
  34 #define __LUSTRE_HANDLES_H_
  35
  36 /** \defgroup handles handles
  37  *
  38  * @{
  39  */
  40
  41 #include <linux/atomic.h>
  42 #include <linux/list.h>
  43 #include <linux/rcupdate.h>
  44 #include <linux/spinlock.h>
  45 #include <linux/types.h>
  46
  47 #include <linux/libcfs/libcfs.h>
  48
  49 struct portals_handle_ops {
  50         void (*hop_addref)(void *object);
  51         void (*hop_free)(void *object, int size);
  52 };
  53
  54 /* These handles are most easily used by having them appear at the very top of
  55  * whatever object that you want to make handles for.  ie:
  56  *
  57  * struct ldlm_lock {
  58  *       struct portals_handle handle;
  59  *       ...
  60  * };
  61  *
  62  * Now you're able to assign the results of cookie2handle directly to an
  63  * ldlm_lock.  If it's not at the top, you'll want to use container_of()
  64  * to compute the start of the structure based on the handle field.
  65  */
  66 struct portals_handle {
  67         struct list_head                        h_link;
  68         __u64                           h_cookie;
  69         const void                      *h_owner;
  70         struct portals_handle_ops       *h_ops;
  71
  72         /* newly added fields to handle the RCU issue. -jxiong */
  73         struct rcu_head                 h_rcu;
  74         spinlock_t                      h_lock;
  75         unsigned int                    h_size:31;
  76         unsigned int                    h_in:1;
  77 };
  78
  79 /* handles.c */
  80
  81 /* Add a handle to the hash table */
  82 void class_handle_hash(struct portals_handle *,
  83                        struct portals_handle_ops *ops);
  84 void class_handle_unhash(struct portals_handle *);
  85 void *class_handle2object(__u64 cookie, const void *owner);
  86 void class_handle_free_cb(struct rcu_head *rcu);
  87 int class_handle_init(void);
  88 void class_handle_cleanup(void);
  89
  90 /** @} handles */
  91
  92 #endif