1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * lustre/obdclass/capa.c
5 * Lustre Capability Cache Management
7 * Copyright (c) 2001-2003 Cluster File Systems, Inc.
8 * Author: Lai Siyao<lsy@clusterfs.com>
10 * This file is part of Lustre, http://www.lustre.org.
12 * Lustre is free software; you can redistribute it and/or
13 * modify it under the terms of version 2 of the GNU General Public
14 * License as published by the Free Software Foundation.
16 * Lustre is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with Lustre; if not, write to the Free Software
23 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 # define EXPORT_SYMTAB
29 #define DEBUG_SUBSYSTEM S_SEC
32 #include <linux/version.h>
34 #include <asm/unistd.h>
35 #include <linux/slab.h>
36 #include <linux/module.h>
37 #include <linux/init.h>
39 #include <linux/obd_class.h>
40 #include <linux/lustre_debug.h>
41 #include <linux/lustre_idl.h>
42 #include <linux/lustre_sec.h>
44 #include <liblustre.h>
47 #include <libcfs/list.h>
48 #include <linux/lustre_sec.h>
50 kmem_cache_t *capa_cachep = NULL;
52 /* capa_lock protect capa hash, list and content. */
53 spinlock_t capa_lock = SPIN_LOCK_UNLOCKED;
54 struct hlist_head *capa_hash;
55 struct list_head capa_list[3];
56 static int capa_count[3] = { 0 };
58 static char *capa_type_name[] = { "client", "mds", "filter" };
60 /* TODO: mdc and llite all need this, so define it here.
61 * in the future it will be moved to ll_sb_info to support multi-
63 struct timer_list ll_capa_timer;
65 EXPORT_SYMBOL(capa_lock);
66 EXPORT_SYMBOL(capa_hash);
67 EXPORT_SYMBOL(capa_list);
68 EXPORT_SYMBOL(ll_capa_timer);
70 static inline int const
71 capa_hashfn(unsigned int uid, __u64 mdsid, unsigned long ino)
73 return (ino ^ uid) * (unsigned long)(mdsid + 1) % NR_CAPAHASH;
76 int capa_op(int flags)
78 if (flags & (FMODE_WRITE|MDS_OPEN_TRUNC))
80 else if (flags & FMODE_READ)
83 LBUG(); /* should be either MAY_READ or MAY_WRITE */
87 static struct obd_capa *
88 find_capa(struct hlist_head *head, uid_t uid, int capa_op, __u64 mdsid,
89 unsigned long ino, __u32 igen, int type)
91 struct hlist_node *pos;
92 struct obd_capa *ocapa;
95 CDEBUG(D_INODE, "find capa for (uid %u, op %d, mdsid "LPU64", ino %lu"
96 " igen %u, type %d\n", (unsigned) uid, capa_op, mdsid, ino, igen, type);
97 hlist_for_each_entry(ocapa, pos, head, c_hash) {
98 if (ocapa->c_capa.lc_ino != ino)
100 if (ocapa->c_capa.lc_igen != igen)
102 if (ocapa->c_capa.lc_mdsid != mdsid)
104 if ((ocapa->c_capa.lc_op & capa_op) != ocapa->c_capa.lc_op)
106 if (ocapa->c_type != type)
109 if (ocapa->c_type == CLIENT_CAPA)
110 ouid = ocapa->c_capa.lc_ruid;
112 ouid = ocapa->c_capa.lc_uid;
117 DEBUG_CAPA(D_INODE, &ocapa->c_capa, "found %s",
118 capa_type_name[ocapa->c_type]);
126 inline void __capa_get(struct obd_capa *ocapa)
128 if (ocapa->c_type != CLIENT_CAPA)
129 atomic_inc(&ocapa->c_refc);
132 static struct obd_capa *
133 find_capa_locked(struct hlist_head *head, uid_t uid, int capa_op, __u64 mdsid,
134 unsigned long ino, __u32 igen, int type)
136 struct obd_capa *ocapa;
138 spin_lock(&capa_lock);
139 ocapa = find_capa(head, uid, capa_op, mdsid, ino, igen, type);
142 spin_unlock(&capa_lock);
147 static struct obd_capa *alloc_capa(void)
149 struct obd_capa *ocapa;
151 OBD_SLAB_ALLOC(ocapa, capa_cachep, SLAB_NOFS, sizeof(*ocapa));
153 INIT_HLIST_NODE(&ocapa->c_hash);
154 INIT_LIST_HEAD(&ocapa->c_list);
160 static void __capa_put(struct obd_capa *ocapa)
162 hlist_del_init(&ocapa->c_hash);
163 list_del_init(&ocapa->c_list);
164 capa_count[ocapa->c_type]--;
167 static void destroy_capa(struct obd_capa *ocapa)
169 OBD_SLAB_FREE(ocapa, capa_cachep, sizeof(*ocapa));
172 int capa_cache_init(void)
176 OBD_ALLOC(capa_hash, PAGE_SIZE);
180 nr_hash = PAGE_SIZE / sizeof(struct hlist_head);
181 LASSERT(nr_hash > NR_CAPAHASH);
183 for (i = 0; i < NR_CAPAHASH; i++)
184 INIT_HLIST_HEAD(capa_hash + i);
186 for (i = 0; i < 3; i++)
187 INIT_LIST_HEAD(&capa_list[i]);
192 void capa_cache_cleanup(void)
194 struct obd_capa *ocapa, *tmp;
197 for (i = MDS_CAPA; i <= FILTER_CAPA; i++) {
198 list_for_each_entry_safe(ocapa, tmp, &capa_list[i], c_list) {
204 OBD_FREE(capa_hash, PAGE_SIZE);
208 static inline void list_add_capa(struct obd_capa *ocapa, struct list_head *head)
210 struct obd_capa *tmp;
212 /* XXX: capa is sorted in client, this could be optimized */
213 if (ocapa->c_type == CLIENT_CAPA) {
214 list_for_each_entry_reverse(tmp, head, c_list) {
215 if (ocapa->c_capa.lc_expiry > tmp->c_capa.lc_expiry) {
216 list_add(&ocapa->c_list, &tmp->c_list);
222 list_add(&ocapa->c_list, head);
225 static inline void do_update_capa(struct obd_capa *ocapa, struct lustre_capa *capa)
227 memcpy(&ocapa->c_capa, capa, sizeof(*capa));
230 static struct obd_capa *
231 get_new_capa_locked(struct hlist_head *head, int type, struct lustre_capa *capa)
233 uid_t uid = capa->lc_uid;
234 int capa_op = capa->lc_op;
235 __u64 mdsid = capa->lc_mdsid;
236 unsigned long ino = capa->lc_ino;
237 struct obd_capa *ocapa, *old;
239 ocapa = alloc_capa();
243 spin_lock(&capa_lock);
244 old = find_capa(head, uid, capa_op, mdsid, ino, capa->lc_igen, type);
246 do_update_capa(ocapa, capa);
247 ocapa->c_type = type;
248 list_add_capa(ocapa, &capa_list[type]);
249 hlist_add_head(&ocapa->c_hash, head);
250 if (type == CLIENT_CAPA)
251 INIT_LIST_HEAD(&ocapa->c_lli_list);
256 DEBUG_CAPA(D_INODE, &ocapa->c_capa, "new %s",
257 capa_type_name[type]);
259 if (type != CLIENT_CAPA && capa_count[type] > CAPA_CACHE_SIZE) {
260 struct list_head *node = capa_list[type].next;
261 struct obd_capa *tcapa;
264 /* free 12 unused capa from head */
265 while (node->next != &capa_list[type] && count < 12) {
266 tcapa = list_entry(node, struct obd_capa,
269 if (atomic_read(&tcapa->c_refc) > 0)
271 DEBUG_CAPA(D_INODE, &tcapa->c_capa,
273 capa_type_name[type]);
280 spin_unlock(&capa_lock);
283 spin_unlock(&capa_lock);
290 capa_get(uid_t uid, int capa_op,__u64 mdsid, unsigned long ino,
291 __u32 igen, int type)
293 struct hlist_head *head = capa_hash + capa_hashfn(uid, mdsid, ino);
294 struct obd_capa *ocapa;
296 ocapa = find_capa_locked(head, uid, capa_op, mdsid, ino, igen, type);
301 void capa_put(struct obd_capa *ocapa)
306 DEBUG_CAPA(D_INODE, &ocapa->c_capa, "put %s",
307 capa_type_name[ocapa->c_type]);
308 spin_lock(&capa_lock);
309 if (ocapa->c_type == CLIENT_CAPA) {
310 list_del_init(&ocapa->c_lli_list);
314 atomic_dec(&ocapa->c_refc);
316 spin_unlock(&capa_lock);
319 struct obd_capa *capa_renew(struct lustre_capa *capa, int type)
321 uid_t uid = capa->lc_uid;
322 int capa_op = capa->lc_op;
323 __u64 mdsid = capa->lc_mdsid;
324 unsigned long ino = capa->lc_ino;
325 struct hlist_head *head = capa_hash +
326 capa_hashfn(uid, mdsid, ino);
327 struct obd_capa *ocapa;
329 spin_lock(&capa_lock);
330 ocapa = find_capa(head, uid, capa_op, mdsid, ino, capa->lc_igen, type);
332 DEBUG_CAPA(D_INFO, capa, "renew %s", capa_type_name[type]);
333 do_update_capa(ocapa, capa);
335 spin_unlock(&capa_lock);
338 ocapa = get_new_capa_locked(head, type, capa);
343 void capa_hmac(struct crypto_tfm *tfm, __u8 *key, struct lustre_capa *capa)
345 int keylen = CAPA_KEY_LEN;
346 struct scatterlist sl = {
347 .page = virt_to_page(capa),
348 .offset = (unsigned long)(capa) % PAGE_SIZE,
349 .length = sizeof(struct lustre_capa_data),
353 crypto_hmac(tfm, key, &keylen, &sl, 1, capa->lc_hmac);
356 void capa_dup(void *dst, struct obd_capa *ocapa)
358 spin_lock(&capa_lock);
359 memcpy(dst, &ocapa->c_capa, sizeof(ocapa->c_capa));
360 spin_unlock(&capa_lock);
363 void capa_dup2(void *dst, struct lustre_capa *capa)
365 spin_lock(&capa_lock);
366 memcpy(dst, capa, sizeof(*capa));
367 spin_unlock(&capa_lock);
370 int capa_expired(struct lustre_capa *capa)
374 do_gettimeofday(&tv);
375 return ((unsigned long )capa->lc_expiry <= tv.tv_sec) ? 1 : 0;
378 int __capa_is_to_expire(struct obd_capa *ocapa, struct timeval *tv)
380 int pre_expiry = capa_pre_expiry(&ocapa->c_capa);
382 /* XXX: in case the clock is inaccurate, minus one more
383 * pre_expiry to make sure the expiry won't miss */
384 return ((unsigned long)ocapa->c_capa.lc_expiry -
385 2 * pre_expiry <= tv->tv_sec)? 1 : 0;
388 int capa_is_to_expire(struct obd_capa *ocapa)
393 do_gettimeofday(&tv);
394 spin_lock(&capa_lock);
395 rc = __capa_is_to_expire(ocapa, &tv);
396 spin_unlock(&capa_lock);
401 EXPORT_SYMBOL(capa_op);
402 EXPORT_SYMBOL(capa_get);
403 EXPORT_SYMBOL(capa_put);
404 EXPORT_SYMBOL(capa_renew);
405 EXPORT_SYMBOL(__capa_get);
406 EXPORT_SYMBOL(capa_hmac);
407 EXPORT_SYMBOL(capa_dup);
408 EXPORT_SYMBOL(capa_dup2);
409 EXPORT_SYMBOL(capa_expired);
410 EXPORT_SYMBOL(__capa_is_to_expire);
411 EXPORT_SYMBOL(capa_is_to_expire);