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