lustre/include/lustre_ucache.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 _UPCALL_CACHE_H
  38 #define _UPCALL_CACHE_H
  39
  40 #define UC_CACHE_NEW            0x01
  41 #define UC_CACHE_ACQUIRING      0x02
  42 #define UC_CACHE_INVALID        0x04
  43 #define UC_CACHE_EXPIRED        0x08
  44
  45 #define UC_CACHE_IS_NEW(i)          ((i)->ue_flags & UC_CACHE_NEW)
  46 #define UC_CACHE_IS_INVALID(i)      ((i)->ue_flags & UC_CACHE_INVALID)
  47 #define UC_CACHE_IS_ACQUIRING(i)    ((i)->ue_flags & UC_CACHE_ACQUIRING)
  48 #define UC_CACHE_IS_EXPIRED(i)      ((i)->ue_flags & UC_CACHE_EXPIRED)
  49 #define UC_CACHE_IS_VALID(i)        ((i)->ue_flags == 0)
  50
  51 #define UC_CACHE_SET_NEW(i)         (i)->ue_flags |= UC_CACHE_NEW
  52 #define UC_CACHE_SET_INVALID(i)     (i)->ue_flags |= UC_CACHE_INVALID
  53 #define UC_CACHE_SET_ACQUIRING(i)   (i)->ue_flags |= UC_CACHE_ACQUIRING
  54 #define UC_CACHE_SET_EXPIRED(i)     (i)->ue_flags |= UC_CACHE_EXPIRED
  55 #define UC_CACHE_SET_VALID(i)       (i)->ue_flags = 0
  56
  57 #define UC_CACHE_CLEAR_NEW(i)       (i)->ue_flags &= ~UC_CACHE_NEW
  58 #define UC_CACHE_CLEAR_ACQUIRING(i) (i)->ue_flags &= ~UC_CACHE_ACQUIRING
  59 #define UC_CACHE_CLEAR_INVALID(i)   (i)->ue_flags &= ~UC_CACHE_INVALID
  60 #define UC_CACHE_CLEAR_EXPIRED(i)   (i)->ue_flags &= ~UC_CACHE_EXPIRED
  61
  62 struct upcall_cache_entry {
  63         struct list_head        ue_hash;
  64         __u64                   ue_key;
  65         __u64                   ue_primary;
  66         struct group_info      *ue_group_info;
  67         atomic_t                ue_refcount;
  68         int                     ue_flags;
  69         cfs_waitq_t             ue_waitq;
  70         cfs_time_t              ue_acquire_expire;
  71         cfs_time_t              ue_expire;
  72 };
  73
  74 #define UC_CACHE_HASH_SIZE        (128)
  75 #define UC_CACHE_HASH_INDEX(id)   ((id) & (UC_CACHE_HASH_SIZE - 1))
  76 #define UC_CACHE_UPCALL_MAXPATH   (1024UL)
  77
  78 struct upcall_cache {
  79         struct list_head        uc_hashtable[UC_CACHE_HASH_SIZE];
  80         spinlock_t              uc_lock;
  81
  82         char                    uc_name[40];            /* for upcall */
  83         char                    uc_upcall[UC_CACHE_UPCALL_MAXPATH];
  84         cfs_time_t              uc_acquire_expire;      /* jiffies */
  85         cfs_time_t              uc_entry_expire;        /* jiffies */
  86 };
  87
  88 struct upcall_cache_entry *upcall_cache_get_entry(struct upcall_cache *hash,
  89                                                   __u64 key, __u32 primary,
  90                                                   __u32 ngroups, __u32 *groups);
  91 void upcall_cache_put_entry(struct upcall_cache *hash,
  92                             struct upcall_cache_entry *entry);
  93 int upcall_cache_downcall(struct upcall_cache *hash, __u32 err, __u64 key,
  94                           __u32 primary, __u32 ngroups, __u32 *groups);
  95 void upcall_cache_flush_idle(struct upcall_cache *cache);
  96 void upcall_cache_flush_all(struct upcall_cache *cache);
  97 struct upcall_cache *upcall_cache_init(const char *name);
  98 void upcall_cache_cleanup(struct upcall_cache *hash);
  99
 100 #endif /* _UPCALL_CACHE_H */