lustre/obdclass/capa.c

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  *  lustre/obdclass/capa.c
   5  *  Lustre Capability Cache Management
   6  *
   7  *  Copyright (c) 2001-2003 Cluster File Systems, Inc.
   8  *   Author: Lai Siyao<lsy@clusterfs.com>
   9  *
  10  *   This file is part of Lustre, http://www.lustre.org.
  11  *
  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.
  15  *
  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.
  20  *
  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.
  24  */
  25 #ifndef EXPORT_SYMTAB
  26 # define EXPORT_SYMTAB
  27 #endif
  28
  29 #define DEBUG_SUBSYSTEM S_SEC
  30
  31 #ifdef __KERNEL__
  32 #include <linux/version.h>
  33 #include <linux/fs.h>
  34 #include <asm/unistd.h>
  35 #include <linux/slab.h>
  36 #include <linux/module.h>
  37 #include <linux/init.h>
  38
  39 #include <linux/obd_class.h>
  40 #include <linux/lustre_debug.h>
  41 #include <linux/lustre_idl.h>
  42 #include <linux/lustre_sec.h>
  43 #else
  44 #include <liblustre.h>
  45 #endif
  46
  47 #include <libcfs/list.h>
  48 #include <linux/lustre_sec.h>
  49
  50 kmem_cache_t *capa_cachep = NULL;
  51
  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 };
  57
  58 /* TODO: mdc and llite all need this, so define it here.
  59  * in the future it will be moved to ll_sb_info to support multi-
  60  * mount point */
  61 struct timer_list ll_capa_timer;
  62
  63 EXPORT_SYMBOL(capa_lock);
  64 EXPORT_SYMBOL(capa_hash);
  65 EXPORT_SYMBOL(capa_list);
  66 EXPORT_SYMBOL(ll_capa_timer);
  67
  68 static inline int const
  69 capa_hashfn(unsigned int uid, int capa_op, __u64 mdsid, unsigned long ino)
  70 {
  71         return (ino ^ uid) * (unsigned long)capa_op * (unsigned long)mdsid %
  72                NR_CAPAHASH;
  73 }
  74
  75 int capa_op(int flags)
  76 {
  77         if (flags & (FMODE_WRITE|MDS_OPEN_TRUNC))
  78                 return CAPA_WRITE;
  79         else if (flags & FMODE_READ)
  80                 return CAPA_READ;
  81
  82         LBUG(); /* should be either MAY_READ or MAY_WRITE */
  83         return 0;
  84 }
  85
  86 static struct obd_capa *
  87 find_capa(struct hlist_head *head, uid_t uid, int capa_op, __u64 mdsid,
  88           unsigned long ino, int type)
  89 {
  90         struct hlist_node *pos;
  91         struct obd_capa *ocapa;
  92         uid_t ouid;
  93
  94         hlist_for_each_entry(ocapa, pos, head, c_hash) {
  95                 if (ocapa->c_capa.lc_ino != ino)
  96                         continue;
  97                 if (ocapa->c_capa.lc_mdsid != mdsid)
  98                         continue;
  99                 if ((ocapa->c_capa.lc_op & capa_op) != ocapa->c_capa.lc_op)
 100                         continue;
 101                 if (ocapa->c_type != type)
 102                         continue;
 103
 104                 if (ocapa->c_type == CLIENT_CAPA)
 105                         ouid = ocapa->c_capa.lc_ruid;
 106                 else
 107                         ouid = ocapa->c_capa.lc_uid;
 108
 109                 if (ouid != uid)
 110                         continue;
 111
 112                 DEBUG_CAPA(D_CACHE, &ocapa->c_capa, "found");
 113
 114                 return ocapa;
 115         }
 116
 117         return NULL;
 118 }
 119
 120 inline void __capa_get(struct obd_capa *ocapa)
 121 {
 122         if (ocapa->c_type != CLIENT_CAPA)
 123                 atomic_inc(&ocapa->c_refc);
 124 }
 125
 126 static struct obd_capa *
 127 find_capa_locked(struct hlist_head *head, uid_t uid, int capa_op, __u64 mdsid,
 128                  unsigned long ino, int type)
 129 {
 130         struct obd_capa *ocapa;
 131
 132         spin_lock(&capa_lock);
 133         ocapa = find_capa(head, uid, capa_op, mdsid, ino, type);
 134         if (ocapa)
 135                 __capa_get(ocapa);
 136         spin_unlock(&capa_lock);
 137
 138         return ocapa;
 139 }
 140
 141 static struct obd_capa *alloc_capa(void)
 142 {
 143         struct obd_capa *ocapa;
 144
 145         OBD_SLAB_ALLOC(ocapa, capa_cachep, SLAB_NOFS, sizeof(*ocapa));
 146         if (ocapa) {
 147                 INIT_HLIST_NODE(&ocapa->c_hash);
 148                 INIT_LIST_HEAD(&ocapa->c_list);
 149         }
 150
 151         return ocapa;
 152 }
 153
 154 static void __capa_put(struct obd_capa *ocapa)
 155 {
 156         hlist_del_init(&ocapa->c_hash);
 157         list_del_init(&ocapa->c_list);
 158         capa_count[ocapa->c_type]--;
 159 }
 160
 161 static void destroy_capa(struct obd_capa *ocapa)
 162 {
 163         OBD_SLAB_FREE(ocapa, capa_cachep, sizeof(*ocapa));
 164 }
 165
 166 int capa_cache_init(void)
 167 {
 168         int nr_hash, i;
 169
 170         OBD_ALLOC(capa_hash, PAGE_SIZE);
 171         if (!capa_hash)
 172                 return -ENOMEM;
 173
 174         nr_hash = PAGE_SIZE / sizeof(struct hlist_head);
 175         LASSERT(nr_hash > NR_CAPAHASH);
 176
 177         for (i = 0; i < NR_CAPAHASH; i++)
 178                 INIT_HLIST_HEAD(capa_hash + i);
 179
 180         for (i = 0; i < 3; i++)
 181                 INIT_LIST_HEAD(&capa_list[i]);
 182
 183         return 0;
 184 }
 185
 186 void capa_cache_cleanup(void)
 187 {
 188         struct obd_capa *ocapa;
 189         struct hlist_node *pos, *n;
 190
 191         hlist_for_each_entry_safe(ocapa, pos, n, capa_hash, c_hash) {
 192                 LASSERT(ocapa->c_type != CLIENT_CAPA);
 193                 __capa_put(ocapa);
 194                 destroy_capa(ocapa);
 195         }
 196
 197         OBD_FREE(capa_hash, PAGE_SIZE);
 198 }
 199
 200
 201 static inline void list_add_capa(struct obd_capa *ocapa, struct list_head *head)
 202 {
 203         struct obd_capa *tmp;
 204
 205         /* XXX: capa is sorted in client, this could be optimized */
 206         if (ocapa->c_type == CLIENT_CAPA) {
 207                 list_for_each_entry_reverse(tmp, head, c_list) {
 208                         if (ocapa->c_capa.lc_expiry > tmp->c_capa.lc_expiry) {
 209                                 list_add(&ocapa->c_list, &tmp->c_list);
 210                                 return;
 211                         }
 212                 }
 213         }
 214
 215         list_add_tail(&ocapa->c_list, head);
 216 }
 217
 218 static inline void do_update_capa(struct obd_capa *ocapa, struct lustre_capa *capa)
 219 {
 220         memcpy(&ocapa->c_capa, capa, sizeof(*capa));
 221 }
 222
 223 static struct obd_capa *
 224 get_new_capa_locked(struct hlist_head *head, int type, struct lustre_capa *capa)
 225 {
 226         uid_t uid = capa->lc_uid;
 227         int capa_op = capa->lc_op;
 228         __u64 mdsid = capa->lc_mdsid;
 229         unsigned long ino = capa->lc_ino;
 230         struct obd_capa *ocapa, *old;
 231
 232         ocapa = alloc_capa();
 233         if (!ocapa)
 234                 return NULL;
 235
 236         spin_lock(&capa_lock);
 237         old = find_capa(head, uid, capa_op, mdsid, ino, type);
 238         if (!old) {
 239                 do_update_capa(ocapa, capa);
 240                 ocapa->c_type = type;
 241                 list_add_capa(ocapa, &capa_list[type]);
 242                 hlist_add_head(&ocapa->c_hash, capa_hash);
 243                 if (type == CLIENT_CAPA)
 244                         INIT_LIST_HEAD(&ocapa->c_lli_list);
 245
 246                 capa_count[type]++;
 247
 248                 DEBUG_CAPA(D_CACHE, &ocapa->c_capa, "new");
 249
 250                 if (type != CLIENT_CAPA && capa_count[type] > CAPA_CACHE_SIZE) {
 251                         struct list_head *node = capa_list[type].next;
 252                         struct obd_capa *tcapa;
 253                         int count = 0;
 254
 255                         /* free 12 unused capa from head */
 256                         while (node->next != &capa_list[type] && count < 12) {
 257                                 tcapa = list_entry(node, struct obd_capa,
 258                                                    c_list);
 259                                 node = node->next;
 260                                 if (atomic_read(&tcapa->c_refc) > 0)
 261                                         continue;
 262                                 DEBUG_CAPA(D_CACHE, &ocapa->c_capa,
 263                                            "free unused");
 264                                 __capa_put(tcapa);
 265                                 destroy_capa(tcapa);
 266                                 count++;
 267                         }
 268                 }
 269
 270                 spin_unlock(&capa_lock);
 271                 return ocapa;
 272         }
 273         spin_unlock(&capa_lock);
 274
 275         destroy_capa(ocapa);
 276         return old;
 277 }
 278
 279 struct obd_capa *
 280 capa_get(uid_t uid, int capa_op,__u64 mdsid, unsigned long ino, int type)
 281 {
 282         struct hlist_head *head = capa_hash +
 283                                   capa_hashfn(uid, capa_op, mdsid, ino);
 284         struct obd_capa *ocapa;
 285
 286         ocapa = find_capa_locked(head, uid, capa_op, mdsid, ino, type);
 287
 288         return ocapa;
 289 }
 290
 291 void capa_put(struct obd_capa *ocapa)
 292 {
 293         if (!ocapa)
 294                 return;
 295
 296         DEBUG_CAPA(D_CACHE, &ocapa->c_capa, "put");
 297         spin_lock(&capa_lock);
 298         if (ocapa->c_type == CLIENT_CAPA) {
 299                 list_del_init(&ocapa->c_lli_list);
 300                 __capa_put(ocapa);
 301                 destroy_capa(ocapa);
 302         } else {
 303                 atomic_dec(&ocapa->c_refc);
 304         }
 305         spin_unlock(&capa_lock);
 306 }
 307
 308 static struct obd_capa *update_capa_locked(struct lustre_capa *capa, int type)
 309 {
 310         uid_t uid = capa->lc_uid;
 311         int capa_op = capa->lc_op;
 312         __u64 mdsid = capa->lc_mdsid;
 313         unsigned long ino = capa->lc_ino;
 314         struct hlist_head *head = capa_hash +
 315                                   capa_hashfn(uid, capa_op, mdsid, ino);
 316         struct obd_capa *ocapa;
 317
 318         spin_lock(&capa_lock);
 319         ocapa = find_capa(head, uid, capa_op, mdsid, ino, type);
 320         if (ocapa)
 321                 do_update_capa(ocapa, capa);
 322         spin_unlock(&capa_lock);
 323
 324         if (!ocapa)
 325                 ocapa = get_new_capa_locked(head, type, capa);
 326
 327         return ocapa;
 328 }
 329
 330 struct obd_capa *capa_renew(struct lustre_capa *capa, int type)
 331 {
 332         DEBUG_CAPA(D_INFO, capa, "renew");
 333
 334         return update_capa_locked(capa, type);
 335 }
 336
 337 void capa_hmac(struct crypto_tfm *tfm, __u8 *key, struct lustre_capa *capa)
 338 {
 339         int keylen = CAPA_KEY_LEN;
 340         struct scatterlist sl = {
 341                 .page   = virt_to_page(capa),
 342                 .offset = (unsigned long)(capa) % PAGE_SIZE,
 343                 .length = sizeof(struct lustre_capa_data),
 344         };
 345
 346         LASSERT(tfm);
 347         crypto_hmac(tfm, key, &keylen, &sl, 1, capa->lc_hmac);
 348 }
 349
 350 void capa_dup(void *dst, struct obd_capa *ocapa)
 351 {
 352         spin_lock(&capa_lock);
 353         memcpy(dst, &ocapa->c_capa, sizeof(ocapa->c_capa));
 354         spin_unlock(&capa_lock);
 355 }
 356
 357 void capa_dup2(void *dst, struct lustre_capa *capa)
 358 {
 359         spin_lock(&capa_lock);
 360         memcpy(dst, capa, sizeof(*capa));
 361         spin_unlock(&capa_lock);
 362 }
 363
 364 int capa_expired(struct lustre_capa *capa)
 365 {
 366         struct timeval tv;
 367
 368         do_gettimeofday(&tv);
 369         return (capa->lc_expiry < tv.tv_sec) ? 1 : 0;
 370 }
 371
 372 int __capa_is_to_expire(struct obd_capa *ocapa)
 373 {
 374         struct timeval tv;
 375         int pre_expiry = capa_pre_expiry(&ocapa->c_capa);
 376
 377         do_gettimeofday(&tv);
 378         return (ocapa->c_capa.lc_expiry - pre_expiry - 1 <= tv.tv_sec)? 1 : 0;
 379 }
 380
 381 int capa_is_to_expire(struct obd_capa *ocapa)
 382 {
 383         int rc;
 384
 385         spin_lock(&capa_lock);
 386         rc = __capa_is_to_expire(ocapa);
 387         spin_unlock(&capa_lock);
 388
 389         return rc;
 390 }
 391
 392 EXPORT_SYMBOL(capa_op);
 393 EXPORT_SYMBOL(capa_get);
 394 EXPORT_SYMBOL(capa_put);
 395 EXPORT_SYMBOL(capa_renew);
 396 EXPORT_SYMBOL(__capa_get);
 397 EXPORT_SYMBOL(capa_hmac);
 398 EXPORT_SYMBOL(capa_dup);
 399 EXPORT_SYMBOL(capa_dup2);
 400 EXPORT_SYMBOL(capa_expired);
 401 EXPORT_SYMBOL(__capa_is_to_expire);
 402 EXPORT_SYMBOL(capa_is_to_expire);