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) 2011, 2013, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/include/lustre_lib.h
38 * Basic Lustre library routines.
49 #include <libcfs/libcfs.h>
50 #include <lustre/lustre_idl.h>
51 #include <lustre_ver.h>
52 #include <lustre_cfg.h>
53 #if defined(__linux__)
54 #include <linux/lustre_lib.h>
55 #elif defined(__APPLE__)
56 #include <darwin/lustre_lib.h>
57 #elif defined(__WINNT__)
58 #include <winnt/lustre_lib.h>
60 #error Unsupported operating system.
64 struct ptlrpc_request;
68 #include <lustre_ha.h>
69 #include <lustre_net.h>
72 #ifdef HAVE_SERVER_SUPPORT
73 void target_client_add_cb(struct obd_device *obd, __u64 transno, void *cb_data,
75 int target_handle_connect(struct ptlrpc_request *req);
76 int target_handle_disconnect(struct ptlrpc_request *req);
77 void target_destroy_export(struct obd_export *exp);
78 int target_handle_ping(struct ptlrpc_request *req);
79 void target_committed_to_req(struct ptlrpc_request *req);
80 void target_cancel_recovery_timer(struct obd_device *obd);
81 void target_stop_recovery_thread(struct obd_device *obd);
82 void target_cleanup_recovery(struct obd_device *obd);
83 int target_queue_recovery_request(struct ptlrpc_request *req,
84 struct obd_device *obd);
85 int target_bulk_io(struct obd_export *exp, struct ptlrpc_bulk_desc *desc,
86 struct l_wait_info *lwi);
89 int target_pack_pool_reply(struct ptlrpc_request *req);
90 int do_set_info_async(struct obd_import *imp,
91 int opcode, int version,
92 obd_count keylen, void *key,
93 obd_count vallen, void *val,
94 struct ptlrpc_request_set *set);
96 #define OBD_RECOVERY_MAX_TIME (obd_timeout * 18) /* b13079 */
97 #define OBD_MAX_IOCTL_BUFFER CONFIG_LUSTRE_OBD_MAX_IOCTL_BUFFER
99 void target_send_reply(struct ptlrpc_request *req, int rc, int fail_id);
103 int client_sanobd_setup(struct obd_device *obddev, struct lustre_cfg* lcfg);
104 struct client_obd *client_conn2cli(struct lustre_handle *conn);
107 struct obd_client_handle {
108 struct lustre_handle och_fh;
109 struct lu_fid och_fid;
110 struct md_open_data *och_mod;
111 struct lustre_handle och_lease_handle; /* open lock for lease */
115 #define OBD_CLIENT_HANDLE_MAGIC 0xd15ea5ed
118 void statfs_pack(struct obd_statfs *osfs, struct kstatfs *sfs);
119 void statfs_unpack(struct kstatfs *sfs, struct obd_statfs *osfs);
125 struct semaphore l_sem;
129 void l_lock_init(struct lustre_lock *);
130 void l_lock(struct lustre_lock *);
131 void l_unlock(struct lustre_lock *);
132 int l_has_lock(struct lustre_lock *);
138 ECHO_MD_CREATE = 1, /* Open/Create file on MDT */
139 ECHO_MD_MKDIR = 2, /* Mkdir on MDT */
140 ECHO_MD_DESTROY = 3, /* Unlink file on MDT */
141 ECHO_MD_RMDIR = 4, /* Rmdir on MDT */
142 ECHO_MD_LOOKUP = 5, /* Lookup on MDT */
143 ECHO_MD_GETATTR = 6, /* Getattr on MDT */
144 ECHO_MD_SETATTR = 7, /* Setattr on MDT */
145 ECHO_MD_ALLOC_FID = 8, /* Get FIDs from MDT */
151 #define OBD_IOCTL_VERSION 0x00010004
153 struct obd_ioctl_data {
170 struct obdo ioc_obdo1;
171 struct obdo ioc_obdo2;
182 /* buffers the kernel will treat as user pointers */
188 /* inline buffers for various arguments */
201 struct obd_ioctl_hdr {
206 static inline int obd_ioctl_packlen(struct obd_ioctl_data *data)
208 int len = cfs_size_round(sizeof(struct obd_ioctl_data));
209 len += cfs_size_round(data->ioc_inllen1);
210 len += cfs_size_round(data->ioc_inllen2);
211 len += cfs_size_round(data->ioc_inllen3);
212 len += cfs_size_round(data->ioc_inllen4);
217 static inline int obd_ioctl_is_invalid(struct obd_ioctl_data *data)
219 if (data->ioc_len > (1<<30)) {
220 CERROR("OBD ioctl: ioc_len larger than 1<<30\n");
223 if (data->ioc_inllen1 > (1<<30)) {
224 CERROR("OBD ioctl: ioc_inllen1 larger than 1<<30\n");
227 if (data->ioc_inllen2 > (1<<30)) {
228 CERROR("OBD ioctl: ioc_inllen2 larger than 1<<30\n");
231 if (data->ioc_inllen3 > (1<<30)) {
232 CERROR("OBD ioctl: ioc_inllen3 larger than 1<<30\n");
235 if (data->ioc_inllen4 > (1<<30)) {
236 CERROR("OBD ioctl: ioc_inllen4 larger than 1<<30\n");
239 if (data->ioc_inlbuf1 && !data->ioc_inllen1) {
240 CERROR("OBD ioctl: inlbuf1 pointer but 0 length\n");
243 if (data->ioc_inlbuf2 && !data->ioc_inllen2) {
244 CERROR("OBD ioctl: inlbuf2 pointer but 0 length\n");
247 if (data->ioc_inlbuf3 && !data->ioc_inllen3) {
248 CERROR("OBD ioctl: inlbuf3 pointer but 0 length\n");
251 if (data->ioc_inlbuf4 && !data->ioc_inllen4) {
252 CERROR("OBD ioctl: inlbuf4 pointer but 0 length\n");
255 if (data->ioc_pbuf1 && !data->ioc_plen1) {
256 CERROR("OBD ioctl: pbuf1 pointer but 0 length\n");
259 if (data->ioc_pbuf2 && !data->ioc_plen2) {
260 CERROR("OBD ioctl: pbuf2 pointer but 0 length\n");
263 if (data->ioc_plen1 && !data->ioc_pbuf1) {
264 CERROR("OBD ioctl: plen1 set but NULL pointer\n");
267 if (data->ioc_plen2 && !data->ioc_pbuf2) {
268 CERROR("OBD ioctl: plen2 set but NULL pointer\n");
271 if (obd_ioctl_packlen(data) > data->ioc_len) {
272 CERROR("OBD ioctl: packlen exceeds ioc_len (%d > %d)\n",
273 obd_ioctl_packlen(data), data->ioc_len);
280 static inline int obd_ioctl_pack(struct obd_ioctl_data *data, char **pbuf,
284 struct obd_ioctl_data *overlay;
285 data->ioc_len = obd_ioctl_packlen(data);
286 data->ioc_version = OBD_IOCTL_VERSION;
288 if (*pbuf && data->ioc_len > max) {
289 fprintf(stderr, "pbuf %p ioc_len %u max %d\n", *pbuf,
294 *pbuf = malloc(data->ioc_len);
298 overlay = (struct obd_ioctl_data *)*pbuf;
299 memcpy(*pbuf, data, sizeof(*data));
301 ptr = overlay->ioc_bulk;
302 if (data->ioc_inlbuf1)
303 LOGL(data->ioc_inlbuf1, data->ioc_inllen1, ptr);
304 if (data->ioc_inlbuf2)
305 LOGL(data->ioc_inlbuf2, data->ioc_inllen2, ptr);
306 if (data->ioc_inlbuf3)
307 LOGL(data->ioc_inlbuf3, data->ioc_inllen3, ptr);
308 if (data->ioc_inlbuf4)
309 LOGL(data->ioc_inlbuf4, data->ioc_inllen4, ptr);
310 if (obd_ioctl_is_invalid(overlay)) {
311 fprintf(stderr, "ioc_len %u max %d\n",
319 static inline int obd_ioctl_unpack(struct obd_ioctl_data *data, char *pbuf,
323 struct obd_ioctl_data *overlay;
327 overlay = (struct obd_ioctl_data *)pbuf;
329 /* Preserve the caller's buffer pointers */
330 overlay->ioc_inlbuf1 = data->ioc_inlbuf1;
331 overlay->ioc_inlbuf2 = data->ioc_inlbuf2;
332 overlay->ioc_inlbuf3 = data->ioc_inlbuf3;
333 overlay->ioc_inlbuf4 = data->ioc_inlbuf4;
335 memcpy(data, pbuf, sizeof(*data));
337 ptr = overlay->ioc_bulk;
338 if (data->ioc_inlbuf1)
339 LOGU(data->ioc_inlbuf1, data->ioc_inllen1, ptr);
340 if (data->ioc_inlbuf2)
341 LOGU(data->ioc_inlbuf2, data->ioc_inllen2, ptr);
342 if (data->ioc_inlbuf3)
343 LOGU(data->ioc_inlbuf3, data->ioc_inllen3, ptr);
344 if (data->ioc_inlbuf4)
345 LOGU(data->ioc_inlbuf4, data->ioc_inllen4, ptr);
351 #include <obd_support.h>
354 /* function defined in lustre/obdclass/<platform>/<platform>-module.c */
355 int obd_ioctl_getdata(char **buf, int *len, void *arg);
356 int obd_ioctl_popdata(void *arg, void *data, int len);
358 /* buffer MUST be at least the size of obd_ioctl_hdr */
359 static inline int obd_ioctl_getdata(char **buf, int *len, void *arg)
361 struct obd_ioctl_hdr hdr;
362 struct obd_ioctl_data *data;
367 err = copy_from_user(&hdr, (void *)arg, sizeof(hdr));
371 if (hdr.ioc_version != OBD_IOCTL_VERSION) {
372 CERROR("Version mismatch kernel vs application\n");
376 if (hdr.ioc_len > OBD_MAX_IOCTL_BUFFER) {
377 CERROR("User buffer len %d exceeds %d max buffer\n",
378 hdr.ioc_len, OBD_MAX_IOCTL_BUFFER);
382 if (hdr.ioc_len < sizeof(struct obd_ioctl_data)) {
383 CERROR("User buffer too small for ioctl (%d)\n", hdr.ioc_len);
387 OBD_ALLOC_LARGE(*buf, hdr.ioc_len);
389 CERROR("Cannot allocate control buffer of len %d\n",
394 data = (struct obd_ioctl_data *)*buf;
396 err = copy_from_user(*buf, (void *)arg, hdr.ioc_len);
398 OBD_FREE_LARGE(*buf, hdr.ioc_len);
402 if (obd_ioctl_is_invalid(data)) {
403 CERROR("ioctl not correctly formatted\n");
404 OBD_FREE_LARGE(*buf, hdr.ioc_len);
408 if (data->ioc_inllen1) {
409 data->ioc_inlbuf1 = &data->ioc_bulk[0];
410 offset += cfs_size_round(data->ioc_inllen1);
413 if (data->ioc_inllen2) {
414 data->ioc_inlbuf2 = &data->ioc_bulk[0] + offset;
415 offset += cfs_size_round(data->ioc_inllen2);
418 if (data->ioc_inllen3) {
419 data->ioc_inlbuf3 = &data->ioc_bulk[0] + offset;
420 offset += cfs_size_round(data->ioc_inllen3);
423 if (data->ioc_inllen4) {
424 data->ioc_inlbuf4 = &data->ioc_bulk[0] + offset;
430 static inline int obd_ioctl_popdata(void *arg, void *data, int len)
432 int err = copy_to_user(arg, data, len);
439 static inline void obd_ioctl_freedata(char *buf, int len)
443 OBD_FREE_LARGE(buf, len);
449 * BSD ioctl description:
450 * #define IOC_V1 _IOR(g, n1, long)
451 * #define IOC_V2 _IOW(g, n2, long)
453 * ioctl(f, IOC_V1, arg);
454 * arg will be treated as a long value,
456 * ioctl(f, IOC_V2, arg)
457 * arg will be treated as a pointer, bsd will call
458 * copyin(buf, arg, sizeof(long))
460 * To make BSD ioctl handles argument correctly and simplely,
461 * we change _IOR to _IOWR so BSD will copyin obd_ioctl_data
462 * for us. Does this change affect Linux? (XXX Liang)
464 #define OBD_IOC_CREATE _IOWR('f', 101, OBD_IOC_DATA_TYPE)
465 #define OBD_IOC_DESTROY _IOW ('f', 104, OBD_IOC_DATA_TYPE)
466 #define OBD_IOC_PREALLOCATE _IOWR('f', 105, OBD_IOC_DATA_TYPE)
468 #define OBD_IOC_SETATTR _IOW ('f', 107, OBD_IOC_DATA_TYPE)
469 #define OBD_IOC_GETATTR _IOWR ('f', 108, OBD_IOC_DATA_TYPE)
470 #define OBD_IOC_READ _IOWR('f', 109, OBD_IOC_DATA_TYPE)
471 #define OBD_IOC_WRITE _IOWR('f', 110, OBD_IOC_DATA_TYPE)
474 #define OBD_IOC_STATFS _IOWR('f', 113, OBD_IOC_DATA_TYPE)
475 #define OBD_IOC_SYNC _IOW ('f', 114, OBD_IOC_DATA_TYPE)
476 #define OBD_IOC_READ2 _IOWR('f', 115, OBD_IOC_DATA_TYPE)
477 #define OBD_IOC_FORMAT _IOWR('f', 116, OBD_IOC_DATA_TYPE)
478 #define OBD_IOC_PARTITION _IOWR('f', 117, OBD_IOC_DATA_TYPE)
479 #define OBD_IOC_COPY _IOWR('f', 120, OBD_IOC_DATA_TYPE)
480 #define OBD_IOC_MIGR _IOWR('f', 121, OBD_IOC_DATA_TYPE)
481 #define OBD_IOC_PUNCH _IOWR('f', 122, OBD_IOC_DATA_TYPE)
483 #define OBD_IOC_MODULE_DEBUG _IOWR('f', 124, OBD_IOC_DATA_TYPE)
484 #define OBD_IOC_BRW_READ _IOWR('f', 125, OBD_IOC_DATA_TYPE)
485 #define OBD_IOC_BRW_WRITE _IOWR('f', 126, OBD_IOC_DATA_TYPE)
486 #define OBD_IOC_NAME2DEV _IOWR('f', 127, OBD_IOC_DATA_TYPE)
487 #define OBD_IOC_UUID2DEV _IOWR('f', 130, OBD_IOC_DATA_TYPE)
489 #define OBD_IOC_GETNAME _IOWR('f', 131, OBD_IOC_DATA_TYPE)
490 #define OBD_IOC_GETMDNAME _IOR('f', 131, char[MAX_OBD_NAME])
491 #define OBD_IOC_GETDTNAME OBD_IOC_GETNAME
493 #define OBD_IOC_LOV_GET_CONFIG _IOWR('f', 132, OBD_IOC_DATA_TYPE)
494 #define OBD_IOC_CLIENT_RECOVER _IOW ('f', 133, OBD_IOC_DATA_TYPE)
495 #define OBD_IOC_PING_TARGET _IOW ('f', 136, OBD_IOC_DATA_TYPE)
497 #define OBD_IOC_DEC_FS_USE_COUNT _IO ('f', 139 )
498 #define OBD_IOC_NO_TRANSNO _IOW ('f', 140, OBD_IOC_DATA_TYPE)
499 #define OBD_IOC_SET_READONLY _IOW ('f', 141, OBD_IOC_DATA_TYPE)
500 #define OBD_IOC_ABORT_RECOVERY _IOR ('f', 142, OBD_IOC_DATA_TYPE)
502 #define OBD_IOC_ROOT_SQUASH _IOWR('f', 143, OBD_IOC_DATA_TYPE)
504 #define OBD_GET_VERSION _IOWR ('f', 144, OBD_IOC_DATA_TYPE)
506 #define OBD_IOC_GSS_SUPPORT _IOWR('f', 145, OBD_IOC_DATA_TYPE)
508 #define OBD_IOC_CLOSE_UUID _IOWR ('f', 147, OBD_IOC_DATA_TYPE)
510 #define OBD_IOC_CHANGELOG_SEND _IOW ('f', 148, OBD_IOC_DATA_TYPE)
511 #define OBD_IOC_GETDEVICE _IOWR ('f', 149, OBD_IOC_DATA_TYPE)
512 #define OBD_IOC_FID2PATH _IOWR ('f', 150, OBD_IOC_DATA_TYPE)
513 /* see also <lustre/lustre_user.h> for ioctls 151-153 */
514 /* OBD_IOC_LOV_SETSTRIPE: See also LL_IOC_LOV_SETSTRIPE */
515 #define OBD_IOC_LOV_SETSTRIPE _IOW ('f', 154, OBD_IOC_DATA_TYPE)
516 /* OBD_IOC_LOV_GETSTRIPE: See also LL_IOC_LOV_GETSTRIPE */
517 #define OBD_IOC_LOV_GETSTRIPE _IOW ('f', 155, OBD_IOC_DATA_TYPE)
518 /* OBD_IOC_LOV_SETEA: See also LL_IOC_LOV_SETEA */
519 #define OBD_IOC_LOV_SETEA _IOW ('f', 156, OBD_IOC_DATA_TYPE)
520 /* see <lustre/lustre_user.h> for ioctls 157-159 */
521 /* OBD_IOC_QUOTACHECK: See also LL_IOC_QUOTACHECK */
522 #define OBD_IOC_QUOTACHECK _IOW ('f', 160, int)
523 /* OBD_IOC_POLL_QUOTACHECK: See also LL_IOC_POLL_QUOTACHECK */
524 #define OBD_IOC_POLL_QUOTACHECK _IOR ('f', 161, struct if_quotacheck *)
525 /* OBD_IOC_QUOTACTL: See also LL_IOC_QUOTACTL */
526 #define OBD_IOC_QUOTACTL _IOWR('f', 162, struct if_quotactl)
527 /* see also <lustre/lustre_user.h> for ioctls 163-176 */
528 #define OBD_IOC_CHANGELOG_REG _IOW ('f', 177, struct obd_ioctl_data)
529 #define OBD_IOC_CHANGELOG_DEREG _IOW ('f', 178, struct obd_ioctl_data)
530 #define OBD_IOC_CHANGELOG_CLEAR _IOW ('f', 179, struct obd_ioctl_data)
531 #define OBD_IOC_RECORD _IOWR('f', 180, OBD_IOC_DATA_TYPE)
532 #define OBD_IOC_ENDRECORD _IOWR('f', 181, OBD_IOC_DATA_TYPE)
533 #define OBD_IOC_PARSE _IOWR('f', 182, OBD_IOC_DATA_TYPE)
534 #define OBD_IOC_DORECORD _IOWR('f', 183, OBD_IOC_DATA_TYPE)
535 #define OBD_IOC_PROCESS_CFG _IOWR('f', 184, OBD_IOC_DATA_TYPE)
536 #define OBD_IOC_DUMP_LOG _IOWR('f', 185, OBD_IOC_DATA_TYPE)
537 #define OBD_IOC_CLEAR_LOG _IOWR('f', 186, OBD_IOC_DATA_TYPE)
538 #define OBD_IOC_PARAM _IOW ('f', 187, OBD_IOC_DATA_TYPE)
539 #define OBD_IOC_POOL _IOWR('f', 188, OBD_IOC_DATA_TYPE)
540 #define OBD_IOC_REPLACE_NIDS _IOWR('f', 189, OBD_IOC_DATA_TYPE)
542 #define OBD_IOC_CATLOGLIST _IOWR('f', 190, OBD_IOC_DATA_TYPE)
543 #define OBD_IOC_LLOG_INFO _IOWR('f', 191, OBD_IOC_DATA_TYPE)
544 #define OBD_IOC_LLOG_PRINT _IOWR('f', 192, OBD_IOC_DATA_TYPE)
545 #define OBD_IOC_LLOG_CANCEL _IOWR('f', 193, OBD_IOC_DATA_TYPE)
546 #define OBD_IOC_LLOG_REMOVE _IOWR('f', 194, OBD_IOC_DATA_TYPE)
547 #define OBD_IOC_LLOG_CHECK _IOWR('f', 195, OBD_IOC_DATA_TYPE)
548 /* OBD_IOC_LLOG_CATINFO is deprecated */
549 #define OBD_IOC_LLOG_CATINFO _IOWR('f', 196, OBD_IOC_DATA_TYPE)
551 #define ECHO_IOC_GET_STRIPE _IOWR('f', 200, OBD_IOC_DATA_TYPE)
552 #define ECHO_IOC_SET_STRIPE _IOWR('f', 201, OBD_IOC_DATA_TYPE)
553 #define ECHO_IOC_ENQUEUE _IOWR('f', 202, OBD_IOC_DATA_TYPE)
554 #define ECHO_IOC_CANCEL _IOWR('f', 203, OBD_IOC_DATA_TYPE)
556 #define OBD_IOC_GET_OBJ_VERSION _IOR('f', 210, OBD_IOC_DATA_TYPE)
558 /* <lustre/lustre_user.h> defines ioctl number 218-219 */
559 #define OBD_IOC_GET_MNTOPT _IOW('f', 220, mntopt_t)
561 #define OBD_IOC_ECHO_MD _IOR('f', 221, struct obd_ioctl_data)
562 #define OBD_IOC_ECHO_ALLOC_SEQ _IOWR('f', 222, struct obd_ioctl_data)
564 #define OBD_IOC_START_LFSCK _IOWR('f', 230, OBD_IOC_DATA_TYPE)
565 #define OBD_IOC_STOP_LFSCK _IOW('f', 231, OBD_IOC_DATA_TYPE)
566 #define OBD_IOC_PAUSE_LFSCK _IOW('f', 232, OBD_IOC_DATA_TYPE)
568 /* XXX _IOWR('f', 250, long) has been defined in
569 * libcfs/include/libcfs/libcfs_private.h for debug, don't use it
572 /* Until such time as we get_info the per-stripe maximum from the OST,
573 * we define this to be 2T - 4k, which is the ext3 maxbytes. */
574 #define LUSTRE_STRIPE_MAXBYTES 0x1fffffff000ULL
576 /* Special values for remove LOV EA from disk */
577 #define LOVEA_DELETE_VALUES(size, count, offset) (size == 0 && count == 0 && \
578 offset == (typeof(offset))(-1))
580 /* #define POISON_BULK 0 */
583 * l_wait_event is a flexible sleeping function, permitting simple caller
584 * configuration of interrupt and timeout sensitivity along with actions to
585 * be performed in the event of either exception.
587 * The first form of usage looks like this:
589 * struct l_wait_info lwi = LWI_TIMEOUT_INTR(timeout, timeout_handler,
590 * intr_handler, callback_data);
591 * rc = l_wait_event(waitq, condition, &lwi);
593 * l_wait_event() makes the current process wait on 'waitq' until 'condition'
594 * is TRUE or a "killable" signal (SIGTERM, SIKGILL, SIGINT) is pending. It
595 * returns 0 to signify 'condition' is TRUE, but if a signal wakes it before
596 * 'condition' becomes true, it optionally calls the specified 'intr_handler'
597 * if not NULL, and returns -EINTR.
599 * If a non-zero timeout is specified, signals are ignored until the timeout
600 * has expired. At this time, if 'timeout_handler' is not NULL it is called.
601 * If it returns FALSE l_wait_event() continues to wait as described above with
602 * signals enabled. Otherwise it returns -ETIMEDOUT.
604 * LWI_INTR(intr_handler, callback_data) is shorthand for
605 * LWI_TIMEOUT_INTR(0, NULL, intr_handler, callback_data)
607 * The second form of usage looks like this:
609 * struct l_wait_info lwi = LWI_TIMEOUT(timeout, timeout_handler);
610 * rc = l_wait_event(waitq, condition, &lwi);
612 * This form is the same as the first except that it COMPLETELY IGNORES
613 * SIGNALS. The caller must therefore beware that if 'timeout' is zero, or if
614 * 'timeout_handler' is not NULL and returns FALSE, then the ONLY thing that
615 * can unblock the current process is 'condition' becoming TRUE.
617 * Another form of usage is:
618 * struct l_wait_info lwi = LWI_TIMEOUT_INTERVAL(timeout, interval,
620 * rc = l_wait_event(waitq, condition, &lwi);
621 * This is the same as previous case, but condition is checked once every
622 * 'interval' jiffies (if non-zero).
624 * Subtle synchronization point: this macro does *not* necessary takes
625 * wait-queue spin-lock before returning, and, hence, following idiom is safe
626 * ONLY when caller provides some external locking:
630 * l_wait_event(&obj->wq, ....); (1)
632 * wake_up(&obj->wq): (2)
633 * spin_lock(&q->lock); (2.1)
634 * __wake_up_common(q, ...); (2.2)
635 * spin_unlock(&q->lock, flags); (2.3)
637 * OBD_FREE_PTR(obj); (3)
639 * As l_wait_event() may "short-cut" execution and return without taking
640 * wait-queue spin-lock, some additional synchronization is necessary to
641 * guarantee that step (3) can begin only after (2.3) finishes.
643 * XXX nikita: some ptlrpc daemon threads have races of that sort.
646 static inline int back_to_sleep(void *arg)
651 #define LWI_ON_SIGNAL_NOOP ((void (*)(void *))(-1))
654 cfs_duration_t lwi_timeout;
655 cfs_duration_t lwi_interval;
657 int (*lwi_on_timeout)(void *);
658 void (*lwi_on_signal)(void *);
662 /* NB: LWI_TIMEOUT ignores signals completely */
663 #define LWI_TIMEOUT(time, cb, data) \
664 ((struct l_wait_info) { \
665 .lwi_timeout = time, \
666 .lwi_on_timeout = cb, \
667 .lwi_cb_data = data, \
669 .lwi_allow_intr = 0 \
672 #define LWI_TIMEOUT_INTERVAL(time, interval, cb, data) \
673 ((struct l_wait_info) { \
674 .lwi_timeout = time, \
675 .lwi_on_timeout = cb, \
676 .lwi_cb_data = data, \
677 .lwi_interval = interval, \
678 .lwi_allow_intr = 0 \
681 #define LWI_TIMEOUT_INTR(time, time_cb, sig_cb, data) \
682 ((struct l_wait_info) { \
683 .lwi_timeout = time, \
684 .lwi_on_timeout = time_cb, \
685 .lwi_on_signal = sig_cb, \
686 .lwi_cb_data = data, \
688 .lwi_allow_intr = 0 \
691 #define LWI_TIMEOUT_INTR_ALL(time, time_cb, sig_cb, data) \
692 ((struct l_wait_info) { \
693 .lwi_timeout = time, \
694 .lwi_on_timeout = time_cb, \
695 .lwi_on_signal = sig_cb, \
696 .lwi_cb_data = data, \
698 .lwi_allow_intr = 1 \
701 #define LWI_INTR(cb, data) LWI_TIMEOUT_INTR(0, NULL, cb, data)
706 * wait for @condition to become true, but no longer than timeout, specified
709 #define __l_wait_event(wq, condition, info, ret, l_add_wait) \
711 cfs_waitlink_t __wait; \
712 cfs_duration_t __timeout = info->lwi_timeout; \
713 cfs_sigset_t __blocked; \
714 int __allow_intr = info->lwi_allow_intr; \
720 cfs_waitlink_init(&__wait); \
721 l_add_wait(&wq, &__wait); \
723 /* Block all signals (just the non-fatal ones if no timeout). */ \
724 if (info->lwi_on_signal != NULL && (__timeout == 0 || __allow_intr)) \
725 __blocked = cfs_block_sigsinv(LUSTRE_FATAL_SIGS); \
727 __blocked = cfs_block_sigsinv(0); \
732 __wstate = info->lwi_on_signal != NULL && \
733 (__timeout == 0 || __allow_intr) ? \
734 CFS_TASK_INTERRUPTIBLE : CFS_TASK_UNINT; \
736 cfs_set_current_state(CFS_TASK_INTERRUPTIBLE); \
741 if (__timeout == 0) { \
742 cfs_waitq_wait(&__wait, __wstate); \
744 cfs_duration_t interval = info->lwi_interval? \
745 min_t(cfs_duration_t, \
746 info->lwi_interval,__timeout):\
748 cfs_duration_t remaining = cfs_waitq_timedwait(&__wait,\
751 __timeout = cfs_time_sub(__timeout, \
752 cfs_time_sub(interval, remaining));\
753 if (__timeout == 0) { \
754 if (info->lwi_on_timeout == NULL || \
755 info->lwi_on_timeout(info->lwi_cb_data)) { \
759 /* Take signals after the timeout expires. */ \
760 if (info->lwi_on_signal != NULL) \
761 (void)cfs_block_sigsinv(LUSTRE_FATAL_SIGS);\
767 if (cfs_signal_pending()) { \
768 if (info->lwi_on_signal != NULL && \
769 (__timeout == 0 || __allow_intr)) { \
770 if (info->lwi_on_signal != LWI_ON_SIGNAL_NOOP) \
771 info->lwi_on_signal(info->lwi_cb_data);\
775 /* We have to do this here because some signals */ \
776 /* are not blockable - ie from strace(1). */ \
777 /* In these cases we want to schedule_timeout() */ \
778 /* again, because we don't want that to return */ \
779 /* -EINTR when the RPC actually succeeded. */ \
780 /* the RECALC_SIGPENDING below will deliver the */ \
781 /* signal properly. */ \
782 cfs_clear_sigpending(); \
786 cfs_restore_sigs(__blocked); \
788 cfs_set_current_state(CFS_TASK_RUNNING); \
789 cfs_waitq_del(&wq, &__wait); \
792 #else /* !__KERNEL__ */
794 #define __l_wait_event(wq, condition, info, ret, l_add_wait) \
796 long __timeout = info->lwi_timeout; \
799 int __timed_out = 0; \
800 int __interval = obd_timeout; \
806 if (__timeout != 0) \
807 __then = time(NULL); \
809 if (__timeout && __timeout < __interval) \
810 __interval = __timeout; \
811 if (info->lwi_interval && info->lwi_interval < __interval) \
812 __interval = info->lwi_interval; \
814 while (!(condition)) { \
815 liblustre_wait_event(__interval); \
819 if (!__timed_out && info->lwi_timeout != 0) { \
820 __now = time(NULL); \
821 __timeout -= __now - __then; \
829 if (info->lwi_on_timeout == NULL || \
830 info->lwi_on_timeout(info->lwi_cb_data)) { \
838 #endif /* __KERNEL__ */
841 #define l_wait_event(wq, condition, info) \
844 struct l_wait_info *__info = (info); \
846 __l_wait_event(wq, condition, __info, \
847 __ret, cfs_waitq_add); \
851 #define l_wait_event_exclusive(wq, condition, info) \
854 struct l_wait_info *__info = (info); \
856 __l_wait_event(wq, condition, __info, \
857 __ret, cfs_waitq_add_exclusive); \
861 #define l_wait_event_exclusive_head(wq, condition, info) \
864 struct l_wait_info *__info = (info); \
866 __l_wait_event(wq, condition, __info, \
867 __ret, cfs_waitq_add_exclusive_head); \
871 #define l_wait_condition(wq, condition) \
873 struct l_wait_info lwi = { 0 }; \
874 l_wait_event(wq, condition, &lwi); \
877 #define l_wait_condition_exclusive(wq, condition) \
879 struct l_wait_info lwi = { 0 }; \
880 l_wait_event_exclusive(wq, condition, &lwi); \
883 #define l_wait_condition_exclusive_head(wq, condition) \
885 struct l_wait_info lwi = { 0 }; \
886 l_wait_event_exclusive_head(wq, condition, &lwi); \
890 #define LIBLUSTRE_CLIENT (0)
892 #define LIBLUSTRE_CLIENT (1)
897 #endif /* _LUSTRE_LIB_H */