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) 2012, 2014, 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/rcupdate.h>
  42 #include <linux/spinlock.h>
  43 #include <libcfs/libcfs.h>
  44
  45 struct portals_handle_ops {
  46         void (*hop_addref)(void *object);
  47         void (*hop_free)(void *object, int size);
  48 };
  49
  50 /* These handles are most easily used by having them appear at the very top of
  51  * whatever object that you want to make handles for.  ie:
  52  *
  53  * struct ldlm_lock {
  54  *         struct portals_handle handle;
  55  *         ...
  56  * };
  57  *
  58  * Now you're able to assign the results of cookie2handle directly to an
  59  * ldlm_lock.  If it's not at the top, you'll want to use container_of()
  60  * to compute the start of the structure based on the handle field. */
  61 struct portals_handle {
  62         struct list_head                h_link;
  63         __u64                           h_cookie;
  64         const void                     *h_owner;
  65         struct portals_handle_ops      *h_ops;
  66
  67         /* newly added fields to handle the RCU issue. -jxiong */
  68         struct rcu_head                 h_rcu;
  69         spinlock_t                      h_lock;
  70         unsigned int                    h_size:31;
  71         unsigned int                    h_in:1;
  72 };
  73
  74 /* handles.c */
  75
  76 /* Add a handle to the hash table */
  77 void class_handle_hash(struct portals_handle *,
  78                        struct portals_handle_ops *ops);
  79 void class_handle_unhash(struct portals_handle *);
  80 void class_handle_hash_back(struct portals_handle *);
  81 void *class_handle2object(__u64 cookie, const void *owner);
  82 void class_handle_free_cb(struct rcu_head *rcu);
  83 int class_handle_init(void);
  84 void class_handle_cleanup(void);
  85
  86 /** @} handles */
  87
  88 #endif