lustre/mds/mds_capa.c

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * Copyright (C) 2004, 2005 Cluster File Systems, Inc.
   5  *
   6  * Author: Lai Siyao <lsy@clusterfs.com>
   7  *
   8  *   This file is part of Lustre, http://www.lustre.org.
   9  *
  10  *   Lustre is free software; you can redistribute it and/or
  11  *   modify it under the terms of version 2 of the GNU General Public
  12  *   License as published by the Free Software Foundation.
  13  *
  14  *   Lustre is distributed in the hope that it will be useful,
  15  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  *   GNU General Public License for more details.
  18  *
  19  *   You should have received a copy of the GNU General Public License
  20  *   along with Lustre; if not, write to the Free Software
  21  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  22  */
  23
  24 #define DEBUG_SUBSYSTEM S_MDS
  25
  26 #include <linux/fs.h>
  27 #include <linux/version.h>
  28 #include <asm/uaccess.h>
  29 #include <linux/file.h>
  30 #include <linux/kmod.h>
  31 #include <linux/random.h>
  32
  33 #include <linux/obd.h>
  34 #include <linux/lustre_mds.h>
  35 #include <linux/lustre_fsfilt.h>
  36 #include <linux/lustre_sec.h>
  37
  38 #include "mds_internal.h"
  39
  40 static struct ptlrpc_thread mds_eck_thread;
  41
  42 static struct thread_ctl {
  43         struct completion ctl_starting;
  44         struct completion ctl_finishing;
  45 } mds_eck_ctl;
  46
  47 static LIST_HEAD(mds_capa_key_list);
  48 static spinlock_t mds_capa_lock; /* protect capa and capa key */
  49 struct timer_list mds_eck_timer;
  50
  51 #define CAPA_KEY_JIFFIES(key) \
  52         expiry_to_jiffies(le64_to_cpu((key)->k_key->lk_expiry))
  53
  54 #define CUR_MDS_CAPA_KEY(mds) (mds)->mds_capa_keys[(mds)->mds_capa_key_idx]
  55 #define CUR_CAPA_KEY(mds) CUR_MDS_CAPA_KEY(mds).k_key
  56 #define CUR_CAPA_KEY_ID(mds) CUR_MDS_CAPA_KEY(mds).k_key->lk_keyid
  57 #define CUR_CAPA_KEY_LIST(mds) CUR_MDS_CAPA_KEY(mds).k_list
  58 #define CUR_CAPA_KEY_EXPIRY(mds) le64_to_cpu(CUR_CAPA_KEY(mds)->lk_expiry)
  59 #define CUR_CAPA_KEY_JIFFIES(mds) CAPA_KEY_JIFFIES(&CUR_MDS_CAPA_KEY(mds))
  60
  61 static int mds_write_capa_key(struct obd_device *obd, int force_sync)
  62 {
  63         struct mds_obd *mds = &obd->u.mds;
  64         struct mds_capa_key *keys = mds->mds_capa_keys;
  65         struct file *filp = mds->mds_capa_keys_filp;
  66         struct lvfs_run_ctxt saved;
  67         loff_t off = 0;
  68         int i, rc = 0;
  69         ENTRY;
  70
  71         push_ctxt(&saved, &obd->obd_lvfs_ctxt, NULL);
  72         for (i = 0; i < 2 && keys[i].k_key; i++) {
  73                 rc = fsfilt_write_record(obd, filp, keys[i].k_key,
  74                                          sizeof(*keys[i].k_key),
  75                                          &off, force_sync);
  76                 if (rc) {
  77                         CERROR("error writing MDS capa key: rc = %d\n", rc);
  78                         break;
  79                 }
  80         }
  81         pop_ctxt(&saved, &obd->obd_lvfs_ctxt, NULL);
  82
  83         RETURN(rc);
  84 }
  85
  86 static inline int
  87 mds_capa_key_cmp(struct mds_obd *mds)
  88 {
  89         return le32_to_cpu(mds->mds_capa_keys[0].k_key->lk_keyid) -
  90                le32_to_cpu(mds->mds_capa_keys[1].k_key->lk_keyid);
  91 }
  92
  93 static void
  94 do_update_capa_key(struct mds_obd *mds, struct lustre_capa_key *key)
  95 {
  96         __u32 keyid = 1;
  97         __u64 expiry_rounded;
  98
  99         if (CUR_CAPA_KEY(mds))
 100                 keyid = le32_to_cpu(CUR_CAPA_KEY_ID(mds)) + 1;
 101         spin_lock(&mds_capa_lock);
 102         expiry_rounded = round_expiry(mds->mds_capa_key_timeout);
 103         spin_unlock(&mds_capa_lock);
 104
 105         key->lk_mdsid = cpu_to_le32(mds->mds_num);
 106         key->lk_keyid = cpu_to_le32(keyid);
 107         key->lk_expiry = cpu_to_le64(expiry_rounded);
 108         get_random_bytes(key->lk_key, sizeof(key->lk_key));
 109 }
 110
 111 static void list_add_capa_key(struct mds_capa_key *key, struct list_head *head)
 112 {
 113         struct mds_capa_key *tmp;
 114
 115         list_for_each_entry_reverse(tmp, head, k_list) {
 116                 if (le64_to_cpu(key->k_key->lk_expiry) <
 117                     le64_to_cpu(tmp->k_key->lk_expiry)) {
 118                         /* put key before tmp */
 119                         list_add_tail(&key->k_list, &tmp->k_list);
 120                         return;
 121                 }
 122         }
 123
 124         list_add_tail(&key->k_list, head);
 125 }
 126
 127 int mds_read_capa_key(struct obd_device *obd, struct file *file)
 128 {
 129         loff_t off = 0;
 130         struct mds_obd *mds = &obd->u.mds;
 131         struct lustre_capa_key *key;
 132         unsigned long capa_keys_size = file->f_dentry->d_inode->i_size;
 133         unsigned long expiry;
 134         int i = 0, rc = 0;
 135         ENTRY;
 136
 137         if (capa_keys_size == 0) {
 138                 CWARN("%s: initializing new %s\n", obd->obd_name,
 139                       file->f_dentry->d_name.name);
 140
 141                 OBD_ALLOC(key, sizeof(*key));
 142                 if (!key)
 143                         RETURN(-ENOMEM);
 144
 145                 do_update_capa_key(mds, key);
 146
 147                 mds->mds_capa_keys[0].k_key = key;
 148                 mds->mds_capa_keys[0].k_obd = obd;
 149                 INIT_LIST_HEAD(&mds->mds_capa_keys[0].k_list);
 150                 mds->mds_capa_key_idx = 0;
 151
 152                 rc = mds_write_capa_key(obd, 1);
 153                 if (rc)
 154                         GOTO(out, rc);
 155         } else {
 156                 LASSERT(capa_keys_size == sizeof(*key) ||
 157                         capa_keys_size == 2 * sizeof(*key));
 158
 159                 while (capa_keys_size > i * sizeof(*key)) {
 160                         OBD_ALLOC(key, sizeof(*key));
 161                         if (!key)
 162                                 RETURN(-ENOMEM);
 163
 164                         rc = fsfilt_read_record(obd, file, key, sizeof(*key),
 165                                                 &off);
 166                         if (rc) {
 167                                 CERROR("error reading MDS %s capa key: %d\n",
 168                                        file->f_dentry->d_name.name, rc);
 169                                 OBD_FREE(key, sizeof(*key));
 170                                 GOTO(out, rc);
 171                         }
 172
 173                         mds->mds_capa_keys[i].k_key = key;
 174                         mds->mds_capa_keys[i].k_obd = obd;
 175                         INIT_LIST_HEAD(&mds->mds_capa_keys[i].k_list);
 176                         i++;
 177                 }
 178
 179                 mds->mds_capa_key_idx = 0;
 180                 if (mds->mds_capa_keys[1].k_key && mds_capa_key_cmp(mds) < 0)
 181                         mds->mds_capa_key_idx = 1;
 182         }
 183
 184         expiry = CUR_CAPA_KEY_JIFFIES(mds);
 185         spin_lock(&mds_capa_lock);
 186         if (time_before(expiry, mds_eck_timer.expires) ||
 187             !timer_pending(&mds_eck_timer)) {
 188                 mod_timer(&mds_eck_timer, expiry);
 189                 CDEBUG(D_INFO, "mds_eck_timer %lu", expiry);
 190         }
 191         list_add_capa_key(&CUR_MDS_CAPA_KEY(mds), &mds_capa_key_list);
 192         spin_unlock(&mds_capa_lock);
 193 out:
 194         RETURN(rc);
 195 }
 196
 197 void mds_capa_keys_cleanup(struct obd_device *obd)
 198 {
 199         struct mds_obd *mds = &obd->u.mds;
 200         int i;
 201
 202         del_timer(&mds_eck_timer);
 203         spin_lock(&mds_capa_lock);
 204         if (CUR_CAPA_KEY(mds))
 205                 list_del_init(&CUR_CAPA_KEY_LIST(mds));
 206         spin_unlock(&mds_capa_lock);
 207
 208         for (i = 0; i < 2; i++)
 209                 if (mds->mds_capa_keys[i].k_key)
 210                         OBD_FREE(mds->mds_capa_keys[i].k_key,
 211                                  sizeof(struct lustre_capa_key));
 212 }
 213
 214 static int mds_set_capa_key(struct obd_device *obd, struct lustre_capa_key *key)
 215 {
 216         struct mds_obd *mds = &obd->u.mds;
 217         int rc;
 218         ENTRY;
 219
 220         rc = obd_set_info(mds->mds_dt_exp, strlen("capa_key"), "capa_key",
 221                           sizeof(*key), key);
 222         RETURN(rc);
 223 }
 224
 225 static int
 226 mds_update_capa_key(struct obd_device *obd, struct mds_capa_key *mkey,
 227                     int force_sync)
 228 {
 229         struct mds_obd *mds = &obd->u.mds;
 230         int to_update = !mds->mds_capa_key_idx;
 231         struct lustre_capa_key *key = mds->mds_capa_keys[to_update].k_key;
 232         __u32 keyid;
 233         unsigned long expiry;
 234         int rc, rc2;
 235         ENTRY;
 236
 237         LASSERT(mkey != &mds->mds_capa_keys[to_update]);
 238
 239         if (key == NULL) {
 240                 /* first update */
 241                 OBD_ALLOC(key, sizeof(*key));
 242                 if (!key)
 243                         RETURN(-ENOMEM);
 244                 mds->mds_capa_keys[to_update].k_key = key;
 245                 mds->mds_capa_keys[to_update].k_obd = obd;
 246         }
 247
 248         do_update_capa_key(mds, key);
 249
 250         keyid = le32_to_cpu(key->lk_keyid);
 251
 252         rc = mds_set_capa_key(obd, key);
 253         if (rc)
 254                 /* XXX: anyway, it will be replayed */
 255                 CERROR("error set capa key(id %u), err = %d\n", keyid, rc);
 256
 257         rc2 = mds_write_capa_key(obd, 1);
 258         if (rc2)
 259                 GOTO(out, rc2);
 260
 261         spin_lock(&mds_capa_lock);
 262         list_del_init(&CUR_CAPA_KEY_LIST(mds));
 263         mds->mds_capa_key_idx = to_update;
 264         expiry = CUR_CAPA_KEY_JIFFIES(mds);
 265         list_add_capa_key(&CUR_MDS_CAPA_KEY(mds), &mds_capa_key_list);
 266
 267         if (time_before(expiry, mds_eck_timer.expires) ||
 268             !timer_pending(&mds_eck_timer)) {
 269                 mod_timer(&mds_eck_timer, expiry);
 270                 CDEBUG(D_INFO, "mds_eck_timer %lu\n", expiry);
 271         }
 272         spin_unlock(&mds_capa_lock);
 273
 274         DEBUG_MDS_CAPA_KEY(D_INFO, &CUR_MDS_CAPA_KEY(mds),
 275                            "mds_update_capa_key");
 276 out:
 277         RETURN(rc2);
 278 }
 279
 280 static inline int have_expired_capa_key(void)
 281 {
 282         struct mds_capa_key *key;
 283         unsigned long expiry;
 284         int expired = 0;
 285         ENTRY;
 286
 287         spin_lock(&mds_capa_lock);
 288         if (!list_empty(&mds_capa_key_list)) {
 289                 key = list_entry(mds_capa_key_list.next, struct mds_capa_key,
 290                                  k_list);
 291                 /* expiry is in sec, so in case it misses, the result will
 292                  * minus 5 sec and then compare with jiffies. (in case the
 293                  * clock is innacurate) */
 294                 expiry = CAPA_KEY_JIFFIES(key);
 295                 expired = time_before(expiry - 5 * HZ, jiffies);
 296                 if (!expired) {
 297                         if (time_before(expiry, mds_eck_timer.expires) ||
 298                             !timer_pending(&mds_eck_timer)) {
 299                                 mod_timer(&mds_eck_timer, expiry);
 300                                 CDEBUG(D_INFO, "mds_eck_timer %lu", expiry);
 301                         }
 302                 }
 303         }
 304         spin_unlock(&mds_capa_lock);
 305
 306         RETURN(expired);
 307 }
 308
 309 static int inline mds_capa_key_check_stop(void)
 310 {
 311         return (mds_eck_thread.t_flags & SVC_STOPPING) ? 1: 0;
 312 }
 313
 314 static int mds_capa_key_thread_main(void *arg)
 315 {
 316         struct thread_ctl *ctl = arg;
 317         unsigned long flags;
 318         int rc;
 319         ENTRY;
 320
 321         lock_kernel();
 322         ptlrpc_daemonize();
 323
 324         SIGNAL_MASK_LOCK(current, flags);
 325         sigfillset(&current->blocked);
 326         RECALC_SIGPENDING;
 327         SIGNAL_MASK_UNLOCK(current, flags);
 328         THREAD_NAME(current->comm, sizeof(current->comm), "mds_ck");
 329         unlock_kernel();
 330
 331         /*
 332          * letting starting function know, that we are ready and control may be
 333          * returned.
 334          */
 335         mds_eck_thread.t_flags = SVC_RUNNING;
 336         complete(&ctl->ctl_starting);
 337
 338         while (!mds_capa_key_check_stop()) {
 339                 struct l_wait_info lwi = { 0 };
 340                 unsigned long expiry;
 341                 struct mds_capa_key *key, *tmp, *next = NULL;
 342
 343                 l_wait_event(mds_eck_thread.t_ctl_waitq,
 344                              (have_expired_capa_key() ||
 345                               mds_capa_key_check_stop()),
 346                              &lwi);
 347
 348                 spin_lock(&mds_capa_lock);
 349                 list_for_each_entry_safe(key, tmp, &mds_capa_key_list, k_list) {
 350                         if (time_after(CAPA_KEY_JIFFIES(key), jiffies)) {
 351                                 next = key;
 352                                 break;
 353                         }
 354
 355                         spin_unlock(&mds_capa_lock);
 356
 357                         CDEBUG(D_INFO, "mds capa key expired: "
 358                                "mds #%u, key #%u\n",
 359                                le32_to_cpu(key->k_key->lk_mdsid),
 360                                le32_to_cpu(key->k_key->lk_keyid));
 361
 362                         rc = mds_update_capa_key(key->k_obd, key, 1);
 363                         spin_lock(&mds_capa_lock);
 364                 }
 365
 366                 if (next) {
 367                         expiry = CAPA_KEY_JIFFIES(next);
 368                         mod_timer(&mds_eck_timer, expiry);
 369                         CDEBUG(D_INFO, "mds_eck_timer %lu", expiry);
 370                 }
 371                 spin_unlock(&mds_capa_lock);
 372         }
 373
 374         mds_eck_thread.t_flags = SVC_STOPPED;
 375
 376         /* this is SMP-safe way to finish thread. */
 377         complete_and_exit(&ctl->ctl_finishing, 0);
 378         EXIT;
 379 }
 380
 381 void mds_capa_key_timer_callback(unsigned long unused)
 382 {
 383         ENTRY;
 384         wake_up(&mds_eck_thread.t_ctl_waitq);
 385         EXIT;
 386 }
 387
 388 int mds_capa_key_start_thread(void)
 389 {
 390         int rc;
 391         ENTRY;
 392
 393         LASSERT(mds_eck_thread.t_flags == 0);
 394         init_completion(&mds_eck_ctl.ctl_starting);
 395         init_completion(&mds_eck_ctl.ctl_finishing);
 396         init_waitqueue_head(&mds_eck_thread.t_ctl_waitq);
 397         spin_lock_init(&mds_capa_lock);
 398
 399         rc = kernel_thread(mds_capa_key_thread_main, &mds_eck_ctl,
 400                            (CLONE_VM | CLONE_FILES));
 401         if (rc < 0) {
 402                 CERROR("cannot start capa key thread, "
 403                        "err = %d\n", rc);
 404                 RETURN(rc);
 405         }
 406
 407         wait_for_completion(&mds_eck_ctl.ctl_starting);
 408         LASSERT(mds_eck_thread.t_flags == SVC_RUNNING);
 409         RETURN(0);
 410 }
 411
 412 void mds_capa_key_stop_thread(void)
 413 {
 414         ENTRY;
 415         mds_eck_thread.t_flags = SVC_STOPPING;
 416         wake_up(&mds_eck_thread.t_ctl_waitq);
 417         wait_for_completion(&mds_eck_ctl.ctl_finishing);
 418         LASSERT(mds_eck_thread.t_flags == SVC_STOPPED);
 419         mds_eck_thread.t_flags = 0;
 420         EXIT;
 421 }
 422
 423 void mds_update_capa_stat(struct obd_device *obd, int stat)
 424 {
 425         struct mds_obd *mds = &obd->u.mds;
 426
 427         spin_lock(&mds_capa_lock);
 428         mds->mds_capa_stat = stat;
 429         spin_unlock(&mds_capa_lock);
 430 }
 431
 432 void mds_update_capa_timeout(struct obd_device *obd, unsigned long timeout)
 433 {
 434         struct mds_obd *mds = &obd->u.mds;
 435
 436         spin_lock(&mds_capa_lock);
 437         mds->mds_capa_timeout = timeout;
 438         /* XXX: update all capabilities in cache if their expiry too long */
 439         spin_unlock(&mds_capa_lock);
 440 }
 441
 442 int mds_update_capa_key_timeout(struct obd_device *obd, unsigned long timeout)
 443 {
 444         struct mds_obd *mds = &obd->u.mds;
 445         struct timeval tv;
 446         int rc;
 447         ENTRY;
 448
 449         do_gettimeofday(&tv);
 450
 451         spin_lock(&mds_capa_lock);
 452         mds->mds_capa_key_timeout = timeout;
 453         if (CUR_CAPA_KEY_EXPIRY(mds) < tv.tv_sec + timeout) {
 454                 spin_unlock(&mds_capa_lock);
 455                 RETURN(0);
 456         }
 457         spin_unlock(&mds_capa_lock);
 458
 459         rc = mds_update_capa_key(obd, &CUR_MDS_CAPA_KEY(mds), 1);
 460
 461         RETURN(rc);
 462 }
 463
 464 static void mds_capa_reverse_map(struct mds_export_data *med,
 465                                  struct lustre_capa *capa)
 466 {
 467         uid_t uid;
 468
 469         if (!med->med_remote) {
 470                 /* when not remote uid, ruid == uid */
 471                 capa->lc_ruid = capa->lc_uid;
 472                 return;
 473         }
 474
 475         ENTRY;
 476         uid = mds_idmap_lookup_uid(med->med_idmap, 1, capa->lc_uid);
 477         if (uid == MDS_IDMAP_NOTFOUND)
 478                 uid = med->med_nllu;
 479         capa->lc_ruid = uid;
 480         capa->lc_flags |= CAPA_FL_REMUID;
 481         EXIT;
 482 }
 483
 484
 485 int mds_pack_capa(struct obd_device *obd, struct mds_export_data *med,
 486                   struct mds_body *req_body, struct lustre_capa *req_capa,
 487                   struct ptlrpc_request *req, int *offset, struct mds_body *body)
 488 {
 489         struct mds_obd *mds = &obd->u.mds;
 490         struct lustre_capa *capa;
 491         struct lustre_msg *repmsg = req->rq_repmsg;
 492         struct obd_capa *ocapa;
 493         __u8 key[CAPA_KEY_LEN];  /* key */
 494         int stat, expired, rc = 0;
 495         ENTRY;
 496
 497         spin_lock(&mds_capa_lock);
 498         stat = mds->mds_capa_stat;
 499         spin_unlock(&mds_capa_lock);
 500
 501         if (stat == 0) {
 502                 (*offset)++;
 503                 RETURN(0); /* capability is disabled */
 504         }
 505
 506         if (OBD_FAIL_CHECK(OBD_FAIL_MDS_PACK_CAPA))
 507                 RETURN(-EINVAL);
 508
 509         if (req_body) {
 510                 /* capa renewal, check capa op against open mode */
 511                 struct mds_file_data *mfd;
 512                 int mode;
 513
 514                 mfd = mds_handle2mfd(&req_body->handle);
 515                 if (mfd == NULL) {
 516                         DEBUG_CAPA(D_INFO, req_capa, "no handle "LPX64" for",
 517                                    req_body->handle.cookie);
 518                         RETURN(-ESTALE);
 519                 }
 520
 521                 mode = accmode(mfd->mfd_mode);
 522                 if (!(req_capa->lc_op & mode)) {
 523                         DEBUG_CAPA(D_ERROR, req_capa, "accmode %d mismatch",
 524                                    mode);
 525                         RETURN(-EACCES);
 526                 }
 527
 528                 mds_mfd_put(mfd);
 529         }
 530
 531         LASSERT(repmsg->buflens[*offset] == sizeof(*capa));
 532         capa = lustre_msg_buf(repmsg, (*offset)++, sizeof(*capa));
 533         LASSERT(capa != NULL);
 534
 535         ocapa = capa_get(req_capa->lc_uid, req_capa->lc_op, req_capa->lc_mdsid,
 536                          req_capa->lc_ino, MDS_CAPA);
 537         if (ocapa) {
 538                 expired = capa_is_to_expire(ocapa);
 539                 if (!expired) {
 540                         capa_dup(capa, ocapa);
 541                         capa_put(ocapa);
 542                         GOTO(out, rc);
 543                 }
 544                 capa_put(ocapa);
 545         }
 546
 547         memcpy(capa, req_capa, sizeof(*capa));
 548         mds_capa_reverse_map(med, capa);
 549
 550         spin_lock(&mds_capa_lock);
 551         capa->lc_keyid = le32_to_cpu(CUR_CAPA_KEY_ID(mds));
 552         capa->lc_expiry = round_expiry(mds->mds_capa_timeout);
 553         if (mds->mds_capa_timeout < CAPA_EXPIRY)
 554                 capa->lc_flags |= CAPA_FL_SHORT;
 555         memcpy(key, CUR_CAPA_KEY(mds)->lk_key, sizeof(key));
 556         spin_unlock(&mds_capa_lock);
 557
 558         capa_hmac(mds->mds_capa_hmac, key, capa);
 559
 560         ocapa = capa_renew(capa, MDS_CAPA);
 561         if (!ocapa)
 562                 rc = -ENOMEM;
 563 out:
 564         if (rc == 0)
 565                 body->valid |= OBD_MD_CAPA;
 566         RETURN(rc);
 567 }
 568