debian: Synchronize debian/changelog with downstream Debian changelog.
[openvswitch] / lib / cfm.c
1 /*
2  * Copyright (c) 2010, 2011, 2012 Nicira, Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #include <config.h>
18 #include "cfm.h"
19
20 #include <assert.h>
21 #include <stdint.h>
22 #include <stdlib.h>
23 #include <string.h>
24
25 #include "byte-order.h"
26 #include "dynamic-string.h"
27 #include "flow.h"
28 #include "hash.h"
29 #include "hmap.h"
30 #include "ofpbuf.h"
31 #include "packets.h"
32 #include "poll-loop.h"
33 #include "random.h"
34 #include "timer.h"
35 #include "timeval.h"
36 #include "unixctl.h"
37 #include "vlog.h"
38
39 VLOG_DEFINE_THIS_MODULE(cfm);
40
41 #define CFM_MAX_RMPS 256
42
43 /* Ethernet destination address of CCM packets. */
44 static const uint8_t eth_addr_ccm[6] = { 0x01, 0x80, 0xC2, 0x00, 0x00, 0x30 };
45 static const uint8_t eth_addr_ccm_x[6] = {
46     0x01, 0x23, 0x20, 0x00, 0x00, 0x30
47 };
48
49 #define ETH_TYPE_CFM 0x8902
50
51 /* A 'ccm' represents a Continuity Check Message from the 802.1ag
52  * specification.  Continuity Check Messages are broadcast periodically so that
53  * hosts can determine whom they have connectivity to.
54  *
55  * The minimum length of a CCM as specified by IEEE 802.1ag is 75 bytes.
56  * Previous versions of Open vSwitch generated 74-byte CCM messages, so we
57  * accept such messages too. */
58 #define CCM_LEN 75
59 #define CCM_ACCEPT_LEN 74
60 #define CCM_MAID_LEN 48
61 #define CCM_OPCODE 1 /* CFM message opcode meaning CCM. */
62 #define CCM_RDI_MASK 0x80
63 #define CFM_HEALTH_INTERVAL 6
64 struct ccm {
65     uint8_t  mdlevel_version; /* MD Level and Version */
66     uint8_t  opcode;
67     uint8_t  flags;
68     uint8_t  tlv_offset;
69     ovs_be32 seq;
70     ovs_be16 mpid;
71     uint8_t  maid[CCM_MAID_LEN];
72
73     /* Defined by ITU-T Y.1731 should be zero */
74     ovs_be16 interval_ms_x;      /* Transmission interval in ms. */
75     ovs_be64 mpid64;             /* MPID in extended mode. */
76     uint8_t opdown;              /* Operationally down. */
77     uint8_t  zero[5];
78
79     /* TLV space. */
80     uint8_t end_tlv;
81 } __attribute__((packed));
82 BUILD_ASSERT_DECL(CCM_LEN == sizeof(struct ccm));
83
84 struct cfm {
85     char *name;                 /* Name of this CFM object. */
86     struct hmap_node hmap_node; /* Node in all_cfms list. */
87
88     uint64_t mpid;
89     bool extended;         /* Extended mode. */
90     enum cfm_fault_reason fault;  /* Connectivity fault status. */
91     enum cfm_fault_reason recv_fault;  /* Bit mask of faults occuring on
92                                           receive. */
93     bool opup;             /* Operational State. */
94     bool remote_opup;      /* Remote Operational State. */
95
96     int fault_override;    /* Manual override of 'fault' status.
97                               Ignored if negative. */
98
99     uint32_t seq;          /* The sequence number of our last CCM. */
100     uint8_t ccm_interval;  /* The CCM transmission interval. */
101     int ccm_interval_ms;   /* 'ccm_interval' in milliseconds. */
102     uint16_t ccm_vlan;     /* Vlan tag of CCM PDUs.  CFM_RANDOM_VLAN if
103                               random. */
104     uint8_t ccm_pcp;       /* Priority of CCM PDUs. */
105     uint8_t maid[CCM_MAID_LEN]; /* The MAID of this CFM. */
106
107     struct timer tx_timer;    /* Send CCM when expired. */
108     struct timer fault_timer; /* Check for faults when expired. */
109
110     struct hmap remote_mps;   /* Remote MPs. */
111
112     /* Result of cfm_get_remote_mpids(). Updated only during fault check to
113      * avoid flapping. */
114     uint64_t *rmps_array;     /* Cache of remote_mps. */
115     size_t rmps_array_len;    /* Number of rmps in 'rmps_array'. */
116
117     int health;               /* Percentage of the number of CCM frames
118                                  received. */
119     int health_interval;      /* Number of fault_intervals since health was
120                                  recomputed. */
121
122 };
123
124 /* Remote MPs represent foreign network entities that are configured to have
125  * the same MAID as this CFM instance. */
126 struct remote_mp {
127     uint64_t mpid;         /* The Maintenance Point ID of this 'remote_mp'. */
128     struct hmap_node node; /* Node in 'remote_mps' map. */
129
130     bool recv;           /* CCM was received since last fault check. */
131     bool opup;           /* Operational State. */
132     uint32_t seq;        /* Most recently received sequence number. */
133     uint8_t num_health_ccm; /* Number of received ccm frames every
134                                CFM_HEALTH_INTERVAL * 'fault_interval'. */
135
136 };
137
138 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(20, 30);
139 static struct hmap all_cfms = HMAP_INITIALIZER(&all_cfms);
140
141 static unixctl_cb_func cfm_unixctl_show;
142 static unixctl_cb_func cfm_unixctl_set_fault;
143
144 static const uint8_t *
145 cfm_ccm_addr(const struct cfm *cfm)
146 {
147     return cfm->extended ? eth_addr_ccm_x : eth_addr_ccm;
148 }
149
150 /* Returns the string representation of the given cfm_fault_reason 'reason'. */
151 const char *
152 cfm_fault_reason_to_str(int reason) {
153     switch (reason) {
154 #define CFM_FAULT_REASON(NAME, STR) case CFM_FAULT_##NAME: return #STR;
155         CFM_FAULT_REASONS
156 #undef CFM_FAULT_REASON
157     default: return "<unknown>";
158     }
159 }
160
161 static void
162 ds_put_cfm_fault(struct ds *ds, int old_fault, int new_fault)
163 {
164     int i;
165
166     for (i = 0; i < CFM_FAULT_N_REASONS; i++) {
167         int reason = 1 << i;
168
169         if ((old_fault | new_fault) & reason) {
170             ds_put_format(ds, " %s%s",
171                           (!(old_fault & reason) ? "+"
172                            : !(new_fault & reason) ? "-"
173                            : ""),
174                           cfm_fault_reason_to_str(reason));
175         }
176     }
177 }
178
179 static void
180 cfm_generate_maid(struct cfm *cfm)
181 {
182     const char *ovs_md_name = "ovs";
183     const char *ovs_ma_name = "ovs";
184     uint8_t *ma_p;
185     size_t md_len, ma_len;
186
187     memset(cfm->maid, 0, CCM_MAID_LEN);
188
189     md_len = strlen(ovs_md_name);
190     ma_len = strlen(ovs_ma_name);
191
192     assert(md_len && ma_len && md_len + ma_len + 4 <= CCM_MAID_LEN);
193
194     cfm->maid[0] = 4;                           /* MD name string format. */
195     cfm->maid[1] = md_len;                      /* MD name size. */
196     memcpy(&cfm->maid[2], ovs_md_name, md_len); /* MD name. */
197
198     ma_p = cfm->maid + 2 + md_len;
199     ma_p[0] = 2;                           /* MA name string format. */
200     ma_p[1] = ma_len;                      /* MA name size. */
201     memcpy(&ma_p[2], ovs_ma_name, ma_len); /* MA name. */
202 }
203
204 static int
205 ccm_interval_to_ms(uint8_t interval)
206 {
207     switch (interval) {
208     case 0:  NOT_REACHED(); /* Explicitly not supported by 802.1ag. */
209     case 1:  return 3;      /* Not recommended due to timer resolution. */
210     case 2:  return 10;     /* Not recommended due to timer resolution. */
211     case 3:  return 100;
212     case 4:  return 1000;
213     case 5:  return 10000;
214     case 6:  return 60000;
215     case 7:  return 600000;
216     default: NOT_REACHED(); /* Explicitly not supported by 802.1ag. */
217     }
218
219     NOT_REACHED();
220 }
221
222 static long long int
223 cfm_fault_interval(struct cfm *cfm)
224 {
225     /* According to the 802.1ag specification we should assume every other MP
226      * with the same MAID has the same transmission interval that we have.  If
227      * an MP has a different interval, cfm_process_heartbeat will register it
228      * as a fault (likely due to a configuration error).  Thus we can check all
229      * MPs at once making this quite a bit simpler.
230      *
231      * According to the specification we should check when (ccm_interval_ms *
232      * 3.5)ms have passed. */
233     return (cfm->ccm_interval_ms * 7) / 2;
234 }
235
236 static uint8_t
237 ms_to_ccm_interval(int interval_ms)
238 {
239     uint8_t i;
240
241     for (i = 7; i > 0; i--) {
242         if (ccm_interval_to_ms(i) <= interval_ms) {
243             return i;
244         }
245     }
246
247     return 1;
248 }
249
250 static uint32_t
251 hash_mpid(uint64_t mpid)
252 {
253     return hash_bytes(&mpid, sizeof mpid, 0);
254 }
255
256 static bool
257 cfm_is_valid_mpid(bool extended, uint64_t mpid)
258 {
259     /* 802.1ag specification requires MPIDs to be within the range [1, 8191].
260      * In extended mode we relax this requirement. */
261     return mpid >= 1 && (extended || mpid <= 8191);
262 }
263
264 static struct remote_mp *
265 lookup_remote_mp(const struct cfm *cfm, uint64_t mpid)
266 {
267     struct remote_mp *rmp;
268
269     HMAP_FOR_EACH_IN_BUCKET (rmp, node, hash_mpid(mpid), &cfm->remote_mps) {
270         if (rmp->mpid == mpid) {
271             return rmp;
272         }
273     }
274
275     return NULL;
276 }
277
278 void
279 cfm_init(void)
280 {
281     unixctl_command_register("cfm/show", "[interface]", 0, 1, cfm_unixctl_show,
282                              NULL);
283     unixctl_command_register("cfm/set-fault", "[interface] normal|false|true",
284                              1, 2, cfm_unixctl_set_fault, NULL);
285 }
286
287 /* Allocates a 'cfm' object called 'name'.  'cfm' should be initialized by
288  * cfm_configure() before use. */
289 struct cfm *
290 cfm_create(const char *name)
291 {
292     struct cfm *cfm;
293
294     cfm = xzalloc(sizeof *cfm);
295     cfm->name = xstrdup(name);
296     hmap_init(&cfm->remote_mps);
297     cfm_generate_maid(cfm);
298     hmap_insert(&all_cfms, &cfm->hmap_node, hash_string(cfm->name, 0));
299     cfm->remote_opup = true;
300     cfm->fault_override = -1;
301     cfm->health = -1;
302     return cfm;
303 }
304
305 void
306 cfm_destroy(struct cfm *cfm)
307 {
308     struct remote_mp *rmp, *rmp_next;
309
310     if (!cfm) {
311         return;
312     }
313
314     HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &cfm->remote_mps) {
315         hmap_remove(&cfm->remote_mps, &rmp->node);
316         free(rmp);
317     }
318
319     hmap_destroy(&cfm->remote_mps);
320     hmap_remove(&all_cfms, &cfm->hmap_node);
321     free(cfm->rmps_array);
322     free(cfm->name);
323     free(cfm);
324 }
325
326 /* Should be run periodically to update fault statistics messages. */
327 void
328 cfm_run(struct cfm *cfm)
329 {
330     if (timer_expired(&cfm->fault_timer)) {
331         long long int interval = cfm_fault_interval(cfm);
332         struct remote_mp *rmp, *rmp_next;
333         bool old_cfm_fault = cfm->fault;
334
335         cfm->fault = cfm->recv_fault;
336         cfm->recv_fault = 0;
337
338         cfm->rmps_array_len = 0;
339         free(cfm->rmps_array);
340         cfm->rmps_array = xmalloc(hmap_count(&cfm->remote_mps) *
341                                   sizeof *cfm->rmps_array);
342
343         cfm->remote_opup = true;
344         if (cfm->health_interval == CFM_HEALTH_INTERVAL) {
345             /* Calculate the cfm health of the interface.  If the number of
346              * remote_mpids of a cfm interface is > 1, the cfm health is
347              * undefined. If the number of remote_mpids is 1, the cfm health is
348              * the percentage of the ccm frames received in the
349              * (CFM_HEALTH_INTERVAL * 3.5)ms, else it is 0. */
350             if (hmap_count(&cfm->remote_mps) > 1) {
351                 cfm->health = -1;
352             } else if (hmap_is_empty(&cfm->remote_mps)) {
353                 cfm->health = 0;
354             } else {
355                 int exp_ccm_recvd;
356
357                 rmp = CONTAINER_OF(hmap_first(&cfm->remote_mps),
358                                    struct remote_mp, node);
359                 exp_ccm_recvd = (CFM_HEALTH_INTERVAL * 7) / 2;
360                 /* Calculate the percentage of healthy ccm frames received.
361                  * Since the 'fault_interval' is (3.5 * cfm_interval), and
362                  * 1 CCM packet must be received every cfm_interval,
363                  * the 'remote_mpid' health reports the percentage of
364                  * healthy CCM frames received every
365                  * 'CFM_HEALTH_INTERVAL'th 'fault_interval'. */
366                 cfm->health = (rmp->num_health_ccm * 100) / exp_ccm_recvd;
367                 cfm->health = MIN(cfm->health, 100);
368                 rmp->num_health_ccm = 0;
369                 assert(cfm->health >= 0 && cfm->health <= 100);
370             }
371             cfm->health_interval = 0;
372         }
373         cfm->health_interval++;
374
375         HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &cfm->remote_mps) {
376
377             if (!rmp->recv) {
378                 VLOG_DBG("%s: no CCM from RMP %"PRIu64" in the last %lldms",
379                          cfm->name, rmp->mpid, interval);
380                 hmap_remove(&cfm->remote_mps, &rmp->node);
381                 free(rmp);
382             } else {
383                 rmp->recv = false;
384
385                 if (!rmp->opup) {
386                     cfm->remote_opup = rmp->opup;
387                 }
388
389                 cfm->rmps_array[cfm->rmps_array_len++] = rmp->mpid;
390             }
391         }
392
393         if (hmap_is_empty(&cfm->remote_mps)) {
394             cfm->fault |= CFM_FAULT_RECV;
395         }
396
397         if (old_cfm_fault != cfm->fault && !VLOG_DROP_INFO(&rl)) {
398             struct ds ds = DS_EMPTY_INITIALIZER;
399
400             ds_put_cfm_fault(&ds, old_cfm_fault, cfm->fault);
401             VLOG_INFO("%s: CFM fault status changed:%s", cfm->name,
402                       ds_cstr_ro(&ds));
403             ds_destroy(&ds);
404         }
405
406         timer_set_duration(&cfm->fault_timer, interval);
407     }
408 }
409
410 /* Should be run periodically to check if the CFM module has a CCM message it
411  * wishes to send. */
412 bool
413 cfm_should_send_ccm(struct cfm *cfm)
414 {
415     return timer_expired(&cfm->tx_timer);
416 }
417
418 /* Composes a CCM message into 'packet'.  Messages generated with this function
419  * should be sent whenever cfm_should_send_ccm() indicates. */
420 void
421 cfm_compose_ccm(struct cfm *cfm, struct ofpbuf *packet,
422                 uint8_t eth_src[ETH_ADDR_LEN])
423 {
424     uint16_t ccm_vlan;
425     struct ccm *ccm;
426
427     timer_set_duration(&cfm->tx_timer, cfm->ccm_interval_ms);
428     eth_compose(packet, cfm_ccm_addr(cfm), eth_src, ETH_TYPE_CFM, sizeof *ccm);
429
430     ccm_vlan = (cfm->ccm_vlan != CFM_RANDOM_VLAN
431                 ? cfm->ccm_vlan
432                 : random_uint16());
433     ccm_vlan = ccm_vlan & VLAN_VID_MASK;
434
435     if (ccm_vlan || cfm->ccm_pcp) {
436         uint16_t tci = ccm_vlan | (cfm->ccm_pcp << VLAN_PCP_SHIFT);
437         eth_push_vlan(packet, htons(tci));
438     }
439
440     ccm = packet->l3;
441     ccm->mdlevel_version = 0;
442     ccm->opcode = CCM_OPCODE;
443     ccm->tlv_offset = 70;
444     ccm->seq = htonl(++cfm->seq);
445     ccm->flags = cfm->ccm_interval;
446     memcpy(ccm->maid, cfm->maid, sizeof ccm->maid);
447     memset(ccm->zero, 0, sizeof ccm->zero);
448     ccm->end_tlv = 0;
449
450     if (cfm->extended) {
451         ccm->mpid = htons(hash_mpid(cfm->mpid));
452         ccm->mpid64 = htonll(cfm->mpid);
453         ccm->opdown = !cfm->opup;
454     } else {
455         ccm->mpid = htons(cfm->mpid);
456         ccm->mpid64 = htonll(0);
457         ccm->opdown = 0;
458     }
459
460     if (cfm->ccm_interval == 0) {
461         assert(cfm->extended);
462         ccm->interval_ms_x = htons(cfm->ccm_interval_ms);
463     }
464
465     if (hmap_is_empty(&cfm->remote_mps)) {
466         ccm->flags |= CCM_RDI_MASK;
467     }
468 }
469
470 void
471 cfm_wait(struct cfm *cfm)
472 {
473     timer_wait(&cfm->tx_timer);
474     timer_wait(&cfm->fault_timer);
475 }
476
477 /* Configures 'cfm' with settings from 's'. */
478 bool
479 cfm_configure(struct cfm *cfm, const struct cfm_settings *s)
480 {
481     uint8_t interval;
482     int interval_ms;
483
484     if (!cfm_is_valid_mpid(s->extended, s->mpid) || s->interval <= 0) {
485         return false;
486     }
487
488     cfm->mpid = s->mpid;
489     cfm->extended = s->extended;
490     cfm->opup = s->opup;
491     interval = ms_to_ccm_interval(s->interval);
492     interval_ms = ccm_interval_to_ms(interval);
493
494     cfm->ccm_vlan = s->ccm_vlan;
495     cfm->ccm_pcp = s->ccm_pcp & (VLAN_PCP_MASK >> VLAN_PCP_SHIFT);
496     if (cfm->extended && interval_ms != s->interval) {
497         interval = 0;
498         interval_ms = MIN(s->interval, UINT16_MAX);
499     }
500
501     if (interval != cfm->ccm_interval || interval_ms != cfm->ccm_interval_ms) {
502         cfm->ccm_interval = interval;
503         cfm->ccm_interval_ms = interval_ms;
504
505         timer_set_expired(&cfm->tx_timer);
506         timer_set_duration(&cfm->fault_timer, cfm_fault_interval(cfm));
507     }
508
509     return true;
510 }
511
512 /* Returns true if 'cfm' should process packets from 'flow'. */
513 bool
514 cfm_should_process_flow(const struct cfm *cfm, const struct flow *flow)
515 {
516     return (ntohs(flow->dl_type) == ETH_TYPE_CFM
517             && eth_addr_equals(flow->dl_dst, cfm_ccm_addr(cfm)));
518 }
519
520 /* Updates internal statistics relevant to packet 'p'.  Should be called on
521  * every packet whose flow returned true when passed to
522  * cfm_should_process_flow. */
523 void
524 cfm_process_heartbeat(struct cfm *cfm, const struct ofpbuf *p)
525 {
526     struct ccm *ccm;
527     struct eth_header *eth;
528
529     eth = p->l2;
530     ccm = ofpbuf_at(p, (uint8_t *)p->l3 - (uint8_t *)p->data, CCM_ACCEPT_LEN);
531
532     if (!ccm) {
533         VLOG_INFO_RL(&rl, "%s: Received an unparseable 802.1ag CCM heartbeat.",
534                      cfm->name);
535         return;
536     }
537
538     if (ccm->opcode != CCM_OPCODE) {
539         VLOG_INFO_RL(&rl, "%s: Received an unsupported 802.1ag message. "
540                      "(opcode %u)", cfm->name, ccm->opcode);
541         return;
542     }
543
544     /* According to the 802.1ag specification, reception of a CCM with an
545      * incorrect ccm_interval, unexpected MAID, or unexpected MPID should
546      * trigger a fault.  We ignore this requirement for several reasons.
547      *
548      * Faults can cause a controller or Open vSwitch to make potentially
549      * expensive changes to the network topology.  It seems prudent to trigger
550      * them judiciously, especially when CFM is used to check slave status of
551      * bonds. Furthermore, faults can be maliciously triggered by crafting
552      * unexpected CCMs. */
553     if (memcmp(ccm->maid, cfm->maid, sizeof ccm->maid)) {
554         cfm->recv_fault |= CFM_FAULT_MAID;
555         VLOG_WARN_RL(&rl, "%s: Received unexpected remote MAID from MAC "
556                      ETH_ADDR_FMT, cfm->name, ETH_ADDR_ARGS(eth->eth_src));
557     } else {
558         uint8_t ccm_interval = ccm->flags & 0x7;
559         bool ccm_rdi = ccm->flags & CCM_RDI_MASK;
560         uint16_t ccm_interval_ms_x = ntohs(ccm->interval_ms_x);
561
562         struct remote_mp *rmp;
563         uint64_t ccm_mpid;
564         uint32_t ccm_seq;
565         bool ccm_opdown;
566         enum cfm_fault_reason cfm_fault = 0;
567
568         if (cfm->extended) {
569             ccm_mpid = ntohll(ccm->mpid64);
570             ccm_opdown = ccm->opdown;
571         } else {
572             ccm_mpid = ntohs(ccm->mpid);
573             ccm_opdown = false;
574         }
575         ccm_seq = ntohl(ccm->seq);
576
577         if (ccm_interval != cfm->ccm_interval) {
578             cfm_fault |= CFM_FAULT_INTERVAL;
579             VLOG_WARN_RL(&rl, "%s: received a CCM with an unexpected interval"
580                          " (%"PRIu8") from RMP %"PRIu64, cfm->name,
581                          ccm_interval, ccm_mpid);
582         }
583
584         if (cfm->extended && ccm_interval == 0
585             && ccm_interval_ms_x != cfm->ccm_interval_ms) {
586             cfm_fault |= CFM_FAULT_INTERVAL;
587             VLOG_WARN_RL(&rl, "%s: received a CCM with an unexpected extended"
588                          " interval (%"PRIu16"ms) from RMP %"PRIu64, cfm->name,
589                          ccm_interval_ms_x, ccm_mpid);
590         }
591
592         rmp = lookup_remote_mp(cfm, ccm_mpid);
593         if (!rmp) {
594             if (hmap_count(&cfm->remote_mps) < CFM_MAX_RMPS) {
595                 rmp = xzalloc(sizeof *rmp);
596                 hmap_insert(&cfm->remote_mps, &rmp->node, hash_mpid(ccm_mpid));
597             } else {
598                 cfm_fault |= CFM_FAULT_OVERFLOW;
599                 VLOG_WARN_RL(&rl,
600                              "%s: dropped CCM with MPID %"PRIu64" from MAC "
601                              ETH_ADDR_FMT, cfm->name, ccm_mpid,
602                              ETH_ADDR_ARGS(eth->eth_src));
603             }
604         }
605
606         if (ccm_rdi) {
607             cfm_fault |= CFM_FAULT_RDI;
608             VLOG_DBG("%s: RDI bit flagged from RMP %"PRIu64, cfm->name,
609                      rmp->mpid);
610         }
611
612         VLOG_DBG("%s: received CCM (seq %"PRIu32") (mpid %"PRIu64")"
613                  " (interval %"PRIu8") (RDI %s)", cfm->name, ccm_seq,
614                  ccm_mpid, ccm_interval, ccm_rdi ? "true" : "false");
615
616         if (rmp) {
617             if (rmp->mpid == cfm->mpid) {
618                 cfm_fault |= CFM_FAULT_LOOPBACK;
619                 VLOG_WARN_RL(&rl,"%s: received CCM with local MPID"
620                              " %"PRIu64, cfm->name, rmp->mpid);
621             }
622
623             if (rmp->seq && ccm_seq != (rmp->seq + 1)) {
624                 cfm_fault |= CFM_FAULT_SEQUENCE;
625                 VLOG_WARN_RL(&rl, "%s: (mpid %"PRIu64") detected sequence"
626                              " numbers which indicate possible connectivity"
627                              " problems (previous %"PRIu32") (current %"PRIu32
628                              ")", cfm->name, ccm_mpid, rmp->seq, ccm_seq);
629             }
630
631             rmp->mpid = ccm_mpid;
632             if (!cfm_fault) {
633                 rmp->num_health_ccm++;
634             }
635             rmp->recv = true;
636             cfm->recv_fault |= cfm_fault;
637             rmp->seq = ccm_seq;
638             rmp->opup = !ccm_opdown;
639         }
640     }
641 }
642
643 /* Gets the fault status of 'cfm'.  Returns a bit mask of 'cfm_fault_reason's
644  * indicating the cause of the connectivity fault, or zero if there is no
645  * fault. */
646 int
647 cfm_get_fault(const struct cfm *cfm)
648 {
649     if (cfm->fault_override >= 0) {
650         return cfm->fault_override ? CFM_FAULT_OVERRIDE : 0;
651     }
652     return cfm->fault;
653 }
654
655 /* Gets the health of 'cfm'.  Returns an integer between 0 and 100 indicating
656  * the health of the link as a percentage of ccm frames received in
657  * CFM_HEALTH_INTERVAL * 'fault_interval' if there is only 1 remote_mpid,
658  * returns 0 if there are no remote_mpids, and returns -1 if there are more
659  * than 1 remote_mpids. */
660 int
661 cfm_get_health(const struct cfm *cfm)
662 {
663     return cfm->health;
664 }
665
666 /* Gets the operational state of 'cfm'.  'cfm' is considered operationally down
667  * if it has received a CCM with the operationally down bit set from any of its
668  * remote maintenance points. Returns true if 'cfm' is operationally up. False
669  * otherwise. */
670 bool
671 cfm_get_opup(const struct cfm *cfm)
672 {
673     return cfm->remote_opup;
674 }
675
676 /* Populates 'rmps' with an array of remote maintenance points reachable by
677  * 'cfm'. The number of remote maintenance points is written to 'n_rmps'.
678  * 'cfm' retains ownership of the array written to 'rmps' */
679 void
680 cfm_get_remote_mpids(const struct cfm *cfm, const uint64_t **rmps,
681                      size_t *n_rmps)
682 {
683     *rmps = cfm->rmps_array;
684     *n_rmps = cfm->rmps_array_len;
685 }
686
687 static struct cfm *
688 cfm_find(const char *name)
689 {
690     struct cfm *cfm;
691
692     HMAP_FOR_EACH_WITH_HASH (cfm, hmap_node, hash_string(name, 0), &all_cfms) {
693         if (!strcmp(cfm->name, name)) {
694             return cfm;
695         }
696     }
697     return NULL;
698 }
699
700 static void
701 cfm_print_details(struct ds *ds, const struct cfm *cfm)
702 {
703     struct remote_mp *rmp;
704     int fault;
705
706     ds_put_format(ds, "---- %s ----\n", cfm->name);
707     ds_put_format(ds, "MPID %"PRIu64":%s%s\n", cfm->mpid,
708                   cfm->extended ? " extended" : "",
709                   cfm->fault_override >= 0 ? " fault_override" : "");
710
711     fault = cfm_get_fault(cfm);
712     if (fault) {
713         ds_put_cstr(ds, "\tfault:");
714         ds_put_cfm_fault(ds, fault, fault);
715         ds_put_cstr(ds, "\n");
716     }
717
718     if (cfm->health == -1) {
719         ds_put_format(ds, "\taverage health: undefined\n");
720     } else {
721         ds_put_format(ds, "\taverage health: %d\n", cfm->health);
722     }
723     ds_put_format(ds, "\topstate: %s\n", cfm->opup ? "up" : "down");
724     ds_put_format(ds, "\tremote_opstate: %s\n",
725                   cfm->remote_opup ? "up" : "down");
726     ds_put_format(ds, "\tinterval: %dms\n", cfm->ccm_interval_ms);
727     ds_put_format(ds, "\tnext CCM tx: %lldms\n",
728                   timer_msecs_until_expired(&cfm->tx_timer));
729     ds_put_format(ds, "\tnext fault check: %lldms\n",
730                   timer_msecs_until_expired(&cfm->fault_timer));
731
732     HMAP_FOR_EACH (rmp, node, &cfm->remote_mps) {
733         ds_put_format(ds, "Remote MPID %"PRIu64"\n", rmp->mpid);
734         ds_put_format(ds, "\trecv since check: %s\n",
735                       rmp->recv ? "true" : "false");
736         ds_put_format(ds, "\topstate: %s\n", rmp->opup? "up" : "down");
737     }
738 }
739
740 static void
741 cfm_unixctl_show(struct unixctl_conn *conn, int argc, const char *argv[],
742                  void *aux OVS_UNUSED)
743 {
744     struct ds ds = DS_EMPTY_INITIALIZER;
745     const struct cfm *cfm;
746
747     if (argc > 1) {
748         cfm = cfm_find(argv[1]);
749         if (!cfm) {
750             unixctl_command_reply_error(conn, "no such CFM object");
751             return;
752         }
753         cfm_print_details(&ds, cfm);
754     } else {
755         HMAP_FOR_EACH (cfm, hmap_node, &all_cfms) {
756             cfm_print_details(&ds, cfm);
757         }
758     }
759
760     unixctl_command_reply(conn, ds_cstr(&ds));
761     ds_destroy(&ds);
762 }
763
764 static void
765 cfm_unixctl_set_fault(struct unixctl_conn *conn, int argc, const char *argv[],
766                       void *aux OVS_UNUSED)
767 {
768     const char *fault_str = argv[argc - 1];
769     int fault_override;
770     struct cfm *cfm;
771
772     if (!strcasecmp("true", fault_str)) {
773         fault_override = 1;
774     } else if (!strcasecmp("false", fault_str)) {
775         fault_override = 0;
776     } else if (!strcasecmp("normal", fault_str)) {
777         fault_override = -1;
778     } else {
779         unixctl_command_reply_error(conn, "unknown fault string");
780         return;
781     }
782
783     if (argc > 2) {
784         cfm = cfm_find(argv[1]);
785         if (!cfm) {
786             unixctl_command_reply_error(conn, "no such CFM object");
787             return;
788         }
789         cfm->fault_override = fault_override;
790     } else {
791         HMAP_FOR_EACH (cfm, hmap_node, &all_cfms) {
792             cfm->fault_override = fault_override;
793         }
794     }
795
796     unixctl_command_reply(conn, "OK");
797 }