4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2014, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
37 /** Implementation of client-side PortalRPC interfaces */
39 #define DEBUG_SUBSYSTEM S_RPC
41 #include <obd_support.h>
42 #include <obd_class.h>
43 #include <lustre_lib.h>
44 #include <lustre_ha.h>
45 #include <lustre_import.h>
46 #include <lustre_req_layout.h>
48 #include "ptlrpc_internal.h"
50 const struct ptlrpc_bulk_frag_ops ptlrpc_bulk_kiov_pin_ops = {
51 .add_kiov_frag = ptlrpc_prep_bulk_page_pin,
52 .release_frags = ptlrpc_release_bulk_page_pin,
54 EXPORT_SYMBOL(ptlrpc_bulk_kiov_pin_ops);
56 const struct ptlrpc_bulk_frag_ops ptlrpc_bulk_kiov_nopin_ops = {
57 .add_kiov_frag = ptlrpc_prep_bulk_page_nopin,
58 .release_frags = ptlrpc_release_bulk_noop,
60 EXPORT_SYMBOL(ptlrpc_bulk_kiov_nopin_ops);
62 const struct ptlrpc_bulk_frag_ops ptlrpc_bulk_kvec_ops = {
63 .add_iov_frag = ptlrpc_prep_bulk_frag,
65 EXPORT_SYMBOL(ptlrpc_bulk_kvec_ops);
67 static int ptlrpc_send_new_req(struct ptlrpc_request *req);
68 static int ptlrpcd_check_work(struct ptlrpc_request *req);
69 static int ptlrpc_unregister_reply(struct ptlrpc_request *request, int async);
72 * Initialize passed in client structure \a cl.
74 void ptlrpc_init_client(int req_portal, int rep_portal, char *name,
75 struct ptlrpc_client *cl)
77 cl->cli_request_portal = req_portal;
78 cl->cli_reply_portal = rep_portal;
81 EXPORT_SYMBOL(ptlrpc_init_client);
84 * Return PortalRPC connection for remore uud \a uuid
86 struct ptlrpc_connection *ptlrpc_uuid_to_connection(struct obd_uuid *uuid)
88 struct ptlrpc_connection *c;
90 lnet_process_id_t peer;
93 /* ptlrpc_uuid_to_peer() initializes its 2nd parameter
94 * before accessing its values. */
95 /* coverity[uninit_use_in_call] */
96 err = ptlrpc_uuid_to_peer(uuid, &peer, &self);
98 CNETERR("cannot find peer %s!\n", uuid->uuid);
102 c = ptlrpc_connection_get(peer, self, uuid);
104 memcpy(c->c_remote_uuid.uuid,
105 uuid->uuid, sizeof(c->c_remote_uuid.uuid));
108 CDEBUG(D_INFO, "%s -> %p\n", uuid->uuid, c);
114 * Allocate and initialize new bulk descriptor on the sender.
115 * Returns pointer to the descriptor or NULL on error.
117 struct ptlrpc_bulk_desc *ptlrpc_new_bulk(unsigned nfrags, unsigned max_brw,
118 enum ptlrpc_bulk_op_type type,
120 const struct ptlrpc_bulk_frag_ops *ops)
122 struct ptlrpc_bulk_desc *desc;
125 /* ensure that only one of KIOV or IOVEC is set but not both */
126 LASSERT((ptlrpc_is_bulk_desc_kiov(type) &&
127 ops->add_kiov_frag != NULL) ||
128 (ptlrpc_is_bulk_desc_kvec(type) &&
129 ops->add_iov_frag != NULL));
131 if (type & PTLRPC_BULK_BUF_KIOV) {
133 offsetof(struct ptlrpc_bulk_desc,
134 bd_u.bd_kiov.bd_vec[nfrags]));
137 offsetof(struct ptlrpc_bulk_desc,
138 bd_u.bd_kvec.bd_kvec[nfrags]));
144 spin_lock_init(&desc->bd_lock);
145 init_waitqueue_head(&desc->bd_waitq);
146 desc->bd_max_iov = nfrags;
147 desc->bd_iov_count = 0;
148 desc->bd_portal = portal;
149 desc->bd_type = type;
150 desc->bd_md_count = 0;
151 desc->bd_frag_ops = (struct ptlrpc_bulk_frag_ops *) ops;
152 LASSERT(max_brw > 0);
153 desc->bd_md_max_brw = min(max_brw, PTLRPC_BULK_OPS_COUNT);
154 /* PTLRPC_BULK_OPS_COUNT is the compile-time transfer limit for this
155 * node. Negotiated ocd_brw_size will always be <= this number. */
156 for (i = 0; i < PTLRPC_BULK_OPS_COUNT; i++)
157 LNetInvalidateHandle(&desc->bd_mds[i]);
163 * Prepare bulk descriptor for specified outgoing request \a req that
164 * can fit \a nfrags * pages. \a type is bulk type. \a portal is where
165 * the bulk to be sent. Used on client-side.
166 * Returns pointer to newly allocatrd initialized bulk descriptor or NULL on
169 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk_imp(struct ptlrpc_request *req,
170 unsigned nfrags, unsigned max_brw,
173 const struct ptlrpc_bulk_frag_ops
176 struct obd_import *imp = req->rq_import;
177 struct ptlrpc_bulk_desc *desc;
180 LASSERT(ptlrpc_is_bulk_op_passive(type));
182 desc = ptlrpc_new_bulk(nfrags, max_brw, type, portal, ops);
186 desc->bd_import_generation = req->rq_import_generation;
187 desc->bd_import = class_import_get(imp);
190 desc->bd_cbid.cbid_fn = client_bulk_callback;
191 desc->bd_cbid.cbid_arg = desc;
193 /* This makes req own desc, and free it when she frees herself */
198 EXPORT_SYMBOL(ptlrpc_prep_bulk_imp);
200 void __ptlrpc_prep_bulk_page(struct ptlrpc_bulk_desc *desc,
201 struct page *page, int pageoffset, int len,
206 LASSERT(desc->bd_iov_count < desc->bd_max_iov);
207 LASSERT(page != NULL);
208 LASSERT(pageoffset >= 0);
210 LASSERT(pageoffset + len <= PAGE_CACHE_SIZE);
211 LASSERT(ptlrpc_is_bulk_desc_kiov(desc->bd_type));
213 kiov = &BD_GET_KIOV(desc, desc->bd_iov_count);
218 page_cache_get(page);
220 kiov->kiov_page = page;
221 kiov->kiov_offset = pageoffset;
222 kiov->kiov_len = len;
224 desc->bd_iov_count++;
226 EXPORT_SYMBOL(__ptlrpc_prep_bulk_page);
228 int ptlrpc_prep_bulk_frag(struct ptlrpc_bulk_desc *desc,
234 LASSERT(desc->bd_iov_count < desc->bd_max_iov);
235 LASSERT(frag != NULL);
237 LASSERT(ptlrpc_is_bulk_desc_kvec(desc->bd_type));
239 iovec = &BD_GET_KVEC(desc, desc->bd_iov_count);
243 iovec->iov_base = frag;
244 iovec->iov_len = len;
246 desc->bd_iov_count++;
248 RETURN(desc->bd_nob);
250 EXPORT_SYMBOL(ptlrpc_prep_bulk_frag);
252 void ptlrpc_free_bulk(struct ptlrpc_bulk_desc *desc)
256 LASSERT(desc != NULL);
257 LASSERT(desc->bd_iov_count != LI_POISON); /* not freed already */
258 LASSERT(desc->bd_md_count == 0); /* network hands off */
259 LASSERT((desc->bd_export != NULL) ^ (desc->bd_import != NULL));
260 LASSERT(desc->bd_frag_ops != NULL);
262 if (ptlrpc_is_bulk_desc_kiov(desc->bd_type))
263 sptlrpc_enc_pool_put_pages(desc);
266 class_export_put(desc->bd_export);
268 class_import_put(desc->bd_import);
270 if (desc->bd_frag_ops->release_frags != NULL)
271 desc->bd_frag_ops->release_frags(desc);
273 if (ptlrpc_is_bulk_desc_kiov(desc->bd_type))
274 OBD_FREE(desc, offsetof(struct ptlrpc_bulk_desc,
275 bd_u.bd_kiov.bd_vec[desc->bd_max_iov]));
277 OBD_FREE(desc, offsetof(struct ptlrpc_bulk_desc,
278 bd_u.bd_kvec.bd_kvec[desc->
283 EXPORT_SYMBOL(ptlrpc_free_bulk);
286 * Set server timelimit for this req, i.e. how long are we willing to wait
287 * for reply before timing out this request.
289 void ptlrpc_at_set_req_timeout(struct ptlrpc_request *req)
295 LASSERT(req->rq_import);
298 /* non-AT settings */
300 * \a imp_server_timeout means this is reverse import and
301 * we send (currently only) ASTs to the client and cannot afford
302 * to wait too long for the reply, otherwise the other client
303 * (because of which we are sending this request) would
304 * timeout waiting for us
306 req->rq_timeout = req->rq_import->imp_server_timeout ?
307 obd_timeout / 2 : obd_timeout;
309 at = &req->rq_import->imp_at;
310 idx = import_at_get_index(req->rq_import,
311 req->rq_request_portal);
312 serv_est = at_get(&at->iat_service_estimate[idx]);
313 req->rq_timeout = at_est2timeout(serv_est);
315 /* We could get even fancier here, using history to predict increased
318 /* Let the server know what this RPC timeout is by putting it in the
320 lustre_msg_set_timeout(req->rq_reqmsg, req->rq_timeout);
322 EXPORT_SYMBOL(ptlrpc_at_set_req_timeout);
324 /* Adjust max service estimate based on server value */
325 static void ptlrpc_at_adj_service(struct ptlrpc_request *req,
326 unsigned int serv_est)
332 LASSERT(req->rq_import);
333 at = &req->rq_import->imp_at;
335 idx = import_at_get_index(req->rq_import, req->rq_request_portal);
336 /* max service estimates are tracked on the server side,
337 so just keep minimal history here */
338 oldse = at_measured(&at->iat_service_estimate[idx], serv_est);
340 CDEBUG(D_ADAPTTO, "The RPC service estimate for %s ptl %d "
341 "has changed from %d to %d\n",
342 req->rq_import->imp_obd->obd_name,req->rq_request_portal,
343 oldse, at_get(&at->iat_service_estimate[idx]));
346 /* Expected network latency per remote node (secs) */
347 int ptlrpc_at_get_net_latency(struct ptlrpc_request *req)
349 return AT_OFF ? 0 : at_get(&req->rq_import->imp_at.iat_net_latency);
352 /* Adjust expected network latency */
353 void ptlrpc_at_adj_net_latency(struct ptlrpc_request *req,
354 unsigned int service_time)
356 unsigned int nl, oldnl;
358 time_t now = cfs_time_current_sec();
360 LASSERT(req->rq_import);
362 if (service_time > now - req->rq_sent + 3) {
363 /* bz16408, however, this can also happen if early reply
364 * is lost and client RPC is expired and resent, early reply
365 * or reply of original RPC can still be fit in reply buffer
366 * of resent RPC, now client is measuring time from the
367 * resent time, but server sent back service time of original
370 CDEBUG((lustre_msg_get_flags(req->rq_reqmsg) & MSG_RESENT) ?
371 D_ADAPTTO : D_WARNING,
372 "Reported service time %u > total measured time "
373 CFS_DURATION_T"\n", service_time,
374 cfs_time_sub(now, req->rq_sent));
378 /* Network latency is total time less server processing time */
379 nl = max_t(int, now - req->rq_sent -
380 service_time, 0) + 1; /* st rounding */
381 at = &req->rq_import->imp_at;
383 oldnl = at_measured(&at->iat_net_latency, nl);
385 CDEBUG(D_ADAPTTO, "The network latency for %s (nid %s) "
386 "has changed from %d to %d\n",
387 req->rq_import->imp_obd->obd_name,
389 &req->rq_import->imp_connection->c_remote_uuid),
390 oldnl, at_get(&at->iat_net_latency));
393 static int unpack_reply(struct ptlrpc_request *req)
397 if (SPTLRPC_FLVR_POLICY(req->rq_flvr.sf_rpc) != SPTLRPC_POLICY_NULL) {
398 rc = ptlrpc_unpack_rep_msg(req, req->rq_replen);
400 DEBUG_REQ(D_ERROR, req, "unpack_rep failed: %d", rc);
405 rc = lustre_unpack_rep_ptlrpc_body(req, MSG_PTLRPC_BODY_OFF);
407 DEBUG_REQ(D_ERROR, req, "unpack ptlrpc body failed: %d", rc);
414 * Handle an early reply message, called with the rq_lock held.
415 * If anything goes wrong just ignore it - same as if it never happened
417 static int ptlrpc_at_recv_early_reply(struct ptlrpc_request *req)
418 __must_hold(&req->rq_lock)
420 struct ptlrpc_request *early_req;
426 spin_unlock(&req->rq_lock);
428 rc = sptlrpc_cli_unwrap_early_reply(req, &early_req);
430 spin_lock(&req->rq_lock);
434 rc = unpack_reply(early_req);
436 sptlrpc_cli_finish_early_reply(early_req);
437 spin_lock(&req->rq_lock);
441 /* Use new timeout value just to adjust the local value for this
442 * request, don't include it into at_history. It is unclear yet why
443 * service time increased and should it be counted or skipped, e.g.
444 * that can be recovery case or some error or server, the real reply
445 * will add all new data if it is worth to add. */
446 req->rq_timeout = lustre_msg_get_timeout(early_req->rq_repmsg);
447 lustre_msg_set_timeout(req->rq_reqmsg, req->rq_timeout);
449 /* Network latency can be adjusted, it is pure network delays */
450 ptlrpc_at_adj_net_latency(req,
451 lustre_msg_get_service_time(early_req->rq_repmsg));
453 sptlrpc_cli_finish_early_reply(early_req);
455 spin_lock(&req->rq_lock);
456 olddl = req->rq_deadline;
457 /* server assumes it now has rq_timeout from when the request
458 * arrived, so the client should give it at least that long.
459 * since we don't know the arrival time we'll use the original
461 req->rq_deadline = req->rq_sent + req->rq_timeout +
462 ptlrpc_at_get_net_latency(req);
464 DEBUG_REQ(D_ADAPTTO, req,
465 "Early reply #%d, new deadline in "CFS_DURATION_T"s "
466 "("CFS_DURATION_T"s)", req->rq_early_count,
467 cfs_time_sub(req->rq_deadline, cfs_time_current_sec()),
468 cfs_time_sub(req->rq_deadline, olddl));
473 static struct kmem_cache *request_cache;
475 int ptlrpc_request_cache_init(void)
477 request_cache = kmem_cache_create("ptlrpc_cache",
478 sizeof(struct ptlrpc_request),
479 0, SLAB_HWCACHE_ALIGN, NULL);
480 return request_cache == NULL ? -ENOMEM : 0;
483 void ptlrpc_request_cache_fini(void)
485 kmem_cache_destroy(request_cache);
488 struct ptlrpc_request *ptlrpc_request_cache_alloc(gfp_t flags)
490 struct ptlrpc_request *req;
492 OBD_SLAB_ALLOC_PTR_GFP(req, request_cache, flags);
496 void ptlrpc_request_cache_free(struct ptlrpc_request *req)
498 OBD_SLAB_FREE_PTR(req, request_cache);
502 * Wind down request pool \a pool.
503 * Frees all requests from the pool too
505 void ptlrpc_free_rq_pool(struct ptlrpc_request_pool *pool)
507 struct list_head *l, *tmp;
508 struct ptlrpc_request *req;
510 LASSERT(pool != NULL);
512 spin_lock(&pool->prp_lock);
513 list_for_each_safe(l, tmp, &pool->prp_req_list) {
514 req = list_entry(l, struct ptlrpc_request, rq_list);
515 list_del(&req->rq_list);
516 LASSERT(req->rq_reqbuf);
517 LASSERT(req->rq_reqbuf_len == pool->prp_rq_size);
518 OBD_FREE_LARGE(req->rq_reqbuf, pool->prp_rq_size);
519 ptlrpc_request_cache_free(req);
521 spin_unlock(&pool->prp_lock);
522 OBD_FREE(pool, sizeof(*pool));
524 EXPORT_SYMBOL(ptlrpc_free_rq_pool);
527 * Allocates, initializes and adds \a num_rq requests to the pool \a pool
529 void ptlrpc_add_rqs_to_pool(struct ptlrpc_request_pool *pool, int num_rq)
534 while (size < pool->prp_rq_size)
537 LASSERTF(list_empty(&pool->prp_req_list) ||
538 size == pool->prp_rq_size,
539 "Trying to change pool size with nonempty pool "
540 "from %d to %d bytes\n", pool->prp_rq_size, size);
542 spin_lock(&pool->prp_lock);
543 pool->prp_rq_size = size;
544 for (i = 0; i < num_rq; i++) {
545 struct ptlrpc_request *req;
546 struct lustre_msg *msg;
548 spin_unlock(&pool->prp_lock);
549 req = ptlrpc_request_cache_alloc(GFP_NOFS);
552 OBD_ALLOC_LARGE(msg, size);
554 ptlrpc_request_cache_free(req);
557 req->rq_reqbuf = msg;
558 req->rq_reqbuf_len = size;
560 spin_lock(&pool->prp_lock);
561 list_add_tail(&req->rq_list, &pool->prp_req_list);
563 spin_unlock(&pool->prp_lock);
566 EXPORT_SYMBOL(ptlrpc_add_rqs_to_pool);
569 * Create and initialize new request pool with given attributes:
570 * \a num_rq - initial number of requests to create for the pool
571 * \a msgsize - maximum message size possible for requests in thid pool
572 * \a populate_pool - function to be called when more requests need to be added
574 * Returns pointer to newly created pool or NULL on error.
576 struct ptlrpc_request_pool *
577 ptlrpc_init_rq_pool(int num_rq, int msgsize,
578 void (*populate_pool)(struct ptlrpc_request_pool *, int))
580 struct ptlrpc_request_pool *pool;
582 OBD_ALLOC(pool, sizeof(struct ptlrpc_request_pool));
586 /* Request next power of two for the allocation, because internally
587 kernel would do exactly this */
589 spin_lock_init(&pool->prp_lock);
590 INIT_LIST_HEAD(&pool->prp_req_list);
591 pool->prp_rq_size = msgsize + SPTLRPC_MAX_PAYLOAD;
592 pool->prp_populate = populate_pool;
594 populate_pool(pool, num_rq);
596 if (list_empty(&pool->prp_req_list)) {
597 /* have not allocated a single request for the pool */
598 OBD_FREE(pool, sizeof(struct ptlrpc_request_pool));
603 EXPORT_SYMBOL(ptlrpc_init_rq_pool);
606 * Fetches one request from pool \a pool
608 static struct ptlrpc_request *
609 ptlrpc_prep_req_from_pool(struct ptlrpc_request_pool *pool)
611 struct ptlrpc_request *request;
612 struct lustre_msg *reqbuf;
617 spin_lock(&pool->prp_lock);
619 /* See if we have anything in a pool, and bail out if nothing,
620 * in writeout path, where this matters, this is safe to do, because
621 * nothing is lost in this case, and when some in-flight requests
622 * complete, this code will be called again. */
623 if (unlikely(list_empty(&pool->prp_req_list))) {
624 spin_unlock(&pool->prp_lock);
628 request = list_entry(pool->prp_req_list.next, struct ptlrpc_request,
630 list_del_init(&request->rq_list);
631 spin_unlock(&pool->prp_lock);
633 LASSERT(request->rq_reqbuf);
634 LASSERT(request->rq_pool);
636 reqbuf = request->rq_reqbuf;
637 memset(request, 0, sizeof(*request));
638 request->rq_reqbuf = reqbuf;
639 request->rq_reqbuf_len = pool->prp_rq_size;
640 request->rq_pool = pool;
646 * Returns freed \a request to pool.
648 static void __ptlrpc_free_req_to_pool(struct ptlrpc_request *request)
650 struct ptlrpc_request_pool *pool = request->rq_pool;
652 spin_lock(&pool->prp_lock);
653 LASSERT(list_empty(&request->rq_list));
654 LASSERT(!request->rq_receiving_reply);
655 list_add_tail(&request->rq_list, &pool->prp_req_list);
656 spin_unlock(&pool->prp_lock);
659 static int __ptlrpc_request_bufs_pack(struct ptlrpc_request *request,
660 __u32 version, int opcode,
661 int count, __u32 *lengths, char **bufs,
662 struct ptlrpc_cli_ctx *ctx)
664 struct obd_import *imp = request->rq_import;
669 request->rq_cli_ctx = sptlrpc_cli_ctx_get(ctx);
671 rc = sptlrpc_req_get_ctx(request);
676 sptlrpc_req_set_flavor(request, opcode);
678 rc = lustre_pack_request(request, imp->imp_msg_magic, count,
681 LASSERT(!request->rq_pool);
685 lustre_msg_add_version(request->rq_reqmsg, version);
686 request->rq_send_state = LUSTRE_IMP_FULL;
687 request->rq_type = PTL_RPC_MSG_REQUEST;
689 request->rq_req_cbid.cbid_fn = request_out_callback;
690 request->rq_req_cbid.cbid_arg = request;
692 request->rq_reply_cbid.cbid_fn = reply_in_callback;
693 request->rq_reply_cbid.cbid_arg = request;
695 request->rq_reply_deadline = 0;
696 request->rq_phase = RQ_PHASE_NEW;
697 request->rq_next_phase = RQ_PHASE_UNDEFINED;
699 request->rq_request_portal = imp->imp_client->cli_request_portal;
700 request->rq_reply_portal = imp->imp_client->cli_reply_portal;
702 ptlrpc_at_set_req_timeout(request);
704 lustre_msg_set_opc(request->rq_reqmsg, opcode);
708 sptlrpc_cli_ctx_put(request->rq_cli_ctx, 1);
710 class_import_put(imp);
714 int ptlrpc_request_bufs_pack(struct ptlrpc_request *request,
715 __u32 version, int opcode, char **bufs,
716 struct ptlrpc_cli_ctx *ctx)
720 count = req_capsule_filled_sizes(&request->rq_pill, RCL_CLIENT);
721 return __ptlrpc_request_bufs_pack(request, version, opcode, count,
722 request->rq_pill.rc_area[RCL_CLIENT],
725 EXPORT_SYMBOL(ptlrpc_request_bufs_pack);
728 * Pack request buffers for network transfer, performing necessary encryption
729 * steps if necessary.
731 int ptlrpc_request_pack(struct ptlrpc_request *request,
732 __u32 version, int opcode)
735 rc = ptlrpc_request_bufs_pack(request, version, opcode, NULL, NULL);
739 /* For some old 1.8 clients (< 1.8.7), they will LASSERT the size of
740 * ptlrpc_body sent from server equal to local ptlrpc_body size, so we
741 * have to send old ptlrpc_body to keep interoprability with these
744 * Only three kinds of server->client RPCs so far:
749 * XXX This should be removed whenever we drop the interoprability with
750 * the these old clients.
752 if (opcode == LDLM_BL_CALLBACK || opcode == LDLM_CP_CALLBACK ||
753 opcode == LDLM_GL_CALLBACK)
754 req_capsule_shrink(&request->rq_pill, &RMF_PTLRPC_BODY,
755 sizeof(struct ptlrpc_body_v2), RCL_CLIENT);
759 EXPORT_SYMBOL(ptlrpc_request_pack);
762 * Helper function to allocate new request on import \a imp
763 * and possibly using existing request from pool \a pool if provided.
764 * Returns allocated request structure with import field filled or
768 struct ptlrpc_request *__ptlrpc_request_alloc(struct obd_import *imp,
769 struct ptlrpc_request_pool *pool)
771 struct ptlrpc_request *request = NULL;
774 request = ptlrpc_prep_req_from_pool(pool);
777 request = ptlrpc_request_cache_alloc(GFP_NOFS);
780 ptlrpc_cli_req_init(request);
782 LASSERTF((unsigned long)imp > 0x1000, "%p", imp);
783 LASSERT(imp != LP_POISON);
784 LASSERTF((unsigned long)imp->imp_client > 0x1000, "%p\n",
786 LASSERT(imp->imp_client != LP_POISON);
788 request->rq_import = class_import_get(imp);
790 CERROR("request allocation out of memory\n");
797 * Helper function for creating a request.
798 * Calls __ptlrpc_request_alloc to allocate new request sturcture and inits
799 * buffer structures according to capsule template \a format.
800 * Returns allocated request structure pointer or NULL on error.
802 static struct ptlrpc_request *
803 ptlrpc_request_alloc_internal(struct obd_import *imp,
804 struct ptlrpc_request_pool * pool,
805 const struct req_format *format)
807 struct ptlrpc_request *request;
809 request = __ptlrpc_request_alloc(imp, pool);
813 req_capsule_init(&request->rq_pill, request, RCL_CLIENT);
814 req_capsule_set(&request->rq_pill, format);
819 * Allocate new request structure for import \a imp and initialize its
820 * buffer structure according to capsule template \a format.
822 struct ptlrpc_request *ptlrpc_request_alloc(struct obd_import *imp,
823 const struct req_format *format)
825 return ptlrpc_request_alloc_internal(imp, NULL, format);
827 EXPORT_SYMBOL(ptlrpc_request_alloc);
830 * Allocate new request structure for import \a imp from pool \a pool and
831 * initialize its buffer structure according to capsule template \a format.
833 struct ptlrpc_request *ptlrpc_request_alloc_pool(struct obd_import *imp,
834 struct ptlrpc_request_pool * pool,
835 const struct req_format *format)
837 return ptlrpc_request_alloc_internal(imp, pool, format);
839 EXPORT_SYMBOL(ptlrpc_request_alloc_pool);
842 * For requests not from pool, free memory of the request structure.
843 * For requests obtained from a pool earlier, return request back to pool.
845 void ptlrpc_request_free(struct ptlrpc_request *request)
847 if (request->rq_pool)
848 __ptlrpc_free_req_to_pool(request);
850 ptlrpc_request_cache_free(request);
852 EXPORT_SYMBOL(ptlrpc_request_free);
855 * Allocate new request for operatione \a opcode and immediatelly pack it for
857 * Only used for simple requests like OBD_PING where the only important
858 * part of the request is operation itself.
859 * Returns allocated request or NULL on error.
861 struct ptlrpc_request *ptlrpc_request_alloc_pack(struct obd_import *imp,
862 const struct req_format *format,
863 __u32 version, int opcode)
865 struct ptlrpc_request *req = ptlrpc_request_alloc(imp, format);
869 rc = ptlrpc_request_pack(req, version, opcode);
871 ptlrpc_request_free(req);
877 EXPORT_SYMBOL(ptlrpc_request_alloc_pack);
880 * Prepare request (fetched from pool \a poolif not NULL) on import \a imp
881 * for operation \a opcode. Request would contain \a count buffers.
882 * Sizes of buffers are described in array \a lengths and buffers themselves
883 * are provided by a pointer \a bufs.
884 * Returns prepared request structure pointer or NULL on error.
886 struct ptlrpc_request *
887 ptlrpc_prep_req_pool(struct obd_import *imp,
888 __u32 version, int opcode,
889 int count, __u32 *lengths, char **bufs,
890 struct ptlrpc_request_pool *pool)
892 struct ptlrpc_request *request;
895 request = __ptlrpc_request_alloc(imp, pool);
899 rc = __ptlrpc_request_bufs_pack(request, version, opcode, count,
900 lengths, bufs, NULL);
902 ptlrpc_request_free(request);
909 * Same as ptlrpc_prep_req_pool, but without pool
911 struct ptlrpc_request *
912 ptlrpc_prep_req(struct obd_import *imp, __u32 version, int opcode, int count,
913 __u32 *lengths, char **bufs)
915 return ptlrpc_prep_req_pool(imp, version, opcode, count, lengths, bufs,
920 * Allocate and initialize new request set structure.
921 * Returns a pointer to the newly allocated set structure or NULL on error.
923 struct ptlrpc_request_set *ptlrpc_prep_set(void)
925 struct ptlrpc_request_set *set;
928 OBD_ALLOC(set, sizeof *set);
931 atomic_set(&set->set_refcount, 1);
932 INIT_LIST_HEAD(&set->set_requests);
933 init_waitqueue_head(&set->set_waitq);
934 atomic_set(&set->set_new_count, 0);
935 atomic_set(&set->set_remaining, 0);
936 spin_lock_init(&set->set_new_req_lock);
937 INIT_LIST_HEAD(&set->set_new_requests);
938 INIT_LIST_HEAD(&set->set_cblist);
939 set->set_max_inflight = UINT_MAX;
940 set->set_producer = NULL;
941 set->set_producer_arg = NULL;
946 EXPORT_SYMBOL(ptlrpc_prep_set);
949 * Allocate and initialize new request set structure with flow control
950 * extension. This extension allows to control the number of requests in-flight
951 * for the whole set. A callback function to generate requests must be provided
952 * and the request set will keep the number of requests sent over the wire to
954 * Returns a pointer to the newly allocated set structure or NULL on error.
956 struct ptlrpc_request_set *ptlrpc_prep_fcset(int max, set_producer_func func,
960 struct ptlrpc_request_set *set;
962 set = ptlrpc_prep_set();
966 set->set_max_inflight = max;
967 set->set_producer = func;
968 set->set_producer_arg = arg;
974 * Wind down and free request set structure previously allocated with
976 * Ensures that all requests on the set have completed and removes
977 * all requests from the request list in a set.
978 * If any unsent request happen to be on the list, pretends that they got
979 * an error in flight and calls their completion handler.
981 void ptlrpc_set_destroy(struct ptlrpc_request_set *set)
983 struct list_head *tmp;
984 struct list_head *next;
989 /* Requests on the set should either all be completed, or all be new */
990 expected_phase = (atomic_read(&set->set_remaining) == 0) ?
991 RQ_PHASE_COMPLETE : RQ_PHASE_NEW;
992 list_for_each(tmp, &set->set_requests) {
993 struct ptlrpc_request *req =
994 list_entry(tmp, struct ptlrpc_request,
997 LASSERT(req->rq_phase == expected_phase);
1001 LASSERTF(atomic_read(&set->set_remaining) == 0 ||
1002 atomic_read(&set->set_remaining) == n, "%d / %d\n",
1003 atomic_read(&set->set_remaining), n);
1005 list_for_each_safe(tmp, next, &set->set_requests) {
1006 struct ptlrpc_request *req =
1007 list_entry(tmp, struct ptlrpc_request,
1009 list_del_init(&req->rq_set_chain);
1011 LASSERT(req->rq_phase == expected_phase);
1013 if (req->rq_phase == RQ_PHASE_NEW) {
1014 ptlrpc_req_interpret(NULL, req, -EBADR);
1015 atomic_dec(&set->set_remaining);
1018 spin_lock(&req->rq_lock);
1020 req->rq_invalid_rqset = 0;
1021 spin_unlock(&req->rq_lock);
1023 ptlrpc_req_finished (req);
1026 LASSERT(atomic_read(&set->set_remaining) == 0);
1028 ptlrpc_reqset_put(set);
1031 EXPORT_SYMBOL(ptlrpc_set_destroy);
1034 * Add a callback function \a fn to the set.
1035 * This function would be called when all requests on this set are completed.
1036 * The function will be passed \a data argument.
1038 int ptlrpc_set_add_cb(struct ptlrpc_request_set *set,
1039 set_interpreter_func fn, void *data)
1041 struct ptlrpc_set_cbdata *cbdata;
1043 OBD_ALLOC_PTR(cbdata);
1047 cbdata->psc_interpret = fn;
1048 cbdata->psc_data = data;
1049 list_add_tail(&cbdata->psc_item, &set->set_cblist);
1055 * Add a new request to the general purpose request set.
1056 * Assumes request reference from the caller.
1058 void ptlrpc_set_add_req(struct ptlrpc_request_set *set,
1059 struct ptlrpc_request *req)
1061 LASSERT(list_empty(&req->rq_set_chain));
1063 /* The set takes over the caller's request reference */
1064 list_add_tail(&req->rq_set_chain, &set->set_requests);
1066 atomic_inc(&set->set_remaining);
1067 req->rq_queued_time = cfs_time_current();
1069 if (req->rq_reqmsg != NULL)
1070 lustre_msg_set_jobid(req->rq_reqmsg, NULL);
1072 if (set->set_producer != NULL)
1073 /* If the request set has a producer callback, the RPC must be
1074 * sent straight away */
1075 ptlrpc_send_new_req(req);
1077 EXPORT_SYMBOL(ptlrpc_set_add_req);
1080 * Add a request to a request with dedicated server thread
1081 * and wake the thread to make any necessary processing.
1082 * Currently only used for ptlrpcd.
1084 void ptlrpc_set_add_new_req(struct ptlrpcd_ctl *pc,
1085 struct ptlrpc_request *req)
1087 struct ptlrpc_request_set *set = pc->pc_set;
1090 LASSERT(req->rq_set == NULL);
1091 LASSERT(test_bit(LIOD_STOP, &pc->pc_flags) == 0);
1093 spin_lock(&set->set_new_req_lock);
1095 * The set takes over the caller's request reference.
1098 req->rq_queued_time = cfs_time_current();
1099 list_add_tail(&req->rq_set_chain, &set->set_new_requests);
1100 count = atomic_inc_return(&set->set_new_count);
1101 spin_unlock(&set->set_new_req_lock);
1103 /* Only need to call wakeup once for the first entry. */
1105 wake_up(&set->set_waitq);
1107 /* XXX: It maybe unnecessary to wakeup all the partners. But to
1108 * guarantee the async RPC can be processed ASAP, we have
1109 * no other better choice. It maybe fixed in future. */
1110 for (i = 0; i < pc->pc_npartners; i++)
1111 wake_up(&pc->pc_partners[i]->pc_set->set_waitq);
1116 * Based on the current state of the import, determine if the request
1117 * can be sent, is an error, or should be delayed.
1119 * Returns true if this request should be delayed. If false, and
1120 * *status is set, then the request can not be sent and *status is the
1121 * error code. If false and status is 0, then request can be sent.
1123 * The imp->imp_lock must be held.
1125 static int ptlrpc_import_delay_req(struct obd_import *imp,
1126 struct ptlrpc_request *req, int *status)
1131 LASSERT (status != NULL);
1134 if (req->rq_ctx_init || req->rq_ctx_fini) {
1135 /* always allow ctx init/fini rpc go through */
1136 } else if (imp->imp_state == LUSTRE_IMP_NEW) {
1137 DEBUG_REQ(D_ERROR, req, "Uninitialized import.");
1139 } else if (imp->imp_state == LUSTRE_IMP_CLOSED) {
1140 /* pings may safely race with umount */
1141 DEBUG_REQ(lustre_msg_get_opc(req->rq_reqmsg) == OBD_PING ?
1142 D_HA : D_ERROR, req, "IMP_CLOSED ");
1144 } else if (ptlrpc_send_limit_expired(req)) {
1145 /* probably doesn't need to be a D_ERROR after initial testing*/
1146 DEBUG_REQ(D_HA, req, "send limit expired ");
1147 *status = -ETIMEDOUT;
1148 } else if (req->rq_send_state == LUSTRE_IMP_CONNECTING &&
1149 imp->imp_state == LUSTRE_IMP_CONNECTING) {
1150 /* allow CONNECT even if import is invalid */ ;
1151 if (atomic_read(&imp->imp_inval_count) != 0) {
1152 DEBUG_REQ(D_ERROR, req, "invalidate in flight");
1155 } else if (imp->imp_invalid || imp->imp_obd->obd_no_recov) {
1156 if (!imp->imp_deactive)
1157 DEBUG_REQ(D_NET, req, "IMP_INVALID");
1158 *status = -ESHUTDOWN; /* bz 12940 */
1159 } else if (req->rq_import_generation != imp->imp_generation) {
1160 DEBUG_REQ(D_ERROR, req, "req wrong generation:");
1162 } else if (req->rq_send_state != imp->imp_state) {
1163 /* invalidate in progress - any requests should be drop */
1164 if (atomic_read(&imp->imp_inval_count) != 0) {
1165 DEBUG_REQ(D_ERROR, req, "invalidate in flight");
1167 } else if (imp->imp_dlm_fake || req->rq_no_delay) {
1168 *status = -EWOULDBLOCK;
1169 } else if (req->rq_allow_replay &&
1170 (imp->imp_state == LUSTRE_IMP_REPLAY ||
1171 imp->imp_state == LUSTRE_IMP_REPLAY_LOCKS ||
1172 imp->imp_state == LUSTRE_IMP_REPLAY_WAIT ||
1173 imp->imp_state == LUSTRE_IMP_RECOVER)) {
1174 DEBUG_REQ(D_HA, req, "allow during recovery.\n");
1184 * Decide if the error message should be printed to the console or not.
1185 * Makes its decision based on request type, status, and failure frequency.
1187 * \param[in] req request that failed and may need a console message
1189 * \retval false if no message should be printed
1190 * \retval true if console message should be printed
1192 static bool ptlrpc_console_allow(struct ptlrpc_request *req)
1196 LASSERT(req->rq_reqmsg != NULL);
1197 opc = lustre_msg_get_opc(req->rq_reqmsg);
1199 /* Suppress particular reconnect errors which are to be expected. */
1200 if (opc == OST_CONNECT || opc == MDS_CONNECT || opc == MGS_CONNECT) {
1203 /* Suppress timed out reconnect requests */
1204 if (lustre_handle_is_used(&req->rq_import->imp_remote_handle) ||
1208 /* Suppress most unavailable/again reconnect requests, but
1209 * print occasionally so it is clear client is trying to
1210 * connect to a server where no target is running. */
1211 err = lustre_msg_get_status(req->rq_repmsg);
1212 if ((err == -ENODEV || err == -EAGAIN) &&
1213 req->rq_import->imp_conn_cnt % 30 != 20)
1221 * Check request processing status.
1222 * Returns the status.
1224 static int ptlrpc_check_status(struct ptlrpc_request *req)
1229 err = lustre_msg_get_status(req->rq_repmsg);
1230 if (lustre_msg_get_type(req->rq_repmsg) == PTL_RPC_MSG_ERR) {
1231 struct obd_import *imp = req->rq_import;
1232 lnet_nid_t nid = imp->imp_connection->c_peer.nid;
1233 __u32 opc = lustre_msg_get_opc(req->rq_reqmsg);
1235 if (ptlrpc_console_allow(req))
1236 LCONSOLE_ERROR_MSG(0x11, "%s: operation %s to node %s "
1237 "failed: rc = %d\n",
1238 imp->imp_obd->obd_name,
1240 libcfs_nid2str(nid), err);
1241 RETURN(err < 0 ? err : -EINVAL);
1245 DEBUG_REQ(D_INFO, req, "status is %d", err);
1246 } else if (err > 0) {
1247 /* XXX: translate this error from net to host */
1248 DEBUG_REQ(D_INFO, req, "status is %d", err);
1255 * save pre-versions of objects into request for replay.
1256 * Versions are obtained from server reply.
1259 static void ptlrpc_save_versions(struct ptlrpc_request *req)
1261 struct lustre_msg *repmsg = req->rq_repmsg;
1262 struct lustre_msg *reqmsg = req->rq_reqmsg;
1263 __u64 *versions = lustre_msg_get_versions(repmsg);
1266 if (lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY)
1270 lustre_msg_set_versions(reqmsg, versions);
1271 CDEBUG(D_INFO, "Client save versions ["LPX64"/"LPX64"]\n",
1272 versions[0], versions[1]);
1278 * Callback function called when client receives RPC reply for \a req.
1279 * Returns 0 on success or error code.
1280 * The return alue would be assigned to req->rq_status by the caller
1281 * as request processing status.
1282 * This function also decides if the request needs to be saved for later replay.
1284 static int after_reply(struct ptlrpc_request *req)
1286 struct obd_import *imp = req->rq_import;
1287 struct obd_device *obd = req->rq_import->imp_obd;
1289 struct timeval work_start;
1293 LASSERT(obd != NULL);
1294 /* repbuf must be unlinked */
1295 LASSERT(!req->rq_receiving_reply && req->rq_reply_unlinked);
1297 if (req->rq_reply_truncated) {
1298 if (ptlrpc_no_resend(req)) {
1299 DEBUG_REQ(D_ERROR, req, "reply buffer overflow,"
1300 " expected: %d, actual size: %d",
1301 req->rq_nob_received, req->rq_repbuf_len);
1305 sptlrpc_cli_free_repbuf(req);
1306 /* Pass the required reply buffer size (include
1307 * space for early reply).
1308 * NB: no need to roundup because alloc_repbuf
1309 * will roundup it */
1310 req->rq_replen = req->rq_nob_received;
1311 req->rq_nob_received = 0;
1312 spin_lock(&req->rq_lock);
1314 spin_unlock(&req->rq_lock);
1318 do_gettimeofday(&work_start);
1319 timediff = cfs_timeval_sub(&work_start, &req->rq_sent_tv, NULL);
1322 * NB Until this point, the whole of the incoming message,
1323 * including buflens, status etc is in the sender's byte order.
1325 rc = sptlrpc_cli_unwrap_reply(req);
1327 DEBUG_REQ(D_ERROR, req, "unwrap reply failed (%d):", rc);
1332 * Security layer unwrap might ask resend this request.
1337 rc = unpack_reply(req);
1341 /* retry indefinitely on EINPROGRESS */
1342 if (lustre_msg_get_status(req->rq_repmsg) == -EINPROGRESS &&
1343 ptlrpc_no_resend(req) == 0 && !req->rq_no_retry_einprogress) {
1344 time_t now = cfs_time_current_sec();
1346 DEBUG_REQ(D_RPCTRACE, req, "Resending request on EINPROGRESS");
1347 spin_lock(&req->rq_lock);
1349 spin_unlock(&req->rq_lock);
1350 req->rq_nr_resend++;
1352 /* Readjust the timeout for current conditions */
1353 ptlrpc_at_set_req_timeout(req);
1354 /* delay resend to give a chance to the server to get ready.
1355 * The delay is increased by 1s on every resend and is capped to
1356 * the current request timeout (i.e. obd_timeout if AT is off,
1357 * or AT service time x 125% + 5s, see at_est2timeout) */
1358 if (req->rq_nr_resend > req->rq_timeout)
1359 req->rq_sent = now + req->rq_timeout;
1361 req->rq_sent = now + req->rq_nr_resend;
1366 if (obd->obd_svc_stats != NULL) {
1367 lprocfs_counter_add(obd->obd_svc_stats, PTLRPC_REQWAIT_CNTR,
1369 ptlrpc_lprocfs_rpc_sent(req, timediff);
1372 if (lustre_msg_get_type(req->rq_repmsg) != PTL_RPC_MSG_REPLY &&
1373 lustre_msg_get_type(req->rq_repmsg) != PTL_RPC_MSG_ERR) {
1374 DEBUG_REQ(D_ERROR, req, "invalid packet received (type=%u)",
1375 lustre_msg_get_type(req->rq_repmsg));
1379 if (lustre_msg_get_opc(req->rq_reqmsg) != OBD_PING)
1380 CFS_FAIL_TIMEOUT(OBD_FAIL_PTLRPC_PAUSE_REP, cfs_fail_val);
1381 ptlrpc_at_adj_service(req, lustre_msg_get_timeout(req->rq_repmsg));
1382 ptlrpc_at_adj_net_latency(req,
1383 lustre_msg_get_service_time(req->rq_repmsg));
1385 rc = ptlrpc_check_status(req);
1386 imp->imp_connect_error = rc;
1390 * Either we've been evicted, or the server has failed for
1391 * some reason. Try to reconnect, and if that fails, punt to
1394 if (ptlrpc_recoverable_error(rc)) {
1395 if (req->rq_send_state != LUSTRE_IMP_FULL ||
1396 imp->imp_obd->obd_no_recov || imp->imp_dlm_fake) {
1399 ptlrpc_request_handle_notconn(req);
1404 * Let's look if server sent slv. Do it only for RPC with
1407 ldlm_cli_update_pool(req);
1411 * Store transno in reqmsg for replay.
1413 if (!(lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY)) {
1414 req->rq_transno = lustre_msg_get_transno(req->rq_repmsg);
1415 lustre_msg_set_transno(req->rq_reqmsg, req->rq_transno);
1418 if (imp->imp_replayable) {
1419 spin_lock(&imp->imp_lock);
1421 * No point in adding already-committed requests to the replay
1422 * list, we will just remove them immediately. b=9829
1424 if (req->rq_transno != 0 &&
1426 lustre_msg_get_last_committed(req->rq_repmsg) ||
1428 /** version recovery */
1429 ptlrpc_save_versions(req);
1430 ptlrpc_retain_replayable_request(req, imp);
1431 } else if (req->rq_commit_cb != NULL &&
1432 list_empty(&req->rq_replay_list)) {
1433 /* NB: don't call rq_commit_cb if it's already on
1434 * rq_replay_list, ptlrpc_free_committed() will call
1435 * it later, see LU-3618 for details */
1436 spin_unlock(&imp->imp_lock);
1437 req->rq_commit_cb(req);
1438 spin_lock(&imp->imp_lock);
1442 * Replay-enabled imports return commit-status information.
1444 if (lustre_msg_get_last_committed(req->rq_repmsg)) {
1445 imp->imp_peer_committed_transno =
1446 lustre_msg_get_last_committed(req->rq_repmsg);
1449 ptlrpc_free_committed(imp);
1451 if (!list_empty(&imp->imp_replay_list)) {
1452 struct ptlrpc_request *last;
1454 last = list_entry(imp->imp_replay_list.prev,
1455 struct ptlrpc_request,
1458 * Requests with rq_replay stay on the list even if no
1459 * commit is expected.
1461 if (last->rq_transno > imp->imp_peer_committed_transno)
1462 ptlrpc_pinger_commit_expected(imp);
1465 spin_unlock(&imp->imp_lock);
1472 * Helper function to send request \a req over the network for the first time
1473 * Also adjusts request phase.
1474 * Returns 0 on success or error code.
1476 static int ptlrpc_send_new_req(struct ptlrpc_request *req)
1478 struct obd_import *imp = req->rq_import;
1479 struct list_head *tmp;
1480 __u64 min_xid = ~0ULL;
1484 LASSERT(req->rq_phase == RQ_PHASE_NEW);
1485 if (req->rq_sent && (req->rq_sent > cfs_time_current_sec()) &&
1486 (!req->rq_generation_set ||
1487 req->rq_import_generation == imp->imp_generation))
1490 ptlrpc_rqphase_move(req, RQ_PHASE_RPC);
1492 spin_lock(&imp->imp_lock);
1494 /* the very first time we assign XID. it's important to assign XID
1495 * and put it on the list atomically, so that the lowest assigned
1496 * XID is always known. this is vital for multislot last_rcvd */
1497 if (req->rq_send_state == LUSTRE_IMP_REPLAY) {
1498 LASSERT(req->rq_xid != 0);
1500 LASSERT(req->rq_xid == 0);
1501 req->rq_xid = ptlrpc_next_xid();
1504 if (!req->rq_generation_set)
1505 req->rq_import_generation = imp->imp_generation;
1507 if (ptlrpc_import_delay_req(imp, req, &rc)) {
1508 spin_lock(&req->rq_lock);
1509 req->rq_waiting = 1;
1510 spin_unlock(&req->rq_lock);
1512 DEBUG_REQ(D_HA, req, "req from PID %d waiting for recovery: "
1513 "(%s != %s)", lustre_msg_get_status(req->rq_reqmsg),
1514 ptlrpc_import_state_name(req->rq_send_state),
1515 ptlrpc_import_state_name(imp->imp_state));
1516 LASSERT(list_empty(&req->rq_list));
1517 list_add_tail(&req->rq_list, &imp->imp_delayed_list);
1518 atomic_inc(&req->rq_import->imp_inflight);
1519 spin_unlock(&imp->imp_lock);
1524 spin_unlock(&imp->imp_lock);
1525 req->rq_status = rc;
1526 ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
1530 LASSERT(list_empty(&req->rq_list));
1531 list_add_tail(&req->rq_list, &imp->imp_sending_list);
1532 atomic_inc(&req->rq_import->imp_inflight);
1534 /* find the lowest unreplied XID */
1535 list_for_each(tmp, &imp->imp_delayed_list) {
1536 struct ptlrpc_request *r;
1537 r = list_entry(tmp, struct ptlrpc_request, rq_list);
1538 if (r->rq_xid < min_xid)
1539 min_xid = r->rq_xid;
1541 list_for_each(tmp, &imp->imp_sending_list) {
1542 struct ptlrpc_request *r;
1543 r = list_entry(tmp, struct ptlrpc_request, rq_list);
1544 if (r->rq_xid < min_xid)
1545 min_xid = r->rq_xid;
1547 spin_unlock(&imp->imp_lock);
1549 if (likely(min_xid != ~0ULL))
1550 lustre_msg_set_last_xid(req->rq_reqmsg, min_xid - 1);
1552 lustre_msg_set_status(req->rq_reqmsg, current_pid());
1554 rc = sptlrpc_req_refresh_ctx(req, -1);
1557 req->rq_status = rc;
1560 spin_lock(&req->rq_lock);
1561 req->rq_wait_ctx = 1;
1562 spin_unlock(&req->rq_lock);
1567 CDEBUG(D_RPCTRACE, "Sending RPC pname:cluuid:pid:xid:nid:opc"
1568 " %s:%s:%d:"LPU64":%s:%d\n", current_comm(),
1569 imp->imp_obd->obd_uuid.uuid,
1570 lustre_msg_get_status(req->rq_reqmsg), req->rq_xid,
1571 libcfs_nid2str(imp->imp_connection->c_peer.nid),
1572 lustre_msg_get_opc(req->rq_reqmsg));
1574 rc = ptl_send_rpc(req, 0);
1576 DEBUG_REQ(D_HA, req, "send failed (%d); expect timeout", rc);
1577 spin_lock(&req->rq_lock);
1578 req->rq_net_err = 1;
1579 spin_unlock(&req->rq_lock);
1585 static inline int ptlrpc_set_producer(struct ptlrpc_request_set *set)
1590 LASSERT(set->set_producer != NULL);
1592 remaining = atomic_read(&set->set_remaining);
1594 /* populate the ->set_requests list with requests until we
1595 * reach the maximum number of RPCs in flight for this set */
1596 while (atomic_read(&set->set_remaining) < set->set_max_inflight) {
1597 rc = set->set_producer(set, set->set_producer_arg);
1598 if (rc == -ENOENT) {
1599 /* no more RPC to produce */
1600 set->set_producer = NULL;
1601 set->set_producer_arg = NULL;
1606 RETURN((atomic_read(&set->set_remaining) - remaining));
1610 * this sends any unsent RPCs in \a set and returns 1 if all are sent
1611 * and no more replies are expected.
1612 * (it is possible to get less replies than requests sent e.g. due to timed out
1613 * requests or requests that we had trouble to send out)
1615 * NOTE: This function contains a potential schedule point (cond_resched()).
1617 int ptlrpc_check_set(const struct lu_env *env, struct ptlrpc_request_set *set)
1619 struct list_head *tmp, *next;
1620 struct list_head comp_reqs;
1621 int force_timer_recalc = 0;
1624 if (atomic_read(&set->set_remaining) == 0)
1627 INIT_LIST_HEAD(&comp_reqs);
1628 list_for_each_safe(tmp, next, &set->set_requests) {
1629 struct ptlrpc_request *req =
1630 list_entry(tmp, struct ptlrpc_request,
1632 struct obd_import *imp = req->rq_import;
1633 int unregistered = 0;
1636 /* This schedule point is mainly for the ptlrpcd caller of this
1637 * function. Most ptlrpc sets are not long-lived and unbounded
1638 * in length, but at the least the set used by the ptlrpcd is.
1639 * Since the processing time is unbounded, we need to insert an
1640 * explicit schedule point to make the thread well-behaved.
1644 if (req->rq_phase == RQ_PHASE_NEW &&
1645 ptlrpc_send_new_req(req)) {
1646 force_timer_recalc = 1;
1649 /* delayed send - skip */
1650 if (req->rq_phase == RQ_PHASE_NEW && req->rq_sent)
1653 /* delayed resend - skip */
1654 if (req->rq_phase == RQ_PHASE_RPC && req->rq_resend &&
1655 req->rq_sent > cfs_time_current_sec())
1658 if (!(req->rq_phase == RQ_PHASE_RPC ||
1659 req->rq_phase == RQ_PHASE_BULK ||
1660 req->rq_phase == RQ_PHASE_INTERPRET ||
1661 req->rq_phase == RQ_PHASE_UNREGISTERING ||
1662 req->rq_phase == RQ_PHASE_COMPLETE)) {
1663 DEBUG_REQ(D_ERROR, req, "bad phase %x", req->rq_phase);
1667 if (req->rq_phase == RQ_PHASE_UNREGISTERING) {
1668 LASSERT(req->rq_next_phase != req->rq_phase);
1669 LASSERT(req->rq_next_phase != RQ_PHASE_UNDEFINED);
1672 * Skip processing until reply is unlinked. We
1673 * can't return to pool before that and we can't
1674 * call interpret before that. We need to make
1675 * sure that all rdma transfers finished and will
1676 * not corrupt any data.
1678 if (ptlrpc_client_recv_or_unlink(req) ||
1679 ptlrpc_client_bulk_active(req))
1683 * Turn fail_loc off to prevent it from looping
1686 if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK)) {
1687 OBD_FAIL_CHECK_ORSET(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK,
1690 if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_BULK_UNLINK)) {
1691 OBD_FAIL_CHECK_ORSET(OBD_FAIL_PTLRPC_LONG_BULK_UNLINK,
1696 * Move to next phase if reply was successfully
1699 ptlrpc_rqphase_move(req, req->rq_next_phase);
1702 if (req->rq_phase == RQ_PHASE_COMPLETE) {
1703 list_move_tail(&req->rq_set_chain, &comp_reqs);
1707 if (req->rq_phase == RQ_PHASE_INTERPRET)
1708 GOTO(interpret, req->rq_status);
1711 * Note that this also will start async reply unlink.
1713 if (req->rq_net_err && !req->rq_timedout) {
1714 ptlrpc_expire_one_request(req, 1);
1717 * Check if we still need to wait for unlink.
1719 if (ptlrpc_client_recv_or_unlink(req) ||
1720 ptlrpc_client_bulk_active(req))
1722 /* If there is no need to resend, fail it now. */
1723 if (req->rq_no_resend) {
1724 if (req->rq_status == 0)
1725 req->rq_status = -EIO;
1726 ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
1727 GOTO(interpret, req->rq_status);
1734 spin_lock(&req->rq_lock);
1735 req->rq_replied = 0;
1736 spin_unlock(&req->rq_lock);
1737 if (req->rq_status == 0)
1738 req->rq_status = -EIO;
1739 ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
1740 GOTO(interpret, req->rq_status);
1743 /* ptlrpc_set_wait->l_wait_event sets lwi_allow_intr
1744 * so it sets rq_intr regardless of individual rpc
1745 * timeouts. The synchronous IO waiting path sets
1746 * rq_intr irrespective of whether ptlrpcd
1747 * has seen a timeout. Our policy is to only interpret
1748 * interrupted rpcs after they have timed out, so we
1749 * need to enforce that here.
1752 if (req->rq_intr && (req->rq_timedout || req->rq_waiting ||
1753 req->rq_wait_ctx)) {
1754 req->rq_status = -EINTR;
1755 ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
1756 GOTO(interpret, req->rq_status);
1759 if (req->rq_phase == RQ_PHASE_RPC) {
1760 if (req->rq_timedout || req->rq_resend ||
1761 req->rq_waiting || req->rq_wait_ctx) {
1764 if (!ptlrpc_unregister_reply(req, 1)) {
1765 ptlrpc_unregister_bulk(req, 1);
1769 spin_lock(&imp->imp_lock);
1770 if (ptlrpc_import_delay_req(imp, req, &status)){
1771 /* put on delay list - only if we wait
1772 * recovery finished - before send */
1773 list_del_init(&req->rq_list);
1774 list_add_tail(&req->rq_list,
1777 spin_unlock(&imp->imp_lock);
1782 req->rq_status = status;
1783 ptlrpc_rqphase_move(req,
1784 RQ_PHASE_INTERPRET);
1785 spin_unlock(&imp->imp_lock);
1786 GOTO(interpret, req->rq_status);
1788 if (ptlrpc_no_resend(req) &&
1789 !req->rq_wait_ctx) {
1790 req->rq_status = -ENOTCONN;
1791 ptlrpc_rqphase_move(req,
1792 RQ_PHASE_INTERPRET);
1793 spin_unlock(&imp->imp_lock);
1794 GOTO(interpret, req->rq_status);
1797 list_del_init(&req->rq_list);
1798 list_add_tail(&req->rq_list,
1799 &imp->imp_sending_list);
1801 spin_unlock(&imp->imp_lock);
1803 spin_lock(&req->rq_lock);
1804 req->rq_waiting = 0;
1805 spin_unlock(&req->rq_lock);
1807 if (req->rq_timedout || req->rq_resend) {
1808 /* This is re-sending anyways,
1809 * let's mark req as resend. */
1810 spin_lock(&req->rq_lock);
1812 spin_unlock(&req->rq_lock);
1814 if (req->rq_bulk != NULL &&
1815 !ptlrpc_unregister_bulk(req, 1))
1819 * rq_wait_ctx is only touched by ptlrpcd,
1820 * so no lock is needed here.
1822 status = sptlrpc_req_refresh_ctx(req, -1);
1825 req->rq_status = status;
1826 spin_lock(&req->rq_lock);
1827 req->rq_wait_ctx = 0;
1828 spin_unlock(&req->rq_lock);
1829 force_timer_recalc = 1;
1831 spin_lock(&req->rq_lock);
1832 req->rq_wait_ctx = 1;
1833 spin_unlock(&req->rq_lock);
1838 spin_lock(&req->rq_lock);
1839 req->rq_wait_ctx = 0;
1840 spin_unlock(&req->rq_lock);
1843 rc = ptl_send_rpc(req, 0);
1845 DEBUG_REQ(D_HA, req,
1846 "send failed: rc = %d", rc);
1847 force_timer_recalc = 1;
1848 spin_lock(&req->rq_lock);
1849 req->rq_net_err = 1;
1850 spin_unlock(&req->rq_lock);
1853 /* need to reset the timeout */
1854 force_timer_recalc = 1;
1857 spin_lock(&req->rq_lock);
1859 if (ptlrpc_client_early(req)) {
1860 ptlrpc_at_recv_early_reply(req);
1861 spin_unlock(&req->rq_lock);
1865 /* Still waiting for a reply? */
1866 if (ptlrpc_client_recv(req)) {
1867 spin_unlock(&req->rq_lock);
1871 /* Did we actually receive a reply? */
1872 if (!ptlrpc_client_replied(req)) {
1873 spin_unlock(&req->rq_lock);
1877 spin_unlock(&req->rq_lock);
1879 /* unlink from net because we are going to
1880 * swab in-place of reply buffer */
1881 unregistered = ptlrpc_unregister_reply(req, 1);
1885 req->rq_status = after_reply(req);
1889 /* If there is no bulk associated with this request,
1890 * then we're done and should let the interpreter
1891 * process the reply. Similarly if the RPC returned
1892 * an error, and therefore the bulk will never arrive.
1894 if (req->rq_bulk == NULL || req->rq_status < 0) {
1895 ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
1896 GOTO(interpret, req->rq_status);
1899 ptlrpc_rqphase_move(req, RQ_PHASE_BULK);
1902 LASSERT(req->rq_phase == RQ_PHASE_BULK);
1903 if (ptlrpc_client_bulk_active(req))
1906 if (req->rq_bulk->bd_failure) {
1907 /* The RPC reply arrived OK, but the bulk screwed
1908 * up! Dead weird since the server told us the RPC
1909 * was good after getting the REPLY for her GET or
1910 * the ACK for her PUT. */
1911 DEBUG_REQ(D_ERROR, req, "bulk transfer failed");
1912 req->rq_status = -EIO;
1915 ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
1918 LASSERT(req->rq_phase == RQ_PHASE_INTERPRET);
1920 /* This moves to "unregistering" phase we need to wait for
1922 if (!unregistered && !ptlrpc_unregister_reply(req, 1)) {
1923 /* start async bulk unlink too */
1924 ptlrpc_unregister_bulk(req, 1);
1928 if (!ptlrpc_unregister_bulk(req, 1))
1931 /* When calling interpret receiving already should be
1933 LASSERT(!req->rq_receiving_reply);
1935 ptlrpc_req_interpret(env, req, req->rq_status);
1937 if (ptlrpcd_check_work(req)) {
1938 atomic_dec(&set->set_remaining);
1941 ptlrpc_rqphase_move(req, RQ_PHASE_COMPLETE);
1943 CDEBUG(req->rq_reqmsg != NULL ? D_RPCTRACE : 0,
1944 "Completed RPC pname:cluuid:pid:xid:nid:"
1945 "opc %s:%s:%d:"LPU64":%s:%d\n",
1946 current_comm(), imp->imp_obd->obd_uuid.uuid,
1947 lustre_msg_get_status(req->rq_reqmsg), req->rq_xid,
1948 libcfs_nid2str(imp->imp_connection->c_peer.nid),
1949 lustre_msg_get_opc(req->rq_reqmsg));
1951 spin_lock(&imp->imp_lock);
1952 /* Request already may be not on sending or delaying list. This
1953 * may happen in the case of marking it erroneous for the case
1954 * ptlrpc_import_delay_req(req, status) find it impossible to
1955 * allow sending this rpc and returns *status != 0. */
1956 if (!list_empty(&req->rq_list)) {
1957 list_del_init(&req->rq_list);
1958 atomic_dec(&imp->imp_inflight);
1960 spin_unlock(&imp->imp_lock);
1962 atomic_dec(&set->set_remaining);
1963 wake_up_all(&imp->imp_recovery_waitq);
1965 if (set->set_producer) {
1966 /* produce a new request if possible */
1967 if (ptlrpc_set_producer(set) > 0)
1968 force_timer_recalc = 1;
1970 /* free the request that has just been completed
1971 * in order not to pollute set->set_requests */
1972 list_del_init(&req->rq_set_chain);
1973 spin_lock(&req->rq_lock);
1975 req->rq_invalid_rqset = 0;
1976 spin_unlock(&req->rq_lock);
1978 /* record rq_status to compute the final status later */
1979 if (req->rq_status != 0)
1980 set->set_rc = req->rq_status;
1981 ptlrpc_req_finished(req);
1983 list_move_tail(&req->rq_set_chain, &comp_reqs);
1987 /* move completed request at the head of list so it's easier for
1988 * caller to find them */
1989 list_splice(&comp_reqs, &set->set_requests);
1991 /* If we hit an error, we want to recover promptly. */
1992 RETURN(atomic_read(&set->set_remaining) == 0 || force_timer_recalc);
1994 EXPORT_SYMBOL(ptlrpc_check_set);
1997 * Time out request \a req. is \a async_unlink is set, that means do not wait
1998 * until LNet actually confirms network buffer unlinking.
1999 * Return 1 if we should give up further retrying attempts or 0 otherwise.
2001 int ptlrpc_expire_one_request(struct ptlrpc_request *req, int async_unlink)
2003 struct obd_import *imp = req->rq_import;
2007 spin_lock(&req->rq_lock);
2008 req->rq_timedout = 1;
2009 spin_unlock(&req->rq_lock);
2011 DEBUG_REQ(D_WARNING, req, "Request sent has %s: [sent "CFS_DURATION_T
2012 "/real "CFS_DURATION_T"]",
2013 req->rq_net_err ? "failed due to network error" :
2014 ((req->rq_real_sent == 0 ||
2015 cfs_time_before(req->rq_real_sent, req->rq_sent) ||
2016 cfs_time_aftereq(req->rq_real_sent, req->rq_deadline)) ?
2017 "timed out for sent delay" : "timed out for slow reply"),
2018 req->rq_sent, req->rq_real_sent);
2020 if (imp != NULL && obd_debug_peer_on_timeout)
2021 LNetCtl(IOC_LIBCFS_DEBUG_PEER, &imp->imp_connection->c_peer);
2023 ptlrpc_unregister_reply(req, async_unlink);
2024 ptlrpc_unregister_bulk(req, async_unlink);
2026 if (obd_dump_on_timeout)
2027 libcfs_debug_dumplog();
2030 DEBUG_REQ(D_HA, req, "NULL import: already cleaned up?");
2034 atomic_inc(&imp->imp_timeouts);
2036 /* The DLM server doesn't want recovery run on its imports. */
2037 if (imp->imp_dlm_fake)
2040 /* If this request is for recovery or other primordial tasks,
2041 * then error it out here. */
2042 if (req->rq_ctx_init || req->rq_ctx_fini ||
2043 req->rq_send_state != LUSTRE_IMP_FULL ||
2044 imp->imp_obd->obd_no_recov) {
2045 DEBUG_REQ(D_RPCTRACE, req, "err -110, sent_state=%s (now=%s)",
2046 ptlrpc_import_state_name(req->rq_send_state),
2047 ptlrpc_import_state_name(imp->imp_state));
2048 spin_lock(&req->rq_lock);
2049 req->rq_status = -ETIMEDOUT;
2051 spin_unlock(&req->rq_lock);
2055 /* if a request can't be resent we can't wait for an answer after
2057 if (ptlrpc_no_resend(req)) {
2058 DEBUG_REQ(D_RPCTRACE, req, "TIMEOUT-NORESEND:");
2062 ptlrpc_fail_import(imp, lustre_msg_get_conn_cnt(req->rq_reqmsg));
2068 * Time out all uncompleted requests in request set pointed by \a data
2069 * Callback used when waiting on sets with l_wait_event.
2072 int ptlrpc_expired_set(void *data)
2074 struct ptlrpc_request_set *set = data;
2075 struct list_head *tmp;
2076 time_t now = cfs_time_current_sec();
2079 LASSERT(set != NULL);
2082 * A timeout expired. See which reqs it applies to...
2084 list_for_each(tmp, &set->set_requests) {
2085 struct ptlrpc_request *req =
2086 list_entry(tmp, struct ptlrpc_request,
2089 /* don't expire request waiting for context */
2090 if (req->rq_wait_ctx)
2093 /* Request in-flight? */
2094 if (!((req->rq_phase == RQ_PHASE_RPC &&
2095 !req->rq_waiting && !req->rq_resend) ||
2096 (req->rq_phase == RQ_PHASE_BULK)))
2099 if (req->rq_timedout || /* already dealt with */
2100 req->rq_deadline > now) /* not expired */
2103 /* Deal with this guy. Do it asynchronously to not block
2104 * ptlrpcd thread. */
2105 ptlrpc_expire_one_request(req, 1);
2109 * When waiting for a whole set, we always break out of the
2110 * sleep so we can recalculate the timeout, or enable interrupts
2111 * if everyone's timed out.
2117 * Sets rq_intr flag in \a req under spinlock.
2119 void ptlrpc_mark_interrupted(struct ptlrpc_request *req)
2121 spin_lock(&req->rq_lock);
2123 spin_unlock(&req->rq_lock);
2125 EXPORT_SYMBOL(ptlrpc_mark_interrupted);
2128 * Interrupts (sets interrupted flag) all uncompleted requests in
2129 * a set \a data. Callback for l_wait_event for interruptible waits.
2131 static void ptlrpc_interrupted_set(void *data)
2133 struct ptlrpc_request_set *set = data;
2134 struct list_head *tmp;
2136 LASSERT(set != NULL);
2137 CDEBUG(D_RPCTRACE, "INTERRUPTED SET %p\n", set);
2139 list_for_each(tmp, &set->set_requests) {
2140 struct ptlrpc_request *req =
2141 list_entry(tmp, struct ptlrpc_request, rq_set_chain);
2143 if (req->rq_phase != RQ_PHASE_RPC &&
2144 req->rq_phase != RQ_PHASE_UNREGISTERING)
2147 ptlrpc_mark_interrupted(req);
2152 * Get the smallest timeout in the set; this does NOT set a timeout.
2154 int ptlrpc_set_next_timeout(struct ptlrpc_request_set *set)
2156 struct list_head *tmp;
2157 time_t now = cfs_time_current_sec();
2159 struct ptlrpc_request *req;
2163 list_for_each(tmp, &set->set_requests) {
2164 req = list_entry(tmp, struct ptlrpc_request, rq_set_chain);
2167 * Request in-flight?
2169 if (!(((req->rq_phase == RQ_PHASE_RPC) && !req->rq_waiting) ||
2170 (req->rq_phase == RQ_PHASE_BULK) ||
2171 (req->rq_phase == RQ_PHASE_NEW)))
2175 * Already timed out.
2177 if (req->rq_timedout)
2183 if (req->rq_wait_ctx)
2186 if (req->rq_phase == RQ_PHASE_NEW)
2187 deadline = req->rq_sent;
2188 else if (req->rq_phase == RQ_PHASE_RPC && req->rq_resend)
2189 deadline = req->rq_sent;
2191 deadline = req->rq_sent + req->rq_timeout;
2193 if (deadline <= now) /* actually expired already */
2194 timeout = 1; /* ASAP */
2195 else if (timeout == 0 || timeout > deadline - now)
2196 timeout = deadline - now;
2202 * Send all unset request from the set and then wait untill all
2203 * requests in the set complete (either get a reply, timeout, get an
2204 * error or otherwise be interrupted).
2205 * Returns 0 on success or error code otherwise.
2207 int ptlrpc_set_wait(struct ptlrpc_request_set *set)
2209 struct list_head *tmp;
2210 struct ptlrpc_request *req;
2211 struct l_wait_info lwi;
2215 if (set->set_producer)
2216 (void)ptlrpc_set_producer(set);
2218 list_for_each(tmp, &set->set_requests) {
2219 req = list_entry(tmp, struct ptlrpc_request,
2221 if (req->rq_phase == RQ_PHASE_NEW)
2222 (void)ptlrpc_send_new_req(req);
2225 if (list_empty(&set->set_requests))
2229 timeout = ptlrpc_set_next_timeout(set);
2231 /* wait until all complete, interrupted, or an in-flight
2233 CDEBUG(D_RPCTRACE, "set %p going to sleep for %d seconds\n",
2236 if (timeout == 0 && !signal_pending(current))
2238 * No requests are in-flight (ether timed out
2239 * or delayed), so we can allow interrupts.
2240 * We still want to block for a limited time,
2241 * so we allow interrupts during the timeout.
2243 lwi = LWI_TIMEOUT_INTR_ALL(cfs_time_seconds(1),
2245 ptlrpc_interrupted_set, set);
2248 * At least one request is in flight, so no
2249 * interrupts are allowed. Wait until all
2250 * complete, or an in-flight req times out.
2252 lwi = LWI_TIMEOUT(cfs_time_seconds(timeout? timeout : 1),
2253 ptlrpc_expired_set, set);
2255 rc = l_wait_event(set->set_waitq, ptlrpc_check_set(NULL, set), &lwi);
2257 /* LU-769 - if we ignored the signal because it was already
2258 * pending when we started, we need to handle it now or we risk
2259 * it being ignored forever */
2260 if (rc == -ETIMEDOUT && !lwi.lwi_allow_intr &&
2261 signal_pending(current)) {
2262 sigset_t blocked_sigs =
2263 cfs_block_sigsinv(LUSTRE_FATAL_SIGS);
2265 /* In fact we only interrupt for the "fatal" signals
2266 * like SIGINT or SIGKILL. We still ignore less
2267 * important signals since ptlrpc set is not easily
2268 * reentrant from userspace again */
2269 if (signal_pending(current))
2270 ptlrpc_interrupted_set(set);
2271 cfs_restore_sigs(blocked_sigs);
2274 LASSERT(rc == 0 || rc == -EINTR || rc == -ETIMEDOUT);
2276 /* -EINTR => all requests have been flagged rq_intr so next
2278 * -ETIMEDOUT => someone timed out. When all reqs have
2279 * timed out, signals are enabled allowing completion with
2281 * I don't really care if we go once more round the loop in
2282 * the error cases -eeb. */
2283 if (rc == 0 && atomic_read(&set->set_remaining) == 0) {
2284 list_for_each(tmp, &set->set_requests) {
2285 req = list_entry(tmp, struct ptlrpc_request,
2287 spin_lock(&req->rq_lock);
2288 req->rq_invalid_rqset = 1;
2289 spin_unlock(&req->rq_lock);
2292 } while (rc != 0 || atomic_read(&set->set_remaining) != 0);
2294 LASSERT(atomic_read(&set->set_remaining) == 0);
2296 rc = set->set_rc; /* rq_status of already freed requests if any */
2297 list_for_each(tmp, &set->set_requests) {
2298 req = list_entry(tmp, struct ptlrpc_request, rq_set_chain);
2300 LASSERT(req->rq_phase == RQ_PHASE_COMPLETE);
2301 if (req->rq_status != 0)
2302 rc = req->rq_status;
2305 if (set->set_interpret != NULL) {
2306 int (*interpreter)(struct ptlrpc_request_set *set,void *,int) =
2308 rc = interpreter (set, set->set_arg, rc);
2310 struct ptlrpc_set_cbdata *cbdata, *n;
2313 list_for_each_entry_safe(cbdata, n,
2314 &set->set_cblist, psc_item) {
2315 list_del_init(&cbdata->psc_item);
2316 err = cbdata->psc_interpret(set, cbdata->psc_data, rc);
2319 OBD_FREE_PTR(cbdata);
2325 EXPORT_SYMBOL(ptlrpc_set_wait);
2328 * Helper fuction for request freeing.
2329 * Called when request count reached zero and request needs to be freed.
2330 * Removes request from all sorts of sending/replay lists it might be on,
2331 * frees network buffers if any are present.
2332 * If \a locked is set, that means caller is already holding import imp_lock
2333 * and so we no longer need to reobtain it (for certain lists manipulations)
2335 static void __ptlrpc_free_req(struct ptlrpc_request *request, int locked)
2339 if (request == NULL)
2342 LASSERT(!request->rq_srv_req);
2343 LASSERT(request->rq_export == NULL);
2344 LASSERTF(!request->rq_receiving_reply, "req %p\n", request);
2345 LASSERTF(list_empty(&request->rq_list), "req %p\n", request);
2346 LASSERTF(list_empty(&request->rq_set_chain), "req %p\n", request);
2347 LASSERTF(!request->rq_replay, "req %p\n", request);
2349 req_capsule_fini(&request->rq_pill);
2351 /* We must take it off the imp_replay_list first. Otherwise, we'll set
2352 * request->rq_reqmsg to NULL while osc_close is dereferencing it. */
2353 if (request->rq_import != NULL) {
2355 spin_lock(&request->rq_import->imp_lock);
2356 list_del_init(&request->rq_replay_list);
2358 spin_unlock(&request->rq_import->imp_lock);
2360 LASSERTF(list_empty(&request->rq_replay_list), "req %p\n", request);
2362 if (atomic_read(&request->rq_refcount) != 0) {
2363 DEBUG_REQ(D_ERROR, request,
2364 "freeing request with nonzero refcount");
2368 if (request->rq_repbuf != NULL)
2369 sptlrpc_cli_free_repbuf(request);
2371 if (request->rq_import != NULL) {
2372 class_import_put(request->rq_import);
2373 request->rq_import = NULL;
2375 if (request->rq_bulk != NULL)
2376 ptlrpc_free_bulk(request->rq_bulk);
2378 if (request->rq_reqbuf != NULL || request->rq_clrbuf != NULL)
2379 sptlrpc_cli_free_reqbuf(request);
2381 if (request->rq_cli_ctx)
2382 sptlrpc_req_put_ctx(request, !locked);
2384 if (request->rq_pool)
2385 __ptlrpc_free_req_to_pool(request);
2387 ptlrpc_request_cache_free(request);
2391 static int __ptlrpc_req_finished(struct ptlrpc_request *request, int locked);
2393 * Drop one request reference. Must be called with import imp_lock held.
2394 * When reference count drops to zero, request is freed.
2396 void ptlrpc_req_finished_with_imp_lock(struct ptlrpc_request *request)
2398 assert_spin_locked(&request->rq_import->imp_lock);
2399 (void)__ptlrpc_req_finished(request, 1);
2404 * Drops one reference count for request \a request.
2405 * \a locked set indicates that caller holds import imp_lock.
2406 * Frees the request whe reference count reaches zero.
2408 static int __ptlrpc_req_finished(struct ptlrpc_request *request, int locked)
2411 if (request == NULL)
2414 if (request == LP_POISON ||
2415 request->rq_reqmsg == LP_POISON) {
2416 CERROR("dereferencing freed request (bug 575)\n");
2421 DEBUG_REQ(D_INFO, request, "refcount now %u",
2422 atomic_read(&request->rq_refcount) - 1);
2424 if (atomic_dec_and_test(&request->rq_refcount)) {
2425 __ptlrpc_free_req(request, locked);
2433 * Drops one reference count for a request.
2435 void ptlrpc_req_finished(struct ptlrpc_request *request)
2437 __ptlrpc_req_finished(request, 0);
2439 EXPORT_SYMBOL(ptlrpc_req_finished);
2442 * Returns xid of a \a request
2444 __u64 ptlrpc_req_xid(struct ptlrpc_request *request)
2446 return request->rq_xid;
2448 EXPORT_SYMBOL(ptlrpc_req_xid);
2451 * Disengage the client's reply buffer from the network
2452 * NB does _NOT_ unregister any client-side bulk.
2453 * IDEMPOTENT, but _not_ safe against concurrent callers.
2454 * The request owner (i.e. the thread doing the I/O) must call...
2455 * Returns 0 on success or 1 if unregistering cannot be made.
2457 static int ptlrpc_unregister_reply(struct ptlrpc_request *request, int async)
2460 struct l_wait_info lwi;
2465 LASSERT(!in_interrupt());
2468 * Let's setup deadline for reply unlink.
2470 if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK) &&
2471 async && request->rq_reply_deadline == 0)
2472 request->rq_reply_deadline = cfs_time_current_sec()+LONG_UNLINK;
2475 * Nothing left to do.
2477 if (!ptlrpc_client_recv_or_unlink(request))
2480 LNetMDUnlink(request->rq_reply_md_h);
2483 * Let's check it once again.
2485 if (!ptlrpc_client_recv_or_unlink(request))
2489 * Move to "Unregistering" phase as reply was not unlinked yet.
2491 ptlrpc_rqphase_move(request, RQ_PHASE_UNREGISTERING);
2494 * Do not wait for unlink to finish.
2500 * We have to l_wait_event() whatever the result, to give liblustre
2501 * a chance to run reply_in_callback(), and to make sure we've
2502 * unlinked before returning a req to the pool.
2505 /* The wq argument is ignored by user-space wait_event macros */
2506 wait_queue_head_t *wq = (request->rq_set != NULL) ?
2507 &request->rq_set->set_waitq :
2508 &request->rq_reply_waitq;
2509 /* Network access will complete in finite time but the HUGE
2510 * timeout lets us CWARN for visibility of sluggish NALs */
2511 lwi = LWI_TIMEOUT_INTERVAL(cfs_time_seconds(LONG_UNLINK),
2512 cfs_time_seconds(1), NULL, NULL);
2513 rc = l_wait_event(*wq, !ptlrpc_client_recv_or_unlink(request),
2516 ptlrpc_rqphase_move(request, request->rq_next_phase);
2520 LASSERT(rc == -ETIMEDOUT);
2521 DEBUG_REQ(D_WARNING, request, "Unexpectedly long timeout "
2522 "receiving_reply=%d req_ulinked=%d reply_unlinked=%d",
2523 request->rq_receiving_reply,
2524 request->rq_req_unlinked,
2525 request->rq_reply_unlinked);
2530 static void ptlrpc_free_request(struct ptlrpc_request *req)
2532 spin_lock(&req->rq_lock);
2534 spin_unlock(&req->rq_lock);
2536 if (req->rq_commit_cb != NULL)
2537 req->rq_commit_cb(req);
2538 list_del_init(&req->rq_replay_list);
2540 __ptlrpc_req_finished(req, 1);
2544 * the request is committed and dropped from the replay list of its import
2546 void ptlrpc_request_committed(struct ptlrpc_request *req, int force)
2548 struct obd_import *imp = req->rq_import;
2550 spin_lock(&imp->imp_lock);
2551 if (list_empty(&req->rq_replay_list)) {
2552 spin_unlock(&imp->imp_lock);
2556 if (force || req->rq_transno <= imp->imp_peer_committed_transno)
2557 ptlrpc_free_request(req);
2559 spin_unlock(&imp->imp_lock);
2561 EXPORT_SYMBOL(ptlrpc_request_committed);
2564 * Iterates through replay_list on import and prunes
2565 * all requests have transno smaller than last_committed for the
2566 * import and don't have rq_replay set.
2567 * Since requests are sorted in transno order, stops when meetign first
2568 * transno bigger than last_committed.
2569 * caller must hold imp->imp_lock
2571 void ptlrpc_free_committed(struct obd_import *imp)
2573 struct ptlrpc_request *req, *saved;
2574 struct ptlrpc_request *last_req = NULL; /* temporary fire escape */
2575 bool skip_committed_list = true;
2578 LASSERT(imp != NULL);
2579 assert_spin_locked(&imp->imp_lock);
2581 if (imp->imp_peer_committed_transno == imp->imp_last_transno_checked &&
2582 imp->imp_generation == imp->imp_last_generation_checked) {
2583 CDEBUG(D_INFO, "%s: skip recheck: last_committed "LPU64"\n",
2584 imp->imp_obd->obd_name, imp->imp_peer_committed_transno);
2587 CDEBUG(D_RPCTRACE, "%s: committing for last_committed "LPU64" gen %d\n",
2588 imp->imp_obd->obd_name, imp->imp_peer_committed_transno,
2589 imp->imp_generation);
2591 if (imp->imp_generation != imp->imp_last_generation_checked ||
2592 imp->imp_last_transno_checked == 0)
2593 skip_committed_list = false;
2595 imp->imp_last_transno_checked = imp->imp_peer_committed_transno;
2596 imp->imp_last_generation_checked = imp->imp_generation;
2598 list_for_each_entry_safe(req, saved, &imp->imp_replay_list,
2600 /* XXX ok to remove when 1357 resolved - rread 05/29/03 */
2601 LASSERT(req != last_req);
2604 if (req->rq_transno == 0) {
2605 DEBUG_REQ(D_EMERG, req, "zero transno during replay");
2608 if (req->rq_import_generation < imp->imp_generation) {
2609 DEBUG_REQ(D_RPCTRACE, req, "free request with old gen");
2613 /* not yet committed */
2614 if (req->rq_transno > imp->imp_peer_committed_transno) {
2615 DEBUG_REQ(D_RPCTRACE, req, "stopping search");
2619 if (req->rq_replay) {
2620 DEBUG_REQ(D_RPCTRACE, req, "keeping (FL_REPLAY)");
2621 list_move_tail(&req->rq_replay_list,
2622 &imp->imp_committed_list);
2626 DEBUG_REQ(D_INFO, req, "commit (last_committed "LPU64")",
2627 imp->imp_peer_committed_transno);
2629 ptlrpc_free_request(req);
2632 if (skip_committed_list)
2635 list_for_each_entry_safe(req, saved, &imp->imp_committed_list,
2637 LASSERT(req->rq_transno != 0);
2638 if (req->rq_import_generation < imp->imp_generation) {
2639 DEBUG_REQ(D_RPCTRACE, req, "free stale open request");
2640 ptlrpc_free_request(req);
2641 } else if (!req->rq_replay) {
2642 DEBUG_REQ(D_RPCTRACE, req, "free closed open request");
2643 ptlrpc_free_request(req);
2650 void ptlrpc_cleanup_client(struct obd_import *imp)
2657 * Schedule previously sent request for resend.
2658 * For bulk requests we assign new xid (to avoid problems with
2659 * lost replies and therefore several transfers landing into same buffer
2660 * from different sending attempts).
2662 void ptlrpc_resend_req(struct ptlrpc_request *req)
2664 DEBUG_REQ(D_HA, req, "going to resend");
2665 spin_lock(&req->rq_lock);
2667 /* Request got reply but linked to the import list still.
2668 Let ptlrpc_check_set() to process it. */
2669 if (ptlrpc_client_replied(req)) {
2670 spin_unlock(&req->rq_lock);
2671 DEBUG_REQ(D_HA, req, "it has reply, so skip it");
2675 lustre_msg_set_handle(req->rq_reqmsg, &(struct lustre_handle){ 0 });
2676 req->rq_status = -EAGAIN;
2679 req->rq_net_err = 0;
2680 req->rq_timedout = 0;
2682 ptlrpc_client_wake_req(req);
2683 spin_unlock(&req->rq_lock);
2686 /* XXX: this function and rq_status are currently unused */
2687 void ptlrpc_restart_req(struct ptlrpc_request *req)
2689 DEBUG_REQ(D_HA, req, "restarting (possibly-)completed request");
2690 req->rq_status = -ERESTARTSYS;
2692 spin_lock(&req->rq_lock);
2693 req->rq_restart = 1;
2694 req->rq_timedout = 0;
2695 ptlrpc_client_wake_req(req);
2696 spin_unlock(&req->rq_lock);
2700 * Grab additional reference on a request \a req
2702 struct ptlrpc_request *ptlrpc_request_addref(struct ptlrpc_request *req)
2705 atomic_inc(&req->rq_refcount);
2708 EXPORT_SYMBOL(ptlrpc_request_addref);
2711 * Add a request to import replay_list.
2712 * Must be called under imp_lock
2714 void ptlrpc_retain_replayable_request(struct ptlrpc_request *req,
2715 struct obd_import *imp)
2717 struct list_head *tmp;
2719 assert_spin_locked(&imp->imp_lock);
2721 if (req->rq_transno == 0) {
2722 DEBUG_REQ(D_EMERG, req, "saving request with zero transno");
2726 /* clear this for new requests that were resent as well
2727 as resent replayed requests. */
2728 lustre_msg_clear_flags(req->rq_reqmsg, MSG_RESENT);
2730 /* don't re-add requests that have been replayed */
2731 if (!list_empty(&req->rq_replay_list))
2734 lustre_msg_add_flags(req->rq_reqmsg, MSG_REPLAY);
2736 LASSERT(imp->imp_replayable);
2737 /* Balanced in ptlrpc_free_committed, usually. */
2738 ptlrpc_request_addref(req);
2739 list_for_each_prev(tmp, &imp->imp_replay_list) {
2740 struct ptlrpc_request *iter = list_entry(tmp,
2741 struct ptlrpc_request,
2744 /* We may have duplicate transnos if we create and then
2745 * open a file, or for closes retained if to match creating
2746 * opens, so use req->rq_xid as a secondary key.
2747 * (See bugs 684, 685, and 428.)
2748 * XXX no longer needed, but all opens need transnos!
2750 if (iter->rq_transno > req->rq_transno)
2753 if (iter->rq_transno == req->rq_transno) {
2754 LASSERT(iter->rq_xid != req->rq_xid);
2755 if (iter->rq_xid > req->rq_xid)
2759 list_add(&req->rq_replay_list, &iter->rq_replay_list);
2763 list_add(&req->rq_replay_list, &imp->imp_replay_list);
2767 * Send request and wait until it completes.
2768 * Returns request processing status.
2770 int ptlrpc_queue_wait(struct ptlrpc_request *req)
2772 struct ptlrpc_request_set *set;
2776 LASSERT(req->rq_set == NULL);
2777 LASSERT(!req->rq_receiving_reply);
2779 set = ptlrpc_prep_set();
2781 CERROR("cannot allocate ptlrpc set: rc = %d\n", -ENOMEM);
2785 /* for distributed debugging */
2786 lustre_msg_set_status(req->rq_reqmsg, current_pid());
2788 /* add a ref for the set (see comment in ptlrpc_set_add_req) */
2789 ptlrpc_request_addref(req);
2790 ptlrpc_set_add_req(set, req);
2791 rc = ptlrpc_set_wait(set);
2792 ptlrpc_set_destroy(set);
2796 EXPORT_SYMBOL(ptlrpc_queue_wait);
2799 * Callback used for replayed requests reply processing.
2800 * In case of successful reply calls registered request replay callback.
2801 * In case of error restart replay process.
2803 static int ptlrpc_replay_interpret(const struct lu_env *env,
2804 struct ptlrpc_request *req,
2805 void * data, int rc)
2807 struct ptlrpc_replay_async_args *aa = data;
2808 struct obd_import *imp = req->rq_import;
2811 atomic_dec(&imp->imp_replay_inflight);
2813 if (!ptlrpc_client_replied(req)) {
2814 CERROR("request replay timed out, restarting recovery\n");
2815 GOTO(out, rc = -ETIMEDOUT);
2818 if (lustre_msg_get_type(req->rq_repmsg) == PTL_RPC_MSG_ERR &&
2819 (lustre_msg_get_status(req->rq_repmsg) == -ENOTCONN ||
2820 lustre_msg_get_status(req->rq_repmsg) == -ENODEV))
2821 GOTO(out, rc = lustre_msg_get_status(req->rq_repmsg));
2823 /** VBR: check version failure */
2824 if (lustre_msg_get_status(req->rq_repmsg) == -EOVERFLOW) {
2825 /** replay was failed due to version mismatch */
2826 DEBUG_REQ(D_WARNING, req, "Version mismatch during replay\n");
2827 spin_lock(&imp->imp_lock);
2828 imp->imp_vbr_failed = 1;
2829 imp->imp_no_lock_replay = 1;
2830 spin_unlock(&imp->imp_lock);
2831 lustre_msg_set_status(req->rq_repmsg, aa->praa_old_status);
2833 /** The transno had better not change over replay. */
2834 LASSERTF(lustre_msg_get_transno(req->rq_reqmsg) ==
2835 lustre_msg_get_transno(req->rq_repmsg) ||
2836 lustre_msg_get_transno(req->rq_repmsg) == 0,
2838 lustre_msg_get_transno(req->rq_reqmsg),
2839 lustre_msg_get_transno(req->rq_repmsg));
2842 spin_lock(&imp->imp_lock);
2843 /** if replays by version then gap occur on server, no trust to locks */
2844 if (lustre_msg_get_flags(req->rq_repmsg) & MSG_VERSION_REPLAY)
2845 imp->imp_no_lock_replay = 1;
2846 imp->imp_last_replay_transno = lustre_msg_get_transno(req->rq_reqmsg);
2847 spin_unlock(&imp->imp_lock);
2848 LASSERT(imp->imp_last_replay_transno);
2850 /* transaction number shouldn't be bigger than the latest replayed */
2851 if (req->rq_transno > lustre_msg_get_transno(req->rq_reqmsg)) {
2852 DEBUG_REQ(D_ERROR, req,
2853 "Reported transno "LPU64" is bigger than the "
2854 "replayed one: "LPU64, req->rq_transno,
2855 lustre_msg_get_transno(req->rq_reqmsg));
2856 GOTO(out, rc = -EINVAL);
2859 DEBUG_REQ(D_HA, req, "got rep");
2861 /* let the callback do fixups, possibly including in the request */
2862 if (req->rq_replay_cb)
2863 req->rq_replay_cb(req);
2865 if (ptlrpc_client_replied(req) &&
2866 lustre_msg_get_status(req->rq_repmsg) != aa->praa_old_status) {
2867 DEBUG_REQ(D_ERROR, req, "status %d, old was %d",
2868 lustre_msg_get_status(req->rq_repmsg),
2869 aa->praa_old_status);
2871 /* Put it back for re-replay. */
2872 lustre_msg_set_status(req->rq_repmsg, aa->praa_old_status);
2876 * Errors while replay can set transno to 0, but
2877 * imp_last_replay_transno shouldn't be set to 0 anyway
2879 if (req->rq_transno == 0)
2880 CERROR("Transno is 0 during replay!\n");
2882 /* continue with recovery */
2883 rc = ptlrpc_import_recovery_state_machine(imp);
2885 req->rq_send_state = aa->praa_old_state;
2888 /* this replay failed, so restart recovery */
2889 ptlrpc_connect_import(imp);
2895 * Prepares and queues request for replay.
2896 * Adds it to ptlrpcd queue for actual sending.
2897 * Returns 0 on success.
2899 int ptlrpc_replay_req(struct ptlrpc_request *req)
2901 struct ptlrpc_replay_async_args *aa;
2904 LASSERT(req->rq_import->imp_state == LUSTRE_IMP_REPLAY);
2906 LASSERT (sizeof (*aa) <= sizeof (req->rq_async_args));
2907 aa = ptlrpc_req_async_args(req);
2908 memset(aa, 0, sizeof *aa);
2910 /* Prepare request to be resent with ptlrpcd */
2911 aa->praa_old_state = req->rq_send_state;
2912 req->rq_send_state = LUSTRE_IMP_REPLAY;
2913 req->rq_phase = RQ_PHASE_NEW;
2914 req->rq_next_phase = RQ_PHASE_UNDEFINED;
2916 aa->praa_old_status = lustre_msg_get_status(req->rq_repmsg);
2918 req->rq_interpret_reply = ptlrpc_replay_interpret;
2919 /* Readjust the timeout for current conditions */
2920 ptlrpc_at_set_req_timeout(req);
2922 /* Tell server the net_latency, so the server can calculate how long
2923 * it should wait for next replay */
2924 lustre_msg_set_service_time(req->rq_reqmsg,
2925 ptlrpc_at_get_net_latency(req));
2926 DEBUG_REQ(D_HA, req, "REPLAY");
2928 atomic_inc(&req->rq_import->imp_replay_inflight);
2929 ptlrpc_request_addref(req); /* ptlrpcd needs a ref */
2931 ptlrpcd_add_req(req, PDL_POLICY_LOCAL, -1);
2936 * Aborts all in-flight request on import \a imp sending and delayed lists
2938 void ptlrpc_abort_inflight(struct obd_import *imp)
2940 struct list_head *tmp, *n;
2943 /* Make sure that no new requests get processed for this import.
2944 * ptlrpc_{queue,set}_wait must (and does) hold imp_lock while testing
2945 * this flag and then putting requests on sending_list or delayed_list.
2947 spin_lock(&imp->imp_lock);
2949 /* XXX locking? Maybe we should remove each request with the list
2950 * locked? Also, how do we know if the requests on the list are
2951 * being freed at this time?
2953 list_for_each_safe(tmp, n, &imp->imp_sending_list) {
2954 struct ptlrpc_request *req = list_entry(tmp,
2955 struct ptlrpc_request,
2958 DEBUG_REQ(D_RPCTRACE, req, "inflight");
2960 spin_lock(&req->rq_lock);
2961 if (req->rq_import_generation < imp->imp_generation) {
2963 req->rq_status = -EIO;
2964 ptlrpc_client_wake_req(req);
2966 spin_unlock(&req->rq_lock);
2969 list_for_each_safe(tmp, n, &imp->imp_delayed_list) {
2970 struct ptlrpc_request *req =
2971 list_entry(tmp, struct ptlrpc_request, rq_list);
2973 DEBUG_REQ(D_RPCTRACE, req, "aborting waiting req");
2975 spin_lock(&req->rq_lock);
2976 if (req->rq_import_generation < imp->imp_generation) {
2978 req->rq_status = -EIO;
2979 ptlrpc_client_wake_req(req);
2981 spin_unlock(&req->rq_lock);
2984 /* Last chance to free reqs left on the replay list, but we
2985 * will still leak reqs that haven't committed. */
2986 if (imp->imp_replayable)
2987 ptlrpc_free_committed(imp);
2989 spin_unlock(&imp->imp_lock);
2995 * Abort all uncompleted requests in request set \a set
2997 void ptlrpc_abort_set(struct ptlrpc_request_set *set)
2999 struct list_head *tmp, *pos;
3001 LASSERT(set != NULL);
3003 list_for_each_safe(pos, tmp, &set->set_requests) {
3004 struct ptlrpc_request *req =
3005 list_entry(pos, struct ptlrpc_request,
3008 spin_lock(&req->rq_lock);
3009 if (req->rq_phase != RQ_PHASE_RPC) {
3010 spin_unlock(&req->rq_lock);
3015 req->rq_status = -EINTR;
3016 ptlrpc_client_wake_req(req);
3017 spin_unlock(&req->rq_lock);
3021 static __u64 ptlrpc_last_xid;
3022 static spinlock_t ptlrpc_last_xid_lock;
3025 * Initialize the XID for the node. This is common among all requests on
3026 * this node, and only requires the property that it is monotonically
3027 * increasing. It does not need to be sequential. Since this is also used
3028 * as the RDMA match bits, it is important that a single client NOT have
3029 * the same match bits for two different in-flight requests, hence we do
3030 * NOT want to have an XID per target or similar.
3032 * To avoid an unlikely collision between match bits after a client reboot
3033 * (which would deliver old data into the wrong RDMA buffer) initialize
3034 * the XID based on the current time, assuming a maximum RPC rate of 1M RPC/s.
3035 * If the time is clearly incorrect, we instead use a 62-bit random number.
3036 * In the worst case the random number will overflow 1M RPCs per second in
3037 * 9133 years, or permutations thereof.
3039 #define YEAR_2004 (1ULL << 30)
3040 void ptlrpc_init_xid(void)
3042 time_t now = cfs_time_current_sec();
3044 spin_lock_init(&ptlrpc_last_xid_lock);
3045 if (now < YEAR_2004) {
3046 cfs_get_random_bytes(&ptlrpc_last_xid, sizeof(ptlrpc_last_xid));
3047 ptlrpc_last_xid >>= 2;
3048 ptlrpc_last_xid |= (1ULL << 61);
3050 ptlrpc_last_xid = (__u64)now << 20;
3053 /* Need to always be aligned to a power-of-two for mutli-bulk BRW */
3054 CLASSERT((PTLRPC_BULK_OPS_COUNT & (PTLRPC_BULK_OPS_COUNT - 1)) == 0);
3055 ptlrpc_last_xid &= PTLRPC_BULK_OPS_MASK;
3059 * Increase xid and returns resulting new value to the caller.
3061 * Multi-bulk BRW RPCs consume multiple XIDs for each bulk transfer, starting
3062 * at the returned xid, up to xid + PTLRPC_BULK_OPS_COUNT - 1. The BRW RPC
3063 * itself uses the last bulk xid needed, so the server can determine the
3064 * the number of bulk transfers from the RPC XID and a bitmask. The starting
3065 * xid must align to a power-of-two value.
3067 * This is assumed to be true due to the initial ptlrpc_last_xid
3068 * value also being initialized to a power-of-two value. LU-1431
3070 __u64 ptlrpc_next_xid(void)
3074 spin_lock(&ptlrpc_last_xid_lock);
3075 next = ptlrpc_last_xid + PTLRPC_BULK_OPS_COUNT;
3076 ptlrpc_last_xid = next;
3077 spin_unlock(&ptlrpc_last_xid_lock);
3083 * If request has a new allocated XID (new request or EINPROGRESS resend),
3084 * use this XID as matchbits of bulk, otherwise allocate a new matchbits for
3085 * request to ensure previous bulk fails and avoid problems with lost replies
3086 * and therefore several transfers landing into the same buffer from different
3089 void ptlrpc_set_bulk_mbits(struct ptlrpc_request *req)
3091 struct ptlrpc_bulk_desc *bd = req->rq_bulk;
3093 LASSERT(bd != NULL);
3095 if (!req->rq_resend || req->rq_nr_resend != 0) {
3096 /* this request has a new xid, just use it as bulk matchbits */
3097 req->rq_mbits = req->rq_xid;
3099 } else { /* needs to generate a new matchbits for resend */
3100 __u64 old_mbits = req->rq_mbits;
3102 if ((bd->bd_import->imp_connect_data.ocd_connect_flags &
3103 OBD_CONNECT_BULK_MBITS) != 0)
3104 req->rq_mbits = ptlrpc_next_xid();
3105 else /* old version transfers rq_xid to peer as matchbits */
3106 req->rq_mbits = req->rq_xid = ptlrpc_next_xid();
3108 CDEBUG(D_HA, "resend bulk old x"LPU64" new x"LPU64"\n",
3109 old_mbits, req->rq_mbits);
3112 /* For multi-bulk RPCs, rq_mbits is the last mbits needed for bulks so
3113 * that server can infer the number of bulks that were prepared,
3115 req->rq_mbits += ((bd->bd_iov_count + LNET_MAX_IOV - 1) /
3120 * Get a glimpse at what next xid value might have been.
3121 * Returns possible next xid.
3123 __u64 ptlrpc_sample_next_xid(void)
3125 #if BITS_PER_LONG == 32
3126 /* need to avoid possible word tearing on 32-bit systems */
3129 spin_lock(&ptlrpc_last_xid_lock);
3130 next = ptlrpc_last_xid + PTLRPC_BULK_OPS_COUNT;
3131 spin_unlock(&ptlrpc_last_xid_lock);
3135 /* No need to lock, since returned value is racy anyways */
3136 return ptlrpc_last_xid + PTLRPC_BULK_OPS_COUNT;
3139 EXPORT_SYMBOL(ptlrpc_sample_next_xid);
3142 * Functions for operating ptlrpc workers.
3144 * A ptlrpc work is a function which will be running inside ptlrpc context.
3145 * The callback shouldn't sleep otherwise it will block that ptlrpcd thread.
3147 * 1. after a work is created, it can be used many times, that is:
3148 * handler = ptlrpcd_alloc_work();
3149 * ptlrpcd_queue_work();
3151 * queue it again when necessary:
3152 * ptlrpcd_queue_work();
3153 * ptlrpcd_destroy_work();
3154 * 2. ptlrpcd_queue_work() can be called by multiple processes meanwhile, but
3155 * it will only be queued once in any time. Also as its name implies, it may
3156 * have delay before it really runs by ptlrpcd thread.
3158 struct ptlrpc_work_async_args {
3159 int (*cb)(const struct lu_env *, void *);
3163 static void ptlrpcd_add_work_req(struct ptlrpc_request *req)
3165 /* re-initialize the req */
3166 req->rq_timeout = obd_timeout;
3167 req->rq_sent = cfs_time_current_sec();
3168 req->rq_deadline = req->rq_sent + req->rq_timeout;
3169 req->rq_reply_deadline = req->rq_deadline;
3170 req->rq_phase = RQ_PHASE_INTERPRET;
3171 req->rq_next_phase = RQ_PHASE_COMPLETE;
3172 req->rq_xid = ptlrpc_next_xid();
3173 req->rq_import_generation = req->rq_import->imp_generation;
3175 ptlrpcd_add_req(req, PDL_POLICY_ROUND, -1);
3178 static int work_interpreter(const struct lu_env *env,
3179 struct ptlrpc_request *req, void *data, int rc)
3181 struct ptlrpc_work_async_args *arg = data;
3183 LASSERT(ptlrpcd_check_work(req));
3184 LASSERT(arg->cb != NULL);
3186 rc = arg->cb(env, arg->cbdata);
3188 list_del_init(&req->rq_set_chain);
3191 if (atomic_dec_return(&req->rq_refcount) > 1) {
3192 atomic_set(&req->rq_refcount, 2);
3193 ptlrpcd_add_work_req(req);
3198 static int worker_format;
3200 static int ptlrpcd_check_work(struct ptlrpc_request *req)
3202 return req->rq_pill.rc_fmt == (void *)&worker_format;
3206 * Create a work for ptlrpc.
3208 void *ptlrpcd_alloc_work(struct obd_import *imp,
3209 int (*cb)(const struct lu_env *, void *), void *cbdata)
3211 struct ptlrpc_request *req = NULL;
3212 struct ptlrpc_work_async_args *args;
3218 RETURN(ERR_PTR(-EINVAL));
3220 /* copy some code from deprecated fakereq. */
3221 req = ptlrpc_request_cache_alloc(GFP_NOFS);
3223 CERROR("ptlrpc: run out of memory!\n");
3224 RETURN(ERR_PTR(-ENOMEM));
3227 ptlrpc_cli_req_init(req);
3229 req->rq_send_state = LUSTRE_IMP_FULL;
3230 req->rq_type = PTL_RPC_MSG_REQUEST;
3231 req->rq_import = class_import_get(imp);
3232 req->rq_interpret_reply = work_interpreter;
3233 /* don't want reply */
3234 req->rq_no_delay = req->rq_no_resend = 1;
3235 req->rq_pill.rc_fmt = (void *)&worker_format;
3237 CLASSERT (sizeof(*args) <= sizeof(req->rq_async_args));
3238 args = ptlrpc_req_async_args(req);
3240 args->cbdata = cbdata;
3244 EXPORT_SYMBOL(ptlrpcd_alloc_work);
3246 void ptlrpcd_destroy_work(void *handler)
3248 struct ptlrpc_request *req = handler;
3251 ptlrpc_req_finished(req);
3253 EXPORT_SYMBOL(ptlrpcd_destroy_work);
3255 int ptlrpcd_queue_work(void *handler)
3257 struct ptlrpc_request *req = handler;
3260 * Check if the req is already being queued.
3262 * Here comes a trick: it lacks a way of checking if a req is being
3263 * processed reliably in ptlrpc. Here I have to use refcount of req
3264 * for this purpose. This is okay because the caller should use this
3265 * req as opaque data. - Jinshan
3267 LASSERT(atomic_read(&req->rq_refcount) > 0);
3268 if (atomic_inc_return(&req->rq_refcount) == 2)
3269 ptlrpcd_add_work_req(req);
3272 EXPORT_SYMBOL(ptlrpcd_queue_work);