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) 2002, 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.
33 /** Implementation of client-side PortalRPC interfaces */
35 #define DEBUG_SUBSYSTEM S_RPC
37 #include <linux/delay.h>
38 #include <obd_support.h>
39 #include <obd_class.h>
40 #include <lustre_lib.h>
41 #include <lustre_ha.h>
42 #include <lustre_import.h>
43 #include <lustre_req_layout.h>
45 #include "ptlrpc_internal.h"
47 const struct ptlrpc_bulk_frag_ops ptlrpc_bulk_kiov_pin_ops = {
48 .add_kiov_frag = ptlrpc_prep_bulk_page_pin,
49 .release_frags = ptlrpc_release_bulk_page_pin,
51 EXPORT_SYMBOL(ptlrpc_bulk_kiov_pin_ops);
53 const struct ptlrpc_bulk_frag_ops ptlrpc_bulk_kiov_nopin_ops = {
54 .add_kiov_frag = ptlrpc_prep_bulk_page_nopin,
55 .release_frags = ptlrpc_release_bulk_noop,
57 EXPORT_SYMBOL(ptlrpc_bulk_kiov_nopin_ops);
59 const struct ptlrpc_bulk_frag_ops ptlrpc_bulk_kvec_ops = {
60 .add_iov_frag = ptlrpc_prep_bulk_frag,
62 EXPORT_SYMBOL(ptlrpc_bulk_kvec_ops);
64 static int ptlrpc_send_new_req(struct ptlrpc_request *req);
65 static int ptlrpcd_check_work(struct ptlrpc_request *req);
66 static int ptlrpc_unregister_reply(struct ptlrpc_request *request, int async);
69 * Initialize passed in client structure \a cl.
71 void ptlrpc_init_client(int req_portal, int rep_portal, char *name,
72 struct ptlrpc_client *cl)
74 cl->cli_request_portal = req_portal;
75 cl->cli_reply_portal = rep_portal;
78 EXPORT_SYMBOL(ptlrpc_init_client);
81 * Return PortalRPC connection for remore uud \a uuid
83 struct ptlrpc_connection *ptlrpc_uuid_to_connection(struct obd_uuid *uuid,
84 lnet_nid_t nid4refnet)
86 struct ptlrpc_connection *c;
88 struct lnet_process_id peer;
91 /* ptlrpc_uuid_to_peer() initializes its 2nd parameter
92 * before accessing its values. */
93 /* coverity[uninit_use_in_call] */
94 peer.nid = nid4refnet;
95 err = ptlrpc_uuid_to_peer(uuid, &peer, &self);
97 CNETERR("cannot find peer %s!\n", uuid->uuid);
101 c = ptlrpc_connection_get(peer, self, uuid);
103 memcpy(c->c_remote_uuid.uuid,
104 uuid->uuid, sizeof(c->c_remote_uuid.uuid));
107 CDEBUG(D_INFO, "%s -> %p\n", uuid->uuid, c);
113 * Allocate and initialize new bulk descriptor on the sender.
114 * Returns pointer to the descriptor or NULL on error.
116 struct ptlrpc_bulk_desc *ptlrpc_new_bulk(unsigned nfrags, unsigned max_brw,
117 enum ptlrpc_bulk_op_type type,
119 const struct ptlrpc_bulk_frag_ops *ops)
121 struct ptlrpc_bulk_desc *desc;
124 /* ensure that only one of KIOV or IOVEC is set but not both */
125 LASSERT((ptlrpc_is_bulk_desc_kiov(type) &&
126 ops->add_kiov_frag != NULL) ||
127 (ptlrpc_is_bulk_desc_kvec(type) &&
128 ops->add_iov_frag != NULL));
133 if (type & PTLRPC_BULK_BUF_KIOV) {
134 OBD_ALLOC_LARGE(GET_KIOV(desc),
135 nfrags * sizeof(*GET_KIOV(desc)));
136 if (GET_KIOV(desc) == NULL)
139 OBD_ALLOC_LARGE(GET_KVEC(desc),
140 nfrags * sizeof(*GET_KVEC(desc)));
141 if (GET_KVEC(desc) == NULL)
145 spin_lock_init(&desc->bd_lock);
146 init_waitqueue_head(&desc->bd_waitq);
147 desc->bd_max_iov = nfrags;
148 desc->bd_iov_count = 0;
149 desc->bd_portal = portal;
150 desc->bd_type = type;
151 desc->bd_md_count = 0;
152 desc->bd_frag_ops = (struct ptlrpc_bulk_frag_ops *) ops;
153 LASSERT(max_brw > 0);
154 desc->bd_md_max_brw = min(max_brw, PTLRPC_BULK_OPS_COUNT);
155 /* PTLRPC_BULK_OPS_COUNT is the compile-time transfer limit for this
156 * node. Negotiated ocd_brw_size will always be <= this number. */
157 for (i = 0; i < PTLRPC_BULK_OPS_COUNT; i++)
158 LNetInvalidateMDHandle(&desc->bd_mds[i]);
167 * Prepare bulk descriptor for specified outgoing request \a req that
168 * can fit \a nfrags * pages. \a type is bulk type. \a portal is where
169 * the bulk to be sent. Used on client-side.
170 * Returns pointer to newly allocatrd initialized bulk descriptor or NULL on
173 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk_imp(struct ptlrpc_request *req,
174 unsigned nfrags, unsigned max_brw,
177 const struct ptlrpc_bulk_frag_ops
180 struct obd_import *imp = req->rq_import;
181 struct ptlrpc_bulk_desc *desc;
184 LASSERT(ptlrpc_is_bulk_op_passive(type));
186 desc = ptlrpc_new_bulk(nfrags, max_brw, type, portal, ops);
190 desc->bd_import_generation = req->rq_import_generation;
191 desc->bd_import = class_import_get(imp);
194 desc->bd_cbid.cbid_fn = client_bulk_callback;
195 desc->bd_cbid.cbid_arg = desc;
197 /* This makes req own desc, and free it when she frees herself */
202 EXPORT_SYMBOL(ptlrpc_prep_bulk_imp);
204 void __ptlrpc_prep_bulk_page(struct ptlrpc_bulk_desc *desc,
205 struct page *page, int pageoffset, int len,
210 LASSERT(desc->bd_iov_count < desc->bd_max_iov);
211 LASSERT(page != NULL);
212 LASSERT(pageoffset >= 0);
214 LASSERT(pageoffset + len <= PAGE_SIZE);
215 LASSERT(ptlrpc_is_bulk_desc_kiov(desc->bd_type));
217 kiov = &BD_GET_KIOV(desc, desc->bd_iov_count);
224 kiov->kiov_page = page;
225 kiov->kiov_offset = pageoffset;
226 kiov->kiov_len = len;
228 desc->bd_iov_count++;
230 EXPORT_SYMBOL(__ptlrpc_prep_bulk_page);
232 int ptlrpc_prep_bulk_frag(struct ptlrpc_bulk_desc *desc,
238 LASSERT(desc->bd_iov_count < desc->bd_max_iov);
239 LASSERT(frag != NULL);
241 LASSERT(ptlrpc_is_bulk_desc_kvec(desc->bd_type));
243 iovec = &BD_GET_KVEC(desc, desc->bd_iov_count);
247 iovec->iov_base = frag;
248 iovec->iov_len = len;
250 desc->bd_iov_count++;
252 RETURN(desc->bd_nob);
254 EXPORT_SYMBOL(ptlrpc_prep_bulk_frag);
256 void ptlrpc_free_bulk(struct ptlrpc_bulk_desc *desc)
260 LASSERT(desc != NULL);
261 LASSERT(desc->bd_iov_count != LI_POISON); /* not freed already */
262 LASSERT(desc->bd_md_count == 0); /* network hands off */
263 LASSERT((desc->bd_export != NULL) ^ (desc->bd_import != NULL));
264 LASSERT(desc->bd_frag_ops != NULL);
266 if (ptlrpc_is_bulk_desc_kiov(desc->bd_type))
267 sptlrpc_enc_pool_put_pages(desc);
270 class_export_put(desc->bd_export);
272 class_import_put(desc->bd_import);
274 if (desc->bd_frag_ops->release_frags != NULL)
275 desc->bd_frag_ops->release_frags(desc);
277 if (ptlrpc_is_bulk_desc_kiov(desc->bd_type))
278 OBD_FREE_LARGE(GET_KIOV(desc),
279 desc->bd_max_iov * sizeof(*GET_KIOV(desc)));
281 OBD_FREE_LARGE(GET_KVEC(desc),
282 desc->bd_max_iov * sizeof(*GET_KVEC(desc)));
286 EXPORT_SYMBOL(ptlrpc_free_bulk);
289 * Set server timelimit for this req, i.e. how long are we willing to wait
290 * for reply before timing out this request.
292 void ptlrpc_at_set_req_timeout(struct ptlrpc_request *req)
298 LASSERT(req->rq_import);
301 /* non-AT settings */
303 * \a imp_server_timeout means this is reverse import and
304 * we send (currently only) ASTs to the client and cannot afford
305 * to wait too long for the reply, otherwise the other client
306 * (because of which we are sending this request) would
307 * timeout waiting for us
309 req->rq_timeout = req->rq_import->imp_server_timeout ?
310 obd_timeout / 2 : obd_timeout;
312 at = &req->rq_import->imp_at;
313 idx = import_at_get_index(req->rq_import,
314 req->rq_request_portal);
315 serv_est = at_get(&at->iat_service_estimate[idx]);
316 req->rq_timeout = at_est2timeout(serv_est);
318 /* We could get even fancier here, using history to predict increased
321 /* Let the server know what this RPC timeout is by putting it in the
323 lustre_msg_set_timeout(req->rq_reqmsg, req->rq_timeout);
325 EXPORT_SYMBOL(ptlrpc_at_set_req_timeout);
327 /* Adjust max service estimate based on server value */
328 static void ptlrpc_at_adj_service(struct ptlrpc_request *req,
329 unsigned int serv_est)
335 LASSERT(req->rq_import);
336 at = &req->rq_import->imp_at;
338 idx = import_at_get_index(req->rq_import, req->rq_request_portal);
339 /* max service estimates are tracked on the server side,
340 so just keep minimal history here */
341 oldse = at_measured(&at->iat_service_estimate[idx], serv_est);
343 CDEBUG(D_ADAPTTO, "The RPC service estimate for %s ptl %d "
344 "has changed from %d to %d\n",
345 req->rq_import->imp_obd->obd_name,req->rq_request_portal,
346 oldse, at_get(&at->iat_service_estimate[idx]));
349 /* Expected network latency per remote node (secs) */
350 int ptlrpc_at_get_net_latency(struct ptlrpc_request *req)
352 return AT_OFF ? 0 : at_get(&req->rq_import->imp_at.iat_net_latency);
355 /* Adjust expected network latency */
356 void ptlrpc_at_adj_net_latency(struct ptlrpc_request *req,
357 unsigned int service_time)
359 unsigned int nl, oldnl;
361 time64_t now = ktime_get_real_seconds();
363 LASSERT(req->rq_import);
365 if (service_time > now - req->rq_sent + 3) {
366 /* bz16408, however, this can also happen if early reply
367 * is lost and client RPC is expired and resent, early reply
368 * or reply of original RPC can still be fit in reply buffer
369 * of resent RPC, now client is measuring time from the
370 * resent time, but server sent back service time of original
373 CDEBUG((lustre_msg_get_flags(req->rq_reqmsg) & MSG_RESENT) ?
374 D_ADAPTTO : D_WARNING,
375 "Reported service time %u > total measured time %lld\n",
376 service_time, now - req->rq_sent);
380 /* Network latency is total time less server processing time */
381 nl = max_t(int, now - req->rq_sent -
382 service_time, 0) + 1; /* st rounding */
383 at = &req->rq_import->imp_at;
385 oldnl = at_measured(&at->iat_net_latency, nl);
387 CDEBUG(D_ADAPTTO, "The network latency for %s (nid %s) "
388 "has changed from %d to %d\n",
389 req->rq_import->imp_obd->obd_name,
391 &req->rq_import->imp_connection->c_remote_uuid),
392 oldnl, at_get(&at->iat_net_latency));
395 static int unpack_reply(struct ptlrpc_request *req)
399 if (SPTLRPC_FLVR_POLICY(req->rq_flvr.sf_rpc) != SPTLRPC_POLICY_NULL) {
400 rc = ptlrpc_unpack_rep_msg(req, req->rq_replen);
402 DEBUG_REQ(D_ERROR, req, "unpack_rep failed: %d", rc);
407 rc = lustre_unpack_rep_ptlrpc_body(req, MSG_PTLRPC_BODY_OFF);
409 DEBUG_REQ(D_ERROR, req, "unpack ptlrpc body failed: %d", rc);
416 * Handle an early reply message, called with the rq_lock held.
417 * If anything goes wrong just ignore it - same as if it never happened
419 static int ptlrpc_at_recv_early_reply(struct ptlrpc_request *req)
420 __must_hold(&req->rq_lock)
422 struct ptlrpc_request *early_req;
428 spin_unlock(&req->rq_lock);
430 rc = sptlrpc_cli_unwrap_early_reply(req, &early_req);
432 spin_lock(&req->rq_lock);
436 rc = unpack_reply(early_req);
438 sptlrpc_cli_finish_early_reply(early_req);
439 spin_lock(&req->rq_lock);
443 /* Use new timeout value just to adjust the local value for this
444 * request, don't include it into at_history. It is unclear yet why
445 * service time increased and should it be counted or skipped, e.g.
446 * that can be recovery case or some error or server, the real reply
447 * will add all new data if it is worth to add. */
448 req->rq_timeout = lustre_msg_get_timeout(early_req->rq_repmsg);
449 lustre_msg_set_timeout(req->rq_reqmsg, req->rq_timeout);
451 /* Network latency can be adjusted, it is pure network delays */
452 ptlrpc_at_adj_net_latency(req,
453 lustre_msg_get_service_time(early_req->rq_repmsg));
455 sptlrpc_cli_finish_early_reply(early_req);
457 spin_lock(&req->rq_lock);
458 olddl = req->rq_deadline;
459 /* server assumes it now has rq_timeout from when the request
460 * arrived, so the client should give it at least that long.
461 * since we don't know the arrival time we'll use the original
463 req->rq_deadline = req->rq_sent + req->rq_timeout +
464 ptlrpc_at_get_net_latency(req);
466 DEBUG_REQ(D_ADAPTTO, req,
467 "Early reply #%d, new deadline in %llds (%llds)",
469 req->rq_deadline - ktime_get_real_seconds(),
470 req->rq_deadline - olddl);
475 static struct kmem_cache *request_cache;
477 int ptlrpc_request_cache_init(void)
479 request_cache = kmem_cache_create("ptlrpc_cache",
480 sizeof(struct ptlrpc_request),
481 0, SLAB_HWCACHE_ALIGN, NULL);
482 return request_cache == NULL ? -ENOMEM : 0;
485 void ptlrpc_request_cache_fini(void)
487 kmem_cache_destroy(request_cache);
490 struct ptlrpc_request *ptlrpc_request_cache_alloc(gfp_t flags)
492 struct ptlrpc_request *req;
494 OBD_SLAB_ALLOC_PTR_GFP(req, request_cache, flags);
498 void ptlrpc_request_cache_free(struct ptlrpc_request *req)
500 OBD_SLAB_FREE_PTR(req, request_cache);
504 * Wind down request pool \a pool.
505 * Frees all requests from the pool too
507 void ptlrpc_free_rq_pool(struct ptlrpc_request_pool *pool)
509 struct list_head *l, *tmp;
510 struct ptlrpc_request *req;
512 LASSERT(pool != NULL);
514 spin_lock(&pool->prp_lock);
515 list_for_each_safe(l, tmp, &pool->prp_req_list) {
516 req = list_entry(l, struct ptlrpc_request, rq_list);
517 list_del(&req->rq_list);
518 LASSERT(req->rq_reqbuf);
519 LASSERT(req->rq_reqbuf_len == pool->prp_rq_size);
520 OBD_FREE_LARGE(req->rq_reqbuf, pool->prp_rq_size);
521 ptlrpc_request_cache_free(req);
523 spin_unlock(&pool->prp_lock);
524 OBD_FREE(pool, sizeof(*pool));
526 EXPORT_SYMBOL(ptlrpc_free_rq_pool);
529 * Allocates, initializes and adds \a num_rq requests to the pool \a pool
531 int ptlrpc_add_rqs_to_pool(struct ptlrpc_request_pool *pool, int num_rq)
536 while (size < pool->prp_rq_size)
539 LASSERTF(list_empty(&pool->prp_req_list) ||
540 size == pool->prp_rq_size,
541 "Trying to change pool size with nonempty pool "
542 "from %d to %d bytes\n", pool->prp_rq_size, size);
544 spin_lock(&pool->prp_lock);
545 pool->prp_rq_size = size;
546 for (i = 0; i < num_rq; i++) {
547 struct ptlrpc_request *req;
548 struct lustre_msg *msg;
550 spin_unlock(&pool->prp_lock);
551 req = ptlrpc_request_cache_alloc(GFP_NOFS);
554 OBD_ALLOC_LARGE(msg, size);
556 ptlrpc_request_cache_free(req);
559 req->rq_reqbuf = msg;
560 req->rq_reqbuf_len = size;
562 spin_lock(&pool->prp_lock);
563 list_add_tail(&req->rq_list, &pool->prp_req_list);
565 spin_unlock(&pool->prp_lock);
568 EXPORT_SYMBOL(ptlrpc_add_rqs_to_pool);
571 * Create and initialize new request pool with given attributes:
572 * \a num_rq - initial number of requests to create for the pool
573 * \a msgsize - maximum message size possible for requests in thid pool
574 * \a populate_pool - function to be called when more requests need to be added
576 * Returns pointer to newly created pool or NULL on error.
578 struct ptlrpc_request_pool *
579 ptlrpc_init_rq_pool(int num_rq, int msgsize,
580 int (*populate_pool)(struct ptlrpc_request_pool *, int))
582 struct ptlrpc_request_pool *pool;
584 OBD_ALLOC(pool, sizeof(struct ptlrpc_request_pool));
588 /* Request next power of two for the allocation, because internally
589 kernel would do exactly this */
591 spin_lock_init(&pool->prp_lock);
592 INIT_LIST_HEAD(&pool->prp_req_list);
593 pool->prp_rq_size = msgsize + SPTLRPC_MAX_PAYLOAD;
594 pool->prp_populate = populate_pool;
596 populate_pool(pool, num_rq);
600 EXPORT_SYMBOL(ptlrpc_init_rq_pool);
603 * Fetches one request from pool \a pool
605 static struct ptlrpc_request *
606 ptlrpc_prep_req_from_pool(struct ptlrpc_request_pool *pool)
608 struct ptlrpc_request *request;
609 struct lustre_msg *reqbuf;
614 spin_lock(&pool->prp_lock);
616 /* See if we have anything in a pool, and bail out if nothing,
617 * in writeout path, where this matters, this is safe to do, because
618 * nothing is lost in this case, and when some in-flight requests
619 * complete, this code will be called again. */
620 if (unlikely(list_empty(&pool->prp_req_list))) {
621 spin_unlock(&pool->prp_lock);
625 request = list_entry(pool->prp_req_list.next, struct ptlrpc_request,
627 list_del_init(&request->rq_list);
628 spin_unlock(&pool->prp_lock);
630 LASSERT(request->rq_reqbuf);
631 LASSERT(request->rq_pool);
633 reqbuf = request->rq_reqbuf;
634 memset(request, 0, sizeof(*request));
635 request->rq_reqbuf = reqbuf;
636 request->rq_reqbuf_len = pool->prp_rq_size;
637 request->rq_pool = pool;
643 * Returns freed \a request to pool.
645 static void __ptlrpc_free_req_to_pool(struct ptlrpc_request *request)
647 struct ptlrpc_request_pool *pool = request->rq_pool;
649 spin_lock(&pool->prp_lock);
650 LASSERT(list_empty(&request->rq_list));
651 LASSERT(!request->rq_receiving_reply);
652 list_add_tail(&request->rq_list, &pool->prp_req_list);
653 spin_unlock(&pool->prp_lock);
656 void ptlrpc_add_unreplied(struct ptlrpc_request *req)
658 struct obd_import *imp = req->rq_import;
659 struct list_head *tmp;
660 struct ptlrpc_request *iter;
662 assert_spin_locked(&imp->imp_lock);
663 LASSERT(list_empty(&req->rq_unreplied_list));
665 /* unreplied list is sorted by xid in ascending order */
666 list_for_each_prev(tmp, &imp->imp_unreplied_list) {
667 iter = list_entry(tmp, struct ptlrpc_request,
670 LASSERT(req->rq_xid != iter->rq_xid);
671 if (req->rq_xid < iter->rq_xid)
673 list_add(&req->rq_unreplied_list, &iter->rq_unreplied_list);
676 list_add(&req->rq_unreplied_list, &imp->imp_unreplied_list);
679 void ptlrpc_assign_next_xid_nolock(struct ptlrpc_request *req)
681 req->rq_xid = ptlrpc_next_xid();
682 ptlrpc_add_unreplied(req);
685 static inline void ptlrpc_assign_next_xid(struct ptlrpc_request *req)
687 spin_lock(&req->rq_import->imp_lock);
688 ptlrpc_assign_next_xid_nolock(req);
689 spin_unlock(&req->rq_import->imp_lock);
692 int ptlrpc_request_bufs_pack(struct ptlrpc_request *request,
693 __u32 version, int opcode, char **bufs,
694 struct ptlrpc_cli_ctx *ctx)
697 struct obd_import *imp;
703 count = req_capsule_filled_sizes(&request->rq_pill, RCL_CLIENT);
704 imp = request->rq_import;
705 lengths = request->rq_pill.rc_area[RCL_CLIENT];
708 request->rq_cli_ctx = sptlrpc_cli_ctx_get(ctx);
710 rc = sptlrpc_req_get_ctx(request);
714 sptlrpc_req_set_flavor(request, opcode);
716 rc = lustre_pack_request(request, imp->imp_msg_magic, count,
721 lustre_msg_add_version(request->rq_reqmsg, version);
722 request->rq_send_state = LUSTRE_IMP_FULL;
723 request->rq_type = PTL_RPC_MSG_REQUEST;
725 request->rq_req_cbid.cbid_fn = request_out_callback;
726 request->rq_req_cbid.cbid_arg = request;
728 request->rq_reply_cbid.cbid_fn = reply_in_callback;
729 request->rq_reply_cbid.cbid_arg = request;
731 request->rq_reply_deadline = 0;
732 request->rq_bulk_deadline = 0;
733 request->rq_req_deadline = 0;
734 request->rq_phase = RQ_PHASE_NEW;
735 request->rq_next_phase = RQ_PHASE_UNDEFINED;
737 request->rq_request_portal = imp->imp_client->cli_request_portal;
738 request->rq_reply_portal = imp->imp_client->cli_reply_portal;
740 ptlrpc_at_set_req_timeout(request);
742 lustre_msg_set_opc(request->rq_reqmsg, opcode);
743 ptlrpc_assign_next_xid(request);
745 /* Let's setup deadline for req/reply/bulk unlink for opcode. */
746 if (cfs_fail_val == opcode) {
747 time64_t *fail_t = NULL, *fail2_t = NULL;
749 if (CFS_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_BULK_UNLINK))
750 fail_t = &request->rq_bulk_deadline;
751 else if (CFS_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK))
752 fail_t = &request->rq_reply_deadline;
753 else if (CFS_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REQ_UNLINK))
754 fail_t = &request->rq_req_deadline;
755 else if (CFS_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_BOTH_UNLINK)) {
756 fail_t = &request->rq_reply_deadline;
757 fail2_t = &request->rq_bulk_deadline;
761 *fail_t = ktime_get_real_seconds() + LONG_UNLINK;
764 *fail2_t = ktime_get_real_seconds() +
768 * The RPC is infected, let the test to change the
771 msleep(4 * MSEC_PER_SEC);
778 LASSERT(!request->rq_pool);
779 sptlrpc_cli_ctx_put(request->rq_cli_ctx, 1);
781 class_import_put(imp);
786 EXPORT_SYMBOL(ptlrpc_request_bufs_pack);
789 * Pack request buffers for network transfer, performing necessary encryption
790 * steps if necessary.
792 int ptlrpc_request_pack(struct ptlrpc_request *request,
793 __u32 version, int opcode)
796 rc = ptlrpc_request_bufs_pack(request, version, opcode, NULL, NULL);
800 /* For some old 1.8 clients (< 1.8.7), they will LASSERT the size of
801 * ptlrpc_body sent from server equal to local ptlrpc_body size, so we
802 * have to send old ptlrpc_body to keep interoprability with these
805 * Only three kinds of server->client RPCs so far:
810 * XXX This should be removed whenever we drop the interoprability with
811 * the these old clients.
813 if (opcode == LDLM_BL_CALLBACK || opcode == LDLM_CP_CALLBACK ||
814 opcode == LDLM_GL_CALLBACK)
815 req_capsule_shrink(&request->rq_pill, &RMF_PTLRPC_BODY,
816 sizeof(struct ptlrpc_body_v2), RCL_CLIENT);
820 EXPORT_SYMBOL(ptlrpc_request_pack);
823 * Helper function to allocate new request on import \a imp
824 * and possibly using existing request from pool \a pool if provided.
825 * Returns allocated request structure with import field filled or
829 struct ptlrpc_request *__ptlrpc_request_alloc(struct obd_import *imp,
830 struct ptlrpc_request_pool *pool)
832 struct ptlrpc_request *request = NULL;
834 request = ptlrpc_request_cache_alloc(GFP_NOFS);
836 if (!request && pool)
837 request = ptlrpc_prep_req_from_pool(pool);
840 ptlrpc_cli_req_init(request);
842 LASSERTF((unsigned long)imp > 0x1000, "%p", imp);
843 LASSERT(imp != LP_POISON);
844 LASSERTF((unsigned long)imp->imp_client > 0x1000, "%p\n",
846 LASSERT(imp->imp_client != LP_POISON);
848 request->rq_import = class_import_get(imp);
850 CERROR("request allocation out of memory\n");
857 * Helper function for creating a request.
858 * Calls __ptlrpc_request_alloc to allocate new request sturcture and inits
859 * buffer structures according to capsule template \a format.
860 * Returns allocated request structure pointer or NULL on error.
862 static struct ptlrpc_request *
863 ptlrpc_request_alloc_internal(struct obd_import *imp,
864 struct ptlrpc_request_pool * pool,
865 const struct req_format *format)
867 struct ptlrpc_request *request;
870 request = __ptlrpc_request_alloc(imp, pool);
874 /* initiate connection if needed when the import has been
875 * referenced by the new request to avoid races with disconnect */
876 if (unlikely(imp->imp_state == LUSTRE_IMP_IDLE)) {
878 CDEBUG_LIMIT(imp->imp_idle_debug,
879 "%s: reconnect after %llds idle\n",
880 imp->imp_obd->obd_name, ktime_get_real_seconds() -
881 imp->imp_last_reply_time);
882 spin_lock(&imp->imp_lock);
883 if (imp->imp_state == LUSTRE_IMP_IDLE) {
884 imp->imp_generation++;
885 imp->imp_initiated_at = imp->imp_generation;
886 imp->imp_state = LUSTRE_IMP_NEW;
889 spin_unlock(&imp->imp_lock);
891 rc = ptlrpc_connect_import(imp);
893 ptlrpc_request_free(request);
896 ptlrpc_pinger_add_import(imp);
900 req_capsule_init(&request->rq_pill, request, RCL_CLIENT);
901 req_capsule_set(&request->rq_pill, format);
906 * Allocate new request structure for import \a imp and initialize its
907 * buffer structure according to capsule template \a format.
909 struct ptlrpc_request *ptlrpc_request_alloc(struct obd_import *imp,
910 const struct req_format *format)
912 return ptlrpc_request_alloc_internal(imp, NULL, format);
914 EXPORT_SYMBOL(ptlrpc_request_alloc);
917 * Allocate new request structure for import \a imp from pool \a pool and
918 * initialize its buffer structure according to capsule template \a format.
920 struct ptlrpc_request *ptlrpc_request_alloc_pool(struct obd_import *imp,
921 struct ptlrpc_request_pool * pool,
922 const struct req_format *format)
924 return ptlrpc_request_alloc_internal(imp, pool, format);
926 EXPORT_SYMBOL(ptlrpc_request_alloc_pool);
929 * For requests not from pool, free memory of the request structure.
930 * For requests obtained from a pool earlier, return request back to pool.
932 void ptlrpc_request_free(struct ptlrpc_request *request)
934 if (request->rq_pool)
935 __ptlrpc_free_req_to_pool(request);
937 ptlrpc_request_cache_free(request);
939 EXPORT_SYMBOL(ptlrpc_request_free);
942 * Allocate new request for operatione \a opcode and immediatelly pack it for
944 * Only used for simple requests like OBD_PING where the only important
945 * part of the request is operation itself.
946 * Returns allocated request or NULL on error.
948 struct ptlrpc_request *ptlrpc_request_alloc_pack(struct obd_import *imp,
949 const struct req_format *format,
950 __u32 version, int opcode)
952 struct ptlrpc_request *req = ptlrpc_request_alloc(imp, format);
956 rc = ptlrpc_request_pack(req, version, opcode);
958 ptlrpc_request_free(req);
964 EXPORT_SYMBOL(ptlrpc_request_alloc_pack);
967 * Allocate and initialize new request set structure on the current CPT.
968 * Returns a pointer to the newly allocated set structure or NULL on error.
970 struct ptlrpc_request_set *ptlrpc_prep_set(void)
972 struct ptlrpc_request_set *set;
976 cpt = cfs_cpt_current(cfs_cpt_table, 0);
977 OBD_CPT_ALLOC(set, cfs_cpt_table, cpt, sizeof *set);
980 atomic_set(&set->set_refcount, 1);
981 INIT_LIST_HEAD(&set->set_requests);
982 init_waitqueue_head(&set->set_waitq);
983 atomic_set(&set->set_new_count, 0);
984 atomic_set(&set->set_remaining, 0);
985 spin_lock_init(&set->set_new_req_lock);
986 INIT_LIST_HEAD(&set->set_new_requests);
987 set->set_max_inflight = UINT_MAX;
988 set->set_producer = NULL;
989 set->set_producer_arg = NULL;
994 EXPORT_SYMBOL(ptlrpc_prep_set);
997 * Allocate and initialize new request set structure with flow control
998 * extension. This extension allows to control the number of requests in-flight
999 * for the whole set. A callback function to generate requests must be provided
1000 * and the request set will keep the number of requests sent over the wire to
1002 * Returns a pointer to the newly allocated set structure or NULL on error.
1004 struct ptlrpc_request_set *ptlrpc_prep_fcset(int max, set_producer_func func,
1008 struct ptlrpc_request_set *set;
1010 set = ptlrpc_prep_set();
1014 set->set_max_inflight = max;
1015 set->set_producer = func;
1016 set->set_producer_arg = arg;
1022 * Wind down and free request set structure previously allocated with
1024 * Ensures that all requests on the set have completed and removes
1025 * all requests from the request list in a set.
1026 * If any unsent request happen to be on the list, pretends that they got
1027 * an error in flight and calls their completion handler.
1029 void ptlrpc_set_destroy(struct ptlrpc_request_set *set)
1031 struct list_head *tmp;
1032 struct list_head *next;
1037 /* Requests on the set should either all be completed, or all be new */
1038 expected_phase = (atomic_read(&set->set_remaining) == 0) ?
1039 RQ_PHASE_COMPLETE : RQ_PHASE_NEW;
1040 list_for_each(tmp, &set->set_requests) {
1041 struct ptlrpc_request *req =
1042 list_entry(tmp, struct ptlrpc_request,
1045 LASSERT(req->rq_phase == expected_phase);
1049 LASSERTF(atomic_read(&set->set_remaining) == 0 ||
1050 atomic_read(&set->set_remaining) == n, "%d / %d\n",
1051 atomic_read(&set->set_remaining), n);
1053 list_for_each_safe(tmp, next, &set->set_requests) {
1054 struct ptlrpc_request *req =
1055 list_entry(tmp, struct ptlrpc_request,
1057 list_del_init(&req->rq_set_chain);
1059 LASSERT(req->rq_phase == expected_phase);
1061 if (req->rq_phase == RQ_PHASE_NEW) {
1062 ptlrpc_req_interpret(NULL, req, -EBADR);
1063 atomic_dec(&set->set_remaining);
1066 spin_lock(&req->rq_lock);
1068 req->rq_invalid_rqset = 0;
1069 spin_unlock(&req->rq_lock);
1071 ptlrpc_req_finished (req);
1074 LASSERT(atomic_read(&set->set_remaining) == 0);
1076 ptlrpc_reqset_put(set);
1079 EXPORT_SYMBOL(ptlrpc_set_destroy);
1082 * Add a new request to the general purpose request set.
1083 * Assumes request reference from the caller.
1085 void ptlrpc_set_add_req(struct ptlrpc_request_set *set,
1086 struct ptlrpc_request *req)
1088 LASSERT(req->rq_import->imp_state != LUSTRE_IMP_IDLE);
1089 LASSERT(list_empty(&req->rq_set_chain));
1091 if (req->rq_allow_intr)
1092 set->set_allow_intr = 1;
1094 /* The set takes over the caller's request reference */
1095 list_add_tail(&req->rq_set_chain, &set->set_requests);
1097 atomic_inc(&set->set_remaining);
1098 req->rq_queued_time = ktime_get_seconds();
1100 if (req->rq_reqmsg != NULL)
1101 lustre_msg_set_jobid(req->rq_reqmsg, NULL);
1103 if (set->set_producer != NULL)
1104 /* If the request set has a producer callback, the RPC must be
1105 * sent straight away */
1106 ptlrpc_send_new_req(req);
1108 EXPORT_SYMBOL(ptlrpc_set_add_req);
1111 * Add a request to a request with dedicated server thread
1112 * and wake the thread to make any necessary processing.
1113 * Currently only used for ptlrpcd.
1115 void ptlrpc_set_add_new_req(struct ptlrpcd_ctl *pc,
1116 struct ptlrpc_request *req)
1118 struct ptlrpc_request_set *set = pc->pc_set;
1121 LASSERT(req->rq_set == NULL);
1122 LASSERT(test_bit(LIOD_STOP, &pc->pc_flags) == 0);
1124 spin_lock(&set->set_new_req_lock);
1126 * The set takes over the caller's request reference.
1129 req->rq_queued_time = ktime_get_seconds();
1130 list_add_tail(&req->rq_set_chain, &set->set_new_requests);
1131 count = atomic_inc_return(&set->set_new_count);
1132 spin_unlock(&set->set_new_req_lock);
1134 /* Only need to call wakeup once for the first entry. */
1136 wake_up(&set->set_waitq);
1138 /* XXX: It maybe unnecessary to wakeup all the partners. But to
1139 * guarantee the async RPC can be processed ASAP, we have
1140 * no other better choice. It maybe fixed in future. */
1141 for (i = 0; i < pc->pc_npartners; i++)
1142 wake_up(&pc->pc_partners[i]->pc_set->set_waitq);
1147 * Based on the current state of the import, determine if the request
1148 * can be sent, is an error, or should be delayed.
1150 * Returns true if this request should be delayed. If false, and
1151 * *status is set, then the request can not be sent and *status is the
1152 * error code. If false and status is 0, then request can be sent.
1154 * The imp->imp_lock must be held.
1156 static int ptlrpc_import_delay_req(struct obd_import *imp,
1157 struct ptlrpc_request *req, int *status)
1162 LASSERT (status != NULL);
1165 if (req->rq_ctx_init || req->rq_ctx_fini) {
1166 /* always allow ctx init/fini rpc go through */
1167 } else if (imp->imp_state == LUSTRE_IMP_NEW) {
1168 DEBUG_REQ(D_ERROR, req, "Uninitialized import.");
1170 } else if (imp->imp_state == LUSTRE_IMP_CLOSED) {
1171 unsigned int opc = lustre_msg_get_opc(req->rq_reqmsg);
1173 /* pings or MDS-equivalent STATFS may safely race with umount */
1174 DEBUG_REQ((opc == OBD_PING || opc == OST_STATFS) ?
1175 D_HA : D_ERROR, req, "IMP_CLOSED ");
1177 } else if (ptlrpc_send_limit_expired(req)) {
1178 /* probably doesn't need to be a D_ERROR after initial testing*/
1179 DEBUG_REQ(D_HA, req, "send limit expired ");
1180 *status = -ETIMEDOUT;
1181 } else if (req->rq_send_state == LUSTRE_IMP_CONNECTING &&
1182 imp->imp_state == LUSTRE_IMP_CONNECTING) {
1183 /* allow CONNECT even if import is invalid */ ;
1184 if (atomic_read(&imp->imp_inval_count) != 0) {
1185 DEBUG_REQ(D_ERROR, req, "invalidate in flight");
1188 } else if (imp->imp_invalid || imp->imp_obd->obd_no_recov) {
1189 if (!imp->imp_deactive)
1190 DEBUG_REQ(D_NET, req, "IMP_INVALID");
1191 *status = -ESHUTDOWN; /* bz 12940 */
1192 } else if (req->rq_import_generation != imp->imp_generation) {
1193 DEBUG_REQ(D_ERROR, req, "req wrong generation:");
1195 } else if (req->rq_send_state != imp->imp_state) {
1196 /* invalidate in progress - any requests should be drop */
1197 if (atomic_read(&imp->imp_inval_count) != 0) {
1198 DEBUG_REQ(D_ERROR, req, "invalidate in flight");
1200 } else if (req->rq_no_delay &&
1201 imp->imp_generation != imp->imp_initiated_at) {
1202 /* ignore nodelay for requests initiating connections */
1203 *status = -EWOULDBLOCK;
1204 } else if (req->rq_allow_replay &&
1205 (imp->imp_state == LUSTRE_IMP_REPLAY ||
1206 imp->imp_state == LUSTRE_IMP_REPLAY_LOCKS ||
1207 imp->imp_state == LUSTRE_IMP_REPLAY_WAIT ||
1208 imp->imp_state == LUSTRE_IMP_RECOVER)) {
1209 DEBUG_REQ(D_HA, req, "allow during recovery.\n");
1219 * Decide if the error message should be printed to the console or not.
1220 * Makes its decision based on request type, status, and failure frequency.
1222 * \param[in] req request that failed and may need a console message
1224 * \retval false if no message should be printed
1225 * \retval true if console message should be printed
1227 static bool ptlrpc_console_allow(struct ptlrpc_request *req, __u32 opc, int err)
1229 LASSERT(req->rq_reqmsg != NULL);
1231 /* Suppress particular reconnect errors which are to be expected. */
1232 if (opc == OST_CONNECT || opc == MDS_CONNECT || opc == MGS_CONNECT) {
1234 /* Suppress timed out reconnect requests */
1235 if (lustre_handle_is_used(&req->rq_import->imp_remote_handle) ||
1239 /* Suppress most unavailable/again reconnect requests, but
1240 * print occasionally so it is clear client is trying to
1241 * connect to a server where no target is running. */
1242 if ((err == -ENODEV || err == -EAGAIN) &&
1243 req->rq_import->imp_conn_cnt % 30 != 20)
1247 if (opc == LDLM_ENQUEUE && err == -EAGAIN)
1248 /* -EAGAIN is normal when using POSIX flocks */
1251 if (opc == OBD_PING && (err == -ENODEV || err == -ENOTCONN) &&
1252 (req->rq_xid & 0xf) != 10)
1253 /* Suppress most ping requests, they may fail occasionally */
1260 * Check request processing status.
1261 * Returns the status.
1263 static int ptlrpc_check_status(struct ptlrpc_request *req)
1268 err = lustre_msg_get_status(req->rq_repmsg);
1269 if (lustre_msg_get_type(req->rq_repmsg) == PTL_RPC_MSG_ERR) {
1270 struct obd_import *imp = req->rq_import;
1271 lnet_nid_t nid = imp->imp_connection->c_peer.nid;
1272 __u32 opc = lustre_msg_get_opc(req->rq_reqmsg);
1274 if (ptlrpc_console_allow(req, opc, err))
1275 LCONSOLE_ERROR_MSG(0x11, "%s: operation %s to node %s "
1276 "failed: rc = %d\n",
1277 imp->imp_obd->obd_name,
1279 libcfs_nid2str(nid), err);
1280 RETURN(err < 0 ? err : -EINVAL);
1284 DEBUG_REQ(D_INFO, req, "status is %d", err);
1285 } else if (err > 0) {
1286 /* XXX: translate this error from net to host */
1287 DEBUG_REQ(D_INFO, req, "status is %d", err);
1294 * save pre-versions of objects into request for replay.
1295 * Versions are obtained from server reply.
1298 static void ptlrpc_save_versions(struct ptlrpc_request *req)
1300 struct lustre_msg *repmsg = req->rq_repmsg;
1301 struct lustre_msg *reqmsg = req->rq_reqmsg;
1302 __u64 *versions = lustre_msg_get_versions(repmsg);
1305 if (lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY)
1309 lustre_msg_set_versions(reqmsg, versions);
1310 CDEBUG(D_INFO, "Client save versions [%#llx/%#llx]\n",
1311 versions[0], versions[1]);
1316 __u64 ptlrpc_known_replied_xid(struct obd_import *imp)
1318 struct ptlrpc_request *req;
1320 assert_spin_locked(&imp->imp_lock);
1321 if (list_empty(&imp->imp_unreplied_list))
1324 req = list_entry(imp->imp_unreplied_list.next, struct ptlrpc_request,
1326 LASSERTF(req->rq_xid >= 1, "XID:%llu\n", req->rq_xid);
1328 if (imp->imp_known_replied_xid < req->rq_xid - 1)
1329 imp->imp_known_replied_xid = req->rq_xid - 1;
1331 return req->rq_xid - 1;
1335 * Callback function called when client receives RPC reply for \a req.
1336 * Returns 0 on success or error code.
1337 * The return alue would be assigned to req->rq_status by the caller
1338 * as request processing status.
1339 * This function also decides if the request needs to be saved for later replay.
1341 static int after_reply(struct ptlrpc_request *req)
1343 struct obd_import *imp = req->rq_import;
1344 struct obd_device *obd = req->rq_import->imp_obd;
1351 LASSERT(obd != NULL);
1352 /* repbuf must be unlinked */
1353 LASSERT(!req->rq_receiving_reply && req->rq_reply_unlinked);
1355 if (req->rq_reply_truncated) {
1356 if (ptlrpc_no_resend(req)) {
1357 DEBUG_REQ(D_ERROR, req, "reply buffer overflow,"
1358 " expected: %d, actual size: %d",
1359 req->rq_nob_received, req->rq_repbuf_len);
1363 sptlrpc_cli_free_repbuf(req);
1364 /* Pass the required reply buffer size (include
1365 * space for early reply).
1366 * NB: no need to roundup because alloc_repbuf
1367 * will roundup it */
1368 req->rq_replen = req->rq_nob_received;
1369 req->rq_nob_received = 0;
1370 spin_lock(&req->rq_lock);
1372 spin_unlock(&req->rq_lock);
1376 work_start = ktime_get_real();
1377 timediff = ktime_us_delta(work_start, req->rq_sent_ns);
1380 * NB Until this point, the whole of the incoming message,
1381 * including buflens, status etc is in the sender's byte order.
1383 rc = sptlrpc_cli_unwrap_reply(req);
1385 DEBUG_REQ(D_ERROR, req, "unwrap reply failed (%d):", rc);
1390 * Security layer unwrap might ask resend this request.
1395 rc = unpack_reply(req);
1399 /* retry indefinitely on EINPROGRESS */
1400 if (lustre_msg_get_status(req->rq_repmsg) == -EINPROGRESS &&
1401 ptlrpc_no_resend(req) == 0 && !req->rq_no_retry_einprogress) {
1402 time64_t now = ktime_get_real_seconds();
1404 DEBUG_REQ(D_RPCTRACE, req, "Resending request on EINPROGRESS");
1405 spin_lock(&req->rq_lock);
1407 spin_unlock(&req->rq_lock);
1408 req->rq_nr_resend++;
1410 /* Readjust the timeout for current conditions */
1411 ptlrpc_at_set_req_timeout(req);
1412 /* delay resend to give a chance to the server to get ready.
1413 * The delay is increased by 1s on every resend and is capped to
1414 * the current request timeout (i.e. obd_timeout if AT is off,
1415 * or AT service time x 125% + 5s, see at_est2timeout) */
1416 if (req->rq_nr_resend > req->rq_timeout)
1417 req->rq_sent = now + req->rq_timeout;
1419 req->rq_sent = now + req->rq_nr_resend;
1421 /* Resend for EINPROGRESS will use a new XID */
1422 spin_lock(&imp->imp_lock);
1423 list_del_init(&req->rq_unreplied_list);
1424 spin_unlock(&imp->imp_lock);
1429 if (obd->obd_svc_stats != NULL) {
1430 lprocfs_counter_add(obd->obd_svc_stats, PTLRPC_REQWAIT_CNTR,
1432 ptlrpc_lprocfs_rpc_sent(req, timediff);
1435 if (lustre_msg_get_type(req->rq_repmsg) != PTL_RPC_MSG_REPLY &&
1436 lustre_msg_get_type(req->rq_repmsg) != PTL_RPC_MSG_ERR) {
1437 DEBUG_REQ(D_ERROR, req, "invalid packet received (type=%u)",
1438 lustre_msg_get_type(req->rq_repmsg));
1442 if (lustre_msg_get_opc(req->rq_reqmsg) != OBD_PING)
1443 CFS_FAIL_TIMEOUT(OBD_FAIL_PTLRPC_PAUSE_REP, cfs_fail_val);
1444 ptlrpc_at_adj_service(req, lustre_msg_get_timeout(req->rq_repmsg));
1445 ptlrpc_at_adj_net_latency(req,
1446 lustre_msg_get_service_time(req->rq_repmsg));
1448 rc = ptlrpc_check_status(req);
1449 imp->imp_connect_error = rc;
1453 * Either we've been evicted, or the server has failed for
1454 * some reason. Try to reconnect, and if that fails, punt to
1457 if (ptlrpc_recoverable_error(rc)) {
1458 if (req->rq_send_state != LUSTRE_IMP_FULL ||
1459 imp->imp_obd->obd_no_recov || imp->imp_dlm_fake) {
1462 ptlrpc_request_handle_notconn(req);
1467 * Let's look if server sent slv. Do it only for RPC with
1470 ldlm_cli_update_pool(req);
1474 * Store transno in reqmsg for replay.
1476 if (!(lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY)) {
1477 req->rq_transno = lustre_msg_get_transno(req->rq_repmsg);
1478 lustre_msg_set_transno(req->rq_reqmsg, req->rq_transno);
1481 if (imp->imp_replayable) {
1482 spin_lock(&imp->imp_lock);
1484 * No point in adding already-committed requests to the replay
1485 * list, we will just remove them immediately. b=9829
1487 if (req->rq_transno != 0 &&
1489 lustre_msg_get_last_committed(req->rq_repmsg) ||
1491 /** version recovery */
1492 ptlrpc_save_versions(req);
1493 ptlrpc_retain_replayable_request(req, imp);
1494 } else if (req->rq_commit_cb != NULL &&
1495 list_empty(&req->rq_replay_list)) {
1496 /* NB: don't call rq_commit_cb if it's already on
1497 * rq_replay_list, ptlrpc_free_committed() will call
1498 * it later, see LU-3618 for details */
1499 spin_unlock(&imp->imp_lock);
1500 req->rq_commit_cb(req);
1501 spin_lock(&imp->imp_lock);
1505 * Replay-enabled imports return commit-status information.
1507 committed = lustre_msg_get_last_committed(req->rq_repmsg);
1508 if (likely(committed > imp->imp_peer_committed_transno))
1509 imp->imp_peer_committed_transno = committed;
1511 ptlrpc_free_committed(imp);
1513 if (!list_empty(&imp->imp_replay_list)) {
1514 struct ptlrpc_request *last;
1516 last = list_entry(imp->imp_replay_list.prev,
1517 struct ptlrpc_request,
1520 * Requests with rq_replay stay on the list even if no
1521 * commit is expected.
1523 if (last->rq_transno > imp->imp_peer_committed_transno)
1524 ptlrpc_pinger_commit_expected(imp);
1527 spin_unlock(&imp->imp_lock);
1534 * Helper function to send request \a req over the network for the first time
1535 * Also adjusts request phase.
1536 * Returns 0 on success or error code.
1538 static int ptlrpc_send_new_req(struct ptlrpc_request *req)
1540 struct obd_import *imp = req->rq_import;
1545 LASSERT(req->rq_phase == RQ_PHASE_NEW);
1547 /* do not try to go further if there is not enough memory in enc_pool */
1548 if (req->rq_sent && req->rq_bulk != NULL)
1549 if (req->rq_bulk->bd_iov_count > get_free_pages_in_pool() &&
1550 pool_is_at_full_capacity())
1553 if (req->rq_sent && (req->rq_sent > ktime_get_real_seconds()) &&
1554 (!req->rq_generation_set ||
1555 req->rq_import_generation == imp->imp_generation))
1558 ptlrpc_rqphase_move(req, RQ_PHASE_RPC);
1560 spin_lock(&imp->imp_lock);
1562 LASSERT(req->rq_xid != 0);
1563 LASSERT(!list_empty(&req->rq_unreplied_list));
1565 if (!req->rq_generation_set)
1566 req->rq_import_generation = imp->imp_generation;
1568 if (ptlrpc_import_delay_req(imp, req, &rc)) {
1569 spin_lock(&req->rq_lock);
1570 req->rq_waiting = 1;
1571 spin_unlock(&req->rq_lock);
1573 DEBUG_REQ(D_HA, req, "req waiting for recovery: (%s != %s)",
1574 ptlrpc_import_state_name(req->rq_send_state),
1575 ptlrpc_import_state_name(imp->imp_state));
1576 LASSERT(list_empty(&req->rq_list));
1577 list_add_tail(&req->rq_list, &imp->imp_delayed_list);
1578 atomic_inc(&req->rq_import->imp_inflight);
1579 spin_unlock(&imp->imp_lock);
1584 spin_unlock(&imp->imp_lock);
1585 req->rq_status = rc;
1586 ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
1590 LASSERT(list_empty(&req->rq_list));
1591 list_add_tail(&req->rq_list, &imp->imp_sending_list);
1592 atomic_inc(&req->rq_import->imp_inflight);
1594 /* find the known replied XID from the unreplied list, CONNECT
1595 * and DISCONNECT requests are skipped to make the sanity check
1596 * on server side happy. see process_req_last_xid().
1598 * For CONNECT: Because replay requests have lower XID, it'll
1599 * break the sanity check if CONNECT bump the exp_last_xid on
1602 * For DISCONNECT: Since client will abort inflight RPC before
1603 * sending DISCONNECT, DISCONNECT may carry an XID which higher
1604 * than the inflight RPC.
1606 if (!ptlrpc_req_is_connect(req) && !ptlrpc_req_is_disconnect(req))
1607 min_xid = ptlrpc_known_replied_xid(imp);
1608 spin_unlock(&imp->imp_lock);
1610 lustre_msg_set_last_xid(req->rq_reqmsg, min_xid);
1612 lustre_msg_set_status(req->rq_reqmsg, current_pid());
1614 rc = sptlrpc_req_refresh_ctx(req, -1);
1617 req->rq_status = rc;
1620 spin_lock(&req->rq_lock);
1621 req->rq_wait_ctx = 1;
1622 spin_unlock(&req->rq_lock);
1627 CDEBUG(D_RPCTRACE, "Sending RPC pname:cluuid:pid:xid:nid:opc"
1628 " %s:%s:%d:%llu:%s:%d\n", current_comm(),
1629 imp->imp_obd->obd_uuid.uuid,
1630 lustre_msg_get_status(req->rq_reqmsg), req->rq_xid,
1631 obd_import_nid2str(imp), lustre_msg_get_opc(req->rq_reqmsg));
1633 rc = ptl_send_rpc(req, 0);
1634 if (rc == -ENOMEM) {
1635 spin_lock(&imp->imp_lock);
1636 if (!list_empty(&req->rq_list)) {
1637 list_del_init(&req->rq_list);
1638 atomic_dec(&req->rq_import->imp_inflight);
1640 spin_unlock(&imp->imp_lock);
1641 ptlrpc_rqphase_move(req, RQ_PHASE_NEW);
1645 DEBUG_REQ(D_HA, req, "send failed (%d); expect timeout", rc);
1646 spin_lock(&req->rq_lock);
1647 req->rq_net_err = 1;
1648 spin_unlock(&req->rq_lock);
1654 static inline int ptlrpc_set_producer(struct ptlrpc_request_set *set)
1659 LASSERT(set->set_producer != NULL);
1661 remaining = atomic_read(&set->set_remaining);
1663 /* populate the ->set_requests list with requests until we
1664 * reach the maximum number of RPCs in flight for this set */
1665 while (atomic_read(&set->set_remaining) < set->set_max_inflight) {
1666 rc = set->set_producer(set, set->set_producer_arg);
1667 if (rc == -ENOENT) {
1668 /* no more RPC to produce */
1669 set->set_producer = NULL;
1670 set->set_producer_arg = NULL;
1675 RETURN((atomic_read(&set->set_remaining) - remaining));
1679 * this sends any unsent RPCs in \a set and returns 1 if all are sent
1680 * and no more replies are expected.
1681 * (it is possible to get less replies than requests sent e.g. due to timed out
1682 * requests or requests that we had trouble to send out)
1684 * NOTE: This function contains a potential schedule point (cond_resched()).
1686 int ptlrpc_check_set(const struct lu_env *env, struct ptlrpc_request_set *set)
1688 struct list_head *tmp, *next;
1689 struct list_head comp_reqs;
1690 int force_timer_recalc = 0;
1693 if (atomic_read(&set->set_remaining) == 0)
1696 INIT_LIST_HEAD(&comp_reqs);
1697 list_for_each_safe(tmp, next, &set->set_requests) {
1698 struct ptlrpc_request *req =
1699 list_entry(tmp, struct ptlrpc_request,
1701 struct obd_import *imp = req->rq_import;
1702 int unregistered = 0;
1706 if (req->rq_phase == RQ_PHASE_COMPLETE) {
1707 list_move_tail(&req->rq_set_chain, &comp_reqs);
1711 /* This schedule point is mainly for the ptlrpcd caller of this
1712 * function. Most ptlrpc sets are not long-lived and unbounded
1713 * in length, but at the least the set used by the ptlrpcd is.
1714 * Since the processing time is unbounded, we need to insert an
1715 * explicit schedule point to make the thread well-behaved.
1719 /* If the caller requires to allow to be interpreted by force
1720 * and it has really been interpreted, then move the request
1721 * to RQ_PHASE_INTERPRET phase in spite of what the current
1723 if (unlikely(req->rq_allow_intr && req->rq_intr)) {
1724 req->rq_status = -EINTR;
1725 ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
1727 /* Since it is interpreted and we have to wait for
1728 * the reply to be unlinked, then use sync mode. */
1731 GOTO(interpret, req->rq_status);
1734 if (req->rq_phase == RQ_PHASE_NEW && ptlrpc_send_new_req(req))
1735 force_timer_recalc = 1;
1737 /* delayed send - skip */
1738 if (req->rq_phase == RQ_PHASE_NEW && req->rq_sent)
1741 /* delayed resend - skip */
1742 if (req->rq_phase == RQ_PHASE_RPC && req->rq_resend &&
1743 req->rq_sent > ktime_get_real_seconds())
1746 if (!(req->rq_phase == RQ_PHASE_RPC ||
1747 req->rq_phase == RQ_PHASE_BULK ||
1748 req->rq_phase == RQ_PHASE_INTERPRET ||
1749 req->rq_phase == RQ_PHASE_UNREG_RPC ||
1750 req->rq_phase == RQ_PHASE_UNREG_BULK)) {
1751 DEBUG_REQ(D_ERROR, req, "bad phase %x", req->rq_phase);
1755 if (req->rq_phase == RQ_PHASE_UNREG_RPC ||
1756 req->rq_phase == RQ_PHASE_UNREG_BULK) {
1757 LASSERT(req->rq_next_phase != req->rq_phase);
1758 LASSERT(req->rq_next_phase != RQ_PHASE_UNDEFINED);
1760 if (req->rq_req_deadline &&
1761 !OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REQ_UNLINK))
1762 req->rq_req_deadline = 0;
1763 if (req->rq_reply_deadline &&
1764 !OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK))
1765 req->rq_reply_deadline = 0;
1766 if (req->rq_bulk_deadline &&
1767 !OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_BULK_UNLINK))
1768 req->rq_bulk_deadline = 0;
1771 * Skip processing until reply is unlinked. We
1772 * can't return to pool before that and we can't
1773 * call interpret before that. We need to make
1774 * sure that all rdma transfers finished and will
1775 * not corrupt any data.
1777 if (req->rq_phase == RQ_PHASE_UNREG_RPC &&
1778 ptlrpc_client_recv_or_unlink(req))
1780 if (req->rq_phase == RQ_PHASE_UNREG_BULK &&
1781 ptlrpc_client_bulk_active(req))
1785 * Turn fail_loc off to prevent it from looping
1788 if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK)) {
1789 OBD_FAIL_CHECK_ORSET(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK,
1792 if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_BULK_UNLINK)) {
1793 OBD_FAIL_CHECK_ORSET(OBD_FAIL_PTLRPC_LONG_BULK_UNLINK,
1798 * Move to next phase if reply was successfully
1801 ptlrpc_rqphase_move(req, req->rq_next_phase);
1804 if (req->rq_phase == RQ_PHASE_INTERPRET)
1805 GOTO(interpret, req->rq_status);
1808 * Note that this also will start async reply unlink.
1810 if (req->rq_net_err && !req->rq_timedout) {
1811 ptlrpc_expire_one_request(req, 1);
1814 * Check if we still need to wait for unlink.
1816 if (ptlrpc_client_recv_or_unlink(req) ||
1817 ptlrpc_client_bulk_active(req))
1819 /* If there is no need to resend, fail it now. */
1820 if (req->rq_no_resend) {
1821 if (req->rq_status == 0)
1822 req->rq_status = -EIO;
1823 ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
1824 GOTO(interpret, req->rq_status);
1831 spin_lock(&req->rq_lock);
1832 req->rq_replied = 0;
1833 spin_unlock(&req->rq_lock);
1834 if (req->rq_status == 0)
1835 req->rq_status = -EIO;
1836 ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
1837 GOTO(interpret, req->rq_status);
1840 /* ptlrpc_set_wait->l_wait_event sets lwi_allow_intr
1841 * so it sets rq_intr regardless of individual rpc
1842 * timeouts. The synchronous IO waiting path sets
1843 * rq_intr irrespective of whether ptlrpcd
1844 * has seen a timeout. Our policy is to only interpret
1845 * interrupted rpcs after they have timed out, so we
1846 * need to enforce that here.
1849 if (req->rq_intr && (req->rq_timedout || req->rq_waiting ||
1850 req->rq_wait_ctx)) {
1851 req->rq_status = -EINTR;
1852 ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
1853 GOTO(interpret, req->rq_status);
1856 if (req->rq_phase == RQ_PHASE_RPC) {
1857 if (req->rq_timedout || req->rq_resend ||
1858 req->rq_waiting || req->rq_wait_ctx) {
1861 if (!ptlrpc_unregister_reply(req, 1)) {
1862 ptlrpc_unregister_bulk(req, 1);
1866 spin_lock(&imp->imp_lock);
1867 if (ptlrpc_import_delay_req(imp, req, &status)){
1868 /* put on delay list - only if we wait
1869 * recovery finished - before send */
1870 list_del_init(&req->rq_list);
1871 list_add_tail(&req->rq_list,
1874 spin_unlock(&imp->imp_lock);
1879 req->rq_status = status;
1880 ptlrpc_rqphase_move(req,
1881 RQ_PHASE_INTERPRET);
1882 spin_unlock(&imp->imp_lock);
1883 GOTO(interpret, req->rq_status);
1885 /* ignore on just initiated connections */
1886 if (ptlrpc_no_resend(req) &&
1887 !req->rq_wait_ctx &&
1888 imp->imp_generation !=
1889 imp->imp_initiated_at) {
1890 req->rq_status = -ENOTCONN;
1891 ptlrpc_rqphase_move(req,
1892 RQ_PHASE_INTERPRET);
1893 spin_unlock(&imp->imp_lock);
1894 GOTO(interpret, req->rq_status);
1897 list_del_init(&req->rq_list);
1898 list_add_tail(&req->rq_list,
1899 &imp->imp_sending_list);
1901 spin_unlock(&imp->imp_lock);
1903 spin_lock(&req->rq_lock);
1904 req->rq_waiting = 0;
1905 spin_unlock(&req->rq_lock);
1907 if (req->rq_timedout || req->rq_resend) {
1908 /* This is re-sending anyways,
1909 * let's mark req as resend. */
1910 spin_lock(&req->rq_lock);
1912 spin_unlock(&req->rq_lock);
1914 if (req->rq_bulk != NULL &&
1915 !ptlrpc_unregister_bulk(req, 1))
1919 * rq_wait_ctx is only touched by ptlrpcd,
1920 * so no lock is needed here.
1922 status = sptlrpc_req_refresh_ctx(req, -1);
1925 req->rq_status = status;
1926 spin_lock(&req->rq_lock);
1927 req->rq_wait_ctx = 0;
1928 spin_unlock(&req->rq_lock);
1929 force_timer_recalc = 1;
1931 spin_lock(&req->rq_lock);
1932 req->rq_wait_ctx = 1;
1933 spin_unlock(&req->rq_lock);
1938 spin_lock(&req->rq_lock);
1939 req->rq_wait_ctx = 0;
1940 spin_unlock(&req->rq_lock);
1943 rc = ptl_send_rpc(req, 0);
1944 if (rc == -ENOMEM) {
1945 spin_lock(&imp->imp_lock);
1946 if (!list_empty(&req->rq_list))
1947 list_del_init(&req->rq_list);
1948 spin_unlock(&imp->imp_lock);
1949 ptlrpc_rqphase_move(req, RQ_PHASE_NEW);
1953 DEBUG_REQ(D_HA, req,
1954 "send failed: rc = %d", rc);
1955 force_timer_recalc = 1;
1956 spin_lock(&req->rq_lock);
1957 req->rq_net_err = 1;
1958 spin_unlock(&req->rq_lock);
1961 /* need to reset the timeout */
1962 force_timer_recalc = 1;
1965 spin_lock(&req->rq_lock);
1967 if (ptlrpc_client_early(req)) {
1968 ptlrpc_at_recv_early_reply(req);
1969 spin_unlock(&req->rq_lock);
1973 /* Still waiting for a reply? */
1974 if (ptlrpc_client_recv(req)) {
1975 spin_unlock(&req->rq_lock);
1979 /* Did we actually receive a reply? */
1980 if (!ptlrpc_client_replied(req)) {
1981 spin_unlock(&req->rq_lock);
1985 spin_unlock(&req->rq_lock);
1987 /* unlink from net because we are going to
1988 * swab in-place of reply buffer */
1989 unregistered = ptlrpc_unregister_reply(req, 1);
1993 req->rq_status = after_reply(req);
1997 /* If there is no bulk associated with this request,
1998 * then we're done and should let the interpreter
1999 * process the reply. Similarly if the RPC returned
2000 * an error, and therefore the bulk will never arrive.
2002 if (req->rq_bulk == NULL || req->rq_status < 0) {
2003 ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
2004 GOTO(interpret, req->rq_status);
2007 ptlrpc_rqphase_move(req, RQ_PHASE_BULK);
2010 LASSERT(req->rq_phase == RQ_PHASE_BULK);
2011 if (ptlrpc_client_bulk_active(req))
2014 if (req->rq_bulk->bd_failure) {
2015 /* The RPC reply arrived OK, but the bulk screwed
2016 * up! Dead weird since the server told us the RPC
2017 * was good after getting the REPLY for her GET or
2018 * the ACK for her PUT. */
2019 DEBUG_REQ(D_ERROR, req, "bulk transfer failed");
2020 req->rq_status = -EIO;
2023 ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
2026 LASSERT(req->rq_phase == RQ_PHASE_INTERPRET);
2028 /* This moves to "unregistering" phase we need to wait for
2030 if (!unregistered && !ptlrpc_unregister_reply(req, async)) {
2031 /* start async bulk unlink too */
2032 ptlrpc_unregister_bulk(req, 1);
2036 if (!ptlrpc_unregister_bulk(req, async))
2039 /* When calling interpret receiving already should be
2041 LASSERT(!req->rq_receiving_reply);
2043 ptlrpc_req_interpret(env, req, req->rq_status);
2045 if (ptlrpcd_check_work(req)) {
2046 atomic_dec(&set->set_remaining);
2049 ptlrpc_rqphase_move(req, RQ_PHASE_COMPLETE);
2051 if (req->rq_reqmsg != NULL)
2053 "Completed RPC pname:cluuid:pid:xid:nid:"
2054 "opc %s:%s:%d:%llu:%s:%d\n", current_comm(),
2055 imp->imp_obd->obd_uuid.uuid,
2056 lustre_msg_get_status(req->rq_reqmsg),
2058 obd_import_nid2str(imp),
2059 lustre_msg_get_opc(req->rq_reqmsg));
2061 spin_lock(&imp->imp_lock);
2062 /* Request already may be not on sending or delaying list. This
2063 * may happen in the case of marking it erroneous for the case
2064 * ptlrpc_import_delay_req(req, status) find it impossible to
2065 * allow sending this rpc and returns *status != 0. */
2066 if (!list_empty(&req->rq_list)) {
2067 list_del_init(&req->rq_list);
2068 atomic_dec(&imp->imp_inflight);
2070 list_del_init(&req->rq_unreplied_list);
2071 spin_unlock(&imp->imp_lock);
2073 atomic_dec(&set->set_remaining);
2074 wake_up_all(&imp->imp_recovery_waitq);
2076 if (set->set_producer) {
2077 /* produce a new request if possible */
2078 if (ptlrpc_set_producer(set) > 0)
2079 force_timer_recalc = 1;
2081 /* free the request that has just been completed
2082 * in order not to pollute set->set_requests */
2083 list_del_init(&req->rq_set_chain);
2084 spin_lock(&req->rq_lock);
2086 req->rq_invalid_rqset = 0;
2087 spin_unlock(&req->rq_lock);
2089 /* record rq_status to compute the final status later */
2090 if (req->rq_status != 0)
2091 set->set_rc = req->rq_status;
2092 ptlrpc_req_finished(req);
2094 list_move_tail(&req->rq_set_chain, &comp_reqs);
2098 /* move completed request at the head of list so it's easier for
2099 * caller to find them */
2100 list_splice(&comp_reqs, &set->set_requests);
2102 /* If we hit an error, we want to recover promptly. */
2103 RETURN(atomic_read(&set->set_remaining) == 0 || force_timer_recalc);
2105 EXPORT_SYMBOL(ptlrpc_check_set);
2108 * Time out request \a req. is \a async_unlink is set, that means do not wait
2109 * until LNet actually confirms network buffer unlinking.
2110 * Return 1 if we should give up further retrying attempts or 0 otherwise.
2112 int ptlrpc_expire_one_request(struct ptlrpc_request *req, int async_unlink)
2114 struct obd_import *imp = req->rq_import;
2115 unsigned int debug_mask = D_RPCTRACE;
2119 spin_lock(&req->rq_lock);
2120 req->rq_timedout = 1;
2121 spin_unlock(&req->rq_lock);
2123 if (ptlrpc_console_allow(req, lustre_msg_get_opc(req->rq_reqmsg),
2124 lustre_msg_get_status(req->rq_reqmsg)))
2125 debug_mask = D_WARNING;
2126 DEBUG_REQ(debug_mask, req, "Request sent has %s: [sent %lld/real %lld]",
2127 req->rq_net_err ? "failed due to network error" :
2128 ((req->rq_real_sent == 0 ||
2129 req->rq_real_sent < req->rq_sent ||
2130 req->rq_real_sent >= req->rq_deadline) ?
2131 "timed out for sent delay" : "timed out for slow reply"),
2132 (s64)req->rq_sent, (s64)req->rq_real_sent);
2134 if (imp != NULL && obd_debug_peer_on_timeout)
2135 LNetDebugPeer(imp->imp_connection->c_peer);
2137 ptlrpc_unregister_reply(req, async_unlink);
2138 ptlrpc_unregister_bulk(req, async_unlink);
2140 if (obd_dump_on_timeout)
2141 libcfs_debug_dumplog();
2144 DEBUG_REQ(D_HA, req, "NULL import: already cleaned up?");
2148 atomic_inc(&imp->imp_timeouts);
2150 /* The DLM server doesn't want recovery run on its imports. */
2151 if (imp->imp_dlm_fake)
2154 /* If this request is for recovery or other primordial tasks,
2155 * then error it out here. */
2156 if (req->rq_ctx_init || req->rq_ctx_fini ||
2157 req->rq_send_state != LUSTRE_IMP_FULL ||
2158 imp->imp_obd->obd_no_recov) {
2159 DEBUG_REQ(D_RPCTRACE, req, "err -110, sent_state=%s (now=%s)",
2160 ptlrpc_import_state_name(req->rq_send_state),
2161 ptlrpc_import_state_name(imp->imp_state));
2162 spin_lock(&req->rq_lock);
2163 req->rq_status = -ETIMEDOUT;
2165 spin_unlock(&req->rq_lock);
2169 /* if a request can't be resent we can't wait for an answer after
2171 if (ptlrpc_no_resend(req)) {
2172 DEBUG_REQ(D_RPCTRACE, req, "TIMEOUT-NORESEND:");
2176 ptlrpc_fail_import(imp, lustre_msg_get_conn_cnt(req->rq_reqmsg));
2182 * Time out all uncompleted requests in request set pointed by \a data
2183 * Callback used when waiting on sets with l_wait_event.
2186 int ptlrpc_expired_set(void *data)
2188 struct ptlrpc_request_set *set = data;
2189 struct list_head *tmp;
2190 time64_t now = ktime_get_real_seconds();
2193 LASSERT(set != NULL);
2196 * A timeout expired. See which reqs it applies to...
2198 list_for_each(tmp, &set->set_requests) {
2199 struct ptlrpc_request *req =
2200 list_entry(tmp, struct ptlrpc_request,
2203 /* don't expire request waiting for context */
2204 if (req->rq_wait_ctx)
2207 /* Request in-flight? */
2208 if (!((req->rq_phase == RQ_PHASE_RPC &&
2209 !req->rq_waiting && !req->rq_resend) ||
2210 (req->rq_phase == RQ_PHASE_BULK)))
2213 if (req->rq_timedout || /* already dealt with */
2214 req->rq_deadline > now) /* not expired */
2217 /* Deal with this guy. Do it asynchronously to not block
2218 * ptlrpcd thread. */
2219 ptlrpc_expire_one_request(req, 1);
2223 * When waiting for a whole set, we always break out of the
2224 * sleep so we can recalculate the timeout, or enable interrupts
2225 * if everyone's timed out.
2231 * Sets rq_intr flag in \a req under spinlock.
2233 void ptlrpc_mark_interrupted(struct ptlrpc_request *req)
2235 spin_lock(&req->rq_lock);
2237 spin_unlock(&req->rq_lock);
2239 EXPORT_SYMBOL(ptlrpc_mark_interrupted);
2242 * Interrupts (sets interrupted flag) all uncompleted requests in
2243 * a set \a data. Callback for l_wait_event for interruptible waits.
2245 static void ptlrpc_interrupted_set(void *data)
2247 struct ptlrpc_request_set *set = data;
2248 struct list_head *tmp;
2250 LASSERT(set != NULL);
2251 CDEBUG(D_RPCTRACE, "INTERRUPTED SET %p\n", set);
2253 list_for_each(tmp, &set->set_requests) {
2254 struct ptlrpc_request *req =
2255 list_entry(tmp, struct ptlrpc_request, rq_set_chain);
2260 if (req->rq_phase != RQ_PHASE_RPC &&
2261 req->rq_phase != RQ_PHASE_UNREG_RPC &&
2262 !req->rq_allow_intr)
2265 ptlrpc_mark_interrupted(req);
2270 * Get the smallest timeout in the set; this does NOT set a timeout.
2272 time64_t ptlrpc_set_next_timeout(struct ptlrpc_request_set *set)
2274 struct list_head *tmp;
2275 time64_t now = ktime_get_real_seconds();
2277 struct ptlrpc_request *req;
2281 list_for_each(tmp, &set->set_requests) {
2282 req = list_entry(tmp, struct ptlrpc_request, rq_set_chain);
2285 * Request in-flight?
2287 if (!(((req->rq_phase == RQ_PHASE_RPC) && !req->rq_waiting) ||
2288 (req->rq_phase == RQ_PHASE_BULK) ||
2289 (req->rq_phase == RQ_PHASE_NEW)))
2293 * Already timed out.
2295 if (req->rq_timedout)
2301 if (req->rq_wait_ctx)
2304 if (req->rq_phase == RQ_PHASE_NEW)
2305 deadline = req->rq_sent;
2306 else if (req->rq_phase == RQ_PHASE_RPC && req->rq_resend)
2307 deadline = req->rq_sent;
2309 deadline = req->rq_sent + req->rq_timeout;
2311 if (deadline <= now) /* actually expired already */
2312 timeout = 1; /* ASAP */
2313 else if (timeout == 0 || timeout > deadline - now)
2314 timeout = deadline - now;
2320 * Send all unset request from the set and then wait untill all
2321 * requests in the set complete (either get a reply, timeout, get an
2322 * error or otherwise be interrupted).
2323 * Returns 0 on success or error code otherwise.
2325 int ptlrpc_set_wait(const struct lu_env *env, struct ptlrpc_request_set *set)
2327 struct list_head *tmp;
2328 struct ptlrpc_request *req;
2329 struct l_wait_info lwi;
2335 if (set->set_producer)
2336 (void)ptlrpc_set_producer(set);
2338 list_for_each(tmp, &set->set_requests) {
2339 req = list_entry(tmp, struct ptlrpc_request,
2341 if (req->rq_phase == RQ_PHASE_NEW)
2342 (void)ptlrpc_send_new_req(req);
2345 if (list_empty(&set->set_requests))
2348 /* ideally we want env provide by the caller all the time,
2349 * but at the moment that would mean a massive change in
2350 * LDLM while benefits would be close to zero, so just
2351 * initialize env here for those rare cases */
2353 /* XXX: skip on the client side? */
2354 rc = lu_env_init(&_env, LCT_DT_THREAD);
2361 timeout = ptlrpc_set_next_timeout(set);
2363 /* wait until all complete, interrupted, or an in-flight
2365 CDEBUG(D_RPCTRACE, "set %p going to sleep for %lld seconds\n",
2368 if ((timeout == 0 && !signal_pending(current)) ||
2369 set->set_allow_intr)
2370 /* No requests are in-flight (ether timed out
2371 * or delayed), so we can allow interrupts.
2372 * We still want to block for a limited time,
2373 * so we allow interrupts during the timeout. */
2374 lwi = LWI_TIMEOUT_INTR_ALL(
2375 cfs_time_seconds(timeout ? timeout : 1),
2377 ptlrpc_interrupted_set, set);
2380 * At least one request is in flight, so no
2381 * interrupts are allowed. Wait until all
2382 * complete, or an in-flight req times out.
2384 lwi = LWI_TIMEOUT(cfs_time_seconds(timeout? timeout : 1),
2385 ptlrpc_expired_set, set);
2387 rc = l_wait_event(set->set_waitq,
2388 ptlrpc_check_set(env, set), &lwi);
2390 /* LU-769 - if we ignored the signal because it was already
2391 * pending when we started, we need to handle it now or we risk
2392 * it being ignored forever */
2393 if (rc == -ETIMEDOUT &&
2394 (!lwi.lwi_allow_intr || set->set_allow_intr) &&
2395 signal_pending(current)) {
2396 sigset_t blocked_sigs =
2397 cfs_block_sigsinv(LUSTRE_FATAL_SIGS);
2399 /* In fact we only interrupt for the "fatal" signals
2400 * like SIGINT or SIGKILL. We still ignore less
2401 * important signals since ptlrpc set is not easily
2402 * reentrant from userspace again */
2403 if (signal_pending(current))
2404 ptlrpc_interrupted_set(set);
2405 cfs_restore_sigs(blocked_sigs);
2408 LASSERT(rc == 0 || rc == -EINTR || rc == -ETIMEDOUT);
2410 /* -EINTR => all requests have been flagged rq_intr so next
2412 * -ETIMEDOUT => someone timed out. When all reqs have
2413 * timed out, signals are enabled allowing completion with
2415 * I don't really care if we go once more round the loop in
2416 * the error cases -eeb. */
2417 if (rc == 0 && atomic_read(&set->set_remaining) == 0) {
2418 list_for_each(tmp, &set->set_requests) {
2419 req = list_entry(tmp, struct ptlrpc_request,
2421 spin_lock(&req->rq_lock);
2422 req->rq_invalid_rqset = 1;
2423 spin_unlock(&req->rq_lock);
2426 } while (rc != 0 || atomic_read(&set->set_remaining) != 0);
2428 LASSERT(atomic_read(&set->set_remaining) == 0);
2430 rc = set->set_rc; /* rq_status of already freed requests if any */
2431 list_for_each(tmp, &set->set_requests) {
2432 req = list_entry(tmp, struct ptlrpc_request, rq_set_chain);
2434 LASSERT(req->rq_phase == RQ_PHASE_COMPLETE);
2435 if (req->rq_status != 0)
2436 rc = req->rq_status;
2439 if (env && env == &_env)
2444 EXPORT_SYMBOL(ptlrpc_set_wait);
2447 * Helper fuction for request freeing.
2448 * Called when request count reached zero and request needs to be freed.
2449 * Removes request from all sorts of sending/replay lists it might be on,
2450 * frees network buffers if any are present.
2451 * If \a locked is set, that means caller is already holding import imp_lock
2452 * and so we no longer need to reobtain it (for certain lists manipulations)
2454 static void __ptlrpc_free_req(struct ptlrpc_request *request, int locked)
2458 if (request == NULL)
2461 LASSERT(!request->rq_srv_req);
2462 LASSERT(request->rq_export == NULL);
2463 LASSERTF(!request->rq_receiving_reply, "req %p\n", request);
2464 LASSERTF(list_empty(&request->rq_list), "req %p\n", request);
2465 LASSERTF(list_empty(&request->rq_set_chain), "req %p\n", request);
2466 LASSERTF(!request->rq_replay, "req %p\n", request);
2468 req_capsule_fini(&request->rq_pill);
2470 /* We must take it off the imp_replay_list first. Otherwise, we'll set
2471 * request->rq_reqmsg to NULL while osc_close is dereferencing it. */
2472 if (request->rq_import != NULL) {
2474 spin_lock(&request->rq_import->imp_lock);
2475 list_del_init(&request->rq_replay_list);
2476 list_del_init(&request->rq_unreplied_list);
2478 spin_unlock(&request->rq_import->imp_lock);
2480 LASSERTF(list_empty(&request->rq_replay_list), "req %p\n", request);
2482 if (atomic_read(&request->rq_refcount) != 0) {
2483 DEBUG_REQ(D_ERROR, request,
2484 "freeing request with nonzero refcount");
2488 if (request->rq_repbuf != NULL)
2489 sptlrpc_cli_free_repbuf(request);
2491 if (request->rq_import != NULL) {
2492 class_import_put(request->rq_import);
2493 request->rq_import = NULL;
2495 if (request->rq_bulk != NULL)
2496 ptlrpc_free_bulk(request->rq_bulk);
2498 if (request->rq_reqbuf != NULL || request->rq_clrbuf != NULL)
2499 sptlrpc_cli_free_reqbuf(request);
2501 if (request->rq_cli_ctx)
2502 sptlrpc_req_put_ctx(request, !locked);
2504 if (request->rq_pool)
2505 __ptlrpc_free_req_to_pool(request);
2507 ptlrpc_request_cache_free(request);
2511 static int __ptlrpc_req_finished(struct ptlrpc_request *request, int locked);
2513 * Drop one request reference. Must be called with import imp_lock held.
2514 * When reference count drops to zero, request is freed.
2516 void ptlrpc_req_finished_with_imp_lock(struct ptlrpc_request *request)
2518 assert_spin_locked(&request->rq_import->imp_lock);
2519 (void)__ptlrpc_req_finished(request, 1);
2524 * Drops one reference count for request \a request.
2525 * \a locked set indicates that caller holds import imp_lock.
2526 * Frees the request whe reference count reaches zero.
2528 * \retval 1 the request is freed
2529 * \retval 0 some others still hold references on the request
2531 static int __ptlrpc_req_finished(struct ptlrpc_request *request, int locked)
2539 LASSERT(request != LP_POISON);
2540 LASSERT(request->rq_reqmsg != LP_POISON);
2542 DEBUG_REQ(D_INFO, request, "refcount now %u",
2543 atomic_read(&request->rq_refcount) - 1);
2545 spin_lock(&request->rq_lock);
2546 count = atomic_dec_return(&request->rq_refcount);
2547 LASSERTF(count >= 0, "Invalid ref count %d\n", count);
2549 /* For open RPC, the client does not know the EA size (LOV, ACL, and
2550 * so on) before replied, then the client has to reserve very large
2551 * reply buffer. Such buffer will not be released until the RPC freed.
2552 * Since The open RPC is replayable, we need to keep it in the replay
2553 * list until close. If there are a lot of files opened concurrently,
2554 * then the client may be OOM.
2556 * If fact, it is unnecessary to keep reply buffer for open replay,
2557 * related EAs have already been saved via mdc_save_lovea() before
2558 * coming here. So it is safe to free the reply buffer some earlier
2559 * before releasing the RPC to avoid client OOM. LU-9514 */
2560 if (count == 1 && request->rq_early_free_repbuf && request->rq_repbuf) {
2561 spin_lock(&request->rq_early_free_lock);
2562 sptlrpc_cli_free_repbuf(request);
2563 request->rq_repbuf = NULL;
2564 request->rq_repbuf_len = 0;
2565 request->rq_repdata = NULL;
2566 request->rq_reqdata_len = 0;
2567 spin_unlock(&request->rq_early_free_lock);
2569 spin_unlock(&request->rq_lock);
2572 __ptlrpc_free_req(request, locked);
2578 * Drops one reference count for a request.
2580 void ptlrpc_req_finished(struct ptlrpc_request *request)
2582 __ptlrpc_req_finished(request, 0);
2584 EXPORT_SYMBOL(ptlrpc_req_finished);
2587 * Returns xid of a \a request
2589 __u64 ptlrpc_req_xid(struct ptlrpc_request *request)
2591 return request->rq_xid;
2593 EXPORT_SYMBOL(ptlrpc_req_xid);
2596 * Disengage the client's reply buffer from the network
2597 * NB does _NOT_ unregister any client-side bulk.
2598 * IDEMPOTENT, but _not_ safe against concurrent callers.
2599 * The request owner (i.e. the thread doing the I/O) must call...
2600 * Returns 0 on success or 1 if unregistering cannot be made.
2602 static int ptlrpc_unregister_reply(struct ptlrpc_request *request, int async)
2605 struct l_wait_info lwi;
2610 LASSERT(!in_interrupt());
2612 /* Let's setup deadline for reply unlink. */
2613 if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK) &&
2614 async && request->rq_reply_deadline == 0 && cfs_fail_val == 0)
2615 request->rq_reply_deadline = ktime_get_real_seconds() +
2619 * Nothing left to do.
2621 if (!ptlrpc_client_recv_or_unlink(request))
2624 LNetMDUnlink(request->rq_reply_md_h);
2627 * Let's check it once again.
2629 if (!ptlrpc_client_recv_or_unlink(request))
2632 /* Move to "Unregistering" phase as reply was not unlinked yet. */
2633 ptlrpc_rqphase_move(request, RQ_PHASE_UNREG_RPC);
2636 * Do not wait for unlink to finish.
2642 * We have to l_wait_event() whatever the result, to give liblustre
2643 * a chance to run reply_in_callback(), and to make sure we've
2644 * unlinked before returning a req to the pool.
2647 /* The wq argument is ignored by user-space wait_event macros */
2648 wait_queue_head_t *wq = (request->rq_set != NULL) ?
2649 &request->rq_set->set_waitq :
2650 &request->rq_reply_waitq;
2651 /* Network access will complete in finite time but the HUGE
2652 * timeout lets us CWARN for visibility of sluggish NALs */
2653 lwi = LWI_TIMEOUT_INTERVAL(cfs_time_seconds(LONG_UNLINK),
2654 cfs_time_seconds(1), NULL, NULL);
2655 rc = l_wait_event(*wq, !ptlrpc_client_recv_or_unlink(request),
2658 ptlrpc_rqphase_move(request, request->rq_next_phase);
2662 LASSERT(rc == -ETIMEDOUT);
2663 DEBUG_REQ(D_WARNING, request, "Unexpectedly long timeout "
2664 "receiving_reply=%d req_ulinked=%d reply_unlinked=%d",
2665 request->rq_receiving_reply,
2666 request->rq_req_unlinked,
2667 request->rq_reply_unlinked);
2672 static void ptlrpc_free_request(struct ptlrpc_request *req)
2674 spin_lock(&req->rq_lock);
2676 spin_unlock(&req->rq_lock);
2678 if (req->rq_commit_cb != NULL)
2679 req->rq_commit_cb(req);
2680 list_del_init(&req->rq_replay_list);
2682 __ptlrpc_req_finished(req, 1);
2686 * the request is committed and dropped from the replay list of its import
2688 void ptlrpc_request_committed(struct ptlrpc_request *req, int force)
2690 struct obd_import *imp = req->rq_import;
2692 spin_lock(&imp->imp_lock);
2693 if (list_empty(&req->rq_replay_list)) {
2694 spin_unlock(&imp->imp_lock);
2698 if (force || req->rq_transno <= imp->imp_peer_committed_transno) {
2699 if (imp->imp_replay_cursor == &req->rq_replay_list)
2700 imp->imp_replay_cursor = req->rq_replay_list.next;
2701 ptlrpc_free_request(req);
2704 spin_unlock(&imp->imp_lock);
2706 EXPORT_SYMBOL(ptlrpc_request_committed);
2709 * Iterates through replay_list on import and prunes
2710 * all requests have transno smaller than last_committed for the
2711 * import and don't have rq_replay set.
2712 * Since requests are sorted in transno order, stops when meetign first
2713 * transno bigger than last_committed.
2714 * caller must hold imp->imp_lock
2716 void ptlrpc_free_committed(struct obd_import *imp)
2718 struct ptlrpc_request *req, *saved;
2719 struct ptlrpc_request *last_req = NULL; /* temporary fire escape */
2720 bool skip_committed_list = true;
2723 LASSERT(imp != NULL);
2724 assert_spin_locked(&imp->imp_lock);
2726 if (imp->imp_peer_committed_transno == imp->imp_last_transno_checked &&
2727 imp->imp_generation == imp->imp_last_generation_checked) {
2728 CDEBUG(D_INFO, "%s: skip recheck: last_committed %llu\n",
2729 imp->imp_obd->obd_name, imp->imp_peer_committed_transno);
2732 CDEBUG(D_RPCTRACE, "%s: committing for last_committed %llu gen %d\n",
2733 imp->imp_obd->obd_name, imp->imp_peer_committed_transno,
2734 imp->imp_generation);
2736 if (imp->imp_generation != imp->imp_last_generation_checked ||
2737 imp->imp_last_transno_checked == 0)
2738 skip_committed_list = false;
2740 imp->imp_last_transno_checked = imp->imp_peer_committed_transno;
2741 imp->imp_last_generation_checked = imp->imp_generation;
2743 list_for_each_entry_safe(req, saved, &imp->imp_replay_list,
2745 /* XXX ok to remove when 1357 resolved - rread 05/29/03 */
2746 LASSERT(req != last_req);
2749 if (req->rq_transno == 0) {
2750 DEBUG_REQ(D_EMERG, req, "zero transno during replay");
2753 if (req->rq_import_generation < imp->imp_generation) {
2754 DEBUG_REQ(D_RPCTRACE, req, "free request with old gen");
2758 /* not yet committed */
2759 if (req->rq_transno > imp->imp_peer_committed_transno) {
2760 DEBUG_REQ(D_RPCTRACE, req, "stopping search");
2764 if (req->rq_replay) {
2765 DEBUG_REQ(D_RPCTRACE, req, "keeping (FL_REPLAY)");
2766 list_move_tail(&req->rq_replay_list,
2767 &imp->imp_committed_list);
2771 DEBUG_REQ(D_INFO, req, "commit (last_committed %llu)",
2772 imp->imp_peer_committed_transno);
2774 ptlrpc_free_request(req);
2777 if (skip_committed_list)
2780 list_for_each_entry_safe(req, saved, &imp->imp_committed_list,
2782 LASSERT(req->rq_transno != 0);
2783 if (req->rq_import_generation < imp->imp_generation ||
2785 DEBUG_REQ(D_RPCTRACE, req, "free %s open request",
2786 req->rq_import_generation <
2787 imp->imp_generation ? "stale" : "closed");
2789 if (imp->imp_replay_cursor == &req->rq_replay_list)
2790 imp->imp_replay_cursor =
2791 req->rq_replay_list.next;
2793 ptlrpc_free_request(req);
2800 void ptlrpc_cleanup_client(struct obd_import *imp)
2807 * Schedule previously sent request for resend.
2808 * For bulk requests we assign new xid (to avoid problems with
2809 * lost replies and therefore several transfers landing into same buffer
2810 * from different sending attempts).
2812 void ptlrpc_resend_req(struct ptlrpc_request *req)
2814 DEBUG_REQ(D_HA, req, "going to resend");
2815 spin_lock(&req->rq_lock);
2817 /* Request got reply but linked to the import list still.
2818 Let ptlrpc_check_set() to process it. */
2819 if (ptlrpc_client_replied(req)) {
2820 spin_unlock(&req->rq_lock);
2821 DEBUG_REQ(D_HA, req, "it has reply, so skip it");
2825 req->rq_status = -EAGAIN;
2828 req->rq_net_err = 0;
2829 req->rq_timedout = 0;
2831 ptlrpc_client_wake_req(req);
2832 spin_unlock(&req->rq_lock);
2835 /* XXX: this function and rq_status are currently unused */
2836 void ptlrpc_restart_req(struct ptlrpc_request *req)
2838 DEBUG_REQ(D_HA, req, "restarting (possibly-)completed request");
2839 req->rq_status = -ERESTARTSYS;
2841 spin_lock(&req->rq_lock);
2842 req->rq_restart = 1;
2843 req->rq_timedout = 0;
2844 ptlrpc_client_wake_req(req);
2845 spin_unlock(&req->rq_lock);
2849 * Grab additional reference on a request \a req
2851 struct ptlrpc_request *ptlrpc_request_addref(struct ptlrpc_request *req)
2854 atomic_inc(&req->rq_refcount);
2857 EXPORT_SYMBOL(ptlrpc_request_addref);
2860 * Add a request to import replay_list.
2861 * Must be called under imp_lock
2863 void ptlrpc_retain_replayable_request(struct ptlrpc_request *req,
2864 struct obd_import *imp)
2866 struct list_head *tmp;
2868 assert_spin_locked(&imp->imp_lock);
2870 if (req->rq_transno == 0) {
2871 DEBUG_REQ(D_EMERG, req, "saving request with zero transno");
2875 /* clear this for new requests that were resent as well
2876 as resent replayed requests. */
2877 lustre_msg_clear_flags(req->rq_reqmsg, MSG_RESENT);
2879 /* don't re-add requests that have been replayed */
2880 if (!list_empty(&req->rq_replay_list))
2883 lustre_msg_add_flags(req->rq_reqmsg, MSG_REPLAY);
2885 spin_lock(&req->rq_lock);
2887 spin_unlock(&req->rq_lock);
2889 LASSERT(imp->imp_replayable);
2890 /* Balanced in ptlrpc_free_committed, usually. */
2891 ptlrpc_request_addref(req);
2892 list_for_each_prev(tmp, &imp->imp_replay_list) {
2893 struct ptlrpc_request *iter = list_entry(tmp,
2894 struct ptlrpc_request,
2897 /* We may have duplicate transnos if we create and then
2898 * open a file, or for closes retained if to match creating
2899 * opens, so use req->rq_xid as a secondary key.
2900 * (See bugs 684, 685, and 428.)
2901 * XXX no longer needed, but all opens need transnos!
2903 if (iter->rq_transno > req->rq_transno)
2906 if (iter->rq_transno == req->rq_transno) {
2907 LASSERT(iter->rq_xid != req->rq_xid);
2908 if (iter->rq_xid > req->rq_xid)
2912 list_add(&req->rq_replay_list, &iter->rq_replay_list);
2916 list_add(&req->rq_replay_list, &imp->imp_replay_list);
2920 * Send request and wait until it completes.
2921 * Returns request processing status.
2923 int ptlrpc_queue_wait(struct ptlrpc_request *req)
2925 struct ptlrpc_request_set *set;
2929 LASSERT(req->rq_set == NULL);
2930 LASSERT(!req->rq_receiving_reply);
2932 set = ptlrpc_prep_set();
2934 CERROR("cannot allocate ptlrpc set: rc = %d\n", -ENOMEM);
2938 /* for distributed debugging */
2939 lustre_msg_set_status(req->rq_reqmsg, current_pid());
2941 /* add a ref for the set (see comment in ptlrpc_set_add_req) */
2942 ptlrpc_request_addref(req);
2943 ptlrpc_set_add_req(set, req);
2944 rc = ptlrpc_set_wait(NULL, set);
2945 ptlrpc_set_destroy(set);
2949 EXPORT_SYMBOL(ptlrpc_queue_wait);
2952 * Callback used for replayed requests reply processing.
2953 * In case of successful reply calls registered request replay callback.
2954 * In case of error restart replay process.
2956 static int ptlrpc_replay_interpret(const struct lu_env *env,
2957 struct ptlrpc_request *req,
2960 struct ptlrpc_replay_async_args *aa = args;
2961 struct obd_import *imp = req->rq_import;
2964 atomic_dec(&imp->imp_replay_inflight);
2966 /* Note: if it is bulk replay (MDS-MDS replay), then even if
2967 * server got the request, but bulk transfer timeout, let's
2968 * replay the bulk req again */
2969 if (!ptlrpc_client_replied(req) ||
2970 (req->rq_bulk != NULL &&
2971 lustre_msg_get_status(req->rq_repmsg) == -ETIMEDOUT)) {
2972 DEBUG_REQ(D_ERROR, req, "request replay timed out.\n");
2973 GOTO(out, rc = -ETIMEDOUT);
2976 if (lustre_msg_get_type(req->rq_repmsg) == PTL_RPC_MSG_ERR &&
2977 (lustre_msg_get_status(req->rq_repmsg) == -ENOTCONN ||
2978 lustre_msg_get_status(req->rq_repmsg) == -ENODEV))
2979 GOTO(out, rc = lustre_msg_get_status(req->rq_repmsg));
2981 /** VBR: check version failure */
2982 if (lustre_msg_get_status(req->rq_repmsg) == -EOVERFLOW) {
2983 /** replay was failed due to version mismatch */
2984 DEBUG_REQ(D_WARNING, req, "Version mismatch during replay\n");
2985 spin_lock(&imp->imp_lock);
2986 imp->imp_vbr_failed = 1;
2987 spin_unlock(&imp->imp_lock);
2988 lustre_msg_set_status(req->rq_repmsg, aa->praa_old_status);
2990 /** The transno had better not change over replay. */
2991 LASSERTF(lustre_msg_get_transno(req->rq_reqmsg) ==
2992 lustre_msg_get_transno(req->rq_repmsg) ||
2993 lustre_msg_get_transno(req->rq_repmsg) == 0,
2995 lustre_msg_get_transno(req->rq_reqmsg),
2996 lustre_msg_get_transno(req->rq_repmsg));
2999 spin_lock(&imp->imp_lock);
3000 imp->imp_last_replay_transno = lustre_msg_get_transno(req->rq_reqmsg);
3001 spin_unlock(&imp->imp_lock);
3002 LASSERT(imp->imp_last_replay_transno);
3004 /* transaction number shouldn't be bigger than the latest replayed */
3005 if (req->rq_transno > lustre_msg_get_transno(req->rq_reqmsg)) {
3006 DEBUG_REQ(D_ERROR, req,
3007 "Reported transno %llu is bigger than the "
3008 "replayed one: %llu", req->rq_transno,
3009 lustre_msg_get_transno(req->rq_reqmsg));
3010 GOTO(out, rc = -EINVAL);
3013 DEBUG_REQ(D_HA, req, "got rep");
3015 /* let the callback do fixups, possibly including in the request */
3016 if (req->rq_replay_cb)
3017 req->rq_replay_cb(req);
3019 if (ptlrpc_client_replied(req) &&
3020 lustre_msg_get_status(req->rq_repmsg) != aa->praa_old_status) {
3021 DEBUG_REQ(D_ERROR, req, "status %d, old was %d",
3022 lustre_msg_get_status(req->rq_repmsg),
3023 aa->praa_old_status);
3025 /* Note: If the replay fails for MDT-MDT recovery, let's
3026 * abort all of the following requests in the replay
3027 * and sending list, because MDT-MDT update requests
3028 * are dependent on each other, see LU-7039 */
3029 if (imp->imp_connect_flags_orig & OBD_CONNECT_MDS_MDS) {
3030 struct ptlrpc_request *free_req;
3031 struct ptlrpc_request *tmp;
3033 spin_lock(&imp->imp_lock);
3034 list_for_each_entry_safe(free_req, tmp,
3035 &imp->imp_replay_list,
3037 ptlrpc_free_request(free_req);
3040 list_for_each_entry_safe(free_req, tmp,
3041 &imp->imp_committed_list,
3043 ptlrpc_free_request(free_req);
3046 list_for_each_entry_safe(free_req, tmp,
3047 &imp->imp_delayed_list,
3049 spin_lock(&free_req->rq_lock);
3050 free_req->rq_err = 1;
3051 free_req->rq_status = -EIO;
3052 ptlrpc_client_wake_req(free_req);
3053 spin_unlock(&free_req->rq_lock);
3056 list_for_each_entry_safe(free_req, tmp,
3057 &imp->imp_sending_list,
3059 spin_lock(&free_req->rq_lock);
3060 free_req->rq_err = 1;
3061 free_req->rq_status = -EIO;
3062 ptlrpc_client_wake_req(free_req);
3063 spin_unlock(&free_req->rq_lock);
3065 spin_unlock(&imp->imp_lock);
3068 /* Put it back for re-replay. */
3069 lustre_msg_set_status(req->rq_repmsg, aa->praa_old_status);
3073 * Errors while replay can set transno to 0, but
3074 * imp_last_replay_transno shouldn't be set to 0 anyway
3076 if (req->rq_transno == 0)
3077 CERROR("Transno is 0 during replay!\n");
3079 /* continue with recovery */
3080 rc = ptlrpc_import_recovery_state_machine(imp);
3082 req->rq_send_state = aa->praa_old_state;
3085 /* this replay failed, so restart recovery */
3086 ptlrpc_connect_import(imp);
3092 * Prepares and queues request for replay.
3093 * Adds it to ptlrpcd queue for actual sending.
3094 * Returns 0 on success.
3096 int ptlrpc_replay_req(struct ptlrpc_request *req)
3098 struct ptlrpc_replay_async_args *aa;
3102 LASSERT(req->rq_import->imp_state == LUSTRE_IMP_REPLAY);
3104 CLASSERT(sizeof(*aa) <= sizeof(req->rq_async_args));
3105 aa = ptlrpc_req_async_args(req);
3106 memset(aa, 0, sizeof(*aa));
3108 /* Prepare request to be resent with ptlrpcd */
3109 aa->praa_old_state = req->rq_send_state;
3110 req->rq_send_state = LUSTRE_IMP_REPLAY;
3111 req->rq_phase = RQ_PHASE_NEW;
3112 req->rq_next_phase = RQ_PHASE_UNDEFINED;
3114 aa->praa_old_status = lustre_msg_get_status(req->rq_repmsg);
3116 req->rq_interpret_reply = ptlrpc_replay_interpret;
3117 /* Readjust the timeout for current conditions */
3118 ptlrpc_at_set_req_timeout(req);
3120 /* Tell server net_latency to calculate how long to wait for reply. */
3121 lustre_msg_set_service_time(req->rq_reqmsg,
3122 ptlrpc_at_get_net_latency(req));
3123 DEBUG_REQ(D_HA, req, "REPLAY");
3125 atomic_inc(&req->rq_import->imp_replay_inflight);
3126 spin_lock(&req->rq_lock);
3127 req->rq_early_free_repbuf = 0;
3128 spin_unlock(&req->rq_lock);
3129 ptlrpc_request_addref(req); /* ptlrpcd needs a ref */
3131 ptlrpcd_add_req(req);
3136 * Aborts all in-flight request on import \a imp sending and delayed lists
3138 void ptlrpc_abort_inflight(struct obd_import *imp)
3140 struct list_head *tmp, *n;
3143 /* Make sure that no new requests get processed for this import.
3144 * ptlrpc_{queue,set}_wait must (and does) hold imp_lock while testing
3145 * this flag and then putting requests on sending_list or delayed_list.
3147 spin_lock(&imp->imp_lock);
3149 /* XXX locking? Maybe we should remove each request with the list
3150 * locked? Also, how do we know if the requests on the list are
3151 * being freed at this time?
3153 list_for_each_safe(tmp, n, &imp->imp_sending_list) {
3154 struct ptlrpc_request *req = list_entry(tmp,
3155 struct ptlrpc_request,
3158 DEBUG_REQ(D_RPCTRACE, req, "inflight");
3160 spin_lock(&req->rq_lock);
3161 if (req->rq_import_generation < imp->imp_generation) {
3163 req->rq_status = -EIO;
3164 ptlrpc_client_wake_req(req);
3166 spin_unlock(&req->rq_lock);
3169 list_for_each_safe(tmp, n, &imp->imp_delayed_list) {
3170 struct ptlrpc_request *req =
3171 list_entry(tmp, struct ptlrpc_request, rq_list);
3173 DEBUG_REQ(D_RPCTRACE, req, "aborting waiting req");
3175 spin_lock(&req->rq_lock);
3176 if (req->rq_import_generation < imp->imp_generation) {
3178 req->rq_status = -EIO;
3179 ptlrpc_client_wake_req(req);
3181 spin_unlock(&req->rq_lock);
3184 /* Last chance to free reqs left on the replay list, but we
3185 * will still leak reqs that haven't committed. */
3186 if (imp->imp_replayable)
3187 ptlrpc_free_committed(imp);
3189 spin_unlock(&imp->imp_lock);
3195 * Abort all uncompleted requests in request set \a set
3197 void ptlrpc_abort_set(struct ptlrpc_request_set *set)
3199 struct list_head *tmp, *pos;
3201 LASSERT(set != NULL);
3203 list_for_each_safe(pos, tmp, &set->set_requests) {
3204 struct ptlrpc_request *req =
3205 list_entry(pos, struct ptlrpc_request,
3208 spin_lock(&req->rq_lock);
3209 if (req->rq_phase != RQ_PHASE_RPC) {
3210 spin_unlock(&req->rq_lock);
3215 req->rq_status = -EINTR;
3216 ptlrpc_client_wake_req(req);
3217 spin_unlock(&req->rq_lock);
3221 static __u64 ptlrpc_last_xid;
3222 static spinlock_t ptlrpc_last_xid_lock;
3225 * Initialize the XID for the node. This is common among all requests on
3226 * this node, and only requires the property that it is monotonically
3227 * increasing. It does not need to be sequential. Since this is also used
3228 * as the RDMA match bits, it is important that a single client NOT have
3229 * the same match bits for two different in-flight requests, hence we do
3230 * NOT want to have an XID per target or similar.
3232 * To avoid an unlikely collision between match bits after a client reboot
3233 * (which would deliver old data into the wrong RDMA buffer) initialize
3234 * the XID based on the current time, assuming a maximum RPC rate of 1M RPC/s.
3235 * If the time is clearly incorrect, we instead use a 62-bit random number.
3236 * In the worst case the random number will overflow 1M RPCs per second in
3237 * 9133 years, or permutations thereof.
3239 #define YEAR_2004 (1ULL << 30)
3240 void ptlrpc_init_xid(void)
3242 time64_t now = ktime_get_real_seconds();
3244 spin_lock_init(&ptlrpc_last_xid_lock);
3245 if (now < YEAR_2004) {
3246 cfs_get_random_bytes(&ptlrpc_last_xid, sizeof(ptlrpc_last_xid));
3247 ptlrpc_last_xid >>= 2;
3248 ptlrpc_last_xid |= (1ULL << 61);
3250 ptlrpc_last_xid = (__u64)now << 20;
3253 /* Need to always be aligned to a power-of-two for mutli-bulk BRW */
3254 CLASSERT((PTLRPC_BULK_OPS_COUNT & (PTLRPC_BULK_OPS_COUNT - 1)) == 0);
3255 ptlrpc_last_xid &= PTLRPC_BULK_OPS_MASK;
3259 * Increase xid and returns resulting new value to the caller.
3261 * Multi-bulk BRW RPCs consume multiple XIDs for each bulk transfer, starting
3262 * at the returned xid, up to xid + PTLRPC_BULK_OPS_COUNT - 1. The BRW RPC
3263 * itself uses the last bulk xid needed, so the server can determine the
3264 * the number of bulk transfers from the RPC XID and a bitmask. The starting
3265 * xid must align to a power-of-two value.
3267 * This is assumed to be true due to the initial ptlrpc_last_xid
3268 * value also being initialized to a power-of-two value. LU-1431
3270 __u64 ptlrpc_next_xid(void)
3274 spin_lock(&ptlrpc_last_xid_lock);
3275 next = ptlrpc_last_xid + PTLRPC_BULK_OPS_COUNT;
3276 ptlrpc_last_xid = next;
3277 spin_unlock(&ptlrpc_last_xid_lock);
3283 * If request has a new allocated XID (new request or EINPROGRESS resend),
3284 * use this XID as matchbits of bulk, otherwise allocate a new matchbits for
3285 * request to ensure previous bulk fails and avoid problems with lost replies
3286 * and therefore several transfers landing into the same buffer from different
3289 void ptlrpc_set_bulk_mbits(struct ptlrpc_request *req)
3291 struct ptlrpc_bulk_desc *bd = req->rq_bulk;
3293 LASSERT(bd != NULL);
3295 /* Generate new matchbits for all resend requests, including
3297 if (req->rq_resend) {
3298 __u64 old_mbits = req->rq_mbits;
3300 /* First time resend on -EINPROGRESS will generate new xid,
3301 * so we can actually use the rq_xid as rq_mbits in such case,
3302 * however, it's bit hard to distinguish such resend with a
3303 * 'resend for the -EINPROGRESS resend'. To make it simple,
3304 * we opt to generate mbits for all resend cases. */
3305 if (OCD_HAS_FLAG(&bd->bd_import->imp_connect_data, BULK_MBITS)){
3306 req->rq_mbits = ptlrpc_next_xid();
3308 /* Old version transfers rq_xid to peer as
3310 spin_lock(&req->rq_import->imp_lock);
3311 list_del_init(&req->rq_unreplied_list);
3312 ptlrpc_assign_next_xid_nolock(req);
3313 spin_unlock(&req->rq_import->imp_lock);
3314 req->rq_mbits = req->rq_xid;
3316 CDEBUG(D_HA, "resend bulk old x%llu new x%llu\n",
3317 old_mbits, req->rq_mbits);
3318 } else if (!(lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY)) {
3319 /* Request being sent first time, use xid as matchbits. */
3320 req->rq_mbits = req->rq_xid;
3322 /* Replay request, xid and matchbits have already been
3323 * correctly assigned. */
3327 /* For multi-bulk RPCs, rq_mbits is the last mbits needed for bulks so
3328 * that server can infer the number of bulks that were prepared,
3330 req->rq_mbits += ((bd->bd_iov_count + LNET_MAX_IOV - 1) /
3333 /* Set rq_xid as rq_mbits to indicate the final bulk for the old
3334 * server which does not support OBD_CONNECT_BULK_MBITS. LU-6808.
3336 * It's ok to directly set the rq_xid here, since this xid bump
3337 * won't affect the request position in unreplied list. */
3338 if (!OCD_HAS_FLAG(&bd->bd_import->imp_connect_data, BULK_MBITS))
3339 req->rq_xid = req->rq_mbits;
3343 * Get a glimpse at what next xid value might have been.
3344 * Returns possible next xid.
3346 __u64 ptlrpc_sample_next_xid(void)
3348 #if BITS_PER_LONG == 32
3349 /* need to avoid possible word tearing on 32-bit systems */
3352 spin_lock(&ptlrpc_last_xid_lock);
3353 next = ptlrpc_last_xid + PTLRPC_BULK_OPS_COUNT;
3354 spin_unlock(&ptlrpc_last_xid_lock);
3358 /* No need to lock, since returned value is racy anyways */
3359 return ptlrpc_last_xid + PTLRPC_BULK_OPS_COUNT;
3362 EXPORT_SYMBOL(ptlrpc_sample_next_xid);
3365 * Functions for operating ptlrpc workers.
3367 * A ptlrpc work is a function which will be running inside ptlrpc context.
3368 * The callback shouldn't sleep otherwise it will block that ptlrpcd thread.
3370 * 1. after a work is created, it can be used many times, that is:
3371 * handler = ptlrpcd_alloc_work();
3372 * ptlrpcd_queue_work();
3374 * queue it again when necessary:
3375 * ptlrpcd_queue_work();
3376 * ptlrpcd_destroy_work();
3377 * 2. ptlrpcd_queue_work() can be called by multiple processes meanwhile, but
3378 * it will only be queued once in any time. Also as its name implies, it may
3379 * have delay before it really runs by ptlrpcd thread.
3381 struct ptlrpc_work_async_args {
3382 int (*cb)(const struct lu_env *, void *);
3386 static void ptlrpcd_add_work_req(struct ptlrpc_request *req)
3388 /* re-initialize the req */
3389 req->rq_timeout = obd_timeout;
3390 req->rq_sent = ktime_get_real_seconds();
3391 req->rq_deadline = req->rq_sent + req->rq_timeout;
3392 req->rq_phase = RQ_PHASE_INTERPRET;
3393 req->rq_next_phase = RQ_PHASE_COMPLETE;
3394 req->rq_xid = ptlrpc_next_xid();
3395 req->rq_import_generation = req->rq_import->imp_generation;
3397 ptlrpcd_add_req(req);
3400 static int work_interpreter(const struct lu_env *env,
3401 struct ptlrpc_request *req, void *args, int rc)
3403 struct ptlrpc_work_async_args *arg = args;
3405 LASSERT(ptlrpcd_check_work(req));
3406 LASSERT(arg->cb != NULL);
3408 rc = arg->cb(env, arg->cbdata);
3410 list_del_init(&req->rq_set_chain);
3413 if (atomic_dec_return(&req->rq_refcount) > 1) {
3414 atomic_set(&req->rq_refcount, 2);
3415 ptlrpcd_add_work_req(req);
3420 static int worker_format;
3422 static int ptlrpcd_check_work(struct ptlrpc_request *req)
3424 return req->rq_pill.rc_fmt == (void *)&worker_format;
3428 * Create a work for ptlrpc.
3430 void *ptlrpcd_alloc_work(struct obd_import *imp,
3431 int (*cb)(const struct lu_env *, void *), void *cbdata)
3433 struct ptlrpc_request *req = NULL;
3434 struct ptlrpc_work_async_args *args;
3440 RETURN(ERR_PTR(-EINVAL));
3442 /* copy some code from deprecated fakereq. */
3443 req = ptlrpc_request_cache_alloc(GFP_NOFS);
3445 CERROR("ptlrpc: run out of memory!\n");
3446 RETURN(ERR_PTR(-ENOMEM));
3449 ptlrpc_cli_req_init(req);
3451 req->rq_send_state = LUSTRE_IMP_FULL;
3452 req->rq_type = PTL_RPC_MSG_REQUEST;
3453 req->rq_import = class_import_get(imp);
3454 req->rq_interpret_reply = work_interpreter;
3455 /* don't want reply */
3456 req->rq_no_delay = req->rq_no_resend = 1;
3457 req->rq_pill.rc_fmt = (void *)&worker_format;
3459 CLASSERT(sizeof(*args) <= sizeof(req->rq_async_args));
3460 args = ptlrpc_req_async_args(req);
3462 args->cbdata = cbdata;
3466 EXPORT_SYMBOL(ptlrpcd_alloc_work);
3468 void ptlrpcd_destroy_work(void *handler)
3470 struct ptlrpc_request *req = handler;
3473 ptlrpc_req_finished(req);
3475 EXPORT_SYMBOL(ptlrpcd_destroy_work);
3477 int ptlrpcd_queue_work(void *handler)
3479 struct ptlrpc_request *req = handler;
3482 * Check if the req is already being queued.
3484 * Here comes a trick: it lacks a way of checking if a req is being
3485 * processed reliably in ptlrpc. Here I have to use refcount of req
3486 * for this purpose. This is okay because the caller should use this
3487 * req as opaque data. - Jinshan
3489 LASSERT(atomic_read(&req->rq_refcount) > 0);
3490 if (atomic_inc_return(&req->rq_refcount) == 2)
3491 ptlrpcd_add_work_req(req);
3494 EXPORT_SYMBOL(ptlrpcd_queue_work);