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.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 * lustre/include/lustre_lib.h
34 * Basic Lustre library routines.
45 #ifdef HAVE_SCHED_HEADERS
46 #include <linux/sched/signal.h>
47 #include <linux/sched/mm.h>
50 #include <libcfs/libcfs.h>
51 #include <uapi/linux/lustre/lustre_idl.h>
52 #include <uapi/linux/lustre/lustre_ver.h>
53 #include <uapi/linux/lustre/lustre_cfg.h>
56 struct ptlrpc_request;
60 #include <lustre_ha.h>
61 #include <lustre_net.h>
63 #define LI_POISON 0x5a5a5a5a
64 #if BITS_PER_LONG > 32
65 # define LL_POISON 0x5a5a5a5a5a5a5a5aL
67 # define LL_POISON 0x5a5a5a5aL
69 #define LP_POISON ((void *)LL_POISON)
71 #ifdef HAVE_SERVER_SUPPORT
72 int rev_import_init(struct obd_export *exp);
73 int target_handle_connect(struct ptlrpc_request *req);
74 int target_handle_disconnect(struct ptlrpc_request *req);
75 void target_destroy_export(struct obd_export *exp);
76 void target_committed_to_req(struct ptlrpc_request *req);
77 void target_cancel_recovery_timer(struct obd_device *obd);
78 void target_stop_recovery_thread(struct obd_device *obd);
79 void target_cleanup_recovery(struct obd_device *obd);
80 int target_queue_recovery_request(struct ptlrpc_request *req,
81 struct obd_device *obd);
82 int target_bulk_io(struct obd_export *exp, struct ptlrpc_bulk_desc *desc);
85 int target_pack_pool_reply(struct ptlrpc_request *req);
86 int do_set_info_async(struct obd_import *imp,
87 int opcode, int version,
88 size_t keylen, void *key,
89 size_t vallen, void *val,
90 struct ptlrpc_request_set *set);
92 void target_send_reply(struct ptlrpc_request *req, int rc, int fail_id);
95 * l_wait_event is a flexible sleeping function, permitting simple caller
96 * configuration of interrupt and timeout sensitivity along with actions to
97 * be performed in the event of either exception.
99 * The first form of usage looks like this:
101 * struct l_wait_info lwi = LWI_TIMEOUT_INTR(timeout, timeout_handler,
102 * intr_handler, callback_data);
103 * rc = l_wait_event(waitq, condition, &lwi);
105 * l_wait_event() makes the current process wait on 'waitq' until 'condition'
106 * is TRUE or a "killable" signal (SIGTERM, SIKGILL, SIGINT) is pending. It
107 * returns 0 to signify 'condition' is TRUE, but if a signal wakes it before
108 * 'condition' becomes true, it optionally calls the specified 'intr_handler'
109 * if not NULL, and returns -EINTR.
111 * If a non-zero timeout is specified, signals are ignored until the timeout
112 * has expired. At this time, if 'timeout_handler' is not NULL it is called.
113 * If it returns FALSE l_wait_event() continues to wait as described above with
114 * signals enabled. Otherwise it returns -ETIMEDOUT.
116 * LWI_INTR(intr_handler, callback_data) is shorthand for
117 * LWI_TIMEOUT_INTR(0, NULL, intr_handler, callback_data)
119 * The second form of usage looks like this:
121 * struct l_wait_info lwi = LWI_TIMEOUT(timeout, timeout_handler);
122 * rc = l_wait_event(waitq, condition, &lwi);
124 * This form is the same as the first except that it COMPLETELY IGNORES
125 * SIGNALS. The caller must therefore beware that if 'timeout' is zero, or if
126 * 'timeout_handler' is not NULL and returns FALSE, then the ONLY thing that
127 * can unblock the current process is 'condition' becoming TRUE.
129 * Another form of usage is:
130 * struct l_wait_info lwi = LWI_TIMEOUT_INTERVAL(timeout, interval,
132 * rc = l_wait_event(waitq, condition, &lwi);
133 * This is the same as previous case, but condition is checked once every
134 * 'interval' jiffies (if non-zero).
136 * Subtle synchronization point: this macro does *not* necessary takes
137 * wait-queue spin-lock before returning, and, hence, following idiom is safe
138 * ONLY when caller provides some external locking:
142 * l_wait_event(&obj->wq, ....); (1)
144 * wake_up(&obj->wq): (2)
145 * spin_lock(&q->lock); (2.1)
146 * __wake_up_common(q, ...); (2.2)
147 * spin_unlock(&q->lock, flags); (2.3)
149 * OBD_FREE_PTR(obj); (3)
151 * As l_wait_event() may "short-cut" execution and return without taking
152 * wait-queue spin-lock, some additional synchronization is necessary to
153 * guarantee that step (3) can begin only after (2.3) finishes.
155 * XXX nikita: some ptlrpc daemon threads have races of that sort.
158 static inline int back_to_sleep(void *arg)
163 #define LWI_ON_SIGNAL_NOOP ((void (*)(void *))(-1))
169 int (*lwi_on_timeout)(void *);
170 void (*lwi_on_signal)(void *);
174 /* NB: LWI_TIMEOUT ignores signals completely */
175 #define LWI_TIMEOUT(time, cb, data) \
176 ((struct l_wait_info) { \
177 .lwi_timeout = time, \
178 .lwi_on_timeout = cb, \
179 .lwi_cb_data = data, \
181 .lwi_allow_intr = 0 \
184 #define LWI_TIMEOUT_INTERVAL(time, interval, cb, data) \
185 ((struct l_wait_info) { \
186 .lwi_timeout = time, \
187 .lwi_on_timeout = cb, \
188 .lwi_cb_data = data, \
189 .lwi_interval = interval, \
190 .lwi_allow_intr = 0 \
193 #define LWI_TIMEOUT_INTR(time, time_cb, sig_cb, data) \
194 ((struct l_wait_info) { \
195 .lwi_timeout = time, \
196 .lwi_on_timeout = time_cb, \
197 .lwi_on_signal = sig_cb, \
198 .lwi_cb_data = data, \
200 .lwi_allow_intr = 0 \
203 #define LWI_TIMEOUT_INTR_ALL(time, time_cb, sig_cb, data) \
204 ((struct l_wait_info) { \
205 .lwi_timeout = time, \
206 .lwi_on_timeout = time_cb, \
207 .lwi_on_signal = sig_cb, \
208 .lwi_cb_data = data, \
210 .lwi_allow_intr = 1 \
213 #define LWI_INTR(cb, data) LWI_TIMEOUT_INTR(0, NULL, cb, data)
216 * wait_queue_t of Linux (version < 2.6.34) is a FIFO list for exclusively
217 * waiting threads, which is not always desirable because all threads will
218 * be waken up again and again, even user only needs a few of them to be
219 * active most time. This is not good for performance because cache can
220 * be polluted by different threads.
222 * LIFO list can resolve this problem because we always wakeup the most
223 * recent active thread by default.
225 * NB: please don't call non-exclusive & exclusive wait on the same
226 * waitq if add_wait_queue_exclusive_head is used.
228 #define add_wait_queue_exclusive_head(waitq, link) \
230 unsigned long flags; \
232 spin_lock_irqsave(&((waitq)->lock), flags); \
233 __add_wait_queue_exclusive(waitq, link); \
234 spin_unlock_irqrestore(&((waitq)->lock), flags); \
238 * wait for @condition to become true, but no longer than timeout, specified
241 #define __l_wait_event(wq, condition, info, ret, l_add_wait) \
243 wait_queue_entry_t __wait; \
244 long __timeout = info->lwi_timeout; \
245 sigset_t __blocked; \
246 int __allow_intr = info->lwi_allow_intr; \
252 init_waitqueue_entry(&__wait, current); \
253 l_add_wait(&wq, &__wait); \
255 /* Block all signals (just the non-fatal ones if no timeout). */ \
256 if (info->lwi_on_signal != NULL && (__timeout == 0 || __allow_intr)) \
257 __blocked = cfs_block_sigsinv(LUSTRE_FATAL_SIGS); \
259 __blocked = cfs_block_sigsinv(0); \
262 set_current_state(TASK_INTERRUPTIBLE); \
264 /* To guarantee that the condition check will be done */ \
265 /* after setting the thread state as TASK_INTERRUPTIBLE. */ \
266 /* Otherwise, out-of-order execution may cause some race. */ \
267 /* Consider the following real execution order: */ \
269 /* 1. Thread1 checks condition on CPU1, gets false. */ \
270 /* 2. Thread2 sets condition on CPU2. */ \
271 /* 3. Thread2 calls wake_up() on CPU2 to wake the threads */ \
272 /* with state TASK_INTERRUPTIBLE | TASK_UNINTERRUPTIBLE. */ \
273 /* But the Thread1's state is TASK_RUNNING at that time. */ \
274 /* 4. Thread1 sets its state as TASK_INTERRUPTIBLE on CPU1, */ \
275 /* then schedule. */ \
277 /* If the '__timeout' variable is zero, the Thread1 will */ \
278 /* have no chance to check the condition again. */ \
280 /* Generally, the interval between out-of-ordered step1 and */ \
281 /* step4 is very tiny, as to above step2 and step3 cannot */ \
282 /* happen. On some degree, it can explain why we seldom hit */ \
283 /* related trouble. But such race really exists, especially */ \
284 /* consider that the step1 and step4 can be interruptible. */ \
285 /* So add barrier to avoid Thread1 out-of-order execution. */ \
291 if (__timeout == 0) { \
294 long interval = info->lwi_interval ? \
295 min_t(long, info->lwi_interval,\
296 __timeout) : __timeout; \
297 long remaining = schedule_timeout(interval); \
299 __timeout -= interval - remaining; \
300 if (__timeout == 0) { \
301 if (info->lwi_on_timeout == NULL || \
302 info->lwi_on_timeout(info->lwi_cb_data)) { \
306 /* Take signals after the timeout expires. */ \
307 if (info->lwi_on_signal != NULL) \
308 (void)cfs_block_sigsinv(LUSTRE_FATAL_SIGS);\
314 if (signal_pending(current)) { \
315 if (info->lwi_on_signal != NULL && \
316 (__timeout == 0 || __allow_intr)) { \
317 if (info->lwi_on_signal != LWI_ON_SIGNAL_NOOP) \
318 info->lwi_on_signal(info->lwi_cb_data);\
322 /* We have to do this here because some signals */ \
323 /* are not blockable - ie from strace(1). */ \
324 /* In these cases we want to schedule_timeout() */ \
325 /* again, because we don't want that to return */ \
326 /* -EINTR when the RPC actually succeeded. */ \
327 /* the recalc_sigpending() below will deliver the */ \
328 /* signal properly. */ \
329 cfs_clear_sigpending(); \
333 cfs_restore_sigs(__blocked); \
335 set_current_state(TASK_RUNNING); \
336 remove_wait_queue(&wq, &__wait); \
340 #define l_wait_event(wq, condition, info) \
343 struct l_wait_info *__info = (info); \
345 __l_wait_event(wq, condition, __info, \
346 __ret, add_wait_queue); \
350 #define l_wait_event_exclusive(wq, condition, info) \
353 struct l_wait_info *__info = (info); \
355 __l_wait_event(wq, condition, __info, \
356 __ret, add_wait_queue_exclusive); \
360 #define l_wait_event_exclusive_head(wq, condition, info) \
363 struct l_wait_info *__info = (info); \
365 __l_wait_event(wq, condition, __info, \
366 __ret, add_wait_queue_exclusive_head); \
370 #define l_wait_condition(wq, condition) \
372 struct l_wait_info lwi = { 0 }; \
373 l_wait_event(wq, condition, &lwi); \
376 #define l_wait_condition_exclusive(wq, condition) \
378 struct l_wait_info lwi = { 0 }; \
379 l_wait_event_exclusive(wq, condition, &lwi); \
382 #define l_wait_condition_exclusive_head(wq, condition) \
384 struct l_wait_info lwi = { 0 }; \
385 l_wait_event_exclusive_head(wq, condition, &lwi); \
390 #endif /* _LUSTRE_LIB_H */