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>
71 #ifdef HAVE_SERVER_SUPPORT
72 void target_client_add_cb(struct obd_device *obd, __u64 transno, void *cb_data,
74 int target_handle_connect(struct ptlrpc_request *req);
75 int target_handle_disconnect(struct ptlrpc_request *req);
76 void target_destroy_export(struct obd_export *exp);
77 int target_handle_ping(struct ptlrpc_request *req);
78 void target_committed_to_req(struct ptlrpc_request *req);
79 void target_cancel_recovery_timer(struct obd_device *obd);
80 void target_stop_recovery_thread(struct obd_device *obd);
81 void target_cleanup_recovery(struct obd_device *obd);
82 int target_queue_recovery_request(struct ptlrpc_request *req,
83 struct obd_device *obd);
84 int target_bulk_io(struct obd_export *exp, struct ptlrpc_bulk_desc *desc,
85 struct l_wait_info *lwi);
88 int target_pack_pool_reply(struct ptlrpc_request *req);
89 int do_set_info_async(struct obd_import *imp,
90 int opcode, int version,
91 obd_count keylen, void *key,
92 obd_count vallen, void *val,
93 struct ptlrpc_request_set *set);
95 #define OBD_RECOVERY_MAX_TIME (obd_timeout * 18) /* b13079 */
96 #define OBD_MAX_IOCTL_BUFFER CONFIG_LUSTRE_OBD_MAX_IOCTL_BUFFER
98 void target_send_reply(struct ptlrpc_request *req, int rc, int fail_id);
102 int client_sanobd_setup(struct obd_device *obddev, struct lustre_cfg* lcfg);
103 struct client_obd *client_conn2cli(struct lustre_handle *conn);
106 struct obd_client_handle {
107 struct lustre_handle och_fh;
108 struct lu_fid och_fid;
109 struct md_open_data *och_mod;
110 struct lustre_handle och_lease_handle; /* open lock for lease */
114 #define OBD_CLIENT_HANDLE_MAGIC 0xd15ea5ed
117 void statfs_pack(struct obd_statfs *osfs, struct kstatfs *sfs);
118 void statfs_unpack(struct kstatfs *sfs, struct obd_statfs *osfs);
123 struct task_struct *l_owner;
124 struct semaphore l_sem;
128 void l_lock_init(struct lustre_lock *);
129 void l_lock(struct lustre_lock *);
130 void l_unlock(struct lustre_lock *);
131 int l_has_lock(struct lustre_lock *);
137 ECHO_MD_CREATE = 1, /* Open/Create file on MDT */
138 ECHO_MD_MKDIR = 2, /* Mkdir on MDT */
139 ECHO_MD_DESTROY = 3, /* Unlink file on MDT */
140 ECHO_MD_RMDIR = 4, /* Rmdir on MDT */
141 ECHO_MD_LOOKUP = 5, /* Lookup on MDT */
142 ECHO_MD_GETATTR = 6, /* Getattr on MDT */
143 ECHO_MD_SETATTR = 7, /* Setattr on MDT */
144 ECHO_MD_ALLOC_FID = 8, /* Get FIDs from MDT */
150 #define OBD_IOCTL_VERSION 0x00010004
152 struct obd_ioctl_data {
169 struct obdo ioc_obdo1;
170 struct obdo ioc_obdo2;
181 /* buffers the kernel will treat as user pointers */
187 /* inline buffers for various arguments */
200 struct obd_ioctl_hdr {
205 static inline int obd_ioctl_packlen(struct obd_ioctl_data *data)
207 int len = cfs_size_round(sizeof(struct obd_ioctl_data));
208 len += cfs_size_round(data->ioc_inllen1);
209 len += cfs_size_round(data->ioc_inllen2);
210 len += cfs_size_round(data->ioc_inllen3);
211 len += cfs_size_round(data->ioc_inllen4);
216 static inline int obd_ioctl_is_invalid(struct obd_ioctl_data *data)
218 if (data->ioc_len > (1<<30)) {
219 CERROR("OBD ioctl: ioc_len larger than 1<<30\n");
222 if (data->ioc_inllen1 > (1<<30)) {
223 CERROR("OBD ioctl: ioc_inllen1 larger than 1<<30\n");
226 if (data->ioc_inllen2 > (1<<30)) {
227 CERROR("OBD ioctl: ioc_inllen2 larger than 1<<30\n");
230 if (data->ioc_inllen3 > (1<<30)) {
231 CERROR("OBD ioctl: ioc_inllen3 larger than 1<<30\n");
234 if (data->ioc_inllen4 > (1<<30)) {
235 CERROR("OBD ioctl: ioc_inllen4 larger than 1<<30\n");
238 if (data->ioc_inlbuf1 && !data->ioc_inllen1) {
239 CERROR("OBD ioctl: inlbuf1 pointer but 0 length\n");
242 if (data->ioc_inlbuf2 && !data->ioc_inllen2) {
243 CERROR("OBD ioctl: inlbuf2 pointer but 0 length\n");
246 if (data->ioc_inlbuf3 && !data->ioc_inllen3) {
247 CERROR("OBD ioctl: inlbuf3 pointer but 0 length\n");
250 if (data->ioc_inlbuf4 && !data->ioc_inllen4) {
251 CERROR("OBD ioctl: inlbuf4 pointer but 0 length\n");
254 if (data->ioc_pbuf1 && !data->ioc_plen1) {
255 CERROR("OBD ioctl: pbuf1 pointer but 0 length\n");
258 if (data->ioc_pbuf2 && !data->ioc_plen2) {
259 CERROR("OBD ioctl: pbuf2 pointer but 0 length\n");
262 if (data->ioc_plen1 && !data->ioc_pbuf1) {
263 CERROR("OBD ioctl: plen1 set but NULL pointer\n");
266 if (data->ioc_plen2 && !data->ioc_pbuf2) {
267 CERROR("OBD ioctl: plen2 set but NULL pointer\n");
270 if (obd_ioctl_packlen(data) > data->ioc_len) {
271 CERROR("OBD ioctl: packlen exceeds ioc_len (%d > %d)\n",
272 obd_ioctl_packlen(data), data->ioc_len);
279 static inline int obd_ioctl_pack(struct obd_ioctl_data *data, char **pbuf,
283 struct obd_ioctl_data *overlay;
284 data->ioc_len = obd_ioctl_packlen(data);
285 data->ioc_version = OBD_IOCTL_VERSION;
287 if (*pbuf && data->ioc_len > max) {
288 fprintf(stderr, "pbuf %p ioc_len %u max %d\n", *pbuf,
293 *pbuf = malloc(data->ioc_len);
297 overlay = (struct obd_ioctl_data *)*pbuf;
298 memcpy(*pbuf, data, sizeof(*data));
300 ptr = overlay->ioc_bulk;
301 if (data->ioc_inlbuf1)
302 LOGL(data->ioc_inlbuf1, data->ioc_inllen1, ptr);
303 if (data->ioc_inlbuf2)
304 LOGL(data->ioc_inlbuf2, data->ioc_inllen2, ptr);
305 if (data->ioc_inlbuf3)
306 LOGL(data->ioc_inlbuf3, data->ioc_inllen3, ptr);
307 if (data->ioc_inlbuf4)
308 LOGL(data->ioc_inlbuf4, data->ioc_inllen4, ptr);
309 if (obd_ioctl_is_invalid(overlay)) {
310 fprintf(stderr, "ioc_len %u max %d\n",
318 static inline int obd_ioctl_unpack(struct obd_ioctl_data *data, char *pbuf,
322 struct obd_ioctl_data *overlay;
326 overlay = (struct obd_ioctl_data *)pbuf;
328 /* Preserve the caller's buffer pointers */
329 overlay->ioc_inlbuf1 = data->ioc_inlbuf1;
330 overlay->ioc_inlbuf2 = data->ioc_inlbuf2;
331 overlay->ioc_inlbuf3 = data->ioc_inlbuf3;
332 overlay->ioc_inlbuf4 = data->ioc_inlbuf4;
334 memcpy(data, pbuf, sizeof(*data));
336 ptr = overlay->ioc_bulk;
337 if (data->ioc_inlbuf1)
338 LOGU(data->ioc_inlbuf1, data->ioc_inllen1, ptr);
339 if (data->ioc_inlbuf2)
340 LOGU(data->ioc_inlbuf2, data->ioc_inllen2, ptr);
341 if (data->ioc_inlbuf3)
342 LOGU(data->ioc_inlbuf3, data->ioc_inllen3, ptr);
343 if (data->ioc_inlbuf4)
344 LOGU(data->ioc_inlbuf4, data->ioc_inllen4, ptr);
350 #include <obd_support.h>
353 /* function defined in lustre/obdclass/<platform>/<platform>-module.c */
354 int obd_ioctl_getdata(char **buf, int *len, void *arg);
355 int obd_ioctl_popdata(void *arg, void *data, int len);
357 /* buffer MUST be at least the size of obd_ioctl_hdr */
358 static inline int obd_ioctl_getdata(char **buf, int *len, void *arg)
360 struct obd_ioctl_hdr hdr;
361 struct obd_ioctl_data *data;
366 err = copy_from_user(&hdr, (void *)arg, sizeof(hdr));
370 if (hdr.ioc_version != OBD_IOCTL_VERSION) {
371 CERROR("Version mismatch kernel vs application\n");
375 if (hdr.ioc_len > OBD_MAX_IOCTL_BUFFER) {
376 CERROR("User buffer len %d exceeds %d max buffer\n",
377 hdr.ioc_len, OBD_MAX_IOCTL_BUFFER);
381 if (hdr.ioc_len < sizeof(struct obd_ioctl_data)) {
382 CERROR("User buffer too small for ioctl (%d)\n", hdr.ioc_len);
386 OBD_ALLOC_LARGE(*buf, hdr.ioc_len);
388 CERROR("Cannot allocate control buffer of len %d\n",
393 data = (struct obd_ioctl_data *)*buf;
395 err = copy_from_user(*buf, (void *)arg, hdr.ioc_len);
397 OBD_FREE_LARGE(*buf, hdr.ioc_len);
401 if (obd_ioctl_is_invalid(data)) {
402 CERROR("ioctl not correctly formatted\n");
403 OBD_FREE_LARGE(*buf, hdr.ioc_len);
407 if (data->ioc_inllen1) {
408 data->ioc_inlbuf1 = &data->ioc_bulk[0];
409 offset += cfs_size_round(data->ioc_inllen1);
412 if (data->ioc_inllen2) {
413 data->ioc_inlbuf2 = &data->ioc_bulk[0] + offset;
414 offset += cfs_size_round(data->ioc_inllen2);
417 if (data->ioc_inllen3) {
418 data->ioc_inlbuf3 = &data->ioc_bulk[0] + offset;
419 offset += cfs_size_round(data->ioc_inllen3);
422 if (data->ioc_inllen4) {
423 data->ioc_inlbuf4 = &data->ioc_bulk[0] + offset;
429 static inline int obd_ioctl_popdata(void *arg, void *data, int len)
431 int err = copy_to_user(arg, data, len);
438 static inline void obd_ioctl_freedata(char *buf, int len)
442 OBD_FREE_LARGE(buf, len);
448 * BSD ioctl description:
449 * #define IOC_V1 _IOR(g, n1, long)
450 * #define IOC_V2 _IOW(g, n2, long)
452 * ioctl(f, IOC_V1, arg);
453 * arg will be treated as a long value,
455 * ioctl(f, IOC_V2, arg)
456 * arg will be treated as a pointer, bsd will call
457 * copyin(buf, arg, sizeof(long))
459 * To make BSD ioctl handles argument correctly and simplely,
460 * we change _IOR to _IOWR so BSD will copyin obd_ioctl_data
461 * for us. Does this change affect Linux? (XXX Liang)
463 #define OBD_IOC_CREATE _IOWR('f', 101, OBD_IOC_DATA_TYPE)
464 #define OBD_IOC_DESTROY _IOW ('f', 104, OBD_IOC_DATA_TYPE)
465 #define OBD_IOC_PREALLOCATE _IOWR('f', 105, OBD_IOC_DATA_TYPE)
467 #define OBD_IOC_SETATTR _IOW ('f', 107, OBD_IOC_DATA_TYPE)
468 #define OBD_IOC_GETATTR _IOWR ('f', 108, OBD_IOC_DATA_TYPE)
469 #define OBD_IOC_READ _IOWR('f', 109, OBD_IOC_DATA_TYPE)
470 #define OBD_IOC_WRITE _IOWR('f', 110, OBD_IOC_DATA_TYPE)
473 #define OBD_IOC_STATFS _IOWR('f', 113, OBD_IOC_DATA_TYPE)
474 #define OBD_IOC_SYNC _IOW ('f', 114, OBD_IOC_DATA_TYPE)
475 #define OBD_IOC_READ2 _IOWR('f', 115, OBD_IOC_DATA_TYPE)
476 #define OBD_IOC_FORMAT _IOWR('f', 116, OBD_IOC_DATA_TYPE)
477 #define OBD_IOC_PARTITION _IOWR('f', 117, OBD_IOC_DATA_TYPE)
478 #define OBD_IOC_COPY _IOWR('f', 120, OBD_IOC_DATA_TYPE)
479 #define OBD_IOC_MIGR _IOWR('f', 121, OBD_IOC_DATA_TYPE)
480 #define OBD_IOC_PUNCH _IOWR('f', 122, OBD_IOC_DATA_TYPE)
482 #define OBD_IOC_MODULE_DEBUG _IOWR('f', 124, OBD_IOC_DATA_TYPE)
483 #define OBD_IOC_BRW_READ _IOWR('f', 125, OBD_IOC_DATA_TYPE)
484 #define OBD_IOC_BRW_WRITE _IOWR('f', 126, OBD_IOC_DATA_TYPE)
485 #define OBD_IOC_NAME2DEV _IOWR('f', 127, OBD_IOC_DATA_TYPE)
486 #define OBD_IOC_UUID2DEV _IOWR('f', 130, OBD_IOC_DATA_TYPE)
488 #define OBD_IOC_GETNAME _IOWR('f', 131, OBD_IOC_DATA_TYPE)
489 #define OBD_IOC_GETMDNAME _IOR('f', 131, char[MAX_OBD_NAME])
490 #define OBD_IOC_GETDTNAME OBD_IOC_GETNAME
492 #define OBD_IOC_LOV_GET_CONFIG _IOWR('f', 132, OBD_IOC_DATA_TYPE)
493 #define OBD_IOC_CLIENT_RECOVER _IOW ('f', 133, OBD_IOC_DATA_TYPE)
494 #define OBD_IOC_PING_TARGET _IOW ('f', 136, OBD_IOC_DATA_TYPE)
496 #define OBD_IOC_DEC_FS_USE_COUNT _IO ('f', 139 )
497 #define OBD_IOC_NO_TRANSNO _IOW ('f', 140, OBD_IOC_DATA_TYPE)
498 #define OBD_IOC_SET_READONLY _IOW ('f', 141, OBD_IOC_DATA_TYPE)
499 #define OBD_IOC_ABORT_RECOVERY _IOR ('f', 142, OBD_IOC_DATA_TYPE)
501 #define OBD_IOC_ROOT_SQUASH _IOWR('f', 143, OBD_IOC_DATA_TYPE)
503 #define OBD_GET_VERSION _IOWR ('f', 144, OBD_IOC_DATA_TYPE)
505 #define OBD_IOC_GSS_SUPPORT _IOWR('f', 145, OBD_IOC_DATA_TYPE)
507 #define OBD_IOC_CLOSE_UUID _IOWR ('f', 147, OBD_IOC_DATA_TYPE)
509 #define OBD_IOC_CHANGELOG_SEND _IOW ('f', 148, OBD_IOC_DATA_TYPE)
510 #define OBD_IOC_GETDEVICE _IOWR ('f', 149, OBD_IOC_DATA_TYPE)
511 #define OBD_IOC_FID2PATH _IOWR ('f', 150, OBD_IOC_DATA_TYPE)
512 /* see also <lustre/lustre_user.h> for ioctls 151-153 */
513 /* OBD_IOC_LOV_SETSTRIPE: See also LL_IOC_LOV_SETSTRIPE */
514 #define OBD_IOC_LOV_SETSTRIPE _IOW ('f', 154, OBD_IOC_DATA_TYPE)
515 /* OBD_IOC_LOV_GETSTRIPE: See also LL_IOC_LOV_GETSTRIPE */
516 #define OBD_IOC_LOV_GETSTRIPE _IOW ('f', 155, OBD_IOC_DATA_TYPE)
517 /* OBD_IOC_LOV_SETEA: See also LL_IOC_LOV_SETEA */
518 #define OBD_IOC_LOV_SETEA _IOW ('f', 156, OBD_IOC_DATA_TYPE)
519 /* see <lustre/lustre_user.h> for ioctls 157-159 */
520 /* OBD_IOC_QUOTACHECK: See also LL_IOC_QUOTACHECK */
521 #define OBD_IOC_QUOTACHECK _IOW ('f', 160, int)
522 /* OBD_IOC_POLL_QUOTACHECK: See also LL_IOC_POLL_QUOTACHECK */
523 #define OBD_IOC_POLL_QUOTACHECK _IOR ('f', 161, struct if_quotacheck *)
524 /* OBD_IOC_QUOTACTL: See also LL_IOC_QUOTACTL */
525 #define OBD_IOC_QUOTACTL _IOWR('f', 162, struct if_quotactl)
526 /* see also <lustre/lustre_user.h> for ioctls 163-176 */
527 #define OBD_IOC_CHANGELOG_REG _IOW ('f', 177, struct obd_ioctl_data)
528 #define OBD_IOC_CHANGELOG_DEREG _IOW ('f', 178, struct obd_ioctl_data)
529 #define OBD_IOC_CHANGELOG_CLEAR _IOW ('f', 179, struct obd_ioctl_data)
530 #define OBD_IOC_RECORD _IOWR('f', 180, OBD_IOC_DATA_TYPE)
531 #define OBD_IOC_ENDRECORD _IOWR('f', 181, OBD_IOC_DATA_TYPE)
532 #define OBD_IOC_PARSE _IOWR('f', 182, OBD_IOC_DATA_TYPE)
533 #define OBD_IOC_DORECORD _IOWR('f', 183, OBD_IOC_DATA_TYPE)
534 #define OBD_IOC_PROCESS_CFG _IOWR('f', 184, OBD_IOC_DATA_TYPE)
535 #define OBD_IOC_DUMP_LOG _IOWR('f', 185, OBD_IOC_DATA_TYPE)
536 #define OBD_IOC_CLEAR_LOG _IOWR('f', 186, OBD_IOC_DATA_TYPE)
537 #define OBD_IOC_PARAM _IOW ('f', 187, OBD_IOC_DATA_TYPE)
538 #define OBD_IOC_POOL _IOWR('f', 188, OBD_IOC_DATA_TYPE)
539 #define OBD_IOC_REPLACE_NIDS _IOWR('f', 189, OBD_IOC_DATA_TYPE)
541 #define OBD_IOC_CATLOGLIST _IOWR('f', 190, OBD_IOC_DATA_TYPE)
542 #define OBD_IOC_LLOG_INFO _IOWR('f', 191, OBD_IOC_DATA_TYPE)
543 #define OBD_IOC_LLOG_PRINT _IOWR('f', 192, OBD_IOC_DATA_TYPE)
544 #define OBD_IOC_LLOG_CANCEL _IOWR('f', 193, OBD_IOC_DATA_TYPE)
545 #define OBD_IOC_LLOG_REMOVE _IOWR('f', 194, OBD_IOC_DATA_TYPE)
546 #define OBD_IOC_LLOG_CHECK _IOWR('f', 195, OBD_IOC_DATA_TYPE)
547 /* OBD_IOC_LLOG_CATINFO is deprecated */
548 #define OBD_IOC_LLOG_CATINFO _IOWR('f', 196, OBD_IOC_DATA_TYPE)
549 #define OBD_IOC_NODEMAP _IOWR('f', 197, 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)
560 #define OBD_IOC_ECHO_MD _IOR('f', 221, struct obd_ioctl_data)
561 #define OBD_IOC_ECHO_ALLOC_SEQ _IOWR('f', 222, struct obd_ioctl_data)
562 #define OBD_IOC_START_LFSCK _IOWR('f', 230, OBD_IOC_DATA_TYPE)
563 #define OBD_IOC_STOP_LFSCK _IOW('f', 231, OBD_IOC_DATA_TYPE)
565 /* XXX _IOWR('f', 250, long) has been defined in
566 * libcfs/include/libcfs/libcfs_private.h for debug, don't use it
569 /* Until such time as we get_info the per-stripe maximum from the OST,
570 * we define this to be 2T - 4k, which is the ext3 maxbytes. */
571 #define LUSTRE_STRIPE_MAXBYTES 0x1fffffff000ULL
573 /* Special values for remove LOV EA from disk */
574 #define LOVEA_DELETE_VALUES(size, count, offset) (size == 0 && count == 0 && \
575 offset == (typeof(offset))(-1))
577 #define LMVEA_DELETE_VALUES(count, offset) ((count) == 0 && \
578 (offset) == (typeof(offset))(-1))
579 /* #define POISON_BULK 0 */
582 * l_wait_event is a flexible sleeping function, permitting simple caller
583 * configuration of interrupt and timeout sensitivity along with actions to
584 * be performed in the event of either exception.
586 * The first form of usage looks like this:
588 * struct l_wait_info lwi = LWI_TIMEOUT_INTR(timeout, timeout_handler,
589 * intr_handler, callback_data);
590 * rc = l_wait_event(waitq, condition, &lwi);
592 * l_wait_event() makes the current process wait on 'waitq' until 'condition'
593 * is TRUE or a "killable" signal (SIGTERM, SIKGILL, SIGINT) is pending. It
594 * returns 0 to signify 'condition' is TRUE, but if a signal wakes it before
595 * 'condition' becomes true, it optionally calls the specified 'intr_handler'
596 * if not NULL, and returns -EINTR.
598 * If a non-zero timeout is specified, signals are ignored until the timeout
599 * has expired. At this time, if 'timeout_handler' is not NULL it is called.
600 * If it returns FALSE l_wait_event() continues to wait as described above with
601 * signals enabled. Otherwise it returns -ETIMEDOUT.
603 * LWI_INTR(intr_handler, callback_data) is shorthand for
604 * LWI_TIMEOUT_INTR(0, NULL, intr_handler, callback_data)
606 * The second form of usage looks like this:
608 * struct l_wait_info lwi = LWI_TIMEOUT(timeout, timeout_handler);
609 * rc = l_wait_event(waitq, condition, &lwi);
611 * This form is the same as the first except that it COMPLETELY IGNORES
612 * SIGNALS. The caller must therefore beware that if 'timeout' is zero, or if
613 * 'timeout_handler' is not NULL and returns FALSE, then the ONLY thing that
614 * can unblock the current process is 'condition' becoming TRUE.
616 * Another form of usage is:
617 * struct l_wait_info lwi = LWI_TIMEOUT_INTERVAL(timeout, interval,
619 * rc = l_wait_event(waitq, condition, &lwi);
620 * This is the same as previous case, but condition is checked once every
621 * 'interval' jiffies (if non-zero).
623 * Subtle synchronization point: this macro does *not* necessary takes
624 * wait-queue spin-lock before returning, and, hence, following idiom is safe
625 * ONLY when caller provides some external locking:
629 * l_wait_event(&obj->wq, ....); (1)
631 * wake_up(&obj->wq): (2)
632 * spin_lock(&q->lock); (2.1)
633 * __wake_up_common(q, ...); (2.2)
634 * spin_unlock(&q->lock, flags); (2.3)
636 * OBD_FREE_PTR(obj); (3)
638 * As l_wait_event() may "short-cut" execution and return without taking
639 * wait-queue spin-lock, some additional synchronization is necessary to
640 * guarantee that step (3) can begin only after (2.3) finishes.
642 * XXX nikita: some ptlrpc daemon threads have races of that sort.
645 static inline int back_to_sleep(void *arg)
650 #define LWI_ON_SIGNAL_NOOP ((void (*)(void *))(-1))
653 cfs_duration_t lwi_timeout;
654 cfs_duration_t lwi_interval;
656 int (*lwi_on_timeout)(void *);
657 void (*lwi_on_signal)(void *);
661 /* NB: LWI_TIMEOUT ignores signals completely */
662 #define LWI_TIMEOUT(time, cb, data) \
663 ((struct l_wait_info) { \
664 .lwi_timeout = time, \
665 .lwi_on_timeout = cb, \
666 .lwi_cb_data = data, \
668 .lwi_allow_intr = 0 \
671 #define LWI_TIMEOUT_INTERVAL(time, interval, cb, data) \
672 ((struct l_wait_info) { \
673 .lwi_timeout = time, \
674 .lwi_on_timeout = cb, \
675 .lwi_cb_data = data, \
676 .lwi_interval = interval, \
677 .lwi_allow_intr = 0 \
680 #define LWI_TIMEOUT_INTR(time, time_cb, sig_cb, data) \
681 ((struct l_wait_info) { \
682 .lwi_timeout = time, \
683 .lwi_on_timeout = time_cb, \
684 .lwi_on_signal = sig_cb, \
685 .lwi_cb_data = data, \
687 .lwi_allow_intr = 0 \
690 #define LWI_TIMEOUT_INTR_ALL(time, time_cb, sig_cb, data) \
691 ((struct l_wait_info) { \
692 .lwi_timeout = time, \
693 .lwi_on_timeout = time_cb, \
694 .lwi_on_signal = sig_cb, \
695 .lwi_cb_data = data, \
697 .lwi_allow_intr = 1 \
700 #define LWI_INTR(cb, data) LWI_TIMEOUT_INTR(0, NULL, cb, data)
705 * wait for @condition to become true, but no longer than timeout, specified
708 #define __l_wait_event(wq, condition, info, ret, l_add_wait) \
710 wait_queue_t __wait; \
711 cfs_duration_t __timeout = info->lwi_timeout; \
712 sigset_t __blocked; \
713 int __allow_intr = info->lwi_allow_intr; \
719 init_waitqueue_entry_current(&__wait); \
720 l_add_wait(&wq, &__wait); \
722 /* Block all signals (just the non-fatal ones if no timeout). */ \
723 if (info->lwi_on_signal != NULL && (__timeout == 0 || __allow_intr)) \
724 __blocked = cfs_block_sigsinv(LUSTRE_FATAL_SIGS); \
726 __blocked = cfs_block_sigsinv(0); \
731 __wstate = info->lwi_on_signal != NULL && \
732 (__timeout == 0 || __allow_intr) ? \
733 TASK_INTERRUPTIBLE : TASK_UNINTERRUPTIBLE; \
735 set_current_state(TASK_INTERRUPTIBLE); \
740 if (__timeout == 0) { \
741 waitq_wait(&__wait, __wstate); \
743 cfs_duration_t interval = info->lwi_interval? \
744 min_t(cfs_duration_t, \
745 info->lwi_interval,__timeout):\
747 cfs_duration_t remaining = waitq_timedwait(&__wait, \
750 __timeout = cfs_time_sub(__timeout, \
751 cfs_time_sub(interval, remaining));\
752 if (__timeout == 0) { \
753 if (info->lwi_on_timeout == NULL || \
754 info->lwi_on_timeout(info->lwi_cb_data)) { \
758 /* Take signals after the timeout expires. */ \
759 if (info->lwi_on_signal != NULL) \
760 (void)cfs_block_sigsinv(LUSTRE_FATAL_SIGS);\
766 if (cfs_signal_pending()) { \
767 if (info->lwi_on_signal != NULL && \
768 (__timeout == 0 || __allow_intr)) { \
769 if (info->lwi_on_signal != LWI_ON_SIGNAL_NOOP) \
770 info->lwi_on_signal(info->lwi_cb_data);\
774 /* We have to do this here because some signals */ \
775 /* are not blockable - ie from strace(1). */ \
776 /* In these cases we want to schedule_timeout() */ \
777 /* again, because we don't want that to return */ \
778 /* -EINTR when the RPC actually succeeded. */ \
779 /* the recalc_sigpending() below will deliver the */ \
780 /* signal properly. */ \
781 cfs_clear_sigpending(); \
785 cfs_restore_sigs(__blocked); \
787 set_current_state(TASK_RUNNING); \
788 remove_wait_queue(&wq, &__wait); \
791 #else /* !__KERNEL__ */
793 #define __l_wait_event(wq, condition, info, ret, l_add_wait) \
795 long __timeout = info->lwi_timeout; \
798 int __timed_out = 0; \
799 int __interval = obd_timeout; \
805 if (__timeout != 0) \
806 __then = time(NULL); \
808 if (__timeout && __timeout < __interval) \
809 __interval = __timeout; \
810 if (info->lwi_interval && info->lwi_interval < __interval) \
811 __interval = info->lwi_interval; \
813 while (!(condition)) { \
814 liblustre_wait_event(__interval); \
818 if (!__timed_out && info->lwi_timeout != 0) { \
819 __now = time(NULL); \
820 __timeout -= __now - __then; \
828 if (info->lwi_on_timeout == NULL || \
829 info->lwi_on_timeout(info->lwi_cb_data)) { \
837 #endif /* __KERNEL__ */
840 #define l_wait_event(wq, condition, info) \
843 struct l_wait_info *__info = (info); \
845 __l_wait_event(wq, condition, __info, \
846 __ret, add_wait_queue); \
850 #define l_wait_event_exclusive(wq, condition, info) \
853 struct l_wait_info *__info = (info); \
855 __l_wait_event(wq, condition, __info, \
856 __ret, add_wait_queue_exclusive); \
860 #define l_wait_event_exclusive_head(wq, condition, info) \
863 struct l_wait_info *__info = (info); \
865 __l_wait_event(wq, condition, __info, \
866 __ret, add_wait_queue_exclusive_head); \
870 #define l_wait_condition(wq, condition) \
872 struct l_wait_info lwi = { 0 }; \
873 l_wait_event(wq, condition, &lwi); \
876 #define l_wait_condition_exclusive(wq, condition) \
878 struct l_wait_info lwi = { 0 }; \
879 l_wait_event_exclusive(wq, condition, &lwi); \
882 #define l_wait_condition_exclusive_head(wq, condition) \
884 struct l_wait_info lwi = { 0 }; \
885 l_wait_event_exclusive_head(wq, condition, &lwi); \
889 #define LIBLUSTRE_CLIENT (0)
891 #define LIBLUSTRE_CLIENT (1)
896 #endif /* _LUSTRE_LIB_H */