4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2012, 2014, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/ptlrpc/sec_gc.c
38 * Author: Eric Mei <ericm@clusterfs.com>
41 #define DEBUG_SUBSYSTEM S_SEC
43 #include <libcfs/libcfs.h>
45 #include <obd_support.h>
46 #include <obd_class.h>
47 #include <lustre_net.h>
48 #include <lustre_sec.h>
50 #include "ptlrpc_internal.h"
52 #define SEC_GC_INTERVAL (30 * 60)
55 static struct mutex sec_gc_mutex;
56 static spinlock_t sec_gc_list_lock;
57 static struct list_head sec_gc_list;
59 static spinlock_t sec_gc_ctx_list_lock;
60 static struct list_head sec_gc_ctx_list;
62 static struct ptlrpc_thread sec_gc_thread;
63 static atomic_t sec_gc_wait_del = ATOMIC_INIT(0);
66 void sptlrpc_gc_add_sec(struct ptlrpc_sec *sec)
68 LASSERT(sec->ps_policy->sp_cops->gc_ctx);
69 LASSERT(sec->ps_gc_interval > 0);
70 LASSERT(list_empty(&sec->ps_gc_list));
72 sec->ps_gc_next = cfs_time_current_sec() + sec->ps_gc_interval;
74 spin_lock(&sec_gc_list_lock);
75 list_add_tail(&sec_gc_list, &sec->ps_gc_list);
76 spin_unlock(&sec_gc_list_lock);
78 CDEBUG(D_SEC, "added sec %p(%s)\n", sec, sec->ps_policy->sp_name);
80 EXPORT_SYMBOL(sptlrpc_gc_add_sec);
82 void sptlrpc_gc_del_sec(struct ptlrpc_sec *sec)
84 if (list_empty(&sec->ps_gc_list))
89 /* signal before list_del to make iteration in gc thread safe */
90 atomic_inc(&sec_gc_wait_del);
92 spin_lock(&sec_gc_list_lock);
93 list_del_init(&sec->ps_gc_list);
94 spin_unlock(&sec_gc_list_lock);
97 mutex_lock(&sec_gc_mutex);
98 mutex_unlock(&sec_gc_mutex);
100 atomic_dec(&sec_gc_wait_del);
102 CDEBUG(D_SEC, "del sec %p(%s)\n", sec, sec->ps_policy->sp_name);
104 EXPORT_SYMBOL(sptlrpc_gc_del_sec);
106 void sptlrpc_gc_add_ctx(struct ptlrpc_cli_ctx *ctx)
108 LASSERT(list_empty(&ctx->cc_gc_chain));
110 CDEBUG(D_SEC, "hand over ctx %p(%u->%s)\n",
111 ctx, ctx->cc_vcred.vc_uid, sec2target_str(ctx->cc_sec));
112 spin_lock(&sec_gc_ctx_list_lock);
113 list_add(&ctx->cc_gc_chain, &sec_gc_ctx_list);
114 spin_unlock(&sec_gc_ctx_list_lock);
116 thread_add_flags(&sec_gc_thread, SVC_SIGNAL);
117 wake_up(&sec_gc_thread.t_ctl_waitq);
119 EXPORT_SYMBOL(sptlrpc_gc_add_ctx);
121 static void sec_process_ctx_list(void)
123 struct ptlrpc_cli_ctx *ctx;
125 spin_lock(&sec_gc_ctx_list_lock);
127 while (!list_empty(&sec_gc_ctx_list)) {
128 ctx = list_entry(sec_gc_ctx_list.next,
129 struct ptlrpc_cli_ctx, cc_gc_chain);
130 list_del_init(&ctx->cc_gc_chain);
131 spin_unlock(&sec_gc_ctx_list_lock);
133 LASSERT(ctx->cc_sec);
134 LASSERT(atomic_read(&ctx->cc_refcount) == 1);
135 CDEBUG(D_SEC, "gc pick up ctx %p(%u->%s)\n",
136 ctx, ctx->cc_vcred.vc_uid, sec2target_str(ctx->cc_sec));
137 sptlrpc_cli_ctx_put(ctx, 1);
139 spin_lock(&sec_gc_ctx_list_lock);
142 spin_unlock(&sec_gc_ctx_list_lock);
145 static void sec_do_gc(struct ptlrpc_sec *sec)
147 LASSERT(sec->ps_policy->sp_cops->gc_ctx);
149 if (unlikely(sec->ps_gc_next == 0)) {
150 CDEBUG(D_SEC, "sec %p(%s) has 0 gc time\n",
151 sec, sec->ps_policy->sp_name);
155 CDEBUG(D_SEC, "check on sec %p(%s)\n", sec, sec->ps_policy->sp_name);
157 if (cfs_time_after(sec->ps_gc_next, cfs_time_current_sec()))
160 sec->ps_policy->sp_cops->gc_ctx(sec);
161 sec->ps_gc_next = cfs_time_current_sec() + sec->ps_gc_interval;
164 static int sec_gc_main(void *arg)
166 struct ptlrpc_thread *thread = (struct ptlrpc_thread *) arg;
167 struct l_wait_info lwi;
171 /* Record that the thread is running */
172 thread_set_flags(thread, SVC_RUNNING);
173 wake_up(&thread->t_ctl_waitq);
176 struct ptlrpc_sec *sec;
178 thread_clear_flags(thread, SVC_SIGNAL);
179 sec_process_ctx_list();
181 /* go through sec list do gc.
182 * FIXME here we iterate through the whole list each time which
183 * is not optimal. we perhaps want to use balanced binary tree
184 * to trace each sec as order of expiry time.
185 * another issue here is we wakeup as fixed interval instead of
186 * according to each sec's expiry time */
187 mutex_lock(&sec_gc_mutex);
188 list_for_each_entry(sec, &sec_gc_list, ps_gc_list) {
189 /* if someone is waiting to be deleted, let it
190 * proceed as soon as possible. */
191 if (atomic_read(&sec_gc_wait_del)) {
192 CDEBUG(D_SEC, "deletion pending, start over\n");
193 mutex_unlock(&sec_gc_mutex);
199 mutex_unlock(&sec_gc_mutex);
201 /* check ctx list again before sleep */
202 sec_process_ctx_list();
204 lwi = LWI_TIMEOUT(msecs_to_jiffies(SEC_GC_INTERVAL *
207 l_wait_event(thread->t_ctl_waitq,
208 thread_is_stopping(thread) ||
209 thread_is_signal(thread),
212 if (thread_test_and_clear_flags(thread, SVC_STOPPING))
216 thread_set_flags(thread, SVC_STOPPED);
217 wake_up(&thread->t_ctl_waitq);
221 int sptlrpc_gc_init(void)
223 struct l_wait_info lwi = { 0 };
224 struct task_struct *task;
226 mutex_init(&sec_gc_mutex);
227 spin_lock_init(&sec_gc_list_lock);
228 spin_lock_init(&sec_gc_ctx_list_lock);
230 INIT_LIST_HEAD(&sec_gc_list);
231 INIT_LIST_HEAD(&sec_gc_ctx_list);
233 /* initialize thread control */
234 memset(&sec_gc_thread, 0, sizeof(sec_gc_thread));
235 init_waitqueue_head(&sec_gc_thread.t_ctl_waitq);
237 task = kthread_run(sec_gc_main, &sec_gc_thread, "sptlrpc_gc");
239 CERROR("can't start gc thread: %ld\n", PTR_ERR(task));
240 return PTR_ERR(task);
243 l_wait_event(sec_gc_thread.t_ctl_waitq,
244 thread_is_running(&sec_gc_thread), &lwi);
248 void sptlrpc_gc_fini(void)
250 struct l_wait_info lwi = { 0 };
252 thread_set_flags(&sec_gc_thread, SVC_STOPPING);
253 wake_up(&sec_gc_thread.t_ctl_waitq);
255 l_wait_event(sec_gc_thread.t_ctl_waitq,
256 thread_is_stopped(&sec_gc_thread), &lwi);