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 /*
  31  * This file is part of Lustre, http://www.lustre.org/
  32  * Lustre is a trademark of Sun Microsystems, Inc.
  33  */
  34
  35 #ifndef __LUSTRE_HANDLES_H_
  36 #define __LUSTRE_HANDLES_H_
  37
  38 /** \defgroup handles handles
  39  *
  40  * @{
  41  */
  42
  43 #if defined(__linux__)
  44 #include <linux/lustre_handles.h>
  45 #elif defined(__APPLE__)
  46 #include <darwin/lustre_handles.h>
  47 #elif defined(__WINNT__)
  48 #include <winnt/lustre_handles.h>
  49 #else
  50 #error Unsupported operating system.
  51 #endif
  52
  53 #include <libcfs/libcfs.h>
  54
  55 #if !defined(HAVE_RCU) || !defined(__KERNEL__)
  56 typedef struct {
  57         int foo;
  58 } cfs_rcu_head_t;
  59 #endif
  60
  61 struct portals_handle_ops {
  62         void (*hop_addref)(void *object);
  63         void (*hop_free)(void *object, int size);
  64 };
  65
  66 /* These handles are most easily used by having them appear at the very top of
  67  * whatever object that you want to make handles for.  ie:
  68  *
  69  * struct ldlm_lock {
  70  *         struct portals_handle handle;
  71  *         ...
  72  * };
  73  *
  74  * Now you're able to assign the results of cookie2handle directly to an
  75  * ldlm_lock.  If it's not at the top, you'll want to use container_of()
  76  * to compute the start of the structure based on the handle field. */
  77 struct portals_handle {
  78         cfs_list_t                      h_link;
  79         __u64                           h_cookie;
  80         struct portals_handle_ops       *h_ops;
  81
  82         /* newly added fields to handle the RCU issue. -jxiong */
  83         cfs_rcu_head_t                  h_rcu;
  84         cfs_spinlock_t                  h_lock;
  85         unsigned int                    h_size:31;
  86         unsigned int                    h_in:1;
  87 };
  88 #define RCU2HANDLE(rcu)    container_of(rcu, struct portals_handle, h_rcu)
  89
  90 /* handles.c */
  91
  92 /* Add a handle to the hash table */
  93 void class_handle_hash(struct portals_handle *,
  94                        struct portals_handle_ops *ops);
  95 void class_handle_unhash(struct portals_handle *);
  96 void class_handle_hash_back(struct portals_handle *);
  97 void *class_handle2object(__u64 cookie);
  98 void class_handle_free_cb(cfs_rcu_head_t *);
  99 int class_handle_init(void);
 100 void class_handle_cleanup(void);
 101
 102 /** @} handles */
 103
 104 #endif