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