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
67 uint8_t mdlevel_version; /* MD Level and Version */
73 uint8_t maid[CCM_MAID_LEN];
75 /* Defined by ITU-T Y.1731 should be zero */
76 ovs_be16 interval_ms_x; /* Transmission interval in ms. */
77 ovs_be64 mpid64; /* MPID in extended mode. */
78 uint8_t opdown; /* Operationally down. */
84 BUILD_ASSERT_DECL(CCM_LEN == sizeof(struct ccm));
87 const char *name; /* Name of this CFM object. */
88 struct hmap_node hmap_node; /* Node in all_cfms list. */
90 struct netdev *netdev;
91 uint64_t rx_packets; /* Packets received by 'netdev'. */
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. */
129 atomic_bool check_tnl_key; /* Verify the tunnel key of inbound packets? */
130 atomic_bool extended; /* Extended mode. */
134 /* Remote MPs represent foreign network entities that are configured to have
135 * the same MAID as this CFM instance. */
137 uint64_t mpid; /* The Maintenance Point ID of this 'remote_mp'. */
138 struct hmap_node node; /* Node in 'remote_mps' map. */
140 bool recv; /* CCM was received since last fault check. */
141 bool opup; /* Operational State. */
142 uint32_t seq; /* Most recently received sequence number. */
143 uint8_t num_health_ccm; /* Number of received ccm frames every
144 CFM_HEALTH_INTERVAL * 'fault_interval'. */
145 long long int last_rx; /* Last CCM reception time. */
149 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(20, 30);
151 static struct ovs_mutex mutex = OVS_MUTEX_INITIALIZER;
152 static struct hmap all_cfms__ = HMAP_INITIALIZER(&all_cfms__);
153 static struct hmap *const all_cfms OVS_GUARDED_BY(mutex) = &all_cfms__;
155 static unixctl_cb_func cfm_unixctl_show;
156 static unixctl_cb_func cfm_unixctl_set_fault;
159 cfm_rx_packets(const struct cfm *cfm) OVS_REQ_WRLOCK(mutex)
161 struct netdev_stats stats;
163 if (!netdev_get_stats(cfm->netdev, &stats)) {
164 return stats.rx_packets;
170 static const uint8_t *
171 cfm_ccm_addr(const struct cfm *cfm)
174 atomic_read(&cfm->extended, &extended);
175 return extended ? eth_addr_ccm_x : eth_addr_ccm;
178 /* Returns the string representation of the given cfm_fault_reason 'reason'. */
180 cfm_fault_reason_to_str(int reason)
183 #define CFM_FAULT_REASON(NAME, STR) case CFM_FAULT_##NAME: return #STR;
185 #undef CFM_FAULT_REASON
186 default: return "<unknown>";
191 ds_put_cfm_fault(struct ds *ds, int fault)
195 for (i = 0; i < CFM_FAULT_N_REASONS; i++) {
198 if (fault & reason) {
199 ds_put_format(ds, "%s ", cfm_fault_reason_to_str(reason));
207 cfm_generate_maid(struct cfm *cfm) OVS_REQ_WRLOCK(mutex)
209 const char *ovs_md_name = "ovs";
210 const char *ovs_ma_name = "ovs";
212 size_t md_len, ma_len;
214 memset(cfm->maid, 0, CCM_MAID_LEN);
216 md_len = strlen(ovs_md_name);
217 ma_len = strlen(ovs_ma_name);
219 ovs_assert(md_len && ma_len && md_len + ma_len + 4 <= CCM_MAID_LEN);
221 cfm->maid[0] = 4; /* MD name string format. */
222 cfm->maid[1] = md_len; /* MD name size. */
223 memcpy(&cfm->maid[2], ovs_md_name, md_len); /* MD name. */
225 ma_p = cfm->maid + 2 + md_len;
226 ma_p[0] = 2; /* MA name string format. */
227 ma_p[1] = ma_len; /* MA name size. */
228 memcpy(&ma_p[2], ovs_ma_name, ma_len); /* MA name. */
232 ccm_interval_to_ms(uint8_t interval)
235 case 0: NOT_REACHED(); /* Explicitly not supported by 802.1ag. */
236 case 1: return 3; /* Not recommended due to timer resolution. */
237 case 2: return 10; /* Not recommended due to timer resolution. */
240 case 5: return 10000;
241 case 6: return 60000;
242 case 7: return 600000;
243 default: NOT_REACHED(); /* Explicitly not supported by 802.1ag. */
250 cfm_fault_interval(struct cfm *cfm) OVS_REQ_WRLOCK(mutex)
252 /* According to the 802.1ag specification we should assume every other MP
253 * with the same MAID has the same transmission interval that we have. If
254 * an MP has a different interval, cfm_process_heartbeat will register it
255 * as a fault (likely due to a configuration error). Thus we can check all
256 * MPs at once making this quite a bit simpler.
258 * According to the specification we should check when (ccm_interval_ms *
259 * 3.5)ms have passed. */
260 return (cfm->ccm_interval_ms * 7) / 2;
264 ms_to_ccm_interval(int interval_ms)
268 for (i = 7; i > 0; i--) {
269 if (ccm_interval_to_ms(i) <= interval_ms) {
278 hash_mpid(uint64_t mpid)
280 return hash_bytes(&mpid, sizeof mpid, 0);
284 cfm_is_valid_mpid(bool extended, uint64_t mpid)
286 /* 802.1ag specification requires MPIDs to be within the range [1, 8191].
287 * In extended mode we relax this requirement. */
288 return mpid >= 1 && (extended || mpid <= 8191);
291 static struct remote_mp *
292 lookup_remote_mp(const struct cfm *cfm, uint64_t mpid) OVS_REQ_WRLOCK(mutex)
294 struct remote_mp *rmp;
296 HMAP_FOR_EACH_IN_BUCKET (rmp, node, hash_mpid(mpid), &cfm->remote_mps) {
297 if (rmp->mpid == mpid) {
308 unixctl_command_register("cfm/show", "[interface]", 0, 1, cfm_unixctl_show,
310 unixctl_command_register("cfm/set-fault", "[interface] normal|false|true",
311 1, 2, cfm_unixctl_set_fault, NULL);
314 /* Allocates a 'cfm' object called 'name'. 'cfm' should be initialized by
315 * cfm_configure() before use. */
317 cfm_create(const struct netdev *netdev) OVS_EXCLUDED(mutex)
321 cfm = xzalloc(sizeof *cfm);
322 cfm->netdev = netdev_ref(netdev);
323 cfm->name = netdev_get_name(cfm->netdev);
324 hmap_init(&cfm->remote_mps);
325 cfm->remote_opup = true;
326 cfm->fault_override = -1;
329 atomic_init(&cfm->extended, false);
330 atomic_init(&cfm->check_tnl_key, false);
331 atomic_init(&cfm->ref_cnt, 1);
333 ovs_mutex_lock(&mutex);
334 cfm_generate_maid(cfm);
335 hmap_insert(all_cfms, &cfm->hmap_node, hash_string(cfm->name, 0));
336 ovs_mutex_unlock(&mutex);
341 cfm_unref(struct cfm *cfm) OVS_EXCLUDED(mutex)
343 struct remote_mp *rmp, *rmp_next;
350 atomic_sub(&cfm->ref_cnt, 1, &orig);
351 ovs_assert(orig > 0);
356 ovs_mutex_lock(&mutex);
357 hmap_remove(all_cfms, &cfm->hmap_node);
358 ovs_mutex_unlock(&mutex);
360 HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &cfm->remote_mps) {
361 hmap_remove(&cfm->remote_mps, &rmp->node);
365 hmap_destroy(&cfm->remote_mps);
366 netdev_close(cfm->netdev);
367 free(cfm->rmps_array);
372 cfm_ref(const struct cfm *cfm_)
374 struct cfm *cfm = CONST_CAST(struct cfm *, cfm_);
377 atomic_add(&cfm->ref_cnt, 1, &orig);
378 ovs_assert(orig > 0);
383 /* Should be run periodically to update fault statistics messages. */
385 cfm_run(struct cfm *cfm) OVS_EXCLUDED(mutex)
387 ovs_mutex_lock(&mutex);
388 if (timer_expired(&cfm->fault_timer)) {
389 long long int interval = cfm_fault_interval(cfm);
390 struct remote_mp *rmp, *rmp_next;
391 bool old_cfm_fault = cfm->fault;
392 bool demand_override;
394 cfm->fault = cfm->recv_fault;
397 cfm->rmps_array_len = 0;
398 free(cfm->rmps_array);
399 cfm->rmps_array = xmalloc(hmap_count(&cfm->remote_mps) *
400 sizeof *cfm->rmps_array);
402 cfm->remote_opup = true;
403 if (cfm->health_interval == CFM_HEALTH_INTERVAL) {
404 /* Calculate the cfm health of the interface. If the number of
405 * remote_mpids of a cfm interface is > 1, the cfm health is
406 * undefined. If the number of remote_mpids is 1, the cfm health is
407 * the percentage of the ccm frames received in the
408 * (CFM_HEALTH_INTERVAL * 3.5)ms, else it is 0. */
409 if (hmap_count(&cfm->remote_mps) > 1) {
411 } else if (hmap_is_empty(&cfm->remote_mps)) {
416 rmp = CONTAINER_OF(hmap_first(&cfm->remote_mps),
417 struct remote_mp, node);
418 exp_ccm_recvd = (CFM_HEALTH_INTERVAL * 7) / 2;
419 /* Calculate the percentage of healthy ccm frames received.
420 * Since the 'fault_interval' is (3.5 * cfm_interval), and
421 * 1 CCM packet must be received every cfm_interval,
422 * the 'remote_mpid' health reports the percentage of
423 * healthy CCM frames received every
424 * 'CFM_HEALTH_INTERVAL'th 'fault_interval'. */
425 cfm->health = (rmp->num_health_ccm * 100) / exp_ccm_recvd;
426 cfm->health = MIN(cfm->health, 100);
427 rmp->num_health_ccm = 0;
428 ovs_assert(cfm->health >= 0 && cfm->health <= 100);
430 cfm->health_interval = 0;
432 cfm->health_interval++;
434 demand_override = false;
436 uint64_t rx_packets = cfm_rx_packets(cfm);
437 demand_override = hmap_count(&cfm->remote_mps) == 1
438 && rx_packets > cfm->rx_packets;
439 cfm->rx_packets = rx_packets;
442 HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &cfm->remote_mps) {
444 VLOG_INFO("%s: Received no CCM from RMP %"PRIu64" in the last"
445 " %lldms", cfm->name, rmp->mpid,
446 time_msec() - rmp->last_rx);
447 if (!demand_override) {
448 hmap_remove(&cfm->remote_mps, &rmp->node);
455 cfm->remote_opup = rmp->opup;
458 cfm->rmps_array[cfm->rmps_array_len++] = rmp->mpid;
462 if (hmap_is_empty(&cfm->remote_mps)) {
463 cfm->fault |= CFM_FAULT_RECV;
466 if (old_cfm_fault != cfm->fault && !VLOG_DROP_INFO(&rl)) {
467 struct ds ds = DS_EMPTY_INITIALIZER;
469 ds_put_cstr(&ds, "from [");
470 ds_put_cfm_fault(&ds, old_cfm_fault);
471 ds_put_cstr(&ds, "] to [");
472 ds_put_cfm_fault(&ds, cfm->fault);
473 ds_put_char(&ds, ']');
474 VLOG_INFO("%s: CFM faults changed %s.", cfm->name, ds_cstr(&ds));
479 timer_set_duration(&cfm->fault_timer, interval);
480 VLOG_DBG("%s: new fault interval", cfm->name);
482 ovs_mutex_unlock(&mutex);
485 /* Should be run periodically to check if the CFM module has a CCM message it
488 cfm_should_send_ccm(struct cfm *cfm) OVS_EXCLUDED(mutex)
492 ovs_mutex_lock(&mutex);
493 ret = timer_expired(&cfm->tx_timer);
494 ovs_mutex_unlock(&mutex);
498 /* Composes a CCM message into 'packet'. Messages generated with this function
499 * should be sent whenever cfm_should_send_ccm() indicates. */
501 cfm_compose_ccm(struct cfm *cfm, struct ofpbuf *packet,
502 uint8_t eth_src[ETH_ADDR_LEN]) OVS_EXCLUDED(mutex)
508 ovs_mutex_lock(&mutex);
509 timer_set_duration(&cfm->tx_timer, cfm->ccm_interval_ms);
510 eth_compose(packet, cfm_ccm_addr(cfm), eth_src, ETH_TYPE_CFM, sizeof *ccm);
512 ccm_vlan = (cfm->ccm_vlan != CFM_RANDOM_VLAN
515 ccm_vlan = ccm_vlan & VLAN_VID_MASK;
517 if (ccm_vlan || cfm->ccm_pcp) {
518 uint16_t tci = ccm_vlan | (cfm->ccm_pcp << VLAN_PCP_SHIFT);
519 eth_push_vlan(packet, htons(tci));
523 ccm->mdlevel_version = 0;
524 ccm->opcode = CCM_OPCODE;
525 ccm->tlv_offset = 70;
526 ccm->seq = htonl(++cfm->seq);
527 ccm->flags = cfm->ccm_interval;
528 memcpy(ccm->maid, cfm->maid, sizeof ccm->maid);
529 memset(ccm->zero, 0, sizeof ccm->zero);
532 atomic_read(&cfm->extended, &extended);
534 ccm->mpid = htons(hash_mpid(cfm->mpid));
535 ccm->mpid64 = htonll(cfm->mpid);
536 ccm->opdown = !cfm->opup;
538 ccm->mpid = htons(cfm->mpid);
539 ccm->mpid64 = htonll(0);
543 if (cfm->ccm_interval == 0) {
544 ovs_assert(extended);
545 ccm->interval_ms_x = htons(cfm->ccm_interval_ms);
547 ccm->interval_ms_x = htons(0);
550 if (cfm->booted && hmap_is_empty(&cfm->remote_mps)) {
551 ccm->flags |= CCM_RDI_MASK;
555 long long int delay = time_msec() - cfm->last_tx;
556 if (delay > (cfm->ccm_interval_ms * 3 / 2)) {
557 VLOG_WARN("%s: long delay of %lldms (expected %dms) sending CCM"
558 " seq %"PRIu32, cfm->name, delay, cfm->ccm_interval_ms,
562 cfm->last_tx = time_msec();
563 ovs_mutex_unlock(&mutex);
567 cfm_wait(struct cfm *cfm) OVS_EXCLUDED(mutex)
569 ovs_mutex_lock(&mutex);
570 timer_wait(&cfm->tx_timer);
571 timer_wait(&cfm->fault_timer);
572 ovs_mutex_unlock(&mutex);
575 /* Configures 'cfm' with settings from 's'. */
577 cfm_configure(struct cfm *cfm, const struct cfm_settings *s)
583 if (!cfm_is_valid_mpid(s->extended, s->mpid) || s->interval <= 0) {
587 ovs_mutex_lock(&mutex);
590 interval = ms_to_ccm_interval(s->interval);
591 interval_ms = ccm_interval_to_ms(interval);
593 atomic_store(&cfm->check_tnl_key, s->check_tnl_key);
594 atomic_store(&cfm->extended, s->extended);
596 cfm->ccm_vlan = s->ccm_vlan;
597 cfm->ccm_pcp = s->ccm_pcp & (VLAN_PCP_MASK >> VLAN_PCP_SHIFT);
598 if (s->extended && interval_ms != s->interval) {
600 interval_ms = MIN(s->interval, UINT16_MAX);
603 if (s->extended && s->demand) {
604 interval_ms = MAX(interval_ms, 500);
607 cfm->rx_packets = cfm_rx_packets(cfm);
613 if (interval != cfm->ccm_interval || interval_ms != cfm->ccm_interval_ms) {
614 cfm->ccm_interval = interval;
615 cfm->ccm_interval_ms = interval_ms;
617 timer_set_expired(&cfm->tx_timer);
618 timer_set_duration(&cfm->fault_timer, cfm_fault_interval(cfm));
621 ovs_mutex_unlock(&mutex);
625 /* Must be called when the netdev owned by 'cfm' should change. */
627 cfm_set_netdev(struct cfm *cfm, const struct netdev *netdev)
630 ovs_mutex_lock(&mutex);
631 if (cfm->netdev != netdev) {
632 netdev_close(cfm->netdev);
633 cfm->netdev = netdev_ref(netdev);
635 ovs_mutex_unlock(&mutex);
638 /* Returns true if 'cfm' should process packets from 'flow'. Sets
639 * fields in 'wc' that were used to make the determination. */
641 cfm_should_process_flow(const struct cfm *cfm, const struct flow *flow,
642 struct flow_wildcards *wc)
646 atomic_read(&cfm->check_tnl_key, &check_tnl_key);
647 memset(&wc->masks.dl_dst, 0xff, sizeof wc->masks.dl_dst);
649 memset(&wc->masks.tunnel.tun_id, 0xff, sizeof wc->masks.tunnel.tun_id);
651 return (ntohs(flow->dl_type) == ETH_TYPE_CFM
652 && eth_addr_equals(flow->dl_dst, cfm_ccm_addr(cfm))
653 && (!check_tnl_key || flow->tunnel.tun_id == htonll(0)));
656 /* Updates internal statistics relevant to packet 'p'. Should be called on
657 * every packet whose flow returned true when passed to
658 * cfm_should_process_flow. */
660 cfm_process_heartbeat(struct cfm *cfm, const struct ofpbuf *p)
664 struct eth_header *eth;
666 ovs_mutex_lock(&mutex);
669 ccm = ofpbuf_at(p, (uint8_t *)p->l3 - (uint8_t *)p->data, CCM_ACCEPT_LEN);
672 VLOG_INFO_RL(&rl, "%s: Received an unparseable 802.1ag CCM heartbeat.",
677 if (ccm->opcode != CCM_OPCODE) {
678 VLOG_INFO_RL(&rl, "%s: Received an unsupported 802.1ag message. "
679 "(opcode %u)", cfm->name, ccm->opcode);
683 /* According to the 802.1ag specification, reception of a CCM with an
684 * incorrect ccm_interval, unexpected MAID, or unexpected MPID should
685 * trigger a fault. We ignore this requirement for several reasons.
687 * Faults can cause a controller or Open vSwitch to make potentially
688 * expensive changes to the network topology. It seems prudent to trigger
689 * them judiciously, especially when CFM is used to check slave status of
690 * bonds. Furthermore, faults can be maliciously triggered by crafting
691 * unexpected CCMs. */
692 if (memcmp(ccm->maid, cfm->maid, sizeof ccm->maid)) {
693 cfm->recv_fault |= CFM_FAULT_MAID;
694 VLOG_WARN_RL(&rl, "%s: Received unexpected remote MAID from MAC "
695 ETH_ADDR_FMT, cfm->name, ETH_ADDR_ARGS(eth->eth_src));
697 uint8_t ccm_interval = ccm->flags & 0x7;
698 bool ccm_rdi = ccm->flags & CCM_RDI_MASK;
699 uint16_t ccm_interval_ms_x = ntohs(ccm->interval_ms_x);
701 struct remote_mp *rmp;
706 enum cfm_fault_reason cfm_fault = 0;
708 atomic_read(&cfm->extended, &extended);
710 ccm_mpid = ntohll(ccm->mpid64);
711 ccm_opdown = ccm->opdown;
713 ccm_mpid = ntohs(ccm->mpid);
716 ccm_seq = ntohl(ccm->seq);
718 if (ccm_interval != cfm->ccm_interval) {
719 cfm_fault |= CFM_FAULT_INTERVAL;
720 VLOG_WARN_RL(&rl, "%s: received a CCM with an unexpected interval"
721 " (%"PRIu8") from RMP %"PRIu64, cfm->name,
722 ccm_interval, ccm_mpid);
725 if (extended && ccm_interval == 0
726 && ccm_interval_ms_x != cfm->ccm_interval_ms) {
727 cfm_fault |= CFM_FAULT_INTERVAL;
728 VLOG_WARN_RL(&rl, "%s: received a CCM with an unexpected extended"
729 " interval (%"PRIu16"ms) from RMP %"PRIu64, cfm->name,
730 ccm_interval_ms_x, ccm_mpid);
733 rmp = lookup_remote_mp(cfm, ccm_mpid);
735 if (hmap_count(&cfm->remote_mps) < CFM_MAX_RMPS) {
736 rmp = xzalloc(sizeof *rmp);
737 hmap_insert(&cfm->remote_mps, &rmp->node, hash_mpid(ccm_mpid));
739 cfm_fault |= CFM_FAULT_OVERFLOW;
741 "%s: dropped CCM with MPID %"PRIu64" from MAC "
742 ETH_ADDR_FMT, cfm->name, ccm_mpid,
743 ETH_ADDR_ARGS(eth->eth_src));
748 cfm_fault |= CFM_FAULT_RDI;
749 VLOG_DBG("%s: RDI bit flagged from RMP %"PRIu64, cfm->name,
753 VLOG_DBG("%s: received CCM (seq %"PRIu32") (mpid %"PRIu64")"
754 " (interval %"PRIu8") (RDI %s)", cfm->name, ccm_seq,
755 ccm_mpid, ccm_interval, ccm_rdi ? "true" : "false");
758 if (rmp->mpid == cfm->mpid) {
759 cfm_fault |= CFM_FAULT_LOOPBACK;
760 VLOG_WARN_RL(&rl,"%s: received CCM with local MPID"
761 " %"PRIu64, cfm->name, rmp->mpid);
764 if (rmp->seq && ccm_seq != (rmp->seq + 1)) {
765 VLOG_WARN_RL(&rl, "%s: (mpid %"PRIu64") detected sequence"
766 " numbers which indicate possible connectivity"
767 " problems (previous %"PRIu32") (current %"PRIu32
768 ")", cfm->name, ccm_mpid, rmp->seq, ccm_seq);
771 rmp->mpid = ccm_mpid;
773 rmp->num_health_ccm++;
776 cfm->recv_fault |= cfm_fault;
778 rmp->opup = !ccm_opdown;
779 rmp->last_rx = time_msec();
784 ovs_mutex_unlock(&mutex);
788 cfm_get_fault__(const struct cfm *cfm) OVS_REQ_WRLOCK(mutex)
790 if (cfm->fault_override >= 0) {
791 return cfm->fault_override ? CFM_FAULT_OVERRIDE : 0;
796 /* Gets the fault status of 'cfm'. Returns a bit mask of 'cfm_fault_reason's
797 * indicating the cause of the connectivity fault, or zero if there is no
800 cfm_get_fault(const struct cfm *cfm) OVS_EXCLUDED(mutex)
804 ovs_mutex_lock(&mutex);
805 fault = cfm_get_fault__(cfm);
806 ovs_mutex_unlock(&mutex);
810 /* Gets the health of 'cfm'. Returns an integer between 0 and 100 indicating
811 * the health of the link as a percentage of ccm frames received in
812 * CFM_HEALTH_INTERVAL * 'fault_interval' if there is only 1 remote_mpid,
813 * returns 0 if there are no remote_mpids, and returns -1 if there are more
814 * than 1 remote_mpids. */
816 cfm_get_health(const struct cfm *cfm) OVS_EXCLUDED(mutex)
820 ovs_mutex_lock(&mutex);
821 health = cfm->health;
822 ovs_mutex_unlock(&mutex);
826 /* Gets the operational state of 'cfm'. 'cfm' is considered operationally down
827 * if it has received a CCM with the operationally down bit set from any of its
828 * remote maintenance points. Returns 1 if 'cfm' is operationally up, 0 if
829 * 'cfm' is operationally down, or -1 if 'cfm' has no operational state
830 * (because it isn't in extended mode). */
832 cfm_get_opup(const struct cfm *cfm) OVS_EXCLUDED(mutex)
837 ovs_mutex_lock(&mutex);
838 atomic_read(&cfm->extended, &extended);
839 opup = extended ? cfm->remote_opup : -1;
840 ovs_mutex_unlock(&mutex);
845 /* Populates 'rmps' with an array of remote maintenance points reachable by
846 * 'cfm'. The number of remote maintenance points is written to 'n_rmps'.
847 * 'cfm' retains ownership of the array written to 'rmps' */
849 cfm_get_remote_mpids(const struct cfm *cfm, uint64_t **rmps, size_t *n_rmps)
852 ovs_mutex_lock(&mutex);
853 *rmps = xmemdup(cfm->rmps_array, cfm->rmps_array_len);
854 *n_rmps = cfm->rmps_array_len;
855 ovs_mutex_unlock(&mutex);
859 cfm_find(const char *name) OVS_REQ_WRLOCK(&mutex)
863 HMAP_FOR_EACH_WITH_HASH (cfm, hmap_node, hash_string(name, 0), all_cfms) {
864 if (!strcmp(cfm->name, name)) {
872 cfm_print_details(struct ds *ds, const struct cfm *cfm) OVS_REQ_WRLOCK(&mutex)
874 struct remote_mp *rmp;
878 atomic_read(&cfm->extended, &extended);
880 ds_put_format(ds, "---- %s ----\n", cfm->name);
881 ds_put_format(ds, "MPID %"PRIu64":%s%s\n", cfm->mpid,
882 extended ? " extended" : "",
883 cfm->fault_override >= 0 ? " fault_override" : "");
885 fault = cfm_get_fault__(cfm);
887 ds_put_cstr(ds, "\tfault: ");
888 ds_put_cfm_fault(ds, fault);
889 ds_put_cstr(ds, "\n");
892 if (cfm->health == -1) {
893 ds_put_format(ds, "\taverage health: undefined\n");
895 ds_put_format(ds, "\taverage health: %d\n", cfm->health);
897 ds_put_format(ds, "\topstate: %s\n", cfm->opup ? "up" : "down");
898 ds_put_format(ds, "\tremote_opstate: %s\n",
899 cfm->remote_opup ? "up" : "down");
900 ds_put_format(ds, "\tinterval: %dms\n", cfm->ccm_interval_ms);
901 ds_put_format(ds, "\tnext CCM tx: %lldms\n",
902 timer_msecs_until_expired(&cfm->tx_timer));
903 ds_put_format(ds, "\tnext fault check: %lldms\n",
904 timer_msecs_until_expired(&cfm->fault_timer));
906 HMAP_FOR_EACH (rmp, node, &cfm->remote_mps) {
907 ds_put_format(ds, "Remote MPID %"PRIu64"\n", rmp->mpid);
908 ds_put_format(ds, "\trecv since check: %s\n",
909 rmp->recv ? "true" : "false");
910 ds_put_format(ds, "\topstate: %s\n", rmp->opup? "up" : "down");
915 cfm_unixctl_show(struct unixctl_conn *conn, int argc, const char *argv[],
916 void *aux OVS_UNUSED) OVS_EXCLUDED(mutex)
918 struct ds ds = DS_EMPTY_INITIALIZER;
919 const struct cfm *cfm;
921 ovs_mutex_lock(&mutex);
923 cfm = cfm_find(argv[1]);
925 unixctl_command_reply_error(conn, "no such CFM object");
928 cfm_print_details(&ds, cfm);
930 HMAP_FOR_EACH (cfm, hmap_node, all_cfms) {
931 cfm_print_details(&ds, cfm);
935 unixctl_command_reply(conn, ds_cstr(&ds));
938 ovs_mutex_unlock(&mutex);
942 cfm_unixctl_set_fault(struct unixctl_conn *conn, int argc, const char *argv[],
943 void *aux OVS_UNUSED) OVS_EXCLUDED(mutex)
945 const char *fault_str = argv[argc - 1];
949 ovs_mutex_lock(&mutex);
950 if (!strcasecmp("true", fault_str)) {
952 } else if (!strcasecmp("false", fault_str)) {
954 } else if (!strcasecmp("normal", fault_str)) {
957 unixctl_command_reply_error(conn, "unknown fault string");
962 cfm = cfm_find(argv[1]);
964 unixctl_command_reply_error(conn, "no such CFM object");
967 cfm->fault_override = fault_override;
969 HMAP_FOR_EACH (cfm, hmap_node, all_cfms) {
970 cfm->fault_override = fault_override;
974 unixctl_command_reply(conn, "OK");
977 ovs_mutex_unlock(&mutex);