lustre/ptlrpc/sec_gc.c

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2012, 2016, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  *
  31  * lustre/ptlrpc/sec_gc.c
  32  *
  33  * Author: Eric Mei <ericm@clusterfs.com>
  34  */
  35
  36 #define DEBUG_SUBSYSTEM S_SEC
  37
  38 #include <linux/workqueue.h>
  39 #include <libcfs/libcfs.h>
  40
  41 #include <obd_support.h>
  42 #include <obd_class.h>
  43 #include <lustre_net.h>
  44 #include <lustre_sec.h>
  45
  46 #include "ptlrpc_internal.h"
  47
  48 #define SEC_GC_INTERVAL (30 * 60)
  49
  50 static DEFINE_MUTEX(sec_gc_mutex);
  51 static DEFINE_SPINLOCK(sec_gc_list_lock);
  52 static DEFINE_SPINLOCK(sec_gc_ctx_list_lock);
  53 static LIST_HEAD(sec_gc_list);
  54 static LIST_HEAD(sec_gc_ctx_list);
  55
  56 static atomic_t sec_gc_wait_del = ATOMIC_INIT(0);
  57
  58 void sptlrpc_gc_add_sec(struct ptlrpc_sec *sec)
  59 {
  60         LASSERT(sec->ps_policy->sp_cops->gc_ctx);
  61         LASSERT(sec->ps_gc_interval > 0);
  62         LASSERT(list_empty(&sec->ps_gc_list));
  63
  64         sec->ps_gc_next = ktime_get_real_seconds() + sec->ps_gc_interval;
  65
  66         spin_lock(&sec_gc_list_lock);
  67         list_add_tail(&sec->ps_gc_list, &sec_gc_list);
  68         spin_unlock(&sec_gc_list_lock);
  69
  70         CDEBUG(D_SEC, "added sec %p(%s)\n", sec, sec->ps_policy->sp_name);
  71 }
  72
  73 void sptlrpc_gc_del_sec(struct ptlrpc_sec *sec)
  74 {
  75         if (list_empty(&sec->ps_gc_list))
  76                 return;
  77
  78         might_sleep();
  79
  80         /* signal before list_del to make iteration in gc thread safe */
  81         atomic_inc(&sec_gc_wait_del);
  82
  83         spin_lock(&sec_gc_list_lock);
  84         list_del_init(&sec->ps_gc_list);
  85         spin_unlock(&sec_gc_list_lock);
  86
  87         /* barrier */
  88         mutex_lock(&sec_gc_mutex);
  89         mutex_unlock(&sec_gc_mutex);
  90
  91         atomic_dec(&sec_gc_wait_del);
  92
  93         CDEBUG(D_SEC, "del sec %p(%s)\n", sec, sec->ps_policy->sp_name);
  94 }
  95
  96 static void sec_gc_main(struct work_struct *ws);
  97 static DECLARE_DELAYED_WORK(sec_gc_work, sec_gc_main);
  98
  99 void sptlrpc_gc_add_ctx(struct ptlrpc_cli_ctx *ctx)
 100 {
 101         LASSERT(list_empty(&ctx->cc_gc_chain));
 102
 103         CDEBUG(D_SEC, "hand over ctx %p(%u->%s)\n",
 104                ctx, ctx->cc_vcred.vc_uid, sec2target_str(ctx->cc_sec));
 105         spin_lock(&sec_gc_ctx_list_lock);
 106         list_add(&ctx->cc_gc_chain, &sec_gc_ctx_list);
 107         spin_unlock(&sec_gc_ctx_list_lock);
 108
 109         mod_delayed_work(system_wq, &sec_gc_work, 0);
 110 }
 111 EXPORT_SYMBOL(sptlrpc_gc_add_ctx);
 112
 113 static void sec_process_ctx_list(void)
 114 {
 115         struct ptlrpc_cli_ctx *ctx;
 116
 117         spin_lock(&sec_gc_ctx_list_lock);
 118
 119         while (!list_empty(&sec_gc_ctx_list)) {
 120                 ctx = list_entry(sec_gc_ctx_list.next,
 121                                      struct ptlrpc_cli_ctx, cc_gc_chain);
 122                 list_del_init(&ctx->cc_gc_chain);
 123                 spin_unlock(&sec_gc_ctx_list_lock);
 124
 125                 LASSERT(ctx->cc_sec);
 126                 LASSERT(atomic_read(&ctx->cc_refcount) == 1);
 127                 CDEBUG(D_SEC, "gc pick up ctx %p(%u->%s)\n",
 128                        ctx, ctx->cc_vcred.vc_uid, sec2target_str(ctx->cc_sec));
 129                 sptlrpc_cli_ctx_put(ctx, 1);
 130
 131                 spin_lock(&sec_gc_ctx_list_lock);
 132         }
 133
 134         spin_unlock(&sec_gc_ctx_list_lock);
 135 }
 136
 137 static void sec_do_gc(struct ptlrpc_sec *sec)
 138 {
 139         LASSERT(sec->ps_policy->sp_cops->gc_ctx);
 140
 141         if (unlikely(sec->ps_gc_next == 0)) {
 142                 CDEBUG(D_SEC, "sec %p(%s) has 0 gc time\n",
 143                        sec, sec->ps_policy->sp_name);
 144                 return;
 145         }
 146
 147         CDEBUG(D_SEC, "check on sec %p(%s)\n", sec, sec->ps_policy->sp_name);
 148
 149         if (sec->ps_gc_next > ktime_get_real_seconds())
 150                 return;
 151
 152         sec->ps_policy->sp_cops->gc_ctx(sec);
 153         sec->ps_gc_next = ktime_get_real_seconds() + sec->ps_gc_interval;
 154 }
 155
 156 static void sec_gc_main(struct work_struct *ws)
 157 {
 158         struct ptlrpc_sec *sec;
 159
 160         sec_process_ctx_list();
 161 again:
 162         /*
 163          * go through sec list do gc.
 164          * FIXME here we iterate through the whole list each time which
 165          * is not optimal. we perhaps want to use balanced binary tree
 166          * to trace each sec as order of expiry time.
 167          * another issue here is we wakeup as fixed interval instead of
 168          * according to each sec's expiry time
 169          */
 170         mutex_lock(&sec_gc_mutex);
 171         list_for_each_entry(sec, &sec_gc_list, ps_gc_list) {
 172                 /*
 173                  * if someone is waiting to be deleted, let it
 174                  * proceed as soon as possible.
 175                  */
 176                 if (atomic_read(&sec_gc_wait_del)) {
 177                         CDEBUG(D_SEC, "deletion pending, start over\n");
 178                         mutex_unlock(&sec_gc_mutex);
 179                         goto again;
 180                 }
 181
 182                 sec_do_gc(sec);
 183         }
 184         mutex_unlock(&sec_gc_mutex);
 185
 186         /* check ctx list again before sleep */
 187         sec_process_ctx_list();
 188         schedule_delayed_work(&sec_gc_work, cfs_time_seconds(SEC_GC_INTERVAL));
 189 }
 190
 191 int sptlrpc_gc_init(void)
 192 {
 193         schedule_delayed_work(&sec_gc_work, cfs_time_seconds(SEC_GC_INTERVAL));
 194         return 0;
 195 }
 196
 197 void sptlrpc_gc_fini(void)
 198 {
 199         cancel_delayed_work_sync(&sec_gc_work);
 200 }