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 static int ptlrpc_send_new_req(struct ptlrpc_request *req);
63 static int ptlrpcd_check_work(struct ptlrpc_request *req);
64 static int ptlrpc_unregister_reply(struct ptlrpc_request *request, int async);
67 * Initialize passed in client structure \a cl.
69 void ptlrpc_init_client(int req_portal, int rep_portal, char *name,
70 struct ptlrpc_client *cl)
72 cl->cli_request_portal = req_portal;
73 cl->cli_reply_portal = rep_portal;
76 EXPORT_SYMBOL(ptlrpc_init_client);
79 * Return PortalRPC connection for remore uud \a uuid
81 struct ptlrpc_connection *ptlrpc_uuid_to_connection(struct obd_uuid *uuid)
83 struct ptlrpc_connection *c;
85 lnet_process_id_t peer;
88 /* ptlrpc_uuid_to_peer() initializes its 2nd parameter
89 * before accessing its values. */
90 /* coverity[uninit_use_in_call] */
91 err = ptlrpc_uuid_to_peer(uuid, &peer, &self);
93 CNETERR("cannot find peer %s!\n", uuid->uuid);
97 c = ptlrpc_connection_get(peer, self, uuid);
99 memcpy(c->c_remote_uuid.uuid,
100 uuid->uuid, sizeof(c->c_remote_uuid.uuid));
103 CDEBUG(D_INFO, "%s -> %p\n", uuid->uuid, c);
109 * Allocate and initialize new bulk descriptor on the sender.
110 * Returns pointer to the descriptor or NULL on error.
112 struct ptlrpc_bulk_desc *ptlrpc_new_bulk(unsigned nfrags, unsigned max_brw,
113 enum ptlrpc_bulk_op_type type,
115 const struct ptlrpc_bulk_frag_ops *ops)
117 struct ptlrpc_bulk_desc *desc;
120 /* ensure that only one of KIOV or IOVEC is set but not both */
121 LASSERT((ptlrpc_is_bulk_desc_kiov(type) &&
122 ops->add_kiov_frag != NULL) ||
123 (ptlrpc_is_bulk_desc_kvec(type) &&
124 ops->add_iov_frag != NULL));
126 if (type & PTLRPC_BULK_BUF_KIOV) {
128 offsetof(struct ptlrpc_bulk_desc,
129 bd_u.bd_kiov.bd_vec[nfrags]));
132 offsetof(struct ptlrpc_bulk_desc,
133 bd_u.bd_kvec.bd_kvec[nfrags]));
139 spin_lock_init(&desc->bd_lock);
140 init_waitqueue_head(&desc->bd_waitq);
141 desc->bd_max_iov = nfrags;
142 desc->bd_iov_count = 0;
143 desc->bd_portal = portal;
144 desc->bd_type = type;
145 desc->bd_md_count = 0;
146 desc->bd_frag_ops = (struct ptlrpc_bulk_frag_ops *) ops;
147 LASSERT(max_brw > 0);
148 desc->bd_md_max_brw = min(max_brw, PTLRPC_BULK_OPS_COUNT);
149 /* PTLRPC_BULK_OPS_COUNT is the compile-time transfer limit for this
150 * node. Negotiated ocd_brw_size will always be <= this number. */
151 for (i = 0; i < PTLRPC_BULK_OPS_COUNT; i++)
152 LNetInvalidateHandle(&desc->bd_mds[i]);
158 * Prepare bulk descriptor for specified outgoing request \a req that
159 * can fit \a nfrags * pages. \a type is bulk type. \a portal is where
160 * the bulk to be sent. Used on client-side.
161 * Returns pointer to newly allocatrd initialized bulk descriptor or NULL on
164 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk_imp(struct ptlrpc_request *req,
165 unsigned nfrags, unsigned max_brw,
168 const struct ptlrpc_bulk_frag_ops
171 struct obd_import *imp = req->rq_import;
172 struct ptlrpc_bulk_desc *desc;
175 LASSERT(ptlrpc_is_bulk_op_passive(type));
177 desc = ptlrpc_new_bulk(nfrags, max_brw, type, portal, ops);
181 desc->bd_import_generation = req->rq_import_generation;
182 desc->bd_import = class_import_get(imp);
185 desc->bd_cbid.cbid_fn = client_bulk_callback;
186 desc->bd_cbid.cbid_arg = desc;
188 /* This makes req own desc, and free it when she frees herself */
193 EXPORT_SYMBOL(ptlrpc_prep_bulk_imp);
195 void __ptlrpc_prep_bulk_page(struct ptlrpc_bulk_desc *desc,
196 struct page *page, int pageoffset, int len,
201 LASSERT(desc->bd_iov_count < desc->bd_max_iov);
202 LASSERT(page != NULL);
203 LASSERT(pageoffset >= 0);
205 LASSERT(pageoffset + len <= PAGE_CACHE_SIZE);
206 LASSERT(ptlrpc_is_bulk_desc_kiov(desc->bd_type));
208 kiov = &BD_GET_KIOV(desc, desc->bd_iov_count);
213 page_cache_get(page);
215 kiov->kiov_page = page;
216 kiov->kiov_offset = pageoffset;
217 kiov->kiov_len = len;
219 desc->bd_iov_count++;
221 EXPORT_SYMBOL(__ptlrpc_prep_bulk_page);
223 int ptlrpc_prep_bulk_frag(struct ptlrpc_bulk_desc *desc,
228 LASSERT(desc->bd_iov_count < desc->bd_max_iov);
229 LASSERT(frag != NULL);
231 LASSERT(ptlrpc_is_bulk_desc_kvec(desc->bd_type));
233 iovec = &BD_GET_KVEC(desc, desc->bd_iov_count);
237 iovec->iov_base = frag;
238 iovec->iov_len = len;
240 desc->bd_iov_count++;
244 EXPORT_SYMBOL(ptlrpc_prep_bulk_frag);
246 void ptlrpc_free_bulk(struct ptlrpc_bulk_desc *desc)
250 LASSERT(desc != NULL);
251 LASSERT(desc->bd_iov_count != LI_POISON); /* not freed already */
252 LASSERT(desc->bd_md_count == 0); /* network hands off */
253 LASSERT((desc->bd_export != NULL) ^ (desc->bd_import != NULL));
254 LASSERT(desc->bd_frag_ops != NULL);
256 if (ptlrpc_is_bulk_desc_kiov(desc->bd_type))
257 sptlrpc_enc_pool_put_pages(desc);
260 class_export_put(desc->bd_export);
262 class_import_put(desc->bd_import);
264 if (desc->bd_frag_ops->release_frags != NULL)
265 desc->bd_frag_ops->release_frags(desc);
267 if (ptlrpc_is_bulk_desc_kiov(desc->bd_type))
268 OBD_FREE(desc, offsetof(struct ptlrpc_bulk_desc,
269 bd_u.bd_kiov.bd_vec[desc->bd_max_iov]));
271 OBD_FREE(desc, offsetof(struct ptlrpc_bulk_desc,
272 bd_u.bd_kvec.bd_kvec[desc->
277 EXPORT_SYMBOL(ptlrpc_free_bulk);
280 * Set server timelimit for this req, i.e. how long are we willing to wait
281 * for reply before timing out this request.
283 void ptlrpc_at_set_req_timeout(struct ptlrpc_request *req)
289 LASSERT(req->rq_import);
292 /* non-AT settings */
294 * \a imp_server_timeout means this is reverse import and
295 * we send (currently only) ASTs to the client and cannot afford
296 * to wait too long for the reply, otherwise the other client
297 * (because of which we are sending this request) would
298 * timeout waiting for us
300 req->rq_timeout = req->rq_import->imp_server_timeout ?
301 obd_timeout / 2 : obd_timeout;
303 at = &req->rq_import->imp_at;
304 idx = import_at_get_index(req->rq_import,
305 req->rq_request_portal);
306 serv_est = at_get(&at->iat_service_estimate[idx]);
307 req->rq_timeout = at_est2timeout(serv_est);
309 /* We could get even fancier here, using history to predict increased
312 /* Let the server know what this RPC timeout is by putting it in the
314 lustre_msg_set_timeout(req->rq_reqmsg, req->rq_timeout);
316 EXPORT_SYMBOL(ptlrpc_at_set_req_timeout);
318 /* Adjust max service estimate based on server value */
319 static void ptlrpc_at_adj_service(struct ptlrpc_request *req,
320 unsigned int serv_est)
326 LASSERT(req->rq_import);
327 at = &req->rq_import->imp_at;
329 idx = import_at_get_index(req->rq_import, req->rq_request_portal);
330 /* max service estimates are tracked on the server side,
331 so just keep minimal history here */
332 oldse = at_measured(&at->iat_service_estimate[idx], serv_est);
334 CDEBUG(D_ADAPTTO, "The RPC service estimate for %s ptl %d "
335 "has changed from %d to %d\n",
336 req->rq_import->imp_obd->obd_name,req->rq_request_portal,
337 oldse, at_get(&at->iat_service_estimate[idx]));
340 /* Expected network latency per remote node (secs) */
341 int ptlrpc_at_get_net_latency(struct ptlrpc_request *req)
343 return AT_OFF ? 0 : at_get(&req->rq_import->imp_at.iat_net_latency);
346 /* Adjust expected network latency */
347 void ptlrpc_at_adj_net_latency(struct ptlrpc_request *req,
348 unsigned int service_time)
350 unsigned int nl, oldnl;
352 time_t now = cfs_time_current_sec();
354 LASSERT(req->rq_import);
356 if (service_time > now - req->rq_sent + 3) {
357 /* bz16408, however, this can also happen if early reply
358 * is lost and client RPC is expired and resent, early reply
359 * or reply of original RPC can still be fit in reply buffer
360 * of resent RPC, now client is measuring time from the
361 * resent time, but server sent back service time of original
364 CDEBUG((lustre_msg_get_flags(req->rq_reqmsg) & MSG_RESENT) ?
365 D_ADAPTTO : D_WARNING,
366 "Reported service time %u > total measured time "
367 CFS_DURATION_T"\n", service_time,
368 cfs_time_sub(now, req->rq_sent));
372 /* Network latency is total time less server processing time */
373 nl = max_t(int, now - req->rq_sent -
374 service_time, 0) + 1; /* st rounding */
375 at = &req->rq_import->imp_at;
377 oldnl = at_measured(&at->iat_net_latency, nl);
379 CDEBUG(D_ADAPTTO, "The network latency for %s (nid %s) "
380 "has changed from %d to %d\n",
381 req->rq_import->imp_obd->obd_name,
383 &req->rq_import->imp_connection->c_remote_uuid),
384 oldnl, at_get(&at->iat_net_latency));
387 static int unpack_reply(struct ptlrpc_request *req)
391 if (SPTLRPC_FLVR_POLICY(req->rq_flvr.sf_rpc) != SPTLRPC_POLICY_NULL) {
392 rc = ptlrpc_unpack_rep_msg(req, req->rq_replen);
394 DEBUG_REQ(D_ERROR, req, "unpack_rep failed: %d", rc);
399 rc = lustre_unpack_rep_ptlrpc_body(req, MSG_PTLRPC_BODY_OFF);
401 DEBUG_REQ(D_ERROR, req, "unpack ptlrpc body failed: %d", rc);
408 * Handle an early reply message, called with the rq_lock held.
409 * If anything goes wrong just ignore it - same as if it never happened
411 static int ptlrpc_at_recv_early_reply(struct ptlrpc_request *req)
412 __must_hold(&req->rq_lock)
414 struct ptlrpc_request *early_req;
420 spin_unlock(&req->rq_lock);
422 rc = sptlrpc_cli_unwrap_early_reply(req, &early_req);
424 spin_lock(&req->rq_lock);
428 rc = unpack_reply(early_req);
430 sptlrpc_cli_finish_early_reply(early_req);
431 spin_lock(&req->rq_lock);
435 /* Use new timeout value just to adjust the local value for this
436 * request, don't include it into at_history. It is unclear yet why
437 * service time increased and should it be counted or skipped, e.g.
438 * that can be recovery case or some error or server, the real reply
439 * will add all new data if it is worth to add. */
440 req->rq_timeout = lustre_msg_get_timeout(early_req->rq_repmsg);
441 lustre_msg_set_timeout(req->rq_reqmsg, req->rq_timeout);
443 /* Network latency can be adjusted, it is pure network delays */
444 ptlrpc_at_adj_net_latency(req,
445 lustre_msg_get_service_time(early_req->rq_repmsg));
447 sptlrpc_cli_finish_early_reply(early_req);
449 spin_lock(&req->rq_lock);
450 olddl = req->rq_deadline;
451 /* server assumes it now has rq_timeout from when the request
452 * arrived, so the client should give it at least that long.
453 * since we don't know the arrival time we'll use the original
455 req->rq_deadline = req->rq_sent + req->rq_timeout +
456 ptlrpc_at_get_net_latency(req);
458 DEBUG_REQ(D_ADAPTTO, req,
459 "Early reply #%d, new deadline in "CFS_DURATION_T"s "
460 "("CFS_DURATION_T"s)", req->rq_early_count,
461 cfs_time_sub(req->rq_deadline, cfs_time_current_sec()),
462 cfs_time_sub(req->rq_deadline, olddl));
467 static struct kmem_cache *request_cache;
469 int ptlrpc_request_cache_init(void)
471 request_cache = kmem_cache_create("ptlrpc_cache",
472 sizeof(struct ptlrpc_request),
473 0, SLAB_HWCACHE_ALIGN, NULL);
474 return request_cache == NULL ? -ENOMEM : 0;
477 void ptlrpc_request_cache_fini(void)
479 kmem_cache_destroy(request_cache);
482 struct ptlrpc_request *ptlrpc_request_cache_alloc(gfp_t flags)
484 struct ptlrpc_request *req;
486 OBD_SLAB_ALLOC_PTR_GFP(req, request_cache, flags);
490 void ptlrpc_request_cache_free(struct ptlrpc_request *req)
492 OBD_SLAB_FREE_PTR(req, request_cache);
496 * Wind down request pool \a pool.
497 * Frees all requests from the pool too
499 void ptlrpc_free_rq_pool(struct ptlrpc_request_pool *pool)
501 struct list_head *l, *tmp;
502 struct ptlrpc_request *req;
504 LASSERT(pool != NULL);
506 spin_lock(&pool->prp_lock);
507 list_for_each_safe(l, tmp, &pool->prp_req_list) {
508 req = list_entry(l, struct ptlrpc_request, rq_list);
509 list_del(&req->rq_list);
510 LASSERT(req->rq_reqbuf);
511 LASSERT(req->rq_reqbuf_len == pool->prp_rq_size);
512 OBD_FREE_LARGE(req->rq_reqbuf, pool->prp_rq_size);
513 ptlrpc_request_cache_free(req);
515 spin_unlock(&pool->prp_lock);
516 OBD_FREE(pool, sizeof(*pool));
518 EXPORT_SYMBOL(ptlrpc_free_rq_pool);
521 * Allocates, initializes and adds \a num_rq requests to the pool \a pool
523 void ptlrpc_add_rqs_to_pool(struct ptlrpc_request_pool *pool, int num_rq)
528 while (size < pool->prp_rq_size)
531 LASSERTF(list_empty(&pool->prp_req_list) ||
532 size == pool->prp_rq_size,
533 "Trying to change pool size with nonempty pool "
534 "from %d to %d bytes\n", pool->prp_rq_size, size);
536 spin_lock(&pool->prp_lock);
537 pool->prp_rq_size = size;
538 for (i = 0; i < num_rq; i++) {
539 struct ptlrpc_request *req;
540 struct lustre_msg *msg;
542 spin_unlock(&pool->prp_lock);
543 req = ptlrpc_request_cache_alloc(GFP_NOFS);
546 OBD_ALLOC_LARGE(msg, size);
548 ptlrpc_request_cache_free(req);
551 req->rq_reqbuf = msg;
552 req->rq_reqbuf_len = size;
554 spin_lock(&pool->prp_lock);
555 list_add_tail(&req->rq_list, &pool->prp_req_list);
557 spin_unlock(&pool->prp_lock);
560 EXPORT_SYMBOL(ptlrpc_add_rqs_to_pool);
563 * Create and initialize new request pool with given attributes:
564 * \a num_rq - initial number of requests to create for the pool
565 * \a msgsize - maximum message size possible for requests in thid pool
566 * \a populate_pool - function to be called when more requests need to be added
568 * Returns pointer to newly created pool or NULL on error.
570 struct ptlrpc_request_pool *
571 ptlrpc_init_rq_pool(int num_rq, int msgsize,
572 void (*populate_pool)(struct ptlrpc_request_pool *, int))
574 struct ptlrpc_request_pool *pool;
576 OBD_ALLOC(pool, sizeof(struct ptlrpc_request_pool));
580 /* Request next power of two for the allocation, because internally
581 kernel would do exactly this */
583 spin_lock_init(&pool->prp_lock);
584 INIT_LIST_HEAD(&pool->prp_req_list);
585 pool->prp_rq_size = msgsize + SPTLRPC_MAX_PAYLOAD;
586 pool->prp_populate = populate_pool;
588 populate_pool(pool, num_rq);
590 if (list_empty(&pool->prp_req_list)) {
591 /* have not allocated a single request for the pool */
592 OBD_FREE(pool, sizeof(struct ptlrpc_request_pool));
597 EXPORT_SYMBOL(ptlrpc_init_rq_pool);
600 * Fetches one request from pool \a pool
602 static struct ptlrpc_request *
603 ptlrpc_prep_req_from_pool(struct ptlrpc_request_pool *pool)
605 struct ptlrpc_request *request;
606 struct lustre_msg *reqbuf;
611 spin_lock(&pool->prp_lock);
613 /* See if we have anything in a pool, and bail out if nothing,
614 * in writeout path, where this matters, this is safe to do, because
615 * nothing is lost in this case, and when some in-flight requests
616 * complete, this code will be called again. */
617 if (unlikely(list_empty(&pool->prp_req_list))) {
618 spin_unlock(&pool->prp_lock);
622 request = list_entry(pool->prp_req_list.next, struct ptlrpc_request,
624 list_del_init(&request->rq_list);
625 spin_unlock(&pool->prp_lock);
627 LASSERT(request->rq_reqbuf);
628 LASSERT(request->rq_pool);
630 reqbuf = request->rq_reqbuf;
631 memset(request, 0, sizeof(*request));
632 request->rq_reqbuf = reqbuf;
633 request->rq_reqbuf_len = pool->prp_rq_size;
634 request->rq_pool = pool;
640 * Returns freed \a request to pool.
642 static void __ptlrpc_free_req_to_pool(struct ptlrpc_request *request)
644 struct ptlrpc_request_pool *pool = request->rq_pool;
646 spin_lock(&pool->prp_lock);
647 LASSERT(list_empty(&request->rq_list));
648 LASSERT(!request->rq_receiving_reply);
649 list_add_tail(&request->rq_list, &pool->prp_req_list);
650 spin_unlock(&pool->prp_lock);
653 static int __ptlrpc_request_bufs_pack(struct ptlrpc_request *request,
654 __u32 version, int opcode,
655 int count, __u32 *lengths, char **bufs,
656 struct ptlrpc_cli_ctx *ctx)
658 struct obd_import *imp = request->rq_import;
663 request->rq_cli_ctx = sptlrpc_cli_ctx_get(ctx);
665 rc = sptlrpc_req_get_ctx(request);
670 sptlrpc_req_set_flavor(request, opcode);
672 rc = lustre_pack_request(request, imp->imp_msg_magic, count,
675 LASSERT(!request->rq_pool);
679 lustre_msg_add_version(request->rq_reqmsg, version);
680 request->rq_send_state = LUSTRE_IMP_FULL;
681 request->rq_type = PTL_RPC_MSG_REQUEST;
683 request->rq_req_cbid.cbid_fn = request_out_callback;
684 request->rq_req_cbid.cbid_arg = request;
686 request->rq_reply_cbid.cbid_fn = reply_in_callback;
687 request->rq_reply_cbid.cbid_arg = request;
689 request->rq_reply_deadline = 0;
690 request->rq_phase = RQ_PHASE_NEW;
691 request->rq_next_phase = RQ_PHASE_UNDEFINED;
693 request->rq_request_portal = imp->imp_client->cli_request_portal;
694 request->rq_reply_portal = imp->imp_client->cli_reply_portal;
696 ptlrpc_at_set_req_timeout(request);
698 request->rq_xid = ptlrpc_next_xid();
699 lustre_msg_set_opc(request->rq_reqmsg, opcode);
703 sptlrpc_cli_ctx_put(request->rq_cli_ctx, 1);
705 class_import_put(imp);
709 int ptlrpc_request_bufs_pack(struct ptlrpc_request *request,
710 __u32 version, int opcode, char **bufs,
711 struct ptlrpc_cli_ctx *ctx)
715 count = req_capsule_filled_sizes(&request->rq_pill, RCL_CLIENT);
716 return __ptlrpc_request_bufs_pack(request, version, opcode, count,
717 request->rq_pill.rc_area[RCL_CLIENT],
720 EXPORT_SYMBOL(ptlrpc_request_bufs_pack);
723 * Pack request buffers for network transfer, performing necessary encryption
724 * steps if necessary.
726 int ptlrpc_request_pack(struct ptlrpc_request *request,
727 __u32 version, int opcode)
730 rc = ptlrpc_request_bufs_pack(request, version, opcode, NULL, NULL);
734 /* For some old 1.8 clients (< 1.8.7), they will LASSERT the size of
735 * ptlrpc_body sent from server equal to local ptlrpc_body size, so we
736 * have to send old ptlrpc_body to keep interoprability with these
739 * Only three kinds of server->client RPCs so far:
744 * XXX This should be removed whenever we drop the interoprability with
745 * the these old clients.
747 if (opcode == LDLM_BL_CALLBACK || opcode == LDLM_CP_CALLBACK ||
748 opcode == LDLM_GL_CALLBACK)
749 req_capsule_shrink(&request->rq_pill, &RMF_PTLRPC_BODY,
750 sizeof(struct ptlrpc_body_v2), RCL_CLIENT);
754 EXPORT_SYMBOL(ptlrpc_request_pack);
757 * Helper function to allocate new request on import \a imp
758 * and possibly using existing request from pool \a pool if provided.
759 * Returns allocated request structure with import field filled or
763 struct ptlrpc_request *__ptlrpc_request_alloc(struct obd_import *imp,
764 struct ptlrpc_request_pool *pool)
766 struct ptlrpc_request *request = NULL;
769 request = ptlrpc_prep_req_from_pool(pool);
772 request = ptlrpc_request_cache_alloc(GFP_NOFS);
775 ptlrpc_cli_req_init(request);
777 LASSERTF((unsigned long)imp > 0x1000, "%p", imp);
778 LASSERT(imp != LP_POISON);
779 LASSERTF((unsigned long)imp->imp_client > 0x1000, "%p\n",
781 LASSERT(imp->imp_client != LP_POISON);
783 request->rq_import = class_import_get(imp);
785 CERROR("request allocation out of memory\n");
792 * Helper function for creating a request.
793 * Calls __ptlrpc_request_alloc to allocate new request sturcture and inits
794 * buffer structures according to capsule template \a format.
795 * Returns allocated request structure pointer or NULL on error.
797 static struct ptlrpc_request *
798 ptlrpc_request_alloc_internal(struct obd_import *imp,
799 struct ptlrpc_request_pool * pool,
800 const struct req_format *format)
802 struct ptlrpc_request *request;
804 request = __ptlrpc_request_alloc(imp, pool);
808 req_capsule_init(&request->rq_pill, request, RCL_CLIENT);
809 req_capsule_set(&request->rq_pill, format);
814 * Allocate new request structure for import \a imp and initialize its
815 * buffer structure according to capsule template \a format.
817 struct ptlrpc_request *ptlrpc_request_alloc(struct obd_import *imp,
818 const struct req_format *format)
820 return ptlrpc_request_alloc_internal(imp, NULL, format);
822 EXPORT_SYMBOL(ptlrpc_request_alloc);
825 * Allocate new request structure for import \a imp from pool \a pool and
826 * initialize its buffer structure according to capsule template \a format.
828 struct ptlrpc_request *ptlrpc_request_alloc_pool(struct obd_import *imp,
829 struct ptlrpc_request_pool * pool,
830 const struct req_format *format)
832 return ptlrpc_request_alloc_internal(imp, pool, format);
834 EXPORT_SYMBOL(ptlrpc_request_alloc_pool);
837 * For requests not from pool, free memory of the request structure.
838 * For requests obtained from a pool earlier, return request back to pool.
840 void ptlrpc_request_free(struct ptlrpc_request *request)
842 if (request->rq_pool)
843 __ptlrpc_free_req_to_pool(request);
845 ptlrpc_request_cache_free(request);
847 EXPORT_SYMBOL(ptlrpc_request_free);
850 * Allocate new request for operatione \a opcode and immediatelly pack it for
852 * Only used for simple requests like OBD_PING where the only important
853 * part of the request is operation itself.
854 * Returns allocated request or NULL on error.
856 struct ptlrpc_request *ptlrpc_request_alloc_pack(struct obd_import *imp,
857 const struct req_format *format,
858 __u32 version, int opcode)
860 struct ptlrpc_request *req = ptlrpc_request_alloc(imp, format);
864 rc = ptlrpc_request_pack(req, version, opcode);
866 ptlrpc_request_free(req);
872 EXPORT_SYMBOL(ptlrpc_request_alloc_pack);
875 * Prepare request (fetched from pool \a poolif not NULL) on import \a imp
876 * for operation \a opcode. Request would contain \a count buffers.
877 * Sizes of buffers are described in array \a lengths and buffers themselves
878 * are provided by a pointer \a bufs.
879 * Returns prepared request structure pointer or NULL on error.
881 struct ptlrpc_request *
882 ptlrpc_prep_req_pool(struct obd_import *imp,
883 __u32 version, int opcode,
884 int count, __u32 *lengths, char **bufs,
885 struct ptlrpc_request_pool *pool)
887 struct ptlrpc_request *request;
890 request = __ptlrpc_request_alloc(imp, pool);
894 rc = __ptlrpc_request_bufs_pack(request, version, opcode, count,
895 lengths, bufs, NULL);
897 ptlrpc_request_free(request);
904 * Same as ptlrpc_prep_req_pool, but without pool
906 struct ptlrpc_request *
907 ptlrpc_prep_req(struct obd_import *imp, __u32 version, int opcode, int count,
908 __u32 *lengths, char **bufs)
910 return ptlrpc_prep_req_pool(imp, version, opcode, count, lengths, bufs,
915 * Allocate and initialize new request set structure.
916 * Returns a pointer to the newly allocated set structure or NULL on error.
918 struct ptlrpc_request_set *ptlrpc_prep_set(void)
920 struct ptlrpc_request_set *set;
923 OBD_ALLOC(set, sizeof *set);
926 atomic_set(&set->set_refcount, 1);
927 INIT_LIST_HEAD(&set->set_requests);
928 init_waitqueue_head(&set->set_waitq);
929 atomic_set(&set->set_new_count, 0);
930 atomic_set(&set->set_remaining, 0);
931 spin_lock_init(&set->set_new_req_lock);
932 INIT_LIST_HEAD(&set->set_new_requests);
933 INIT_LIST_HEAD(&set->set_cblist);
934 set->set_max_inflight = UINT_MAX;
935 set->set_producer = NULL;
936 set->set_producer_arg = NULL;
941 EXPORT_SYMBOL(ptlrpc_prep_set);
944 * Allocate and initialize new request set structure with flow control
945 * extension. This extension allows to control the number of requests in-flight
946 * for the whole set. A callback function to generate requests must be provided
947 * and the request set will keep the number of requests sent over the wire to
949 * Returns a pointer to the newly allocated set structure or NULL on error.
951 struct ptlrpc_request_set *ptlrpc_prep_fcset(int max, set_producer_func func,
955 struct ptlrpc_request_set *set;
957 set = ptlrpc_prep_set();
961 set->set_max_inflight = max;
962 set->set_producer = func;
963 set->set_producer_arg = arg;
969 * Wind down and free request set structure previously allocated with
971 * Ensures that all requests on the set have completed and removes
972 * all requests from the request list in a set.
973 * If any unsent request happen to be on the list, pretends that they got
974 * an error in flight and calls their completion handler.
976 void ptlrpc_set_destroy(struct ptlrpc_request_set *set)
978 struct list_head *tmp;
979 struct list_head *next;
984 /* Requests on the set should either all be completed, or all be new */
985 expected_phase = (atomic_read(&set->set_remaining) == 0) ?
986 RQ_PHASE_COMPLETE : RQ_PHASE_NEW;
987 list_for_each(tmp, &set->set_requests) {
988 struct ptlrpc_request *req =
989 list_entry(tmp, struct ptlrpc_request,
992 LASSERT(req->rq_phase == expected_phase);
996 LASSERTF(atomic_read(&set->set_remaining) == 0 ||
997 atomic_read(&set->set_remaining) == n, "%d / %d\n",
998 atomic_read(&set->set_remaining), n);
1000 list_for_each_safe(tmp, next, &set->set_requests) {
1001 struct ptlrpc_request *req =
1002 list_entry(tmp, struct ptlrpc_request,
1004 list_del_init(&req->rq_set_chain);
1006 LASSERT(req->rq_phase == expected_phase);
1008 if (req->rq_phase == RQ_PHASE_NEW) {
1009 ptlrpc_req_interpret(NULL, req, -EBADR);
1010 atomic_dec(&set->set_remaining);
1013 spin_lock(&req->rq_lock);
1015 req->rq_invalid_rqset = 0;
1016 spin_unlock(&req->rq_lock);
1018 ptlrpc_req_finished (req);
1021 LASSERT(atomic_read(&set->set_remaining) == 0);
1023 ptlrpc_reqset_put(set);
1026 EXPORT_SYMBOL(ptlrpc_set_destroy);
1029 * Add a callback function \a fn to the set.
1030 * This function would be called when all requests on this set are completed.
1031 * The function will be passed \a data argument.
1033 int ptlrpc_set_add_cb(struct ptlrpc_request_set *set,
1034 set_interpreter_func fn, void *data)
1036 struct ptlrpc_set_cbdata *cbdata;
1038 OBD_ALLOC_PTR(cbdata);
1042 cbdata->psc_interpret = fn;
1043 cbdata->psc_data = data;
1044 list_add_tail(&cbdata->psc_item, &set->set_cblist);
1050 * Add a new request to the general purpose request set.
1051 * Assumes request reference from the caller.
1053 void ptlrpc_set_add_req(struct ptlrpc_request_set *set,
1054 struct ptlrpc_request *req)
1056 LASSERT(list_empty(&req->rq_set_chain));
1058 /* The set takes over the caller's request reference */
1059 list_add_tail(&req->rq_set_chain, &set->set_requests);
1061 atomic_inc(&set->set_remaining);
1062 req->rq_queued_time = cfs_time_current();
1064 if (req->rq_reqmsg != NULL)
1065 lustre_msg_set_jobid(req->rq_reqmsg, NULL);
1067 if (set->set_producer != NULL)
1068 /* If the request set has a producer callback, the RPC must be
1069 * sent straight away */
1070 ptlrpc_send_new_req(req);
1072 EXPORT_SYMBOL(ptlrpc_set_add_req);
1075 * Add a request to a request with dedicated server thread
1076 * and wake the thread to make any necessary processing.
1077 * Currently only used for ptlrpcd.
1079 void ptlrpc_set_add_new_req(struct ptlrpcd_ctl *pc,
1080 struct ptlrpc_request *req)
1082 struct ptlrpc_request_set *set = pc->pc_set;
1085 LASSERT(req->rq_set == NULL);
1086 LASSERT(test_bit(LIOD_STOP, &pc->pc_flags) == 0);
1088 spin_lock(&set->set_new_req_lock);
1090 * The set takes over the caller's request reference.
1093 req->rq_queued_time = cfs_time_current();
1094 list_add_tail(&req->rq_set_chain, &set->set_new_requests);
1095 count = atomic_inc_return(&set->set_new_count);
1096 spin_unlock(&set->set_new_req_lock);
1098 /* Only need to call wakeup once for the first entry. */
1100 wake_up(&set->set_waitq);
1102 /* XXX: It maybe unnecessary to wakeup all the partners. But to
1103 * guarantee the async RPC can be processed ASAP, we have
1104 * no other better choice. It maybe fixed in future. */
1105 for (i = 0; i < pc->pc_npartners; i++)
1106 wake_up(&pc->pc_partners[i]->pc_set->set_waitq);
1111 * Based on the current state of the import, determine if the request
1112 * can be sent, is an error, or should be delayed.
1114 * Returns true if this request should be delayed. If false, and
1115 * *status is set, then the request can not be sent and *status is the
1116 * error code. If false and status is 0, then request can be sent.
1118 * The imp->imp_lock must be held.
1120 static int ptlrpc_import_delay_req(struct obd_import *imp,
1121 struct ptlrpc_request *req, int *status)
1126 LASSERT (status != NULL);
1129 if (req->rq_ctx_init || req->rq_ctx_fini) {
1130 /* always allow ctx init/fini rpc go through */
1131 } else if (imp->imp_state == LUSTRE_IMP_NEW) {
1132 DEBUG_REQ(D_ERROR, req, "Uninitialized import.");
1134 } else if (imp->imp_state == LUSTRE_IMP_CLOSED) {
1135 /* pings may safely race with umount */
1136 DEBUG_REQ(lustre_msg_get_opc(req->rq_reqmsg) == OBD_PING ?
1137 D_HA : D_ERROR, req, "IMP_CLOSED ");
1139 } else if (ptlrpc_send_limit_expired(req)) {
1140 /* probably doesn't need to be a D_ERROR after initial testing*/
1141 DEBUG_REQ(D_HA, req, "send limit expired ");
1142 *status = -ETIMEDOUT;
1143 } else if (req->rq_send_state == LUSTRE_IMP_CONNECTING &&
1144 imp->imp_state == LUSTRE_IMP_CONNECTING) {
1145 /* allow CONNECT even if import is invalid */ ;
1146 if (atomic_read(&imp->imp_inval_count) != 0) {
1147 DEBUG_REQ(D_ERROR, req, "invalidate in flight");
1150 } else if (imp->imp_invalid || imp->imp_obd->obd_no_recov) {
1151 if (!imp->imp_deactive)
1152 DEBUG_REQ(D_NET, req, "IMP_INVALID");
1153 *status = -ESHUTDOWN; /* bz 12940 */
1154 } else if (req->rq_import_generation != imp->imp_generation) {
1155 DEBUG_REQ(D_ERROR, req, "req wrong generation:");
1157 } else if (req->rq_send_state != imp->imp_state) {
1158 /* invalidate in progress - any requests should be drop */
1159 if (atomic_read(&imp->imp_inval_count) != 0) {
1160 DEBUG_REQ(D_ERROR, req, "invalidate in flight");
1162 } else if (imp->imp_dlm_fake || req->rq_no_delay) {
1163 *status = -EWOULDBLOCK;
1164 } else if (req->rq_allow_replay &&
1165 (imp->imp_state == LUSTRE_IMP_REPLAY ||
1166 imp->imp_state == LUSTRE_IMP_REPLAY_LOCKS ||
1167 imp->imp_state == LUSTRE_IMP_REPLAY_WAIT ||
1168 imp->imp_state == LUSTRE_IMP_RECOVER)) {
1169 DEBUG_REQ(D_HA, req, "allow during recovery.\n");
1179 * Decide if the error message should be printed to the console or not.
1180 * Makes its decision based on request type, status, and failure frequency.
1182 * \param[in] req request that failed and may need a console message
1184 * \retval false if no message should be printed
1185 * \retval true if console message should be printed
1187 static bool ptlrpc_console_allow(struct ptlrpc_request *req)
1191 LASSERT(req->rq_reqmsg != NULL);
1192 opc = lustre_msg_get_opc(req->rq_reqmsg);
1194 /* Suppress particular reconnect errors which are to be expected. */
1195 if (opc == OST_CONNECT || opc == MDS_CONNECT || opc == MGS_CONNECT) {
1198 /* Suppress timed out reconnect requests */
1199 if (lustre_handle_is_used(&req->rq_import->imp_remote_handle) ||
1203 /* Suppress most unavailable/again reconnect requests, but
1204 * print occasionally so it is clear client is trying to
1205 * connect to a server where no target is running. */
1206 err = lustre_msg_get_status(req->rq_repmsg);
1207 if ((err == -ENODEV || err == -EAGAIN) &&
1208 req->rq_import->imp_conn_cnt % 30 != 20)
1216 * Check request processing status.
1217 * Returns the status.
1219 static int ptlrpc_check_status(struct ptlrpc_request *req)
1224 err = lustre_msg_get_status(req->rq_repmsg);
1225 if (lustre_msg_get_type(req->rq_repmsg) == PTL_RPC_MSG_ERR) {
1226 struct obd_import *imp = req->rq_import;
1227 lnet_nid_t nid = imp->imp_connection->c_peer.nid;
1228 __u32 opc = lustre_msg_get_opc(req->rq_reqmsg);
1230 if (ptlrpc_console_allow(req))
1231 LCONSOLE_ERROR_MSG(0x11, "%s: operation %s to node %s "
1232 "failed: rc = %d\n",
1233 imp->imp_obd->obd_name,
1235 libcfs_nid2str(nid), err);
1236 RETURN(err < 0 ? err : -EINVAL);
1240 DEBUG_REQ(D_INFO, req, "status is %d", err);
1241 } else if (err > 0) {
1242 /* XXX: translate this error from net to host */
1243 DEBUG_REQ(D_INFO, req, "status is %d", err);
1250 * save pre-versions of objects into request for replay.
1251 * Versions are obtained from server reply.
1254 static void ptlrpc_save_versions(struct ptlrpc_request *req)
1256 struct lustre_msg *repmsg = req->rq_repmsg;
1257 struct lustre_msg *reqmsg = req->rq_reqmsg;
1258 __u64 *versions = lustre_msg_get_versions(repmsg);
1261 if (lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY)
1265 lustre_msg_set_versions(reqmsg, versions);
1266 CDEBUG(D_INFO, "Client save versions ["LPX64"/"LPX64"]\n",
1267 versions[0], versions[1]);
1273 * Callback function called when client receives RPC reply for \a req.
1274 * Returns 0 on success or error code.
1275 * The return alue would be assigned to req->rq_status by the caller
1276 * as request processing status.
1277 * This function also decides if the request needs to be saved for later replay.
1279 static int after_reply(struct ptlrpc_request *req)
1281 struct obd_import *imp = req->rq_import;
1282 struct obd_device *obd = req->rq_import->imp_obd;
1284 struct timeval work_start;
1288 LASSERT(obd != NULL);
1289 /* repbuf must be unlinked */
1290 LASSERT(!req->rq_receiving_reply && req->rq_reply_unlinked);
1292 if (req->rq_reply_truncated) {
1293 if (ptlrpc_no_resend(req)) {
1294 DEBUG_REQ(D_ERROR, req, "reply buffer overflow,"
1295 " expected: %d, actual size: %d",
1296 req->rq_nob_received, req->rq_repbuf_len);
1300 sptlrpc_cli_free_repbuf(req);
1301 /* Pass the required reply buffer size (include
1302 * space for early reply).
1303 * NB: no need to roundup because alloc_repbuf
1304 * will roundup it */
1305 req->rq_replen = req->rq_nob_received;
1306 req->rq_nob_received = 0;
1307 spin_lock(&req->rq_lock);
1309 spin_unlock(&req->rq_lock);
1313 do_gettimeofday(&work_start);
1314 timediff = cfs_timeval_sub(&work_start, &req->rq_sent_tv, NULL);
1317 * NB Until this point, the whole of the incoming message,
1318 * including buflens, status etc is in the sender's byte order.
1320 rc = sptlrpc_cli_unwrap_reply(req);
1322 DEBUG_REQ(D_ERROR, req, "unwrap reply failed (%d):", rc);
1327 * Security layer unwrap might ask resend this request.
1332 rc = unpack_reply(req);
1336 /* retry indefinitely on EINPROGRESS */
1337 if (lustre_msg_get_status(req->rq_repmsg) == -EINPROGRESS &&
1338 ptlrpc_no_resend(req) == 0 && !req->rq_no_retry_einprogress) {
1339 time_t now = cfs_time_current_sec();
1341 DEBUG_REQ(D_RPCTRACE, req, "Resending request on EINPROGRESS");
1342 spin_lock(&req->rq_lock);
1344 spin_unlock(&req->rq_lock);
1345 req->rq_nr_resend++;
1347 /* allocate new xid to avoid reply reconstruction */
1348 if (!req->rq_bulk) {
1349 /* new xid is already allocated for bulk in
1350 * ptlrpc_check_set() */
1351 req->rq_xid = ptlrpc_next_xid();
1352 DEBUG_REQ(D_RPCTRACE, req, "Allocating new xid for "
1353 "resend on EINPROGRESS");
1356 /* Readjust the timeout for current conditions */
1357 ptlrpc_at_set_req_timeout(req);
1358 /* delay resend to give a chance to the server to get ready.
1359 * The delay is increased by 1s on every resend and is capped to
1360 * the current request timeout (i.e. obd_timeout if AT is off,
1361 * or AT service time x 125% + 5s, see at_est2timeout) */
1362 if (req->rq_nr_resend > req->rq_timeout)
1363 req->rq_sent = now + req->rq_timeout;
1365 req->rq_sent = now + req->rq_nr_resend;
1370 if (obd->obd_svc_stats != NULL) {
1371 lprocfs_counter_add(obd->obd_svc_stats, PTLRPC_REQWAIT_CNTR,
1373 ptlrpc_lprocfs_rpc_sent(req, timediff);
1376 if (lustre_msg_get_type(req->rq_repmsg) != PTL_RPC_MSG_REPLY &&
1377 lustre_msg_get_type(req->rq_repmsg) != PTL_RPC_MSG_ERR) {
1378 DEBUG_REQ(D_ERROR, req, "invalid packet received (type=%u)",
1379 lustre_msg_get_type(req->rq_repmsg));
1383 if (lustre_msg_get_opc(req->rq_reqmsg) != OBD_PING)
1384 CFS_FAIL_TIMEOUT(OBD_FAIL_PTLRPC_PAUSE_REP, cfs_fail_val);
1385 ptlrpc_at_adj_service(req, lustre_msg_get_timeout(req->rq_repmsg));
1386 ptlrpc_at_adj_net_latency(req,
1387 lustre_msg_get_service_time(req->rq_repmsg));
1389 rc = ptlrpc_check_status(req);
1390 imp->imp_connect_error = rc;
1394 * Either we've been evicted, or the server has failed for
1395 * some reason. Try to reconnect, and if that fails, punt to
1398 if (ptlrpc_recoverable_error(rc)) {
1399 if (req->rq_send_state != LUSTRE_IMP_FULL ||
1400 imp->imp_obd->obd_no_recov || imp->imp_dlm_fake) {
1403 ptlrpc_request_handle_notconn(req);
1408 * Let's look if server sent slv. Do it only for RPC with
1411 ldlm_cli_update_pool(req);
1415 * Store transno in reqmsg for replay.
1417 if (!(lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY)) {
1418 req->rq_transno = lustre_msg_get_transno(req->rq_repmsg);
1419 lustre_msg_set_transno(req->rq_reqmsg, req->rq_transno);
1422 if (imp->imp_replayable) {
1423 spin_lock(&imp->imp_lock);
1425 * No point in adding already-committed requests to the replay
1426 * list, we will just remove them immediately. b=9829
1428 if (req->rq_transno != 0 &&
1430 lustre_msg_get_last_committed(req->rq_repmsg) ||
1432 /** version recovery */
1433 ptlrpc_save_versions(req);
1434 ptlrpc_retain_replayable_request(req, imp);
1435 } else if (req->rq_commit_cb != NULL &&
1436 list_empty(&req->rq_replay_list)) {
1437 /* NB: don't call rq_commit_cb if it's already on
1438 * rq_replay_list, ptlrpc_free_committed() will call
1439 * it later, see LU-3618 for details */
1440 spin_unlock(&imp->imp_lock);
1441 req->rq_commit_cb(req);
1442 spin_lock(&imp->imp_lock);
1446 * Replay-enabled imports return commit-status information.
1448 if (lustre_msg_get_last_committed(req->rq_repmsg)) {
1449 imp->imp_peer_committed_transno =
1450 lustre_msg_get_last_committed(req->rq_repmsg);
1453 ptlrpc_free_committed(imp);
1455 if (!list_empty(&imp->imp_replay_list)) {
1456 struct ptlrpc_request *last;
1458 last = list_entry(imp->imp_replay_list.prev,
1459 struct ptlrpc_request,
1462 * Requests with rq_replay stay on the list even if no
1463 * commit is expected.
1465 if (last->rq_transno > imp->imp_peer_committed_transno)
1466 ptlrpc_pinger_commit_expected(imp);
1469 spin_unlock(&imp->imp_lock);
1476 * Helper function to send request \a req over the network for the first time
1477 * Also adjusts request phase.
1478 * Returns 0 on success or error code.
1480 static int ptlrpc_send_new_req(struct ptlrpc_request *req)
1482 struct obd_import *imp = req->rq_import;
1486 LASSERT(req->rq_phase == RQ_PHASE_NEW);
1487 if (req->rq_sent && (req->rq_sent > cfs_time_current_sec()) &&
1488 (!req->rq_generation_set ||
1489 req->rq_import_generation == imp->imp_generation))
1492 ptlrpc_rqphase_move(req, RQ_PHASE_RPC);
1494 spin_lock(&imp->imp_lock);
1496 if (!req->rq_generation_set)
1497 req->rq_import_generation = imp->imp_generation;
1499 if (ptlrpc_import_delay_req(imp, req, &rc)) {
1500 spin_lock(&req->rq_lock);
1501 req->rq_waiting = 1;
1502 spin_unlock(&req->rq_lock);
1504 DEBUG_REQ(D_HA, req, "req from PID %d waiting for recovery: "
1505 "(%s != %s)", lustre_msg_get_status(req->rq_reqmsg),
1506 ptlrpc_import_state_name(req->rq_send_state),
1507 ptlrpc_import_state_name(imp->imp_state));
1508 LASSERT(list_empty(&req->rq_list));
1509 list_add_tail(&req->rq_list, &imp->imp_delayed_list);
1510 atomic_inc(&req->rq_import->imp_inflight);
1511 spin_unlock(&imp->imp_lock);
1516 spin_unlock(&imp->imp_lock);
1517 req->rq_status = rc;
1518 ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
1522 LASSERT(list_empty(&req->rq_list));
1523 list_add_tail(&req->rq_list, &imp->imp_sending_list);
1524 atomic_inc(&req->rq_import->imp_inflight);
1525 spin_unlock(&imp->imp_lock);
1527 lustre_msg_set_status(req->rq_reqmsg, current_pid());
1529 rc = sptlrpc_req_refresh_ctx(req, -1);
1532 req->rq_status = rc;
1535 spin_lock(&req->rq_lock);
1536 req->rq_wait_ctx = 1;
1537 spin_unlock(&req->rq_lock);
1542 CDEBUG(D_RPCTRACE, "Sending RPC pname:cluuid:pid:xid:nid:opc"
1543 " %s:%s:%d:"LPU64":%s:%d\n", current_comm(),
1544 imp->imp_obd->obd_uuid.uuid,
1545 lustre_msg_get_status(req->rq_reqmsg), req->rq_xid,
1546 libcfs_nid2str(imp->imp_connection->c_peer.nid),
1547 lustre_msg_get_opc(req->rq_reqmsg));
1549 rc = ptl_send_rpc(req, 0);
1551 DEBUG_REQ(D_HA, req, "send failed (%d); expect timeout", rc);
1552 spin_lock(&req->rq_lock);
1553 req->rq_net_err = 1;
1554 spin_unlock(&req->rq_lock);
1560 static inline int ptlrpc_set_producer(struct ptlrpc_request_set *set)
1565 LASSERT(set->set_producer != NULL);
1567 remaining = atomic_read(&set->set_remaining);
1569 /* populate the ->set_requests list with requests until we
1570 * reach the maximum number of RPCs in flight for this set */
1571 while (atomic_read(&set->set_remaining) < set->set_max_inflight) {
1572 rc = set->set_producer(set, set->set_producer_arg);
1573 if (rc == -ENOENT) {
1574 /* no more RPC to produce */
1575 set->set_producer = NULL;
1576 set->set_producer_arg = NULL;
1581 RETURN((atomic_read(&set->set_remaining) - remaining));
1585 * this sends any unsent RPCs in \a set and returns 1 if all are sent
1586 * and no more replies are expected.
1587 * (it is possible to get less replies than requests sent e.g. due to timed out
1588 * requests or requests that we had trouble to send out)
1590 * NOTE: This function contains a potential schedule point (cond_resched()).
1592 int ptlrpc_check_set(const struct lu_env *env, struct ptlrpc_request_set *set)
1594 struct list_head *tmp, *next;
1595 struct list_head comp_reqs;
1596 int force_timer_recalc = 0;
1599 if (atomic_read(&set->set_remaining) == 0)
1602 INIT_LIST_HEAD(&comp_reqs);
1603 list_for_each_safe(tmp, next, &set->set_requests) {
1604 struct ptlrpc_request *req =
1605 list_entry(tmp, struct ptlrpc_request,
1607 struct obd_import *imp = req->rq_import;
1608 int unregistered = 0;
1611 /* This schedule point is mainly for the ptlrpcd caller of this
1612 * function. Most ptlrpc sets are not long-lived and unbounded
1613 * in length, but at the least the set used by the ptlrpcd is.
1614 * Since the processing time is unbounded, we need to insert an
1615 * explicit schedule point to make the thread well-behaved.
1619 if (req->rq_phase == RQ_PHASE_NEW &&
1620 ptlrpc_send_new_req(req)) {
1621 force_timer_recalc = 1;
1624 /* delayed send - skip */
1625 if (req->rq_phase == RQ_PHASE_NEW && req->rq_sent)
1628 /* delayed resend - skip */
1629 if (req->rq_phase == RQ_PHASE_RPC && req->rq_resend &&
1630 req->rq_sent > cfs_time_current_sec())
1633 if (!(req->rq_phase == RQ_PHASE_RPC ||
1634 req->rq_phase == RQ_PHASE_BULK ||
1635 req->rq_phase == RQ_PHASE_INTERPRET ||
1636 req->rq_phase == RQ_PHASE_UNREGISTERING ||
1637 req->rq_phase == RQ_PHASE_COMPLETE)) {
1638 DEBUG_REQ(D_ERROR, req, "bad phase %x", req->rq_phase);
1642 if (req->rq_phase == RQ_PHASE_UNREGISTERING) {
1643 LASSERT(req->rq_next_phase != req->rq_phase);
1644 LASSERT(req->rq_next_phase != RQ_PHASE_UNDEFINED);
1647 * Skip processing until reply is unlinked. We
1648 * can't return to pool before that and we can't
1649 * call interpret before that. We need to make
1650 * sure that all rdma transfers finished and will
1651 * not corrupt any data.
1653 if (ptlrpc_client_recv_or_unlink(req) ||
1654 ptlrpc_client_bulk_active(req))
1658 * Turn fail_loc off to prevent it from looping
1661 if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK)) {
1662 OBD_FAIL_CHECK_ORSET(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK,
1665 if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_BULK_UNLINK)) {
1666 OBD_FAIL_CHECK_ORSET(OBD_FAIL_PTLRPC_LONG_BULK_UNLINK,
1671 * Move to next phase if reply was successfully
1674 ptlrpc_rqphase_move(req, req->rq_next_phase);
1677 if (req->rq_phase == RQ_PHASE_COMPLETE) {
1678 list_move_tail(&req->rq_set_chain, &comp_reqs);
1682 if (req->rq_phase == RQ_PHASE_INTERPRET)
1683 GOTO(interpret, req->rq_status);
1686 * Note that this also will start async reply unlink.
1688 if (req->rq_net_err && !req->rq_timedout) {
1689 ptlrpc_expire_one_request(req, 1);
1692 * Check if we still need to wait for unlink.
1694 if (ptlrpc_client_recv_or_unlink(req) ||
1695 ptlrpc_client_bulk_active(req))
1697 /* If there is no need to resend, fail it now. */
1698 if (req->rq_no_resend) {
1699 if (req->rq_status == 0)
1700 req->rq_status = -EIO;
1701 ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
1702 GOTO(interpret, req->rq_status);
1709 spin_lock(&req->rq_lock);
1710 req->rq_replied = 0;
1711 spin_unlock(&req->rq_lock);
1712 if (req->rq_status == 0)
1713 req->rq_status = -EIO;
1714 ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
1715 GOTO(interpret, req->rq_status);
1718 /* ptlrpc_set_wait->l_wait_event sets lwi_allow_intr
1719 * so it sets rq_intr regardless of individual rpc
1720 * timeouts. The synchronous IO waiting path sets
1721 * rq_intr irrespective of whether ptlrpcd
1722 * has seen a timeout. Our policy is to only interpret
1723 * interrupted rpcs after they have timed out, so we
1724 * need to enforce that here.
1727 if (req->rq_intr && (req->rq_timedout || req->rq_waiting ||
1728 req->rq_wait_ctx)) {
1729 req->rq_status = -EINTR;
1730 ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
1731 GOTO(interpret, req->rq_status);
1734 if (req->rq_phase == RQ_PHASE_RPC) {
1735 if (req->rq_timedout || req->rq_resend ||
1736 req->rq_waiting || req->rq_wait_ctx) {
1739 if (!ptlrpc_unregister_reply(req, 1)) {
1740 ptlrpc_unregister_bulk(req, 1);
1744 spin_lock(&imp->imp_lock);
1745 if (ptlrpc_import_delay_req(imp, req, &status)){
1746 /* put on delay list - only if we wait
1747 * recovery finished - before send */
1748 list_del_init(&req->rq_list);
1749 list_add_tail(&req->rq_list,
1752 spin_unlock(&imp->imp_lock);
1757 req->rq_status = status;
1758 ptlrpc_rqphase_move(req,
1759 RQ_PHASE_INTERPRET);
1760 spin_unlock(&imp->imp_lock);
1761 GOTO(interpret, req->rq_status);
1763 if (ptlrpc_no_resend(req) &&
1764 !req->rq_wait_ctx) {
1765 req->rq_status = -ENOTCONN;
1766 ptlrpc_rqphase_move(req,
1767 RQ_PHASE_INTERPRET);
1768 spin_unlock(&imp->imp_lock);
1769 GOTO(interpret, req->rq_status);
1772 list_del_init(&req->rq_list);
1773 list_add_tail(&req->rq_list,
1774 &imp->imp_sending_list);
1776 spin_unlock(&imp->imp_lock);
1778 spin_lock(&req->rq_lock);
1779 req->rq_waiting = 0;
1780 spin_unlock(&req->rq_lock);
1782 if (req->rq_timedout || req->rq_resend) {
1783 /* This is re-sending anyways,
1784 * let's mark req as resend. */
1785 spin_lock(&req->rq_lock);
1787 spin_unlock(&req->rq_lock);
1791 if (!ptlrpc_unregister_bulk(req, 1))
1794 /* ensure previous bulk fails */
1795 old_xid = req->rq_xid;
1796 req->rq_xid = ptlrpc_next_xid();
1797 CDEBUG(D_HA, "resend bulk "
1800 old_xid, req->rq_xid);
1804 * rq_wait_ctx is only touched by ptlrpcd,
1805 * so no lock is needed here.
1807 status = sptlrpc_req_refresh_ctx(req, -1);
1810 req->rq_status = status;
1811 spin_lock(&req->rq_lock);
1812 req->rq_wait_ctx = 0;
1813 spin_unlock(&req->rq_lock);
1814 force_timer_recalc = 1;
1816 spin_lock(&req->rq_lock);
1817 req->rq_wait_ctx = 1;
1818 spin_unlock(&req->rq_lock);
1823 spin_lock(&req->rq_lock);
1824 req->rq_wait_ctx = 0;
1825 spin_unlock(&req->rq_lock);
1828 rc = ptl_send_rpc(req, 0);
1830 DEBUG_REQ(D_HA, req,
1831 "send failed: rc = %d", rc);
1832 force_timer_recalc = 1;
1833 spin_lock(&req->rq_lock);
1834 req->rq_net_err = 1;
1835 spin_unlock(&req->rq_lock);
1838 /* need to reset the timeout */
1839 force_timer_recalc = 1;
1842 spin_lock(&req->rq_lock);
1844 if (ptlrpc_client_early(req)) {
1845 ptlrpc_at_recv_early_reply(req);
1846 spin_unlock(&req->rq_lock);
1850 /* Still waiting for a reply? */
1851 if (ptlrpc_client_recv(req)) {
1852 spin_unlock(&req->rq_lock);
1856 /* Did we actually receive a reply? */
1857 if (!ptlrpc_client_replied(req)) {
1858 spin_unlock(&req->rq_lock);
1862 spin_unlock(&req->rq_lock);
1864 /* unlink from net because we are going to
1865 * swab in-place of reply buffer */
1866 unregistered = ptlrpc_unregister_reply(req, 1);
1870 req->rq_status = after_reply(req);
1874 /* If there is no bulk associated with this request,
1875 * then we're done and should let the interpreter
1876 * process the reply. Similarly if the RPC returned
1877 * an error, and therefore the bulk will never arrive.
1879 if (req->rq_bulk == NULL || req->rq_status < 0) {
1880 ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
1881 GOTO(interpret, req->rq_status);
1884 ptlrpc_rqphase_move(req, RQ_PHASE_BULK);
1887 LASSERT(req->rq_phase == RQ_PHASE_BULK);
1888 if (ptlrpc_client_bulk_active(req))
1891 if (req->rq_bulk->bd_failure) {
1892 /* The RPC reply arrived OK, but the bulk screwed
1893 * up! Dead weird since the server told us the RPC
1894 * was good after getting the REPLY for her GET or
1895 * the ACK for her PUT. */
1896 DEBUG_REQ(D_ERROR, req, "bulk transfer failed");
1897 req->rq_status = -EIO;
1900 ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
1903 LASSERT(req->rq_phase == RQ_PHASE_INTERPRET);
1905 /* This moves to "unregistering" phase we need to wait for
1907 if (!unregistered && !ptlrpc_unregister_reply(req, 1)) {
1908 /* start async bulk unlink too */
1909 ptlrpc_unregister_bulk(req, 1);
1913 if (!ptlrpc_unregister_bulk(req, 1))
1916 /* When calling interpret receiving already should be
1918 LASSERT(!req->rq_receiving_reply);
1920 ptlrpc_req_interpret(env, req, req->rq_status);
1922 if (ptlrpcd_check_work(req)) {
1923 atomic_dec(&set->set_remaining);
1926 ptlrpc_rqphase_move(req, RQ_PHASE_COMPLETE);
1928 CDEBUG(req->rq_reqmsg != NULL ? D_RPCTRACE : 0,
1929 "Completed RPC pname:cluuid:pid:xid:nid:"
1930 "opc %s:%s:%d:"LPU64":%s:%d\n",
1931 current_comm(), imp->imp_obd->obd_uuid.uuid,
1932 lustre_msg_get_status(req->rq_reqmsg), req->rq_xid,
1933 libcfs_nid2str(imp->imp_connection->c_peer.nid),
1934 lustre_msg_get_opc(req->rq_reqmsg));
1936 spin_lock(&imp->imp_lock);
1937 /* Request already may be not on sending or delaying list. This
1938 * may happen in the case of marking it erroneous for the case
1939 * ptlrpc_import_delay_req(req, status) find it impossible to
1940 * allow sending this rpc and returns *status != 0. */
1941 if (!list_empty(&req->rq_list)) {
1942 list_del_init(&req->rq_list);
1943 atomic_dec(&imp->imp_inflight);
1945 spin_unlock(&imp->imp_lock);
1947 atomic_dec(&set->set_remaining);
1948 wake_up_all(&imp->imp_recovery_waitq);
1950 if (set->set_producer) {
1951 /* produce a new request if possible */
1952 if (ptlrpc_set_producer(set) > 0)
1953 force_timer_recalc = 1;
1955 /* free the request that has just been completed
1956 * in order not to pollute set->set_requests */
1957 list_del_init(&req->rq_set_chain);
1958 spin_lock(&req->rq_lock);
1960 req->rq_invalid_rqset = 0;
1961 spin_unlock(&req->rq_lock);
1963 /* record rq_status to compute the final status later */
1964 if (req->rq_status != 0)
1965 set->set_rc = req->rq_status;
1966 ptlrpc_req_finished(req);
1968 list_move_tail(&req->rq_set_chain, &comp_reqs);
1972 /* move completed request at the head of list so it's easier for
1973 * caller to find them */
1974 list_splice(&comp_reqs, &set->set_requests);
1976 /* If we hit an error, we want to recover promptly. */
1977 RETURN(atomic_read(&set->set_remaining) == 0 || force_timer_recalc);
1979 EXPORT_SYMBOL(ptlrpc_check_set);
1982 * Time out request \a req. is \a async_unlink is set, that means do not wait
1983 * until LNet actually confirms network buffer unlinking.
1984 * Return 1 if we should give up further retrying attempts or 0 otherwise.
1986 int ptlrpc_expire_one_request(struct ptlrpc_request *req, int async_unlink)
1988 struct obd_import *imp = req->rq_import;
1992 spin_lock(&req->rq_lock);
1993 req->rq_timedout = 1;
1994 spin_unlock(&req->rq_lock);
1996 DEBUG_REQ(D_WARNING, req, "Request sent has %s: [sent "CFS_DURATION_T
1997 "/real "CFS_DURATION_T"]",
1998 req->rq_net_err ? "failed due to network error" :
1999 ((req->rq_real_sent == 0 ||
2000 cfs_time_before(req->rq_real_sent, req->rq_sent) ||
2001 cfs_time_aftereq(req->rq_real_sent, req->rq_deadline)) ?
2002 "timed out for sent delay" : "timed out for slow reply"),
2003 req->rq_sent, req->rq_real_sent);
2005 if (imp != NULL && obd_debug_peer_on_timeout)
2006 LNetCtl(IOC_LIBCFS_DEBUG_PEER, &imp->imp_connection->c_peer);
2008 ptlrpc_unregister_reply(req, async_unlink);
2009 ptlrpc_unregister_bulk(req, async_unlink);
2011 if (obd_dump_on_timeout)
2012 libcfs_debug_dumplog();
2015 DEBUG_REQ(D_HA, req, "NULL import: already cleaned up?");
2019 atomic_inc(&imp->imp_timeouts);
2021 /* The DLM server doesn't want recovery run on its imports. */
2022 if (imp->imp_dlm_fake)
2025 /* If this request is for recovery or other primordial tasks,
2026 * then error it out here. */
2027 if (req->rq_ctx_init || req->rq_ctx_fini ||
2028 req->rq_send_state != LUSTRE_IMP_FULL ||
2029 imp->imp_obd->obd_no_recov) {
2030 DEBUG_REQ(D_RPCTRACE, req, "err -110, sent_state=%s (now=%s)",
2031 ptlrpc_import_state_name(req->rq_send_state),
2032 ptlrpc_import_state_name(imp->imp_state));
2033 spin_lock(&req->rq_lock);
2034 req->rq_status = -ETIMEDOUT;
2036 spin_unlock(&req->rq_lock);
2040 /* if a request can't be resent we can't wait for an answer after
2042 if (ptlrpc_no_resend(req)) {
2043 DEBUG_REQ(D_RPCTRACE, req, "TIMEOUT-NORESEND:");
2047 ptlrpc_fail_import(imp, lustre_msg_get_conn_cnt(req->rq_reqmsg));
2053 * Time out all uncompleted requests in request set pointed by \a data
2054 * Callback used when waiting on sets with l_wait_event.
2057 int ptlrpc_expired_set(void *data)
2059 struct ptlrpc_request_set *set = data;
2060 struct list_head *tmp;
2061 time_t now = cfs_time_current_sec();
2064 LASSERT(set != NULL);
2067 * A timeout expired. See which reqs it applies to...
2069 list_for_each(tmp, &set->set_requests) {
2070 struct ptlrpc_request *req =
2071 list_entry(tmp, struct ptlrpc_request,
2074 /* don't expire request waiting for context */
2075 if (req->rq_wait_ctx)
2078 /* Request in-flight? */
2079 if (!((req->rq_phase == RQ_PHASE_RPC &&
2080 !req->rq_waiting && !req->rq_resend) ||
2081 (req->rq_phase == RQ_PHASE_BULK)))
2084 if (req->rq_timedout || /* already dealt with */
2085 req->rq_deadline > now) /* not expired */
2088 /* Deal with this guy. Do it asynchronously to not block
2089 * ptlrpcd thread. */
2090 ptlrpc_expire_one_request(req, 1);
2094 * When waiting for a whole set, we always break out of the
2095 * sleep so we can recalculate the timeout, or enable interrupts
2096 * if everyone's timed out.
2102 * Sets rq_intr flag in \a req under spinlock.
2104 void ptlrpc_mark_interrupted(struct ptlrpc_request *req)
2106 spin_lock(&req->rq_lock);
2108 spin_unlock(&req->rq_lock);
2110 EXPORT_SYMBOL(ptlrpc_mark_interrupted);
2113 * Interrupts (sets interrupted flag) all uncompleted requests in
2114 * a set \a data. Callback for l_wait_event for interruptible waits.
2116 static void ptlrpc_interrupted_set(void *data)
2118 struct ptlrpc_request_set *set = data;
2119 struct list_head *tmp;
2121 LASSERT(set != NULL);
2122 CDEBUG(D_RPCTRACE, "INTERRUPTED SET %p\n", set);
2124 list_for_each(tmp, &set->set_requests) {
2125 struct ptlrpc_request *req =
2126 list_entry(tmp, struct ptlrpc_request, rq_set_chain);
2128 if (req->rq_phase != RQ_PHASE_RPC &&
2129 req->rq_phase != RQ_PHASE_UNREGISTERING)
2132 ptlrpc_mark_interrupted(req);
2137 * Get the smallest timeout in the set; this does NOT set a timeout.
2139 int ptlrpc_set_next_timeout(struct ptlrpc_request_set *set)
2141 struct list_head *tmp;
2142 time_t now = cfs_time_current_sec();
2144 struct ptlrpc_request *req;
2148 list_for_each(tmp, &set->set_requests) {
2149 req = list_entry(tmp, struct ptlrpc_request, rq_set_chain);
2152 * Request in-flight?
2154 if (!(((req->rq_phase == RQ_PHASE_RPC) && !req->rq_waiting) ||
2155 (req->rq_phase == RQ_PHASE_BULK) ||
2156 (req->rq_phase == RQ_PHASE_NEW)))
2160 * Already timed out.
2162 if (req->rq_timedout)
2168 if (req->rq_wait_ctx)
2171 if (req->rq_phase == RQ_PHASE_NEW)
2172 deadline = req->rq_sent;
2173 else if (req->rq_phase == RQ_PHASE_RPC && req->rq_resend)
2174 deadline = req->rq_sent;
2176 deadline = req->rq_sent + req->rq_timeout;
2178 if (deadline <= now) /* actually expired already */
2179 timeout = 1; /* ASAP */
2180 else if (timeout == 0 || timeout > deadline - now)
2181 timeout = deadline - now;
2187 * Send all unset request from the set and then wait untill all
2188 * requests in the set complete (either get a reply, timeout, get an
2189 * error or otherwise be interrupted).
2190 * Returns 0 on success or error code otherwise.
2192 int ptlrpc_set_wait(struct ptlrpc_request_set *set)
2194 struct list_head *tmp;
2195 struct ptlrpc_request *req;
2196 struct l_wait_info lwi;
2200 if (set->set_producer)
2201 (void)ptlrpc_set_producer(set);
2203 list_for_each(tmp, &set->set_requests) {
2204 req = list_entry(tmp, struct ptlrpc_request,
2206 if (req->rq_phase == RQ_PHASE_NEW)
2207 (void)ptlrpc_send_new_req(req);
2210 if (list_empty(&set->set_requests))
2214 timeout = ptlrpc_set_next_timeout(set);
2216 /* wait until all complete, interrupted, or an in-flight
2218 CDEBUG(D_RPCTRACE, "set %p going to sleep for %d seconds\n",
2221 if (timeout == 0 && !signal_pending(current))
2223 * No requests are in-flight (ether timed out
2224 * or delayed), so we can allow interrupts.
2225 * We still want to block for a limited time,
2226 * so we allow interrupts during the timeout.
2228 lwi = LWI_TIMEOUT_INTR_ALL(cfs_time_seconds(1),
2230 ptlrpc_interrupted_set, set);
2233 * At least one request is in flight, so no
2234 * interrupts are allowed. Wait until all
2235 * complete, or an in-flight req times out.
2237 lwi = LWI_TIMEOUT(cfs_time_seconds(timeout? timeout : 1),
2238 ptlrpc_expired_set, set);
2240 rc = l_wait_event(set->set_waitq, ptlrpc_check_set(NULL, set), &lwi);
2242 /* LU-769 - if we ignored the signal because it was already
2243 * pending when we started, we need to handle it now or we risk
2244 * it being ignored forever */
2245 if (rc == -ETIMEDOUT && !lwi.lwi_allow_intr &&
2246 signal_pending(current)) {
2247 sigset_t blocked_sigs =
2248 cfs_block_sigsinv(LUSTRE_FATAL_SIGS);
2250 /* In fact we only interrupt for the "fatal" signals
2251 * like SIGINT or SIGKILL. We still ignore less
2252 * important signals since ptlrpc set is not easily
2253 * reentrant from userspace again */
2254 if (signal_pending(current))
2255 ptlrpc_interrupted_set(set);
2256 cfs_restore_sigs(blocked_sigs);
2259 LASSERT(rc == 0 || rc == -EINTR || rc == -ETIMEDOUT);
2261 /* -EINTR => all requests have been flagged rq_intr so next
2263 * -ETIMEDOUT => someone timed out. When all reqs have
2264 * timed out, signals are enabled allowing completion with
2266 * I don't really care if we go once more round the loop in
2267 * the error cases -eeb. */
2268 if (rc == 0 && atomic_read(&set->set_remaining) == 0) {
2269 list_for_each(tmp, &set->set_requests) {
2270 req = list_entry(tmp, struct ptlrpc_request,
2272 spin_lock(&req->rq_lock);
2273 req->rq_invalid_rqset = 1;
2274 spin_unlock(&req->rq_lock);
2277 } while (rc != 0 || atomic_read(&set->set_remaining) != 0);
2279 LASSERT(atomic_read(&set->set_remaining) == 0);
2281 rc = set->set_rc; /* rq_status of already freed requests if any */
2282 list_for_each(tmp, &set->set_requests) {
2283 req = list_entry(tmp, struct ptlrpc_request, rq_set_chain);
2285 LASSERT(req->rq_phase == RQ_PHASE_COMPLETE);
2286 if (req->rq_status != 0)
2287 rc = req->rq_status;
2290 if (set->set_interpret != NULL) {
2291 int (*interpreter)(struct ptlrpc_request_set *set,void *,int) =
2293 rc = interpreter (set, set->set_arg, rc);
2295 struct ptlrpc_set_cbdata *cbdata, *n;
2298 list_for_each_entry_safe(cbdata, n,
2299 &set->set_cblist, psc_item) {
2300 list_del_init(&cbdata->psc_item);
2301 err = cbdata->psc_interpret(set, cbdata->psc_data, rc);
2304 OBD_FREE_PTR(cbdata);
2310 EXPORT_SYMBOL(ptlrpc_set_wait);
2313 * Helper fuction for request freeing.
2314 * Called when request count reached zero and request needs to be freed.
2315 * Removes request from all sorts of sending/replay lists it might be on,
2316 * frees network buffers if any are present.
2317 * If \a locked is set, that means caller is already holding import imp_lock
2318 * and so we no longer need to reobtain it (for certain lists manipulations)
2320 static void __ptlrpc_free_req(struct ptlrpc_request *request, int locked)
2324 if (request == NULL)
2327 LASSERT(!request->rq_srv_req);
2328 LASSERT(request->rq_export == NULL);
2329 LASSERTF(!request->rq_receiving_reply, "req %p\n", request);
2330 LASSERTF(list_empty(&request->rq_list), "req %p\n", request);
2331 LASSERTF(list_empty(&request->rq_set_chain), "req %p\n", request);
2332 LASSERTF(!request->rq_replay, "req %p\n", request);
2334 req_capsule_fini(&request->rq_pill);
2336 /* We must take it off the imp_replay_list first. Otherwise, we'll set
2337 * request->rq_reqmsg to NULL while osc_close is dereferencing it. */
2338 if (request->rq_import != NULL) {
2340 spin_lock(&request->rq_import->imp_lock);
2341 list_del_init(&request->rq_replay_list);
2343 spin_unlock(&request->rq_import->imp_lock);
2345 LASSERTF(list_empty(&request->rq_replay_list), "req %p\n", request);
2347 if (atomic_read(&request->rq_refcount) != 0) {
2348 DEBUG_REQ(D_ERROR, request,
2349 "freeing request with nonzero refcount");
2353 if (request->rq_repbuf != NULL)
2354 sptlrpc_cli_free_repbuf(request);
2356 if (request->rq_import != NULL) {
2357 class_import_put(request->rq_import);
2358 request->rq_import = NULL;
2360 if (request->rq_bulk != NULL)
2361 ptlrpc_free_bulk(request->rq_bulk);
2363 if (request->rq_reqbuf != NULL || request->rq_clrbuf != NULL)
2364 sptlrpc_cli_free_reqbuf(request);
2366 if (request->rq_cli_ctx)
2367 sptlrpc_req_put_ctx(request, !locked);
2369 if (request->rq_pool)
2370 __ptlrpc_free_req_to_pool(request);
2372 ptlrpc_request_cache_free(request);
2376 static int __ptlrpc_req_finished(struct ptlrpc_request *request, int locked);
2378 * Drop one request reference. Must be called with import imp_lock held.
2379 * When reference count drops to zero, request is freed.
2381 void ptlrpc_req_finished_with_imp_lock(struct ptlrpc_request *request)
2383 assert_spin_locked(&request->rq_import->imp_lock);
2384 (void)__ptlrpc_req_finished(request, 1);
2389 * Drops one reference count for request \a request.
2390 * \a locked set indicates that caller holds import imp_lock.
2391 * Frees the request whe reference count reaches zero.
2393 static int __ptlrpc_req_finished(struct ptlrpc_request *request, int locked)
2396 if (request == NULL)
2399 if (request == LP_POISON ||
2400 request->rq_reqmsg == LP_POISON) {
2401 CERROR("dereferencing freed request (bug 575)\n");
2406 DEBUG_REQ(D_INFO, request, "refcount now %u",
2407 atomic_read(&request->rq_refcount) - 1);
2409 if (atomic_dec_and_test(&request->rq_refcount)) {
2410 __ptlrpc_free_req(request, locked);
2418 * Drops one reference count for a request.
2420 void ptlrpc_req_finished(struct ptlrpc_request *request)
2422 __ptlrpc_req_finished(request, 0);
2424 EXPORT_SYMBOL(ptlrpc_req_finished);
2427 * Returns xid of a \a request
2429 __u64 ptlrpc_req_xid(struct ptlrpc_request *request)
2431 return request->rq_xid;
2433 EXPORT_SYMBOL(ptlrpc_req_xid);
2436 * Disengage the client's reply buffer from the network
2437 * NB does _NOT_ unregister any client-side bulk.
2438 * IDEMPOTENT, but _not_ safe against concurrent callers.
2439 * The request owner (i.e. the thread doing the I/O) must call...
2440 * Returns 0 on success or 1 if unregistering cannot be made.
2442 static int ptlrpc_unregister_reply(struct ptlrpc_request *request, int async)
2445 struct l_wait_info lwi;
2450 LASSERT(!in_interrupt());
2453 * Let's setup deadline for reply unlink.
2455 if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK) &&
2456 async && request->rq_reply_deadline == 0)
2457 request->rq_reply_deadline = cfs_time_current_sec()+LONG_UNLINK;
2460 * Nothing left to do.
2462 if (!ptlrpc_client_recv_or_unlink(request))
2465 LNetMDUnlink(request->rq_reply_md_h);
2468 * Let's check it once again.
2470 if (!ptlrpc_client_recv_or_unlink(request))
2474 * Move to "Unregistering" phase as reply was not unlinked yet.
2476 ptlrpc_rqphase_move(request, RQ_PHASE_UNREGISTERING);
2479 * Do not wait for unlink to finish.
2485 * We have to l_wait_event() whatever the result, to give liblustre
2486 * a chance to run reply_in_callback(), and to make sure we've
2487 * unlinked before returning a req to the pool.
2490 /* The wq argument is ignored by user-space wait_event macros */
2491 wait_queue_head_t *wq = (request->rq_set != NULL) ?
2492 &request->rq_set->set_waitq :
2493 &request->rq_reply_waitq;
2494 /* Network access will complete in finite time but the HUGE
2495 * timeout lets us CWARN for visibility of sluggish NALs */
2496 lwi = LWI_TIMEOUT_INTERVAL(cfs_time_seconds(LONG_UNLINK),
2497 cfs_time_seconds(1), NULL, NULL);
2498 rc = l_wait_event(*wq, !ptlrpc_client_recv_or_unlink(request),
2501 ptlrpc_rqphase_move(request, request->rq_next_phase);
2505 LASSERT(rc == -ETIMEDOUT);
2506 DEBUG_REQ(D_WARNING, request, "Unexpectedly long timeout "
2507 "receiving_reply=%d req_ulinked=%d reply_unlinked=%d",
2508 request->rq_receiving_reply,
2509 request->rq_req_unlinked,
2510 request->rq_reply_unlinked);
2515 static void ptlrpc_free_request(struct ptlrpc_request *req)
2517 spin_lock(&req->rq_lock);
2519 spin_unlock(&req->rq_lock);
2521 if (req->rq_commit_cb != NULL)
2522 req->rq_commit_cb(req);
2523 list_del_init(&req->rq_replay_list);
2525 __ptlrpc_req_finished(req, 1);
2529 * the request is committed and dropped from the replay list of its import
2531 void ptlrpc_request_committed(struct ptlrpc_request *req, int force)
2533 struct obd_import *imp = req->rq_import;
2535 spin_lock(&imp->imp_lock);
2536 if (list_empty(&req->rq_replay_list)) {
2537 spin_unlock(&imp->imp_lock);
2541 if (force || req->rq_transno <= imp->imp_peer_committed_transno)
2542 ptlrpc_free_request(req);
2544 spin_unlock(&imp->imp_lock);
2546 EXPORT_SYMBOL(ptlrpc_request_committed);
2549 * Iterates through replay_list on import and prunes
2550 * all requests have transno smaller than last_committed for the
2551 * import and don't have rq_replay set.
2552 * Since requests are sorted in transno order, stops when meetign first
2553 * transno bigger than last_committed.
2554 * caller must hold imp->imp_lock
2556 void ptlrpc_free_committed(struct obd_import *imp)
2558 struct ptlrpc_request *req, *saved;
2559 struct ptlrpc_request *last_req = NULL; /* temporary fire escape */
2560 bool skip_committed_list = true;
2563 LASSERT(imp != NULL);
2564 assert_spin_locked(&imp->imp_lock);
2566 if (imp->imp_peer_committed_transno == imp->imp_last_transno_checked &&
2567 imp->imp_generation == imp->imp_last_generation_checked) {
2568 CDEBUG(D_INFO, "%s: skip recheck: last_committed "LPU64"\n",
2569 imp->imp_obd->obd_name, imp->imp_peer_committed_transno);
2572 CDEBUG(D_RPCTRACE, "%s: committing for last_committed "LPU64" gen %d\n",
2573 imp->imp_obd->obd_name, imp->imp_peer_committed_transno,
2574 imp->imp_generation);
2576 if (imp->imp_generation != imp->imp_last_generation_checked ||
2577 imp->imp_last_transno_checked == 0)
2578 skip_committed_list = false;
2580 imp->imp_last_transno_checked = imp->imp_peer_committed_transno;
2581 imp->imp_last_generation_checked = imp->imp_generation;
2583 list_for_each_entry_safe(req, saved, &imp->imp_replay_list,
2585 /* XXX ok to remove when 1357 resolved - rread 05/29/03 */
2586 LASSERT(req != last_req);
2589 if (req->rq_transno == 0) {
2590 DEBUG_REQ(D_EMERG, req, "zero transno during replay");
2593 if (req->rq_import_generation < imp->imp_generation) {
2594 DEBUG_REQ(D_RPCTRACE, req, "free request with old gen");
2598 /* not yet committed */
2599 if (req->rq_transno > imp->imp_peer_committed_transno) {
2600 DEBUG_REQ(D_RPCTRACE, req, "stopping search");
2604 if (req->rq_replay) {
2605 DEBUG_REQ(D_RPCTRACE, req, "keeping (FL_REPLAY)");
2606 list_move_tail(&req->rq_replay_list,
2607 &imp->imp_committed_list);
2611 DEBUG_REQ(D_INFO, req, "commit (last_committed "LPU64")",
2612 imp->imp_peer_committed_transno);
2614 ptlrpc_free_request(req);
2617 if (skip_committed_list)
2620 list_for_each_entry_safe(req, saved, &imp->imp_committed_list,
2622 LASSERT(req->rq_transno != 0);
2623 if (req->rq_import_generation < imp->imp_generation) {
2624 DEBUG_REQ(D_RPCTRACE, req, "free stale open request");
2625 ptlrpc_free_request(req);
2626 } else if (!req->rq_replay) {
2627 DEBUG_REQ(D_RPCTRACE, req, "free closed open request");
2628 ptlrpc_free_request(req);
2635 void ptlrpc_cleanup_client(struct obd_import *imp)
2642 * Schedule previously sent request for resend.
2643 * For bulk requests we assign new xid (to avoid problems with
2644 * lost replies and therefore several transfers landing into same buffer
2645 * from different sending attempts).
2647 void ptlrpc_resend_req(struct ptlrpc_request *req)
2649 DEBUG_REQ(D_HA, req, "going to resend");
2650 spin_lock(&req->rq_lock);
2652 /* Request got reply but linked to the import list still.
2653 Let ptlrpc_check_set() to process it. */
2654 if (ptlrpc_client_replied(req)) {
2655 spin_unlock(&req->rq_lock);
2656 DEBUG_REQ(D_HA, req, "it has reply, so skip it");
2660 lustre_msg_set_handle(req->rq_reqmsg, &(struct lustre_handle){ 0 });
2661 req->rq_status = -EAGAIN;
2664 req->rq_net_err = 0;
2665 req->rq_timedout = 0;
2667 __u64 old_xid = req->rq_xid;
2669 /* ensure previous bulk fails */
2670 req->rq_xid = ptlrpc_next_xid();
2671 CDEBUG(D_HA, "resend bulk old x"LPU64" new x"LPU64"\n",
2672 old_xid, req->rq_xid);
2674 ptlrpc_client_wake_req(req);
2675 spin_unlock(&req->rq_lock);
2678 /* XXX: this function and rq_status are currently unused */
2679 void ptlrpc_restart_req(struct ptlrpc_request *req)
2681 DEBUG_REQ(D_HA, req, "restarting (possibly-)completed request");
2682 req->rq_status = -ERESTARTSYS;
2684 spin_lock(&req->rq_lock);
2685 req->rq_restart = 1;
2686 req->rq_timedout = 0;
2687 ptlrpc_client_wake_req(req);
2688 spin_unlock(&req->rq_lock);
2692 * Grab additional reference on a request \a req
2694 struct ptlrpc_request *ptlrpc_request_addref(struct ptlrpc_request *req)
2697 atomic_inc(&req->rq_refcount);
2700 EXPORT_SYMBOL(ptlrpc_request_addref);
2703 * Add a request to import replay_list.
2704 * Must be called under imp_lock
2706 void ptlrpc_retain_replayable_request(struct ptlrpc_request *req,
2707 struct obd_import *imp)
2709 struct list_head *tmp;
2711 assert_spin_locked(&imp->imp_lock);
2713 if (req->rq_transno == 0) {
2714 DEBUG_REQ(D_EMERG, req, "saving request with zero transno");
2718 /* clear this for new requests that were resent as well
2719 as resent replayed requests. */
2720 lustre_msg_clear_flags(req->rq_reqmsg, MSG_RESENT);
2722 /* don't re-add requests that have been replayed */
2723 if (!list_empty(&req->rq_replay_list))
2726 lustre_msg_add_flags(req->rq_reqmsg, MSG_REPLAY);
2728 LASSERT(imp->imp_replayable);
2729 /* Balanced in ptlrpc_free_committed, usually. */
2730 ptlrpc_request_addref(req);
2731 list_for_each_prev(tmp, &imp->imp_replay_list) {
2732 struct ptlrpc_request *iter = list_entry(tmp,
2733 struct ptlrpc_request,
2736 /* We may have duplicate transnos if we create and then
2737 * open a file, or for closes retained if to match creating
2738 * opens, so use req->rq_xid as a secondary key.
2739 * (See bugs 684, 685, and 428.)
2740 * XXX no longer needed, but all opens need transnos!
2742 if (iter->rq_transno > req->rq_transno)
2745 if (iter->rq_transno == req->rq_transno) {
2746 LASSERT(iter->rq_xid != req->rq_xid);
2747 if (iter->rq_xid > req->rq_xid)
2751 list_add(&req->rq_replay_list, &iter->rq_replay_list);
2755 list_add(&req->rq_replay_list, &imp->imp_replay_list);
2759 * Send request and wait until it completes.
2760 * Returns request processing status.
2762 int ptlrpc_queue_wait(struct ptlrpc_request *req)
2764 struct ptlrpc_request_set *set;
2768 LASSERT(req->rq_set == NULL);
2769 LASSERT(!req->rq_receiving_reply);
2771 set = ptlrpc_prep_set();
2773 CERROR("cannot allocate ptlrpc set: rc = %d\n", -ENOMEM);
2777 /* for distributed debugging */
2778 lustre_msg_set_status(req->rq_reqmsg, current_pid());
2780 /* add a ref for the set (see comment in ptlrpc_set_add_req) */
2781 ptlrpc_request_addref(req);
2782 ptlrpc_set_add_req(set, req);
2783 rc = ptlrpc_set_wait(set);
2784 ptlrpc_set_destroy(set);
2788 EXPORT_SYMBOL(ptlrpc_queue_wait);
2791 * Callback used for replayed requests reply processing.
2792 * In case of successful reply calls registered request replay callback.
2793 * In case of error restart replay process.
2795 static int ptlrpc_replay_interpret(const struct lu_env *env,
2796 struct ptlrpc_request *req,
2797 void * data, int rc)
2799 struct ptlrpc_replay_async_args *aa = data;
2800 struct obd_import *imp = req->rq_import;
2803 atomic_dec(&imp->imp_replay_inflight);
2805 if (!ptlrpc_client_replied(req)) {
2806 CERROR("request replay timed out, restarting recovery\n");
2807 GOTO(out, rc = -ETIMEDOUT);
2810 if (lustre_msg_get_type(req->rq_repmsg) == PTL_RPC_MSG_ERR &&
2811 (lustre_msg_get_status(req->rq_repmsg) == -ENOTCONN ||
2812 lustre_msg_get_status(req->rq_repmsg) == -ENODEV))
2813 GOTO(out, rc = lustre_msg_get_status(req->rq_repmsg));
2815 /** VBR: check version failure */
2816 if (lustre_msg_get_status(req->rq_repmsg) == -EOVERFLOW) {
2817 /** replay was failed due to version mismatch */
2818 DEBUG_REQ(D_WARNING, req, "Version mismatch during replay\n");
2819 spin_lock(&imp->imp_lock);
2820 imp->imp_vbr_failed = 1;
2821 imp->imp_no_lock_replay = 1;
2822 spin_unlock(&imp->imp_lock);
2823 lustre_msg_set_status(req->rq_repmsg, aa->praa_old_status);
2825 /** The transno had better not change over replay. */
2826 LASSERTF(lustre_msg_get_transno(req->rq_reqmsg) ==
2827 lustre_msg_get_transno(req->rq_repmsg) ||
2828 lustre_msg_get_transno(req->rq_repmsg) == 0,
2830 lustre_msg_get_transno(req->rq_reqmsg),
2831 lustre_msg_get_transno(req->rq_repmsg));
2834 spin_lock(&imp->imp_lock);
2835 /** if replays by version then gap occur on server, no trust to locks */
2836 if (lustre_msg_get_flags(req->rq_repmsg) & MSG_VERSION_REPLAY)
2837 imp->imp_no_lock_replay = 1;
2838 imp->imp_last_replay_transno = lustre_msg_get_transno(req->rq_reqmsg);
2839 spin_unlock(&imp->imp_lock);
2840 LASSERT(imp->imp_last_replay_transno);
2842 /* transaction number shouldn't be bigger than the latest replayed */
2843 if (req->rq_transno > lustre_msg_get_transno(req->rq_reqmsg)) {
2844 DEBUG_REQ(D_ERROR, req,
2845 "Reported transno "LPU64" is bigger than the "
2846 "replayed one: "LPU64, req->rq_transno,
2847 lustre_msg_get_transno(req->rq_reqmsg));
2848 GOTO(out, rc = -EINVAL);
2851 DEBUG_REQ(D_HA, req, "got rep");
2853 /* let the callback do fixups, possibly including in the request */
2854 if (req->rq_replay_cb)
2855 req->rq_replay_cb(req);
2857 if (ptlrpc_client_replied(req) &&
2858 lustre_msg_get_status(req->rq_repmsg) != aa->praa_old_status) {
2859 DEBUG_REQ(D_ERROR, req, "status %d, old was %d",
2860 lustre_msg_get_status(req->rq_repmsg),
2861 aa->praa_old_status);
2863 /* Put it back for re-replay. */
2864 lustre_msg_set_status(req->rq_repmsg, aa->praa_old_status);
2868 * Errors while replay can set transno to 0, but
2869 * imp_last_replay_transno shouldn't be set to 0 anyway
2871 if (req->rq_transno == 0)
2872 CERROR("Transno is 0 during replay!\n");
2874 /* continue with recovery */
2875 rc = ptlrpc_import_recovery_state_machine(imp);
2877 req->rq_send_state = aa->praa_old_state;
2880 /* this replay failed, so restart recovery */
2881 ptlrpc_connect_import(imp);
2887 * Prepares and queues request for replay.
2888 * Adds it to ptlrpcd queue for actual sending.
2889 * Returns 0 on success.
2891 int ptlrpc_replay_req(struct ptlrpc_request *req)
2893 struct ptlrpc_replay_async_args *aa;
2896 LASSERT(req->rq_import->imp_state == LUSTRE_IMP_REPLAY);
2898 LASSERT (sizeof (*aa) <= sizeof (req->rq_async_args));
2899 aa = ptlrpc_req_async_args(req);
2900 memset(aa, 0, sizeof *aa);
2902 /* Prepare request to be resent with ptlrpcd */
2903 aa->praa_old_state = req->rq_send_state;
2904 req->rq_send_state = LUSTRE_IMP_REPLAY;
2905 req->rq_phase = RQ_PHASE_NEW;
2906 req->rq_next_phase = RQ_PHASE_UNDEFINED;
2908 aa->praa_old_status = lustre_msg_get_status(req->rq_repmsg);
2910 req->rq_interpret_reply = ptlrpc_replay_interpret;
2911 /* Readjust the timeout for current conditions */
2912 ptlrpc_at_set_req_timeout(req);
2914 /* Tell server the net_latency, so the server can calculate how long
2915 * it should wait for next replay */
2916 lustre_msg_set_service_time(req->rq_reqmsg,
2917 ptlrpc_at_get_net_latency(req));
2918 DEBUG_REQ(D_HA, req, "REPLAY");
2920 atomic_inc(&req->rq_import->imp_replay_inflight);
2921 ptlrpc_request_addref(req); /* ptlrpcd needs a ref */
2923 ptlrpcd_add_req(req, PDL_POLICY_LOCAL, -1);
2928 * Aborts all in-flight request on import \a imp sending and delayed lists
2930 void ptlrpc_abort_inflight(struct obd_import *imp)
2932 struct list_head *tmp, *n;
2935 /* Make sure that no new requests get processed for this import.
2936 * ptlrpc_{queue,set}_wait must (and does) hold imp_lock while testing
2937 * this flag and then putting requests on sending_list or delayed_list.
2939 spin_lock(&imp->imp_lock);
2941 /* XXX locking? Maybe we should remove each request with the list
2942 * locked? Also, how do we know if the requests on the list are
2943 * being freed at this time?
2945 list_for_each_safe(tmp, n, &imp->imp_sending_list) {
2946 struct ptlrpc_request *req = list_entry(tmp,
2947 struct ptlrpc_request,
2950 DEBUG_REQ(D_RPCTRACE, req, "inflight");
2952 spin_lock(&req->rq_lock);
2953 if (req->rq_import_generation < imp->imp_generation) {
2955 req->rq_status = -EIO;
2956 ptlrpc_client_wake_req(req);
2958 spin_unlock(&req->rq_lock);
2961 list_for_each_safe(tmp, n, &imp->imp_delayed_list) {
2962 struct ptlrpc_request *req =
2963 list_entry(tmp, struct ptlrpc_request, rq_list);
2965 DEBUG_REQ(D_RPCTRACE, req, "aborting waiting req");
2967 spin_lock(&req->rq_lock);
2968 if (req->rq_import_generation < imp->imp_generation) {
2970 req->rq_status = -EIO;
2971 ptlrpc_client_wake_req(req);
2973 spin_unlock(&req->rq_lock);
2976 /* Last chance to free reqs left on the replay list, but we
2977 * will still leak reqs that haven't committed. */
2978 if (imp->imp_replayable)
2979 ptlrpc_free_committed(imp);
2981 spin_unlock(&imp->imp_lock);
2987 * Abort all uncompleted requests in request set \a set
2989 void ptlrpc_abort_set(struct ptlrpc_request_set *set)
2991 struct list_head *tmp, *pos;
2993 LASSERT(set != NULL);
2995 list_for_each_safe(pos, tmp, &set->set_requests) {
2996 struct ptlrpc_request *req =
2997 list_entry(pos, struct ptlrpc_request,
3000 spin_lock(&req->rq_lock);
3001 if (req->rq_phase != RQ_PHASE_RPC) {
3002 spin_unlock(&req->rq_lock);
3007 req->rq_status = -EINTR;
3008 ptlrpc_client_wake_req(req);
3009 spin_unlock(&req->rq_lock);
3013 static __u64 ptlrpc_last_xid;
3014 static spinlock_t ptlrpc_last_xid_lock;
3017 * Initialize the XID for the node. This is common among all requests on
3018 * this node, and only requires the property that it is monotonically
3019 * increasing. It does not need to be sequential. Since this is also used
3020 * as the RDMA match bits, it is important that a single client NOT have
3021 * the same match bits for two different in-flight requests, hence we do
3022 * NOT want to have an XID per target or similar.
3024 * To avoid an unlikely collision between match bits after a client reboot
3025 * (which would deliver old data into the wrong RDMA buffer) initialize
3026 * the XID based on the current time, assuming a maximum RPC rate of 1M RPC/s.
3027 * If the time is clearly incorrect, we instead use a 62-bit random number.
3028 * In the worst case the random number will overflow 1M RPCs per second in
3029 * 9133 years, or permutations thereof.
3031 #define YEAR_2004 (1ULL << 30)
3032 void ptlrpc_init_xid(void)
3034 time_t now = cfs_time_current_sec();
3036 spin_lock_init(&ptlrpc_last_xid_lock);
3037 if (now < YEAR_2004) {
3038 cfs_get_random_bytes(&ptlrpc_last_xid, sizeof(ptlrpc_last_xid));
3039 ptlrpc_last_xid >>= 2;
3040 ptlrpc_last_xid |= (1ULL << 61);
3042 ptlrpc_last_xid = (__u64)now << 20;
3045 /* Need to always be aligned to a power-of-two for mutli-bulk BRW */
3046 CLASSERT((PTLRPC_BULK_OPS_COUNT & (PTLRPC_BULK_OPS_COUNT - 1)) == 0);
3047 ptlrpc_last_xid &= PTLRPC_BULK_OPS_MASK;
3051 * Increase xid and returns resulting new value to the caller.
3053 * Multi-bulk BRW RPCs consume multiple XIDs for each bulk transfer, starting
3054 * at the returned xid, up to xid + PTLRPC_BULK_OPS_COUNT - 1. The BRW RPC
3055 * itself uses the last bulk xid needed, so the server can determine the
3056 * the number of bulk transfers from the RPC XID and a bitmask. The starting
3057 * xid must align to a power-of-two value.
3059 * This is assumed to be true due to the initial ptlrpc_last_xid
3060 * value also being initialized to a power-of-two value. LU-1431
3062 __u64 ptlrpc_next_xid(void)
3066 spin_lock(&ptlrpc_last_xid_lock);
3067 next = ptlrpc_last_xid + PTLRPC_BULK_OPS_COUNT;
3068 ptlrpc_last_xid = next;
3069 spin_unlock(&ptlrpc_last_xid_lock);
3075 * Get a glimpse at what next xid value might have been.
3076 * Returns possible next xid.
3078 __u64 ptlrpc_sample_next_xid(void)
3080 #if BITS_PER_LONG == 32
3081 /* need to avoid possible word tearing on 32-bit systems */
3084 spin_lock(&ptlrpc_last_xid_lock);
3085 next = ptlrpc_last_xid + PTLRPC_BULK_OPS_COUNT;
3086 spin_unlock(&ptlrpc_last_xid_lock);
3090 /* No need to lock, since returned value is racy anyways */
3091 return ptlrpc_last_xid + PTLRPC_BULK_OPS_COUNT;
3094 EXPORT_SYMBOL(ptlrpc_sample_next_xid);
3097 * Functions for operating ptlrpc workers.
3099 * A ptlrpc work is a function which will be running inside ptlrpc context.
3100 * The callback shouldn't sleep otherwise it will block that ptlrpcd thread.
3102 * 1. after a work is created, it can be used many times, that is:
3103 * handler = ptlrpcd_alloc_work();
3104 * ptlrpcd_queue_work();
3106 * queue it again when necessary:
3107 * ptlrpcd_queue_work();
3108 * ptlrpcd_destroy_work();
3109 * 2. ptlrpcd_queue_work() can be called by multiple processes meanwhile, but
3110 * it will only be queued once in any time. Also as its name implies, it may
3111 * have delay before it really runs by ptlrpcd thread.
3113 struct ptlrpc_work_async_args {
3114 int (*cb)(const struct lu_env *, void *);
3118 static void ptlrpcd_add_work_req(struct ptlrpc_request *req)
3120 /* re-initialize the req */
3121 req->rq_timeout = obd_timeout;
3122 req->rq_sent = cfs_time_current_sec();
3123 req->rq_deadline = req->rq_sent + req->rq_timeout;
3124 req->rq_reply_deadline = req->rq_deadline;
3125 req->rq_phase = RQ_PHASE_INTERPRET;
3126 req->rq_next_phase = RQ_PHASE_COMPLETE;
3127 req->rq_xid = ptlrpc_next_xid();
3128 req->rq_import_generation = req->rq_import->imp_generation;
3130 ptlrpcd_add_req(req, PDL_POLICY_ROUND, -1);
3133 static int work_interpreter(const struct lu_env *env,
3134 struct ptlrpc_request *req, void *data, int rc)
3136 struct ptlrpc_work_async_args *arg = data;
3138 LASSERT(ptlrpcd_check_work(req));
3139 LASSERT(arg->cb != NULL);
3141 rc = arg->cb(env, arg->cbdata);
3143 list_del_init(&req->rq_set_chain);
3146 if (atomic_dec_return(&req->rq_refcount) > 1) {
3147 atomic_set(&req->rq_refcount, 2);
3148 ptlrpcd_add_work_req(req);
3153 static int worker_format;
3155 static int ptlrpcd_check_work(struct ptlrpc_request *req)
3157 return req->rq_pill.rc_fmt == (void *)&worker_format;
3161 * Create a work for ptlrpc.
3163 void *ptlrpcd_alloc_work(struct obd_import *imp,
3164 int (*cb)(const struct lu_env *, void *), void *cbdata)
3166 struct ptlrpc_request *req = NULL;
3167 struct ptlrpc_work_async_args *args;
3173 RETURN(ERR_PTR(-EINVAL));
3175 /* copy some code from deprecated fakereq. */
3176 req = ptlrpc_request_cache_alloc(GFP_NOFS);
3178 CERROR("ptlrpc: run out of memory!\n");
3179 RETURN(ERR_PTR(-ENOMEM));
3182 ptlrpc_cli_req_init(req);
3184 req->rq_send_state = LUSTRE_IMP_FULL;
3185 req->rq_type = PTL_RPC_MSG_REQUEST;
3186 req->rq_import = class_import_get(imp);
3187 req->rq_interpret_reply = work_interpreter;
3188 /* don't want reply */
3189 req->rq_no_delay = req->rq_no_resend = 1;
3190 req->rq_pill.rc_fmt = (void *)&worker_format;
3192 CLASSERT (sizeof(*args) <= sizeof(req->rq_async_args));
3193 args = ptlrpc_req_async_args(req);
3195 args->cbdata = cbdata;
3199 EXPORT_SYMBOL(ptlrpcd_alloc_work);
3201 void ptlrpcd_destroy_work(void *handler)
3203 struct ptlrpc_request *req = handler;
3206 ptlrpc_req_finished(req);
3208 EXPORT_SYMBOL(ptlrpcd_destroy_work);
3210 int ptlrpcd_queue_work(void *handler)
3212 struct ptlrpc_request *req = handler;
3215 * Check if the req is already being queued.
3217 * Here comes a trick: it lacks a way of checking if a req is being
3218 * processed reliably in ptlrpc. Here I have to use refcount of req
3219 * for this purpose. This is okay because the caller should use this
3220 * req as opaque data. - Jinshan
3222 LASSERT(atomic_read(&req->rq_refcount) > 0);
3223 if (atomic_inc_return(&req->rq_refcount) == 2)
3224 ptlrpcd_add_work_req(req);
3227 EXPORT_SYMBOL(ptlrpcd_queue_work);