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