Whamcloud - gitweb
LU-12222 lnet: Introduce constant for the lolnd NID
[fs/lustre-release.git] / lnet / lnet / lib-msg.c
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License version 2 for more details (a copy is included
14  * in the LICENSE file that accompanied this code).
15  *
16  * You should have received a copy of the GNU General Public License
17  * version 2 along with this program; If not, see
18  * http://www.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2012, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  * Lustre is a trademark of Sun Microsystems, Inc.
31  *
32  * lnet/lnet/lib-msg.c
33  *
34  * Message decoding, parsing and finalizing routines
35  */
36
37 #define DEBUG_SUBSYSTEM S_LNET
38
39 #include <lnet/lib-lnet.h>
40
41 void
42 lnet_build_unlink_event(struct lnet_libmd *md, struct lnet_event *ev)
43 {
44         ENTRY;
45
46         memset(ev, 0, sizeof(*ev));
47
48         ev->status   = 0;
49         ev->unlinked = 1;
50         ev->type     = LNET_EVENT_UNLINK;
51         lnet_md_deconstruct(md, ev);
52         lnet_md2handle(&ev->md_handle, md);
53         EXIT;
54 }
55
56 /*
57  * Don't need any lock, must be called after lnet_commit_md
58  */
59 void
60 lnet_build_msg_event(struct lnet_msg *msg, enum lnet_event_kind ev_type)
61 {
62         struct lnet_hdr *hdr = &msg->msg_hdr;
63         struct lnet_event *ev = &msg->msg_ev;
64
65         LASSERT(!msg->msg_routing);
66
67         ev->type = ev_type;
68         ev->msg_type = msg->msg_type;
69
70         if (ev_type == LNET_EVENT_SEND) {
71                 /* event for active message */
72                 ev->target.nid    = le64_to_cpu(hdr->dest_nid);
73                 ev->target.pid    = le32_to_cpu(hdr->dest_pid);
74                 ev->initiator.nid = LNET_NID_ANY;
75                 ev->initiator.pid = the_lnet.ln_pid;
76                 ev->source.nid    = LNET_NID_ANY;
77                 ev->source.pid    = the_lnet.ln_pid;
78                 ev->sender        = LNET_NID_ANY;
79         } else {
80                 /* event for passive message */
81                 ev->target.pid    = hdr->dest_pid;
82                 ev->target.nid    = hdr->dest_nid;
83                 ev->initiator.pid = hdr->src_pid;
84                 /* Multi-Rail: resolve src_nid to "primary" peer NID */
85                 ev->initiator.nid = msg->msg_initiator;
86                 /* Multi-Rail: track source NID. */
87                 ev->source.pid    = hdr->src_pid;
88                 ev->source.nid    = hdr->src_nid;
89                 ev->rlength       = hdr->payload_length;
90                 ev->sender        = msg->msg_from;
91                 ev->mlength       = msg->msg_wanted;
92                 ev->offset        = msg->msg_offset;
93         }
94
95         switch (ev_type) {
96         default:
97                 LBUG();
98
99         case LNET_EVENT_PUT: /* passive PUT */
100                 ev->pt_index   = hdr->msg.put.ptl_index;
101                 ev->match_bits = hdr->msg.put.match_bits;
102                 ev->hdr_data   = hdr->msg.put.hdr_data;
103                 return;
104
105         case LNET_EVENT_GET: /* passive GET */
106                 ev->pt_index   = hdr->msg.get.ptl_index;
107                 ev->match_bits = hdr->msg.get.match_bits;
108                 ev->hdr_data   = 0;
109                 return;
110
111         case LNET_EVENT_ACK: /* ACK */
112                 ev->match_bits = hdr->msg.ack.match_bits;
113                 ev->mlength    = hdr->msg.ack.mlength;
114                 return;
115
116         case LNET_EVENT_REPLY: /* REPLY */
117                 return;
118
119         case LNET_EVENT_SEND: /* active message */
120                 if (msg->msg_type == LNET_MSG_PUT) {
121                         ev->pt_index   = le32_to_cpu(hdr->msg.put.ptl_index);
122                         ev->match_bits = le64_to_cpu(hdr->msg.put.match_bits);
123                         ev->offset     = le32_to_cpu(hdr->msg.put.offset);
124                         ev->mlength    =
125                         ev->rlength    = le32_to_cpu(hdr->payload_length);
126                         ev->hdr_data   = le64_to_cpu(hdr->msg.put.hdr_data);
127
128                 } else {
129                         LASSERT(msg->msg_type == LNET_MSG_GET);
130                         ev->pt_index   = le32_to_cpu(hdr->msg.get.ptl_index);
131                         ev->match_bits = le64_to_cpu(hdr->msg.get.match_bits);
132                         ev->mlength    =
133                         ev->rlength    = le32_to_cpu(hdr->msg.get.sink_length);
134                         ev->offset     = le32_to_cpu(hdr->msg.get.src_offset);
135                         ev->hdr_data   = 0;
136                 }
137                 return;
138         }
139 }
140
141 void
142 lnet_msg_commit(struct lnet_msg *msg, int cpt)
143 {
144         struct lnet_msg_container *container = the_lnet.ln_msg_containers[cpt];
145         struct lnet_counters_common *common;
146         s64 timeout_ns;
147
148         /* set the message deadline */
149         timeout_ns = lnet_transaction_timeout * NSEC_PER_SEC;
150         msg->msg_deadline = ktime_add_ns(ktime_get(), timeout_ns);
151
152         /* routed message can be committed for both receiving and sending */
153         LASSERT(!msg->msg_tx_committed);
154
155         if (msg->msg_sending) {
156                 LASSERT(!msg->msg_receiving);
157                 msg->msg_tx_cpt = cpt;
158                 msg->msg_tx_committed = 1;
159                 if (msg->msg_rx_committed) { /* routed message REPLY */
160                         LASSERT(msg->msg_onactivelist);
161                         return;
162                 }
163         } else {
164                 LASSERT(!msg->msg_sending);
165                 msg->msg_rx_cpt = cpt;
166                 msg->msg_rx_committed = 1;
167         }
168
169         LASSERT(!msg->msg_onactivelist);
170
171         msg->msg_onactivelist = 1;
172         list_add_tail(&msg->msg_activelist, &container->msc_active);
173
174         common = &the_lnet.ln_counters[cpt]->lct_common;
175         common->lcc_msgs_alloc++;
176         if (common->lcc_msgs_alloc > common->lcc_msgs_max)
177                 common->lcc_msgs_max = common->lcc_msgs_alloc;
178 }
179
180 static void
181 lnet_msg_decommit_tx(struct lnet_msg *msg, int status)
182 {
183         struct lnet_counters_common *common;
184         struct lnet_event *ev = &msg->msg_ev;
185
186         LASSERT(msg->msg_tx_committed);
187         if (status != 0)
188                 goto out;
189
190         common = &(the_lnet.ln_counters[msg->msg_tx_cpt]->lct_common);
191         switch (ev->type) {
192         default: /* routed message */
193                 LASSERT(msg->msg_routing);
194                 LASSERT(msg->msg_rx_committed);
195                 LASSERT(ev->type == 0);
196
197                 common->lcc_route_length += msg->msg_len;
198                 common->lcc_route_count++;
199                 goto incr_stats;
200
201         case LNET_EVENT_PUT:
202                 /* should have been decommitted */
203                 LASSERT(!msg->msg_rx_committed);
204                 /* overwritten while sending ACK */
205                 LASSERT(msg->msg_type == LNET_MSG_ACK);
206                 msg->msg_type = LNET_MSG_PUT; /* fix type */
207                 break;
208
209         case LNET_EVENT_SEND:
210                 LASSERT(!msg->msg_rx_committed);
211                 if (msg->msg_type == LNET_MSG_PUT)
212                         common->lcc_send_length += msg->msg_len;
213                 break;
214
215         case LNET_EVENT_GET:
216                 LASSERT(msg->msg_rx_committed);
217                 /* overwritten while sending reply, we should never be
218                  * here for optimized GET */
219                 LASSERT(msg->msg_type == LNET_MSG_REPLY);
220                 msg->msg_type = LNET_MSG_GET; /* fix type */
221                 break;
222         }
223
224         common->lcc_send_count++;
225
226 incr_stats:
227         if (msg->msg_txpeer)
228                 lnet_incr_stats(&msg->msg_txpeer->lpni_stats,
229                                 msg->msg_type,
230                                 LNET_STATS_TYPE_SEND);
231         if (msg->msg_txni)
232                 lnet_incr_stats(&msg->msg_txni->ni_stats,
233                                 msg->msg_type,
234                                 LNET_STATS_TYPE_SEND);
235  out:
236         lnet_return_tx_credits_locked(msg);
237         msg->msg_tx_committed = 0;
238 }
239
240 static void
241 lnet_msg_decommit_rx(struct lnet_msg *msg, int status)
242 {
243         struct lnet_counters_common *common;
244         struct lnet_event *ev = &msg->msg_ev;
245
246         LASSERT(!msg->msg_tx_committed); /* decommitted or never committed */
247         LASSERT(msg->msg_rx_committed);
248
249         if (status != 0)
250                 goto out;
251
252         common = &(the_lnet.ln_counters[msg->msg_rx_cpt]->lct_common);
253         switch (ev->type) {
254         default:
255                 LASSERT(ev->type == 0);
256                 LASSERT(msg->msg_routing);
257                 goto incr_stats;
258
259         case LNET_EVENT_ACK:
260                 LASSERT(msg->msg_type == LNET_MSG_ACK);
261                 break;
262
263         case LNET_EVENT_GET:
264                 /* type is "REPLY" if it's an optimized GET on passive side,
265                  * because optimized GET will never be committed for sending,
266                  * so message type wouldn't be changed back to "GET" by
267                  * lnet_msg_decommit_tx(), see details in lnet_parse_get() */
268                 LASSERT(msg->msg_type == LNET_MSG_REPLY ||
269                         msg->msg_type == LNET_MSG_GET);
270                 common->lcc_send_length += msg->msg_wanted;
271                 break;
272
273         case LNET_EVENT_PUT:
274                 LASSERT(msg->msg_type == LNET_MSG_PUT);
275                 break;
276
277         case LNET_EVENT_REPLY:
278                 /* type is "GET" if it's an optimized GET on active side,
279                  * see details in lnet_create_reply_msg() */
280                 LASSERT(msg->msg_type == LNET_MSG_GET ||
281                         msg->msg_type == LNET_MSG_REPLY);
282                 break;
283         }
284
285         common->lcc_recv_count++;
286
287 incr_stats:
288         if (msg->msg_rxpeer)
289                 lnet_incr_stats(&msg->msg_rxpeer->lpni_stats,
290                                 msg->msg_type,
291                                 LNET_STATS_TYPE_RECV);
292         if (msg->msg_rxni)
293                 lnet_incr_stats(&msg->msg_rxni->ni_stats,
294                                 msg->msg_type,
295                                 LNET_STATS_TYPE_RECV);
296         if (ev->type == LNET_EVENT_PUT || ev->type == LNET_EVENT_REPLY)
297                 common->lcc_recv_length += msg->msg_wanted;
298
299  out:
300         lnet_return_rx_credits_locked(msg);
301         msg->msg_rx_committed = 0;
302 }
303
304 void
305 lnet_msg_decommit(struct lnet_msg *msg, int cpt, int status)
306 {
307         int     cpt2 = cpt;
308
309         LASSERT(msg->msg_tx_committed || msg->msg_rx_committed);
310         LASSERT(msg->msg_onactivelist);
311
312         if (msg->msg_tx_committed) { /* always decommit for sending first */
313                 LASSERT(cpt == msg->msg_tx_cpt);
314                 lnet_msg_decommit_tx(msg, status);
315         }
316
317         if (msg->msg_rx_committed) {
318                 /* forwarding msg committed for both receiving and sending */
319                 if (cpt != msg->msg_rx_cpt) {
320                         lnet_net_unlock(cpt);
321                         cpt2 = msg->msg_rx_cpt;
322                         lnet_net_lock(cpt2);
323                 }
324                 lnet_msg_decommit_rx(msg, status);
325         }
326
327         list_del(&msg->msg_activelist);
328         msg->msg_onactivelist = 0;
329
330         the_lnet.ln_counters[cpt2]->lct_common.lcc_msgs_alloc--;
331
332         if (cpt2 != cpt) {
333                 lnet_net_unlock(cpt2);
334                 lnet_net_lock(cpt);
335         }
336 }
337
338 void
339 lnet_msg_attach_md(struct lnet_msg *msg, struct lnet_libmd *md,
340                    unsigned int offset, unsigned int mlen)
341 {
342         /* NB: @offset and @len are only useful for receiving */
343         /* Here, we attach the MD on lnet_msg and mark it busy and
344          * decrementing its threshold. Come what may, the lnet_msg "owns"
345          * the MD until a call to lnet_msg_detach_md or lnet_finalize()
346          * signals completion. */
347         LASSERT(!msg->msg_routing);
348
349         msg->msg_md = md;
350         if (msg->msg_receiving) { /* committed for receiving */
351                 msg->msg_offset = offset;
352                 msg->msg_wanted = mlen;
353         }
354
355         md->md_refcount++;
356         if (md->md_threshold != LNET_MD_THRESH_INF) {
357                 LASSERT(md->md_threshold > 0);
358                 md->md_threshold--;
359         }
360
361         /* build umd in event */
362         lnet_md2handle(&msg->msg_ev.md_handle, md);
363         lnet_md_deconstruct(md, &msg->msg_ev);
364 }
365
366 static int
367 lnet_complete_msg_locked(struct lnet_msg *msg, int cpt)
368 {
369         struct lnet_handle_wire ack_wmd;
370         int                rc;
371         int                status = msg->msg_ev.status;
372
373         LASSERT(msg->msg_onactivelist);
374
375         if (status == 0 && msg->msg_ack) {
376                 /* Only send an ACK if the PUT completed successfully */
377
378                 lnet_msg_decommit(msg, cpt, 0);
379
380                 msg->msg_ack = 0;
381                 lnet_net_unlock(cpt);
382
383                 LASSERT(msg->msg_ev.type == LNET_EVENT_PUT);
384                 LASSERT(!msg->msg_routing);
385
386                 ack_wmd = msg->msg_hdr.msg.put.ack_wmd;
387
388                 lnet_prep_send(msg, LNET_MSG_ACK, msg->msg_ev.source, 0, 0);
389
390                 msg->msg_hdr.msg.ack.dst_wmd = ack_wmd;
391                 msg->msg_hdr.msg.ack.match_bits = msg->msg_ev.match_bits;
392                 msg->msg_hdr.msg.ack.mlength = cpu_to_le32(msg->msg_ev.mlength);
393
394                 rc = lnet_send(msg->msg_ev.target.nid, msg, msg->msg_from);
395
396                 lnet_net_lock(cpt);
397                 /*
398                  * NB: message is committed for sending, we should return
399                  * on success because LND will finalize this message later.
400                  *
401                  * Also, there is possibility that message is committed for
402                  * sending and also failed before delivering to LND,
403                  * i.e: ENOMEM, in that case we can't fall through either
404                  * because CPT for sending can be different with CPT for
405                  * receiving, so we should return back to lnet_finalize()
406                  * to make sure we are locking the correct partition.
407                  */
408                 return rc;
409
410         } else if (status == 0 &&       /* OK so far */
411                    (msg->msg_routing && !msg->msg_sending)) {
412                 /* not forwarded */
413                 LASSERT(!msg->msg_receiving);   /* called back recv already */
414                 lnet_net_unlock(cpt);
415
416                 rc = lnet_send(LNET_NID_ANY, msg, LNET_NID_ANY);
417
418                 lnet_net_lock(cpt);
419                 /*
420                  * NB: message is committed for sending, we should return
421                  * on success because LND will finalize this message later.
422                  *
423                  * Also, there is possibility that message is committed for
424                  * sending and also failed before delivering to LND,
425                  * i.e: ENOMEM, in that case we can't fall through either:
426                  * - The rule is message must decommit for sending first if
427                  *   the it's committed for both sending and receiving
428                  * - CPT for sending can be different with CPT for receiving,
429                  *   so we should return back to lnet_finalize() to make
430                  *   sure we are locking the correct partition.
431                  */
432                 return rc;
433         }
434
435         lnet_msg_decommit(msg, cpt, status);
436         lnet_msg_free(msg);
437         return 0;
438 }
439
440 static void
441 lnet_dec_healthv_locked(atomic_t *healthv, int sensitivity)
442 {
443         int h = atomic_read(healthv);
444
445         if (h < sensitivity) {
446                 atomic_set(healthv, 0);
447         } else {
448                 h -= sensitivity;
449                 atomic_set(healthv, h);
450         }
451 }
452
453 static void
454 lnet_handle_local_failure(struct lnet_ni *local_ni)
455 {
456         /*
457          * the lnet_net_lock(0) is used to protect the addref on the ni
458          * and the recovery queue.
459          */
460         lnet_net_lock(0);
461         /* the mt could've shutdown and cleaned up the queues */
462         if (the_lnet.ln_mt_state != LNET_MT_STATE_RUNNING) {
463                 lnet_net_unlock(0);
464                 return;
465         }
466
467         lnet_dec_healthv_locked(&local_ni->ni_healthv, lnet_health_sensitivity);
468         /*
469          * add the NI to the recovery queue if it's not already there
470          * and it's health value is actually below the maximum. It's
471          * possible that the sensitivity might be set to 0, and the health
472          * value will not be reduced. In this case, there is no reason to
473          * invoke recovery
474          */
475         if (list_empty(&local_ni->ni_recovery) &&
476             atomic_read(&local_ni->ni_healthv) < LNET_MAX_HEALTH_VALUE) {
477                 CDEBUG(D_NET, "ni %s added to recovery queue. Health = %d\n",
478                         libcfs_nid2str(local_ni->ni_nid),
479                         atomic_read(&local_ni->ni_healthv));
480                 list_add_tail(&local_ni->ni_recovery,
481                               &the_lnet.ln_mt_localNIRecovq);
482                 lnet_ni_addref_locked(local_ni, 0);
483         }
484         lnet_net_unlock(0);
485 }
486
487 void
488 lnet_handle_remote_failure_locked(struct lnet_peer_ni *lpni)
489 {
490         __u32 sensitivity = lnet_health_sensitivity;
491         __u32 lp_sensitivity;
492
493         /*
494          * NO-OP if:
495          * 1. lpni could be NULL if we're in the LOLND case
496          * 2. this is a recovery message
497          */
498         if (!lpni)
499                 return;
500
501         /*
502          * If there is a health sensitivity in the peer then use that
503          * instead of the globally set one.
504          */
505         lp_sensitivity = lpni->lpni_peer_net->lpn_peer->lp_health_sensitivity;
506         if (lp_sensitivity)
507                 sensitivity = lp_sensitivity;
508
509         lnet_dec_healthv_locked(&lpni->lpni_healthv, sensitivity);
510
511         /* update the peer_net's health value */
512         lnet_update_peer_net_healthv(lpni);
513
514         /*
515          * add the peer NI to the recovery queue if it's not already there
516          * and it's health value is actually below the maximum. It's
517          * possible that the sensitivity might be set to 0, and the health
518          * value will not be reduced. In this case, there is no reason to
519          * invoke recovery
520          */
521         lnet_peer_ni_add_to_recoveryq_locked(lpni);
522 }
523
524 static void
525 lnet_handle_remote_failure(struct lnet_peer_ni *lpni)
526 {
527         /* lpni could be NULL if we're in the LOLND case */
528         if (!lpni)
529                 return;
530
531         lnet_net_lock(0);
532         /* the mt could've shutdown and cleaned up the queues */
533         if (the_lnet.ln_mt_state != LNET_MT_STATE_RUNNING) {
534                 lnet_net_unlock(0);
535                 return;
536         }
537         lnet_handle_remote_failure_locked(lpni);
538         lnet_net_unlock(0);
539 }
540
541 static void
542 lnet_incr_hstats(struct lnet_ni *ni, struct lnet_peer_ni *lpni,
543                  enum lnet_msg_hstatus hstatus)
544 {
545         struct lnet_counters_health *health;
546
547         health = &the_lnet.ln_counters[0]->lct_health;
548
549         switch (hstatus) {
550         case LNET_MSG_STATUS_LOCAL_INTERRUPT:
551                 atomic_inc(&ni->ni_hstats.hlt_local_interrupt);
552                 health->lch_local_interrupt_count++;
553                 break;
554         case LNET_MSG_STATUS_LOCAL_DROPPED:
555                 atomic_inc(&ni->ni_hstats.hlt_local_dropped);
556                 health->lch_local_dropped_count++;
557                 break;
558         case LNET_MSG_STATUS_LOCAL_ABORTED:
559                 atomic_inc(&ni->ni_hstats.hlt_local_aborted);
560                 health->lch_local_aborted_count++;
561                 break;
562         case LNET_MSG_STATUS_LOCAL_NO_ROUTE:
563                 atomic_inc(&ni->ni_hstats.hlt_local_no_route);
564                 health->lch_local_no_route_count++;
565                 break;
566         case LNET_MSG_STATUS_LOCAL_TIMEOUT:
567                 atomic_inc(&ni->ni_hstats.hlt_local_timeout);
568                 health->lch_local_timeout_count++;
569                 break;
570         case LNET_MSG_STATUS_LOCAL_ERROR:
571                 atomic_inc(&ni->ni_hstats.hlt_local_error);
572                 health->lch_local_error_count++;
573                 break;
574         case LNET_MSG_STATUS_REMOTE_DROPPED:
575                 if (lpni)
576                         atomic_inc(&lpni->lpni_hstats.hlt_remote_dropped);
577                 health->lch_remote_dropped_count++;
578                 break;
579         case LNET_MSG_STATUS_REMOTE_ERROR:
580                 if (lpni)
581                         atomic_inc(&lpni->lpni_hstats.hlt_remote_error);
582                 health->lch_remote_error_count++;
583                 break;
584         case LNET_MSG_STATUS_REMOTE_TIMEOUT:
585                 if (lpni)
586                         atomic_inc(&lpni->lpni_hstats.hlt_remote_timeout);
587                 health->lch_remote_timeout_count++;
588                 break;
589         case LNET_MSG_STATUS_NETWORK_TIMEOUT:
590                 if (lpni)
591                         atomic_inc(&lpni->lpni_hstats.hlt_network_timeout);
592                 health->lch_network_timeout_count++;
593                 break;
594         case LNET_MSG_STATUS_OK:
595                 break;
596         default:
597                 LBUG();
598         }
599 }
600
601 static void
602 lnet_resend_msg_locked(struct lnet_msg *msg)
603 {
604         msg->msg_retry_count++;
605
606         /*
607          * remove message from the active list and reset it to prepare
608          * for a resend. Two exceptions to this
609          *
610          * 1. the router case. When a message is being routed it is
611          * committed for rx when received and committed for tx when
612          * forwarded. We don't want to remove it from the active list, since
613          * code which handles receiving expects it to remain on the active
614          * list.
615          *
616          * 2. The REPLY case. Reply messages use the same message
617          * structure for the GET that was received.
618          */
619         if (!msg->msg_routing && msg->msg_type != LNET_MSG_REPLY) {
620                 list_del_init(&msg->msg_activelist);
621                 msg->msg_onactivelist = 0;
622         }
623         /*
624          * The msg_target.nid which was originally set
625          * when calling LNetGet() or LNetPut() might've
626          * been overwritten if we're routing this message.
627          * Call lnet_msg_decommit_tx() to return the credit
628          * this message consumed. The message will
629          * consume another credit when it gets resent.
630          */
631         msg->msg_target.nid = msg->msg_hdr.dest_nid;
632         lnet_msg_decommit_tx(msg, -EAGAIN);
633         msg->msg_sending = 0;
634         msg->msg_receiving = 0;
635         msg->msg_target_is_router = 0;
636
637         CDEBUG(D_NET, "%s->%s:%s:%s - queuing msg (%p) for resend\n",
638                libcfs_nid2str(msg->msg_hdr.src_nid),
639                libcfs_nid2str(msg->msg_hdr.dest_nid),
640                lnet_msgtyp2str(msg->msg_type),
641                lnet_health_error2str(msg->msg_health_status), msg);
642
643         list_add_tail(&msg->msg_list, the_lnet.ln_mt_resendqs[msg->msg_tx_cpt]);
644
645         complete(&the_lnet.ln_mt_wait_complete);
646 }
647
648 int
649 lnet_check_finalize_recursion_locked(struct lnet_msg *msg,
650                                      struct list_head *containerq,
651                                      int nworkers, void **workers)
652 {
653         int my_slot = -1;
654         int i;
655
656         list_add_tail(&msg->msg_list, containerq);
657
658         for (i = 0; i < nworkers; i++) {
659                 if (workers[i] == current)
660                         break;
661
662                 if (my_slot < 0 && workers[i] == NULL)
663                         my_slot = i;
664         }
665
666         if (i < nworkers || my_slot < 0)
667                 return -1;
668
669         workers[my_slot] = current;
670
671         return my_slot;
672 }
673
674 int
675 lnet_attempt_msg_resend(struct lnet_msg *msg)
676 {
677         struct lnet_msg_container *container;
678         int my_slot;
679         int cpt;
680
681         /* we can only resend tx_committed messages */
682         LASSERT(msg->msg_tx_committed);
683
684         /* don't resend recovery messages */
685         if (msg->msg_recovery) {
686                 CDEBUG(D_NET, "msg %s->%s is a recovery ping. retry# %d\n",
687                         libcfs_nid2str(msg->msg_from),
688                         libcfs_nid2str(msg->msg_target.nid),
689                         msg->msg_retry_count);
690                 return -ENOTRECOVERABLE;
691         }
692
693         /*
694          * if we explicitly indicated we don't want to resend then just
695          * return
696          */
697         if (msg->msg_no_resend) {
698                 CDEBUG(D_NET, "msg %s->%s requested no resend. retry# %d\n",
699                         libcfs_nid2str(msg->msg_from),
700                         libcfs_nid2str(msg->msg_target.nid),
701                         msg->msg_retry_count);
702                 return -ENOTRECOVERABLE;
703         }
704
705         /* check if the message has exceeded the number of retries */
706         if (msg->msg_retry_count >= lnet_retry_count) {
707                 CNETERR("msg %s->%s exceeded retry count %d\n",
708                         libcfs_nid2str(msg->msg_from),
709                         libcfs_nid2str(msg->msg_target.nid),
710                         msg->msg_retry_count);
711                 return -ENOTRECOVERABLE;
712         }
713
714         cpt = msg->msg_tx_cpt;
715         lnet_net_lock(cpt);
716
717         /* check again under lock */
718         if (the_lnet.ln_mt_state != LNET_MT_STATE_RUNNING) {
719                 lnet_net_unlock(cpt);
720                 return -ESHUTDOWN;
721         }
722
723         container = the_lnet.ln_msg_containers[cpt];
724         my_slot =
725                 lnet_check_finalize_recursion_locked(msg,
726                                         &container->msc_resending,
727                                         container->msc_nfinalizers,
728                                         container->msc_resenders);
729
730         /* enough threads are resending */
731         if (my_slot == -1) {
732                 lnet_net_unlock(cpt);
733                 return 0;
734         }
735
736         while (!list_empty(&container->msc_resending)) {
737                 msg = list_entry(container->msc_resending.next,
738                                         struct lnet_msg, msg_list);
739                 list_del(&msg->msg_list);
740
741                 /*
742                  * resending the message will require us to call
743                  * lnet_msg_decommit_tx() which will return the credit
744                  * which this message holds. This could trigger another
745                  * queued message to be sent. If that message fails and
746                  * requires a resend we will recurse.
747                  * But since at this point the slot is taken, the message
748                  * will be queued in the container and dealt with
749                  * later. This breaks the recursion.
750                  */
751                 lnet_resend_msg_locked(msg);
752         }
753
754         /*
755          * msc_resenders is an array of process pointers. Each entry holds
756          * a pointer to the current process operating on the message. An
757          * array entry is created per CPT. If the array slot is already
758          * set, then it means that there is a thread on the CPT currently
759          * resending a message.
760          * Once the thread finishes clear the slot to enable the thread to
761          * take on more resend work.
762          */
763         container->msc_resenders[my_slot] = NULL;
764         lnet_net_unlock(cpt);
765
766         return 0;
767 }
768
769 /*
770  * Do a health check on the message:
771  * return -1 if we're not going to handle the error or
772  *   if we've reached the maximum number of retries.
773  *   success case will return -1 as well
774  * return 0 if it the message is requeued for send
775  */
776 static int
777 lnet_health_check(struct lnet_msg *msg)
778 {
779         enum lnet_msg_hstatus hstatus = msg->msg_health_status;
780         struct lnet_peer_ni *lpni;
781         struct lnet_ni *ni;
782         bool lo = false;
783
784         /* if we're shutting down no point in handling health. */
785         if (the_lnet.ln_mt_state != LNET_MT_STATE_RUNNING)
786                 return -1;
787
788         LASSERT(msg->msg_tx_committed || msg->msg_rx_committed);
789
790         /*
791          * if we're sending to the LOLND then the msg_txpeer will not be
792          * set. So no need to sanity check it.
793          */
794         if (msg->msg_tx_committed && msg->msg_txni->ni_nid != LNET_NID_LO_0)
795                 LASSERT(msg->msg_txpeer);
796         else if (msg->msg_tx_committed &&
797                  msg->msg_txni->ni_nid == LNET_NID_LO_0)
798                 lo = true;
799
800         if (hstatus != LNET_MSG_STATUS_OK &&
801             ktime_compare(ktime_get(), msg->msg_deadline) >= 0)
802                 return -1;
803
804         /*
805          * always prefer txni/txpeer if they message is committed for both
806          * directions.
807          */
808         if (msg->msg_tx_committed) {
809                 ni = msg->msg_txni;
810                 lpni = msg->msg_txpeer;
811         } else {
812                 ni = msg->msg_rxni;
813                 lpni = msg->msg_rxpeer;
814         }
815
816         if (!lo)
817                 LASSERT(ni && lpni);
818         else
819                 LASSERT(ni);
820
821         CDEBUG(D_NET, "health check: %s->%s: %s: %s\n",
822                libcfs_nid2str(ni->ni_nid),
823                (lo) ? "self" : libcfs_nid2str(lpni->lpni_nid),
824                lnet_msgtyp2str(msg->msg_type),
825                lnet_health_error2str(hstatus));
826
827         /*
828          * stats are only incremented for errors so avoid wasting time
829          * incrementing statistics if there is no error.
830          */
831         if (hstatus != LNET_MSG_STATUS_OK) {
832                 lnet_net_lock(0);
833                 lnet_incr_hstats(ni, lpni, hstatus);
834                 lnet_net_unlock(0);
835         }
836
837         switch (hstatus) {
838         case LNET_MSG_STATUS_OK:
839                 /*
840                  * increment the local ni health weather we successfully
841                  * received or sent a message on it.
842                  */
843                 lnet_inc_healthv(&ni->ni_healthv, lnet_health_sensitivity);
844                 /*
845                  * It's possible msg_txpeer is NULL in the LOLND
846                  * case. Only increment the peer's health if we're
847                  * receiving a message from it. It's the only sure way to
848                  * know that a remote interface is up.
849                  * If this interface is part of a router, then take that
850                  * as indication that the router is fully healthy.
851                  */
852                 if (lpni && msg->msg_rx_committed) {
853                         /*
854                          * If we're receiving a message from the router or
855                          * I'm a router, then set that lpni's health to
856                          * maximum so we can commence communication
857                          */
858                         lnet_net_lock(0);
859                         if (lnet_isrouter(lpni) || the_lnet.ln_routing) {
860                                 lnet_set_lpni_healthv_locked(lpni,
861                                         LNET_MAX_HEALTH_VALUE);
862                         } else {
863                                 __u32 sensitivity = lpni->lpni_peer_net->
864                                         lpn_peer->lp_health_sensitivity;
865
866                                 lnet_inc_lpni_healthv_locked(lpni,
867                                         (sensitivity) ? sensitivity :
868                                         lnet_health_sensitivity);
869                         }
870                         lnet_net_unlock(0);
871                 }
872
873                 /* we can finalize this message */
874                 return -1;
875         case LNET_MSG_STATUS_LOCAL_INTERRUPT:
876         case LNET_MSG_STATUS_LOCAL_DROPPED:
877         case LNET_MSG_STATUS_LOCAL_ABORTED:
878         case LNET_MSG_STATUS_LOCAL_NO_ROUTE:
879         case LNET_MSG_STATUS_LOCAL_TIMEOUT:
880                 /*
881                  * don't further decrement the health value if the
882                  * recovery message failed.
883                  */
884                 if (!msg->msg_recovery)
885                         lnet_handle_local_failure(ni);
886                 if (msg->msg_tx_committed)
887                         /* add to the re-send queue */
888                         return lnet_attempt_msg_resend(msg);
889                 break;
890
891         /*
892          * These errors will not trigger a resend so simply
893          * finalize the message
894          */
895         case LNET_MSG_STATUS_LOCAL_ERROR:
896                 /*
897                  * don't further decrement the health value if the
898                  * recovery message failed.
899                  */
900                 if (!msg->msg_recovery)
901                         lnet_handle_local_failure(ni);
902                 return -1;
903
904         /*
905          * TODO: since the remote dropped the message we can
906          * attempt a resend safely.
907          */
908         case LNET_MSG_STATUS_REMOTE_DROPPED:
909                 if (!msg->msg_recovery)
910                         lnet_handle_remote_failure(lpni);
911                 if (msg->msg_tx_committed)
912                         return lnet_attempt_msg_resend(msg);
913                 break;
914
915         case LNET_MSG_STATUS_REMOTE_ERROR:
916         case LNET_MSG_STATUS_REMOTE_TIMEOUT:
917         case LNET_MSG_STATUS_NETWORK_TIMEOUT:
918                 if (!msg->msg_recovery)
919                         lnet_handle_remote_failure(lpni);
920                 return -1;
921         default:
922                 LBUG();
923         }
924
925         /* no resend is needed */
926         return -1;
927 }
928
929 static void
930 lnet_msg_detach_md(struct lnet_msg *msg, int cpt, int status)
931 {
932         struct lnet_libmd *md = msg->msg_md;
933         int unlink;
934
935         /* Now it's safe to drop my caller's ref */
936         md->md_refcount--;
937         LASSERT(md->md_refcount >= 0);
938
939         unlink = lnet_md_unlinkable(md);
940         if (md->md_handler) {
941                 if ((md->md_flags & LNET_MD_FLAG_ABORTED) && !status) {
942                         msg->msg_ev.status   = -ETIMEDOUT;
943                         CDEBUG(D_NET, "md 0x%p already unlinked\n", md);
944                 } else {
945                         msg->msg_ev.status   = status;
946                 }
947                 msg->msg_ev.unlinked = unlink;
948                 md->md_handler(&msg->msg_ev);
949         }
950
951         if (unlink || (md->md_refcount == 0 &&
952                        md->md_threshold == LNET_MD_THRESH_INF))
953                 lnet_detach_rsp_tracker(md, cpt);
954
955         if (unlink)
956                 lnet_md_unlink(md);
957
958         msg->msg_md = NULL;
959 }
960
961 static bool
962 lnet_is_health_check(struct lnet_msg *msg)
963 {
964         bool hc = true;
965         int status = msg->msg_ev.status;
966
967         if ((!msg->msg_tx_committed && !msg->msg_rx_committed) ||
968             !msg->msg_onactivelist) {
969                 CDEBUG(D_NET, "msg %p not committed for send or receive\n",
970                        msg);
971                 return false;
972         }
973
974         if ((msg->msg_tx_committed && !msg->msg_txpeer) ||
975             (msg->msg_rx_committed && !msg->msg_rxpeer)) {
976                 /* The optimized GET case does not set msg_rxpeer, but status
977                  * could be zero. Only print the error message if we have a
978                  * non-zero status.
979                  */
980                 if (status)
981                         CDEBUG(D_NET, "msg %p status %d cannot retry\n", msg,
982                                status);
983                 return false;
984         }
985
986         /* Check for status inconsistencies */
987         if ((!status && msg->msg_health_status != LNET_MSG_STATUS_OK) ||
988              (status && msg->msg_health_status == LNET_MSG_STATUS_OK)) {
989                 CDEBUG(D_NET, "Msg %p is in inconsistent state, don't perform health "
990                        "checking (%d, %d)\n", msg, status,
991                        msg->msg_health_status);
992                 hc = false;
993         }
994
995         CDEBUG(D_NET, "health check = %d, status = %d, hstatus = %d\n",
996                hc, status, msg->msg_health_status);
997
998         return hc;
999 }
1000
1001 char *
1002 lnet_health_error2str(enum lnet_msg_hstatus hstatus)
1003 {
1004         switch (hstatus) {
1005         case LNET_MSG_STATUS_LOCAL_INTERRUPT:
1006                 return "LOCAL_INTERRUPT";
1007         case LNET_MSG_STATUS_LOCAL_DROPPED:
1008                 return "LOCAL_DROPPED";
1009         case LNET_MSG_STATUS_LOCAL_ABORTED:
1010                 return "LOCAL_ABORTED";
1011         case LNET_MSG_STATUS_LOCAL_NO_ROUTE:
1012                 return "LOCAL_NO_ROUTE";
1013         case LNET_MSG_STATUS_LOCAL_TIMEOUT:
1014                 return "LOCAL_TIMEOUT";
1015         case LNET_MSG_STATUS_LOCAL_ERROR:
1016                 return "LOCAL_ERROR";
1017         case LNET_MSG_STATUS_REMOTE_DROPPED:
1018                 return "REMOTE_DROPPED";
1019         case LNET_MSG_STATUS_REMOTE_ERROR:
1020                 return "REMOTE_ERROR";
1021         case LNET_MSG_STATUS_REMOTE_TIMEOUT:
1022                 return "REMOTE_TIMEOUT";
1023         case LNET_MSG_STATUS_NETWORK_TIMEOUT:
1024                 return "NETWORK_TIMEOUT";
1025         case LNET_MSG_STATUS_OK:
1026                 return "OK";
1027         default:
1028                 return "<UNKNOWN>";
1029         }
1030 }
1031
1032 bool
1033 lnet_send_error_simulation(struct lnet_msg *msg,
1034                            enum lnet_msg_hstatus *hstatus)
1035 {
1036         if (!msg)
1037                 return false;
1038
1039         if (list_empty(&the_lnet.ln_drop_rules))
1040             return false;
1041
1042         /* match only health rules */
1043         if (!lnet_drop_rule_match(&msg->msg_hdr, LNET_NID_ANY,
1044                                   hstatus))
1045                 return false;
1046
1047         CDEBUG(D_NET, "src %s(%s)->dst %s: %s simulate health error: %s\n",
1048                 libcfs_nid2str(msg->msg_hdr.src_nid),
1049                 libcfs_nid2str(msg->msg_txni->ni_nid),
1050                 libcfs_nid2str(msg->msg_hdr.dest_nid),
1051                 lnet_msgtyp2str(msg->msg_type),
1052                 lnet_health_error2str(*hstatus));
1053
1054         return true;
1055 }
1056 EXPORT_SYMBOL(lnet_send_error_simulation);
1057
1058 void
1059 lnet_finalize(struct lnet_msg *msg, int status)
1060 {
1061         struct lnet_msg_container *container;
1062         int my_slot;
1063         int cpt;
1064         int rc;
1065
1066         LASSERT(!in_interrupt());
1067
1068         if (msg == NULL)
1069                 return;
1070
1071         msg->msg_ev.status = status;
1072
1073         if (lnet_is_health_check(msg)) {
1074                 /*
1075                  * Check the health status of the message. If it has one
1076                  * of the errors that we're supposed to handle, and it has
1077                  * not timed out, then
1078                  *      1. Decrement the appropriate health_value
1079                  *      2. queue the message on the resend queue
1080
1081                  * if the message send is success, timed out or failed in the
1082                  * health check for any reason then we'll just finalize the
1083                  * message. Otherwise just return since the message has been
1084                  * put on the resend queue.
1085                  */
1086                 if (!lnet_health_check(msg))
1087                         return;
1088         }
1089
1090         /*
1091          * We're not going to resend this message so detach its MD and invoke
1092          * the appropriate callbacks
1093          */
1094         if (msg->msg_md != NULL) {
1095                 cpt = lnet_cpt_of_cookie(msg->msg_md->md_lh.lh_cookie);
1096                 lnet_res_lock(cpt);
1097                 lnet_msg_detach_md(msg, cpt, status);
1098                 lnet_res_unlock(cpt);
1099         }
1100
1101 again:
1102         if (!msg->msg_tx_committed && !msg->msg_rx_committed) {
1103                 /* not committed to network yet */
1104                 LASSERT(!msg->msg_onactivelist);
1105                 lnet_msg_free(msg);
1106                 return;
1107         }
1108
1109         /*
1110          * NB: routed message can be committed for both receiving and sending,
1111          * we should finalize in LIFO order and keep counters correct.
1112          * (finalize sending first then finalize receiving)
1113          */
1114         cpt = msg->msg_tx_committed ? msg->msg_tx_cpt : msg->msg_rx_cpt;
1115         lnet_net_lock(cpt);
1116
1117         container = the_lnet.ln_msg_containers[cpt];
1118
1119         /* Recursion breaker.  Don't complete the message here if I am (or
1120          * enough other threads are) already completing messages */
1121         my_slot = lnet_check_finalize_recursion_locked(msg,
1122                                                 &container->msc_finalizing,
1123                                                 container->msc_nfinalizers,
1124                                                 container->msc_finalizers);
1125
1126         /* enough threads are resending */
1127         if (my_slot == -1) {
1128                 lnet_net_unlock(cpt);
1129                 return;
1130         }
1131
1132         rc = 0;
1133         while (!list_empty(&container->msc_finalizing)) {
1134                 msg = list_entry(container->msc_finalizing.next,
1135                                  struct lnet_msg, msg_list);
1136
1137                 list_del_init(&msg->msg_list);
1138
1139                 /* NB drops and regains the lnet lock if it actually does
1140                  * anything, so my finalizing friends can chomp along too */
1141                 rc = lnet_complete_msg_locked(msg, cpt);
1142                 if (rc != 0)
1143                         break;
1144         }
1145
1146         if (unlikely(!list_empty(&the_lnet.ln_delay_rules))) {
1147                 lnet_net_unlock(cpt);
1148                 lnet_delay_rule_check();
1149                 lnet_net_lock(cpt);
1150         }
1151
1152         container->msc_finalizers[my_slot] = NULL;
1153         lnet_net_unlock(cpt);
1154
1155         if (rc != 0)
1156                 goto again;
1157 }
1158 EXPORT_SYMBOL(lnet_finalize);
1159
1160 void
1161 lnet_msg_container_cleanup(struct lnet_msg_container *container)
1162 {
1163         int     count = 0;
1164
1165         if (container->msc_init == 0)
1166                 return;
1167
1168         while (!list_empty(&container->msc_active)) {
1169                 struct lnet_msg *msg;
1170
1171                 msg  = list_entry(container->msc_active.next,
1172                                   struct lnet_msg, msg_activelist);
1173                 LASSERT(msg->msg_onactivelist);
1174                 msg->msg_onactivelist = 0;
1175                 list_del_init(&msg->msg_activelist);
1176                 lnet_msg_free(msg);
1177                 count++;
1178         }
1179
1180         if (count > 0)
1181                 CERROR("%d active msg on exit\n", count);
1182
1183         if (container->msc_finalizers != NULL) {
1184                 CFS_FREE_PTR_ARRAY(container->msc_finalizers,
1185                                    container->msc_nfinalizers);
1186                 container->msc_finalizers = NULL;
1187         }
1188
1189         if (container->msc_resenders != NULL) {
1190                 CFS_FREE_PTR_ARRAY(container->msc_resenders,
1191                                    container->msc_nfinalizers);
1192                 container->msc_resenders = NULL;
1193         }
1194         container->msc_init = 0;
1195 }
1196
1197 int
1198 lnet_msg_container_setup(struct lnet_msg_container *container, int cpt)
1199 {
1200         int rc = 0;
1201
1202         container->msc_init = 1;
1203
1204         INIT_LIST_HEAD(&container->msc_active);
1205         INIT_LIST_HEAD(&container->msc_finalizing);
1206         INIT_LIST_HEAD(&container->msc_resending);
1207
1208         /* number of CPUs */
1209         container->msc_nfinalizers = cfs_cpt_weight(lnet_cpt_table(), cpt);
1210         if (container->msc_nfinalizers == 0)
1211                 container->msc_nfinalizers = 1;
1212
1213         LIBCFS_CPT_ALLOC(container->msc_finalizers, lnet_cpt_table(), cpt,
1214                          container->msc_nfinalizers *
1215                          sizeof(*container->msc_finalizers));
1216
1217         if (container->msc_finalizers == NULL) {
1218                 CERROR("Failed to allocate message finalizers\n");
1219                 lnet_msg_container_cleanup(container);
1220                 return -ENOMEM;
1221         }
1222
1223         LIBCFS_CPT_ALLOC(container->msc_resenders, lnet_cpt_table(), cpt,
1224                          container->msc_nfinalizers *
1225                          sizeof(*container->msc_resenders));
1226
1227         if (container->msc_resenders == NULL) {
1228                 CERROR("Failed to allocate message resenders\n");
1229                 lnet_msg_container_cleanup(container);
1230                 return -ENOMEM;
1231         }
1232
1233         return rc;
1234 }
1235
1236 void
1237 lnet_msg_containers_destroy(void)
1238 {
1239         struct lnet_msg_container *container;
1240         int     i;
1241
1242         if (the_lnet.ln_msg_containers == NULL)
1243                 return;
1244
1245         cfs_percpt_for_each(container, i, the_lnet.ln_msg_containers)
1246                 lnet_msg_container_cleanup(container);
1247
1248         cfs_percpt_free(the_lnet.ln_msg_containers);
1249         the_lnet.ln_msg_containers = NULL;
1250 }
1251
1252 int
1253 lnet_msg_containers_create(void)
1254 {
1255         struct lnet_msg_container *container;
1256         int     rc;
1257         int     i;
1258
1259         the_lnet.ln_msg_containers = cfs_percpt_alloc(lnet_cpt_table(),
1260                                                       sizeof(*container));
1261
1262         if (the_lnet.ln_msg_containers == NULL) {
1263                 CERROR("Failed to allocate cpu-partition data for network\n");
1264                 return -ENOMEM;
1265         }
1266
1267         cfs_percpt_for_each(container, i, the_lnet.ln_msg_containers) {
1268                 rc = lnet_msg_container_setup(container, i);
1269                 if (rc != 0) {
1270                         lnet_msg_containers_destroy();
1271                         return rc;
1272                 }
1273         }
1274
1275         return 0;
1276 }