lustre/include/lustre_handles.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
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  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
  37 #ifndef __LUSTRE_HANDLES_H_
  38 #define __LUSTRE_HANDLES_H_
  39
  40 /** \defgroup handles handles
  41  *
  42  * @{
  43  */
  44
  45 #if defined(__linux__)
  46 #include <linux/lustre_handles.h>
  47 #elif defined(__APPLE__)
  48 #include <darwin/lustre_handles.h>
  49 #elif defined(__WINNT__)
  50 #include <winnt/lustre_handles.h>
  51 #else
  52 #error Unsupported operating system.
  53 #endif
  54
  55 #include <libcfs/libcfs.h>
  56
  57 typedef void (*portals_handle_addref_cb)(void *object);
  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 hack up a macro that
  69  * uses some offsetof() magic. */
  70
  71 struct portals_handle {
  72         cfs_list_t h_link;
  73         __u64 h_cookie;
  74         portals_handle_addref_cb h_addref;
  75
  76         /* newly added fields to handle the RCU issue. -jxiong */
  77         cfs_spinlock_t h_lock;
  78         void *h_ptr;
  79         void (*h_free_cb)(void *, size_t);
  80         cfs_rcu_head_t h_rcu;
  81         unsigned int h_size;
  82         __u8 h_in:1;
  83         __u8 h_unused[3];
  84 };
  85 #define RCU2HANDLE(rcu)    container_of(rcu, struct portals_handle, h_rcu)
  86
  87 /* handles.c */
  88
  89 /* Add a handle to the hash table */
  90 void class_handle_hash(struct portals_handle *, portals_handle_addref_cb);
  91 void class_handle_unhash(struct portals_handle *);
  92 void class_handle_hash_back(struct portals_handle *);
  93 void *class_handle2object(__u64 cookie);
  94 void class_handle_free_cb(cfs_rcu_head_t *);
  95 int class_handle_init(void);
  96 void class_handle_cleanup(void);
  97
  98 /** @} handles */
  99
 100 #endif