Whamcloud - gitweb
LU-10157 ptlrpc: separate number MD and refrences for bulk
[fs/lustre-release.git] / lustre / ptlrpc / client.c
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
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.
9  *
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).
15  *
16  * You should have received a copy of the GNU General Public License
17  * version 2 along with this program; If not, see
18  * http://www.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2011, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  * Lustre is a trademark of Sun Microsystems, Inc.
31  */
32
33 /** Implementation of client-side PortalRPC interfaces */
34
35 #define DEBUG_SUBSYSTEM S_RPC
36
37 #include <linux/delay.h>
38 #include <linux/random.h>
39
40 #include <lnet/lib-lnet.h>
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>
47
48 #include "ptlrpc_internal.h"
49
50 static void ptlrpc_prep_bulk_page_pin(struct ptlrpc_bulk_desc *desc,
51                                       struct page *page, int pageoffset,
52                                       int len)
53 {
54         __ptlrpc_prep_bulk_page(desc, page, pageoffset, len, 1);
55 }
56
57 static void ptlrpc_prep_bulk_page_nopin(struct ptlrpc_bulk_desc *desc,
58                                         struct page *page, int pageoffset,
59                                         int len)
60 {
61         __ptlrpc_prep_bulk_page(desc, page, pageoffset, len, 0);
62 }
63
64 static void ptlrpc_release_bulk_page_pin(struct ptlrpc_bulk_desc *desc)
65 {
66         int i;
67
68         for (i = 0; i < desc->bd_iov_count ; i++)
69                 put_page(desc->bd_vec[i].bv_page);
70 }
71
72 static int ptlrpc_prep_bulk_frag_pages(struct ptlrpc_bulk_desc *desc,
73                                        void *frag, int len)
74 {
75         unsigned int offset = (unsigned long)frag & ~PAGE_MASK;
76
77         ENTRY;
78         while (len > 0) {
79                 int page_len = min_t(unsigned int, PAGE_SIZE - offset,
80                                      len);
81                 unsigned long vaddr = (unsigned long)frag;
82
83                 ptlrpc_prep_bulk_page_nopin(desc,
84                                             lnet_kvaddr_to_page(vaddr),
85                                             offset, page_len);
86                 offset = 0;
87                 len -= page_len;
88                 frag += page_len;
89         }
90
91         RETURN(desc->bd_nob);
92 }
93
94 const struct ptlrpc_bulk_frag_ops ptlrpc_bulk_kiov_pin_ops = {
95         .add_kiov_frag  = ptlrpc_prep_bulk_page_pin,
96         .release_frags  = ptlrpc_release_bulk_page_pin,
97 };
98 EXPORT_SYMBOL(ptlrpc_bulk_kiov_pin_ops);
99
100 const struct ptlrpc_bulk_frag_ops ptlrpc_bulk_kiov_nopin_ops = {
101         .add_kiov_frag  = ptlrpc_prep_bulk_page_nopin,
102         .release_frags  = ptlrpc_release_bulk_noop,
103         .add_iov_frag   = ptlrpc_prep_bulk_frag_pages,
104 };
105 EXPORT_SYMBOL(ptlrpc_bulk_kiov_nopin_ops);
106
107 static int ptlrpc_send_new_req(struct ptlrpc_request *req);
108 static int ptlrpcd_check_work(struct ptlrpc_request *req);
109 static int ptlrpc_unregister_reply(struct ptlrpc_request *request, int async);
110
111 /**
112  * Initialize passed in client structure \a cl.
113  */
114 void ptlrpc_init_client(int req_portal, int rep_portal, const char *name,
115                         struct ptlrpc_client *cl)
116 {
117         cl->cli_request_portal = req_portal;
118         cl->cli_reply_portal   = rep_portal;
119         cl->cli_name           = name;
120 }
121 EXPORT_SYMBOL(ptlrpc_init_client);
122
123 /**
124  * Return PortalRPC connection for remore uud \a uuid
125  */
126 struct ptlrpc_connection *ptlrpc_uuid_to_connection(struct obd_uuid *uuid,
127                                                     lnet_nid_t nid4refnet)
128 {
129         struct ptlrpc_connection *c;
130         lnet_nid_t self;
131         struct lnet_process_id peer;
132         int err;
133
134         /*
135          * ptlrpc_uuid_to_peer() initializes its 2nd parameter
136          * before accessing its values.
137          */
138         /* coverity[uninit_use_in_call] */
139         peer.nid = nid4refnet;
140         err = ptlrpc_uuid_to_peer(uuid, &peer, &self);
141         if (err != 0) {
142                 CNETERR("cannot find peer %s!\n", uuid->uuid);
143                 return NULL;
144         }
145
146         c = ptlrpc_connection_get(peer, self, uuid);
147         if (c) {
148                 memcpy(c->c_remote_uuid.uuid,
149                        uuid->uuid, sizeof(c->c_remote_uuid.uuid));
150         }
151
152         CDEBUG(D_INFO, "%s -> %p\n", uuid->uuid, c);
153
154         return c;
155 }
156
157 /**
158  * Allocate and initialize new bulk descriptor on the sender.
159  * Returns pointer to the descriptor or NULL on error.
160  */
161 struct ptlrpc_bulk_desc *ptlrpc_new_bulk(unsigned int nfrags,
162                                          unsigned int max_brw,
163                                          enum ptlrpc_bulk_op_type type,
164                                          unsigned int portal,
165                                          const struct ptlrpc_bulk_frag_ops *ops)
166 {
167         struct ptlrpc_bulk_desc *desc;
168         int i;
169
170         LASSERT(ops->add_kiov_frag != NULL);
171
172         OBD_ALLOC_PTR(desc);
173         if (!desc)
174                 return NULL;
175
176         OBD_ALLOC_LARGE(desc->bd_vec,
177                         nfrags * sizeof(*desc->bd_vec));
178         if (!desc->bd_vec)
179                 goto out;
180
181         spin_lock_init(&desc->bd_lock);
182         init_waitqueue_head(&desc->bd_waitq);
183         desc->bd_max_iov = nfrags;
184         desc->bd_iov_count = 0;
185         desc->bd_portal = portal;
186         desc->bd_type = type;
187         desc->bd_md_count = 0;
188         desc->bd_frag_ops = ops;
189         LASSERT(max_brw > 0);
190         desc->bd_md_max_brw = min(max_brw, PTLRPC_BULK_OPS_COUNT);
191         /*
192          * PTLRPC_BULK_OPS_COUNT is the compile-time transfer limit for this
193          * node. Negotiated ocd_brw_size will always be <= this number.
194          */
195         for (i = 0; i < PTLRPC_BULK_OPS_COUNT; i++)
196                 LNetInvalidateMDHandle(&desc->bd_mds[i]);
197
198         return desc;
199 out:
200         OBD_FREE_PTR(desc);
201         return NULL;
202 }
203
204 /**
205  * Prepare bulk descriptor for specified outgoing request \a req that
206  * can fit \a nfrags * pages. \a type is bulk type. \a portal is where
207  * the bulk to be sent. Used on client-side.
208  * Returns pointer to newly allocatrd initialized bulk descriptor or NULL on
209  * error.
210  */
211 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk_imp(struct ptlrpc_request *req,
212                                               unsigned int nfrags,
213                                               unsigned int max_brw,
214                                               unsigned int type,
215                                               unsigned int portal,
216                                               const struct ptlrpc_bulk_frag_ops
217                                                 *ops)
218 {
219         struct obd_import *imp = req->rq_import;
220         struct ptlrpc_bulk_desc *desc;
221
222         ENTRY;
223         LASSERT(ptlrpc_is_bulk_op_passive(type));
224
225         desc = ptlrpc_new_bulk(nfrags, max_brw, type, portal, ops);
226         if (!desc)
227                 RETURN(NULL);
228
229         desc->bd_import = class_import_get(imp);
230         desc->bd_req = req;
231
232         desc->bd_cbid.cbid_fn  = client_bulk_callback;
233         desc->bd_cbid.cbid_arg = desc;
234
235         /* This makes req own desc, and free it when she frees herself */
236         req->rq_bulk = desc;
237
238         return desc;
239 }
240 EXPORT_SYMBOL(ptlrpc_prep_bulk_imp);
241
242 void __ptlrpc_prep_bulk_page(struct ptlrpc_bulk_desc *desc,
243                              struct page *page, int pageoffset, int len,
244                              int pin)
245 {
246         struct bio_vec *kiov;
247
248         LASSERT(desc->bd_iov_count < desc->bd_max_iov);
249         LASSERT(page != NULL);
250         LASSERT(pageoffset >= 0);
251         LASSERT(len > 0);
252         LASSERT(pageoffset + len <= PAGE_SIZE);
253
254         kiov = &desc->bd_vec[desc->bd_iov_count];
255
256         desc->bd_nob += len;
257
258         if (pin)
259                 get_page(page);
260
261         kiov->bv_page = page;
262         kiov->bv_offset = pageoffset;
263         kiov->bv_len = len;
264
265         desc->bd_iov_count++;
266 }
267 EXPORT_SYMBOL(__ptlrpc_prep_bulk_page);
268
269 void ptlrpc_free_bulk(struct ptlrpc_bulk_desc *desc)
270 {
271         ENTRY;
272
273         LASSERT(desc != NULL);
274         LASSERT(desc->bd_iov_count != LI_POISON); /* not freed already */
275         LASSERT(desc->bd_refs == 0);         /* network hands off */
276         LASSERT((desc->bd_export != NULL) ^ (desc->bd_import != NULL));
277         LASSERT(desc->bd_frag_ops != NULL);
278
279         sptlrpc_enc_pool_put_pages(desc);
280
281         if (desc->bd_export)
282                 class_export_put(desc->bd_export);
283         else
284                 class_import_put(desc->bd_import);
285
286         if (desc->bd_frag_ops->release_frags != NULL)
287                 desc->bd_frag_ops->release_frags(desc);
288
289         OBD_FREE_LARGE(desc->bd_vec,
290                        desc->bd_max_iov * sizeof(*desc->bd_vec));
291         OBD_FREE_PTR(desc);
292         EXIT;
293 }
294 EXPORT_SYMBOL(ptlrpc_free_bulk);
295
296 /**
297  * Set server timelimit for this req, i.e. how long are we willing to wait
298  * for reply before timing out this request.
299  */
300 void ptlrpc_at_set_req_timeout(struct ptlrpc_request *req)
301 {
302         LASSERT(req->rq_import);
303
304         if (AT_OFF) {
305                 /* non-AT settings */
306                 /**
307                  * \a imp_server_timeout means this is reverse import and
308                  * we send (currently only) ASTs to the client and cannot afford
309                  * to wait too long for the reply, otherwise the other client
310                  * (because of which we are sending this request) would
311                  * timeout waiting for us
312                  */
313                 req->rq_timeout = req->rq_import->imp_server_timeout ?
314                                   obd_timeout / 2 : obd_timeout;
315         } else {
316                 struct imp_at *at = &req->rq_import->imp_at;
317                 timeout_t serv_est;
318                 int idx;
319
320                 idx = import_at_get_index(req->rq_import,
321                                           req->rq_request_portal);
322                 serv_est = at_get(&at->iat_service_estimate[idx]);
323                 /*
324                  * Currently a 32 bit value is sent over the
325                  * wire for rq_timeout so please don't change this
326                  * to time64_t. The work for LU-1158 will in time
327                  * replace rq_timeout with a 64 bit nanosecond value
328                  */
329                 req->rq_timeout = at_est2timeout(serv_est);
330         }
331         /*
332          * We could get even fancier here, using history to predict increased
333          * loading...
334          *
335          * Let the server know what this RPC timeout is by putting it in the
336          * reqmsg
337          */
338         lustre_msg_set_timeout(req->rq_reqmsg, req->rq_timeout);
339 }
340 EXPORT_SYMBOL(ptlrpc_at_set_req_timeout);
341
342 /* Adjust max service estimate based on server value */
343 static void ptlrpc_at_adj_service(struct ptlrpc_request *req,
344                                   timeout_t serv_est)
345 {
346         int idx;
347         timeout_t oldse;
348         struct imp_at *at;
349
350         LASSERT(req->rq_import);
351         at = &req->rq_import->imp_at;
352
353         idx = import_at_get_index(req->rq_import, req->rq_request_portal);
354         /*
355          * max service estimates are tracked on the server side,
356          * so just keep minimal history here
357          */
358         oldse = at_measured(&at->iat_service_estimate[idx], serv_est);
359         if (oldse != 0)
360                 CDEBUG(D_ADAPTTO,
361                        "The RPC service estimate for %s ptl %d has changed from %d to %d\n",
362                        req->rq_import->imp_obd->obd_name,
363                        req->rq_request_portal,
364                        oldse, at_get(&at->iat_service_estimate[idx]));
365 }
366
367 /* Expected network latency per remote node (secs) */
368 int ptlrpc_at_get_net_latency(struct ptlrpc_request *req)
369 {
370         return AT_OFF ? 0 : at_get(&req->rq_import->imp_at.iat_net_latency);
371 }
372
373 /* Adjust expected network latency */
374 void ptlrpc_at_adj_net_latency(struct ptlrpc_request *req,
375                                timeout_t service_timeout)
376 {
377         time64_t now = ktime_get_real_seconds();
378         struct imp_at *at;
379         timeout_t oldnl;
380         timeout_t nl;
381
382         LASSERT(req->rq_import);
383
384         if (service_timeout > now - req->rq_sent + 3) {
385                 /*
386                  * b=16408, however, this can also happen if early reply
387                  * is lost and client RPC is expired and resent, early reply
388                  * or reply of original RPC can still be fit in reply buffer
389                  * of resent RPC, now client is measuring time from the
390                  * resent time, but server sent back service time of original
391                  * RPC.
392                  */
393                 CDEBUG((lustre_msg_get_flags(req->rq_reqmsg) & MSG_RESENT) ?
394                        D_ADAPTTO : D_WARNING,
395                        "Reported service time %u > total measured time %lld\n",
396                        service_timeout, now - req->rq_sent);
397                 return;
398         }
399
400         /* Network latency is total time less server processing time,
401          * st rounding
402          */
403         nl = max_t(timeout_t, now - req->rq_sent - service_timeout, 0) + 1;
404         at = &req->rq_import->imp_at;
405
406         oldnl = at_measured(&at->iat_net_latency, nl);
407         if (oldnl != 0)
408                 CDEBUG(D_ADAPTTO,
409                        "The network latency for %s (nid %s) has changed from %d to %d\n",
410                        req->rq_import->imp_obd->obd_name,
411                        obd_uuid2str(&req->rq_import->imp_connection->c_remote_uuid),
412                        oldnl, at_get(&at->iat_net_latency));
413 }
414
415 static int unpack_reply(struct ptlrpc_request *req)
416 {
417         int rc;
418
419         if (SPTLRPC_FLVR_POLICY(req->rq_flvr.sf_rpc) != SPTLRPC_POLICY_NULL) {
420                 rc = ptlrpc_unpack_rep_msg(req, req->rq_replen);
421                 if (rc) {
422                         DEBUG_REQ(D_ERROR, req, "unpack_rep failed: rc = %d",
423                                   rc);
424                         return -EPROTO;
425                 }
426         }
427
428         rc = lustre_unpack_rep_ptlrpc_body(req, MSG_PTLRPC_BODY_OFF);
429         if (rc) {
430                 DEBUG_REQ(D_ERROR, req, "unpack ptlrpc body failed: rc = %d",
431                           rc);
432                 return -EPROTO;
433         }
434         return 0;
435 }
436
437 /**
438  * Handle an early reply message, called with the rq_lock held.
439  * If anything goes wrong just ignore it - same as if it never happened
440  */
441 static int ptlrpc_at_recv_early_reply(struct ptlrpc_request *req)
442 __must_hold(&req->rq_lock)
443 {
444         struct ptlrpc_request *early_req;
445         timeout_t service_timeout;
446         time64_t olddl;
447         int rc;
448
449         ENTRY;
450         req->rq_early = 0;
451         spin_unlock(&req->rq_lock);
452
453         rc = sptlrpc_cli_unwrap_early_reply(req, &early_req);
454         if (rc) {
455                 spin_lock(&req->rq_lock);
456                 RETURN(rc);
457         }
458
459         rc = unpack_reply(early_req);
460         if (rc != 0) {
461                 sptlrpc_cli_finish_early_reply(early_req);
462                 spin_lock(&req->rq_lock);
463                 RETURN(rc);
464         }
465
466         /*
467          * Use new timeout value just to adjust the local value for this
468          * request, don't include it into at_history. It is unclear yet why
469          * service time increased and should it be counted or skipped, e.g.
470          * that can be recovery case or some error or server, the real reply
471          * will add all new data if it is worth to add.
472          */
473         req->rq_timeout = lustre_msg_get_timeout(early_req->rq_repmsg);
474         lustre_msg_set_timeout(req->rq_reqmsg, req->rq_timeout);
475
476         /* Network latency can be adjusted, it is pure network delays */
477         service_timeout = lustre_msg_get_service_timeout(early_req->rq_repmsg);
478         ptlrpc_at_adj_net_latency(req, service_timeout);
479
480         sptlrpc_cli_finish_early_reply(early_req);
481
482         spin_lock(&req->rq_lock);
483         olddl = req->rq_deadline;
484         /*
485          * server assumes it now has rq_timeout from when the request
486          * arrived, so the client should give it at least that long.
487          * since we don't know the arrival time we'll use the original
488          * sent time
489          */
490         req->rq_deadline = req->rq_sent + req->rq_timeout +
491                            ptlrpc_at_get_net_latency(req);
492
493         /* The below message is checked in replay-single.sh test_65{a,b} */
494         /* The below message is checked in sanity-{gss,krb5} test_8 */
495         DEBUG_REQ(D_ADAPTTO, req,
496                   "Early reply #%d, new deadline in %llds (%llds)",
497                   req->rq_early_count,
498                   req->rq_deadline - ktime_get_real_seconds(),
499                   req->rq_deadline - olddl);
500
501         RETURN(rc);
502 }
503
504 static struct kmem_cache *request_cache;
505
506 int ptlrpc_request_cache_init(void)
507 {
508         request_cache = kmem_cache_create("ptlrpc_cache",
509                                           sizeof(struct ptlrpc_request),
510                                           0, SLAB_HWCACHE_ALIGN, NULL);
511         return request_cache ? 0 : -ENOMEM;
512 }
513
514 void ptlrpc_request_cache_fini(void)
515 {
516         kmem_cache_destroy(request_cache);
517 }
518
519 struct ptlrpc_request *ptlrpc_request_cache_alloc(gfp_t flags)
520 {
521         struct ptlrpc_request *req;
522
523         OBD_SLAB_ALLOC_PTR_GFP(req, request_cache, flags);
524         return req;
525 }
526
527 void ptlrpc_request_cache_free(struct ptlrpc_request *req)
528 {
529         OBD_SLAB_FREE_PTR(req, request_cache);
530 }
531
532 /**
533  * Wind down request pool \a pool.
534  * Frees all requests from the pool too
535  */
536 void ptlrpc_free_rq_pool(struct ptlrpc_request_pool *pool)
537 {
538         struct list_head *l, *tmp;
539         struct ptlrpc_request *req;
540
541         LASSERT(pool != NULL);
542
543         spin_lock(&pool->prp_lock);
544         list_for_each_safe(l, tmp, &pool->prp_req_list) {
545                 req = list_entry(l, struct ptlrpc_request, rq_list);
546                 list_del(&req->rq_list);
547                 LASSERT(req->rq_reqbuf);
548                 LASSERT(req->rq_reqbuf_len == pool->prp_rq_size);
549                 OBD_FREE_LARGE(req->rq_reqbuf, pool->prp_rq_size);
550                 ptlrpc_request_cache_free(req);
551         }
552         spin_unlock(&pool->prp_lock);
553         OBD_FREE(pool, sizeof(*pool));
554 }
555 EXPORT_SYMBOL(ptlrpc_free_rq_pool);
556
557 /**
558  * Allocates, initializes and adds \a num_rq requests to the pool \a pool
559  */
560 int ptlrpc_add_rqs_to_pool(struct ptlrpc_request_pool *pool, int num_rq)
561 {
562         int i;
563         int size = 1;
564
565         while (size < pool->prp_rq_size)
566                 size <<= 1;
567
568         LASSERTF(list_empty(&pool->prp_req_list) ||
569                  size == pool->prp_rq_size,
570                  "Trying to change pool size with nonempty pool from %d to %d bytes\n",
571                  pool->prp_rq_size, size);
572
573         pool->prp_rq_size = size;
574         for (i = 0; i < num_rq; i++) {
575                 struct ptlrpc_request *req;
576                 struct lustre_msg *msg;
577
578                 req = ptlrpc_request_cache_alloc(GFP_NOFS);
579                 if (!req)
580                         return i;
581                 OBD_ALLOC_LARGE(msg, size);
582                 if (!msg) {
583                         ptlrpc_request_cache_free(req);
584                         return i;
585                 }
586                 req->rq_reqbuf = msg;
587                 req->rq_reqbuf_len = size;
588                 req->rq_pool = pool;
589                 spin_lock(&pool->prp_lock);
590                 list_add_tail(&req->rq_list, &pool->prp_req_list);
591                 spin_unlock(&pool->prp_lock);
592         }
593         return num_rq;
594 }
595 EXPORT_SYMBOL(ptlrpc_add_rqs_to_pool);
596
597 /**
598  * Create and initialize new request pool with given attributes:
599  * \a num_rq - initial number of requests to create for the pool
600  * \a msgsize - maximum message size possible for requests in thid pool
601  * \a populate_pool - function to be called when more requests need to be added
602  *                    to the pool
603  * Returns pointer to newly created pool or NULL on error.
604  */
605 struct ptlrpc_request_pool *
606 ptlrpc_init_rq_pool(int num_rq, int msgsize,
607                     int (*populate_pool)(struct ptlrpc_request_pool *, int))
608 {
609         struct ptlrpc_request_pool *pool;
610
611         OBD_ALLOC_PTR(pool);
612         if (!pool)
613                 return NULL;
614
615         /*
616          * Request next power of two for the allocation, because internally
617          * kernel would do exactly this
618          */
619         spin_lock_init(&pool->prp_lock);
620         INIT_LIST_HEAD(&pool->prp_req_list);
621         pool->prp_rq_size = msgsize + SPTLRPC_MAX_PAYLOAD;
622         pool->prp_populate = populate_pool;
623
624         populate_pool(pool, num_rq);
625
626         return pool;
627 }
628 EXPORT_SYMBOL(ptlrpc_init_rq_pool);
629
630 /**
631  * Fetches one request from pool \a pool
632  */
633 static struct ptlrpc_request *
634 ptlrpc_prep_req_from_pool(struct ptlrpc_request_pool *pool)
635 {
636         struct ptlrpc_request *request;
637         struct lustre_msg *reqbuf;
638
639         if (!pool)
640                 return NULL;
641
642         spin_lock(&pool->prp_lock);
643
644         /*
645          * See if we have anything in a pool, and bail out if nothing,
646          * in writeout path, where this matters, this is safe to do, because
647          * nothing is lost in this case, and when some in-flight requests
648          * complete, this code will be called again.
649          */
650         if (unlikely(list_empty(&pool->prp_req_list))) {
651                 spin_unlock(&pool->prp_lock);
652                 return NULL;
653         }
654
655         request = list_entry(pool->prp_req_list.next, struct ptlrpc_request,
656                              rq_list);
657         list_del_init(&request->rq_list);
658         spin_unlock(&pool->prp_lock);
659
660         LASSERT(request->rq_reqbuf);
661         LASSERT(request->rq_pool);
662
663         reqbuf = request->rq_reqbuf;
664         memset(request, 0, sizeof(*request));
665         request->rq_reqbuf = reqbuf;
666         request->rq_reqbuf_len = pool->prp_rq_size;
667         request->rq_pool = pool;
668
669         return request;
670 }
671
672 /**
673  * Returns freed \a request to pool.
674  */
675 static void __ptlrpc_free_req_to_pool(struct ptlrpc_request *request)
676 {
677         struct ptlrpc_request_pool *pool = request->rq_pool;
678
679         spin_lock(&pool->prp_lock);
680         LASSERT(list_empty(&request->rq_list));
681         LASSERT(!request->rq_receiving_reply);
682         list_add_tail(&request->rq_list, &pool->prp_req_list);
683         spin_unlock(&pool->prp_lock);
684 }
685
686 void ptlrpc_add_unreplied(struct ptlrpc_request *req)
687 {
688         struct obd_import *imp = req->rq_import;
689         struct list_head *tmp;
690         struct ptlrpc_request *iter;
691
692         assert_spin_locked(&imp->imp_lock);
693         LASSERT(list_empty(&req->rq_unreplied_list));
694
695         /* unreplied list is sorted by xid in ascending order */
696         list_for_each_prev(tmp, &imp->imp_unreplied_list) {
697                 iter = list_entry(tmp, struct ptlrpc_request,
698                                   rq_unreplied_list);
699
700                 LASSERT(req->rq_xid != iter->rq_xid);
701                 if (req->rq_xid < iter->rq_xid)
702                         continue;
703                 list_add(&req->rq_unreplied_list, &iter->rq_unreplied_list);
704                 return;
705         }
706         list_add(&req->rq_unreplied_list, &imp->imp_unreplied_list);
707 }
708
709 void ptlrpc_assign_next_xid_nolock(struct ptlrpc_request *req)
710 {
711         req->rq_xid = ptlrpc_next_xid();
712         ptlrpc_add_unreplied(req);
713 }
714
715 static inline void ptlrpc_assign_next_xid(struct ptlrpc_request *req)
716 {
717         spin_lock(&req->rq_import->imp_lock);
718         ptlrpc_assign_next_xid_nolock(req);
719         spin_unlock(&req->rq_import->imp_lock);
720 }
721
722 static atomic64_t ptlrpc_last_xid;
723
724 static void ptlrpc_reassign_next_xid(struct ptlrpc_request *req)
725 {
726         spin_lock(&req->rq_import->imp_lock);
727         list_del_init(&req->rq_unreplied_list);
728         ptlrpc_assign_next_xid_nolock(req);
729         spin_unlock(&req->rq_import->imp_lock);
730         DEBUG_REQ(D_RPCTRACE, req, "reassign xid");
731 }
732
733 void ptlrpc_get_mod_rpc_slot(struct ptlrpc_request *req)
734 {
735         struct client_obd *cli = &req->rq_import->imp_obd->u.cli;
736         __u32 opc;
737         __u16 tag;
738
739         opc = lustre_msg_get_opc(req->rq_reqmsg);
740         tag = obd_get_mod_rpc_slot(cli, opc);
741         lustre_msg_set_tag(req->rq_reqmsg, tag);
742         ptlrpc_reassign_next_xid(req);
743 }
744 EXPORT_SYMBOL(ptlrpc_get_mod_rpc_slot);
745
746 void ptlrpc_put_mod_rpc_slot(struct ptlrpc_request *req)
747 {
748         __u16 tag = lustre_msg_get_tag(req->rq_reqmsg);
749
750         if (tag != 0) {
751                 struct client_obd *cli = &req->rq_import->imp_obd->u.cli;
752                 __u32 opc = lustre_msg_get_opc(req->rq_reqmsg);
753
754                 obd_put_mod_rpc_slot(cli, opc, tag);
755         }
756 }
757 EXPORT_SYMBOL(ptlrpc_put_mod_rpc_slot);
758
759 int ptlrpc_request_bufs_pack(struct ptlrpc_request *request,
760                              __u32 version, int opcode, char **bufs,
761                              struct ptlrpc_cli_ctx *ctx)
762 {
763         int count;
764         struct obd_import *imp;
765         __u32 *lengths;
766         int rc;
767
768         ENTRY;
769
770         count = req_capsule_filled_sizes(&request->rq_pill, RCL_CLIENT);
771         imp = request->rq_import;
772         lengths = request->rq_pill.rc_area[RCL_CLIENT];
773
774         if (ctx) {
775                 request->rq_cli_ctx = sptlrpc_cli_ctx_get(ctx);
776         } else {
777                 rc = sptlrpc_req_get_ctx(request);
778                 if (rc)
779                         GOTO(out_free, rc);
780         }
781         sptlrpc_req_set_flavor(request, opcode);
782
783         rc = lustre_pack_request(request, imp->imp_msg_magic, count,
784                                  lengths, bufs);
785         if (rc)
786                 GOTO(out_ctx, rc);
787
788         lustre_msg_add_version(request->rq_reqmsg, version);
789         request->rq_send_state = LUSTRE_IMP_FULL;
790         request->rq_type = PTL_RPC_MSG_REQUEST;
791
792         request->rq_req_cbid.cbid_fn  = request_out_callback;
793         request->rq_req_cbid.cbid_arg = request;
794
795         request->rq_reply_cbid.cbid_fn  = reply_in_callback;
796         request->rq_reply_cbid.cbid_arg = request;
797
798         request->rq_reply_deadline = 0;
799         request->rq_bulk_deadline = 0;
800         request->rq_req_deadline = 0;
801         request->rq_phase = RQ_PHASE_NEW;
802         request->rq_next_phase = RQ_PHASE_UNDEFINED;
803
804         request->rq_request_portal = imp->imp_client->cli_request_portal;
805         request->rq_reply_portal = imp->imp_client->cli_reply_portal;
806
807         ptlrpc_at_set_req_timeout(request);
808
809         lustre_msg_set_opc(request->rq_reqmsg, opcode);
810
811         /* Let's setup deadline for req/reply/bulk unlink for opcode. */
812         if (cfs_fail_val == opcode) {
813                 time64_t *fail_t = NULL, *fail2_t = NULL;
814
815                 if (CFS_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_BULK_UNLINK)) {
816                         fail_t = &request->rq_bulk_deadline;
817                 } else if (CFS_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK)) {
818                         fail_t = &request->rq_reply_deadline;
819                 } else if (CFS_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REQ_UNLINK)) {
820                         fail_t = &request->rq_req_deadline;
821                 } else if (CFS_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_BOTH_UNLINK)) {
822                         fail_t = &request->rq_reply_deadline;
823                         fail2_t = &request->rq_bulk_deadline;
824                 } else if (CFS_FAIL_CHECK(OBD_FAIL_PTLRPC_ROUND_XID)) {
825                         time64_t now = ktime_get_real_seconds();
826                         u64 xid = ((u64)now >> 4) << 24;
827
828                         atomic64_set(&ptlrpc_last_xid, xid);
829                 }
830
831                 if (fail_t) {
832                         *fail_t = ktime_get_real_seconds() +
833                                   PTLRPC_REQ_LONG_UNLINK;
834
835                         if (fail2_t)
836                                 *fail2_t = ktime_get_real_seconds() +
837                                            PTLRPC_REQ_LONG_UNLINK;
838
839                         /*
840                          * The RPC is infected, let the test to change the
841                          * fail_loc
842                          */
843                         msleep(4 * MSEC_PER_SEC);
844                 }
845         }
846         ptlrpc_assign_next_xid(request);
847
848         RETURN(0);
849
850 out_ctx:
851         LASSERT(!request->rq_pool);
852         sptlrpc_cli_ctx_put(request->rq_cli_ctx, 1);
853 out_free:
854         atomic_dec(&imp->imp_reqs);
855         class_import_put(imp);
856
857         return rc;
858 }
859 EXPORT_SYMBOL(ptlrpc_request_bufs_pack);
860
861 /**
862  * Pack request buffers for network transfer, performing necessary encryption
863  * steps if necessary.
864  */
865 int ptlrpc_request_pack(struct ptlrpc_request *request,
866                         __u32 version, int opcode)
867 {
868         return ptlrpc_request_bufs_pack(request, version, opcode, NULL, NULL);
869 }
870 EXPORT_SYMBOL(ptlrpc_request_pack);
871
872 /**
873  * Helper function to allocate new request on import \a imp
874  * and possibly using existing request from pool \a pool if provided.
875  * Returns allocated request structure with import field filled or
876  * NULL on error.
877  */
878 static inline
879 struct ptlrpc_request *__ptlrpc_request_alloc(struct obd_import *imp,
880                                               struct ptlrpc_request_pool *pool)
881 {
882         struct ptlrpc_request *request = NULL;
883
884         request = ptlrpc_request_cache_alloc(GFP_NOFS);
885
886         if (!request && pool)
887                 request = ptlrpc_prep_req_from_pool(pool);
888
889         if (request) {
890                 ptlrpc_cli_req_init(request);
891
892                 LASSERTF((unsigned long)imp > 0x1000, "%p\n", imp);
893                 LASSERT(imp != LP_POISON);
894                 LASSERTF((unsigned long)imp->imp_client > 0x1000, "%p\n",
895                          imp->imp_client);
896                 LASSERT(imp->imp_client != LP_POISON);
897
898                 request->rq_import = class_import_get(imp);
899                 atomic_inc(&imp->imp_reqs);
900         } else {
901                 CERROR("request allocation out of memory\n");
902         }
903
904         return request;
905 }
906
907 static int ptlrpc_reconnect_if_idle(struct obd_import *imp)
908 {
909         int rc;
910
911         /*
912          * initiate connection if needed when the import has been
913          * referenced by the new request to avoid races with disconnect.
914          * serialize this check against conditional state=IDLE
915          * in ptlrpc_disconnect_idle_interpret()
916          */
917         spin_lock(&imp->imp_lock);
918         if (imp->imp_state == LUSTRE_IMP_IDLE) {
919                 imp->imp_generation++;
920                 imp->imp_initiated_at = imp->imp_generation;
921                 imp->imp_state = LUSTRE_IMP_NEW;
922
923                 /* connect_import_locked releases imp_lock */
924                 rc = ptlrpc_connect_import_locked(imp);
925                 if (rc)
926                         return rc;
927                 ptlrpc_pinger_add_import(imp);
928         } else {
929                 spin_unlock(&imp->imp_lock);
930         }
931         return 0;
932 }
933
934 /**
935  * Helper function for creating a request.
936  * Calls __ptlrpc_request_alloc to allocate new request sturcture and inits
937  * buffer structures according to capsule template \a format.
938  * Returns allocated request structure pointer or NULL on error.
939  */
940 static struct ptlrpc_request *
941 ptlrpc_request_alloc_internal(struct obd_import *imp,
942                               struct ptlrpc_request_pool *pool,
943                               const struct req_format *format)
944 {
945         struct ptlrpc_request *request;
946
947         request = __ptlrpc_request_alloc(imp, pool);
948         if (!request)
949                 return NULL;
950
951         /* don't make expensive check for idling connection
952          * if it's already connected */
953         if (unlikely(imp->imp_state != LUSTRE_IMP_FULL)) {
954                 if (ptlrpc_reconnect_if_idle(imp) < 0) {
955                         atomic_dec(&imp->imp_reqs);
956                         ptlrpc_request_free(request);
957                         return NULL;
958                 }
959         }
960
961         req_capsule_init(&request->rq_pill, request, RCL_CLIENT);
962         req_capsule_set(&request->rq_pill, format);
963         return request;
964 }
965
966 /**
967  * Allocate new request structure for import \a imp and initialize its
968  * buffer structure according to capsule template \a format.
969  */
970 struct ptlrpc_request *ptlrpc_request_alloc(struct obd_import *imp,
971                                             const struct req_format *format)
972 {
973         return ptlrpc_request_alloc_internal(imp, NULL, format);
974 }
975 EXPORT_SYMBOL(ptlrpc_request_alloc);
976
977 /**
978  * Allocate new request structure for import \a imp from pool \a pool and
979  * initialize its buffer structure according to capsule template \a format.
980  */
981 struct ptlrpc_request *
982 ptlrpc_request_alloc_pool(struct obd_import *imp,
983                           struct ptlrpc_request_pool *pool,
984                           const struct req_format *format)
985 {
986         return ptlrpc_request_alloc_internal(imp, pool, format);
987 }
988 EXPORT_SYMBOL(ptlrpc_request_alloc_pool);
989
990 /**
991  * For requests not from pool, free memory of the request structure.
992  * For requests obtained from a pool earlier, return request back to pool.
993  */
994 void ptlrpc_request_free(struct ptlrpc_request *request)
995 {
996         if (request->rq_pool)
997                 __ptlrpc_free_req_to_pool(request);
998         else
999                 ptlrpc_request_cache_free(request);
1000 }
1001 EXPORT_SYMBOL(ptlrpc_request_free);
1002
1003 /**
1004  * Allocate new request for operatione \a opcode and immediatelly pack it for
1005  * network transfer.
1006  * Only used for simple requests like OBD_PING where the only important
1007  * part of the request is operation itself.
1008  * Returns allocated request or NULL on error.
1009  */
1010 struct ptlrpc_request *ptlrpc_request_alloc_pack(struct obd_import *imp,
1011                                                  const struct req_format *format,
1012                                                  __u32 version, int opcode)
1013 {
1014         struct ptlrpc_request *req = ptlrpc_request_alloc(imp, format);
1015         int rc;
1016
1017         if (req) {
1018                 rc = ptlrpc_request_pack(req, version, opcode);
1019                 if (rc) {
1020                         ptlrpc_request_free(req);
1021                         req = NULL;
1022                 }
1023         }
1024         return req;
1025 }
1026 EXPORT_SYMBOL(ptlrpc_request_alloc_pack);
1027
1028 /**
1029  * Allocate and initialize new request set structure on the current CPT.
1030  * Returns a pointer to the newly allocated set structure or NULL on error.
1031  */
1032 struct ptlrpc_request_set *ptlrpc_prep_set(void)
1033 {
1034         struct ptlrpc_request_set *set;
1035         int cpt;
1036
1037         ENTRY;
1038         cpt = cfs_cpt_current(cfs_cpt_tab, 0);
1039         OBD_CPT_ALLOC(set, cfs_cpt_tab, cpt, sizeof(*set));
1040         if (!set)
1041                 RETURN(NULL);
1042         atomic_set(&set->set_refcount, 1);
1043         INIT_LIST_HEAD(&set->set_requests);
1044         init_waitqueue_head(&set->set_waitq);
1045         atomic_set(&set->set_new_count, 0);
1046         atomic_set(&set->set_remaining, 0);
1047         spin_lock_init(&set->set_new_req_lock);
1048         INIT_LIST_HEAD(&set->set_new_requests);
1049         set->set_max_inflight = UINT_MAX;
1050         set->set_producer     = NULL;
1051         set->set_producer_arg = NULL;
1052         set->set_rc           = 0;
1053
1054         RETURN(set);
1055 }
1056 EXPORT_SYMBOL(ptlrpc_prep_set);
1057
1058 /**
1059  * Allocate and initialize new request set structure with flow control
1060  * extension. This extension allows to control the number of requests in-flight
1061  * for the whole set. A callback function to generate requests must be provided
1062  * and the request set will keep the number of requests sent over the wire to
1063  * @max_inflight.
1064  * Returns a pointer to the newly allocated set structure or NULL on error.
1065  */
1066 struct ptlrpc_request_set *ptlrpc_prep_fcset(int max, set_producer_func func,
1067                                              void *arg)
1068
1069 {
1070         struct ptlrpc_request_set *set;
1071
1072         set = ptlrpc_prep_set();
1073         if (!set)
1074                 RETURN(NULL);
1075
1076         set->set_max_inflight  = max;
1077         set->set_producer      = func;
1078         set->set_producer_arg  = arg;
1079
1080         RETURN(set);
1081 }
1082
1083 /**
1084  * Wind down and free request set structure previously allocated with
1085  * ptlrpc_prep_set.
1086  * Ensures that all requests on the set have completed and removes
1087  * all requests from the request list in a set.
1088  * If any unsent request happen to be on the list, pretends that they got
1089  * an error in flight and calls their completion handler.
1090  */
1091 void ptlrpc_set_destroy(struct ptlrpc_request_set *set)
1092 {
1093         struct list_head *tmp;
1094         struct list_head *next;
1095         int expected_phase;
1096         int n = 0;
1097
1098         ENTRY;
1099
1100         /* Requests on the set should either all be completed, or all be new */
1101         expected_phase = (atomic_read(&set->set_remaining) == 0) ?
1102                          RQ_PHASE_COMPLETE : RQ_PHASE_NEW;
1103         list_for_each(tmp, &set->set_requests) {
1104                 struct ptlrpc_request *req =
1105                         list_entry(tmp, struct ptlrpc_request,
1106                                    rq_set_chain);
1107
1108                 LASSERT(req->rq_phase == expected_phase);
1109                 n++;
1110         }
1111
1112         LASSERTF(atomic_read(&set->set_remaining) == 0 ||
1113                  atomic_read(&set->set_remaining) == n, "%d / %d\n",
1114                  atomic_read(&set->set_remaining), n);
1115
1116         list_for_each_safe(tmp, next, &set->set_requests) {
1117                 struct ptlrpc_request *req =
1118                         list_entry(tmp, struct ptlrpc_request,
1119                                    rq_set_chain);
1120                 list_del_init(&req->rq_set_chain);
1121
1122                 LASSERT(req->rq_phase == expected_phase);
1123
1124                 if (req->rq_phase == RQ_PHASE_NEW) {
1125                         ptlrpc_req_interpret(NULL, req, -EBADR);
1126                         atomic_dec(&set->set_remaining);
1127                 }
1128
1129                 spin_lock(&req->rq_lock);
1130                 req->rq_set = NULL;
1131                 req->rq_invalid_rqset = 0;
1132                 spin_unlock(&req->rq_lock);
1133
1134                 ptlrpc_req_finished(req);
1135         }
1136
1137         LASSERT(atomic_read(&set->set_remaining) == 0);
1138
1139         ptlrpc_reqset_put(set);
1140         EXIT;
1141 }
1142 EXPORT_SYMBOL(ptlrpc_set_destroy);
1143
1144 /**
1145  * Add a new request to the general purpose request set.
1146  * Assumes request reference from the caller.
1147  */
1148 void ptlrpc_set_add_req(struct ptlrpc_request_set *set,
1149                         struct ptlrpc_request *req)
1150 {
1151         if (set == PTLRPCD_SET) {
1152                 ptlrpcd_add_req(req);
1153                 return;
1154         }
1155
1156         LASSERT(req->rq_import->imp_state != LUSTRE_IMP_IDLE);
1157         LASSERT(list_empty(&req->rq_set_chain));
1158
1159         if (req->rq_allow_intr)
1160                 set->set_allow_intr = 1;
1161
1162         /* The set takes over the caller's request reference */
1163         list_add_tail(&req->rq_set_chain, &set->set_requests);
1164         req->rq_set = set;
1165         atomic_inc(&set->set_remaining);
1166         req->rq_queued_time = ktime_get_seconds();
1167
1168         if (req->rq_reqmsg)
1169                 lustre_msg_set_jobid(req->rq_reqmsg, NULL);
1170
1171         if (set->set_producer)
1172                 /*
1173                  * If the request set has a producer callback, the RPC must be
1174                  * sent straight away
1175                  */
1176                 ptlrpc_send_new_req(req);
1177 }
1178 EXPORT_SYMBOL(ptlrpc_set_add_req);
1179
1180 /**
1181  * Add a request to a request with dedicated server thread
1182  * and wake the thread to make any necessary processing.
1183  * Currently only used for ptlrpcd.
1184  */
1185 void ptlrpc_set_add_new_req(struct ptlrpcd_ctl *pc,
1186                             struct ptlrpc_request *req)
1187 {
1188         struct ptlrpc_request_set *set = pc->pc_set;
1189         int count, i;
1190
1191         LASSERT(req->rq_set == NULL);
1192         LASSERT(test_bit(LIOD_STOP, &pc->pc_flags) == 0);
1193
1194         spin_lock(&set->set_new_req_lock);
1195         /*
1196          * The set takes over the caller's request reference.
1197          */
1198         req->rq_set = set;
1199         req->rq_queued_time = ktime_get_seconds();
1200         list_add_tail(&req->rq_set_chain, &set->set_new_requests);
1201         count = atomic_inc_return(&set->set_new_count);
1202         spin_unlock(&set->set_new_req_lock);
1203
1204         /* Only need to call wakeup once for the first entry. */
1205         if (count == 1) {
1206                 wake_up(&set->set_waitq);
1207
1208                 /*
1209                  * XXX: It maybe unnecessary to wakeup all the partners. But to
1210                  *      guarantee the async RPC can be processed ASAP, we have
1211                  *      no other better choice. It maybe fixed in future.
1212                  */
1213                 for (i = 0; i < pc->pc_npartners; i++)
1214                         wake_up(&pc->pc_partners[i]->pc_set->set_waitq);
1215         }
1216 }
1217
1218 /**
1219  * Based on the current state of the import, determine if the request
1220  * can be sent, is an error, or should be delayed.
1221  *
1222  * Returns true if this request should be delayed. If false, and
1223  * *status is set, then the request can not be sent and *status is the
1224  * error code.  If false and status is 0, then request can be sent.
1225  *
1226  * The imp->imp_lock must be held.
1227  */
1228 static int ptlrpc_import_delay_req(struct obd_import *imp,
1229                                    struct ptlrpc_request *req, int *status)
1230 {
1231         int delay = 0;
1232
1233         ENTRY;
1234         LASSERT(status);
1235         *status = 0;
1236
1237         if (req->rq_ctx_init || req->rq_ctx_fini) {
1238                 /* always allow ctx init/fini rpc go through */
1239         } else if (imp->imp_state == LUSTRE_IMP_NEW) {
1240                 DEBUG_REQ(D_ERROR, req, "Uninitialized import");
1241                 *status = -EIO;
1242         } else if (imp->imp_state == LUSTRE_IMP_CLOSED) {
1243                 unsigned int opc = lustre_msg_get_opc(req->rq_reqmsg);
1244
1245                 /*
1246                  * pings or MDS-equivalent STATFS may safely
1247                  * race with umount
1248                  */
1249                 DEBUG_REQ((opc == OBD_PING || opc == OST_STATFS) ?
1250                           D_HA : D_ERROR, req, "IMP_CLOSED");
1251                 *status = -EIO;
1252         } else if (ptlrpc_send_limit_expired(req)) {
1253                 /* probably doesn't need to be a D_ERROR afterinitial testing */
1254                 DEBUG_REQ(D_HA, req, "send limit expired");
1255                 *status = -ETIMEDOUT;
1256         } else if (req->rq_send_state == LUSTRE_IMP_CONNECTING &&
1257                    imp->imp_state == LUSTRE_IMP_CONNECTING) {
1258                 ;/* allow CONNECT even if import is invalid */
1259                 if (atomic_read(&imp->imp_inval_count) != 0) {
1260                         DEBUG_REQ(D_ERROR, req, "invalidate in flight");
1261                         *status = -EIO;
1262                 }
1263         } else if (imp->imp_invalid || imp->imp_obd->obd_no_recov) {
1264                 if (!imp->imp_deactive)
1265                         DEBUG_REQ(D_NET, req, "IMP_INVALID");
1266                 *status = -ESHUTDOWN; /* b=12940 */
1267         } else if (req->rq_import_generation != imp->imp_generation) {
1268                 DEBUG_REQ(D_ERROR, req, "req wrong generation:");
1269                 *status = -EIO;
1270         } else if (req->rq_send_state != imp->imp_state) {
1271                 /* invalidate in progress - any requests should be drop */
1272                 if (atomic_read(&imp->imp_inval_count) != 0) {
1273                         DEBUG_REQ(D_ERROR, req, "invalidate in flight");
1274                         *status = -EIO;
1275                 } else if (req->rq_no_delay &&
1276                            imp->imp_generation != imp->imp_initiated_at) {
1277                         /* ignore nodelay for requests initiating connections */
1278                         *status = -EWOULDBLOCK;
1279                 } else if (req->rq_allow_replay &&
1280                            (imp->imp_state == LUSTRE_IMP_REPLAY ||
1281                             imp->imp_state == LUSTRE_IMP_REPLAY_LOCKS ||
1282                             imp->imp_state == LUSTRE_IMP_REPLAY_WAIT ||
1283                             imp->imp_state == LUSTRE_IMP_RECOVER)) {
1284                         DEBUG_REQ(D_HA, req, "allow during recovery");
1285                 } else {
1286                         delay = 1;
1287                 }
1288         }
1289
1290         RETURN(delay);
1291 }
1292
1293 /**
1294  * Decide if the error message should be printed to the console or not.
1295  * Makes its decision based on request type, status, and failure frequency.
1296  *
1297  * \param[in] req  request that failed and may need a console message
1298  *
1299  * \retval false if no message should be printed
1300  * \retval true  if console message should be printed
1301  */
1302 static bool ptlrpc_console_allow(struct ptlrpc_request *req, __u32 opc, int err)
1303 {
1304         LASSERT(req->rq_reqmsg != NULL);
1305
1306         /* Suppress particular reconnect errors which are to be expected. */
1307         if (opc == OST_CONNECT || opc == MDS_CONNECT || opc == MGS_CONNECT) {
1308                 /* Suppress timed out reconnect requests */
1309                 if (lustre_handle_is_used(&req->rq_import->imp_remote_handle) ||
1310                     req->rq_timedout)
1311                         return false;
1312
1313                 /*
1314                  * Suppress most unavailable/again reconnect requests, but
1315                  * print occasionally so it is clear client is trying to
1316                  * connect to a server where no target is running.
1317                  */
1318                 if ((err == -ENODEV || err == -EAGAIN) &&
1319                     req->rq_import->imp_conn_cnt % 30 != 20)
1320                         return false;
1321         }
1322
1323         if (opc == LDLM_ENQUEUE && err == -EAGAIN)
1324                 /* -EAGAIN is normal when using POSIX flocks */
1325                 return false;
1326
1327         if (opc == OBD_PING && (err == -ENODEV || err == -ENOTCONN) &&
1328             (req->rq_xid & 0xf) != 10)
1329                 /* Suppress most ping requests, they may fail occasionally */
1330                 return false;
1331
1332         return true;
1333 }
1334
1335 /**
1336  * Check request processing status.
1337  * Returns the status.
1338  */
1339 static int ptlrpc_check_status(struct ptlrpc_request *req)
1340 {
1341         int rc;
1342
1343         ENTRY;
1344         rc = lustre_msg_get_status(req->rq_repmsg);
1345         if (lustre_msg_get_type(req->rq_repmsg) == PTL_RPC_MSG_ERR) {
1346                 struct obd_import *imp = req->rq_import;
1347                 lnet_nid_t nid = imp->imp_connection->c_peer.nid;
1348                 __u32 opc = lustre_msg_get_opc(req->rq_reqmsg);
1349
1350                 if (ptlrpc_console_allow(req, opc, rc))
1351                         LCONSOLE_ERROR_MSG(0x11,
1352                                            "%s: operation %s to node %s failed: rc = %d\n",
1353                                            imp->imp_obd->obd_name,
1354                                            ll_opcode2str(opc),
1355                                            libcfs_nid2str(nid), rc);
1356                 RETURN(rc < 0 ? rc : -EINVAL);
1357         }
1358
1359         if (rc)
1360                 DEBUG_REQ(D_INFO, req, "check status: rc = %d", rc);
1361
1362         RETURN(rc);
1363 }
1364
1365 /**
1366  * save pre-versions of objects into request for replay.
1367  * Versions are obtained from server reply.
1368  * used for VBR.
1369  */
1370 static void ptlrpc_save_versions(struct ptlrpc_request *req)
1371 {
1372         struct lustre_msg *repmsg = req->rq_repmsg;
1373         struct lustre_msg *reqmsg = req->rq_reqmsg;
1374         __u64 *versions = lustre_msg_get_versions(repmsg);
1375
1376         ENTRY;
1377         if (lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY)
1378                 return;
1379
1380         LASSERT(versions);
1381         lustre_msg_set_versions(reqmsg, versions);
1382         CDEBUG(D_INFO, "Client save versions [%#llx/%#llx]\n",
1383                versions[0], versions[1]);
1384
1385         EXIT;
1386 }
1387
1388 __u64 ptlrpc_known_replied_xid(struct obd_import *imp)
1389 {
1390         struct ptlrpc_request *req;
1391
1392         assert_spin_locked(&imp->imp_lock);
1393         if (list_empty(&imp->imp_unreplied_list))
1394                 return 0;
1395
1396         req = list_entry(imp->imp_unreplied_list.next, struct ptlrpc_request,
1397                          rq_unreplied_list);
1398         LASSERTF(req->rq_xid >= 1, "XID:%llu\n", req->rq_xid);
1399
1400         if (imp->imp_known_replied_xid < req->rq_xid - 1)
1401                 imp->imp_known_replied_xid = req->rq_xid - 1;
1402
1403         return req->rq_xid - 1;
1404 }
1405
1406 /**
1407  * Callback function called when client receives RPC reply for \a req.
1408  * Returns 0 on success or error code.
1409  * The return alue would be assigned to req->rq_status by the caller
1410  * as request processing status.
1411  * This function also decides if the request needs to be saved for later replay.
1412  */
1413 static int after_reply(struct ptlrpc_request *req)
1414 {
1415         struct obd_import *imp = req->rq_import;
1416         struct obd_device *obd = req->rq_import->imp_obd;
1417         ktime_t work_start;
1418         u64 committed;
1419         s64 timediff;
1420         int rc;
1421
1422         ENTRY;
1423         LASSERT(obd != NULL);
1424         /* repbuf must be unlinked */
1425         LASSERT(!req->rq_receiving_reply && req->rq_reply_unlinked);
1426
1427         if (req->rq_reply_truncated) {
1428                 if (ptlrpc_no_resend(req)) {
1429                         DEBUG_REQ(D_ERROR, req,
1430                                   "reply buffer overflow, expected=%d, actual size=%d",
1431                                   req->rq_nob_received, req->rq_repbuf_len);
1432                         RETURN(-EOVERFLOW);
1433                 }
1434
1435                 sptlrpc_cli_free_repbuf(req);
1436                 /*
1437                  * Pass the required reply buffer size (include
1438                  * space for early reply).
1439                  * NB: no need to roundup because alloc_repbuf
1440                  * will roundup it
1441                  */
1442                 req->rq_replen = req->rq_nob_received;
1443                 req->rq_nob_received = 0;
1444                 spin_lock(&req->rq_lock);
1445                 req->rq_resend       = 1;
1446                 spin_unlock(&req->rq_lock);
1447                 RETURN(0);
1448         }
1449
1450         work_start = ktime_get_real();
1451         timediff = ktime_us_delta(work_start, req->rq_sent_ns);
1452
1453         /*
1454          * NB Until this point, the whole of the incoming message,
1455          * including buflens, status etc is in the sender's byte order.
1456          */
1457         rc = sptlrpc_cli_unwrap_reply(req);
1458         if (rc) {
1459                 DEBUG_REQ(D_ERROR, req, "unwrap reply failed: rc = %d", rc);
1460                 RETURN(rc);
1461         }
1462
1463         /*
1464          * Security layer unwrap might ask resend this request.
1465          */
1466         if (req->rq_resend)
1467                 RETURN(0);
1468
1469         rc = unpack_reply(req);
1470         if (rc)
1471                 RETURN(rc);
1472
1473         /* retry indefinitely on EINPROGRESS */
1474         if (lustre_msg_get_status(req->rq_repmsg) == -EINPROGRESS &&
1475             ptlrpc_no_resend(req) == 0 && !req->rq_no_retry_einprogress) {
1476                 time64_t now = ktime_get_real_seconds();
1477
1478                 DEBUG_REQ((req->rq_nr_resend % 8 == 1 ? D_WARNING : 0) |
1479                           D_RPCTRACE, req, "resending request on EINPROGRESS");
1480                 spin_lock(&req->rq_lock);
1481                 req->rq_resend = 1;
1482                 spin_unlock(&req->rq_lock);
1483                 req->rq_nr_resend++;
1484
1485                 /* Readjust the timeout for current conditions */
1486                 ptlrpc_at_set_req_timeout(req);
1487                 /*
1488                  * delay resend to give a chance to the server to get ready.
1489                  * The delay is increased by 1s on every resend and is capped to
1490                  * the current request timeout (i.e. obd_timeout if AT is off,
1491                  * or AT service time x 125% + 5s, see at_est2timeout)
1492                  */
1493                 if (req->rq_nr_resend > req->rq_timeout)
1494                         req->rq_sent = now + req->rq_timeout;
1495                 else
1496                         req->rq_sent = now + req->rq_nr_resend;
1497
1498                 /* Resend for EINPROGRESS will use a new XID */
1499                 spin_lock(&imp->imp_lock);
1500                 list_del_init(&req->rq_unreplied_list);
1501                 spin_unlock(&imp->imp_lock);
1502
1503                 RETURN(0);
1504         }
1505
1506         if (obd->obd_svc_stats) {
1507                 lprocfs_counter_add(obd->obd_svc_stats, PTLRPC_REQWAIT_CNTR,
1508                                     timediff);
1509                 ptlrpc_lprocfs_rpc_sent(req, timediff);
1510         }
1511
1512         if (lustre_msg_get_type(req->rq_repmsg) != PTL_RPC_MSG_REPLY &&
1513             lustre_msg_get_type(req->rq_repmsg) != PTL_RPC_MSG_ERR) {
1514                 DEBUG_REQ(D_ERROR, req, "invalid packet received (type=%u)",
1515                           lustre_msg_get_type(req->rq_repmsg));
1516                 RETURN(-EPROTO);
1517         }
1518
1519         if (lustre_msg_get_opc(req->rq_reqmsg) != OBD_PING)
1520                 CFS_FAIL_TIMEOUT(OBD_FAIL_PTLRPC_PAUSE_REP, cfs_fail_val);
1521         ptlrpc_at_adj_service(req, lustre_msg_get_timeout(req->rq_repmsg));
1522         ptlrpc_at_adj_net_latency(req,
1523                                   lustre_msg_get_service_timeout(req->rq_repmsg));
1524
1525         rc = ptlrpc_check_status(req);
1526
1527         if (rc) {
1528                 /*
1529                  * Either we've been evicted, or the server has failed for
1530                  * some reason. Try to reconnect, and if that fails, punt to
1531                  * the upcall.
1532                  */
1533                 if (ptlrpc_recoverable_error(rc)) {
1534                         if (req->rq_send_state != LUSTRE_IMP_FULL ||
1535                             imp->imp_obd->obd_no_recov || imp->imp_dlm_fake) {
1536                                 RETURN(rc);
1537                         }
1538                         ptlrpc_request_handle_notconn(req);
1539                         RETURN(rc);
1540                 }
1541         } else {
1542                 /*
1543                  * Let's look if server sent slv. Do it only for RPC with
1544                  * rc == 0.
1545                  */
1546                 ldlm_cli_update_pool(req);
1547         }
1548
1549         /*
1550          * Store transno in reqmsg for replay.
1551          */
1552         if (!(lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY)) {
1553                 req->rq_transno = lustre_msg_get_transno(req->rq_repmsg);
1554                 lustre_msg_set_transno(req->rq_reqmsg, req->rq_transno);
1555         }
1556
1557         if (imp->imp_replayable) {
1558                 spin_lock(&imp->imp_lock);
1559                 /*
1560                  * No point in adding already-committed requests to the replay
1561                  * list, we will just remove them immediately. b=9829
1562                  */
1563                 if (req->rq_transno != 0 &&
1564                     (req->rq_transno >
1565                      lustre_msg_get_last_committed(req->rq_repmsg) ||
1566                      req->rq_replay)) {
1567                         /** version recovery */
1568                         ptlrpc_save_versions(req);
1569                         ptlrpc_retain_replayable_request(req, imp);
1570                 } else if (req->rq_commit_cb &&
1571                            list_empty(&req->rq_replay_list)) {
1572                         /*
1573                          * NB: don't call rq_commit_cb if it's already on
1574                          * rq_replay_list, ptlrpc_free_committed() will call
1575                          * it later, see LU-3618 for details
1576                          */
1577                         spin_unlock(&imp->imp_lock);
1578                         req->rq_commit_cb(req);
1579                         spin_lock(&imp->imp_lock);
1580                 }
1581
1582                 /*
1583                  * Replay-enabled imports return commit-status information.
1584                  */
1585                 committed = lustre_msg_get_last_committed(req->rq_repmsg);
1586                 if (likely(committed > imp->imp_peer_committed_transno))
1587                         imp->imp_peer_committed_transno = committed;
1588
1589                 ptlrpc_free_committed(imp);
1590
1591                 if (!list_empty(&imp->imp_replay_list)) {
1592                         struct ptlrpc_request *last;
1593
1594                         last = list_entry(imp->imp_replay_list.prev,
1595                                           struct ptlrpc_request,
1596                                           rq_replay_list);
1597                         /*
1598                          * Requests with rq_replay stay on the list even if no
1599                          * commit is expected.
1600                          */
1601                         if (last->rq_transno > imp->imp_peer_committed_transno)
1602                                 ptlrpc_pinger_commit_expected(imp);
1603                 }
1604
1605                 spin_unlock(&imp->imp_lock);
1606         }
1607
1608         RETURN(rc);
1609 }
1610
1611 /**
1612  * Helper function to send request \a req over the network for the first time
1613  * Also adjusts request phase.
1614  * Returns 0 on success or error code.
1615  */
1616 static int ptlrpc_send_new_req(struct ptlrpc_request *req)
1617 {
1618         struct obd_import *imp = req->rq_import;
1619         __u64 min_xid = 0;
1620         int rc;
1621
1622         ENTRY;
1623         LASSERT(req->rq_phase == RQ_PHASE_NEW);
1624
1625         /* do not try to go further if there is not enough memory in enc_pool */
1626         if (req->rq_sent && req->rq_bulk)
1627                 if (req->rq_bulk->bd_iov_count > get_free_pages_in_pool() &&
1628                     pool_is_at_full_capacity())
1629                         RETURN(-ENOMEM);
1630
1631         if (req->rq_sent && (req->rq_sent > ktime_get_real_seconds()) &&
1632             (!req->rq_generation_set ||
1633              req->rq_import_generation == imp->imp_generation))
1634                 RETURN(0);
1635
1636         ptlrpc_rqphase_move(req, RQ_PHASE_RPC);
1637
1638         spin_lock(&imp->imp_lock);
1639
1640         LASSERT(req->rq_xid != 0);
1641         LASSERT(!list_empty(&req->rq_unreplied_list));
1642
1643         if (!req->rq_generation_set)
1644                 req->rq_import_generation = imp->imp_generation;
1645
1646         if (ptlrpc_import_delay_req(imp, req, &rc)) {
1647                 spin_lock(&req->rq_lock);
1648                 req->rq_waiting = 1;
1649                 spin_unlock(&req->rq_lock);
1650
1651                 DEBUG_REQ(D_HA, req, "req waiting for recovery: (%s != %s)",
1652                           ptlrpc_import_state_name(req->rq_send_state),
1653                           ptlrpc_import_state_name(imp->imp_state));
1654                 LASSERT(list_empty(&req->rq_list));
1655                 list_add_tail(&req->rq_list, &imp->imp_delayed_list);
1656                 atomic_inc(&req->rq_import->imp_inflight);
1657                 spin_unlock(&imp->imp_lock);
1658                 RETURN(0);
1659         }
1660
1661         if (rc != 0) {
1662                 spin_unlock(&imp->imp_lock);
1663                 req->rq_status = rc;
1664                 ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
1665                 RETURN(rc);
1666         }
1667
1668         LASSERT(list_empty(&req->rq_list));
1669         list_add_tail(&req->rq_list, &imp->imp_sending_list);
1670         atomic_inc(&req->rq_import->imp_inflight);
1671
1672         /*
1673          * find the known replied XID from the unreplied list, CONNECT
1674          * and DISCONNECT requests are skipped to make the sanity check
1675          * on server side happy. see process_req_last_xid().
1676          *
1677          * For CONNECT: Because replay requests have lower XID, it'll
1678          * break the sanity check if CONNECT bump the exp_last_xid on
1679          * server.
1680          *
1681          * For DISCONNECT: Since client will abort inflight RPC before
1682          * sending DISCONNECT, DISCONNECT may carry an XID which higher
1683          * than the inflight RPC.
1684          */
1685         if (!ptlrpc_req_is_connect(req) && !ptlrpc_req_is_disconnect(req))
1686                 min_xid = ptlrpc_known_replied_xid(imp);
1687         spin_unlock(&imp->imp_lock);
1688
1689         lustre_msg_set_last_xid(req->rq_reqmsg, min_xid);
1690
1691         lustre_msg_set_status(req->rq_reqmsg, current->pid);
1692
1693         rc = sptlrpc_req_refresh_ctx(req, 0);
1694         if (rc) {
1695                 if (req->rq_err) {
1696                         req->rq_status = rc;
1697                         RETURN(1);
1698                 } else {
1699                         spin_lock(&req->rq_lock);
1700                         req->rq_wait_ctx = 1;
1701                         spin_unlock(&req->rq_lock);
1702                         RETURN(0);
1703                 }
1704         }
1705
1706         CDEBUG(D_RPCTRACE,
1707                "Sending RPC req@%p pname:cluuid:pid:xid:nid:opc:job %s:%s:%d:%llu:%s:%d:%s\n",
1708                req, current->comm,
1709                imp->imp_obd->obd_uuid.uuid,
1710                lustre_msg_get_status(req->rq_reqmsg), req->rq_xid,
1711                obd_import_nid2str(imp), lustre_msg_get_opc(req->rq_reqmsg),
1712                lustre_msg_get_jobid(req->rq_reqmsg) ?: "");
1713
1714         rc = ptl_send_rpc(req, 0);
1715         if (rc == -ENOMEM) {
1716                 spin_lock(&imp->imp_lock);
1717                 if (!list_empty(&req->rq_list)) {
1718                         list_del_init(&req->rq_list);
1719                         if (atomic_dec_and_test(&req->rq_import->imp_inflight))
1720                                 wake_up(&req->rq_import->imp_recovery_waitq);
1721                 }
1722                 spin_unlock(&imp->imp_lock);
1723                 ptlrpc_rqphase_move(req, RQ_PHASE_NEW);
1724                 RETURN(rc);
1725         }
1726         if (rc) {
1727                 DEBUG_REQ(D_HA, req, "send failed, expect timeout: rc = %d",
1728                           rc);
1729                 spin_lock(&req->rq_lock);
1730                 req->rq_net_err = 1;
1731                 spin_unlock(&req->rq_lock);
1732                 RETURN(rc);
1733         }
1734         RETURN(0);
1735 }
1736
1737 static inline int ptlrpc_set_producer(struct ptlrpc_request_set *set)
1738 {
1739         int remaining, rc;
1740
1741         ENTRY;
1742         LASSERT(set->set_producer != NULL);
1743
1744         remaining = atomic_read(&set->set_remaining);
1745
1746         /*
1747          * populate the ->set_requests list with requests until we
1748          * reach the maximum number of RPCs in flight for this set
1749          */
1750         while (atomic_read(&set->set_remaining) < set->set_max_inflight) {
1751                 rc = set->set_producer(set, set->set_producer_arg);
1752                 if (rc == -ENOENT) {
1753                         /* no more RPC to produce */
1754                         set->set_producer     = NULL;
1755                         set->set_producer_arg = NULL;
1756                         RETURN(0);
1757                 }
1758         }
1759
1760         RETURN((atomic_read(&set->set_remaining) - remaining));
1761 }
1762
1763 /**
1764  * this sends any unsent RPCs in \a set and returns 1 if all are sent
1765  * and no more replies are expected.
1766  * (it is possible to get less replies than requests sent e.g. due to timed out
1767  * requests or requests that we had trouble to send out)
1768  *
1769  * NOTE: This function contains a potential schedule point (cond_resched()).
1770  */
1771 int ptlrpc_check_set(const struct lu_env *env, struct ptlrpc_request_set *set)
1772 {
1773         struct list_head *tmp, *next;
1774         LIST_HEAD(comp_reqs);
1775         int force_timer_recalc = 0;
1776
1777         ENTRY;
1778         if (atomic_read(&set->set_remaining) == 0)
1779                 RETURN(1);
1780
1781         list_for_each_safe(tmp, next, &set->set_requests) {
1782                 struct ptlrpc_request *req =
1783                         list_entry(tmp, struct ptlrpc_request,
1784                                    rq_set_chain);
1785                 struct obd_import *imp = req->rq_import;
1786                 int unregistered = 0;
1787                 int async = 1;
1788                 int rc = 0;
1789
1790                 if (req->rq_phase == RQ_PHASE_COMPLETE) {
1791                         list_move_tail(&req->rq_set_chain, &comp_reqs);
1792                         continue;
1793                 }
1794
1795                 /*
1796                  * This schedule point is mainly for the ptlrpcd caller of this
1797                  * function.  Most ptlrpc sets are not long-lived and unbounded
1798                  * in length, but at the least the set used by the ptlrpcd is.
1799                  * Since the processing time is unbounded, we need to insert an
1800                  * explicit schedule point to make the thread well-behaved.
1801                  */
1802                 cond_resched();
1803
1804                 /*
1805                  * If the caller requires to allow to be interpreted by force
1806                  * and it has really been interpreted, then move the request
1807                  * to RQ_PHASE_INTERPRET phase in spite of what the current
1808                  * phase is.
1809                  */
1810                 if (unlikely(req->rq_allow_intr && req->rq_intr)) {
1811                         req->rq_status = -EINTR;
1812                         ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
1813
1814                         /*
1815                          * Since it is interpreted and we have to wait for
1816                          * the reply to be unlinked, then use sync mode.
1817                          */
1818                         async = 0;
1819
1820                         GOTO(interpret, req->rq_status);
1821                 }
1822
1823                 if (req->rq_phase == RQ_PHASE_NEW && ptlrpc_send_new_req(req))
1824                         force_timer_recalc = 1;
1825
1826                 /* delayed send - skip */
1827                 if (req->rq_phase == RQ_PHASE_NEW && req->rq_sent)
1828                         continue;
1829
1830                 /* delayed resend - skip */
1831                 if (req->rq_phase == RQ_PHASE_RPC && req->rq_resend &&
1832                     req->rq_sent > ktime_get_real_seconds())
1833                         continue;
1834
1835                 if (!(req->rq_phase == RQ_PHASE_RPC ||
1836                       req->rq_phase == RQ_PHASE_BULK ||
1837                       req->rq_phase == RQ_PHASE_INTERPRET ||
1838                       req->rq_phase == RQ_PHASE_UNREG_RPC ||
1839                       req->rq_phase == RQ_PHASE_UNREG_BULK)) {
1840                         DEBUG_REQ(D_ERROR, req, "bad phase %x", req->rq_phase);
1841                         LBUG();
1842                 }
1843
1844                 if (req->rq_phase == RQ_PHASE_UNREG_RPC ||
1845                     req->rq_phase == RQ_PHASE_UNREG_BULK) {
1846                         LASSERT(req->rq_next_phase != req->rq_phase);
1847                         LASSERT(req->rq_next_phase != RQ_PHASE_UNDEFINED);
1848
1849                         if (req->rq_req_deadline &&
1850                             !OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REQ_UNLINK))
1851                                 req->rq_req_deadline = 0;
1852                         if (req->rq_reply_deadline &&
1853                             !OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK))
1854                                 req->rq_reply_deadline = 0;
1855                         if (req->rq_bulk_deadline &&
1856                             !OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_BULK_UNLINK))
1857                                 req->rq_bulk_deadline = 0;
1858
1859                         /*
1860                          * Skip processing until reply is unlinked. We
1861                          * can't return to pool before that and we can't
1862                          * call interpret before that. We need to make
1863                          * sure that all rdma transfers finished and will
1864                          * not corrupt any data.
1865                          */
1866                         if (req->rq_phase == RQ_PHASE_UNREG_RPC &&
1867                             ptlrpc_client_recv_or_unlink(req))
1868                                 continue;
1869                         if (req->rq_phase == RQ_PHASE_UNREG_BULK &&
1870                             ptlrpc_client_bulk_active(req))
1871                                 continue;
1872
1873                         /*
1874                          * Turn fail_loc off to prevent it from looping
1875                          * forever.
1876                          */
1877                         if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK)) {
1878                                 OBD_FAIL_CHECK_ORSET(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK,
1879                                                      OBD_FAIL_ONCE);
1880                         }
1881                         if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_BULK_UNLINK)) {
1882                                 OBD_FAIL_CHECK_ORSET(OBD_FAIL_PTLRPC_LONG_BULK_UNLINK,
1883                                                      OBD_FAIL_ONCE);
1884                         }
1885
1886                         /*
1887                          * Move to next phase if reply was successfully
1888                          * unlinked.
1889                          */
1890                         ptlrpc_rqphase_move(req, req->rq_next_phase);
1891                 }
1892
1893                 if (req->rq_phase == RQ_PHASE_INTERPRET)
1894                         GOTO(interpret, req->rq_status);
1895
1896                 /*
1897                  * Note that this also will start async reply unlink.
1898                  */
1899                 if (req->rq_net_err && !req->rq_timedout) {
1900                         ptlrpc_expire_one_request(req, 1);
1901
1902                         /*
1903                          * Check if we still need to wait for unlink.
1904                          */
1905                         if (ptlrpc_client_recv_or_unlink(req) ||
1906                             ptlrpc_client_bulk_active(req))
1907                                 continue;
1908                         /* If there is no need to resend, fail it now. */
1909                         if (req->rq_no_resend) {
1910                                 if (req->rq_status == 0)
1911                                         req->rq_status = -EIO;
1912                                 ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
1913                                 GOTO(interpret, req->rq_status);
1914                         } else {
1915                                 continue;
1916                         }
1917                 }
1918
1919                 if (req->rq_err) {
1920                         spin_lock(&req->rq_lock);
1921                         req->rq_replied = 0;
1922                         spin_unlock(&req->rq_lock);
1923                         if (req->rq_status == 0)
1924                                 req->rq_status = -EIO;
1925                         ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
1926                         GOTO(interpret, req->rq_status);
1927                 }
1928
1929                 /*
1930                  * ptlrpc_set_wait uses l_wait_event_abortable_timeout()
1931                  * so it sets rq_intr regardless of individual rpc
1932                  * timeouts. The synchronous IO waiting path sets
1933                  * rq_intr irrespective of whether ptlrpcd
1934                  * has seen a timeout.  Our policy is to only interpret
1935                  * interrupted rpcs after they have timed out, so we
1936                  * need to enforce that here.
1937                  */
1938
1939                 if (req->rq_intr && (req->rq_timedout || req->rq_waiting ||
1940                                      req->rq_wait_ctx)) {
1941                         req->rq_status = -EINTR;
1942                         ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
1943                         GOTO(interpret, req->rq_status);
1944                 }
1945
1946                 if (req->rq_phase == RQ_PHASE_RPC) {
1947                         if (req->rq_timedout || req->rq_resend ||
1948                             req->rq_waiting || req->rq_wait_ctx) {
1949                                 int status;
1950
1951                                 if (!ptlrpc_unregister_reply(req, 1)) {
1952                                         ptlrpc_unregister_bulk(req, 1);
1953                                         continue;
1954                                 }
1955
1956                                 spin_lock(&imp->imp_lock);
1957                                 if (ptlrpc_import_delay_req(imp, req,
1958                                                             &status)) {
1959                                         /*
1960                                          * put on delay list - only if we wait
1961                                          * recovery finished - before send
1962                                          */
1963                                         list_move_tail(&req->rq_list,
1964                                                        &imp->imp_delayed_list);
1965                                         spin_unlock(&imp->imp_lock);
1966                                         continue;
1967                                 }
1968
1969                                 if (status != 0)  {
1970                                         req->rq_status = status;
1971                                         ptlrpc_rqphase_move(req,
1972                                                             RQ_PHASE_INTERPRET);
1973                                         spin_unlock(&imp->imp_lock);
1974                                         GOTO(interpret, req->rq_status);
1975                                 }
1976                                 /* ignore on just initiated connections */
1977                                 if (ptlrpc_no_resend(req) &&
1978                                     !req->rq_wait_ctx &&
1979                                     imp->imp_generation !=
1980                                     imp->imp_initiated_at) {
1981                                         req->rq_status = -ENOTCONN;
1982                                         ptlrpc_rqphase_move(req,
1983                                                             RQ_PHASE_INTERPRET);
1984                                         spin_unlock(&imp->imp_lock);
1985                                         GOTO(interpret, req->rq_status);
1986                                 }
1987
1988                                 list_move_tail(&req->rq_list,
1989                                                &imp->imp_sending_list);
1990
1991                                 spin_unlock(&imp->imp_lock);
1992
1993                                 spin_lock(&req->rq_lock);
1994                                 req->rq_waiting = 0;
1995                                 spin_unlock(&req->rq_lock);
1996
1997                                 if (req->rq_timedout || req->rq_resend) {
1998                                         /*
1999                                          * This is re-sending anyways,
2000                                          * let's mark req as resend.
2001                                          */
2002                                         spin_lock(&req->rq_lock);
2003                                         req->rq_resend = 1;
2004                                         spin_unlock(&req->rq_lock);
2005                                 }
2006                                 /*
2007                                  * rq_wait_ctx is only touched by ptlrpcd,
2008                                  * so no lock is needed here.
2009                                  */
2010                                 status = sptlrpc_req_refresh_ctx(req, 0);
2011                                 if (status) {
2012                                         if (req->rq_err) {
2013                                                 req->rq_status = status;
2014                                                 spin_lock(&req->rq_lock);
2015                                                 req->rq_wait_ctx = 0;
2016                                                 spin_unlock(&req->rq_lock);
2017                                                 force_timer_recalc = 1;
2018                                         } else {
2019                                                 spin_lock(&req->rq_lock);
2020                                                 req->rq_wait_ctx = 1;
2021                                                 spin_unlock(&req->rq_lock);
2022                                         }
2023
2024                                         continue;
2025                                 } else {
2026                                         spin_lock(&req->rq_lock);
2027                                         req->rq_wait_ctx = 0;
2028                                         spin_unlock(&req->rq_lock);
2029                                 }
2030
2031                                 /*
2032                                  * In any case, the previous bulk should be
2033                                  * cleaned up to prepare for the new sending
2034                                  */
2035                                 if (req->rq_bulk &&
2036                                     !ptlrpc_unregister_bulk(req, 1))
2037                                         continue;
2038
2039                                 rc = ptl_send_rpc(req, 0);
2040                                 if (rc == -ENOMEM) {
2041                                         spin_lock(&imp->imp_lock);
2042                                         if (!list_empty(&req->rq_list))
2043                                                 list_del_init(&req->rq_list);
2044                                         spin_unlock(&imp->imp_lock);
2045                                         ptlrpc_rqphase_move(req, RQ_PHASE_NEW);
2046                                         continue;
2047                                 }
2048                                 if (rc) {
2049                                         DEBUG_REQ(D_HA, req,
2050                                                   "send failed: rc = %d", rc);
2051                                         force_timer_recalc = 1;
2052                                         spin_lock(&req->rq_lock);
2053                                         req->rq_net_err = 1;
2054                                         spin_unlock(&req->rq_lock);
2055                                         continue;
2056                                 }
2057                                 /* need to reset the timeout */
2058                                 force_timer_recalc = 1;
2059                         }
2060
2061                         spin_lock(&req->rq_lock);
2062
2063                         if (ptlrpc_client_early(req)) {
2064                                 ptlrpc_at_recv_early_reply(req);
2065                                 spin_unlock(&req->rq_lock);
2066                                 continue;
2067                         }
2068
2069                         /* Still waiting for a reply? */
2070                         if (ptlrpc_client_recv(req)) {
2071                                 spin_unlock(&req->rq_lock);
2072                                 continue;
2073                         }
2074
2075                         /* Did we actually receive a reply? */
2076                         if (!ptlrpc_client_replied(req)) {
2077                                 spin_unlock(&req->rq_lock);
2078                                 continue;
2079                         }
2080
2081                         spin_unlock(&req->rq_lock);
2082
2083                         /*
2084                          * unlink from net because we are going to
2085                          * swab in-place of reply buffer
2086                          */
2087                         unregistered = ptlrpc_unregister_reply(req, 1);
2088                         if (!unregistered)
2089                                 continue;
2090
2091                         req->rq_status = after_reply(req);
2092                         if (req->rq_resend)
2093                                 continue;
2094
2095                         /*
2096                          * If there is no bulk associated with this request,
2097                          * then we're done and should let the interpreter
2098                          * process the reply. Similarly if the RPC returned
2099                          * an error, and therefore the bulk will never arrive.
2100                          */
2101                         if (!req->rq_bulk || req->rq_status < 0) {
2102                                 ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
2103                                 GOTO(interpret, req->rq_status);
2104                         }
2105
2106                         ptlrpc_rqphase_move(req, RQ_PHASE_BULK);
2107                 }
2108
2109                 LASSERT(req->rq_phase == RQ_PHASE_BULK);
2110                 if (ptlrpc_client_bulk_active(req))
2111                         continue;
2112
2113                 if (req->rq_bulk->bd_failure) {
2114                         /*
2115                          * The RPC reply arrived OK, but the bulk screwed
2116                          * up!  Dead weird since the server told us the RPC
2117                          * was good after getting the REPLY for her GET or
2118                          * the ACK for her PUT.
2119                          */
2120                         DEBUG_REQ(D_ERROR, req, "bulk transfer failed");
2121                         req->rq_status = -EIO;
2122                 }
2123
2124                 ptlrpc_rqphase_move(req, RQ_PHASE_INTERPRET);
2125
2126 interpret:
2127                 LASSERT(req->rq_phase == RQ_PHASE_INTERPRET);
2128
2129                 /*
2130                  * This moves to "unregistering" phase we need to wait for
2131                  * reply unlink.
2132                  */
2133                 if (!unregistered && !ptlrpc_unregister_reply(req, async)) {
2134                         /* start async bulk unlink too */
2135                         ptlrpc_unregister_bulk(req, 1);
2136                         continue;
2137                 }
2138
2139                 if (!ptlrpc_unregister_bulk(req, async))
2140                         continue;
2141
2142                 /*
2143                  * When calling interpret receiving already should be
2144                  * finished.
2145                  */
2146                 LASSERT(!req->rq_receiving_reply);
2147
2148                 ptlrpc_req_interpret(env, req, req->rq_status);
2149
2150                 if (ptlrpcd_check_work(req)) {
2151                         atomic_dec(&set->set_remaining);
2152                         continue;
2153                 }
2154                 ptlrpc_rqphase_move(req, RQ_PHASE_COMPLETE);
2155
2156                 if (req->rq_reqmsg)
2157                         CDEBUG(D_RPCTRACE,
2158                                "Completed RPC req@%p pname:cluuid:pid:xid:nid:opc:job %s:%s:%d:%llu:%s:%d:%s\n",
2159                                req, current->comm,
2160                                imp->imp_obd->obd_uuid.uuid,
2161                                lustre_msg_get_status(req->rq_reqmsg),
2162                                req->rq_xid,
2163                                obd_import_nid2str(imp),
2164                                lustre_msg_get_opc(req->rq_reqmsg),
2165                                lustre_msg_get_jobid(req->rq_reqmsg) ?: "");
2166
2167                 spin_lock(&imp->imp_lock);
2168                 /*
2169                  * Request already may be not on sending or delaying list. This
2170                  * may happen in the case of marking it erroneous for the case
2171                  * ptlrpc_import_delay_req(req, status) find it impossible to
2172                  * allow sending this rpc and returns *status != 0.
2173                  */
2174                 if (!list_empty(&req->rq_list)) {
2175                         list_del_init(&req->rq_list);
2176                         if (atomic_dec_and_test(&imp->imp_inflight))
2177                                 wake_up(&imp->imp_recovery_waitq);
2178                 }
2179                 list_del_init(&req->rq_unreplied_list);
2180                 spin_unlock(&imp->imp_lock);
2181
2182                 atomic_dec(&set->set_remaining);
2183                 wake_up(&imp->imp_recovery_waitq);
2184
2185                 if (set->set_producer) {
2186                         /* produce a new request if possible */
2187                         if (ptlrpc_set_producer(set) > 0)
2188                                 force_timer_recalc = 1;
2189
2190                         /*
2191                          * free the request that has just been completed
2192                          * in order not to pollute set->set_requests
2193                          */
2194                         list_del_init(&req->rq_set_chain);
2195                         spin_lock(&req->rq_lock);
2196                         req->rq_set = NULL;
2197                         req->rq_invalid_rqset = 0;
2198                         spin_unlock(&req->rq_lock);
2199
2200                         /* record rq_status to compute the final status later */
2201                         if (req->rq_status != 0)
2202                                 set->set_rc = req->rq_status;
2203                         ptlrpc_req_finished(req);
2204                 } else {
2205                         list_move_tail(&req->rq_set_chain, &comp_reqs);
2206                 }
2207         }
2208
2209         /*
2210          * move completed request at the head of list so it's easier for
2211          * caller to find them
2212          */
2213         list_splice(&comp_reqs, &set->set_requests);
2214
2215         /* If we hit an error, we want to recover promptly. */
2216         RETURN(atomic_read(&set->set_remaining) == 0 || force_timer_recalc);
2217 }
2218 EXPORT_SYMBOL(ptlrpc_check_set);
2219
2220 /**
2221  * Time out request \a req. is \a async_unlink is set, that means do not wait
2222  * until LNet actually confirms network buffer unlinking.
2223  * Return 1 if we should give up further retrying attempts or 0 otherwise.
2224  */
2225 int ptlrpc_expire_one_request(struct ptlrpc_request *req, int async_unlink)
2226 {
2227         struct obd_import *imp = req->rq_import;
2228         unsigned int debug_mask = D_RPCTRACE;
2229         int rc = 0;
2230
2231         ENTRY;
2232         spin_lock(&req->rq_lock);
2233         req->rq_timedout = 1;
2234         spin_unlock(&req->rq_lock);
2235
2236         if (ptlrpc_console_allow(req, lustre_msg_get_opc(req->rq_reqmsg),
2237                                  lustre_msg_get_status(req->rq_reqmsg)))
2238                 debug_mask = D_WARNING;
2239         DEBUG_REQ(debug_mask, req, "Request sent has %s: [sent %lld/real %lld]",
2240                   req->rq_net_err ? "failed due to network error" :
2241                      ((req->rq_real_sent == 0 ||
2242                        req->rq_real_sent < req->rq_sent ||
2243                        req->rq_real_sent >= req->rq_deadline) ?
2244                       "timed out for sent delay" : "timed out for slow reply"),
2245                   req->rq_sent, req->rq_real_sent);
2246
2247         if (imp && obd_debug_peer_on_timeout)
2248                 LNetDebugPeer(imp->imp_connection->c_peer);
2249
2250         ptlrpc_unregister_reply(req, async_unlink);
2251         ptlrpc_unregister_bulk(req, async_unlink);
2252
2253         if (obd_dump_on_timeout)
2254                 libcfs_debug_dumplog();
2255
2256         if (!imp) {
2257                 DEBUG_REQ(D_HA, req, "NULL import: already cleaned up?");
2258                 RETURN(1);
2259         }
2260
2261         atomic_inc(&imp->imp_timeouts);
2262
2263         /* The DLM server doesn't want recovery run on its imports. */
2264         if (imp->imp_dlm_fake)
2265                 RETURN(1);
2266
2267         /*
2268          * If this request is for recovery or other primordial tasks,
2269          * then error it out here.
2270          */
2271         if (req->rq_ctx_init || req->rq_ctx_fini ||
2272             req->rq_send_state != LUSTRE_IMP_FULL ||
2273             imp->imp_obd->obd_no_recov) {
2274                 DEBUG_REQ(D_RPCTRACE, req, "err -110, sent_state=%s (now=%s)",
2275                           ptlrpc_import_state_name(req->rq_send_state),
2276                           ptlrpc_import_state_name(imp->imp_state));
2277                 spin_lock(&req->rq_lock);
2278                 req->rq_status = -ETIMEDOUT;
2279                 req->rq_err = 1;
2280                 spin_unlock(&req->rq_lock);
2281                 RETURN(1);
2282         }
2283
2284         /*
2285          * if a request can't be resent we can't wait for an answer after
2286          * the timeout
2287          */
2288         if (ptlrpc_no_resend(req)) {
2289                 DEBUG_REQ(D_RPCTRACE, req, "TIMEOUT-NORESEND:");
2290                 rc = 1;
2291         }
2292
2293         ptlrpc_fail_import(imp, lustre_msg_get_conn_cnt(req->rq_reqmsg));
2294
2295         RETURN(rc);
2296 }
2297
2298 /**
2299  * Time out all uncompleted requests in request set pointed by \a data
2300  * This is called when a wait times out.
2301  */
2302 void ptlrpc_expired_set(struct ptlrpc_request_set *set)
2303 {
2304         struct list_head *tmp;
2305         time64_t now = ktime_get_real_seconds();
2306
2307         ENTRY;
2308         LASSERT(set != NULL);
2309
2310         /*
2311          * A timeout expired. See which reqs it applies to...
2312          */
2313         list_for_each(tmp, &set->set_requests) {
2314                 struct ptlrpc_request *req =
2315                         list_entry(tmp, struct ptlrpc_request,
2316                                    rq_set_chain);
2317
2318                 /* don't expire request waiting for context */
2319                 if (req->rq_wait_ctx)
2320                         continue;
2321
2322                 /* Request in-flight? */
2323                 if (!((req->rq_phase == RQ_PHASE_RPC &&
2324                        !req->rq_waiting && !req->rq_resend) ||
2325                       (req->rq_phase == RQ_PHASE_BULK)))
2326                         continue;
2327
2328                 if (req->rq_timedout ||     /* already dealt with */
2329                     req->rq_deadline > now) /* not expired */
2330                         continue;
2331
2332                 /*
2333                  * Deal with this guy. Do it asynchronously to not block
2334                  * ptlrpcd thread.
2335                  */
2336                 ptlrpc_expire_one_request(req, 1);
2337         }
2338 }
2339
2340 /**
2341  * Interrupts (sets interrupted flag) all uncompleted requests in
2342  * a set \a data. This is called when a wait_event is interrupted
2343  * by a signal.
2344  */
2345 static void ptlrpc_interrupted_set(struct ptlrpc_request_set *set)
2346 {
2347         struct list_head *tmp;
2348
2349         LASSERT(set != NULL);
2350         CDEBUG(D_RPCTRACE, "INTERRUPTED SET %p\n", set);
2351
2352         list_for_each(tmp, &set->set_requests) {
2353                 struct ptlrpc_request *req =
2354                         list_entry(tmp, struct ptlrpc_request, rq_set_chain);
2355
2356                 if (req->rq_intr)
2357                         continue;
2358
2359                 if (req->rq_phase != RQ_PHASE_RPC &&
2360                     req->rq_phase != RQ_PHASE_UNREG_RPC &&
2361                     !req->rq_allow_intr)
2362                         continue;
2363
2364                 spin_lock(&req->rq_lock);
2365                 req->rq_intr = 1;
2366                 spin_unlock(&req->rq_lock);
2367         }
2368 }
2369
2370 /**
2371  * Get the smallest timeout in the set; this does NOT set a timeout.
2372  */
2373 time64_t ptlrpc_set_next_timeout(struct ptlrpc_request_set *set)
2374 {
2375         struct list_head *tmp;
2376         time64_t now = ktime_get_real_seconds();
2377         int timeout = 0;
2378         struct ptlrpc_request *req;
2379         time64_t deadline;
2380
2381         ENTRY;
2382         list_for_each(tmp, &set->set_requests) {
2383                 req = list_entry(tmp, struct ptlrpc_request, rq_set_chain);
2384
2385                 /* Request in-flight? */
2386                 if (!(((req->rq_phase == RQ_PHASE_RPC) && !req->rq_waiting) ||
2387                       (req->rq_phase == RQ_PHASE_BULK) ||
2388                       (req->rq_phase == RQ_PHASE_NEW)))
2389                         continue;
2390
2391                 /* Already timed out. */
2392                 if (req->rq_timedout)
2393                         continue;
2394
2395                 /* Waiting for ctx. */
2396                 if (req->rq_wait_ctx)
2397                         continue;
2398
2399                 if (req->rq_phase == RQ_PHASE_NEW)
2400                         deadline = req->rq_sent;
2401                 else if (req->rq_phase == RQ_PHASE_RPC && req->rq_resend)
2402                         deadline = req->rq_sent;
2403                 else
2404                         deadline = req->rq_sent + req->rq_timeout;
2405
2406                 if (deadline <= now)    /* actually expired already */
2407                         timeout = 1;    /* ASAP */
2408                 else if (timeout == 0 || timeout > deadline - now)
2409                         timeout = deadline - now;
2410         }
2411         RETURN(timeout);
2412 }
2413
2414 /**
2415  * Send all unset request from the set and then wait untill all
2416  * requests in the set complete (either get a reply, timeout, get an
2417  * error or otherwise be interrupted).
2418  * Returns 0 on success or error code otherwise.
2419  */
2420 int ptlrpc_set_wait(const struct lu_env *env, struct ptlrpc_request_set *set)
2421 {
2422         struct list_head *tmp;
2423         struct ptlrpc_request *req;
2424         time64_t timeout;
2425         int rc;
2426
2427         ENTRY;
2428         if (set->set_producer)
2429                 (void)ptlrpc_set_producer(set);
2430         else
2431                 list_for_each(tmp, &set->set_requests) {
2432                         req = list_entry(tmp, struct ptlrpc_request,
2433                                          rq_set_chain);
2434                         if (req->rq_phase == RQ_PHASE_NEW)
2435                                 (void)ptlrpc_send_new_req(req);
2436                 }
2437
2438         if (list_empty(&set->set_requests))
2439                 RETURN(0);
2440
2441         do {
2442                 timeout = ptlrpc_set_next_timeout(set);
2443
2444                 /*
2445                  * wait until all complete, interrupted, or an in-flight
2446                  * req times out
2447                  */
2448                 CDEBUG(D_RPCTRACE, "set %p going to sleep for %lld seconds\n",
2449                        set, timeout);
2450
2451                 if ((timeout == 0 && !signal_pending(current)) ||
2452                     set->set_allow_intr) {
2453                         /*
2454                          * No requests are in-flight (ether timed out
2455                          * or delayed), so we can allow interrupts.
2456                          * We still want to block for a limited time,
2457                          * so we allow interrupts during the timeout.
2458                          */
2459                         rc = l_wait_event_abortable_timeout(
2460                                 set->set_waitq,
2461                                 ptlrpc_check_set(NULL, set),
2462                                 cfs_time_seconds(timeout ? timeout : 1));
2463                         if (rc == 0) {
2464                                 rc = -ETIMEDOUT;
2465                                 ptlrpc_expired_set(set);
2466                         } else if (rc < 0) {
2467                                 rc = -EINTR;
2468                                 ptlrpc_interrupted_set(set);
2469                         } else {
2470                                 rc = 0;
2471                         }
2472                 } else {
2473                         /*
2474                          * At least one request is in flight, so no
2475                          * interrupts are allowed. Wait until all
2476                          * complete, or an in-flight req times out.
2477                          */
2478                         rc = wait_event_idle_timeout(
2479                                 set->set_waitq,
2480                                 ptlrpc_check_set(NULL, set),
2481                                 cfs_time_seconds(timeout ? timeout : 1));
2482                         if (rc == 0) {
2483                                 ptlrpc_expired_set(set);
2484                                 rc = -ETIMEDOUT;
2485                         } else {
2486                                 rc = 0;
2487                         }
2488
2489                         /*
2490                          * LU-769 - if we ignored the signal because
2491                          * it was already pending when we started, we
2492                          * need to handle it now or we risk it being
2493                          * ignored forever
2494                          */
2495                         if (rc == -ETIMEDOUT &&
2496                             signal_pending(current)) {
2497                                 sigset_t old, new;
2498
2499                                 siginitset(&new, LUSTRE_FATAL_SIGS);
2500                                 sigprocmask(SIG_BLOCK, &new, &old);
2501                                 /*
2502                                  * In fact we only interrupt for the
2503                                  * "fatal" signals like SIGINT or
2504                                  * SIGKILL. We still ignore less
2505                                  * important signals since ptlrpc set
2506                                  * is not easily reentrant from
2507                                  * userspace again
2508                                  */
2509                                 if (signal_pending(current))
2510                                         ptlrpc_interrupted_set(set);
2511                                 sigprocmask(SIG_SETMASK, &old, NULL);
2512                         }
2513                 }
2514
2515                 LASSERT(rc == 0 || rc == -EINTR || rc == -ETIMEDOUT);
2516
2517                 /*
2518                  * -EINTR => all requests have been flagged rq_intr so next
2519                  * check completes.
2520                  * -ETIMEDOUT => someone timed out.  When all reqs have
2521                  * timed out, signals are enabled allowing completion with
2522                  * EINTR.
2523                  * I don't really care if we go once more round the loop in
2524                  * the error cases -eeb.
2525                  */
2526                 if (rc == 0 && atomic_read(&set->set_remaining) == 0) {
2527                         list_for_each(tmp, &set->set_requests) {
2528                                 req = list_entry(tmp, struct ptlrpc_request,
2529                                                  rq_set_chain);
2530                                 spin_lock(&req->rq_lock);
2531                                 req->rq_invalid_rqset = 1;
2532                                 spin_unlock(&req->rq_lock);
2533                         }
2534                 }
2535         } while (rc != 0 || atomic_read(&set->set_remaining) != 0);
2536
2537         LASSERT(atomic_read(&set->set_remaining) == 0);
2538
2539         rc = set->set_rc; /* rq_status of already freed requests if any */
2540         list_for_each(tmp, &set->set_requests) {
2541                 req = list_entry(tmp, struct ptlrpc_request, rq_set_chain);
2542
2543                 LASSERT(req->rq_phase == RQ_PHASE_COMPLETE);
2544                 if (req->rq_status != 0)
2545                         rc = req->rq_status;
2546         }
2547
2548         RETURN(rc);
2549 }
2550 EXPORT_SYMBOL(ptlrpc_set_wait);
2551
2552 /**
2553  * Helper fuction for request freeing.
2554  * Called when request count reached zero and request needs to be freed.
2555  * Removes request from all sorts of sending/replay lists it might be on,
2556  * frees network buffers if any are present.
2557  * If \a locked is set, that means caller is already holding import imp_lock
2558  * and so we no longer need to reobtain it (for certain lists manipulations)
2559  */
2560 static void __ptlrpc_free_req(struct ptlrpc_request *request, int locked)
2561 {
2562         ENTRY;
2563
2564         if (!request)
2565                 RETURN_EXIT;
2566
2567         LASSERT(!request->rq_srv_req);
2568         LASSERT(request->rq_export == NULL);
2569         LASSERTF(!request->rq_receiving_reply, "req %p\n", request);
2570         LASSERTF(list_empty(&request->rq_list), "req %p\n", request);
2571         LASSERTF(list_empty(&request->rq_set_chain), "req %p\n", request);
2572         LASSERTF(!request->rq_replay, "req %p\n", request);
2573
2574         req_capsule_fini(&request->rq_pill);
2575
2576         /*
2577          * We must take it off the imp_replay_list first.  Otherwise, we'll set
2578          * request->rq_reqmsg to NULL while osc_close is dereferencing it.
2579          */
2580         if (request->rq_import) {
2581                 if (!locked)
2582                         spin_lock(&request->rq_import->imp_lock);
2583                 list_del_init(&request->rq_replay_list);
2584                 list_del_init(&request->rq_unreplied_list);
2585                 if (!locked)
2586                         spin_unlock(&request->rq_import->imp_lock);
2587         }
2588         LASSERTF(list_empty(&request->rq_replay_list), "req %p\n", request);
2589
2590         if (atomic_read(&request->rq_refcount) != 0) {
2591                 DEBUG_REQ(D_ERROR, request,
2592                           "freeing request with nonzero refcount");
2593                 LBUG();
2594         }
2595
2596         if (request->rq_repbuf)
2597                 sptlrpc_cli_free_repbuf(request);
2598
2599         if (request->rq_import) {
2600                 if (!ptlrpcd_check_work(request)) {
2601                         LASSERT(atomic_read(&request->rq_import->imp_reqs) > 0);
2602                         atomic_dec(&request->rq_import->imp_reqs);
2603                 }
2604                 class_import_put(request->rq_import);
2605                 request->rq_import = NULL;
2606         }
2607         if (request->rq_bulk)
2608                 ptlrpc_free_bulk(request->rq_bulk);
2609
2610         if (request->rq_reqbuf || request->rq_clrbuf)
2611                 sptlrpc_cli_free_reqbuf(request);
2612
2613         if (request->rq_cli_ctx)
2614                 sptlrpc_req_put_ctx(request, !locked);
2615
2616         if (request->rq_pool)
2617                 __ptlrpc_free_req_to_pool(request);
2618         else
2619                 ptlrpc_request_cache_free(request);
2620         EXIT;
2621 }
2622
2623 static int __ptlrpc_req_finished(struct ptlrpc_request *request, int locked);
2624 /**
2625  * Drop one request reference. Must be called with import imp_lock held.
2626  * When reference count drops to zero, request is freed.
2627  */
2628 void ptlrpc_req_finished_with_imp_lock(struct ptlrpc_request *request)
2629 {
2630         assert_spin_locked(&request->rq_import->imp_lock);
2631         (void)__ptlrpc_req_finished(request, 1);
2632 }
2633
2634 /**
2635  * Helper function
2636  * Drops one reference count for request \a request.
2637  * \a locked set indicates that caller holds import imp_lock.
2638  * Frees the request whe reference count reaches zero.
2639  *
2640  * \retval 1    the request is freed
2641  * \retval 0    some others still hold references on the request
2642  */
2643 static int __ptlrpc_req_finished(struct ptlrpc_request *request, int locked)
2644 {
2645         int count;
2646
2647         ENTRY;
2648         if (!request)
2649                 RETURN(1);
2650
2651         LASSERT(request != LP_POISON);
2652         LASSERT(request->rq_reqmsg != LP_POISON);
2653
2654         DEBUG_REQ(D_INFO, request, "refcount now %u",
2655                   atomic_read(&request->rq_refcount) - 1);
2656
2657         spin_lock(&request->rq_lock);
2658         count = atomic_dec_return(&request->rq_refcount);
2659         LASSERTF(count >= 0, "Invalid ref count %d\n", count);
2660
2661         /*
2662          * For open RPC, the client does not know the EA size (LOV, ACL, and
2663          * so on) before replied, then the client has to reserve very large
2664          * reply buffer. Such buffer will not be released until the RPC freed.
2665          * Since The open RPC is replayable, we need to keep it in the replay
2666          * list until close. If there are a lot of files opened concurrently,
2667          * then the client may be OOM.
2668          *
2669          * If fact, it is unnecessary to keep reply buffer for open replay,
2670          * related EAs have already been saved via mdc_save_lovea() before
2671          * coming here. So it is safe to free the reply buffer some earlier
2672          * before releasing the RPC to avoid client OOM. LU-9514
2673          */
2674         if (count == 1 && request->rq_early_free_repbuf && request->rq_repbuf) {
2675                 spin_lock(&request->rq_early_free_lock);
2676                 sptlrpc_cli_free_repbuf(request);
2677                 request->rq_repbuf = NULL;
2678                 request->rq_repbuf_len = 0;
2679                 request->rq_repdata = NULL;
2680                 request->rq_reqdata_len = 0;
2681                 spin_unlock(&request->rq_early_free_lock);
2682         }
2683         spin_unlock(&request->rq_lock);
2684
2685         if (!count)
2686                 __ptlrpc_free_req(request, locked);
2687
2688         RETURN(!count);
2689 }
2690
2691 /**
2692  * Drops one reference count for a request.
2693  */
2694 void ptlrpc_req_finished(struct ptlrpc_request *request)
2695 {
2696         __ptlrpc_req_finished(request, 0);
2697 }
2698 EXPORT_SYMBOL(ptlrpc_req_finished);
2699
2700 /**
2701  * Returns xid of a \a request
2702  */
2703 __u64 ptlrpc_req_xid(struct ptlrpc_request *request)
2704 {
2705         return request->rq_xid;
2706 }
2707 EXPORT_SYMBOL(ptlrpc_req_xid);
2708
2709 /**
2710  * Disengage the client's reply buffer from the network
2711  * NB does _NOT_ unregister any client-side bulk.
2712  * IDEMPOTENT, but _not_ safe against concurrent callers.
2713  * The request owner (i.e. the thread doing the I/O) must call...
2714  * Returns 0 on success or 1 if unregistering cannot be made.
2715  */
2716 static int ptlrpc_unregister_reply(struct ptlrpc_request *request, int async)
2717 {
2718         /*
2719          * Might sleep.
2720          */
2721         LASSERT(!in_interrupt());
2722
2723         /* Let's setup deadline for reply unlink. */
2724         if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK) &&
2725             async && request->rq_reply_deadline == 0 && cfs_fail_val == 0)
2726                 request->rq_reply_deadline = ktime_get_real_seconds() +
2727                                              PTLRPC_REQ_LONG_UNLINK;
2728
2729         /*
2730          * Nothing left to do.
2731          */
2732         if (!ptlrpc_client_recv_or_unlink(request))
2733                 RETURN(1);
2734
2735         LNetMDUnlink(request->rq_reply_md_h);
2736
2737         /*
2738          * Let's check it once again.
2739          */
2740         if (!ptlrpc_client_recv_or_unlink(request))
2741                 RETURN(1);
2742
2743         /* Move to "Unregistering" phase as reply was not unlinked yet. */
2744         ptlrpc_rqphase_move(request, RQ_PHASE_UNREG_RPC);
2745
2746         /*
2747          * Do not wait for unlink to finish.
2748          */
2749         if (async)
2750                 RETURN(0);
2751
2752         /*
2753          * We have to wait_event_idle_timeout() whatever the result, to get
2754          * a chance to run reply_in_callback(), and to make sure we've
2755          * unlinked before returning a req to the pool.
2756          */
2757         for (;;) {
2758                 wait_queue_head_t *wq = (request->rq_set) ?
2759                                         &request->rq_set->set_waitq :
2760                                         &request->rq_reply_waitq;
2761                 int seconds = PTLRPC_REQ_LONG_UNLINK;
2762                 /*
2763                  * Network access will complete in finite time but the HUGE
2764                  * timeout lets us CWARN for visibility of sluggish NALs
2765                  */
2766                 while (seconds > 0 &&
2767                        wait_event_idle_timeout(
2768                                *wq,
2769                                !ptlrpc_client_recv_or_unlink(request),
2770                                cfs_time_seconds(1)) == 0)
2771                         seconds -= 1;
2772                 if (seconds > 0) {
2773                         ptlrpc_rqphase_move(request, request->rq_next_phase);
2774                         RETURN(1);
2775                 }
2776
2777                 DEBUG_REQ(D_WARNING, request,
2778                           "Unexpectedly long timeout receiving_reply=%d req_ulinked=%d reply_unlinked=%d",
2779                           request->rq_receiving_reply,
2780                           request->rq_req_unlinked,
2781                           request->rq_reply_unlinked);
2782         }
2783         RETURN(0);
2784 }
2785
2786 static void ptlrpc_free_request(struct ptlrpc_request *req)
2787 {
2788         spin_lock(&req->rq_lock);
2789         req->rq_replay = 0;
2790         spin_unlock(&req->rq_lock);
2791
2792         if (req->rq_commit_cb)
2793                 req->rq_commit_cb(req);
2794         list_del_init(&req->rq_replay_list);
2795
2796         __ptlrpc_req_finished(req, 1);
2797 }
2798
2799 /**
2800  * the request is committed and dropped from the replay list of its import
2801  */
2802 void ptlrpc_request_committed(struct ptlrpc_request *req, int force)
2803 {
2804         struct obd_import *imp = req->rq_import;
2805
2806         spin_lock(&imp->imp_lock);
2807         if (list_empty(&req->rq_replay_list)) {
2808                 spin_unlock(&imp->imp_lock);
2809                 return;
2810         }
2811
2812         if (force || req->rq_transno <= imp->imp_peer_committed_transno) {
2813                 if (imp->imp_replay_cursor == &req->rq_replay_list)
2814                         imp->imp_replay_cursor = req->rq_replay_list.next;
2815                 ptlrpc_free_request(req);
2816         }
2817
2818         spin_unlock(&imp->imp_lock);
2819 }
2820 EXPORT_SYMBOL(ptlrpc_request_committed);
2821
2822 /**
2823  * Iterates through replay_list on import and prunes
2824  * all requests have transno smaller than last_committed for the
2825  * import and don't have rq_replay set.
2826  * Since requests are sorted in transno order, stops when meetign first
2827  * transno bigger than last_committed.
2828  * caller must hold imp->imp_lock
2829  */
2830 void ptlrpc_free_committed(struct obd_import *imp)
2831 {
2832         struct ptlrpc_request *req, *saved;
2833         struct ptlrpc_request *last_req = NULL; /* temporary fire escape */
2834         bool skip_committed_list = true;
2835
2836         ENTRY;
2837         LASSERT(imp != NULL);
2838         assert_spin_locked(&imp->imp_lock);
2839
2840         if (imp->imp_peer_committed_transno == imp->imp_last_transno_checked &&
2841             imp->imp_generation == imp->imp_last_generation_checked) {
2842                 CDEBUG(D_INFO, "%s: skip recheck: last_committed %llu\n",
2843                        imp->imp_obd->obd_name, imp->imp_peer_committed_transno);
2844                 RETURN_EXIT;
2845         }
2846         CDEBUG(D_RPCTRACE, "%s: committing for last_committed %llu gen %d\n",
2847                imp->imp_obd->obd_name, imp->imp_peer_committed_transno,
2848                imp->imp_generation);
2849
2850         if (imp->imp_generation != imp->imp_last_generation_checked ||
2851             imp->imp_last_transno_checked == 0)
2852                 skip_committed_list = false;
2853
2854         imp->imp_last_transno_checked = imp->imp_peer_committed_transno;
2855         imp->imp_last_generation_checked = imp->imp_generation;
2856
2857         list_for_each_entry_safe(req, saved, &imp->imp_replay_list,
2858                                  rq_replay_list) {
2859                 /* XXX ok to remove when 1357 resolved - rread 05/29/03  */
2860                 LASSERT(req != last_req);
2861                 last_req = req;
2862
2863                 if (req->rq_transno == 0) {
2864                         DEBUG_REQ(D_EMERG, req, "zero transno during replay");
2865                         LBUG();
2866                 }
2867                 if (req->rq_import_generation < imp->imp_generation) {
2868                         DEBUG_REQ(D_RPCTRACE, req, "free request with old gen");
2869                         GOTO(free_req, 0);
2870                 }
2871
2872                 /* not yet committed */
2873                 if (req->rq_transno > imp->imp_peer_committed_transno) {
2874                         DEBUG_REQ(D_RPCTRACE, req, "stopping search");
2875                         break;
2876                 }
2877
2878                 if (req->rq_replay) {
2879                         DEBUG_REQ(D_RPCTRACE, req, "keeping (FL_REPLAY)");
2880                         list_move_tail(&req->rq_replay_list,
2881                                        &imp->imp_committed_list);
2882                         continue;
2883                 }
2884
2885                 DEBUG_REQ(D_INFO, req, "commit (last_committed %llu)",
2886                           imp->imp_peer_committed_transno);
2887 free_req:
2888                 ptlrpc_free_request(req);
2889         }
2890
2891         if (skip_committed_list)
2892                 GOTO(out, 0);
2893
2894         list_for_each_entry_safe(req, saved, &imp->imp_committed_list,
2895                                  rq_replay_list) {
2896                 LASSERT(req->rq_transno != 0);
2897                 if (req->rq_import_generation < imp->imp_generation ||
2898                     !req->rq_replay) {
2899                         DEBUG_REQ(D_RPCTRACE, req, "free %s open request",
2900                                   req->rq_import_generation <
2901                                   imp->imp_generation ? "stale" : "closed");
2902
2903                         if (imp->imp_replay_cursor == &req->rq_replay_list)
2904                                 imp->imp_replay_cursor =
2905                                         req->rq_replay_list.next;
2906
2907                         ptlrpc_free_request(req);
2908                 }
2909         }
2910 out:
2911         EXIT;
2912 }
2913
2914 void ptlrpc_cleanup_client(struct obd_import *imp)
2915 {
2916         ENTRY;
2917         EXIT;
2918 }
2919
2920 /**
2921  * Schedule previously sent request for resend.
2922  * For bulk requests we assign new xid (to avoid problems with
2923  * lost replies and therefore several transfers landing into same buffer
2924  * from different sending attempts).
2925  */
2926 void ptlrpc_resend_req(struct ptlrpc_request *req)
2927 {
2928         DEBUG_REQ(D_HA, req, "going to resend");
2929         spin_lock(&req->rq_lock);
2930
2931         /*
2932          * Request got reply but linked to the import list still.
2933          * Let ptlrpc_check_set() process it.
2934          */
2935         if (ptlrpc_client_replied(req)) {
2936                 spin_unlock(&req->rq_lock);
2937                 DEBUG_REQ(D_HA, req, "it has reply, so skip it");
2938                 return;
2939         }
2940
2941         req->rq_status = -EAGAIN;
2942
2943         req->rq_resend = 1;
2944         req->rq_net_err = 0;
2945         req->rq_timedout = 0;
2946
2947         ptlrpc_client_wake_req(req);
2948         spin_unlock(&req->rq_lock);
2949 }
2950
2951 /* XXX: this function and rq_status are currently unused */
2952 void ptlrpc_restart_req(struct ptlrpc_request *req)
2953 {
2954         DEBUG_REQ(D_HA, req, "restarting (possibly-)completed request");
2955         req->rq_status = -ERESTARTSYS;
2956
2957         spin_lock(&req->rq_lock);
2958         req->rq_restart = 1;
2959         req->rq_timedout = 0;
2960         ptlrpc_client_wake_req(req);
2961         spin_unlock(&req->rq_lock);
2962 }
2963
2964 /**
2965  * Grab additional reference on a request \a req
2966  */
2967 struct ptlrpc_request *ptlrpc_request_addref(struct ptlrpc_request *req)
2968 {
2969         ENTRY;
2970         atomic_inc(&req->rq_refcount);
2971         RETURN(req);
2972 }
2973 EXPORT_SYMBOL(ptlrpc_request_addref);
2974
2975 /**
2976  * Add a request to import replay_list.
2977  * Must be called under imp_lock
2978  */
2979 void ptlrpc_retain_replayable_request(struct ptlrpc_request *req,
2980                                       struct obd_import *imp)
2981 {
2982         struct list_head *tmp;
2983
2984         assert_spin_locked(&imp->imp_lock);
2985
2986         if (req->rq_transno == 0) {
2987                 DEBUG_REQ(D_EMERG, req, "saving request with zero transno");
2988                 LBUG();
2989         }
2990
2991         /*
2992          * clear this for new requests that were resent as well
2993          * as resent replayed requests.
2994          */
2995         lustre_msg_clear_flags(req->rq_reqmsg, MSG_RESENT);
2996
2997         /* don't re-add requests that have been replayed */
2998         if (!list_empty(&req->rq_replay_list))
2999                 return;
3000
3001         lustre_msg_add_flags(req->rq_reqmsg, MSG_REPLAY);
3002
3003         spin_lock(&req->rq_lock);
3004         req->rq_resend = 0;
3005         spin_unlock(&req->rq_lock);
3006
3007         LASSERT(imp->imp_replayable);
3008         /* Balanced in ptlrpc_free_committed, usually. */
3009         ptlrpc_request_addref(req);
3010         list_for_each_prev(tmp, &imp->imp_replay_list) {
3011                 struct ptlrpc_request *iter = list_entry(tmp,
3012                                                          struct ptlrpc_request,
3013                                                          rq_replay_list);
3014
3015                 /*
3016                  * We may have duplicate transnos if we create and then
3017                  * open a file, or for closes retained if to match creating
3018                  * opens, so use req->rq_xid as a secondary key.
3019                  * (See bugs 684, 685, and 428.)
3020                  * XXX no longer needed, but all opens need transnos!
3021                  */
3022                 if (iter->rq_transno > req->rq_transno)
3023                         continue;
3024
3025                 if (iter->rq_transno == req->rq_transno) {
3026                         LASSERT(iter->rq_xid != req->rq_xid);
3027                         if (iter->rq_xid > req->rq_xid)
3028                                 continue;
3029                 }
3030
3031                 list_add(&req->rq_replay_list, &iter->rq_replay_list);
3032                 return;
3033         }
3034
3035         list_add(&req->rq_replay_list, &imp->imp_replay_list);
3036 }
3037
3038 /**
3039  * Send request and wait until it completes.
3040  * Returns request processing status.
3041  */
3042 int ptlrpc_queue_wait(struct ptlrpc_request *req)
3043 {
3044         struct ptlrpc_request_set *set;
3045         int rc;
3046
3047         ENTRY;
3048         LASSERT(req->rq_set == NULL);
3049         LASSERT(!req->rq_receiving_reply);
3050
3051         set = ptlrpc_prep_set();
3052         if (!set) {
3053                 CERROR("cannot allocate ptlrpc set: rc = %d\n", -ENOMEM);
3054                 RETURN(-ENOMEM);
3055         }
3056
3057         /* for distributed debugging */
3058         lustre_msg_set_status(req->rq_reqmsg, current->pid);
3059
3060         /* add a ref for the set (see comment in ptlrpc_set_add_req) */
3061         ptlrpc_request_addref(req);
3062         ptlrpc_set_add_req(set, req);
3063         rc = ptlrpc_set_wait(NULL, set);
3064         ptlrpc_set_destroy(set);
3065
3066         RETURN(rc);
3067 }
3068 EXPORT_SYMBOL(ptlrpc_queue_wait);
3069
3070 /**
3071  * Callback used for replayed requests reply processing.
3072  * In case of successful reply calls registered request replay callback.
3073  * In case of error restart replay process.
3074  */
3075 static int ptlrpc_replay_interpret(const struct lu_env *env,
3076                                    struct ptlrpc_request *req,
3077                                    void *args, int rc)
3078 {
3079         struct ptlrpc_replay_async_args *aa = args;
3080         struct obd_import *imp = req->rq_import;
3081
3082         ENTRY;
3083         atomic_dec(&imp->imp_replay_inflight);
3084
3085         /*
3086          * Note: if it is bulk replay (MDS-MDS replay), then even if
3087          * server got the request, but bulk transfer timeout, let's
3088          * replay the bulk req again
3089          */
3090         if (!ptlrpc_client_replied(req) ||
3091             (req->rq_bulk &&
3092              lustre_msg_get_status(req->rq_repmsg) == -ETIMEDOUT)) {
3093                 DEBUG_REQ(D_ERROR, req, "request replay timed out");
3094                 GOTO(out, rc = -ETIMEDOUT);
3095         }
3096
3097         if (lustre_msg_get_type(req->rq_repmsg) == PTL_RPC_MSG_ERR &&
3098             (lustre_msg_get_status(req->rq_repmsg) == -ENOTCONN ||
3099             lustre_msg_get_status(req->rq_repmsg) == -ENODEV))
3100                 GOTO(out, rc = lustre_msg_get_status(req->rq_repmsg));
3101
3102         /** VBR: check version failure */
3103         if (lustre_msg_get_status(req->rq_repmsg) == -EOVERFLOW) {
3104                 /** replay was failed due to version mismatch */
3105                 DEBUG_REQ(D_WARNING, req, "Version mismatch during replay");
3106                 spin_lock(&imp->imp_lock);
3107                 imp->imp_vbr_failed = 1;
3108                 spin_unlock(&imp->imp_lock);
3109                 lustre_msg_set_status(req->rq_repmsg, aa->praa_old_status);
3110         } else {
3111                 /** The transno had better not change over replay. */
3112                 LASSERTF(lustre_msg_get_transno(req->rq_reqmsg) ==
3113                          lustre_msg_get_transno(req->rq_repmsg) ||
3114                          lustre_msg_get_transno(req->rq_repmsg) == 0,
3115                          "%#llx/%#llx\n",
3116                          lustre_msg_get_transno(req->rq_reqmsg),
3117                          lustre_msg_get_transno(req->rq_repmsg));
3118         }
3119
3120         spin_lock(&imp->imp_lock);
3121         imp->imp_last_replay_transno = lustre_msg_get_transno(req->rq_reqmsg);
3122         spin_unlock(&imp->imp_lock);
3123         LASSERT(imp->imp_last_replay_transno);
3124
3125         /* transaction number shouldn't be bigger than the latest replayed */
3126         if (req->rq_transno > lustre_msg_get_transno(req->rq_reqmsg)) {
3127                 DEBUG_REQ(D_ERROR, req,
3128                           "Reported transno=%llu is bigger than replayed=%llu",
3129                           req->rq_transno,
3130                           lustre_msg_get_transno(req->rq_reqmsg));
3131                 GOTO(out, rc = -EINVAL);
3132         }
3133
3134         DEBUG_REQ(D_HA, req, "got reply");
3135
3136         /* let the callback do fixups, possibly including in the request */
3137         if (req->rq_replay_cb)
3138                 req->rq_replay_cb(req);
3139
3140         if (ptlrpc_client_replied(req) &&
3141             lustre_msg_get_status(req->rq_repmsg) != aa->praa_old_status) {
3142                 DEBUG_REQ(D_ERROR, req, "status %d, old was %d",
3143                           lustre_msg_get_status(req->rq_repmsg),
3144                           aa->praa_old_status);
3145
3146                 /*
3147                  * Note: If the replay fails for MDT-MDT recovery, let's
3148                  * abort all of the following requests in the replay
3149                  * and sending list, because MDT-MDT update requests
3150                  * are dependent on each other, see LU-7039
3151                  */
3152                 if (imp->imp_connect_flags_orig & OBD_CONNECT_MDS_MDS) {
3153                         struct ptlrpc_request *free_req;
3154                         struct ptlrpc_request *tmp;
3155
3156                         spin_lock(&imp->imp_lock);
3157                         list_for_each_entry_safe(free_req, tmp,
3158                                                  &imp->imp_replay_list,
3159                                                  rq_replay_list) {
3160                                 ptlrpc_free_request(free_req);
3161                         }
3162
3163                         list_for_each_entry_safe(free_req, tmp,
3164                                                  &imp->imp_committed_list,
3165                                                  rq_replay_list) {
3166                                 ptlrpc_free_request(free_req);
3167                         }
3168
3169                         list_for_each_entry_safe(free_req, tmp,
3170                                                  &imp->imp_delayed_list,
3171                                                  rq_list) {
3172                                 spin_lock(&free_req->rq_lock);
3173                                 free_req->rq_err = 1;
3174                                 free_req->rq_status = -EIO;
3175                                 ptlrpc_client_wake_req(free_req);
3176                                 spin_unlock(&free_req->rq_lock);
3177                         }
3178
3179                         list_for_each_entry_safe(free_req, tmp,
3180                                                  &imp->imp_sending_list,
3181                                                  rq_list) {
3182                                 spin_lock(&free_req->rq_lock);
3183                                 free_req->rq_err = 1;
3184                                 free_req->rq_status = -EIO;
3185                                 ptlrpc_client_wake_req(free_req);
3186                                 spin_unlock(&free_req->rq_lock);
3187                         }
3188                         spin_unlock(&imp->imp_lock);
3189                 }
3190         } else {
3191                 /* Put it back for re-replay. */
3192                 lustre_msg_set_status(req->rq_repmsg, aa->praa_old_status);
3193         }
3194
3195         /*
3196          * Errors while replay can set transno to 0, but
3197          * imp_last_replay_transno shouldn't be set to 0 anyway
3198          */
3199         if (req->rq_transno == 0)
3200                 CERROR("Transno is 0 during replay!\n");
3201
3202         /* continue with recovery */
3203         rc = ptlrpc_import_recovery_state_machine(imp);
3204  out:
3205         req->rq_send_state = aa->praa_old_state;
3206
3207         if (rc != 0)
3208                 /* this replay failed, so restart recovery */
3209                 ptlrpc_connect_import(imp);
3210
3211         RETURN(rc);
3212 }
3213
3214 /**
3215  * Prepares and queues request for replay.
3216  * Adds it to ptlrpcd queue for actual sending.
3217  * Returns 0 on success.
3218  */
3219 int ptlrpc_replay_req(struct ptlrpc_request *req)
3220 {
3221         struct ptlrpc_replay_async_args *aa;
3222
3223         ENTRY;
3224
3225         LASSERT(req->rq_import->imp_state == LUSTRE_IMP_REPLAY);
3226
3227         aa = ptlrpc_req_async_args(aa, req);
3228         memset(aa, 0, sizeof(*aa));
3229
3230         /* Prepare request to be resent with ptlrpcd */
3231         aa->praa_old_state = req->rq_send_state;
3232         req->rq_send_state = LUSTRE_IMP_REPLAY;
3233         req->rq_phase = RQ_PHASE_NEW;
3234         req->rq_next_phase = RQ_PHASE_UNDEFINED;
3235         if (req->rq_repmsg)
3236                 aa->praa_old_status = lustre_msg_get_status(req->rq_repmsg);
3237         req->rq_status = 0;
3238         req->rq_interpret_reply = ptlrpc_replay_interpret;
3239         /* Readjust the timeout for current conditions */
3240         ptlrpc_at_set_req_timeout(req);
3241
3242         /* Tell server net_latency to calculate how long to wait for reply. */
3243         lustre_msg_set_service_timeout(req->rq_reqmsg,
3244                                        ptlrpc_at_get_net_latency(req));
3245         DEBUG_REQ(D_HA, req, "REPLAY");
3246
3247         atomic_inc(&req->rq_import->imp_replay_inflight);
3248         spin_lock(&req->rq_lock);
3249         req->rq_early_free_repbuf = 0;
3250         spin_unlock(&req->rq_lock);
3251         ptlrpc_request_addref(req); /* ptlrpcd needs a ref */
3252
3253         ptlrpcd_add_req(req);
3254         RETURN(0);
3255 }
3256
3257 /**
3258  * Aborts all in-flight request on import \a imp sending and delayed lists
3259  */
3260 void ptlrpc_abort_inflight(struct obd_import *imp)
3261 {
3262         struct list_head *tmp, *n;
3263         ENTRY;
3264
3265         /*
3266          * Make sure that no new requests get processed for this import.
3267          * ptlrpc_{queue,set}_wait must (and does) hold imp_lock while testing
3268          * this flag and then putting requests on sending_list or delayed_list.
3269          */
3270         assert_spin_locked(&imp->imp_lock);
3271
3272         /*
3273          * XXX locking?  Maybe we should remove each request with the list
3274          * locked?  Also, how do we know if the requests on the list are
3275          * being freed at this time?
3276          */
3277         list_for_each_safe(tmp, n, &imp->imp_sending_list) {
3278                 struct ptlrpc_request *req = list_entry(tmp,
3279                                                         struct ptlrpc_request,
3280                                                         rq_list);
3281
3282                 DEBUG_REQ(D_RPCTRACE, req, "inflight");
3283
3284                 spin_lock(&req->rq_lock);
3285                 if (req->rq_import_generation < imp->imp_generation) {
3286                         req->rq_err = 1;
3287                         req->rq_status = -EIO;
3288                         ptlrpc_client_wake_req(req);
3289                 }
3290                 spin_unlock(&req->rq_lock);
3291         }
3292
3293         list_for_each_safe(tmp, n, &imp->imp_delayed_list) {
3294                 struct ptlrpc_request *req =
3295                         list_entry(tmp, struct ptlrpc_request, rq_list);
3296
3297                 DEBUG_REQ(D_RPCTRACE, req, "aborting waiting req");
3298
3299                 spin_lock(&req->rq_lock);
3300                 if (req->rq_import_generation < imp->imp_generation) {
3301                         req->rq_err = 1;
3302                         req->rq_status = -EIO;
3303                         ptlrpc_client_wake_req(req);
3304                 }
3305                 spin_unlock(&req->rq_lock);
3306         }
3307
3308         /*
3309          * Last chance to free reqs left on the replay list, but we
3310          * will still leak reqs that haven't committed.
3311          */
3312         if (imp->imp_replayable)
3313                 ptlrpc_free_committed(imp);
3314
3315         EXIT;
3316 }
3317
3318 /**
3319  * Abort all uncompleted requests in request set \a set
3320  */
3321 void ptlrpc_abort_set(struct ptlrpc_request_set *set)
3322 {
3323         struct list_head *tmp, *pos;
3324
3325         LASSERT(set != NULL);
3326
3327         list_for_each_safe(pos, tmp, &set->set_requests) {
3328                 struct ptlrpc_request *req =
3329                         list_entry(pos, struct ptlrpc_request,
3330                                    rq_set_chain);
3331
3332                 spin_lock(&req->rq_lock);
3333                 if (req->rq_phase != RQ_PHASE_RPC) {
3334                         spin_unlock(&req->rq_lock);
3335                         continue;
3336                 }
3337
3338                 req->rq_err = 1;
3339                 req->rq_status = -EINTR;
3340                 ptlrpc_client_wake_req(req);
3341                 spin_unlock(&req->rq_lock);
3342         }
3343 }
3344
3345 /**
3346  * Initialize the XID for the node.  This is common among all requests on
3347  * this node, and only requires the property that it is monotonically
3348  * increasing.  It does not need to be sequential.  Since this is also used
3349  * as the RDMA match bits, it is important that a single client NOT have
3350  * the same match bits for two different in-flight requests, hence we do
3351  * NOT want to have an XID per target or similar.
3352  *
3353  * To avoid an unlikely collision between match bits after a client reboot
3354  * (which would deliver old data into the wrong RDMA buffer) initialize
3355  * the XID based on the current time, assuming a maximum RPC rate of 1M RPC/s.
3356  * If the time is clearly incorrect, we instead use a 62-bit random number.
3357  * In the worst case the random number will overflow 1M RPCs per second in
3358  * 9133 years, or permutations thereof.
3359  */
3360 #define YEAR_2004 (1ULL << 30)
3361 void ptlrpc_init_xid(void)
3362 {
3363         time64_t now = ktime_get_real_seconds();
3364         u64 xid;
3365
3366         if (now < YEAR_2004) {
3367                 get_random_bytes(&xid, sizeof(xid));
3368                 xid >>= 2;
3369                 xid |= (1ULL << 61);
3370         } else {
3371                 xid = (u64)now << 20;
3372         }
3373
3374         /* Need to always be aligned to a power-of-two for mutli-bulk BRW */
3375         BUILD_BUG_ON((PTLRPC_BULK_OPS_COUNT & (PTLRPC_BULK_OPS_COUNT - 1)) !=
3376                      0);
3377         xid &= PTLRPC_BULK_OPS_MASK;
3378         atomic64_set(&ptlrpc_last_xid, xid);
3379 }
3380
3381 /**
3382  * Increase xid and returns resulting new value to the caller.
3383  *
3384  * Multi-bulk BRW RPCs consume multiple XIDs for each bulk transfer, starting
3385  * at the returned xid, up to xid + PTLRPC_BULK_OPS_COUNT - 1. The BRW RPC
3386  * itself uses the last bulk xid needed, so the server can determine the
3387  * the number of bulk transfers from the RPC XID and a bitmask.  The starting
3388  * xid must align to a power-of-two value.
3389  *
3390  * This is assumed to be true due to the initial ptlrpc_last_xid
3391  * value also being initialized to a power-of-two value. LU-1431
3392  */
3393 __u64 ptlrpc_next_xid(void)
3394 {
3395         return atomic64_add_return(PTLRPC_BULK_OPS_COUNT, &ptlrpc_last_xid);
3396 }
3397
3398 /**
3399  * If request has a new allocated XID (new request or EINPROGRESS resend),
3400  * use this XID as matchbits of bulk, otherwise allocate a new matchbits for
3401  * request to ensure previous bulk fails and avoid problems with lost replies
3402  * and therefore several transfers landing into the same buffer from different
3403  * sending attempts.
3404  */
3405 void ptlrpc_set_bulk_mbits(struct ptlrpc_request *req)
3406 {
3407         struct ptlrpc_bulk_desc *bd = req->rq_bulk;
3408
3409         LASSERT(bd != NULL);
3410
3411         /*
3412          * Generate new matchbits for all resend requests, including
3413          * resend replay.
3414          */
3415         if (req->rq_resend) {
3416                 __u64 old_mbits = req->rq_mbits;
3417
3418                 /*
3419                  * First time resend on -EINPROGRESS will generate new xid,
3420                  * so we can actually use the rq_xid as rq_mbits in such case,
3421                  * however, it's bit hard to distinguish such resend with a
3422                  * 'resend for the -EINPROGRESS resend'. To make it simple,
3423                  * we opt to generate mbits for all resend cases.
3424                  */
3425                 if (OCD_HAS_FLAG(&bd->bd_import->imp_connect_data,
3426                                  BULK_MBITS)) {
3427                         req->rq_mbits = ptlrpc_next_xid();
3428                 } else {
3429                         /*
3430                          * Old version transfers rq_xid to peer as
3431                          * matchbits.
3432                          */
3433                         spin_lock(&req->rq_import->imp_lock);
3434                         list_del_init(&req->rq_unreplied_list);
3435                         ptlrpc_assign_next_xid_nolock(req);
3436                         spin_unlock(&req->rq_import->imp_lock);
3437                         req->rq_mbits = req->rq_xid;
3438                 }
3439                 CDEBUG(D_HA, "resend bulk old x%llu new x%llu\n",
3440                        old_mbits, req->rq_mbits);
3441         } else if (!(lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY)) {
3442                 /* Request being sent first time, use xid as matchbits. */
3443                 if (OCD_HAS_FLAG(&bd->bd_import->imp_connect_data, BULK_MBITS)
3444                     || req->rq_mbits == 0) {
3445                         req->rq_mbits = req->rq_xid;
3446                 } else {
3447                         int total_md = (bd->bd_iov_count + LNET_MAX_IOV - 1) /
3448                                         LNET_MAX_IOV;
3449                         req->rq_mbits -= total_md - 1;
3450                 }
3451         } else {
3452                 /*
3453                  * Replay request, xid and matchbits have already been
3454                  * correctly assigned.
3455                  */
3456                 return;
3457         }
3458
3459         /*
3460          * For multi-bulk RPCs, rq_mbits is the last mbits needed for bulks so
3461          * that server can infer the number of bulks that were prepared,
3462          * see LU-1431
3463          */
3464         req->rq_mbits += ((bd->bd_iov_count + LNET_MAX_IOV - 1) /
3465                           LNET_MAX_IOV) - 1;
3466
3467         /*
3468          * Set rq_xid as rq_mbits to indicate the final bulk for the old
3469          * server which does not support OBD_CONNECT_BULK_MBITS. LU-6808.
3470          *
3471          * It's ok to directly set the rq_xid here, since this xid bump
3472          * won't affect the request position in unreplied list.
3473          */
3474         if (!OCD_HAS_FLAG(&bd->bd_import->imp_connect_data, BULK_MBITS))
3475                 req->rq_xid = req->rq_mbits;
3476 }
3477
3478 /**
3479  * Get a glimpse at what next xid value might have been.
3480  * Returns possible next xid.
3481  */
3482 __u64 ptlrpc_sample_next_xid(void)
3483 {
3484         return atomic64_read(&ptlrpc_last_xid) + PTLRPC_BULK_OPS_COUNT;
3485 }
3486 EXPORT_SYMBOL(ptlrpc_sample_next_xid);
3487
3488 /**
3489  * Functions for operating ptlrpc workers.
3490  *
3491  * A ptlrpc work is a function which will be running inside ptlrpc context.
3492  * The callback shouldn't sleep otherwise it will block that ptlrpcd thread.
3493  *
3494  * 1. after a work is created, it can be used many times, that is:
3495  *         handler = ptlrpcd_alloc_work();
3496  *         ptlrpcd_queue_work();
3497  *
3498  *    queue it again when necessary:
3499  *         ptlrpcd_queue_work();
3500  *         ptlrpcd_destroy_work();
3501  * 2. ptlrpcd_queue_work() can be called by multiple processes meanwhile, but
3502  *    it will only be queued once in any time. Also as its name implies, it may
3503  *    have delay before it really runs by ptlrpcd thread.
3504  */
3505 struct ptlrpc_work_async_args {
3506         int (*cb)(const struct lu_env *, void *);
3507         void *cbdata;
3508 };
3509
3510 static void ptlrpcd_add_work_req(struct ptlrpc_request *req)
3511 {
3512         /* re-initialize the req */
3513         req->rq_timeout         = obd_timeout;
3514         req->rq_sent            = ktime_get_real_seconds();
3515         req->rq_deadline        = req->rq_sent + req->rq_timeout;
3516         req->rq_phase           = RQ_PHASE_INTERPRET;
3517         req->rq_next_phase      = RQ_PHASE_COMPLETE;
3518         req->rq_xid             = ptlrpc_next_xid();
3519         req->rq_import_generation = req->rq_import->imp_generation;
3520
3521         ptlrpcd_add_req(req);
3522 }
3523
3524 static int work_interpreter(const struct lu_env *env,
3525                             struct ptlrpc_request *req, void *args, int rc)
3526 {
3527         struct ptlrpc_work_async_args *arg = args;
3528
3529         LASSERT(ptlrpcd_check_work(req));
3530         LASSERT(arg->cb != NULL);
3531
3532         rc = arg->cb(env, arg->cbdata);
3533
3534         list_del_init(&req->rq_set_chain);
3535         req->rq_set = NULL;
3536
3537         if (atomic_dec_return(&req->rq_refcount) > 1) {
3538                 atomic_set(&req->rq_refcount, 2);
3539                 ptlrpcd_add_work_req(req);
3540         }
3541         return rc;
3542 }
3543
3544 static int worker_format;
3545
3546 static int ptlrpcd_check_work(struct ptlrpc_request *req)
3547 {
3548         return req->rq_pill.rc_fmt == (void *)&worker_format;
3549 }
3550
3551 /**
3552  * Create a work for ptlrpc.
3553  */
3554 void *ptlrpcd_alloc_work(struct obd_import *imp,
3555                          int (*cb)(const struct lu_env *, void *), void *cbdata)
3556 {
3557         struct ptlrpc_request *req = NULL;
3558         struct ptlrpc_work_async_args *args;
3559
3560         ENTRY;
3561         might_sleep();
3562
3563         if (!cb)
3564                 RETURN(ERR_PTR(-EINVAL));
3565
3566         /* copy some code from deprecated fakereq. */
3567         req = ptlrpc_request_cache_alloc(GFP_NOFS);
3568         if (!req) {
3569                 CERROR("ptlrpc: run out of memory!\n");
3570                 RETURN(ERR_PTR(-ENOMEM));
3571         }
3572
3573         ptlrpc_cli_req_init(req);
3574
3575         req->rq_send_state = LUSTRE_IMP_FULL;
3576         req->rq_type = PTL_RPC_MSG_REQUEST;
3577         req->rq_import = class_import_get(imp);
3578         req->rq_interpret_reply = work_interpreter;
3579         /* don't want reply */
3580         req->rq_no_delay = req->rq_no_resend = 1;
3581         req->rq_pill.rc_fmt = (void *)&worker_format;
3582
3583         args = ptlrpc_req_async_args(args, req);
3584         args->cb     = cb;
3585         args->cbdata = cbdata;
3586
3587         RETURN(req);
3588 }
3589 EXPORT_SYMBOL(ptlrpcd_alloc_work);
3590
3591 void ptlrpcd_destroy_work(void *handler)
3592 {
3593         struct ptlrpc_request *req = handler;
3594
3595         if (req)
3596                 ptlrpc_req_finished(req);
3597 }
3598 EXPORT_SYMBOL(ptlrpcd_destroy_work);
3599
3600 int ptlrpcd_queue_work(void *handler)
3601 {
3602         struct ptlrpc_request *req = handler;
3603
3604         /*
3605          * Check if the req is already being queued.
3606          *
3607          * Here comes a trick: it lacks a way of checking if a req is being
3608          * processed reliably in ptlrpc. Here I have to use refcount of req
3609          * for this purpose. This is okay because the caller should use this
3610          * req as opaque data. - Jinshan
3611          */
3612         LASSERT(atomic_read(&req->rq_refcount) > 0);
3613         if (atomic_inc_return(&req->rq_refcount) == 2)
3614                 ptlrpcd_add_work_req(req);
3615         return 0;
3616 }
3617 EXPORT_SYMBOL(ptlrpcd_queue_work);