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 static char *capa_type_name[] = { "client", "mds", "filter" };
  59
  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-
  62  * mount point */
  63 struct timer_list ll_capa_timer;
  64
  65 EXPORT_SYMBOL(capa_lock);
  66 EXPORT_SYMBOL(capa_hash);
  67 EXPORT_SYMBOL(capa_list);
  68 EXPORT_SYMBOL(ll_capa_timer);
  69
  70 static inline int const
  71 capa_hashfn(unsigned int uid, __u64 mdsid, unsigned long ino)
  72 {
  73         return (ino ^ uid) * (unsigned long)(mdsid + 1) % NR_CAPAHASH;
  74 }
  75
  76 int capa_op(int flags)
  77 {
  78         if (flags & (FMODE_WRITE|MDS_OPEN_TRUNC))
  79                 return CAPA_WRITE;
  80         else if (flags & FMODE_READ)
  81                 return CAPA_READ;
  82
  83         LBUG(); /* should be either MAY_READ or MAY_WRITE */
  84         return 0;
  85 }
  86
  87 static struct obd_capa *
  88 find_capa(struct hlist_head *head, uid_t uid, int capa_op, __u64 mdsid,
  89           unsigned long ino, int type)
  90 {
  91         struct hlist_node *pos;
  92         struct obd_capa *ocapa;
  93         uid_t ouid;
  94
  95         hlist_for_each_entry(ocapa, pos, head, c_hash) {
  96                 if (ocapa->c_capa.lc_ino != ino)
  97                         continue;
  98                 if (ocapa->c_capa.lc_mdsid != mdsid)
  99                         continue;
 100                 if ((ocapa->c_capa.lc_op & capa_op) != ocapa->c_capa.lc_op)
 101                         continue;
 102                 if (ocapa->c_type != type)
 103                         continue;
 104
 105                 if (ocapa->c_type == CLIENT_CAPA)
 106                         ouid = ocapa->c_capa.lc_ruid;
 107                 else
 108                         ouid = ocapa->c_capa.lc_uid;
 109
 110                 if (ouid != uid)
 111                         continue;
 112
 113                 DEBUG_CAPA(D_CACHE, &ocapa->c_capa, "found %s",
 114                            capa_type_name[ocapa->c_type]);
 115
 116                 return ocapa;
 117         }
 118
 119         return NULL;
 120 }
 121
 122 inline void __capa_get(struct obd_capa *ocapa)
 123 {
 124         if (ocapa->c_type != CLIENT_CAPA)
 125                 atomic_inc(&ocapa->c_refc);
 126 }
 127
 128 static struct obd_capa *
 129 find_capa_locked(struct hlist_head *head, uid_t uid, int capa_op, __u64 mdsid,
 130                  unsigned long ino, int type)
 131 {
 132         struct obd_capa *ocapa;
 133
 134         spin_lock(&capa_lock);
 135         ocapa = find_capa(head, uid, capa_op, mdsid, ino, type);
 136         if (ocapa)
 137                 __capa_get(ocapa);
 138         spin_unlock(&capa_lock);
 139
 140         return ocapa;
 141 }
 142
 143 static struct obd_capa *alloc_capa(void)
 144 {
 145         struct obd_capa *ocapa;
 146
 147         OBD_SLAB_ALLOC(ocapa, capa_cachep, SLAB_NOFS, sizeof(*ocapa));
 148         if (ocapa) {
 149                 INIT_HLIST_NODE(&ocapa->c_hash);
 150                 INIT_LIST_HEAD(&ocapa->c_list);
 151         }
 152
 153         return ocapa;
 154 }
 155
 156 static void __capa_put(struct obd_capa *ocapa)
 157 {
 158         hlist_del_init(&ocapa->c_hash);
 159         list_del_init(&ocapa->c_list);
 160         capa_count[ocapa->c_type]--;
 161 }
 162
 163 static void destroy_capa(struct obd_capa *ocapa)
 164 {
 165         OBD_SLAB_FREE(ocapa, capa_cachep, sizeof(*ocapa));
 166 }
 167
 168 int capa_cache_init(void)
 169 {
 170         int nr_hash, i;
 171
 172         OBD_ALLOC(capa_hash, PAGE_SIZE);
 173         if (!capa_hash)
 174                 return -ENOMEM;
 175
 176         nr_hash = PAGE_SIZE / sizeof(struct hlist_head);
 177         LASSERT(nr_hash > NR_CAPAHASH);
 178
 179         for (i = 0; i < NR_CAPAHASH; i++)
 180                 INIT_HLIST_HEAD(capa_hash + i);
 181
 182         for (i = 0; i < 3; i++)
 183                 INIT_LIST_HEAD(&capa_list[i]);
 184
 185         return 0;
 186 }
 187
 188 void capa_cache_cleanup(void)
 189 {
 190         struct obd_capa *ocapa, *tmp;
 191         int i;
 192
 193         for (i = MDS_CAPA; i <= FILTER_CAPA; i++) {
 194                 list_for_each_entry_safe(ocapa, tmp, &capa_list[i], c_list) {
 195                         __capa_put(ocapa);
 196                         destroy_capa(ocapa);
 197                 }
 198         }
 199
 200         OBD_FREE(capa_hash, PAGE_SIZE);
 201 }
 202
 203
 204 static inline void list_add_capa(struct obd_capa *ocapa, struct list_head *head)
 205 {
 206         struct obd_capa *tmp;
 207
 208         /* XXX: capa is sorted in client, this could be optimized */
 209         if (ocapa->c_type == CLIENT_CAPA) {
 210                 list_for_each_entry_reverse(tmp, head, c_list) {
 211                         if (ocapa->c_capa.lc_expiry > tmp->c_capa.lc_expiry) {
 212                                 list_add(&ocapa->c_list, &tmp->c_list);
 213                                 return;
 214                         }
 215                 }
 216         }
 217
 218         list_add(&ocapa->c_list, head);
 219 }
 220
 221 static inline void do_update_capa(struct obd_capa *ocapa, struct lustre_capa *capa)
 222 {
 223         memcpy(&ocapa->c_capa, capa, sizeof(*capa));
 224 }
 225
 226 static struct obd_capa *
 227 get_new_capa_locked(struct hlist_head *head, int type, struct lustre_capa *capa)
 228 {
 229         uid_t uid = capa->lc_uid;
 230         int capa_op = capa->lc_op;
 231         __u64 mdsid = capa->lc_mdsid;
 232         unsigned long ino = capa->lc_ino;
 233         struct obd_capa *ocapa, *old;
 234
 235         ocapa = alloc_capa();
 236         if (!ocapa)
 237                 return NULL;
 238
 239         spin_lock(&capa_lock);
 240         old = find_capa(head, uid, capa_op, mdsid, ino, type);
 241         if (!old) {
 242                 do_update_capa(ocapa, capa);
 243                 ocapa->c_type = type;
 244                 list_add_capa(ocapa, &capa_list[type]);
 245                 hlist_add_head(&ocapa->c_hash, head);
 246                 if (type == CLIENT_CAPA)
 247                         INIT_LIST_HEAD(&ocapa->c_lli_list);
 248
 249                 capa_count[type]++;
 250
 251                 DEBUG_CAPA(D_CACHE, &ocapa->c_capa, "new %s",
 252                            capa_type_name[type]);
 253
 254                 if (type != CLIENT_CAPA && capa_count[type] > CAPA_CACHE_SIZE) {
 255                         struct list_head *node = capa_list[type].next;
 256                         struct obd_capa *tcapa;
 257                         int count = 0;
 258
 259                         /* free 12 unused capa from head */
 260                         while (node->next != &capa_list[type] && count < 12) {
 261                                 tcapa = list_entry(node, struct obd_capa,
 262                                                    c_list);
 263                                 node = node->next;
 264                                 if (atomic_read(&tcapa->c_refc) > 0)
 265                                         continue;
 266                                 DEBUG_CAPA(D_CACHE, &tcapa->c_capa,
 267                                            "free unused %s",
 268                                            capa_type_name[type]);
 269                                 __capa_put(tcapa);
 270                                 destroy_capa(tcapa);
 271                                 count++;
 272                         }
 273                 }
 274
 275                 spin_unlock(&capa_lock);
 276                 return ocapa;
 277         }
 278         spin_unlock(&capa_lock);
 279
 280         destroy_capa(ocapa);
 281         return old;
 282 }
 283
 284 struct obd_capa *
 285 capa_get(uid_t uid, int capa_op,__u64 mdsid, unsigned long ino, int type)
 286 {
 287         struct hlist_head *head = capa_hash + capa_hashfn(uid, mdsid, ino);
 288         struct obd_capa *ocapa;
 289
 290         ocapa = find_capa_locked(head, uid, capa_op, mdsid, ino, type);
 291
 292         return ocapa;
 293 }
 294
 295 void capa_put(struct obd_capa *ocapa)
 296 {
 297         if (!ocapa)
 298                 return;
 299
 300         DEBUG_CAPA(D_CACHE, &ocapa->c_capa, "put %s",
 301                    capa_type_name[ocapa->c_type]);
 302         spin_lock(&capa_lock);
 303         if (ocapa->c_type == CLIENT_CAPA) {
 304                 list_del_init(&ocapa->c_lli_list);
 305                 __capa_put(ocapa);
 306                 destroy_capa(ocapa);
 307         } else {
 308                 atomic_dec(&ocapa->c_refc);
 309         }
 310         spin_unlock(&capa_lock);
 311 }
 312
 313 struct obd_capa *capa_renew(struct lustre_capa *capa, int type)
 314 {
 315         uid_t uid = capa->lc_uid;
 316         int capa_op = capa->lc_op;
 317         __u64 mdsid = capa->lc_mdsid;
 318         unsigned long ino = capa->lc_ino;
 319         struct hlist_head *head = capa_hash +
 320                                   capa_hashfn(uid, mdsid, ino);
 321         struct obd_capa *ocapa;
 322
 323         spin_lock(&capa_lock);
 324         ocapa = find_capa(head, uid, capa_op, mdsid, ino, type);
 325         if (ocapa) {
 326                 DEBUG_CAPA(D_INFO, capa, "renew %s", capa_type_name[type]);
 327                 do_update_capa(ocapa, capa);
 328         }
 329         spin_unlock(&capa_lock);
 330
 331         if (!ocapa)
 332                 ocapa = get_new_capa_locked(head, type, capa);
 333
 334         return ocapa;
 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 ((unsigned long )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         /* XXX: in case the lock is inaccurate, minus one more
 379          * pre_expiry to make sure the expiry won't miss */
 380         return ((unsigned long)ocapa->c_capa.lc_expiry -
 381                 2 * pre_expiry <= tv.tv_sec)? 1 : 0;
 382 }
 383
 384 int capa_is_to_expire(struct obd_capa *ocapa)
 385 {
 386         int rc;
 387
 388         spin_lock(&capa_lock);
 389         rc = __capa_is_to_expire(ocapa);
 390         spin_unlock(&capa_lock);
 391
 392         return rc;
 393 }
 394
 395 EXPORT_SYMBOL(capa_op);
 396 EXPORT_SYMBOL(capa_get);
 397 EXPORT_SYMBOL(capa_put);
 398 EXPORT_SYMBOL(capa_renew);
 399 EXPORT_SYMBOL(__capa_get);
 400 EXPORT_SYMBOL(capa_hmac);
 401 EXPORT_SYMBOL(capa_dup);
 402 EXPORT_SYMBOL(capa_dup2);
 403 EXPORT_SYMBOL(capa_expired);
 404 EXPORT_SYMBOL(__capa_is_to_expire);
 405 EXPORT_SYMBOL(capa_is_to_expire);