2 * Copyright (c) 2010, 2011, 2012 Nicira, Inc.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
24 #include "byte-order.h"
25 #include "dynamic-string.h"
32 #include "poll-loop.h"
39 VLOG_DEFINE_THIS_MODULE(cfm);
41 #define CFM_MAX_RMPS 256
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
49 #define ETH_TYPE_CFM 0x8902
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.
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. */
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
65 uint8_t mdlevel_version; /* MD Level and Version */
71 uint8_t maid[CCM_MAID_LEN];
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. */
81 } __attribute__((packed));
82 BUILD_ASSERT_DECL(CCM_LEN == sizeof(struct ccm));
85 const char *name; /* Name of this CFM object. */
86 struct hmap_node hmap_node; /* Node in all_cfms list. */
88 struct netdev *netdev;
89 uint64_t rx_packets; /* Packets received by 'netdev'. */
92 bool check_tnl_key; /* Verify the tunnel key of inbound packets? */
93 bool extended; /* Extended mode. */
94 bool demand; /* Demand mode. */
95 bool booted; /* A full fault interval has occurred. */
96 enum cfm_fault_reason fault; /* Connectivity fault status. */
97 enum cfm_fault_reason recv_fault; /* Bit mask of faults occurring on
99 bool opup; /* Operational State. */
100 bool remote_opup; /* Remote Operational State. */
102 int fault_override; /* Manual override of 'fault' status.
103 Ignored if negative. */
105 uint32_t seq; /* The sequence number of our last CCM. */
106 uint8_t ccm_interval; /* The CCM transmission interval. */
107 int ccm_interval_ms; /* 'ccm_interval' in milliseconds. */
108 uint16_t ccm_vlan; /* Vlan tag of CCM PDUs. CFM_RANDOM_VLAN if
110 uint8_t ccm_pcp; /* Priority of CCM PDUs. */
111 uint8_t maid[CCM_MAID_LEN]; /* The MAID of this CFM. */
113 struct timer tx_timer; /* Send CCM when expired. */
114 struct timer fault_timer; /* Check for faults when expired. */
116 struct hmap remote_mps; /* Remote MPs. */
118 /* Result of cfm_get_remote_mpids(). Updated only during fault check to
120 uint64_t *rmps_array; /* Cache of remote_mps. */
121 size_t rmps_array_len; /* Number of rmps in 'rmps_array'. */
123 int health; /* Percentage of the number of CCM frames
125 int health_interval; /* Number of fault_intervals since health was
127 long long int last_tx; /* Last CCM transmission time. */
130 /* Remote MPs represent foreign network entities that are configured to have
131 * the same MAID as this CFM instance. */
133 uint64_t mpid; /* The Maintenance Point ID of this 'remote_mp'. */
134 struct hmap_node node; /* Node in 'remote_mps' map. */
136 bool recv; /* CCM was received since last fault check. */
137 bool opup; /* Operational State. */
138 uint32_t seq; /* Most recently received sequence number. */
139 uint8_t num_health_ccm; /* Number of received ccm frames every
140 CFM_HEALTH_INTERVAL * 'fault_interval'. */
141 long long int last_rx; /* Last CCM reception time. */
145 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(20, 30);
146 static struct hmap all_cfms = HMAP_INITIALIZER(&all_cfms);
148 static unixctl_cb_func cfm_unixctl_show;
149 static unixctl_cb_func cfm_unixctl_set_fault;
152 cfm_rx_packets(const struct cfm *cfm)
154 struct netdev_stats stats;
156 if (!netdev_get_stats(cfm->netdev, &stats)) {
157 return stats.rx_packets;
163 static const uint8_t *
164 cfm_ccm_addr(const struct cfm *cfm)
166 return cfm->extended ? eth_addr_ccm_x : eth_addr_ccm;
169 /* Returns the string representation of the given cfm_fault_reason 'reason'. */
171 cfm_fault_reason_to_str(int reason) {
173 #define CFM_FAULT_REASON(NAME, STR) case CFM_FAULT_##NAME: return #STR;
175 #undef CFM_FAULT_REASON
176 default: return "<unknown>";
181 ds_put_cfm_fault(struct ds *ds, int fault)
185 for (i = 0; i < CFM_FAULT_N_REASONS; i++) {
188 if (fault & reason) {
189 ds_put_format(ds, "%s ", cfm_fault_reason_to_str(reason));
197 cfm_generate_maid(struct cfm *cfm)
199 const char *ovs_md_name = "ovs";
200 const char *ovs_ma_name = "ovs";
202 size_t md_len, ma_len;
204 memset(cfm->maid, 0, CCM_MAID_LEN);
206 md_len = strlen(ovs_md_name);
207 ma_len = strlen(ovs_ma_name);
209 ovs_assert(md_len && ma_len && md_len + ma_len + 4 <= CCM_MAID_LEN);
211 cfm->maid[0] = 4; /* MD name string format. */
212 cfm->maid[1] = md_len; /* MD name size. */
213 memcpy(&cfm->maid[2], ovs_md_name, md_len); /* MD name. */
215 ma_p = cfm->maid + 2 + md_len;
216 ma_p[0] = 2; /* MA name string format. */
217 ma_p[1] = ma_len; /* MA name size. */
218 memcpy(&ma_p[2], ovs_ma_name, ma_len); /* MA name. */
222 ccm_interval_to_ms(uint8_t interval)
225 case 0: NOT_REACHED(); /* Explicitly not supported by 802.1ag. */
226 case 1: return 3; /* Not recommended due to timer resolution. */
227 case 2: return 10; /* Not recommended due to timer resolution. */
230 case 5: return 10000;
231 case 6: return 60000;
232 case 7: return 600000;
233 default: NOT_REACHED(); /* Explicitly not supported by 802.1ag. */
240 cfm_fault_interval(struct cfm *cfm)
242 /* According to the 802.1ag specification we should assume every other MP
243 * with the same MAID has the same transmission interval that we have. If
244 * an MP has a different interval, cfm_process_heartbeat will register it
245 * as a fault (likely due to a configuration error). Thus we can check all
246 * MPs at once making this quite a bit simpler.
248 * According to the specification we should check when (ccm_interval_ms *
249 * 3.5)ms have passed. */
250 return (cfm->ccm_interval_ms * 7) / 2;
254 ms_to_ccm_interval(int interval_ms)
258 for (i = 7; i > 0; i--) {
259 if (ccm_interval_to_ms(i) <= interval_ms) {
268 hash_mpid(uint64_t mpid)
270 return hash_bytes(&mpid, sizeof mpid, 0);
274 cfm_is_valid_mpid(bool extended, uint64_t mpid)
276 /* 802.1ag specification requires MPIDs to be within the range [1, 8191].
277 * In extended mode we relax this requirement. */
278 return mpid >= 1 && (extended || mpid <= 8191);
281 static struct remote_mp *
282 lookup_remote_mp(const struct cfm *cfm, uint64_t mpid)
284 struct remote_mp *rmp;
286 HMAP_FOR_EACH_IN_BUCKET (rmp, node, hash_mpid(mpid), &cfm->remote_mps) {
287 if (rmp->mpid == mpid) {
298 unixctl_command_register("cfm/show", "[interface]", 0, 1, cfm_unixctl_show,
300 unixctl_command_register("cfm/set-fault", "[interface] normal|false|true",
301 1, 2, cfm_unixctl_set_fault, NULL);
304 /* Allocates a 'cfm' object called 'name'. 'cfm' should be initialized by
305 * cfm_configure() before use. */
307 cfm_create(const struct netdev *netdev)
311 cfm = xzalloc(sizeof *cfm);
312 cfm->netdev = netdev_ref(netdev);
313 cfm->name = netdev_get_name(cfm->netdev);
314 hmap_init(&cfm->remote_mps);
315 cfm_generate_maid(cfm);
316 hmap_insert(&all_cfms, &cfm->hmap_node, hash_string(cfm->name, 0));
317 cfm->remote_opup = true;
318 cfm->fault_override = -1;
325 cfm_destroy(struct cfm *cfm)
327 struct remote_mp *rmp, *rmp_next;
333 HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &cfm->remote_mps) {
334 hmap_remove(&cfm->remote_mps, &rmp->node);
338 hmap_destroy(&cfm->remote_mps);
339 hmap_remove(&all_cfms, &cfm->hmap_node);
340 netdev_close(cfm->netdev);
341 free(cfm->rmps_array);
345 /* Should be run periodically to update fault statistics messages. */
347 cfm_run(struct cfm *cfm)
349 if (timer_expired(&cfm->fault_timer)) {
350 long long int interval = cfm_fault_interval(cfm);
351 struct remote_mp *rmp, *rmp_next;
352 bool old_cfm_fault = cfm->fault;
353 bool demand_override;
355 cfm->fault = cfm->recv_fault;
358 cfm->rmps_array_len = 0;
359 free(cfm->rmps_array);
360 cfm->rmps_array = xmalloc(hmap_count(&cfm->remote_mps) *
361 sizeof *cfm->rmps_array);
363 cfm->remote_opup = true;
364 if (cfm->health_interval == CFM_HEALTH_INTERVAL) {
365 /* Calculate the cfm health of the interface. If the number of
366 * remote_mpids of a cfm interface is > 1, the cfm health is
367 * undefined. If the number of remote_mpids is 1, the cfm health is
368 * the percentage of the ccm frames received in the
369 * (CFM_HEALTH_INTERVAL * 3.5)ms, else it is 0. */
370 if (hmap_count(&cfm->remote_mps) > 1) {
372 } else if (hmap_is_empty(&cfm->remote_mps)) {
377 rmp = CONTAINER_OF(hmap_first(&cfm->remote_mps),
378 struct remote_mp, node);
379 exp_ccm_recvd = (CFM_HEALTH_INTERVAL * 7) / 2;
380 /* Calculate the percentage of healthy ccm frames received.
381 * Since the 'fault_interval' is (3.5 * cfm_interval), and
382 * 1 CCM packet must be received every cfm_interval,
383 * the 'remote_mpid' health reports the percentage of
384 * healthy CCM frames received every
385 * 'CFM_HEALTH_INTERVAL'th 'fault_interval'. */
386 cfm->health = (rmp->num_health_ccm * 100) / exp_ccm_recvd;
387 cfm->health = MIN(cfm->health, 100);
388 rmp->num_health_ccm = 0;
389 ovs_assert(cfm->health >= 0 && cfm->health <= 100);
391 cfm->health_interval = 0;
393 cfm->health_interval++;
395 demand_override = false;
397 uint64_t rx_packets = cfm_rx_packets(cfm);
398 demand_override = hmap_count(&cfm->remote_mps) == 1
399 && rx_packets > cfm->rx_packets;
400 cfm->rx_packets = rx_packets;
403 HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &cfm->remote_mps) {
405 VLOG_INFO("%s: Received no CCM from RMP %"PRIu64" in the last"
406 " %lldms", cfm->name, rmp->mpid,
407 time_msec() - rmp->last_rx);
408 if (!demand_override) {
409 hmap_remove(&cfm->remote_mps, &rmp->node);
416 cfm->remote_opup = rmp->opup;
419 cfm->rmps_array[cfm->rmps_array_len++] = rmp->mpid;
423 if (hmap_is_empty(&cfm->remote_mps)) {
424 cfm->fault |= CFM_FAULT_RECV;
427 if (old_cfm_fault != cfm->fault && !VLOG_DROP_INFO(&rl)) {
428 struct ds ds = DS_EMPTY_INITIALIZER;
430 ds_put_cstr(&ds, "from [");
431 ds_put_cfm_fault(&ds, old_cfm_fault);
432 ds_put_cstr(&ds, "] to [");
433 ds_put_cfm_fault(&ds, cfm->fault);
434 ds_put_char(&ds, ']');
435 VLOG_INFO("%s: CFM faults changed %s.", cfm->name, ds_cstr(&ds));
440 timer_set_duration(&cfm->fault_timer, interval);
441 VLOG_DBG("%s: new fault interval", cfm->name);
445 /* Should be run periodically to check if the CFM module has a CCM message it
448 cfm_should_send_ccm(struct cfm *cfm)
450 return timer_expired(&cfm->tx_timer);
453 /* Composes a CCM message into 'packet'. Messages generated with this function
454 * should be sent whenever cfm_should_send_ccm() indicates. */
456 cfm_compose_ccm(struct cfm *cfm, struct ofpbuf *packet,
457 uint8_t eth_src[ETH_ADDR_LEN])
462 timer_set_duration(&cfm->tx_timer, cfm->ccm_interval_ms);
463 eth_compose(packet, cfm_ccm_addr(cfm), eth_src, ETH_TYPE_CFM, sizeof *ccm);
465 ccm_vlan = (cfm->ccm_vlan != CFM_RANDOM_VLAN
468 ccm_vlan = ccm_vlan & VLAN_VID_MASK;
470 if (ccm_vlan || cfm->ccm_pcp) {
471 uint16_t tci = ccm_vlan | (cfm->ccm_pcp << VLAN_PCP_SHIFT);
472 eth_push_vlan(packet, htons(tci));
476 ccm->mdlevel_version = 0;
477 ccm->opcode = CCM_OPCODE;
478 ccm->tlv_offset = 70;
479 ccm->seq = htonl(++cfm->seq);
480 ccm->flags = cfm->ccm_interval;
481 memcpy(ccm->maid, cfm->maid, sizeof ccm->maid);
482 memset(ccm->zero, 0, sizeof ccm->zero);
486 ccm->mpid = htons(hash_mpid(cfm->mpid));
487 ccm->mpid64 = htonll(cfm->mpid);
488 ccm->opdown = !cfm->opup;
490 ccm->mpid = htons(cfm->mpid);
491 ccm->mpid64 = htonll(0);
495 if (cfm->ccm_interval == 0) {
496 ovs_assert(cfm->extended);
497 ccm->interval_ms_x = htons(cfm->ccm_interval_ms);
499 ccm->interval_ms_x = htons(0);
502 if (cfm->booted && hmap_is_empty(&cfm->remote_mps)) {
503 ccm->flags |= CCM_RDI_MASK;
507 long long int delay = time_msec() - cfm->last_tx;
508 if (delay > (cfm->ccm_interval_ms * 3 / 2)) {
509 VLOG_WARN("%s: long delay of %lldms (expected %dms) sending CCM"
510 " seq %"PRIu32, cfm->name, delay, cfm->ccm_interval_ms,
514 cfm->last_tx = time_msec();
518 cfm_wait(struct cfm *cfm)
520 timer_wait(&cfm->tx_timer);
521 timer_wait(&cfm->fault_timer);
524 /* Configures 'cfm' with settings from 's'. */
526 cfm_configure(struct cfm *cfm, const struct cfm_settings *s)
531 if (!cfm_is_valid_mpid(s->extended, s->mpid) || s->interval <= 0) {
536 cfm->check_tnl_key = s->check_tnl_key;
537 cfm->extended = s->extended;
539 interval = ms_to_ccm_interval(s->interval);
540 interval_ms = ccm_interval_to_ms(interval);
542 cfm->ccm_vlan = s->ccm_vlan;
543 cfm->ccm_pcp = s->ccm_pcp & (VLAN_PCP_MASK >> VLAN_PCP_SHIFT);
544 if (cfm->extended && interval_ms != s->interval) {
546 interval_ms = MIN(s->interval, UINT16_MAX);
549 if (cfm->extended && s->demand) {
550 interval_ms = MAX(interval_ms, 500);
553 cfm->rx_packets = cfm_rx_packets(cfm);
559 if (interval != cfm->ccm_interval || interval_ms != cfm->ccm_interval_ms) {
560 cfm->ccm_interval = interval;
561 cfm->ccm_interval_ms = interval_ms;
563 timer_set_expired(&cfm->tx_timer);
564 timer_set_duration(&cfm->fault_timer, cfm_fault_interval(cfm));
570 /* Must be called when the netdev owned by 'cfm' should change. */
572 cfm_set_netdev(struct cfm *cfm, const struct netdev *netdev)
574 if (cfm->netdev != netdev) {
575 netdev_close(cfm->netdev);
576 cfm->netdev = netdev_ref(netdev);
580 /* Returns true if 'cfm' should process packets from 'flow'. Sets
581 * fields in 'wc' that were used to make the determination. */
583 cfm_should_process_flow(const struct cfm *cfm, const struct flow *flow,
584 struct flow_wildcards *wc)
586 memset(&wc->masks.dl_dst, 0xff, sizeof wc->masks.dl_dst);
587 memset(&wc->masks.dl_type, 0xff, sizeof wc->masks.dl_type);
588 if (cfm->check_tnl_key) {
589 memset(&wc->masks.tunnel.tun_id, 0xff, sizeof wc->masks.tunnel.tun_id);
591 return (ntohs(flow->dl_type) == ETH_TYPE_CFM
592 && eth_addr_equals(flow->dl_dst, cfm_ccm_addr(cfm))
593 && (!cfm->check_tnl_key || flow->tunnel.tun_id == htonll(0)));
596 /* Updates internal statistics relevant to packet 'p'. Should be called on
597 * every packet whose flow returned true when passed to
598 * cfm_should_process_flow. */
600 cfm_process_heartbeat(struct cfm *cfm, const struct ofpbuf *p)
603 struct eth_header *eth;
606 ccm = ofpbuf_at(p, (uint8_t *)p->l3 - (uint8_t *)p->data, CCM_ACCEPT_LEN);
609 VLOG_INFO_RL(&rl, "%s: Received an unparseable 802.1ag CCM heartbeat.",
614 if (ccm->opcode != CCM_OPCODE) {
615 VLOG_INFO_RL(&rl, "%s: Received an unsupported 802.1ag message. "
616 "(opcode %u)", cfm->name, ccm->opcode);
620 /* According to the 802.1ag specification, reception of a CCM with an
621 * incorrect ccm_interval, unexpected MAID, or unexpected MPID should
622 * trigger a fault. We ignore this requirement for several reasons.
624 * Faults can cause a controller or Open vSwitch to make potentially
625 * expensive changes to the network topology. It seems prudent to trigger
626 * them judiciously, especially when CFM is used to check slave status of
627 * bonds. Furthermore, faults can be maliciously triggered by crafting
628 * unexpected CCMs. */
629 if (memcmp(ccm->maid, cfm->maid, sizeof ccm->maid)) {
630 cfm->recv_fault |= CFM_FAULT_MAID;
631 VLOG_WARN_RL(&rl, "%s: Received unexpected remote MAID from MAC "
632 ETH_ADDR_FMT, cfm->name, ETH_ADDR_ARGS(eth->eth_src));
634 uint8_t ccm_interval = ccm->flags & 0x7;
635 bool ccm_rdi = ccm->flags & CCM_RDI_MASK;
636 uint16_t ccm_interval_ms_x = ntohs(ccm->interval_ms_x);
638 struct remote_mp *rmp;
642 enum cfm_fault_reason cfm_fault = 0;
645 ccm_mpid = ntohll(ccm->mpid64);
646 ccm_opdown = ccm->opdown;
648 ccm_mpid = ntohs(ccm->mpid);
651 ccm_seq = ntohl(ccm->seq);
653 if (ccm_interval != cfm->ccm_interval) {
654 cfm_fault |= CFM_FAULT_INTERVAL;
655 VLOG_WARN_RL(&rl, "%s: received a CCM with an unexpected interval"
656 " (%"PRIu8") from RMP %"PRIu64, cfm->name,
657 ccm_interval, ccm_mpid);
660 if (cfm->extended && ccm_interval == 0
661 && ccm_interval_ms_x != cfm->ccm_interval_ms) {
662 cfm_fault |= CFM_FAULT_INTERVAL;
663 VLOG_WARN_RL(&rl, "%s: received a CCM with an unexpected extended"
664 " interval (%"PRIu16"ms) from RMP %"PRIu64, cfm->name,
665 ccm_interval_ms_x, ccm_mpid);
668 rmp = lookup_remote_mp(cfm, ccm_mpid);
670 if (hmap_count(&cfm->remote_mps) < CFM_MAX_RMPS) {
671 rmp = xzalloc(sizeof *rmp);
672 hmap_insert(&cfm->remote_mps, &rmp->node, hash_mpid(ccm_mpid));
674 cfm_fault |= CFM_FAULT_OVERFLOW;
676 "%s: dropped CCM with MPID %"PRIu64" from MAC "
677 ETH_ADDR_FMT, cfm->name, ccm_mpid,
678 ETH_ADDR_ARGS(eth->eth_src));
683 cfm_fault |= CFM_FAULT_RDI;
684 VLOG_DBG("%s: RDI bit flagged from RMP %"PRIu64, cfm->name,
688 VLOG_DBG("%s: received CCM (seq %"PRIu32") (mpid %"PRIu64")"
689 " (interval %"PRIu8") (RDI %s)", cfm->name, ccm_seq,
690 ccm_mpid, ccm_interval, ccm_rdi ? "true" : "false");
693 if (rmp->mpid == cfm->mpid) {
694 cfm_fault |= CFM_FAULT_LOOPBACK;
695 VLOG_WARN_RL(&rl,"%s: received CCM with local MPID"
696 " %"PRIu64, cfm->name, rmp->mpid);
699 if (rmp->seq && ccm_seq != (rmp->seq + 1)) {
700 VLOG_WARN_RL(&rl, "%s: (mpid %"PRIu64") detected sequence"
701 " numbers which indicate possible connectivity"
702 " problems (previous %"PRIu32") (current %"PRIu32
703 ")", cfm->name, ccm_mpid, rmp->seq, ccm_seq);
706 rmp->mpid = ccm_mpid;
708 rmp->num_health_ccm++;
711 cfm->recv_fault |= cfm_fault;
713 rmp->opup = !ccm_opdown;
714 rmp->last_rx = time_msec();
719 /* Gets the fault status of 'cfm'. Returns a bit mask of 'cfm_fault_reason's
720 * indicating the cause of the connectivity fault, or zero if there is no
723 cfm_get_fault(const struct cfm *cfm)
725 if (cfm->fault_override >= 0) {
726 return cfm->fault_override ? CFM_FAULT_OVERRIDE : 0;
731 /* Gets the health of 'cfm'. Returns an integer between 0 and 100 indicating
732 * the health of the link as a percentage of ccm frames received in
733 * CFM_HEALTH_INTERVAL * 'fault_interval' if there is only 1 remote_mpid,
734 * returns 0 if there are no remote_mpids, and returns -1 if there are more
735 * than 1 remote_mpids. */
737 cfm_get_health(const struct cfm *cfm)
742 /* Gets the operational state of 'cfm'. 'cfm' is considered operationally down
743 * if it has received a CCM with the operationally down bit set from any of its
744 * remote maintenance points. Returns 1 if 'cfm' is operationally up, 0 if
745 * 'cfm' is operationally down, or -1 if 'cfm' has no operational state
746 * (because it isn't in extended mode). */
748 cfm_get_opup(const struct cfm *cfm)
751 return cfm->remote_opup;
757 /* Populates 'rmps' with an array of remote maintenance points reachable by
758 * 'cfm'. The number of remote maintenance points is written to 'n_rmps'.
759 * 'cfm' retains ownership of the array written to 'rmps' */
761 cfm_get_remote_mpids(const struct cfm *cfm, const uint64_t **rmps,
764 *rmps = cfm->rmps_array;
765 *n_rmps = cfm->rmps_array_len;
769 cfm_find(const char *name)
773 HMAP_FOR_EACH_WITH_HASH (cfm, hmap_node, hash_string(name, 0), &all_cfms) {
774 if (!strcmp(cfm->name, name)) {
782 cfm_print_details(struct ds *ds, const struct cfm *cfm)
784 struct remote_mp *rmp;
787 ds_put_format(ds, "---- %s ----\n", cfm->name);
788 ds_put_format(ds, "MPID %"PRIu64":%s%s\n", cfm->mpid,
789 cfm->extended ? " extended" : "",
790 cfm->fault_override >= 0 ? " fault_override" : "");
792 fault = cfm_get_fault(cfm);
794 ds_put_cstr(ds, "\tfault: ");
795 ds_put_cfm_fault(ds, fault);
796 ds_put_cstr(ds, "\n");
799 if (cfm->health == -1) {
800 ds_put_format(ds, "\taverage health: undefined\n");
802 ds_put_format(ds, "\taverage health: %d\n", cfm->health);
804 ds_put_format(ds, "\topstate: %s\n", cfm->opup ? "up" : "down");
805 ds_put_format(ds, "\tremote_opstate: %s\n",
806 cfm->remote_opup ? "up" : "down");
807 ds_put_format(ds, "\tinterval: %dms\n", cfm->ccm_interval_ms);
808 ds_put_format(ds, "\tnext CCM tx: %lldms\n",
809 timer_msecs_until_expired(&cfm->tx_timer));
810 ds_put_format(ds, "\tnext fault check: %lldms\n",
811 timer_msecs_until_expired(&cfm->fault_timer));
813 HMAP_FOR_EACH (rmp, node, &cfm->remote_mps) {
814 ds_put_format(ds, "Remote MPID %"PRIu64"\n", rmp->mpid);
815 ds_put_format(ds, "\trecv since check: %s\n",
816 rmp->recv ? "true" : "false");
817 ds_put_format(ds, "\topstate: %s\n", rmp->opup? "up" : "down");
822 cfm_unixctl_show(struct unixctl_conn *conn, int argc, const char *argv[],
823 void *aux OVS_UNUSED)
825 struct ds ds = DS_EMPTY_INITIALIZER;
826 const struct cfm *cfm;
829 cfm = cfm_find(argv[1]);
831 unixctl_command_reply_error(conn, "no such CFM object");
834 cfm_print_details(&ds, cfm);
836 HMAP_FOR_EACH (cfm, hmap_node, &all_cfms) {
837 cfm_print_details(&ds, cfm);
841 unixctl_command_reply(conn, ds_cstr(&ds));
846 cfm_unixctl_set_fault(struct unixctl_conn *conn, int argc, const char *argv[],
847 void *aux OVS_UNUSED)
849 const char *fault_str = argv[argc - 1];
853 if (!strcasecmp("true", fault_str)) {
855 } else if (!strcasecmp("false", fault_str)) {
857 } else if (!strcasecmp("normal", fault_str)) {
860 unixctl_command_reply_error(conn, "unknown fault string");
865 cfm = cfm_find(argv[1]);
867 unixctl_command_reply_error(conn, "no such CFM object");
870 cfm->fault_override = fault_override;
872 HMAP_FOR_EACH (cfm, hmap_node, &all_cfms) {
873 cfm->fault_override = fault_override;
877 unixctl_command_reply(conn, "OK");