2 * Copyright (c) 2010, 2011, 2012, 2013, 2014 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 "connectivity.h"
26 #include "dynamic-string.h"
33 #include "poll-loop.h"
41 VLOG_DEFINE_THIS_MODULE(cfm);
43 #define CFM_MAX_RMPS 256
45 /* Ethernet destination address of CCM packets. */
46 static const uint8_t eth_addr_ccm[6] = { 0x01, 0x80, 0xC2, 0x00, 0x00, 0x30 };
47 static const uint8_t eth_addr_ccm_x[6] = {
48 0x01, 0x23, 0x20, 0x00, 0x00, 0x30
51 #define ETH_TYPE_CFM 0x8902
53 /* A 'ccm' represents a Continuity Check Message from the 802.1ag
54 * specification. Continuity Check Messages are broadcast periodically so that
55 * hosts can determine whom they have connectivity to.
57 * The minimum length of a CCM as specified by IEEE 802.1ag is 75 bytes.
58 * Previous versions of Open vSwitch generated 74-byte CCM messages, so we
59 * accept such messages too. */
61 #define CCM_ACCEPT_LEN 74
62 #define CCM_MAID_LEN 48
63 #define CCM_OPCODE 1 /* CFM message opcode meaning CCM. */
64 #define CCM_RDI_MASK 0x80
65 #define CFM_HEALTH_INTERVAL 6
69 uint8_t mdlevel_version; /* MD Level and Version */
75 uint8_t maid[CCM_MAID_LEN];
77 /* Defined by ITU-T Y.1731 should be zero */
78 ovs_be16 interval_ms_x; /* Transmission interval in ms. */
79 ovs_be64 mpid64; /* MPID in extended mode. */
80 uint8_t opdown; /* Operationally down. */
86 BUILD_ASSERT_DECL(CCM_LEN == sizeof(struct ccm));
89 const char *name; /* Name of this CFM object. */
90 struct hmap_node hmap_node; /* Node in all_cfms list. */
92 struct netdev *netdev;
93 uint64_t rx_packets; /* Packets received by 'netdev'. */
96 bool demand; /* Demand mode. */
97 bool booted; /* A full fault interval has occurred. */
98 enum cfm_fault_reason fault; /* Connectivity fault status. */
99 enum cfm_fault_reason recv_fault; /* Bit mask of faults occurring on
101 bool opup; /* Operational State. */
102 bool remote_opup; /* Remote Operational State. */
104 int fault_override; /* Manual override of 'fault' status.
105 Ignored if negative. */
107 uint32_t seq; /* The sequence number of our last CCM. */
108 uint8_t ccm_interval; /* The CCM transmission interval. */
109 int ccm_interval_ms; /* 'ccm_interval' in milliseconds. */
110 uint16_t ccm_vlan; /* Vlan tag of CCM PDUs. CFM_RANDOM_VLAN if
112 uint8_t ccm_pcp; /* Priority of CCM PDUs. */
113 uint8_t maid[CCM_MAID_LEN]; /* The MAID of this CFM. */
115 struct timer tx_timer; /* Send CCM when expired. */
116 struct timer fault_timer; /* Check for faults when expired. */
118 struct hmap remote_mps; /* Remote MPs. */
120 /* Result of cfm_get_remote_mpids(). Updated only during fault check to
122 uint64_t *rmps_array; /* Cache of remote_mps. */
123 size_t rmps_array_len; /* Number of rmps in 'rmps_array'. */
125 int health; /* Percentage of the number of CCM frames
127 int health_interval; /* Number of fault_intervals since health was
129 long long int last_tx; /* Last CCM transmission time. */
131 atomic_bool check_tnl_key; /* Verify the tunnel key of inbound packets? */
132 atomic_bool extended; /* Extended mode. */
133 struct ovs_refcount ref_cnt;
135 uint64_t flap_count; /* Count the flaps since boot. */
138 /* Remote MPs represent foreign network entities that are configured to have
139 * the same MAID as this CFM instance. */
141 uint64_t mpid; /* The Maintenance Point ID of this 'remote_mp'. */
142 struct hmap_node node; /* Node in 'remote_mps' map. */
144 bool recv; /* CCM was received since last fault check. */
145 bool opup; /* Operational State. */
146 uint32_t seq; /* Most recently received sequence number. */
147 uint8_t num_health_ccm; /* Number of received ccm frames every
148 CFM_HEALTH_INTERVAL * 'fault_interval'. */
149 long long int last_rx; /* Last CCM reception time. */
153 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(20, 30);
155 static struct ovs_mutex mutex = OVS_MUTEX_INITIALIZER;
156 static struct hmap all_cfms__ = HMAP_INITIALIZER(&all_cfms__);
157 static struct hmap *const all_cfms OVS_GUARDED_BY(mutex) = &all_cfms__;
159 static unixctl_cb_func cfm_unixctl_show;
160 static unixctl_cb_func cfm_unixctl_set_fault;
163 cfm_rx_packets(const struct cfm *cfm) OVS_REQUIRES(mutex)
165 struct netdev_stats stats;
167 if (!netdev_get_stats(cfm->netdev, &stats)) {
168 return stats.rx_packets;
174 static const uint8_t *
175 cfm_ccm_addr(struct cfm *cfm)
178 atomic_read(&cfm->extended, &extended);
179 return extended ? eth_addr_ccm_x : eth_addr_ccm;
182 /* Returns the string representation of the given cfm_fault_reason 'reason'. */
184 cfm_fault_reason_to_str(int reason)
187 #define CFM_FAULT_REASON(NAME, STR) case CFM_FAULT_##NAME: return #STR;
189 #undef CFM_FAULT_REASON
190 default: return "<unknown>";
195 ds_put_cfm_fault(struct ds *ds, int fault)
199 for (i = 0; i < CFM_FAULT_N_REASONS; i++) {
202 if (fault & reason) {
203 ds_put_format(ds, "%s ", cfm_fault_reason_to_str(reason));
211 cfm_generate_maid(struct cfm *cfm) OVS_REQUIRES(mutex)
213 const char *ovs_md_name = "ovs";
214 const char *ovs_ma_name = "ovs";
216 size_t md_len, ma_len;
218 memset(cfm->maid, 0, CCM_MAID_LEN);
220 md_len = strlen(ovs_md_name);
221 ma_len = strlen(ovs_ma_name);
223 ovs_assert(md_len && ma_len && md_len + ma_len + 4 <= CCM_MAID_LEN);
225 cfm->maid[0] = 4; /* MD name string format. */
226 cfm->maid[1] = md_len; /* MD name size. */
227 memcpy(&cfm->maid[2], ovs_md_name, md_len); /* MD name. */
229 ma_p = cfm->maid + 2 + md_len;
230 ma_p[0] = 2; /* MA name string format. */
231 ma_p[1] = ma_len; /* MA name size. */
232 memcpy(&ma_p[2], ovs_ma_name, ma_len); /* MA name. */
236 ccm_interval_to_ms(uint8_t interval)
239 case 0: OVS_NOT_REACHED(); /* Explicitly not supported by 802.1ag. */
240 case 1: return 3; /* Not recommended due to timer resolution. */
241 case 2: return 10; /* Not recommended due to timer resolution. */
244 case 5: return 10000;
245 case 6: return 60000;
246 case 7: return 600000;
247 default: OVS_NOT_REACHED(); /* Explicitly not supported by 802.1ag. */
254 cfm_fault_interval(struct cfm *cfm) OVS_REQUIRES(mutex)
256 /* According to the 802.1ag specification we should assume every other MP
257 * with the same MAID has the same transmission interval that we have. If
258 * an MP has a different interval, cfm_process_heartbeat will register it
259 * as a fault (likely due to a configuration error). Thus we can check all
260 * MPs at once making this quite a bit simpler.
262 * When cfm is not in demand mode, we check when (ccm_interval_ms * 3.5) ms
263 * have passed. When cfm is in demand mode, we check when
264 * (MAX(ccm_interval_ms, 500) * 3.5) ms have passed. This ensures that
265 * ovs-vswitchd has enough time to pull statistics from the datapath. */
267 return (MAX(cfm->ccm_interval_ms, cfm->demand ? 500 : cfm->ccm_interval_ms)
272 ms_to_ccm_interval(int interval_ms)
276 for (i = 7; i > 0; i--) {
277 if (ccm_interval_to_ms(i) <= interval_ms) {
286 hash_mpid(uint64_t mpid)
288 return hash_bytes(&mpid, sizeof mpid, 0);
292 cfm_is_valid_mpid(bool extended, uint64_t mpid)
294 /* 802.1ag specification requires MPIDs to be within the range [1, 8191].
295 * In extended mode we relax this requirement. */
296 return mpid >= 1 && (extended || mpid <= 8191);
299 static struct remote_mp *
300 lookup_remote_mp(const struct cfm *cfm, uint64_t mpid) OVS_REQUIRES(mutex)
302 struct remote_mp *rmp;
304 HMAP_FOR_EACH_IN_BUCKET (rmp, node, hash_mpid(mpid), &cfm->remote_mps) {
305 if (rmp->mpid == mpid) {
316 unixctl_command_register("cfm/show", "[interface]", 0, 1, cfm_unixctl_show,
318 unixctl_command_register("cfm/set-fault", "[interface] normal|false|true",
319 1, 2, cfm_unixctl_set_fault, NULL);
322 /* Allocates a 'cfm' object called 'name'. 'cfm' should be initialized by
323 * cfm_configure() before use. */
325 cfm_create(const struct netdev *netdev) OVS_EXCLUDED(mutex)
329 cfm = xzalloc(sizeof *cfm);
330 cfm->netdev = netdev_ref(netdev);
331 cfm->name = netdev_get_name(cfm->netdev);
332 hmap_init(&cfm->remote_mps);
333 cfm->remote_opup = true;
334 cfm->fault_override = -1;
338 atomic_init(&cfm->extended, false);
339 atomic_init(&cfm->check_tnl_key, false);
340 ovs_refcount_init(&cfm->ref_cnt);
342 ovs_mutex_lock(&mutex);
343 cfm_generate_maid(cfm);
344 hmap_insert(all_cfms, &cfm->hmap_node, hash_string(cfm->name, 0));
345 ovs_mutex_unlock(&mutex);
350 cfm_unref(struct cfm *cfm) OVS_EXCLUDED(mutex)
352 struct remote_mp *rmp, *rmp_next;
358 if (ovs_refcount_unref(&cfm->ref_cnt) != 1) {
362 ovs_mutex_lock(&mutex);
363 hmap_remove(all_cfms, &cfm->hmap_node);
364 ovs_mutex_unlock(&mutex);
366 HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &cfm->remote_mps) {
367 hmap_remove(&cfm->remote_mps, &rmp->node);
371 hmap_destroy(&cfm->remote_mps);
372 netdev_close(cfm->netdev);
373 free(cfm->rmps_array);
379 cfm_ref(const struct cfm *cfm_)
381 struct cfm *cfm = CONST_CAST(struct cfm *, cfm_);
383 ovs_refcount_ref(&cfm->ref_cnt);
388 /* Should be run periodically to update fault statistics messages. */
390 cfm_run(struct cfm *cfm) OVS_EXCLUDED(mutex)
392 ovs_mutex_lock(&mutex);
393 if (timer_expired(&cfm->fault_timer)) {
394 long long int interval = cfm_fault_interval(cfm);
395 struct remote_mp *rmp, *rmp_next;
396 bool old_cfm_fault = cfm->fault;
397 bool old_rmp_opup = cfm->remote_opup;
398 bool demand_override;
399 bool rmp_set_opup = false;
400 bool rmp_set_opdown = false;
402 cfm->fault = cfm->recv_fault;
405 cfm->rmps_array_len = 0;
406 free(cfm->rmps_array);
407 cfm->rmps_array = xmalloc(hmap_count(&cfm->remote_mps) *
408 sizeof *cfm->rmps_array);
410 if (cfm->health_interval == CFM_HEALTH_INTERVAL) {
411 /* Calculate the cfm health of the interface. If the number of
412 * remote_mpids of a cfm interface is > 1, the cfm health is
413 * undefined. If the number of remote_mpids is 1, the cfm health is
414 * the percentage of the ccm frames received in the
415 * (CFM_HEALTH_INTERVAL * 3.5)ms, else it is 0. */
416 if (hmap_count(&cfm->remote_mps) > 1) {
418 } else if (hmap_is_empty(&cfm->remote_mps)) {
422 int old_health = cfm->health;
424 rmp = CONTAINER_OF(hmap_first(&cfm->remote_mps),
425 struct remote_mp, node);
426 exp_ccm_recvd = (CFM_HEALTH_INTERVAL * 7) / 2;
427 /* Calculate the percentage of healthy ccm frames received.
428 * Since the 'fault_interval' is (3.5 * cfm_interval), and
429 * 1 CCM packet must be received every cfm_interval,
430 * the 'remote_mpid' health reports the percentage of
431 * healthy CCM frames received every
432 * 'CFM_HEALTH_INTERVAL'th 'fault_interval'. */
433 cfm->health = (rmp->num_health_ccm * 100) / exp_ccm_recvd;
434 cfm->health = MIN(cfm->health, 100);
435 rmp->num_health_ccm = 0;
436 ovs_assert(cfm->health >= 0 && cfm->health <= 100);
438 if (cfm->health != old_health) {
439 seq_change(connectivity_seq_get());
442 cfm->health_interval = 0;
444 cfm->health_interval++;
446 demand_override = false;
448 uint64_t rx_packets = cfm_rx_packets(cfm);
449 demand_override = hmap_count(&cfm->remote_mps) == 1
450 && rx_packets > cfm->rx_packets;
451 cfm->rx_packets = rx_packets;
454 HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &cfm->remote_mps) {
456 VLOG_INFO("%s: Received no CCM from RMP %"PRIu64" in the last"
457 " %lldms", cfm->name, rmp->mpid,
458 time_msec() - rmp->last_rx);
459 if (!demand_override) {
460 hmap_remove(&cfm->remote_mps, &rmp->node);
469 rmp_set_opdown = true;
472 cfm->rmps_array[cfm->rmps_array_len++] = rmp->mpid;
476 if (rmp_set_opdown) {
477 cfm->remote_opup = false;
479 else if (rmp_set_opup) {
480 cfm->remote_opup = true;
483 if (old_rmp_opup != cfm->remote_opup) {
484 seq_change(connectivity_seq_get());
487 if (hmap_is_empty(&cfm->remote_mps)) {
488 cfm->fault |= CFM_FAULT_RECV;
491 if (old_cfm_fault != cfm->fault) {
492 if (!VLOG_DROP_INFO(&rl)) {
493 struct ds ds = DS_EMPTY_INITIALIZER;
495 ds_put_cstr(&ds, "from [");
496 ds_put_cfm_fault(&ds, old_cfm_fault);
497 ds_put_cstr(&ds, "] to [");
498 ds_put_cfm_fault(&ds, cfm->fault);
499 ds_put_char(&ds, ']');
500 VLOG_INFO("%s: CFM faults changed %s.", cfm->name, ds_cstr(&ds));
504 /* If there is a flap, increments the counter. */
505 if (old_cfm_fault == false || cfm->fault == false) {
509 seq_change(connectivity_seq_get());
513 timer_set_duration(&cfm->fault_timer, interval);
514 VLOG_DBG("%s: new fault interval", cfm->name);
516 ovs_mutex_unlock(&mutex);
519 /* Should be run periodically to check if the CFM module has a CCM message it
522 cfm_should_send_ccm(struct cfm *cfm) OVS_EXCLUDED(mutex)
526 ovs_mutex_lock(&mutex);
527 ret = timer_expired(&cfm->tx_timer);
528 ovs_mutex_unlock(&mutex);
532 /* Composes a CCM message into 'packet'. Messages generated with this function
533 * should be sent whenever cfm_should_send_ccm() indicates. */
535 cfm_compose_ccm(struct cfm *cfm, struct ofpbuf *packet,
536 uint8_t eth_src[ETH_ADDR_LEN]) OVS_EXCLUDED(mutex)
542 ovs_mutex_lock(&mutex);
543 timer_set_duration(&cfm->tx_timer, cfm->ccm_interval_ms);
544 eth_compose(packet, cfm_ccm_addr(cfm), eth_src, ETH_TYPE_CFM, sizeof *ccm);
546 ccm_vlan = (cfm->ccm_vlan != CFM_RANDOM_VLAN
549 ccm_vlan = ccm_vlan & VLAN_VID_MASK;
551 if (ccm_vlan || cfm->ccm_pcp) {
552 uint16_t tci = ccm_vlan | (cfm->ccm_pcp << VLAN_PCP_SHIFT);
553 eth_push_vlan(packet, htons(ETH_TYPE_VLAN), htons(tci));
557 ccm->mdlevel_version = 0;
558 ccm->opcode = CCM_OPCODE;
559 ccm->tlv_offset = 70;
560 ccm->seq = htonl(++cfm->seq);
561 ccm->flags = cfm->ccm_interval;
562 memcpy(ccm->maid, cfm->maid, sizeof ccm->maid);
563 memset(ccm->zero, 0, sizeof ccm->zero);
566 atomic_read(&cfm->extended, &extended);
568 ccm->mpid = htons(hash_mpid(cfm->mpid));
569 ccm->mpid64 = htonll(cfm->mpid);
570 ccm->opdown = !cfm->opup;
572 ccm->mpid = htons(cfm->mpid);
573 ccm->mpid64 = htonll(0);
577 if (cfm->ccm_interval == 0) {
578 ovs_assert(extended);
579 ccm->interval_ms_x = htons(cfm->ccm_interval_ms);
581 ccm->interval_ms_x = htons(0);
584 if (cfm->booted && hmap_is_empty(&cfm->remote_mps)) {
585 ccm->flags |= CCM_RDI_MASK;
589 long long int delay = time_msec() - cfm->last_tx;
590 if (delay > (cfm->ccm_interval_ms * 3 / 2)) {
591 VLOG_WARN("%s: long delay of %lldms (expected %dms) sending CCM"
592 " seq %"PRIu32, cfm->name, delay, cfm->ccm_interval_ms,
596 cfm->last_tx = time_msec();
597 ovs_mutex_unlock(&mutex);
601 cfm_wait(struct cfm *cfm) OVS_EXCLUDED(mutex)
603 poll_timer_wait_until(cfm_wake_time(cfm));
607 /* Returns the next cfm wakeup time. */
609 cfm_wake_time(struct cfm *cfm) OVS_EXCLUDED(mutex)
611 long long int retval;
617 ovs_mutex_lock(&mutex);
618 retval = MIN(cfm->tx_timer.t, cfm->fault_timer.t);
619 ovs_mutex_unlock(&mutex);
624 /* Configures 'cfm' with settings from 's'. */
626 cfm_configure(struct cfm *cfm, const struct cfm_settings *s)
632 if (!cfm_is_valid_mpid(s->extended, s->mpid) || s->interval <= 0) {
636 ovs_mutex_lock(&mutex);
639 interval = ms_to_ccm_interval(s->interval);
640 interval_ms = ccm_interval_to_ms(interval);
642 atomic_store(&cfm->check_tnl_key, s->check_tnl_key);
643 atomic_store(&cfm->extended, s->extended);
645 cfm->ccm_vlan = s->ccm_vlan;
646 cfm->ccm_pcp = s->ccm_pcp & (VLAN_PCP_MASK >> VLAN_PCP_SHIFT);
647 if (s->extended && interval_ms != s->interval) {
649 interval_ms = MIN(s->interval, UINT16_MAX);
652 if (s->extended && s->demand) {
655 cfm->rx_packets = cfm_rx_packets(cfm);
661 if (interval != cfm->ccm_interval || interval_ms != cfm->ccm_interval_ms) {
662 cfm->ccm_interval = interval;
663 cfm->ccm_interval_ms = interval_ms;
665 timer_set_expired(&cfm->tx_timer);
666 timer_set_duration(&cfm->fault_timer, cfm_fault_interval(cfm));
669 ovs_mutex_unlock(&mutex);
673 /* Must be called when the netdev owned by 'cfm' should change. */
675 cfm_set_netdev(struct cfm *cfm, const struct netdev *netdev)
678 ovs_mutex_lock(&mutex);
679 if (cfm->netdev != netdev) {
680 netdev_close(cfm->netdev);
681 cfm->netdev = netdev_ref(netdev);
683 ovs_mutex_unlock(&mutex);
686 /* Returns true if 'cfm' should process packets from 'flow'. Sets
687 * fields in 'wc' that were used to make the determination. */
689 cfm_should_process_flow(const struct cfm *cfm_, const struct flow *flow,
690 struct flow_wildcards *wc)
692 struct cfm *cfm = CONST_CAST(struct cfm *, cfm_);
695 atomic_read(&cfm->check_tnl_key, &check_tnl_key);
696 memset(&wc->masks.dl_dst, 0xff, sizeof wc->masks.dl_dst);
698 memset(&wc->masks.tunnel.tun_id, 0xff, sizeof wc->masks.tunnel.tun_id);
700 return (ntohs(flow->dl_type) == ETH_TYPE_CFM
701 && eth_addr_equals(flow->dl_dst, cfm_ccm_addr(cfm))
702 && (!check_tnl_key || flow->tunnel.tun_id == htonll(0)));
705 /* Updates internal statistics relevant to packet 'p'. Should be called on
706 * every packet whose flow returned true when passed to
707 * cfm_should_process_flow. */
709 cfm_process_heartbeat(struct cfm *cfm, const struct ofpbuf *p)
713 struct eth_header *eth;
715 ovs_mutex_lock(&mutex);
718 ccm = ofpbuf_at(p, (uint8_t *)p->l3 - (uint8_t *)p->data, CCM_ACCEPT_LEN);
721 VLOG_INFO_RL(&rl, "%s: Received an unparseable 802.1ag CCM heartbeat.",
726 if (ccm->opcode != CCM_OPCODE) {
727 VLOG_INFO_RL(&rl, "%s: Received an unsupported 802.1ag message. "
728 "(opcode %u)", cfm->name, ccm->opcode);
732 /* According to the 802.1ag specification, reception of a CCM with an
733 * incorrect ccm_interval, unexpected MAID, or unexpected MPID should
734 * trigger a fault. We ignore this requirement for several reasons.
736 * Faults can cause a controller or Open vSwitch to make potentially
737 * expensive changes to the network topology. It seems prudent to trigger
738 * them judiciously, especially when CFM is used to check slave status of
739 * bonds. Furthermore, faults can be maliciously triggered by crafting
740 * unexpected CCMs. */
741 if (memcmp(ccm->maid, cfm->maid, sizeof ccm->maid)) {
742 cfm->recv_fault |= CFM_FAULT_MAID;
743 VLOG_WARN_RL(&rl, "%s: Received unexpected remote MAID from MAC "
744 ETH_ADDR_FMT, cfm->name, ETH_ADDR_ARGS(eth->eth_src));
746 uint8_t ccm_interval = ccm->flags & 0x7;
747 bool ccm_rdi = ccm->flags & CCM_RDI_MASK;
748 uint16_t ccm_interval_ms_x = ntohs(ccm->interval_ms_x);
750 struct remote_mp *rmp;
755 enum cfm_fault_reason cfm_fault = 0;
757 atomic_read(&cfm->extended, &extended);
759 ccm_mpid = ntohll(ccm->mpid64);
760 ccm_opdown = ccm->opdown;
762 ccm_mpid = ntohs(ccm->mpid);
765 ccm_seq = ntohl(ccm->seq);
767 if (ccm_interval != cfm->ccm_interval) {
768 VLOG_WARN_RL(&rl, "%s: received a CCM with an unexpected interval"
769 " (%"PRIu8") from RMP %"PRIu64, cfm->name,
770 ccm_interval, ccm_mpid);
773 if (extended && ccm_interval == 0
774 && ccm_interval_ms_x != cfm->ccm_interval_ms) {
775 VLOG_WARN_RL(&rl, "%s: received a CCM with an unexpected extended"
776 " interval (%"PRIu16"ms) from RMP %"PRIu64, cfm->name,
777 ccm_interval_ms_x, ccm_mpid);
780 rmp = lookup_remote_mp(cfm, ccm_mpid);
782 if (hmap_count(&cfm->remote_mps) < CFM_MAX_RMPS) {
783 rmp = xzalloc(sizeof *rmp);
784 hmap_insert(&cfm->remote_mps, &rmp->node, hash_mpid(ccm_mpid));
786 cfm_fault |= CFM_FAULT_OVERFLOW;
788 "%s: dropped CCM with MPID %"PRIu64" from MAC "
789 ETH_ADDR_FMT, cfm->name, ccm_mpid,
790 ETH_ADDR_ARGS(eth->eth_src));
795 cfm_fault |= CFM_FAULT_RDI;
796 VLOG_DBG("%s: RDI bit flagged from RMP %"PRIu64, cfm->name,
800 VLOG_DBG("%s: received CCM (seq %"PRIu32") (mpid %"PRIu64")"
801 " (interval %"PRIu8") (RDI %s)", cfm->name, ccm_seq,
802 ccm_mpid, ccm_interval, ccm_rdi ? "true" : "false");
805 if (rmp->mpid == cfm->mpid) {
806 cfm_fault |= CFM_FAULT_LOOPBACK;
807 VLOG_WARN_RL(&rl,"%s: received CCM with local MPID"
808 " %"PRIu64, cfm->name, rmp->mpid);
811 if (rmp->seq && ccm_seq != (rmp->seq + 1)) {
812 VLOG_WARN_RL(&rl, "%s: (mpid %"PRIu64") detected sequence"
813 " numbers which indicate possible connectivity"
814 " problems (previous %"PRIu32") (current %"PRIu32
815 ")", cfm->name, ccm_mpid, rmp->seq, ccm_seq);
818 rmp->mpid = ccm_mpid;
820 rmp->num_health_ccm++;
823 cfm->recv_fault |= cfm_fault;
825 rmp->opup = !ccm_opdown;
826 rmp->last_rx = time_msec();
831 ovs_mutex_unlock(&mutex);
835 cfm_get_fault__(const struct cfm *cfm) OVS_REQUIRES(mutex)
837 if (cfm->fault_override >= 0) {
838 return cfm->fault_override ? CFM_FAULT_OVERRIDE : 0;
843 /* Gets the fault status of 'cfm'. Returns a bit mask of 'cfm_fault_reason's
844 * indicating the cause of the connectivity fault, or zero if there is no
847 cfm_get_fault(const struct cfm *cfm) OVS_EXCLUDED(mutex)
851 ovs_mutex_lock(&mutex);
852 fault = cfm_get_fault__(cfm);
853 ovs_mutex_unlock(&mutex);
857 /* Gets the number of cfm fault flapping since start. */
859 cfm_get_flap_count(const struct cfm *cfm) OVS_EXCLUDED(mutex)
862 ovs_mutex_lock(&mutex);
863 flap_count = cfm->flap_count;
864 ovs_mutex_unlock(&mutex);
868 /* Gets the health of 'cfm'. Returns an integer between 0 and 100 indicating
869 * the health of the link as a percentage of ccm frames received in
870 * CFM_HEALTH_INTERVAL * 'fault_interval' if there is only 1 remote_mpid,
871 * returns 0 if there are no remote_mpids, and returns -1 if there are more
872 * than 1 remote_mpids. */
874 cfm_get_health(const struct cfm *cfm) OVS_EXCLUDED(mutex)
878 ovs_mutex_lock(&mutex);
879 health = cfm->health;
880 ovs_mutex_unlock(&mutex);
884 /* Gets the operational state of 'cfm'. 'cfm' is considered operationally down
885 * if it has received a CCM with the operationally down bit set from any of its
886 * remote maintenance points. Returns 1 if 'cfm' is operationally up, 0 if
887 * 'cfm' is operationally down, or -1 if 'cfm' has no operational state
888 * (because it isn't in extended mode). */
890 cfm_get_opup(const struct cfm *cfm_) OVS_EXCLUDED(mutex)
892 struct cfm *cfm = CONST_CAST(struct cfm *, cfm_);
896 ovs_mutex_lock(&mutex);
897 atomic_read(&cfm->extended, &extended);
898 opup = extended ? cfm->remote_opup : -1;
899 ovs_mutex_unlock(&mutex);
904 /* Populates 'rmps' with an array of remote maintenance points reachable by
905 * 'cfm'. The number of remote maintenance points is written to 'n_rmps'.
906 * 'cfm' retains ownership of the array written to 'rmps' */
908 cfm_get_remote_mpids(const struct cfm *cfm, uint64_t **rmps, size_t *n_rmps)
911 ovs_mutex_lock(&mutex);
912 *rmps = xmemdup(cfm->rmps_array, cfm->rmps_array_len * sizeof **rmps);
913 *n_rmps = cfm->rmps_array_len;
914 ovs_mutex_unlock(&mutex);
918 cfm_find(const char *name) OVS_REQUIRES(mutex)
922 HMAP_FOR_EACH_WITH_HASH (cfm, hmap_node, hash_string(name, 0), all_cfms) {
923 if (!strcmp(cfm->name, name)) {
931 cfm_print_details(struct ds *ds, struct cfm *cfm) OVS_REQUIRES(mutex)
933 struct remote_mp *rmp;
937 atomic_read(&cfm->extended, &extended);
939 ds_put_format(ds, "---- %s ----\n", cfm->name);
940 ds_put_format(ds, "MPID %"PRIu64":%s%s\n", cfm->mpid,
941 extended ? " extended" : "",
942 cfm->fault_override >= 0 ? " fault_override" : "");
944 fault = cfm_get_fault__(cfm);
946 ds_put_cstr(ds, "\tfault: ");
947 ds_put_cfm_fault(ds, fault);
948 ds_put_cstr(ds, "\n");
951 if (cfm->health == -1) {
952 ds_put_format(ds, "\taverage health: undefined\n");
954 ds_put_format(ds, "\taverage health: %d\n", cfm->health);
956 ds_put_format(ds, "\topstate: %s\n", cfm->opup ? "up" : "down");
957 ds_put_format(ds, "\tremote_opstate: %s\n",
958 cfm->remote_opup ? "up" : "down");
959 ds_put_format(ds, "\tinterval: %dms\n", cfm->ccm_interval_ms);
960 ds_put_format(ds, "\tnext CCM tx: %lldms\n",
961 timer_msecs_until_expired(&cfm->tx_timer));
962 ds_put_format(ds, "\tnext fault check: %lldms\n",
963 timer_msecs_until_expired(&cfm->fault_timer));
965 HMAP_FOR_EACH (rmp, node, &cfm->remote_mps) {
966 ds_put_format(ds, "Remote MPID %"PRIu64"\n", rmp->mpid);
967 ds_put_format(ds, "\trecv since check: %s\n",
968 rmp->recv ? "true" : "false");
969 ds_put_format(ds, "\topstate: %s\n", rmp->opup? "up" : "down");
974 cfm_unixctl_show(struct unixctl_conn *conn, int argc, const char *argv[],
975 void *aux OVS_UNUSED) OVS_EXCLUDED(mutex)
977 struct ds ds = DS_EMPTY_INITIALIZER;
980 ovs_mutex_lock(&mutex);
982 cfm = cfm_find(argv[1]);
984 unixctl_command_reply_error(conn, "no such CFM object");
987 cfm_print_details(&ds, cfm);
989 HMAP_FOR_EACH (cfm, hmap_node, all_cfms) {
990 cfm_print_details(&ds, cfm);
994 unixctl_command_reply(conn, ds_cstr(&ds));
997 ovs_mutex_unlock(&mutex);
1001 cfm_unixctl_set_fault(struct unixctl_conn *conn, int argc, const char *argv[],
1002 void *aux OVS_UNUSED) OVS_EXCLUDED(mutex)
1004 const char *fault_str = argv[argc - 1];
1008 ovs_mutex_lock(&mutex);
1009 if (!strcasecmp("true", fault_str)) {
1011 } else if (!strcasecmp("false", fault_str)) {
1013 } else if (!strcasecmp("normal", fault_str)) {
1014 fault_override = -1;
1016 unixctl_command_reply_error(conn, "unknown fault string");
1021 cfm = cfm_find(argv[1]);
1023 unixctl_command_reply_error(conn, "no such CFM object");
1026 cfm->fault_override = fault_override;
1028 HMAP_FOR_EACH (cfm, hmap_node, all_cfms) {
1029 cfm->fault_override = fault_override;
1033 seq_change(connectivity_seq_get());
1034 unixctl_command_reply(conn, "OK");
1037 ovs_mutex_unlock(&mutex);