cfm: Minor whitespace cleanup.
[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     long long int last_tx;    /* Last CCM transmission time. */
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     cfm->last_tx = 0;
303     return cfm;
304 }
305
306 void
307 cfm_destroy(struct cfm *cfm)
308 {
309     struct remote_mp *rmp, *rmp_next;
310
311     if (!cfm) {
312         return;
313     }
314
315     HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &cfm->remote_mps) {
316         hmap_remove(&cfm->remote_mps, &rmp->node);
317         free(rmp);
318     }
319
320     hmap_destroy(&cfm->remote_mps);
321     hmap_remove(&all_cfms, &cfm->hmap_node);
322     free(cfm->rmps_array);
323     free(cfm->name);
324     free(cfm);
325 }
326
327 /* Should be run periodically to update fault statistics messages. */
328 void
329 cfm_run(struct cfm *cfm)
330 {
331     if (timer_expired(&cfm->fault_timer)) {
332         long long int interval = cfm_fault_interval(cfm);
333         struct remote_mp *rmp, *rmp_next;
334         bool old_cfm_fault = cfm->fault;
335
336         cfm->fault = cfm->recv_fault;
337         cfm->recv_fault = 0;
338
339         cfm->rmps_array_len = 0;
340         free(cfm->rmps_array);
341         cfm->rmps_array = xmalloc(hmap_count(&cfm->remote_mps) *
342                                   sizeof *cfm->rmps_array);
343
344         cfm->remote_opup = true;
345         if (cfm->health_interval == CFM_HEALTH_INTERVAL) {
346             /* Calculate the cfm health of the interface.  If the number of
347              * remote_mpids of a cfm interface is > 1, the cfm health is
348              * undefined. If the number of remote_mpids is 1, the cfm health is
349              * the percentage of the ccm frames received in the
350              * (CFM_HEALTH_INTERVAL * 3.5)ms, else it is 0. */
351             if (hmap_count(&cfm->remote_mps) > 1) {
352                 cfm->health = -1;
353             } else if (hmap_is_empty(&cfm->remote_mps)) {
354                 cfm->health = 0;
355             } else {
356                 int exp_ccm_recvd;
357
358                 rmp = CONTAINER_OF(hmap_first(&cfm->remote_mps),
359                                    struct remote_mp, node);
360                 exp_ccm_recvd = (CFM_HEALTH_INTERVAL * 7) / 2;
361                 /* Calculate the percentage of healthy ccm frames received.
362                  * Since the 'fault_interval' is (3.5 * cfm_interval), and
363                  * 1 CCM packet must be received every cfm_interval,
364                  * the 'remote_mpid' health reports the percentage of
365                  * healthy CCM frames received every
366                  * 'CFM_HEALTH_INTERVAL'th 'fault_interval'. */
367                 cfm->health = (rmp->num_health_ccm * 100) / exp_ccm_recvd;
368                 cfm->health = MIN(cfm->health, 100);
369                 rmp->num_health_ccm = 0;
370                 assert(cfm->health >= 0 && cfm->health <= 100);
371             }
372             cfm->health_interval = 0;
373         }
374         cfm->health_interval++;
375
376         HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &cfm->remote_mps) {
377
378             if (!rmp->recv) {
379                 VLOG_DBG("%s: no CCM from RMP %"PRIu64" in the last %lldms",
380                          cfm->name, rmp->mpid, interval);
381                 hmap_remove(&cfm->remote_mps, &rmp->node);
382                 free(rmp);
383             } else {
384                 rmp->recv = false;
385
386                 if (!rmp->opup) {
387                     cfm->remote_opup = rmp->opup;
388                 }
389
390                 cfm->rmps_array[cfm->rmps_array_len++] = rmp->mpid;
391             }
392         }
393
394         if (hmap_is_empty(&cfm->remote_mps)) {
395             cfm->fault |= CFM_FAULT_RECV;
396         }
397
398         if (old_cfm_fault != cfm->fault && !VLOG_DROP_INFO(&rl)) {
399             struct ds ds = DS_EMPTY_INITIALIZER;
400
401             ds_put_cfm_fault(&ds, old_cfm_fault, cfm->fault);
402             VLOG_INFO("%s: CFM fault status changed:%s", cfm->name,
403                       ds_cstr_ro(&ds));
404             ds_destroy(&ds);
405         }
406
407         timer_set_duration(&cfm->fault_timer, interval);
408         VLOG_DBG("%s: new fault interval", cfm->name);
409     }
410 }
411
412 /* Should be run periodically to check if the CFM module has a CCM message it
413  * wishes to send. */
414 bool
415 cfm_should_send_ccm(struct cfm *cfm)
416 {
417     return timer_expired(&cfm->tx_timer);
418 }
419
420 /* Composes a CCM message into 'packet'.  Messages generated with this function
421  * should be sent whenever cfm_should_send_ccm() indicates. */
422 void
423 cfm_compose_ccm(struct cfm *cfm, struct ofpbuf *packet,
424                 uint8_t eth_src[ETH_ADDR_LEN])
425 {
426     uint16_t ccm_vlan;
427     struct ccm *ccm;
428
429     timer_set_duration(&cfm->tx_timer, cfm->ccm_interval_ms);
430     eth_compose(packet, cfm_ccm_addr(cfm), eth_src, ETH_TYPE_CFM, sizeof *ccm);
431
432     ccm_vlan = (cfm->ccm_vlan != CFM_RANDOM_VLAN
433                 ? cfm->ccm_vlan
434                 : random_uint16());
435     ccm_vlan = ccm_vlan & VLAN_VID_MASK;
436
437     if (ccm_vlan || cfm->ccm_pcp) {
438         uint16_t tci = ccm_vlan | (cfm->ccm_pcp << VLAN_PCP_SHIFT);
439         eth_push_vlan(packet, htons(tci));
440     }
441
442     ccm = packet->l3;
443     ccm->mdlevel_version = 0;
444     ccm->opcode = CCM_OPCODE;
445     ccm->tlv_offset = 70;
446     ccm->seq = htonl(++cfm->seq);
447     ccm->flags = cfm->ccm_interval;
448     memcpy(ccm->maid, cfm->maid, sizeof ccm->maid);
449     memset(ccm->zero, 0, sizeof ccm->zero);
450     ccm->end_tlv = 0;
451
452     if (cfm->extended) {
453         ccm->mpid = htons(hash_mpid(cfm->mpid));
454         ccm->mpid64 = htonll(cfm->mpid);
455         ccm->opdown = !cfm->opup;
456     } else {
457         ccm->mpid = htons(cfm->mpid);
458         ccm->mpid64 = htonll(0);
459         ccm->opdown = 0;
460     }
461
462     if (cfm->ccm_interval == 0) {
463         assert(cfm->extended);
464         ccm->interval_ms_x = htons(cfm->ccm_interval_ms);
465     }
466
467     if (hmap_is_empty(&cfm->remote_mps)) {
468         ccm->flags |= CCM_RDI_MASK;
469     }
470
471     if (cfm->last_tx) {
472         long long int delay = time_msec() - cfm->last_tx;
473         if (delay > (cfm->ccm_interval_ms * 3 / 2)) {
474             VLOG_WARN("%s: long delay of %lldms (expected %dms) sending CCM"
475                       " seq %"PRIu32, cfm->name, delay, cfm->ccm_interval_ms,
476                       cfm->seq);
477         }
478     }
479     cfm->last_tx = time_msec();
480 }
481
482 void
483 cfm_wait(struct cfm *cfm)
484 {
485     timer_wait(&cfm->tx_timer);
486     timer_wait(&cfm->fault_timer);
487 }
488
489 /* Configures 'cfm' with settings from 's'. */
490 bool
491 cfm_configure(struct cfm *cfm, const struct cfm_settings *s)
492 {
493     uint8_t interval;
494     int interval_ms;
495
496     if (!cfm_is_valid_mpid(s->extended, s->mpid) || s->interval <= 0) {
497         return false;
498     }
499
500     cfm->mpid = s->mpid;
501     cfm->extended = s->extended;
502     cfm->opup = s->opup;
503     interval = ms_to_ccm_interval(s->interval);
504     interval_ms = ccm_interval_to_ms(interval);
505
506     cfm->ccm_vlan = s->ccm_vlan;
507     cfm->ccm_pcp = s->ccm_pcp & (VLAN_PCP_MASK >> VLAN_PCP_SHIFT);
508     if (cfm->extended && interval_ms != s->interval) {
509         interval = 0;
510         interval_ms = MIN(s->interval, UINT16_MAX);
511     }
512
513     if (interval != cfm->ccm_interval || interval_ms != cfm->ccm_interval_ms) {
514         cfm->ccm_interval = interval;
515         cfm->ccm_interval_ms = interval_ms;
516
517         timer_set_expired(&cfm->tx_timer);
518         timer_set_duration(&cfm->fault_timer, cfm_fault_interval(cfm));
519     }
520
521     return true;
522 }
523
524 /* Returns true if 'cfm' should process packets from 'flow'. */
525 bool
526 cfm_should_process_flow(const struct cfm *cfm, const struct flow *flow)
527 {
528     return (ntohs(flow->dl_type) == ETH_TYPE_CFM
529             && eth_addr_equals(flow->dl_dst, cfm_ccm_addr(cfm)));
530 }
531
532 /* Updates internal statistics relevant to packet 'p'.  Should be called on
533  * every packet whose flow returned true when passed to
534  * cfm_should_process_flow. */
535 void
536 cfm_process_heartbeat(struct cfm *cfm, const struct ofpbuf *p)
537 {
538     struct ccm *ccm;
539     struct eth_header *eth;
540
541     eth = p->l2;
542     ccm = ofpbuf_at(p, (uint8_t *)p->l3 - (uint8_t *)p->data, CCM_ACCEPT_LEN);
543
544     if (!ccm) {
545         VLOG_INFO_RL(&rl, "%s: Received an unparseable 802.1ag CCM heartbeat.",
546                      cfm->name);
547         return;
548     }
549
550     if (ccm->opcode != CCM_OPCODE) {
551         VLOG_INFO_RL(&rl, "%s: Received an unsupported 802.1ag message. "
552                      "(opcode %u)", cfm->name, ccm->opcode);
553         return;
554     }
555
556     /* According to the 802.1ag specification, reception of a CCM with an
557      * incorrect ccm_interval, unexpected MAID, or unexpected MPID should
558      * trigger a fault.  We ignore this requirement for several reasons.
559      *
560      * Faults can cause a controller or Open vSwitch to make potentially
561      * expensive changes to the network topology.  It seems prudent to trigger
562      * them judiciously, especially when CFM is used to check slave status of
563      * bonds. Furthermore, faults can be maliciously triggered by crafting
564      * unexpected CCMs. */
565     if (memcmp(ccm->maid, cfm->maid, sizeof ccm->maid)) {
566         cfm->recv_fault |= CFM_FAULT_MAID;
567         VLOG_WARN_RL(&rl, "%s: Received unexpected remote MAID from MAC "
568                      ETH_ADDR_FMT, cfm->name, ETH_ADDR_ARGS(eth->eth_src));
569     } else {
570         uint8_t ccm_interval = ccm->flags & 0x7;
571         bool ccm_rdi = ccm->flags & CCM_RDI_MASK;
572         uint16_t ccm_interval_ms_x = ntohs(ccm->interval_ms_x);
573
574         struct remote_mp *rmp;
575         uint64_t ccm_mpid;
576         uint32_t ccm_seq;
577         bool ccm_opdown;
578         enum cfm_fault_reason cfm_fault = 0;
579
580         if (cfm->extended) {
581             ccm_mpid = ntohll(ccm->mpid64);
582             ccm_opdown = ccm->opdown;
583         } else {
584             ccm_mpid = ntohs(ccm->mpid);
585             ccm_opdown = false;
586         }
587         ccm_seq = ntohl(ccm->seq);
588
589         if (ccm_interval != cfm->ccm_interval) {
590             cfm_fault |= CFM_FAULT_INTERVAL;
591             VLOG_WARN_RL(&rl, "%s: received a CCM with an unexpected interval"
592                          " (%"PRIu8") from RMP %"PRIu64, cfm->name,
593                          ccm_interval, ccm_mpid);
594         }
595
596         if (cfm->extended && ccm_interval == 0
597             && ccm_interval_ms_x != cfm->ccm_interval_ms) {
598             cfm_fault |= CFM_FAULT_INTERVAL;
599             VLOG_WARN_RL(&rl, "%s: received a CCM with an unexpected extended"
600                          " interval (%"PRIu16"ms) from RMP %"PRIu64, cfm->name,
601                          ccm_interval_ms_x, ccm_mpid);
602         }
603
604         rmp = lookup_remote_mp(cfm, ccm_mpid);
605         if (!rmp) {
606             if (hmap_count(&cfm->remote_mps) < CFM_MAX_RMPS) {
607                 rmp = xzalloc(sizeof *rmp);
608                 hmap_insert(&cfm->remote_mps, &rmp->node, hash_mpid(ccm_mpid));
609             } else {
610                 cfm_fault |= CFM_FAULT_OVERFLOW;
611                 VLOG_WARN_RL(&rl,
612                              "%s: dropped CCM with MPID %"PRIu64" from MAC "
613                              ETH_ADDR_FMT, cfm->name, ccm_mpid,
614                              ETH_ADDR_ARGS(eth->eth_src));
615             }
616         }
617
618         if (ccm_rdi) {
619             cfm_fault |= CFM_FAULT_RDI;
620             VLOG_DBG("%s: RDI bit flagged from RMP %"PRIu64, cfm->name,
621                      ccm_mpid);
622         }
623
624         VLOG_DBG("%s: received CCM (seq %"PRIu32") (mpid %"PRIu64")"
625                  " (interval %"PRIu8") (RDI %s)", cfm->name, ccm_seq,
626                  ccm_mpid, ccm_interval, ccm_rdi ? "true" : "false");
627
628         if (rmp) {
629             if (rmp->mpid == cfm->mpid) {
630                 cfm_fault |= CFM_FAULT_LOOPBACK;
631                 VLOG_WARN_RL(&rl,"%s: received CCM with local MPID"
632                              " %"PRIu64, cfm->name, rmp->mpid);
633             }
634
635             if (rmp->seq && ccm_seq != (rmp->seq + 1)) {
636                 cfm_fault |= CFM_FAULT_SEQUENCE;
637                 VLOG_WARN_RL(&rl, "%s: (mpid %"PRIu64") detected sequence"
638                              " numbers which indicate possible connectivity"
639                              " problems (previous %"PRIu32") (current %"PRIu32
640                              ")", cfm->name, ccm_mpid, rmp->seq, ccm_seq);
641             }
642
643             rmp->mpid = ccm_mpid;
644             if (!cfm_fault) {
645                 rmp->num_health_ccm++;
646             }
647             rmp->recv = true;
648             cfm->recv_fault |= cfm_fault;
649             rmp->seq = ccm_seq;
650             rmp->opup = !ccm_opdown;
651         }
652     }
653 }
654
655 /* Gets the fault status of 'cfm'.  Returns a bit mask of 'cfm_fault_reason's
656  * indicating the cause of the connectivity fault, or zero if there is no
657  * fault. */
658 int
659 cfm_get_fault(const struct cfm *cfm)
660 {
661     if (cfm->fault_override >= 0) {
662         return cfm->fault_override ? CFM_FAULT_OVERRIDE : 0;
663     }
664     return cfm->fault;
665 }
666
667 /* Gets the health of 'cfm'.  Returns an integer between 0 and 100 indicating
668  * the health of the link as a percentage of ccm frames received in
669  * CFM_HEALTH_INTERVAL * 'fault_interval' if there is only 1 remote_mpid,
670  * returns 0 if there are no remote_mpids, and returns -1 if there are more
671  * than 1 remote_mpids. */
672 int
673 cfm_get_health(const struct cfm *cfm)
674 {
675     return cfm->health;
676 }
677
678 /* Gets the operational state of 'cfm'.  'cfm' is considered operationally down
679  * if it has received a CCM with the operationally down bit set from any of its
680  * remote maintenance points. Returns true if 'cfm' is operationally up. False
681  * otherwise. */
682 bool
683 cfm_get_opup(const struct cfm *cfm)
684 {
685     return cfm->remote_opup;
686 }
687
688 /* Populates 'rmps' with an array of remote maintenance points reachable by
689  * 'cfm'. The number of remote maintenance points is written to 'n_rmps'.
690  * 'cfm' retains ownership of the array written to 'rmps' */
691 void
692 cfm_get_remote_mpids(const struct cfm *cfm, const uint64_t **rmps,
693                      size_t *n_rmps)
694 {
695     *rmps = cfm->rmps_array;
696     *n_rmps = cfm->rmps_array_len;
697 }
698
699 static struct cfm *
700 cfm_find(const char *name)
701 {
702     struct cfm *cfm;
703
704     HMAP_FOR_EACH_WITH_HASH (cfm, hmap_node, hash_string(name, 0), &all_cfms) {
705         if (!strcmp(cfm->name, name)) {
706             return cfm;
707         }
708     }
709     return NULL;
710 }
711
712 static void
713 cfm_print_details(struct ds *ds, const struct cfm *cfm)
714 {
715     struct remote_mp *rmp;
716     int fault;
717
718     ds_put_format(ds, "---- %s ----\n", cfm->name);
719     ds_put_format(ds, "MPID %"PRIu64":%s%s\n", cfm->mpid,
720                   cfm->extended ? " extended" : "",
721                   cfm->fault_override >= 0 ? " fault_override" : "");
722
723     fault = cfm_get_fault(cfm);
724     if (fault) {
725         ds_put_cstr(ds, "\tfault:");
726         ds_put_cfm_fault(ds, fault, fault);
727         ds_put_cstr(ds, "\n");
728     }
729
730     if (cfm->health == -1) {
731         ds_put_format(ds, "\taverage health: undefined\n");
732     } else {
733         ds_put_format(ds, "\taverage health: %d\n", cfm->health);
734     }
735     ds_put_format(ds, "\topstate: %s\n", cfm->opup ? "up" : "down");
736     ds_put_format(ds, "\tremote_opstate: %s\n",
737                   cfm->remote_opup ? "up" : "down");
738     ds_put_format(ds, "\tinterval: %dms\n", cfm->ccm_interval_ms);
739     ds_put_format(ds, "\tnext CCM tx: %lldms\n",
740                   timer_msecs_until_expired(&cfm->tx_timer));
741     ds_put_format(ds, "\tnext fault check: %lldms\n",
742                   timer_msecs_until_expired(&cfm->fault_timer));
743
744     HMAP_FOR_EACH (rmp, node, &cfm->remote_mps) {
745         ds_put_format(ds, "Remote MPID %"PRIu64"\n", rmp->mpid);
746         ds_put_format(ds, "\trecv since check: %s\n",
747                       rmp->recv ? "true" : "false");
748         ds_put_format(ds, "\topstate: %s\n", rmp->opup? "up" : "down");
749     }
750 }
751
752 static void
753 cfm_unixctl_show(struct unixctl_conn *conn, int argc, const char *argv[],
754                  void *aux OVS_UNUSED)
755 {
756     struct ds ds = DS_EMPTY_INITIALIZER;
757     const struct cfm *cfm;
758
759     if (argc > 1) {
760         cfm = cfm_find(argv[1]);
761         if (!cfm) {
762             unixctl_command_reply_error(conn, "no such CFM object");
763             return;
764         }
765         cfm_print_details(&ds, cfm);
766     } else {
767         HMAP_FOR_EACH (cfm, hmap_node, &all_cfms) {
768             cfm_print_details(&ds, cfm);
769         }
770     }
771
772     unixctl_command_reply(conn, ds_cstr(&ds));
773     ds_destroy(&ds);
774 }
775
776 static void
777 cfm_unixctl_set_fault(struct unixctl_conn *conn, int argc, const char *argv[],
778                       void *aux OVS_UNUSED)
779 {
780     const char *fault_str = argv[argc - 1];
781     int fault_override;
782     struct cfm *cfm;
783
784     if (!strcasecmp("true", fault_str)) {
785         fault_override = 1;
786     } else if (!strcasecmp("false", fault_str)) {
787         fault_override = 0;
788     } else if (!strcasecmp("normal", fault_str)) {
789         fault_override = -1;
790     } else {
791         unixctl_command_reply_error(conn, "unknown fault string");
792         return;
793     }
794
795     if (argc > 2) {
796         cfm = cfm_find(argv[1]);
797         if (!cfm) {
798             unixctl_command_reply_error(conn, "no such CFM object");
799             return;
800         }
801         cfm->fault_override = fault_override;
802     } else {
803         HMAP_FOR_EACH (cfm, hmap_node, &all_cfms) {
804             cfm->fault_override = fault_override;
805         }
806     }
807
808     unixctl_command_reply(conn, "OK");
809 }