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  */
  31
  32 #ifndef __LUSTRE_HANDLES_H_
  33 #define __LUSTRE_HANDLES_H_
  34
  35 /** \defgroup handles handles
  36  *
  37  * @{
  38  */
  39
  40 #include <linux/rcupdate.h>
  41 #include <linux/refcount.h>
  42 #include <linux/spinlock.h>
  43 #include <libcfs/libcfs.h>
  44
  45 /* These handles are most easily used by having them appear at the very top of
  46  * whatever object that you want to make handles for.  ie:
  47  *
  48  * struct ldlm_lock {
  49  *         struct portals_handle handle;
  50  *         ...
  51  * };
  52  *
  53  * Now you're able to assign the results of cookie2handle directly to an
  54  * ldlm_lock.  If it's not at the top, you'll want to use container_of()
  55  * to compute the start of the structure based on the handle field. */
  56 struct portals_handle {
  57         struct hlist_node               h_link;
  58         __u64                           h_cookie;
  59         const char                      *h_owner;
  60         refcount_t                      h_ref;
  61         struct rcu_head                 h_rcu;
  62 };
  63
  64 /* handles.c */
  65
  66 /* Add a handle to the hash table */
  67 void class_handle_hash(struct portals_handle *, const char *h_owner);
  68 void class_handle_unhash(struct portals_handle *);
  69 void *class_handle2object(u64 cookie, const char *h_owner);
  70 int class_handle_init(void);
  71 void class_handle_cleanup(void);
  72
  73 /** @} handles */
  74
  75 #endif