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;
869 request = __ptlrpc_request_alloc(imp, pool);
873 /* initiate connection if needed when the import has been
874 * referenced by the new request to avoid races with disconnect */
875 if (unlikely(imp->imp_state == LUSTRE_IMP_IDLE)) {
877 CDEBUG_LIMIT(imp->imp_idle_debug,
878 "%s: reconnect after %llds idle\n",
879 imp->imp_obd->obd_name, ktime_get_real_seconds() -
880 imp->imp_last_reply_time);
881 spin_lock(&imp->imp_lock);
882 if (imp->imp_state == LUSTRE_IMP_IDLE) {
883 imp->imp_generation++;
884 imp->imp_initiated_at = imp->imp_generation;
885 imp->imp_state = LUSTRE_IMP_NEW;
887 /* connect_import_locked releases imp_lock */
888 rc = ptlrpc_connect_import_locked(imp);
890 ptlrpc_request_free(request);
893 ptlrpc_pinger_add_import(imp);
895 spin_unlock(&imp->imp_lock);
899 req_capsule_init(&request->rq_pill, request, RCL_CLIENT);
900 req_capsule_set(&request->rq_pill, format);
905 * Allocate new request structure for import \a imp and initialize its
906 * buffer structure according to capsule template \a format.
908 struct ptlrpc_request *ptlrpc_request_alloc(struct obd_import *imp,
909 const struct req_format *format)
911 return ptlrpc_request_alloc_internal(imp, NULL, format);
913 EXPORT_SYMBOL(ptlrpc_request_alloc);
916 * Allocate new request structure for import \a imp from pool \a pool and
917 * initialize its buffer structure according to capsule template \a format.
919 struct ptlrpc_request *ptlrpc_request_alloc_pool(struct obd_import *imp,
920 struct ptlrpc_request_pool * pool,
921 const struct req_format *format)
923 return ptlrpc_request_alloc_internal(imp, pool, format);
925 EXPORT_SYMBOL(ptlrpc_request_alloc_pool);
928 * For requests not from pool, free memory of the request structure.
929 * For requests obtained from a pool earlier, return request back to pool.
931 void ptlrpc_request_free(struct ptlrpc_request *request)
933 if (request->rq_pool)
934 __ptlrpc_free_req_to_pool(request);
936 ptlrpc_request_cache_free(request);
938 EXPORT_SYMBOL(ptlrpc_request_free);
941 * Allocate new request for operatione \a opcode and immediatelly pack it for
943 * Only used for simple requests like OBD_PING where the only important
944 * part of the request is operation itself.
945 * Returns allocated request or NULL on error.
947 struct ptlrpc_request *ptlrpc_request_alloc_pack(struct obd_import *imp,
948 const struct req_format *format,
949 __u32 version, int opcode)
951 struct ptlrpc_request *req = ptlrpc_request_alloc(imp, format);
955 rc = ptlrpc_request_pack(req, version, opcode);
957 ptlrpc_request_free(req);
963 EXPORT_SYMBOL(ptlrpc_request_alloc_pack);
966 * Allocate and initialize new request set structure on the current CPT.
967 * Returns a pointer to the newly allocated set structure or NULL on error.
969 struct ptlrpc_request_set *ptlrpc_prep_set(void)
971 struct ptlrpc_request_set *set;
975 cpt = cfs_cpt_current(cfs_cpt_table, 0);
976 OBD_CPT_ALLOC(set, cfs_cpt_table, cpt, sizeof *set);
979 atomic_set(&set->set_refcount, 1);
980 INIT_LIST_HEAD(&set->set_requests);
981 init_waitqueue_head(&set->set_waitq);
982 atomic_set(&set->set_new_count, 0);
983 atomic_set(&set->set_remaining, 0);
984 spin_lock_init(&set->set_new_req_lock);
985 INIT_LIST_HEAD(&set->set_new_requests);
986 set->set_max_inflight = UINT_MAX;
987 set->set_producer = NULL;
988 set->set_producer_arg = NULL;
993 EXPORT_SYMBOL(ptlrpc_prep_set);
996 * Allocate and initialize new request set structure with flow control
997 * extension. This extension allows to control the number of requests in-flight
998 * for the whole set. A callback function to generate requests must be provided
999 * and the request set will keep the number of requests sent over the wire to
1001 * Returns a pointer to the newly allocated set structure or NULL on error.
1003 struct ptlrpc_request_set *ptlrpc_prep_fcset(int max, set_producer_func func,
1007 struct ptlrpc_request_set *set;
1009 set = ptlrpc_prep_set();
1013 set->set_max_inflight = max;
1014 set->set_producer = func;
1015 set->set_producer_arg = arg;
1021 * Wind down and free request set structure previously allocated with
1023 * Ensures that all requests on the set have completed and removes
1024 * all requests from the request list in a set.
1025 * If any unsent request happen to be on the list, pretends that they got
1026 * an error in flight and calls their completion handler.
1028 void ptlrpc_set_destroy(struct ptlrpc_request_set *set)
1030 struct list_head *tmp;
1031 struct list_head *next;
1036 /* Requests on the set should either all be completed, or all be new */
1037 expected_phase = (atomic_read(&set->set_remaining) == 0) ?
1038 RQ_PHASE_COMPLETE : RQ_PHASE_NEW;
1039 list_for_each(tmp, &set->set_requests) {
1040 struct ptlrpc_request *req =
1041 list_entry(tmp, struct ptlrpc_request,
1044 LASSERT(req->rq_phase == expected_phase);
1048 LASSERTF(atomic_read(&set->set_remaining) == 0 ||
1049 atomic_read(&set->set_remaining) == n, "%d / %d\n",
1050 atomic_read(&set->set_remaining), n);
1052 list_for_each_safe(tmp, next, &set->set_requests) {
1053 struct ptlrpc_request *req =
1054 list_entry(tmp, struct ptlrpc_request,
1056 list_del_init(&req->rq_set_chain);
1058 LASSERT(req->rq_phase == expected_phase);
1060 if (req->rq_phase == RQ_PHASE_NEW) {
1061 ptlrpc_req_interpret(NULL, req, -EBADR);
1062 atomic_dec(&set->set_remaining);
1065 spin_lock(&req->rq_lock);
1067 req->rq_invalid_rqset = 0;
1068 spin_unlock(&req->rq_lock);
1070 ptlrpc_req_finished (req);
1073 LASSERT(atomic_read(&set->set_remaining) == 0);
1075 ptlrpc_reqset_put(set);
1078 EXPORT_SYMBOL(ptlrpc_set_destroy);
1081 * Add a new request to the general purpose request set.
1082 * Assumes request reference from the caller.
1084 void ptlrpc_set_add_req(struct ptlrpc_request_set *set,
1085 struct ptlrpc_request *req)
1087 LASSERT(req->rq_import->imp_state != LUSTRE_IMP_IDLE);
1088 LASSERT(list_empty(&req->rq_set_chain));
1090 if (req->rq_allow_intr)
1091 set->set_allow_intr = 1;
1093 /* The set takes over the caller's request reference */
1094 list_add_tail(&req->rq_set_chain, &set->set_requests);
1096 atomic_inc(&set->set_remaining);
1097 req->rq_queued_time = ktime_get_seconds();
1099 if (req->rq_reqmsg != NULL)
1100 lustre_msg_set_jobid(req->rq_reqmsg, NULL);
1102 if (set->set_producer != NULL)
1103 /* If the request set has a producer callback, the RPC must be
1104 * sent straight away */
1105 ptlrpc_send_new_req(req);
1107 EXPORT_SYMBOL(ptlrpc_set_add_req);
1110 * Add a request to a request with dedicated server thread
1111 * and wake the thread to make any necessary processing.
1112 * Currently only used for ptlrpcd.
1114 void ptlrpc_set_add_new_req(struct ptlrpcd_ctl *pc,
1115 struct ptlrpc_request *req)
1117 struct ptlrpc_request_set *set = pc->pc_set;
1120 LASSERT(req->rq_set == NULL);
1121 LASSERT(test_bit(LIOD_STOP, &pc->pc_flags) == 0);
1123 spin_lock(&set->set_new_req_lock);
1125 * The set takes over the caller's request reference.
1128 req->rq_queued_time = ktime_get_seconds();
1129 list_add_tail(&req->rq_set_chain, &set->set_new_requests);
1130 count = atomic_inc_return(&set->set_new_count);
1131 spin_unlock(&set->set_new_req_lock);
1133 /* Only need to call wakeup once for the first entry. */
1135 wake_up(&set->set_waitq);
1137 /* XXX: It maybe unnecessary to wakeup all the partners. But to
1138 * guarantee the async RPC can be processed ASAP, we have
1139 * no other better choice. It maybe fixed in future. */
1140 for (i = 0; i < pc->pc_npartners; i++)
1141 wake_up(&pc->pc_partners[i]->pc_set->set_waitq);
1146 * Based on the current state of the import, determine if the request
1147 * can be sent, is an error, or should be delayed.
1149 * Returns true if this request should be delayed. If false, and
1150 * *status is set, then the request can not be sent and *status is the
1151 * error code. If false and status is 0, then request can be sent.
1153 * The imp->imp_lock must be held.
1155 static int ptlrpc_import_delay_req(struct obd_import *imp,
1156 struct ptlrpc_request *req, int *status)
1161 LASSERT (status != NULL);
1164 if (req->rq_ctx_init || req->rq_ctx_fini) {
1165 /* always allow ctx init/fini rpc go through */
1166 } else if (imp->imp_state == LUSTRE_IMP_NEW) {
1167 DEBUG_REQ(D_ERROR, req, "Uninitialized import.");
1169 } else if (imp->imp_state == LUSTRE_IMP_CLOSED) {
1170 unsigned int opc = lustre_msg_get_opc(req->rq_reqmsg);
1172 /* pings or MDS-equivalent STATFS may safely race with umount */
1173 DEBUG_REQ((opc == OBD_PING || opc == OST_STATFS) ?
1174 D_HA : D_ERROR, req, "IMP_CLOSED ");
1176 } else if (ptlrpc_send_limit_expired(req)) {
1177 /* probably doesn't need to be a D_ERROR after initial testing*/
1178 DEBUG_REQ(D_HA, req, "send limit expired ");
1179 *status = -ETIMEDOUT;
1180 } else if (req->rq_send_state == LUSTRE_IMP_CONNECTING &&
1181 imp->imp_state == LUSTRE_IMP_CONNECTING) {
1182 /* allow CONNECT even if import is invalid */ ;
1183 if (atomic_read(&imp->imp_inval_count) != 0) {
1184 DEBUG_REQ(D_ERROR, req, "invalidate in flight");
1187 } else if (imp->imp_invalid || imp->imp_obd->obd_no_recov) {
1188 if (!imp->imp_deactive)
1189 DEBUG_REQ(D_NET, req, "IMP_INVALID");
1190 *status = -ESHUTDOWN; /* bz 12940 */
1191 } else if (req->rq_import_generation != imp->imp_generation) {
1192 DEBUG_REQ(D_ERROR, req, "req wrong generation:");
1194 } else if (req->rq_send_state != imp->imp_state) {
1195 /* invalidate in progress - any requests should be drop */
1196 if (atomic_read(&imp->imp_inval_count) != 0) {
1197 DEBUG_REQ(D_ERROR, req, "invalidate in flight");
1199 } else if (req->rq_no_delay &&
1200 imp->imp_generation != imp->imp_initiated_at) {
1201 /* ignore nodelay for requests initiating connections */
1202 *status = -EWOULDBLOCK;
1203 } else if (req->rq_allow_replay &&
1204 (imp->imp_state == LUSTRE_IMP_REPLAY ||
1205 imp->imp_state == LUSTRE_IMP_REPLAY_LOCKS ||
1206 imp->imp_state == LUSTRE_IMP_REPLAY_WAIT ||
1207 imp->imp_state == LUSTRE_IMP_RECOVER)) {
1208 DEBUG_REQ(D_HA, req, "allow during recovery.\n");
1218 * Decide if the error message should be printed to the console or not.
1219 * Makes its decision based on request type, status, and failure frequency.
1221 * \param[in] req request that failed and may need a console message
1223 * \retval false if no message should be printed
1224 * \retval true if console message should be printed
1226 static bool ptlrpc_console_allow(struct ptlrpc_request *req, __u32 opc, int err)
1228 LASSERT(req->rq_reqmsg != NULL);
1230 /* Suppress particular reconnect errors which are to be expected. */
1231 if (opc == OST_CONNECT || opc == MDS_CONNECT || opc == MGS_CONNECT) {
1233 /* Suppress timed out reconnect requests */
1234 if (lustre_handle_is_used(&req->rq_import->imp_remote_handle) ||
1238 /* Suppress most unavailable/again reconnect requests, but
1239 * print occasionally so it is clear client is trying to
1240 * connect to a server where no target is running. */
1241 if ((err == -ENODEV || err == -EAGAIN) &&
1242 req->rq_import->imp_conn_cnt % 30 != 20)
1246 if (opc == LDLM_ENQUEUE && err == -EAGAIN)
1247 /* -EAGAIN is normal when using POSIX flocks */
1250 if (opc == OBD_PING && (err == -ENODEV || err == -ENOTCONN) &&
1251 (req->rq_xid & 0xf) != 10)
1252 /* Suppress most ping requests, they may fail occasionally */
1259 * Check request processing status.
1260 * Returns the status.
1262 static int ptlrpc_check_status(struct ptlrpc_request *req)
1267 err = lustre_msg_get_status(req->rq_repmsg);
1268 if (lustre_msg_get_type(req->rq_repmsg) == PTL_RPC_MSG_ERR) {
1269 struct obd_import *imp = req->rq_import;
1270 lnet_nid_t nid = imp->imp_connection->c_peer.nid;
1271 __u32 opc = lustre_msg_get_opc(req->rq_reqmsg);
1273 if (ptlrpc_console_allow(req, opc, err))
1274 LCONSOLE_ERROR_MSG(0x11, "%s: operation %s to node %s "
1275 "failed: rc = %d\n",
1276 imp->imp_obd->obd_name,
1278 libcfs_nid2str(nid), err);
1279 RETURN(err < 0 ? err : -EINVAL);
1283 DEBUG_REQ(D_INFO, req, "status is %d", err);
1284 } else if (err > 0) {
1285 /* XXX: translate this error from net to host */
1286 DEBUG_REQ(D_INFO, req, "status is %d", err);
1293 * save pre-versions of objects into request for replay.
1294 * Versions are obtained from server reply.
1297 static void ptlrpc_save_versions(struct ptlrpc_request *req)
1299 struct lustre_msg *repmsg = req->rq_repmsg;
1300 struct lustre_msg *reqmsg = req->rq_reqmsg;
1301 __u64 *versions = lustre_msg_get_versions(repmsg);
1304 if (lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY)
1308 lustre_msg_set_versions(reqmsg, versions);
1309 CDEBUG(D_INFO, "Client save versions [%#llx/%#llx]\n",
1310 versions[0], versions[1]);
1315 __u64 ptlrpc_known_replied_xid(struct obd_import *imp)
1317 struct ptlrpc_request *req;
1319 assert_spin_locked(&imp->imp_lock);
1320 if (list_empty(&imp->imp_unreplied_list))
1323 req = list_entry(imp->imp_unreplied_list.next, struct ptlrpc_request,
1325 LASSERTF(req->rq_xid >= 1, "XID:%llu\n", req->rq_xid);
1327 if (imp->imp_known_replied_xid < req->rq_xid - 1)
1328 imp->imp_known_replied_xid = req->rq_xid - 1;
1330 return req->rq_xid - 1;
1334 * Callback function called when client receives RPC reply for \a req.
1335 * Returns 0 on success or error code.
1336 * The return alue would be assigned to req->rq_status by the caller
1337 * as request processing status.
1338 * This function also decides if the request needs to be saved for later replay.
1340 static int after_reply(struct ptlrpc_request *req)
1342 struct obd_import *imp = req->rq_import;
1343 struct obd_device *obd = req->rq_import->imp_obd;
1350 LASSERT(obd != NULL);
1351 /* repbuf must be unlinked */
1352 LASSERT(!req->rq_receiving_reply && req->rq_reply_unlinked);
1354 if (req->rq_reply_truncated) {
1355 if (ptlrpc_no_resend(req)) {
1356 DEBUG_REQ(D_ERROR, req, "reply buffer overflow,"
1357 " expected: %d, actual size: %d",
1358 req->rq_nob_received, req->rq_repbuf_len);
1362 sptlrpc_cli_free_repbuf(req);
1363 /* Pass the required reply buffer size (include
1364 * space for early reply).
1365 * NB: no need to roundup because alloc_repbuf
1366 * will roundup it */
1367 req->rq_replen = req->rq_nob_received;
1368 req->rq_nob_received = 0;
1369 spin_lock(&req->rq_lock);
1371 spin_unlock(&req->rq_lock);
1375 work_start = ktime_get_real();
1376 timediff = ktime_us_delta(work_start, req->rq_sent_ns);
1379 * NB Until this point, the whole of the incoming message,
1380 * including buflens, status etc is in the sender's byte order.
1382 rc = sptlrpc_cli_unwrap_reply(req);
1384 DEBUG_REQ(D_ERROR, req, "unwrap reply failed (%d):", rc);
1389 * Security layer unwrap might ask resend this request.
1394 rc = unpack_reply(req);
1398 /* retry indefinitely on EINPROGRESS */
1399 if (lustre_msg_get_status(req->rq_repmsg) == -EINPROGRESS &&
1400 ptlrpc_no_resend(req) == 0 && !req->rq_no_retry_einprogress) {
1401 time64_t now = ktime_get_real_seconds();
1403 DEBUG_REQ(D_RPCTRACE, req, "Resending request on EINPROGRESS");
1404 spin_lock(&req->rq_lock);
1406 spin_unlock(&req->rq_lock);
1407 req->rq_nr_resend++;
1409 /* Readjust the timeout for current conditions */
1410 ptlrpc_at_set_req_timeout(req);
1411 /* delay resend to give a chance to the server to get ready.
1412 * The delay is increased by 1s on every resend and is capped to
1413 * the current request timeout (i.e. obd_timeout if AT is off,
1414 * or AT service time x 125% + 5s, see at_est2timeout) */
1415 if (req->rq_nr_resend > req->rq_timeout)
1416 req->rq_sent = now + req->rq_timeout;
1418 req->rq_sent = now + req->rq_nr_resend;
1420 /* Resend for EINPROGRESS will use a new XID */
1421 spin_lock(&imp->imp_lock);
1422 list_del_init(&req->rq_unreplied_list);
1423 spin_unlock(&imp->imp_lock);
1428 if (obd->obd_svc_stats != NULL) {
1429 lprocfs_counter_add(obd->obd_svc_stats, PTLRPC_REQWAIT_CNTR,
1431 ptlrpc_lprocfs_rpc_sent(req, timediff);
1434 if (lustre_msg_get_type(req->rq_repmsg) != PTL_RPC_MSG_REPLY &&
1435 lustre_msg_get_type(req->rq_repmsg) != PTL_RPC_MSG_ERR) {
1436 DEBUG_REQ(D_ERROR, req, "invalid packet received (type=%u)",
1437 lustre_msg_get_type(req->rq_repmsg));
1441 if (lustre_msg_get_opc(req->rq_reqmsg) != OBD_PING)
1442 CFS_FAIL_TIMEOUT(OBD_FAIL_PTLRPC_PAUSE_REP, cfs_fail_val);
1443 ptlrpc_at_adj_service(req, lustre_msg_get_timeout(req->rq_repmsg));
1444 ptlrpc_at_adj_net_latency(req,
1445 lustre_msg_get_service_time(req->rq_repmsg));
1447 rc = ptlrpc_check_status(req);
1448 imp->imp_connect_error = rc;
1452 * Either we've been evicted, or the server has failed for
1453 * some reason. Try to reconnect, and if that fails, punt to
1456 if (ptlrpc_recoverable_error(rc)) {
1457 if (req->rq_send_state != LUSTRE_IMP_FULL ||
1458 imp->imp_obd->obd_no_recov || imp->imp_dlm_fake) {
1461 ptlrpc_request_handle_notconn(req);
1466 * Let's look if server sent slv. Do it only for RPC with
1469 ldlm_cli_update_pool(req);
1473 * Store transno in reqmsg for replay.
1475 if (!(lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY)) {
1476 req->rq_transno = lustre_msg_get_transno(req->rq_repmsg);
1477 lustre_msg_set_transno(req->rq_reqmsg, req->rq_transno);
1480 if (imp->imp_replayable) {
1481 spin_lock(&imp->imp_lock);
1483 * No point in adding already-committed requests to the replay
1484 * list, we will just remove them immediately. b=9829
1486 if (req->rq_transno != 0 &&
1488 lustre_msg_get_last_committed(req->rq_repmsg) ||
1490 /** version recovery */
1491 ptlrpc_save_versions(req);
1492 ptlrpc_retain_replayable_request(req, imp);
1493 } else if (req->rq_commit_cb != NULL &&
1494 list_empty(&req->rq_replay_list)) {
1495 /* NB: don't call rq_commit_cb if it's already on
1496 * rq_replay_list, ptlrpc_free_committed() will call
1497 * it later, see LU-3618 for details */
1498 spin_unlock(&imp->imp_lock);
1499 req->rq_commit_cb(req);
1500 spin_lock(&imp->imp_lock);
1504 * Replay-enabled imports return commit-status information.
1506 committed = lustre_msg_get_last_committed(req->rq_repmsg);
1507 if (likely(committed > imp->imp_peer_committed_transno))
1508 imp->imp_peer_committed_transno = committed;
1510 ptlrpc_free_committed(imp);
1512 if (!list_empty(&imp->imp_replay_list)) {
1513 struct ptlrpc_request *last;
1515 last = list_entry(imp->imp_replay_list.prev,
1516 struct ptlrpc_request,
1519 * Requests with rq_replay stay on the list even if no
1520 * commit is expected.
1522 if (last->rq_transno > imp->imp_peer_committed_transno)
1523 ptlrpc_pinger_commit_expected(imp);
1526 spin_unlock(&imp->imp_lock);
1533 * Helper function to send request \a req over the network for the first time
1534 * Also adjusts request phase.
1535 * Returns 0 on success or error code.
1537 static int ptlrpc_send_new_req(struct ptlrpc_request *req)
1539 struct obd_import *imp = req->rq_import;
1544 LASSERT(req->rq_phase == RQ_PHASE_NEW);
1546 /* do not try to go further if there is not enough memory in enc_pool */
1547 if (req->rq_sent && req->rq_bulk != NULL)
1548 if (req->rq_bulk->bd_iov_count > get_free_pages_in_pool() &&
1549 pool_is_at_full_capacity())
1552 if (req->rq_sent && (req->rq_sent > ktime_get_real_seconds()) &&
1553 (!req->rq_generation_set ||
1554 req->rq_import_generation == imp->imp_generation))
1557 ptlrpc_rqphase_move(req, RQ_PHASE_RPC);
1559 spin_lock(&imp->imp_lock);
1561 LASSERT(req->rq_xid != 0);
1562 LASSERT(!list_empty(&req->rq_unreplied_list));
1564 if (!req->rq_generation_set)
1565 req->rq_import_generation = imp->imp_generation;
1567 if (ptlrpc_import_delay_req(imp, req, &rc)) {
1568 spin_lock(&req->rq_lock);
1569 req->rq_waiting = 1;
1570 spin_unlock(&req->rq_lock);
1572 DEBUG_REQ(D_HA, req, "req waiting for recovery: (%s != %s)",
1573 ptlrpc_import_state_name(req->rq_send_state),
1574 ptlrpc_import_state_name(imp->imp_state));
1575 LASSERT(list_empty(&req->rq_list));
1576 list_add_tail(&req->rq_list, &imp->imp_delayed_list);
1577 atomic_inc(&req->rq_import->imp_inflight);
1578 spin_unlock(&imp->imp_lock);
1583 spin_unlock(&imp->imp_lock);
1584 req->rq_status = rc;
1585 ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
1589 LASSERT(list_empty(&req->rq_list));
1590 list_add_tail(&req->rq_list, &imp->imp_sending_list);
1591 atomic_inc(&req->rq_import->imp_inflight);
1593 /* find the known replied XID from the unreplied list, CONNECT
1594 * and DISCONNECT requests are skipped to make the sanity check
1595 * on server side happy. see process_req_last_xid().
1597 * For CONNECT: Because replay requests have lower XID, it'll
1598 * break the sanity check if CONNECT bump the exp_last_xid on
1601 * For DISCONNECT: Since client will abort inflight RPC before
1602 * sending DISCONNECT, DISCONNECT may carry an XID which higher
1603 * than the inflight RPC.
1605 if (!ptlrpc_req_is_connect(req) && !ptlrpc_req_is_disconnect(req))
1606 min_xid = ptlrpc_known_replied_xid(imp);
1607 spin_unlock(&imp->imp_lock);
1609 lustre_msg_set_last_xid(req->rq_reqmsg, min_xid);
1611 lustre_msg_set_status(req->rq_reqmsg, current_pid());
1613 rc = sptlrpc_req_refresh_ctx(req, -1);
1616 req->rq_status = rc;
1619 spin_lock(&req->rq_lock);
1620 req->rq_wait_ctx = 1;
1621 spin_unlock(&req->rq_lock);
1626 CDEBUG(D_RPCTRACE, "Sending RPC pname:cluuid:pid:xid:nid:opc"
1627 " %s:%s:%d:%llu:%s:%d\n", current_comm(),
1628 imp->imp_obd->obd_uuid.uuid,
1629 lustre_msg_get_status(req->rq_reqmsg), req->rq_xid,
1630 obd_import_nid2str(imp), lustre_msg_get_opc(req->rq_reqmsg));
1632 rc = ptl_send_rpc(req, 0);
1633 if (rc == -ENOMEM) {
1634 spin_lock(&imp->imp_lock);
1635 if (!list_empty(&req->rq_list)) {
1636 list_del_init(&req->rq_list);
1637 atomic_dec(&req->rq_import->imp_inflight);
1639 spin_unlock(&imp->imp_lock);
1640 ptlrpc_rqphase_move(req, RQ_PHASE_NEW);
1644 DEBUG_REQ(D_HA, req, "send failed (%d); expect timeout", rc);
1645 spin_lock(&req->rq_lock);
1646 req->rq_net_err = 1;
1647 spin_unlock(&req->rq_lock);
1653 static inline int ptlrpc_set_producer(struct ptlrpc_request_set *set)
1658 LASSERT(set->set_producer != NULL);
1660 remaining = atomic_read(&set->set_remaining);
1662 /* populate the ->set_requests list with requests until we
1663 * reach the maximum number of RPCs in flight for this set */
1664 while (atomic_read(&set->set_remaining) < set->set_max_inflight) {
1665 rc = set->set_producer(set, set->set_producer_arg);
1666 if (rc == -ENOENT) {
1667 /* no more RPC to produce */
1668 set->set_producer = NULL;
1669 set->set_producer_arg = NULL;
1674 RETURN((atomic_read(&set->set_remaining) - remaining));
1678 * this sends any unsent RPCs in \a set and returns 1 if all are sent
1679 * and no more replies are expected.
1680 * (it is possible to get less replies than requests sent e.g. due to timed out
1681 * requests or requests that we had trouble to send out)
1683 * NOTE: This function contains a potential schedule point (cond_resched()).
1685 int ptlrpc_check_set(const struct lu_env *env, struct ptlrpc_request_set *set)
1687 struct list_head *tmp, *next;
1688 struct list_head comp_reqs;
1689 int force_timer_recalc = 0;
1692 if (atomic_read(&set->set_remaining) == 0)
1695 INIT_LIST_HEAD(&comp_reqs);
1696 list_for_each_safe(tmp, next, &set->set_requests) {
1697 struct ptlrpc_request *req =
1698 list_entry(tmp, struct ptlrpc_request,
1700 struct obd_import *imp = req->rq_import;
1701 int unregistered = 0;
1705 if (req->rq_phase == RQ_PHASE_COMPLETE) {
1706 list_move_tail(&req->rq_set_chain, &comp_reqs);
1710 /* This schedule point is mainly for the ptlrpcd caller of this
1711 * function. Most ptlrpc sets are not long-lived and unbounded
1712 * in length, but at the least the set used by the ptlrpcd is.
1713 * Since the processing time is unbounded, we need to insert an
1714 * explicit schedule point to make the thread well-behaved.
1718 /* If the caller requires to allow to be interpreted by force
1719 * and it has really been interpreted, then move the request
1720 * to RQ_PHASE_INTERPRET phase in spite of what the current
1722 if (unlikely(req->rq_allow_intr && req->rq_intr)) {
1723 req->rq_status = -EINTR;
1724 ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
1726 /* Since it is interpreted and we have to wait for
1727 * the reply to be unlinked, then use sync mode. */
1730 GOTO(interpret, req->rq_status);
1733 if (req->rq_phase == RQ_PHASE_NEW && ptlrpc_send_new_req(req))
1734 force_timer_recalc = 1;
1736 /* delayed send - skip */
1737 if (req->rq_phase == RQ_PHASE_NEW && req->rq_sent)
1740 /* delayed resend - skip */
1741 if (req->rq_phase == RQ_PHASE_RPC && req->rq_resend &&
1742 req->rq_sent > ktime_get_real_seconds())
1745 if (!(req->rq_phase == RQ_PHASE_RPC ||
1746 req->rq_phase == RQ_PHASE_BULK ||
1747 req->rq_phase == RQ_PHASE_INTERPRET ||
1748 req->rq_phase == RQ_PHASE_UNREG_RPC ||
1749 req->rq_phase == RQ_PHASE_UNREG_BULK)) {
1750 DEBUG_REQ(D_ERROR, req, "bad phase %x", req->rq_phase);
1754 if (req->rq_phase == RQ_PHASE_UNREG_RPC ||
1755 req->rq_phase == RQ_PHASE_UNREG_BULK) {
1756 LASSERT(req->rq_next_phase != req->rq_phase);
1757 LASSERT(req->rq_next_phase != RQ_PHASE_UNDEFINED);
1759 if (req->rq_req_deadline &&
1760 !OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REQ_UNLINK))
1761 req->rq_req_deadline = 0;
1762 if (req->rq_reply_deadline &&
1763 !OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK))
1764 req->rq_reply_deadline = 0;
1765 if (req->rq_bulk_deadline &&
1766 !OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_BULK_UNLINK))
1767 req->rq_bulk_deadline = 0;
1770 * Skip processing until reply is unlinked. We
1771 * can't return to pool before that and we can't
1772 * call interpret before that. We need to make
1773 * sure that all rdma transfers finished and will
1774 * not corrupt any data.
1776 if (req->rq_phase == RQ_PHASE_UNREG_RPC &&
1777 ptlrpc_client_recv_or_unlink(req))
1779 if (req->rq_phase == RQ_PHASE_UNREG_BULK &&
1780 ptlrpc_client_bulk_active(req))
1784 * Turn fail_loc off to prevent it from looping
1787 if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK)) {
1788 OBD_FAIL_CHECK_ORSET(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK,
1791 if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_BULK_UNLINK)) {
1792 OBD_FAIL_CHECK_ORSET(OBD_FAIL_PTLRPC_LONG_BULK_UNLINK,
1797 * Move to next phase if reply was successfully
1800 ptlrpc_rqphase_move(req, req->rq_next_phase);
1803 if (req->rq_phase == RQ_PHASE_INTERPRET)
1804 GOTO(interpret, req->rq_status);
1807 * Note that this also will start async reply unlink.
1809 if (req->rq_net_err && !req->rq_timedout) {
1810 ptlrpc_expire_one_request(req, 1);
1813 * Check if we still need to wait for unlink.
1815 if (ptlrpc_client_recv_or_unlink(req) ||
1816 ptlrpc_client_bulk_active(req))
1818 /* If there is no need to resend, fail it now. */
1819 if (req->rq_no_resend) {
1820 if (req->rq_status == 0)
1821 req->rq_status = -EIO;
1822 ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
1823 GOTO(interpret, req->rq_status);
1830 spin_lock(&req->rq_lock);
1831 req->rq_replied = 0;
1832 spin_unlock(&req->rq_lock);
1833 if (req->rq_status == 0)
1834 req->rq_status = -EIO;
1835 ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
1836 GOTO(interpret, req->rq_status);
1839 /* ptlrpc_set_wait->l_wait_event sets lwi_allow_intr
1840 * so it sets rq_intr regardless of individual rpc
1841 * timeouts. The synchronous IO waiting path sets
1842 * rq_intr irrespective of whether ptlrpcd
1843 * has seen a timeout. Our policy is to only interpret
1844 * interrupted rpcs after they have timed out, so we
1845 * need to enforce that here.
1848 if (req->rq_intr && (req->rq_timedout || req->rq_waiting ||
1849 req->rq_wait_ctx)) {
1850 req->rq_status = -EINTR;
1851 ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
1852 GOTO(interpret, req->rq_status);
1855 if (req->rq_phase == RQ_PHASE_RPC) {
1856 if (req->rq_timedout || req->rq_resend ||
1857 req->rq_waiting || req->rq_wait_ctx) {
1860 if (!ptlrpc_unregister_reply(req, 1)) {
1861 ptlrpc_unregister_bulk(req, 1);
1865 spin_lock(&imp->imp_lock);
1866 if (ptlrpc_import_delay_req(imp, req, &status)){
1867 /* put on delay list - only if we wait
1868 * recovery finished - before send */
1869 list_del_init(&req->rq_list);
1870 list_add_tail(&req->rq_list,
1873 spin_unlock(&imp->imp_lock);
1878 req->rq_status = status;
1879 ptlrpc_rqphase_move(req,
1880 RQ_PHASE_INTERPRET);
1881 spin_unlock(&imp->imp_lock);
1882 GOTO(interpret, req->rq_status);
1884 /* ignore on just initiated connections */
1885 if (ptlrpc_no_resend(req) &&
1886 !req->rq_wait_ctx &&
1887 imp->imp_generation !=
1888 imp->imp_initiated_at) {
1889 req->rq_status = -ENOTCONN;
1890 ptlrpc_rqphase_move(req,
1891 RQ_PHASE_INTERPRET);
1892 spin_unlock(&imp->imp_lock);
1893 GOTO(interpret, req->rq_status);
1896 list_del_init(&req->rq_list);
1897 list_add_tail(&req->rq_list,
1898 &imp->imp_sending_list);
1900 spin_unlock(&imp->imp_lock);
1902 spin_lock(&req->rq_lock);
1903 req->rq_waiting = 0;
1904 spin_unlock(&req->rq_lock);
1906 if (req->rq_timedout || req->rq_resend) {
1907 /* This is re-sending anyways,
1908 * let's mark req as resend. */
1909 spin_lock(&req->rq_lock);
1911 spin_unlock(&req->rq_lock);
1914 * rq_wait_ctx is only touched by ptlrpcd,
1915 * so no lock is needed here.
1917 status = sptlrpc_req_refresh_ctx(req, -1);
1920 req->rq_status = status;
1921 spin_lock(&req->rq_lock);
1922 req->rq_wait_ctx = 0;
1923 spin_unlock(&req->rq_lock);
1924 force_timer_recalc = 1;
1926 spin_lock(&req->rq_lock);
1927 req->rq_wait_ctx = 1;
1928 spin_unlock(&req->rq_lock);
1933 spin_lock(&req->rq_lock);
1934 req->rq_wait_ctx = 0;
1935 spin_unlock(&req->rq_lock);
1938 /* In any case, the previous bulk should be
1939 * cleaned up to prepare for the new sending */
1940 if (req->rq_bulk != NULL &&
1941 !ptlrpc_unregister_bulk(req, 1))
1944 rc = ptl_send_rpc(req, 0);
1945 if (rc == -ENOMEM) {
1946 spin_lock(&imp->imp_lock);
1947 if (!list_empty(&req->rq_list))
1948 list_del_init(&req->rq_list);
1949 spin_unlock(&imp->imp_lock);
1950 ptlrpc_rqphase_move(req, RQ_PHASE_NEW);
1954 DEBUG_REQ(D_HA, req,
1955 "send failed: rc = %d", rc);
1956 force_timer_recalc = 1;
1957 spin_lock(&req->rq_lock);
1958 req->rq_net_err = 1;
1959 spin_unlock(&req->rq_lock);
1962 /* need to reset the timeout */
1963 force_timer_recalc = 1;
1966 spin_lock(&req->rq_lock);
1968 if (ptlrpc_client_early(req)) {
1969 ptlrpc_at_recv_early_reply(req);
1970 spin_unlock(&req->rq_lock);
1974 /* Still waiting for a reply? */
1975 if (ptlrpc_client_recv(req)) {
1976 spin_unlock(&req->rq_lock);
1980 /* Did we actually receive a reply? */
1981 if (!ptlrpc_client_replied(req)) {
1982 spin_unlock(&req->rq_lock);
1986 spin_unlock(&req->rq_lock);
1988 /* unlink from net because we are going to
1989 * swab in-place of reply buffer */
1990 unregistered = ptlrpc_unregister_reply(req, 1);
1994 req->rq_status = after_reply(req);
1998 /* If there is no bulk associated with this request,
1999 * then we're done and should let the interpreter
2000 * process the reply. Similarly if the RPC returned
2001 * an error, and therefore the bulk will never arrive.
2003 if (req->rq_bulk == NULL || req->rq_status < 0) {
2004 ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
2005 GOTO(interpret, req->rq_status);
2008 ptlrpc_rqphase_move(req, RQ_PHASE_BULK);
2011 LASSERT(req->rq_phase == RQ_PHASE_BULK);
2012 if (ptlrpc_client_bulk_active(req))
2015 if (req->rq_bulk->bd_failure) {
2016 /* The RPC reply arrived OK, but the bulk screwed
2017 * up! Dead weird since the server told us the RPC
2018 * was good after getting the REPLY for her GET or
2019 * the ACK for her PUT. */
2020 DEBUG_REQ(D_ERROR, req, "bulk transfer failed");
2021 req->rq_status = -EIO;
2024 ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
2027 LASSERT(req->rq_phase == RQ_PHASE_INTERPRET);
2029 /* This moves to "unregistering" phase we need to wait for
2031 if (!unregistered && !ptlrpc_unregister_reply(req, async)) {
2032 /* start async bulk unlink too */
2033 ptlrpc_unregister_bulk(req, 1);
2037 if (!ptlrpc_unregister_bulk(req, async))
2040 /* When calling interpret receiving already should be
2042 LASSERT(!req->rq_receiving_reply);
2044 ptlrpc_req_interpret(env, req, req->rq_status);
2046 if (ptlrpcd_check_work(req)) {
2047 atomic_dec(&set->set_remaining);
2050 ptlrpc_rqphase_move(req, RQ_PHASE_COMPLETE);
2052 if (req->rq_reqmsg != NULL)
2054 "Completed RPC pname:cluuid:pid:xid:nid:"
2055 "opc %s:%s:%d:%llu:%s:%d\n", current_comm(),
2056 imp->imp_obd->obd_uuid.uuid,
2057 lustre_msg_get_status(req->rq_reqmsg),
2059 obd_import_nid2str(imp),
2060 lustre_msg_get_opc(req->rq_reqmsg));
2062 spin_lock(&imp->imp_lock);
2063 /* Request already may be not on sending or delaying list. This
2064 * may happen in the case of marking it erroneous for the case
2065 * ptlrpc_import_delay_req(req, status) find it impossible to
2066 * allow sending this rpc and returns *status != 0. */
2067 if (!list_empty(&req->rq_list)) {
2068 list_del_init(&req->rq_list);
2069 atomic_dec(&imp->imp_inflight);
2071 list_del_init(&req->rq_unreplied_list);
2072 spin_unlock(&imp->imp_lock);
2074 atomic_dec(&set->set_remaining);
2075 wake_up_all(&imp->imp_recovery_waitq);
2077 if (set->set_producer) {
2078 /* produce a new request if possible */
2079 if (ptlrpc_set_producer(set) > 0)
2080 force_timer_recalc = 1;
2082 /* free the request that has just been completed
2083 * in order not to pollute set->set_requests */
2084 list_del_init(&req->rq_set_chain);
2085 spin_lock(&req->rq_lock);
2087 req->rq_invalid_rqset = 0;
2088 spin_unlock(&req->rq_lock);
2090 /* record rq_status to compute the final status later */
2091 if (req->rq_status != 0)
2092 set->set_rc = req->rq_status;
2093 ptlrpc_req_finished(req);
2095 list_move_tail(&req->rq_set_chain, &comp_reqs);
2099 /* move completed request at the head of list so it's easier for
2100 * caller to find them */
2101 list_splice(&comp_reqs, &set->set_requests);
2103 /* If we hit an error, we want to recover promptly. */
2104 RETURN(atomic_read(&set->set_remaining) == 0 || force_timer_recalc);
2106 EXPORT_SYMBOL(ptlrpc_check_set);
2109 * Time out request \a req. is \a async_unlink is set, that means do not wait
2110 * until LNet actually confirms network buffer unlinking.
2111 * Return 1 if we should give up further retrying attempts or 0 otherwise.
2113 int ptlrpc_expire_one_request(struct ptlrpc_request *req, int async_unlink)
2115 struct obd_import *imp = req->rq_import;
2116 unsigned int debug_mask = D_RPCTRACE;
2120 spin_lock(&req->rq_lock);
2121 req->rq_timedout = 1;
2122 spin_unlock(&req->rq_lock);
2124 if (ptlrpc_console_allow(req, lustre_msg_get_opc(req->rq_reqmsg),
2125 lustre_msg_get_status(req->rq_reqmsg)))
2126 debug_mask = D_WARNING;
2127 DEBUG_REQ(debug_mask, req, "Request sent has %s: [sent %lld/real %lld]",
2128 req->rq_net_err ? "failed due to network error" :
2129 ((req->rq_real_sent == 0 ||
2130 req->rq_real_sent < req->rq_sent ||
2131 req->rq_real_sent >= req->rq_deadline) ?
2132 "timed out for sent delay" : "timed out for slow reply"),
2133 (s64)req->rq_sent, (s64)req->rq_real_sent);
2135 if (imp != NULL && obd_debug_peer_on_timeout)
2136 LNetDebugPeer(imp->imp_connection->c_peer);
2138 ptlrpc_unregister_reply(req, async_unlink);
2139 ptlrpc_unregister_bulk(req, async_unlink);
2141 if (obd_dump_on_timeout)
2142 libcfs_debug_dumplog();
2145 DEBUG_REQ(D_HA, req, "NULL import: already cleaned up?");
2149 atomic_inc(&imp->imp_timeouts);
2151 /* The DLM server doesn't want recovery run on its imports. */
2152 if (imp->imp_dlm_fake)
2155 /* If this request is for recovery or other primordial tasks,
2156 * then error it out here. */
2157 if (req->rq_ctx_init || req->rq_ctx_fini ||
2158 req->rq_send_state != LUSTRE_IMP_FULL ||
2159 imp->imp_obd->obd_no_recov) {
2160 DEBUG_REQ(D_RPCTRACE, req, "err -110, sent_state=%s (now=%s)",
2161 ptlrpc_import_state_name(req->rq_send_state),
2162 ptlrpc_import_state_name(imp->imp_state));
2163 spin_lock(&req->rq_lock);
2164 req->rq_status = -ETIMEDOUT;
2166 spin_unlock(&req->rq_lock);
2170 /* if a request can't be resent we can't wait for an answer after
2172 if (ptlrpc_no_resend(req)) {
2173 DEBUG_REQ(D_RPCTRACE, req, "TIMEOUT-NORESEND:");
2177 ptlrpc_fail_import(imp, lustre_msg_get_conn_cnt(req->rq_reqmsg));
2183 * Time out all uncompleted requests in request set pointed by \a data
2184 * Callback used when waiting on sets with l_wait_event.
2187 int ptlrpc_expired_set(void *data)
2189 struct ptlrpc_request_set *set = data;
2190 struct list_head *tmp;
2191 time64_t now = ktime_get_real_seconds();
2194 LASSERT(set != NULL);
2197 * A timeout expired. See which reqs it applies to...
2199 list_for_each(tmp, &set->set_requests) {
2200 struct ptlrpc_request *req =
2201 list_entry(tmp, struct ptlrpc_request,
2204 /* don't expire request waiting for context */
2205 if (req->rq_wait_ctx)
2208 /* Request in-flight? */
2209 if (!((req->rq_phase == RQ_PHASE_RPC &&
2210 !req->rq_waiting && !req->rq_resend) ||
2211 (req->rq_phase == RQ_PHASE_BULK)))
2214 if (req->rq_timedout || /* already dealt with */
2215 req->rq_deadline > now) /* not expired */
2218 /* Deal with this guy. Do it asynchronously to not block
2219 * ptlrpcd thread. */
2220 ptlrpc_expire_one_request(req, 1);
2224 * When waiting for a whole set, we always break out of the
2225 * sleep so we can recalculate the timeout, or enable interrupts
2226 * if everyone's timed out.
2232 * Sets rq_intr flag in \a req under spinlock.
2234 void ptlrpc_mark_interrupted(struct ptlrpc_request *req)
2236 spin_lock(&req->rq_lock);
2238 spin_unlock(&req->rq_lock);
2240 EXPORT_SYMBOL(ptlrpc_mark_interrupted);
2243 * Interrupts (sets interrupted flag) all uncompleted requests in
2244 * a set \a data. Callback for l_wait_event for interruptible waits.
2246 static void ptlrpc_interrupted_set(void *data)
2248 struct ptlrpc_request_set *set = data;
2249 struct list_head *tmp;
2251 LASSERT(set != NULL);
2252 CDEBUG(D_RPCTRACE, "INTERRUPTED SET %p\n", set);
2254 list_for_each(tmp, &set->set_requests) {
2255 struct ptlrpc_request *req =
2256 list_entry(tmp, struct ptlrpc_request, rq_set_chain);
2261 if (req->rq_phase != RQ_PHASE_RPC &&
2262 req->rq_phase != RQ_PHASE_UNREG_RPC &&
2263 !req->rq_allow_intr)
2266 ptlrpc_mark_interrupted(req);
2271 * Get the smallest timeout in the set; this does NOT set a timeout.
2273 time64_t ptlrpc_set_next_timeout(struct ptlrpc_request_set *set)
2275 struct list_head *tmp;
2276 time64_t now = ktime_get_real_seconds();
2278 struct ptlrpc_request *req;
2282 list_for_each(tmp, &set->set_requests) {
2283 req = list_entry(tmp, struct ptlrpc_request, rq_set_chain);
2286 * Request in-flight?
2288 if (!(((req->rq_phase == RQ_PHASE_RPC) && !req->rq_waiting) ||
2289 (req->rq_phase == RQ_PHASE_BULK) ||
2290 (req->rq_phase == RQ_PHASE_NEW)))
2294 * Already timed out.
2296 if (req->rq_timedout)
2302 if (req->rq_wait_ctx)
2305 if (req->rq_phase == RQ_PHASE_NEW)
2306 deadline = req->rq_sent;
2307 else if (req->rq_phase == RQ_PHASE_RPC && req->rq_resend)
2308 deadline = req->rq_sent;
2310 deadline = req->rq_sent + req->rq_timeout;
2312 if (deadline <= now) /* actually expired already */
2313 timeout = 1; /* ASAP */
2314 else if (timeout == 0 || timeout > deadline - now)
2315 timeout = deadline - now;
2321 * Send all unset request from the set and then wait untill all
2322 * requests in the set complete (either get a reply, timeout, get an
2323 * error or otherwise be interrupted).
2324 * Returns 0 on success or error code otherwise.
2326 int ptlrpc_set_wait(const struct lu_env *env, struct ptlrpc_request_set *set)
2328 struct list_head *tmp;
2329 struct ptlrpc_request *req;
2330 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))
2349 timeout = ptlrpc_set_next_timeout(set);
2351 /* wait until all complete, interrupted, or an in-flight
2353 CDEBUG(D_RPCTRACE, "set %p going to sleep for %lld seconds\n",
2356 if ((timeout == 0 && !signal_pending(current)) ||
2357 set->set_allow_intr)
2358 /* No requests are in-flight (ether timed out
2359 * or delayed), so we can allow interrupts.
2360 * We still want to block for a limited time,
2361 * so we allow interrupts during the timeout. */
2362 lwi = LWI_TIMEOUT_INTR_ALL(
2363 cfs_time_seconds(timeout ? timeout : 1),
2365 ptlrpc_interrupted_set, set);
2368 * At least one request is in flight, so no
2369 * interrupts are allowed. Wait until all
2370 * complete, or an in-flight req times out.
2372 lwi = LWI_TIMEOUT(cfs_time_seconds(timeout? timeout : 1),
2373 ptlrpc_expired_set, set);
2375 rc = l_wait_event(set->set_waitq,
2376 ptlrpc_check_set(NULL, set), &lwi);
2378 /* LU-769 - if we ignored the signal because it was already
2379 * pending when we started, we need to handle it now or we risk
2380 * it being ignored forever */
2381 if (rc == -ETIMEDOUT &&
2382 (!lwi.lwi_allow_intr || set->set_allow_intr) &&
2383 signal_pending(current)) {
2384 sigset_t blocked_sigs =
2385 cfs_block_sigsinv(LUSTRE_FATAL_SIGS);
2387 /* In fact we only interrupt for the "fatal" signals
2388 * like SIGINT or SIGKILL. We still ignore less
2389 * important signals since ptlrpc set is not easily
2390 * reentrant from userspace again */
2391 if (signal_pending(current))
2392 ptlrpc_interrupted_set(set);
2393 cfs_restore_sigs(blocked_sigs);
2396 LASSERT(rc == 0 || rc == -EINTR || rc == -ETIMEDOUT);
2398 /* -EINTR => all requests have been flagged rq_intr so next
2400 * -ETIMEDOUT => someone timed out. When all reqs have
2401 * timed out, signals are enabled allowing completion with
2403 * I don't really care if we go once more round the loop in
2404 * the error cases -eeb. */
2405 if (rc == 0 && atomic_read(&set->set_remaining) == 0) {
2406 list_for_each(tmp, &set->set_requests) {
2407 req = list_entry(tmp, struct ptlrpc_request,
2409 spin_lock(&req->rq_lock);
2410 req->rq_invalid_rqset = 1;
2411 spin_unlock(&req->rq_lock);
2414 } while (rc != 0 || atomic_read(&set->set_remaining) != 0);
2416 LASSERT(atomic_read(&set->set_remaining) == 0);
2418 rc = set->set_rc; /* rq_status of already freed requests if any */
2419 list_for_each(tmp, &set->set_requests) {
2420 req = list_entry(tmp, struct ptlrpc_request, rq_set_chain);
2422 LASSERT(req->rq_phase == RQ_PHASE_COMPLETE);
2423 if (req->rq_status != 0)
2424 rc = req->rq_status;
2429 EXPORT_SYMBOL(ptlrpc_set_wait);
2432 * Helper fuction for request freeing.
2433 * Called when request count reached zero and request needs to be freed.
2434 * Removes request from all sorts of sending/replay lists it might be on,
2435 * frees network buffers if any are present.
2436 * If \a locked is set, that means caller is already holding import imp_lock
2437 * and so we no longer need to reobtain it (for certain lists manipulations)
2439 static void __ptlrpc_free_req(struct ptlrpc_request *request, int locked)
2443 if (request == NULL)
2446 LASSERT(!request->rq_srv_req);
2447 LASSERT(request->rq_export == NULL);
2448 LASSERTF(!request->rq_receiving_reply, "req %p\n", request);
2449 LASSERTF(list_empty(&request->rq_list), "req %p\n", request);
2450 LASSERTF(list_empty(&request->rq_set_chain), "req %p\n", request);
2451 LASSERTF(!request->rq_replay, "req %p\n", request);
2453 req_capsule_fini(&request->rq_pill);
2455 /* We must take it off the imp_replay_list first. Otherwise, we'll set
2456 * request->rq_reqmsg to NULL while osc_close is dereferencing it. */
2457 if (request->rq_import != NULL) {
2459 spin_lock(&request->rq_import->imp_lock);
2460 list_del_init(&request->rq_replay_list);
2461 list_del_init(&request->rq_unreplied_list);
2463 spin_unlock(&request->rq_import->imp_lock);
2465 LASSERTF(list_empty(&request->rq_replay_list), "req %p\n", request);
2467 if (atomic_read(&request->rq_refcount) != 0) {
2468 DEBUG_REQ(D_ERROR, request,
2469 "freeing request with nonzero refcount");
2473 if (request->rq_repbuf != NULL)
2474 sptlrpc_cli_free_repbuf(request);
2476 if (request->rq_import != NULL) {
2477 class_import_put(request->rq_import);
2478 request->rq_import = NULL;
2480 if (request->rq_bulk != NULL)
2481 ptlrpc_free_bulk(request->rq_bulk);
2483 if (request->rq_reqbuf != NULL || request->rq_clrbuf != NULL)
2484 sptlrpc_cli_free_reqbuf(request);
2486 if (request->rq_cli_ctx)
2487 sptlrpc_req_put_ctx(request, !locked);
2489 if (request->rq_pool)
2490 __ptlrpc_free_req_to_pool(request);
2492 ptlrpc_request_cache_free(request);
2496 static int __ptlrpc_req_finished(struct ptlrpc_request *request, int locked);
2498 * Drop one request reference. Must be called with import imp_lock held.
2499 * When reference count drops to zero, request is freed.
2501 void ptlrpc_req_finished_with_imp_lock(struct ptlrpc_request *request)
2503 assert_spin_locked(&request->rq_import->imp_lock);
2504 (void)__ptlrpc_req_finished(request, 1);
2509 * Drops one reference count for request \a request.
2510 * \a locked set indicates that caller holds import imp_lock.
2511 * Frees the request whe reference count reaches zero.
2513 * \retval 1 the request is freed
2514 * \retval 0 some others still hold references on the request
2516 static int __ptlrpc_req_finished(struct ptlrpc_request *request, int locked)
2524 LASSERT(request != LP_POISON);
2525 LASSERT(request->rq_reqmsg != LP_POISON);
2527 DEBUG_REQ(D_INFO, request, "refcount now %u",
2528 atomic_read(&request->rq_refcount) - 1);
2530 spin_lock(&request->rq_lock);
2531 count = atomic_dec_return(&request->rq_refcount);
2532 LASSERTF(count >= 0, "Invalid ref count %d\n", count);
2534 /* For open RPC, the client does not know the EA size (LOV, ACL, and
2535 * so on) before replied, then the client has to reserve very large
2536 * reply buffer. Such buffer will not be released until the RPC freed.
2537 * Since The open RPC is replayable, we need to keep it in the replay
2538 * list until close. If there are a lot of files opened concurrently,
2539 * then the client may be OOM.
2541 * If fact, it is unnecessary to keep reply buffer for open replay,
2542 * related EAs have already been saved via mdc_save_lovea() before
2543 * coming here. So it is safe to free the reply buffer some earlier
2544 * before releasing the RPC to avoid client OOM. LU-9514 */
2545 if (count == 1 && request->rq_early_free_repbuf && request->rq_repbuf) {
2546 spin_lock(&request->rq_early_free_lock);
2547 sptlrpc_cli_free_repbuf(request);
2548 request->rq_repbuf = NULL;
2549 request->rq_repbuf_len = 0;
2550 request->rq_repdata = NULL;
2551 request->rq_reqdata_len = 0;
2552 spin_unlock(&request->rq_early_free_lock);
2554 spin_unlock(&request->rq_lock);
2557 __ptlrpc_free_req(request, locked);
2563 * Drops one reference count for a request.
2565 void ptlrpc_req_finished(struct ptlrpc_request *request)
2567 __ptlrpc_req_finished(request, 0);
2569 EXPORT_SYMBOL(ptlrpc_req_finished);
2572 * Returns xid of a \a request
2574 __u64 ptlrpc_req_xid(struct ptlrpc_request *request)
2576 return request->rq_xid;
2578 EXPORT_SYMBOL(ptlrpc_req_xid);
2581 * Disengage the client's reply buffer from the network
2582 * NB does _NOT_ unregister any client-side bulk.
2583 * IDEMPOTENT, but _not_ safe against concurrent callers.
2584 * The request owner (i.e. the thread doing the I/O) must call...
2585 * Returns 0 on success or 1 if unregistering cannot be made.
2587 static int ptlrpc_unregister_reply(struct ptlrpc_request *request, int async)
2590 struct l_wait_info lwi;
2595 LASSERT(!in_interrupt());
2597 /* Let's setup deadline for reply unlink. */
2598 if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK) &&
2599 async && request->rq_reply_deadline == 0 && cfs_fail_val == 0)
2600 request->rq_reply_deadline = ktime_get_real_seconds() +
2604 * Nothing left to do.
2606 if (!ptlrpc_client_recv_or_unlink(request))
2609 LNetMDUnlink(request->rq_reply_md_h);
2612 * Let's check it once again.
2614 if (!ptlrpc_client_recv_or_unlink(request))
2617 /* Move to "Unregistering" phase as reply was not unlinked yet. */
2618 ptlrpc_rqphase_move(request, RQ_PHASE_UNREG_RPC);
2621 * Do not wait for unlink to finish.
2627 * We have to l_wait_event() whatever the result, to give liblustre
2628 * a chance to run reply_in_callback(), and to make sure we've
2629 * unlinked before returning a req to the pool.
2632 /* The wq argument is ignored by user-space wait_event macros */
2633 wait_queue_head_t *wq = (request->rq_set != NULL) ?
2634 &request->rq_set->set_waitq :
2635 &request->rq_reply_waitq;
2636 /* Network access will complete in finite time but the HUGE
2637 * timeout lets us CWARN for visibility of sluggish NALs */
2638 lwi = LWI_TIMEOUT_INTERVAL(cfs_time_seconds(LONG_UNLINK),
2639 cfs_time_seconds(1), NULL, NULL);
2640 rc = l_wait_event(*wq, !ptlrpc_client_recv_or_unlink(request),
2643 ptlrpc_rqphase_move(request, request->rq_next_phase);
2647 LASSERT(rc == -ETIMEDOUT);
2648 DEBUG_REQ(D_WARNING, request, "Unexpectedly long timeout "
2649 "receiving_reply=%d req_ulinked=%d reply_unlinked=%d",
2650 request->rq_receiving_reply,
2651 request->rq_req_unlinked,
2652 request->rq_reply_unlinked);
2657 static void ptlrpc_free_request(struct ptlrpc_request *req)
2659 spin_lock(&req->rq_lock);
2661 spin_unlock(&req->rq_lock);
2663 if (req->rq_commit_cb != NULL)
2664 req->rq_commit_cb(req);
2665 list_del_init(&req->rq_replay_list);
2667 __ptlrpc_req_finished(req, 1);
2671 * the request is committed and dropped from the replay list of its import
2673 void ptlrpc_request_committed(struct ptlrpc_request *req, int force)
2675 struct obd_import *imp = req->rq_import;
2677 spin_lock(&imp->imp_lock);
2678 if (list_empty(&req->rq_replay_list)) {
2679 spin_unlock(&imp->imp_lock);
2683 if (force || req->rq_transno <= imp->imp_peer_committed_transno) {
2684 if (imp->imp_replay_cursor == &req->rq_replay_list)
2685 imp->imp_replay_cursor = req->rq_replay_list.next;
2686 ptlrpc_free_request(req);
2689 spin_unlock(&imp->imp_lock);
2691 EXPORT_SYMBOL(ptlrpc_request_committed);
2694 * Iterates through replay_list on import and prunes
2695 * all requests have transno smaller than last_committed for the
2696 * import and don't have rq_replay set.
2697 * Since requests are sorted in transno order, stops when meetign first
2698 * transno bigger than last_committed.
2699 * caller must hold imp->imp_lock
2701 void ptlrpc_free_committed(struct obd_import *imp)
2703 struct ptlrpc_request *req, *saved;
2704 struct ptlrpc_request *last_req = NULL; /* temporary fire escape */
2705 bool skip_committed_list = true;
2708 LASSERT(imp != NULL);
2709 assert_spin_locked(&imp->imp_lock);
2711 if (imp->imp_peer_committed_transno == imp->imp_last_transno_checked &&
2712 imp->imp_generation == imp->imp_last_generation_checked) {
2713 CDEBUG(D_INFO, "%s: skip recheck: last_committed %llu\n",
2714 imp->imp_obd->obd_name, imp->imp_peer_committed_transno);
2717 CDEBUG(D_RPCTRACE, "%s: committing for last_committed %llu gen %d\n",
2718 imp->imp_obd->obd_name, imp->imp_peer_committed_transno,
2719 imp->imp_generation);
2721 if (imp->imp_generation != imp->imp_last_generation_checked ||
2722 imp->imp_last_transno_checked == 0)
2723 skip_committed_list = false;
2725 imp->imp_last_transno_checked = imp->imp_peer_committed_transno;
2726 imp->imp_last_generation_checked = imp->imp_generation;
2728 list_for_each_entry_safe(req, saved, &imp->imp_replay_list,
2730 /* XXX ok to remove when 1357 resolved - rread 05/29/03 */
2731 LASSERT(req != last_req);
2734 if (req->rq_transno == 0) {
2735 DEBUG_REQ(D_EMERG, req, "zero transno during replay");
2738 if (req->rq_import_generation < imp->imp_generation) {
2739 DEBUG_REQ(D_RPCTRACE, req, "free request with old gen");
2743 /* not yet committed */
2744 if (req->rq_transno > imp->imp_peer_committed_transno) {
2745 DEBUG_REQ(D_RPCTRACE, req, "stopping search");
2749 if (req->rq_replay) {
2750 DEBUG_REQ(D_RPCTRACE, req, "keeping (FL_REPLAY)");
2751 list_move_tail(&req->rq_replay_list,
2752 &imp->imp_committed_list);
2756 DEBUG_REQ(D_INFO, req, "commit (last_committed %llu)",
2757 imp->imp_peer_committed_transno);
2759 ptlrpc_free_request(req);
2762 if (skip_committed_list)
2765 list_for_each_entry_safe(req, saved, &imp->imp_committed_list,
2767 LASSERT(req->rq_transno != 0);
2768 if (req->rq_import_generation < imp->imp_generation ||
2770 DEBUG_REQ(D_RPCTRACE, req, "free %s open request",
2771 req->rq_import_generation <
2772 imp->imp_generation ? "stale" : "closed");
2774 if (imp->imp_replay_cursor == &req->rq_replay_list)
2775 imp->imp_replay_cursor =
2776 req->rq_replay_list.next;
2778 ptlrpc_free_request(req);
2785 void ptlrpc_cleanup_client(struct obd_import *imp)
2792 * Schedule previously sent request for resend.
2793 * For bulk requests we assign new xid (to avoid problems with
2794 * lost replies and therefore several transfers landing into same buffer
2795 * from different sending attempts).
2797 void ptlrpc_resend_req(struct ptlrpc_request *req)
2799 DEBUG_REQ(D_HA, req, "going to resend");
2800 spin_lock(&req->rq_lock);
2802 /* Request got reply but linked to the import list still.
2803 Let ptlrpc_check_set() to process it. */
2804 if (ptlrpc_client_replied(req)) {
2805 spin_unlock(&req->rq_lock);
2806 DEBUG_REQ(D_HA, req, "it has reply, so skip it");
2810 req->rq_status = -EAGAIN;
2813 req->rq_net_err = 0;
2814 req->rq_timedout = 0;
2816 ptlrpc_client_wake_req(req);
2817 spin_unlock(&req->rq_lock);
2820 /* XXX: this function and rq_status are currently unused */
2821 void ptlrpc_restart_req(struct ptlrpc_request *req)
2823 DEBUG_REQ(D_HA, req, "restarting (possibly-)completed request");
2824 req->rq_status = -ERESTARTSYS;
2826 spin_lock(&req->rq_lock);
2827 req->rq_restart = 1;
2828 req->rq_timedout = 0;
2829 ptlrpc_client_wake_req(req);
2830 spin_unlock(&req->rq_lock);
2834 * Grab additional reference on a request \a req
2836 struct ptlrpc_request *ptlrpc_request_addref(struct ptlrpc_request *req)
2839 atomic_inc(&req->rq_refcount);
2842 EXPORT_SYMBOL(ptlrpc_request_addref);
2845 * Add a request to import replay_list.
2846 * Must be called under imp_lock
2848 void ptlrpc_retain_replayable_request(struct ptlrpc_request *req,
2849 struct obd_import *imp)
2851 struct list_head *tmp;
2853 assert_spin_locked(&imp->imp_lock);
2855 if (req->rq_transno == 0) {
2856 DEBUG_REQ(D_EMERG, req, "saving request with zero transno");
2860 /* clear this for new requests that were resent as well
2861 as resent replayed requests. */
2862 lustre_msg_clear_flags(req->rq_reqmsg, MSG_RESENT);
2864 /* don't re-add requests that have been replayed */
2865 if (!list_empty(&req->rq_replay_list))
2868 lustre_msg_add_flags(req->rq_reqmsg, MSG_REPLAY);
2870 spin_lock(&req->rq_lock);
2872 spin_unlock(&req->rq_lock);
2874 LASSERT(imp->imp_replayable);
2875 /* Balanced in ptlrpc_free_committed, usually. */
2876 ptlrpc_request_addref(req);
2877 list_for_each_prev(tmp, &imp->imp_replay_list) {
2878 struct ptlrpc_request *iter = list_entry(tmp,
2879 struct ptlrpc_request,
2882 /* We may have duplicate transnos if we create and then
2883 * open a file, or for closes retained if to match creating
2884 * opens, so use req->rq_xid as a secondary key.
2885 * (See bugs 684, 685, and 428.)
2886 * XXX no longer needed, but all opens need transnos!
2888 if (iter->rq_transno > req->rq_transno)
2891 if (iter->rq_transno == req->rq_transno) {
2892 LASSERT(iter->rq_xid != req->rq_xid);
2893 if (iter->rq_xid > req->rq_xid)
2897 list_add(&req->rq_replay_list, &iter->rq_replay_list);
2901 list_add(&req->rq_replay_list, &imp->imp_replay_list);
2905 * Send request and wait until it completes.
2906 * Returns request processing status.
2908 int ptlrpc_queue_wait(struct ptlrpc_request *req)
2910 struct ptlrpc_request_set *set;
2914 LASSERT(req->rq_set == NULL);
2915 LASSERT(!req->rq_receiving_reply);
2917 set = ptlrpc_prep_set();
2919 CERROR("cannot allocate ptlrpc set: rc = %d\n", -ENOMEM);
2923 /* for distributed debugging */
2924 lustre_msg_set_status(req->rq_reqmsg, current_pid());
2926 /* add a ref for the set (see comment in ptlrpc_set_add_req) */
2927 ptlrpc_request_addref(req);
2928 ptlrpc_set_add_req(set, req);
2929 rc = ptlrpc_set_wait(NULL, set);
2930 ptlrpc_set_destroy(set);
2934 EXPORT_SYMBOL(ptlrpc_queue_wait);
2937 * Callback used for replayed requests reply processing.
2938 * In case of successful reply calls registered request replay callback.
2939 * In case of error restart replay process.
2941 static int ptlrpc_replay_interpret(const struct lu_env *env,
2942 struct ptlrpc_request *req,
2943 void * data, int rc)
2945 struct ptlrpc_replay_async_args *aa = data;
2946 struct obd_import *imp = req->rq_import;
2949 atomic_dec(&imp->imp_replay_inflight);
2951 /* Note: if it is bulk replay (MDS-MDS replay), then even if
2952 * server got the request, but bulk transfer timeout, let's
2953 * replay the bulk req again */
2954 if (!ptlrpc_client_replied(req) ||
2955 (req->rq_bulk != NULL &&
2956 lustre_msg_get_status(req->rq_repmsg) == -ETIMEDOUT)) {
2957 DEBUG_REQ(D_ERROR, req, "request replay timed out.\n");
2958 GOTO(out, rc = -ETIMEDOUT);
2961 if (lustre_msg_get_type(req->rq_repmsg) == PTL_RPC_MSG_ERR &&
2962 (lustre_msg_get_status(req->rq_repmsg) == -ENOTCONN ||
2963 lustre_msg_get_status(req->rq_repmsg) == -ENODEV))
2964 GOTO(out, rc = lustre_msg_get_status(req->rq_repmsg));
2966 /** VBR: check version failure */
2967 if (lustre_msg_get_status(req->rq_repmsg) == -EOVERFLOW) {
2968 /** replay was failed due to version mismatch */
2969 DEBUG_REQ(D_WARNING, req, "Version mismatch during replay\n");
2970 spin_lock(&imp->imp_lock);
2971 imp->imp_vbr_failed = 1;
2972 spin_unlock(&imp->imp_lock);
2973 lustre_msg_set_status(req->rq_repmsg, aa->praa_old_status);
2975 /** The transno had better not change over replay. */
2976 LASSERTF(lustre_msg_get_transno(req->rq_reqmsg) ==
2977 lustre_msg_get_transno(req->rq_repmsg) ||
2978 lustre_msg_get_transno(req->rq_repmsg) == 0,
2980 lustre_msg_get_transno(req->rq_reqmsg),
2981 lustre_msg_get_transno(req->rq_repmsg));
2984 spin_lock(&imp->imp_lock);
2985 imp->imp_last_replay_transno = lustre_msg_get_transno(req->rq_reqmsg);
2986 spin_unlock(&imp->imp_lock);
2987 LASSERT(imp->imp_last_replay_transno);
2989 /* transaction number shouldn't be bigger than the latest replayed */
2990 if (req->rq_transno > lustre_msg_get_transno(req->rq_reqmsg)) {
2991 DEBUG_REQ(D_ERROR, req,
2992 "Reported transno %llu is bigger than the "
2993 "replayed one: %llu", req->rq_transno,
2994 lustre_msg_get_transno(req->rq_reqmsg));
2995 GOTO(out, rc = -EINVAL);
2998 DEBUG_REQ(D_HA, req, "got rep");
3000 /* let the callback do fixups, possibly including in the request */
3001 if (req->rq_replay_cb)
3002 req->rq_replay_cb(req);
3004 if (ptlrpc_client_replied(req) &&
3005 lustre_msg_get_status(req->rq_repmsg) != aa->praa_old_status) {
3006 DEBUG_REQ(D_ERROR, req, "status %d, old was %d",
3007 lustre_msg_get_status(req->rq_repmsg),
3008 aa->praa_old_status);
3010 /* Note: If the replay fails for MDT-MDT recovery, let's
3011 * abort all of the following requests in the replay
3012 * and sending list, because MDT-MDT update requests
3013 * are dependent on each other, see LU-7039 */
3014 if (imp->imp_connect_flags_orig & OBD_CONNECT_MDS_MDS) {
3015 struct ptlrpc_request *free_req;
3016 struct ptlrpc_request *tmp;
3018 spin_lock(&imp->imp_lock);
3019 list_for_each_entry_safe(free_req, tmp,
3020 &imp->imp_replay_list,
3022 ptlrpc_free_request(free_req);
3025 list_for_each_entry_safe(free_req, tmp,
3026 &imp->imp_committed_list,
3028 ptlrpc_free_request(free_req);
3031 list_for_each_entry_safe(free_req, tmp,
3032 &imp->imp_delayed_list,
3034 spin_lock(&free_req->rq_lock);
3035 free_req->rq_err = 1;
3036 free_req->rq_status = -EIO;
3037 ptlrpc_client_wake_req(free_req);
3038 spin_unlock(&free_req->rq_lock);
3041 list_for_each_entry_safe(free_req, tmp,
3042 &imp->imp_sending_list,
3044 spin_lock(&free_req->rq_lock);
3045 free_req->rq_err = 1;
3046 free_req->rq_status = -EIO;
3047 ptlrpc_client_wake_req(free_req);
3048 spin_unlock(&free_req->rq_lock);
3050 spin_unlock(&imp->imp_lock);
3053 /* Put it back for re-replay. */
3054 lustre_msg_set_status(req->rq_repmsg, aa->praa_old_status);
3058 * Errors while replay can set transno to 0, but
3059 * imp_last_replay_transno shouldn't be set to 0 anyway
3061 if (req->rq_transno == 0)
3062 CERROR("Transno is 0 during replay!\n");
3064 /* continue with recovery */
3065 rc = ptlrpc_import_recovery_state_machine(imp);
3067 req->rq_send_state = aa->praa_old_state;
3070 /* this replay failed, so restart recovery */
3071 ptlrpc_connect_import(imp);
3077 * Prepares and queues request for replay.
3078 * Adds it to ptlrpcd queue for actual sending.
3079 * Returns 0 on success.
3081 int ptlrpc_replay_req(struct ptlrpc_request *req)
3083 struct ptlrpc_replay_async_args *aa;
3087 LASSERT(req->rq_import->imp_state == LUSTRE_IMP_REPLAY);
3089 CLASSERT(sizeof(*aa) <= sizeof(req->rq_async_args));
3090 aa = ptlrpc_req_async_args(req);
3091 memset(aa, 0, sizeof(*aa));
3093 /* Prepare request to be resent with ptlrpcd */
3094 aa->praa_old_state = req->rq_send_state;
3095 req->rq_send_state = LUSTRE_IMP_REPLAY;
3096 req->rq_phase = RQ_PHASE_NEW;
3097 req->rq_next_phase = RQ_PHASE_UNDEFINED;
3099 aa->praa_old_status = lustre_msg_get_status(req->rq_repmsg);
3101 req->rq_interpret_reply = ptlrpc_replay_interpret;
3102 /* Readjust the timeout for current conditions */
3103 ptlrpc_at_set_req_timeout(req);
3105 /* Tell server the net_latency, so the server can calculate how long
3106 * it should wait for next replay */
3107 lustre_msg_set_service_time(req->rq_reqmsg,
3108 ptlrpc_at_get_net_latency(req));
3109 DEBUG_REQ(D_HA, req, "REPLAY");
3111 atomic_inc(&req->rq_import->imp_replay_inflight);
3112 spin_lock(&req->rq_lock);
3113 req->rq_early_free_repbuf = 0;
3114 spin_unlock(&req->rq_lock);
3115 ptlrpc_request_addref(req); /* ptlrpcd needs a ref */
3117 ptlrpcd_add_req(req);
3122 * Aborts all in-flight request on import \a imp sending and delayed lists
3124 void ptlrpc_abort_inflight(struct obd_import *imp)
3126 struct list_head *tmp, *n;
3130 * Make sure that no new requests get processed for this import.
3131 * ptlrpc_{queue,set}_wait must (and does) hold imp_lock while testing
3132 * this flag and then putting requests on sending_list or delayed_list.
3134 assert_spin_locked(&imp->imp_lock);
3136 /* XXX locking? Maybe we should remove each request with the list
3137 * locked? Also, how do we know if the requests on the list are
3138 * being freed at this time?
3140 list_for_each_safe(tmp, n, &imp->imp_sending_list) {
3141 struct ptlrpc_request *req = list_entry(tmp,
3142 struct ptlrpc_request,
3145 DEBUG_REQ(D_RPCTRACE, req, "inflight");
3147 spin_lock(&req->rq_lock);
3148 if (req->rq_import_generation < imp->imp_generation) {
3150 req->rq_status = -EIO;
3151 ptlrpc_client_wake_req(req);
3153 spin_unlock(&req->rq_lock);
3156 list_for_each_safe(tmp, n, &imp->imp_delayed_list) {
3157 struct ptlrpc_request *req =
3158 list_entry(tmp, struct ptlrpc_request, rq_list);
3160 DEBUG_REQ(D_RPCTRACE, req, "aborting waiting req");
3162 spin_lock(&req->rq_lock);
3163 if (req->rq_import_generation < imp->imp_generation) {
3165 req->rq_status = -EIO;
3166 ptlrpc_client_wake_req(req);
3168 spin_unlock(&req->rq_lock);
3171 /* Last chance to free reqs left on the replay list, but we
3172 * will still leak reqs that haven't committed. */
3173 if (imp->imp_replayable)
3174 ptlrpc_free_committed(imp);
3180 * Abort all uncompleted requests in request set \a set
3182 void ptlrpc_abort_set(struct ptlrpc_request_set *set)
3184 struct list_head *tmp, *pos;
3186 LASSERT(set != NULL);
3188 list_for_each_safe(pos, tmp, &set->set_requests) {
3189 struct ptlrpc_request *req =
3190 list_entry(pos, struct ptlrpc_request,
3193 spin_lock(&req->rq_lock);
3194 if (req->rq_phase != RQ_PHASE_RPC) {
3195 spin_unlock(&req->rq_lock);
3200 req->rq_status = -EINTR;
3201 ptlrpc_client_wake_req(req);
3202 spin_unlock(&req->rq_lock);
3206 static __u64 ptlrpc_last_xid;
3207 static spinlock_t ptlrpc_last_xid_lock;
3210 * Initialize the XID for the node. This is common among all requests on
3211 * this node, and only requires the property that it is monotonically
3212 * increasing. It does not need to be sequential. Since this is also used
3213 * as the RDMA match bits, it is important that a single client NOT have
3214 * the same match bits for two different in-flight requests, hence we do
3215 * NOT want to have an XID per target or similar.
3217 * To avoid an unlikely collision between match bits after a client reboot
3218 * (which would deliver old data into the wrong RDMA buffer) initialize
3219 * the XID based on the current time, assuming a maximum RPC rate of 1M RPC/s.
3220 * If the time is clearly incorrect, we instead use a 62-bit random number.
3221 * In the worst case the random number will overflow 1M RPCs per second in
3222 * 9133 years, or permutations thereof.
3224 #define YEAR_2004 (1ULL << 30)
3225 void ptlrpc_init_xid(void)
3227 time64_t now = ktime_get_real_seconds();
3229 spin_lock_init(&ptlrpc_last_xid_lock);
3230 if (now < YEAR_2004) {
3231 cfs_get_random_bytes(&ptlrpc_last_xid, sizeof(ptlrpc_last_xid));
3232 ptlrpc_last_xid >>= 2;
3233 ptlrpc_last_xid |= (1ULL << 61);
3235 ptlrpc_last_xid = (__u64)now << 20;
3238 /* Need to always be aligned to a power-of-two for mutli-bulk BRW */
3239 CLASSERT((PTLRPC_BULK_OPS_COUNT & (PTLRPC_BULK_OPS_COUNT - 1)) == 0);
3240 ptlrpc_last_xid &= PTLRPC_BULK_OPS_MASK;
3244 * Increase xid and returns resulting new value to the caller.
3246 * Multi-bulk BRW RPCs consume multiple XIDs for each bulk transfer, starting
3247 * at the returned xid, up to xid + PTLRPC_BULK_OPS_COUNT - 1. The BRW RPC
3248 * itself uses the last bulk xid needed, so the server can determine the
3249 * the number of bulk transfers from the RPC XID and a bitmask. The starting
3250 * xid must align to a power-of-two value.
3252 * This is assumed to be true due to the initial ptlrpc_last_xid
3253 * value also being initialized to a power-of-two value. LU-1431
3255 __u64 ptlrpc_next_xid(void)
3259 spin_lock(&ptlrpc_last_xid_lock);
3260 next = ptlrpc_last_xid + PTLRPC_BULK_OPS_COUNT;
3261 ptlrpc_last_xid = next;
3262 spin_unlock(&ptlrpc_last_xid_lock);
3268 * If request has a new allocated XID (new request or EINPROGRESS resend),
3269 * use this XID as matchbits of bulk, otherwise allocate a new matchbits for
3270 * request to ensure previous bulk fails and avoid problems with lost replies
3271 * and therefore several transfers landing into the same buffer from different
3274 void ptlrpc_set_bulk_mbits(struct ptlrpc_request *req)
3276 struct ptlrpc_bulk_desc *bd = req->rq_bulk;
3278 LASSERT(bd != NULL);
3280 /* Generate new matchbits for all resend requests, including
3282 if (req->rq_resend) {
3283 __u64 old_mbits = req->rq_mbits;
3285 /* First time resend on -EINPROGRESS will generate new xid,
3286 * so we can actually use the rq_xid as rq_mbits in such case,
3287 * however, it's bit hard to distinguish such resend with a
3288 * 'resend for the -EINPROGRESS resend'. To make it simple,
3289 * we opt to generate mbits for all resend cases. */
3290 if (OCD_HAS_FLAG(&bd->bd_import->imp_connect_data, BULK_MBITS)){
3291 req->rq_mbits = ptlrpc_next_xid();
3293 /* Old version transfers rq_xid to peer as
3295 spin_lock(&req->rq_import->imp_lock);
3296 list_del_init(&req->rq_unreplied_list);
3297 ptlrpc_assign_next_xid_nolock(req);
3298 spin_unlock(&req->rq_import->imp_lock);
3299 req->rq_mbits = req->rq_xid;
3301 CDEBUG(D_HA, "resend bulk old x%llu new x%llu\n",
3302 old_mbits, req->rq_mbits);
3303 } else if (!(lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY)) {
3304 /* Request being sent first time, use xid as matchbits. */
3305 req->rq_mbits = req->rq_xid;
3307 /* Replay request, xid and matchbits have already been
3308 * correctly assigned. */
3312 /* For multi-bulk RPCs, rq_mbits is the last mbits needed for bulks so
3313 * that server can infer the number of bulks that were prepared,
3315 req->rq_mbits += ((bd->bd_iov_count + LNET_MAX_IOV - 1) /
3318 /* Set rq_xid as rq_mbits to indicate the final bulk for the old
3319 * server which does not support OBD_CONNECT_BULK_MBITS. LU-6808.
3321 * It's ok to directly set the rq_xid here, since this xid bump
3322 * won't affect the request position in unreplied list. */
3323 if (!OCD_HAS_FLAG(&bd->bd_import->imp_connect_data, BULK_MBITS))
3324 req->rq_xid = req->rq_mbits;
3328 * Get a glimpse at what next xid value might have been.
3329 * Returns possible next xid.
3331 __u64 ptlrpc_sample_next_xid(void)
3333 #if BITS_PER_LONG == 32
3334 /* need to avoid possible word tearing on 32-bit systems */
3337 spin_lock(&ptlrpc_last_xid_lock);
3338 next = ptlrpc_last_xid + PTLRPC_BULK_OPS_COUNT;
3339 spin_unlock(&ptlrpc_last_xid_lock);
3343 /* No need to lock, since returned value is racy anyways */
3344 return ptlrpc_last_xid + PTLRPC_BULK_OPS_COUNT;
3347 EXPORT_SYMBOL(ptlrpc_sample_next_xid);
3350 * Functions for operating ptlrpc workers.
3352 * A ptlrpc work is a function which will be running inside ptlrpc context.
3353 * The callback shouldn't sleep otherwise it will block that ptlrpcd thread.
3355 * 1. after a work is created, it can be used many times, that is:
3356 * handler = ptlrpcd_alloc_work();
3357 * ptlrpcd_queue_work();
3359 * queue it again when necessary:
3360 * ptlrpcd_queue_work();
3361 * ptlrpcd_destroy_work();
3362 * 2. ptlrpcd_queue_work() can be called by multiple processes meanwhile, but
3363 * it will only be queued once in any time. Also as its name implies, it may
3364 * have delay before it really runs by ptlrpcd thread.
3366 struct ptlrpc_work_async_args {
3367 int (*cb)(const struct lu_env *, void *);
3371 static void ptlrpcd_add_work_req(struct ptlrpc_request *req)
3373 /* re-initialize the req */
3374 req->rq_timeout = obd_timeout;
3375 req->rq_sent = ktime_get_real_seconds();
3376 req->rq_deadline = req->rq_sent + req->rq_timeout;
3377 req->rq_phase = RQ_PHASE_INTERPRET;
3378 req->rq_next_phase = RQ_PHASE_COMPLETE;
3379 req->rq_xid = ptlrpc_next_xid();
3380 req->rq_import_generation = req->rq_import->imp_generation;
3382 ptlrpcd_add_req(req);
3385 static int work_interpreter(const struct lu_env *env,
3386 struct ptlrpc_request *req, void *data, int rc)
3388 struct ptlrpc_work_async_args *arg = data;
3390 LASSERT(ptlrpcd_check_work(req));
3391 LASSERT(arg->cb != NULL);
3393 rc = arg->cb(env, arg->cbdata);
3395 list_del_init(&req->rq_set_chain);
3398 if (atomic_dec_return(&req->rq_refcount) > 1) {
3399 atomic_set(&req->rq_refcount, 2);
3400 ptlrpcd_add_work_req(req);
3405 static int worker_format;
3407 static int ptlrpcd_check_work(struct ptlrpc_request *req)
3409 return req->rq_pill.rc_fmt == (void *)&worker_format;
3413 * Create a work for ptlrpc.
3415 void *ptlrpcd_alloc_work(struct obd_import *imp,
3416 int (*cb)(const struct lu_env *, void *), void *cbdata)
3418 struct ptlrpc_request *req = NULL;
3419 struct ptlrpc_work_async_args *args;
3425 RETURN(ERR_PTR(-EINVAL));
3427 /* copy some code from deprecated fakereq. */
3428 req = ptlrpc_request_cache_alloc(GFP_NOFS);
3430 CERROR("ptlrpc: run out of memory!\n");
3431 RETURN(ERR_PTR(-ENOMEM));
3434 ptlrpc_cli_req_init(req);
3436 req->rq_send_state = LUSTRE_IMP_FULL;
3437 req->rq_type = PTL_RPC_MSG_REQUEST;
3438 req->rq_import = class_import_get(imp);
3439 req->rq_interpret_reply = work_interpreter;
3440 /* don't want reply */
3441 req->rq_no_delay = req->rq_no_resend = 1;
3442 req->rq_pill.rc_fmt = (void *)&worker_format;
3444 CLASSERT(sizeof(*args) <= sizeof(req->rq_async_args));
3445 args = ptlrpc_req_async_args(req);
3447 args->cbdata = cbdata;
3451 EXPORT_SYMBOL(ptlrpcd_alloc_work);
3453 void ptlrpcd_destroy_work(void *handler)
3455 struct ptlrpc_request *req = handler;
3458 ptlrpc_req_finished(req);
3460 EXPORT_SYMBOL(ptlrpcd_destroy_work);
3462 int ptlrpcd_queue_work(void *handler)
3464 struct ptlrpc_request *req = handler;
3467 * Check if the req is already being queued.
3469 * Here comes a trick: it lacks a way of checking if a req is being
3470 * processed reliably in ptlrpc. Here I have to use refcount of req
3471 * for this purpose. This is okay because the caller should use this
3472 * req as opaque data. - Jinshan
3474 LASSERT(atomic_read(&req->rq_refcount) > 0);
3475 if (atomic_inc_return(&req->rq_refcount) == 2)
3476 ptlrpcd_add_work_req(req);
3479 EXPORT_SYMBOL(ptlrpcd_queue_work);