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 MAY_WRITE;
  79         else if (flags & FMODE_READ)
  80                 return MAY_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         ENTRY;
  93
  94         CDEBUG(D_CACHE, "find_capa uid %u op %u mdsid "LPU64" ino %lu "
  95                "type %d\n", uid, capa_op, mdsid, ino, type);
  96
  97         hlist_for_each_entry(ocapa, pos, head, c_hash) {
  98                 if (ocapa->c_capa.lc_uid != uid)
  99                         continue;
 100                 if (ocapa->c_capa.lc_op != capa_op)
 101                         continue;
 102                 if (ocapa->c_capa.lc_mdsid != mdsid)
 103                         continue;
 104                 if (ocapa->c_capa.lc_ino != ino)
 105                         continue;
 106                 if (ocapa->c_type != type)
 107                         continue;
 108                 RETURN(ocapa);
 109         }
 110
 111         RETURN(NULL);
 112 }
 113
 114 inline void __capa_get(struct obd_capa *ocapa)
 115 {
 116         atomic_inc(&ocapa->c_refc);
 117 }
 118
 119 static struct obd_capa *
 120 find_capa_locked(struct hlist_head *head, uid_t uid, int capa_op, __u64 mdsid,
 121                  unsigned long ino, int type)
 122 {
 123         struct obd_capa *ocapa;
 124         ENTRY;
 125
 126         spin_lock(&capa_lock);
 127         ocapa = find_capa(head, uid, capa_op, mdsid, ino, type);
 128         if (ocapa)
 129                 __capa_get(ocapa);
 130         spin_unlock(&capa_lock);
 131
 132         RETURN(ocapa);
 133 }
 134
 135 static struct obd_capa *alloc_capa(void)
 136 {
 137         struct obd_capa *ocapa;
 138         ENTRY;
 139
 140         OBD_SLAB_ALLOC(ocapa, capa_cachep, SLAB_NOFS, sizeof(*ocapa));
 141         if (ocapa) {
 142                 INIT_HLIST_NODE(&ocapa->c_hash);
 143                 INIT_LIST_HEAD(&ocapa->c_list);
 144         }
 145
 146         RETURN(ocapa);
 147 }
 148
 149 static void destroy_capa(struct obd_capa *ocapa)
 150 {
 151         OBD_SLAB_FREE(ocapa, capa_cachep, sizeof(*ocapa));
 152 }
 153
 154 int capa_cache_init(void)
 155 {
 156         int nr_hash, i;
 157
 158         OBD_ALLOC(capa_hash, PAGE_SIZE);
 159         if (!capa_hash)
 160                 return -ENOMEM;
 161
 162         nr_hash = PAGE_SIZE / sizeof(struct hlist_head);
 163         LASSERT(nr_hash > NR_CAPAHASH);
 164
 165         for (i = 0; i < NR_CAPAHASH; i++)
 166                 INIT_HLIST_HEAD(capa_hash + i);
 167
 168         for (i = 0; i < 3; i++)
 169                 INIT_LIST_HEAD(&capa_list[i]);
 170
 171         return 0;
 172 }
 173
 174 void capa_cache_cleanup(void)
 175 {
 176         struct obd_capa *ocapa;
 177         struct hlist_node *pos, *n;
 178
 179         hlist_for_each_entry_safe(ocapa, pos, n, capa_hash, c_hash) {
 180                 hlist_del(&ocapa->c_hash);
 181                 list_del(&ocapa->c_list);
 182                 OBD_FREE(ocapa, sizeof(*ocapa));
 183         }
 184
 185         OBD_FREE(capa_hash, PAGE_SIZE);
 186 }
 187
 188
 189 static inline void list_add_capa(struct obd_capa *ocapa, struct list_head *head)
 190 {
 191         struct obd_capa *tmp;
 192
 193         /* XXX: capa is sorted in client, this could be optimized */
 194         if (ocapa->c_type == CLIENT_CAPA) {
 195                 list_for_each_entry_reverse(tmp, head, c_list) {
 196                         if (ocapa->c_capa.lc_expiry > tmp->c_capa.lc_expiry) {
 197                                 list_add(&ocapa->c_list, &tmp->c_list);
 198                                 return;
 199                         }
 200                 }
 201         }
 202
 203         list_add_tail(&ocapa->c_list, head);
 204 }
 205
 206 #define DEBUG_CAPA(level, ocapa, fmt, args...)                                 \
 207 do {                                                                           \
 208 CDEBUG(level, fmt " capa@%p uid %u op %u ino "LPU64" mdsid %d keyid %d "       \
 209        "expiry "LPU64" flags %u type %d\n",                                    \
 210        ##args, ocapa, ocapa->c_capa.lc_uid, ocapa->c_capa.lc_op,               \
 211        ocapa->c_capa.lc_ino, ocapa->c_capa.lc_mdsid, ocapa->c_capa.lc_keyid,   \
 212        ocapa->c_capa.lc_expiry, ocapa->c_capa.lc_flags, ocapa->c_type);        \
 213 } while (0)
 214
 215 static struct obd_capa *
 216 get_new_capa_locked(struct hlist_head *head, uid_t uid, int capa_op,__u64 mdsid,
 217                     unsigned long ino, int type, struct lustre_capa *capa,
 218                     struct inode *inode, struct lustre_handle *handle)
 219 {
 220         struct obd_capa *ocapa, *old;
 221         ENTRY;
 222
 223         ocapa = alloc_capa();
 224         if (!ocapa)
 225                 RETURN(NULL);
 226
 227         spin_lock(&capa_lock);
 228         old = find_capa(head, uid, capa_op, mdsid, ino, type);
 229         if (!old) {
 230                 memcpy(&ocapa->c_capa, capa, sizeof(*capa));
 231                 ocapa->c_type = type;
 232                 if (type == CLIENT_CAPA) {
 233                         LASSERT(inode);
 234 #ifdef __KERNEL__
 235                         igrab(inode);
 236 #endif
 237                         ocapa->c_inode = inode;
 238                         memcpy(&ocapa->c_handle, handle, sizeof(*handle));
 239                 }
 240                 list_add_capa(ocapa, &capa_list[type]);
 241                 hlist_add_head(&ocapa->c_hash, capa_hash);
 242                 capa_count[type]++;
 243                 DEBUG_CAPA(D_CACHE, ocapa, "get_new_capa_locked");
 244                 __capa_get(ocapa);
 245                 if (type != CLIENT_CAPA && capa_count[type] > CAPA_CACHE_SIZE) {
 246                         struct list_head *node = capa_list[type].next;
 247                         struct obd_capa *tcapa;
 248                         int count = 0;
 249
 250                         /* free 12 unused capa from head */
 251                         while (node->next != &capa_list[type] && count < 12) {
 252                                 tcapa = list_entry(node, struct obd_capa, c_list);
 253                                 node = node->next;
 254                                 if (atomic_read(&tcapa->c_refc) > 0)
 255                                         continue;
 256                                 list_del(&tcapa->c_list);
 257                                 destroy_capa(tcapa);
 258                                 count++;
 259                         }
 260                 }
 261
 262                 spin_unlock(&capa_lock);
 263                 RETURN(ocapa);
 264         }
 265
 266         __capa_get(old);
 267         spin_unlock(&capa_lock);
 268         destroy_capa(ocapa);
 269         ocapa = old;
 270         RETURN(ocapa);
 271 }
 272
 273 static struct obd_capa *
 274 capa_get_locked(uid_t uid, int capa_op,__u64 mdsid, unsigned long ino,
 275                 int type, struct lustre_capa *capa, struct inode *inode,
 276                 struct lustre_handle *handle)
 277 {
 278         struct hlist_head *head = capa_hash +
 279                                   capa_hashfn(uid, capa_op, mdsid, ino);
 280         struct obd_capa *ocapa;
 281         ENTRY;
 282
 283         ocapa = find_capa_locked(head, uid, capa_op, mdsid, ino, type);
 284         if (ocapa)
 285                 RETURN(ocapa);
 286
 287         if (capa)
 288                 ocapa = get_new_capa_locked(head, uid, capa_op, mdsid, ino,
 289                                             type, capa, inode, handle);
 290         RETURN(ocapa);
 291 }
 292
 293 struct obd_capa *
 294 capa_get(uid_t uid, int capa_op, __u64 mdsid, unsigned long ino, int type,
 295          struct lustre_capa *capa, struct inode *inode,
 296          struct lustre_handle *handle)
 297 {
 298         return capa_get_locked(uid, capa_op, mdsid, ino, type, capa, inode,
 299                                handle);
 300 }
 301
 302 static void __capa_put(struct obd_capa *ocapa, int type)
 303 {
 304         hlist_del_init(&ocapa->c_hash);
 305         list_del_init(&ocapa->c_list);
 306         capa_count[type]--;
 307 }
 308
 309 void capa_put(struct obd_capa *ocapa, int type)
 310 {
 311         ENTRY;
 312
 313         if (ocapa) {
 314                 if (atomic_dec_and_lock(&ocapa->c_refc, &capa_lock)) {
 315                         if (type == CLIENT_CAPA) {
 316 #ifdef __KERNEL__
 317                                 iput(ocapa->c_inode);
 318 #endif
 319                                 __capa_put(ocapa, type);
 320                                 destroy_capa(ocapa);
 321                         }
 322                         spin_unlock(&capa_lock);
 323                 }
 324         }
 325
 326         EXIT;
 327 }
 328
 329 static inline void __update_capa(struct obd_capa *ocapa, struct lustre_capa *capa)
 330 {
 331         memcpy(&ocapa->c_capa, capa, sizeof(*capa));
 332 }
 333
 334 static int update_capa_locked(struct lustre_capa *capa, int type)
 335 {
 336         uid_t uid = capa->lc_uid;
 337         int capa_op = capa->lc_op;
 338         __u64 mdsid = capa->lc_mdsid;
 339         unsigned long ino = capa->lc_ino;
 340         struct hlist_head *head = capa_hash +
 341                                   capa_hashfn(uid, capa_op, mdsid, ino);
 342         struct obd_capa *ocapa;
 343         ENTRY;
 344
 345         spin_lock(&capa_lock);
 346         ocapa = find_capa(head, uid, capa_op, mdsid, ino, type);
 347         if (ocapa)
 348                 __update_capa(ocapa, capa);
 349         spin_unlock(&capa_lock);
 350
 351         if (ocapa == NULL && type == MDS_CAPA)
 352                 ocapa = get_new_capa_locked(head, uid, capa_op, mdsid, ino, type,
 353                                             capa, NULL, NULL);
 354
 355         RETURN(ocapa ? 0 : -ENOENT);
 356 }
 357
 358 int capa_renew(struct lustre_capa *capa, int type)
 359 {
 360         return update_capa_locked(capa, type);
 361 }
 362
 363 void capa_hmac(struct crypto_tfm *tfm, __u8 *key, struct lustre_capa *capa)
 364 {
 365         int keylen = CAPA_KEY_LEN;
 366         struct scatterlist sl = {
 367                 .page   = virt_to_page(capa),
 368                 .offset = (unsigned long)(capa) % PAGE_SIZE,
 369                 .length = sizeof(struct lustre_capa_data),
 370         };
 371         ENTRY;
 372
 373         LASSERT(tfm);
 374         crypto_hmac(tfm, key, &keylen, &sl, 1, capa->lc_hmac);
 375         EXIT;
 376 }
 377
 378 void capa_dup(void *dst, struct obd_capa *ocapa)
 379 {
 380         spin_lock(&capa_lock);
 381         memcpy(dst, &ocapa->c_capa, sizeof(ocapa->c_capa));
 382         spin_unlock(&capa_lock);
 383 }
 384
 385 void capa_dup2(void *dst, struct lustre_capa *capa)
 386 {
 387         spin_lock(&capa_lock);
 388         memcpy(dst, capa, sizeof(*capa));
 389         spin_unlock(&capa_lock);
 390 }
 391
 392 int capa_expired(struct lustre_capa *capa)
 393 {
 394         struct timeval tv;
 395
 396         do_gettimeofday(&tv);
 397         return (capa->lc_expiry < tv.tv_sec) ? 1 : 0;
 398 }
 399
 400 int __capa_is_to_expire(struct obd_capa *ocapa)
 401 {
 402         struct timeval tv;
 403         int pre_expiry = capa_pre_expiry(&ocapa->c_capa);
 404
 405         do_gettimeofday(&tv);
 406         return (ocapa->c_capa.lc_expiry - pre_expiry < tv.tv_sec)? 1 : 0;
 407 }
 408
 409 int capa_is_to_expire(struct obd_capa *ocapa)
 410 {
 411         int rc;
 412
 413         spin_lock(&capa_lock);
 414         rc = __capa_is_to_expire(ocapa);
 415         spin_unlock(&capa_lock);
 416
 417         return rc;
 418 }
 419
 420 EXPORT_SYMBOL(capa_op);
 421 EXPORT_SYMBOL(capa_get);
 422 EXPORT_SYMBOL(capa_put);
 423 EXPORT_SYMBOL(capa_renew);
 424 EXPORT_SYMBOL(__capa_get);
 425 EXPORT_SYMBOL(capa_hmac);
 426 EXPORT_SYMBOL(capa_dup);
 427 EXPORT_SYMBOL(capa_dup2);
 428 EXPORT_SYMBOL(capa_expired);
 429 EXPORT_SYMBOL(__capa_is_to_expire);
 430 EXPORT_SYMBOL(capa_is_to_expire);