2 * Copyright (c) 2010, 2011, 2012, 2013, 2014, 2015 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 "dp-packet.h"
27 #include "openvswitch/dynamic-string.h"
32 #include "ovs-atomic.h"
34 #include "poll-loop.h"
40 #include "openvswitch/vlog.h"
42 VLOG_DEFINE_THIS_MODULE(cfm);
44 #define CFM_MAX_RMPS 256
46 /* Ethernet destination address of CCM packets. */
47 static const struct eth_addr eth_addr_ccm = {
48 { { 0x01, 0x80, 0xC2, 0x00, 0x00, 0x30 } } };
49 static const struct eth_addr eth_addr_ccm_x = {
50 { { 0x01, 0x23, 0x20, 0x00, 0x00, 0x30 } } };
52 #define ETH_TYPE_CFM 0x8902
54 /* A 'ccm' represents a Continuity Check Message from the 802.1ag
55 * specification. Continuity Check Messages are broadcast periodically so that
56 * hosts can determine whom they have connectivity to.
58 * The minimum length of a CCM as specified by IEEE 802.1ag is 75 bytes.
59 * Previous versions of Open vSwitch generated 74-byte CCM messages, so we
60 * accept such messages too. */
62 #define CCM_ACCEPT_LEN 74
63 #define CCM_MAID_LEN 48
64 #define CCM_OPCODE 1 /* CFM message opcode meaning CCM. */
65 #define CCM_RDI_MASK 0x80
66 #define CFM_HEALTH_INTERVAL 6
70 uint8_t mdlevel_version; /* MD Level and Version */
76 uint8_t maid[CCM_MAID_LEN];
78 /* Defined by ITU-T Y.1731 should be zero */
79 ovs_be16 interval_ms_x; /* Transmission interval in ms. */
80 ovs_be64 mpid64; /* MPID in extended mode. */
81 uint8_t opdown; /* Operationally down. */
87 BUILD_ASSERT_DECL(CCM_LEN == sizeof(struct ccm));
90 const char *name; /* Name of this CFM object. */
91 struct hmap_node hmap_node; /* Node in all_cfms list. */
93 struct netdev *netdev;
94 uint64_t rx_packets; /* Packets received by 'netdev'. */
97 bool demand; /* Demand mode. */
98 bool booted; /* A full fault interval has occurred. */
99 enum cfm_fault_reason fault; /* Connectivity fault status. */
100 enum cfm_fault_reason recv_fault; /* Bit mask of faults occurring on
102 bool opup; /* Operational State. */
103 bool remote_opup; /* Remote Operational State. */
105 int fault_override; /* Manual override of 'fault' status.
106 Ignored if negative. */
108 uint32_t seq; /* The sequence number of our last CCM. */
109 uint8_t ccm_interval; /* The CCM transmission interval. */
110 int ccm_interval_ms; /* 'ccm_interval' in milliseconds. */
111 uint16_t ccm_vlan; /* Vlan tag of CCM PDUs. CFM_RANDOM_VLAN if
113 uint8_t ccm_pcp; /* Priority of CCM PDUs. */
114 uint8_t maid[CCM_MAID_LEN]; /* The MAID of this CFM. */
116 struct timer tx_timer; /* Send CCM when expired. */
117 struct timer fault_timer; /* Check for faults when expired. */
119 struct hmap remote_mps; /* Remote MPs. */
121 /* Result of cfm_get_remote_mpids(). Updated only during fault check to
123 uint64_t *rmps_array; /* Cache of remote_mps. */
124 size_t rmps_array_len; /* Number of rmps in 'rmps_array'. */
126 int health; /* Percentage of the number of CCM frames
128 int health_interval; /* Number of fault_intervals since health was
130 long long int last_tx; /* Last CCM transmission time. */
132 /* These bools are atomic to allow readers to check their values
133 * without taking 'mutex'. Such readers do not assume the values they
134 * read are synchronized with any other members. */
135 atomic_bool check_tnl_key; /* Verify the tunnel key of inbound packets? */
136 atomic_bool extended; /* Extended mode. */
137 struct ovs_refcount ref_cnt;
139 uint64_t flap_count; /* Count the flaps since boot. */
141 /* True when the variables returned by cfm_get_*() are changed
142 * since last check. */
145 /* When 'cfm->demand' is set, at least one ccm is required to be received
146 * every 100 * cfm_interval. If ccm is not received within this interval,
147 * even if data packets are received, the cfm fault will be set. */
148 struct timer demand_rx_ccm_t;
151 /* Remote MPs represent foreign network entities that are configured to have
152 * the same MAID as this CFM instance. */
154 uint64_t mpid; /* The Maintenance Point ID of this 'remote_mp'. */
155 struct hmap_node node; /* Node in 'remote_mps' map. */
157 bool recv; /* CCM was received since last fault check. */
158 bool opup; /* Operational State. */
159 uint32_t seq; /* Most recently received sequence number. */
160 uint8_t num_health_ccm; /* Number of received ccm frames every
161 CFM_HEALTH_INTERVAL * 'fault_interval'. */
162 long long int last_rx; /* Last CCM reception time. */
166 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(20, 30);
168 static struct ovs_mutex mutex = OVS_MUTEX_INITIALIZER;
169 static struct hmap all_cfms__ = HMAP_INITIALIZER(&all_cfms__);
170 static struct hmap *const all_cfms OVS_GUARDED_BY(mutex) = &all_cfms__;
172 static unixctl_cb_func cfm_unixctl_show;
173 static unixctl_cb_func cfm_unixctl_set_fault;
176 cfm_rx_packets(const struct cfm *cfm) OVS_REQUIRES(mutex)
178 struct netdev_stats stats;
180 if (!netdev_get_stats(cfm->netdev, &stats)) {
181 return stats.rx_packets;
187 static struct eth_addr
188 cfm_ccm_addr(struct cfm *cfm)
192 atomic_read_relaxed(&cfm->extended, &extended);
194 return extended ? eth_addr_ccm_x : eth_addr_ccm;
197 /* Returns the string representation of the given cfm_fault_reason 'reason'. */
199 cfm_fault_reason_to_str(int reason)
202 #define CFM_FAULT_REASON(NAME, STR) case CFM_FAULT_##NAME: return #STR;
204 #undef CFM_FAULT_REASON
205 default: return "<unknown>";
210 ds_put_cfm_fault(struct ds *ds, int fault)
214 for (i = 0; i < CFM_FAULT_N_REASONS; i++) {
217 if (fault & reason) {
218 ds_put_format(ds, "%s ", cfm_fault_reason_to_str(reason));
226 cfm_generate_maid(struct cfm *cfm) OVS_REQUIRES(mutex)
228 const char *ovs_md_name = "ovs";
229 const char *ovs_ma_name = "ovs";
231 size_t md_len, ma_len;
233 memset(cfm->maid, 0, CCM_MAID_LEN);
235 md_len = strlen(ovs_md_name);
236 ma_len = strlen(ovs_ma_name);
238 ovs_assert(md_len && ma_len && md_len + ma_len + 4 <= CCM_MAID_LEN);
240 cfm->maid[0] = 4; /* MD name string format. */
241 cfm->maid[1] = md_len; /* MD name size. */
242 memcpy(&cfm->maid[2], ovs_md_name, md_len); /* MD name. */
244 ma_p = cfm->maid + 2 + md_len;
245 ma_p[0] = 2; /* MA name string format. */
246 ma_p[1] = ma_len; /* MA name size. */
247 memcpy(&ma_p[2], ovs_ma_name, ma_len); /* MA name. */
251 ccm_interval_to_ms(uint8_t interval)
254 case 0: OVS_NOT_REACHED(); /* Explicitly not supported by 802.1ag. */
255 case 1: return 3; /* Not recommended due to timer resolution. */
256 case 2: return 10; /* Not recommended due to timer resolution. */
259 case 5: return 10000;
260 case 6: return 60000;
261 case 7: return 600000;
262 default: OVS_NOT_REACHED(); /* Explicitly not supported by 802.1ag. */
269 cfm_fault_interval(struct cfm *cfm) OVS_REQUIRES(mutex)
271 /* According to the 802.1ag specification we should assume every other MP
272 * with the same MAID has the same transmission interval that we have. If
273 * an MP has a different interval, cfm_process_heartbeat will register it
274 * as a fault (likely due to a configuration error). Thus we can check all
275 * MPs at once making this quite a bit simpler.
277 * When cfm is not in demand mode, we check when (ccm_interval_ms * 3.5) ms
278 * have passed. When cfm is in demand mode, we check when
279 * (MAX(ccm_interval_ms, 500) * 3.5) ms have passed. This ensures that
280 * ovs-vswitchd has enough time to pull statistics from the datapath. */
282 return (MAX(cfm->ccm_interval_ms, cfm->demand ? 500 : cfm->ccm_interval_ms)
287 ms_to_ccm_interval(int interval_ms)
291 for (i = 7; i > 0; i--) {
292 if (ccm_interval_to_ms(i) <= interval_ms) {
301 hash_mpid(uint64_t mpid)
303 return hash_uint64(mpid);
307 cfm_is_valid_mpid(bool extended, uint64_t mpid)
309 /* 802.1ag specification requires MPIDs to be within the range [1, 8191].
310 * In extended mode we relax this requirement. */
311 return mpid >= 1 && (extended || mpid <= 8191);
314 static struct remote_mp *
315 lookup_remote_mp(const struct cfm *cfm, uint64_t mpid) OVS_REQUIRES(mutex)
317 struct remote_mp *rmp;
319 HMAP_FOR_EACH_IN_BUCKET (rmp, node, hash_mpid(mpid), &cfm->remote_mps) {
320 if (rmp->mpid == mpid) {
331 unixctl_command_register("cfm/show", "[interface]", 0, 1, cfm_unixctl_show,
333 unixctl_command_register("cfm/set-fault", "[interface] normal|false|true",
334 1, 2, cfm_unixctl_set_fault, NULL);
337 /* Records the status change and changes the global connectivity seq. */
339 cfm_status_changed(struct cfm *cfm) OVS_REQUIRES(mutex)
341 seq_change(connectivity_seq_get());
342 cfm->status_changed = true;
345 /* Allocates a 'cfm' object called 'name'. 'cfm' should be initialized by
346 * cfm_configure() before use. */
348 cfm_create(const struct netdev *netdev) OVS_EXCLUDED(mutex)
352 cfm = xzalloc(sizeof *cfm);
353 cfm->netdev = netdev_ref(netdev);
354 cfm->name = netdev_get_name(cfm->netdev);
355 hmap_init(&cfm->remote_mps);
356 cfm->remote_opup = true;
357 cfm->fault_override = -1;
361 atomic_init(&cfm->extended, false);
362 atomic_init(&cfm->check_tnl_key, false);
363 ovs_refcount_init(&cfm->ref_cnt);
365 ovs_mutex_lock(&mutex);
366 cfm_status_changed(cfm);
367 cfm_generate_maid(cfm);
368 hmap_insert(all_cfms, &cfm->hmap_node, hash_string(cfm->name, 0));
369 ovs_mutex_unlock(&mutex);
375 cfm_unref(struct cfm *cfm) OVS_EXCLUDED(mutex)
377 struct remote_mp *rmp;
383 if (ovs_refcount_unref_relaxed(&cfm->ref_cnt) != 1) {
387 ovs_mutex_lock(&mutex);
388 cfm_status_changed(cfm);
389 hmap_remove(all_cfms, &cfm->hmap_node);
390 ovs_mutex_unlock(&mutex);
392 HMAP_FOR_EACH_POP (rmp, node, &cfm->remote_mps) {
396 hmap_destroy(&cfm->remote_mps);
397 netdev_close(cfm->netdev);
398 free(cfm->rmps_array);
404 cfm_ref(const struct cfm *cfm_)
406 struct cfm *cfm = CONST_CAST(struct cfm *, cfm_);
408 ovs_refcount_ref(&cfm->ref_cnt);
413 /* Should be run periodically to update fault statistics messages. */
415 cfm_run(struct cfm *cfm) OVS_EXCLUDED(mutex)
417 ovs_mutex_lock(&mutex);
418 if (timer_expired(&cfm->fault_timer)) {
419 long long int interval = cfm_fault_interval(cfm);
420 struct remote_mp *rmp, *rmp_next;
421 enum cfm_fault_reason old_cfm_fault = cfm->fault;
422 uint64_t old_flap_count = cfm->flap_count;
423 int old_health = cfm->health;
424 size_t old_rmps_array_len = cfm->rmps_array_len;
425 bool old_rmps_deleted = false;
426 bool old_rmp_opup = cfm->remote_opup;
427 bool demand_override;
428 bool rmp_set_opup = false;
429 bool rmp_set_opdown = false;
431 cfm->fault = cfm->recv_fault;
434 cfm->rmps_array_len = 0;
435 free(cfm->rmps_array);
436 cfm->rmps_array = xmalloc(hmap_count(&cfm->remote_mps) *
437 sizeof *cfm->rmps_array);
439 if (cfm->health_interval == CFM_HEALTH_INTERVAL) {
440 /* Calculate the cfm health of the interface. If the number of
441 * remote_mpids of a cfm interface is > 1, the cfm health is
442 * undefined. If the number of remote_mpids is 1, the cfm health is
443 * the percentage of the ccm frames received in the
444 * (CFM_HEALTH_INTERVAL * 3.5)ms, else it is 0. */
445 if (hmap_count(&cfm->remote_mps) > 1) {
447 } else if (hmap_is_empty(&cfm->remote_mps)) {
452 rmp = CONTAINER_OF(hmap_first(&cfm->remote_mps),
453 struct remote_mp, node);
454 exp_ccm_recvd = (CFM_HEALTH_INTERVAL * 7) / 2;
455 /* Calculate the percentage of healthy ccm frames received.
456 * Since the 'fault_interval' is (3.5 * cfm_interval), and
457 * 1 CCM packet must be received every cfm_interval,
458 * the 'remote_mpid' health reports the percentage of
459 * healthy CCM frames received every
460 * 'CFM_HEALTH_INTERVAL'th 'fault_interval'. */
461 cfm->health = (rmp->num_health_ccm * 100) / exp_ccm_recvd;
462 cfm->health = MIN(cfm->health, 100);
463 rmp->num_health_ccm = 0;
464 ovs_assert(cfm->health >= 0 && cfm->health <= 100);
466 cfm->health_interval = 0;
468 cfm->health_interval++;
470 demand_override = false;
472 uint64_t rx_packets = cfm_rx_packets(cfm);
473 demand_override = hmap_count(&cfm->remote_mps) == 1
474 && rx_packets > cfm->rx_packets
475 && !timer_expired(&cfm->demand_rx_ccm_t);
476 cfm->rx_packets = rx_packets;
479 HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &cfm->remote_mps) {
481 VLOG_INFO("%s: Received no CCM from RMP %"PRIu64" in the last"
482 " %lldms", cfm->name, rmp->mpid,
483 time_msec() - rmp->last_rx);
484 if (!demand_override) {
485 old_rmps_deleted = true;
486 hmap_remove(&cfm->remote_mps, &rmp->node);
495 rmp_set_opdown = true;
498 cfm->rmps_array[cfm->rmps_array_len++] = rmp->mpid;
502 if (rmp_set_opdown) {
503 cfm->remote_opup = false;
505 else if (rmp_set_opup) {
506 cfm->remote_opup = true;
509 if (hmap_is_empty(&cfm->remote_mps)) {
510 cfm->fault |= CFM_FAULT_RECV;
513 if (old_cfm_fault != cfm->fault) {
514 if (!VLOG_DROP_INFO(&rl)) {
515 struct ds ds = DS_EMPTY_INITIALIZER;
517 ds_put_cstr(&ds, "from [");
518 ds_put_cfm_fault(&ds, old_cfm_fault);
519 ds_put_cstr(&ds, "] to [");
520 ds_put_cfm_fault(&ds, cfm->fault);
521 ds_put_char(&ds, ']');
522 VLOG_INFO("%s: CFM faults changed %s.", cfm->name, ds_cstr(&ds));
526 /* If there is a flap, increments the counter. */
527 if (old_cfm_fault == 0 || cfm->fault == 0) {
532 /* These variables represent the cfm session status, it is desirable
533 * to update them to database immediately after change. */
534 if (old_health != cfm->health
535 || old_rmp_opup != cfm->remote_opup
536 || (old_rmps_array_len != cfm->rmps_array_len || old_rmps_deleted)
537 || old_cfm_fault != cfm->fault
538 || old_flap_count != cfm->flap_count) {
539 cfm_status_changed(cfm);
543 timer_set_duration(&cfm->fault_timer, interval);
544 VLOG_DBG("%s: new fault interval", cfm->name);
546 ovs_mutex_unlock(&mutex);
549 /* Should be run periodically to check if the CFM module has a CCM message it
552 cfm_should_send_ccm(struct cfm *cfm) OVS_EXCLUDED(mutex)
556 ovs_mutex_lock(&mutex);
557 ret = timer_expired(&cfm->tx_timer);
558 ovs_mutex_unlock(&mutex);
562 /* Composes a CCM message into 'packet'. Messages generated with this function
563 * should be sent whenever cfm_should_send_ccm() indicates. */
565 cfm_compose_ccm(struct cfm *cfm, struct dp_packet *packet,
566 const struct eth_addr eth_src) OVS_EXCLUDED(mutex)
572 ovs_mutex_lock(&mutex);
573 timer_set_duration(&cfm->tx_timer, cfm->ccm_interval_ms);
574 eth_compose(packet, cfm_ccm_addr(cfm), eth_src, ETH_TYPE_CFM, sizeof *ccm);
576 ccm_vlan = (cfm->ccm_vlan != CFM_RANDOM_VLAN
579 ccm_vlan = ccm_vlan & VLAN_VID_MASK;
581 if (ccm_vlan || cfm->ccm_pcp) {
582 uint16_t tci = ccm_vlan | (cfm->ccm_pcp << VLAN_PCP_SHIFT);
583 eth_push_vlan(packet, htons(ETH_TYPE_VLAN), htons(tci));
586 atomic_read_relaxed(&cfm->extended, &extended);
588 ccm = dp_packet_l3(packet);
589 ccm->mdlevel_version = 0;
590 ccm->opcode = CCM_OPCODE;
591 ccm->tlv_offset = 70;
592 ccm->seq = htonl(++cfm->seq);
593 ccm->flags = cfm->ccm_interval;
594 memcpy(ccm->maid, cfm->maid, sizeof ccm->maid);
595 memset(ccm->zero, 0, sizeof ccm->zero);
599 ccm->mpid = htons(hash_mpid(cfm->mpid));
600 ccm->mpid64 = htonll(cfm->mpid);
601 ccm->opdown = !cfm->opup;
603 ccm->mpid = htons(cfm->mpid);
604 ccm->mpid64 = htonll(0);
608 if (cfm->ccm_interval == 0) {
609 ovs_assert(extended);
610 ccm->interval_ms_x = htons(cfm->ccm_interval_ms);
612 ccm->interval_ms_x = htons(0);
615 if (cfm->booted && hmap_is_empty(&cfm->remote_mps)) {
616 ccm->flags |= CCM_RDI_MASK;
620 long long int delay = time_msec() - cfm->last_tx;
621 if (delay > (cfm->ccm_interval_ms * 3 / 2)) {
622 VLOG_INFO("%s: long delay of %lldms (expected %dms) sending CCM"
623 " seq %"PRIu32, cfm->name, delay, cfm->ccm_interval_ms,
627 cfm->last_tx = time_msec();
628 ovs_mutex_unlock(&mutex);
632 cfm_wait(struct cfm *cfm) OVS_EXCLUDED(mutex)
634 long long int wake_time = cfm_wake_time(cfm);
635 poll_timer_wait_until(wake_time);
640 /* Returns the next cfm wakeup time. */
642 cfm_wake_time(struct cfm *cfm) OVS_EXCLUDED(mutex)
644 long long int retval;
650 ovs_mutex_lock(&mutex);
651 retval = MIN(cfm->tx_timer.t, cfm->fault_timer.t);
652 ovs_mutex_unlock(&mutex);
657 /* Configures 'cfm' with settings from 's'. */
659 cfm_configure(struct cfm *cfm, const struct cfm_settings *s)
665 if (!cfm_is_valid_mpid(s->extended, s->mpid) || s->interval <= 0) {
669 ovs_mutex_lock(&mutex);
672 interval = ms_to_ccm_interval(s->interval);
673 interval_ms = ccm_interval_to_ms(interval);
675 atomic_store_relaxed(&cfm->check_tnl_key, s->check_tnl_key);
676 atomic_store_relaxed(&cfm->extended, s->extended);
678 cfm->ccm_vlan = s->ccm_vlan;
679 cfm->ccm_pcp = s->ccm_pcp & (VLAN_PCP_MASK >> VLAN_PCP_SHIFT);
680 if (s->extended && interval_ms != s->interval) {
682 interval_ms = MIN(s->interval, UINT16_MAX);
685 if (s->extended && s->demand) {
688 cfm->rx_packets = cfm_rx_packets(cfm);
694 if (interval != cfm->ccm_interval || interval_ms != cfm->ccm_interval_ms) {
695 cfm->ccm_interval = interval;
696 cfm->ccm_interval_ms = interval_ms;
698 timer_set_expired(&cfm->tx_timer);
699 timer_set_duration(&cfm->fault_timer, cfm_fault_interval(cfm));
702 ovs_mutex_unlock(&mutex);
706 /* Must be called when the netdev owned by 'cfm' should change. */
708 cfm_set_netdev(struct cfm *cfm, const struct netdev *netdev)
711 ovs_mutex_lock(&mutex);
712 if (cfm->netdev != netdev) {
713 netdev_close(cfm->netdev);
714 cfm->netdev = netdev_ref(netdev);
716 ovs_mutex_unlock(&mutex);
719 /* Returns true if 'cfm' should process packets from 'flow'. Sets
720 * fields in 'wc' that were used to make the determination. */
722 cfm_should_process_flow(const struct cfm *cfm_, const struct flow *flow,
723 struct flow_wildcards *wc)
725 struct cfm *cfm = CONST_CAST(struct cfm *, cfm_);
728 /* Most packets are not CFM. */
729 if (OVS_LIKELY(flow->dl_type != htons(ETH_TYPE_CFM))) {
733 memset(&wc->masks.dl_dst, 0xff, sizeof wc->masks.dl_dst);
734 if (OVS_UNLIKELY(!eth_addr_equals(flow->dl_dst, cfm_ccm_addr(cfm)))) {
738 atomic_read_relaxed(&cfm->check_tnl_key, &check_tnl_key);
741 memset(&wc->masks.tunnel.tun_id, 0xff, sizeof wc->masks.tunnel.tun_id);
742 return flow->tunnel.tun_id == htonll(0);
747 /* Updates internal statistics relevant to packet 'p'. Should be called on
748 * every packet whose flow returned true when passed to
749 * cfm_should_process_flow. */
751 cfm_process_heartbeat(struct cfm *cfm, const struct dp_packet *p)
755 struct eth_header *eth;
758 ovs_mutex_lock(&mutex);
760 atomic_read_relaxed(&cfm->extended, &extended);
762 eth = dp_packet_l2(p);
763 ccm = dp_packet_at(p, (uint8_t *)dp_packet_l3(p) - (uint8_t *)dp_packet_data(p),
767 VLOG_INFO_RL(&rl, "%s: Received an unparseable 802.1ag CCM heartbeat.",
772 if (ccm->opcode != CCM_OPCODE) {
773 VLOG_INFO_RL(&rl, "%s: Received an unsupported 802.1ag message. "
774 "(opcode %u)", cfm->name, ccm->opcode);
778 /* According to the 802.1ag specification, reception of a CCM with an
779 * incorrect ccm_interval, unexpected MAID, or unexpected MPID should
780 * trigger a fault. We ignore this requirement for several reasons.
782 * Faults can cause a controller or Open vSwitch to make potentially
783 * expensive changes to the network topology. It seems prudent to trigger
784 * them judiciously, especially when CFM is used to check slave status of
785 * bonds. Furthermore, faults can be maliciously triggered by crafting
786 * unexpected CCMs. */
787 if (memcmp(ccm->maid, cfm->maid, sizeof ccm->maid)) {
788 cfm->recv_fault |= CFM_FAULT_MAID;
789 VLOG_WARN_RL(&rl, "%s: Received unexpected remote MAID from MAC "
790 ETH_ADDR_FMT, cfm->name, ETH_ADDR_ARGS(eth->eth_src));
792 uint8_t ccm_interval = ccm->flags & 0x7;
793 bool ccm_rdi = ccm->flags & CCM_RDI_MASK;
794 uint16_t ccm_interval_ms_x = ntohs(ccm->interval_ms_x);
796 struct remote_mp *rmp;
800 enum cfm_fault_reason cfm_fault = 0;
803 ccm_mpid = ntohll(ccm->mpid64);
804 ccm_opdown = ccm->opdown;
806 ccm_mpid = ntohs(ccm->mpid);
809 ccm_seq = ntohl(ccm->seq);
811 if (ccm_interval != cfm->ccm_interval) {
812 VLOG_WARN_RL(&rl, "%s: received a CCM with an unexpected interval"
813 " (%"PRIu8") from RMP %"PRIu64, cfm->name,
814 ccm_interval, ccm_mpid);
817 if (extended && ccm_interval == 0
818 && ccm_interval_ms_x != cfm->ccm_interval_ms) {
819 VLOG_WARN_RL(&rl, "%s: received a CCM with an unexpected extended"
820 " interval (%"PRIu16"ms) from RMP %"PRIu64, cfm->name,
821 ccm_interval_ms_x, ccm_mpid);
824 rmp = lookup_remote_mp(cfm, ccm_mpid);
826 if (hmap_count(&cfm->remote_mps) < CFM_MAX_RMPS) {
827 rmp = xzalloc(sizeof *rmp);
828 hmap_insert(&cfm->remote_mps, &rmp->node, hash_mpid(ccm_mpid));
830 cfm_fault |= CFM_FAULT_OVERFLOW;
832 "%s: dropped CCM with MPID %"PRIu64" from MAC "
833 ETH_ADDR_FMT, cfm->name, ccm_mpid,
834 ETH_ADDR_ARGS(eth->eth_src));
839 cfm_fault |= CFM_FAULT_RDI;
840 VLOG_DBG("%s: RDI bit flagged from RMP %"PRIu64, cfm->name,
844 VLOG_DBG("%s: received CCM (seq %"PRIu32") (mpid %"PRIu64")"
845 " (interval %"PRIu8") (RDI %s)", cfm->name, ccm_seq,
846 ccm_mpid, ccm_interval, ccm_rdi ? "true" : "false");
849 if (rmp->mpid == cfm->mpid) {
850 cfm_fault |= CFM_FAULT_LOOPBACK;
851 VLOG_WARN_RL(&rl,"%s: received CCM with local MPID"
852 " %"PRIu64, cfm->name, rmp->mpid);
855 if (rmp->seq && ccm_seq != (rmp->seq + 1)) {
856 VLOG_WARN_RL(&rl, "%s: (mpid %"PRIu64") detected sequence"
857 " numbers which indicate possible connectivity"
858 " problems (previous %"PRIu32") (current %"PRIu32
859 ")", cfm->name, ccm_mpid, rmp->seq, ccm_seq);
862 rmp->mpid = ccm_mpid;
864 rmp->num_health_ccm++;
866 timer_set_duration(&cfm->demand_rx_ccm_t,
867 100 * cfm->ccm_interval_ms);
871 cfm->recv_fault |= cfm_fault;
873 rmp->opup = !ccm_opdown;
874 rmp->last_rx = time_msec();
879 ovs_mutex_unlock(&mutex);
882 /* Returns and resets the 'cfm->status_changed'. */
884 cfm_check_status_change(struct cfm *cfm) OVS_EXCLUDED(mutex)
888 ovs_mutex_lock(&mutex);
889 ret = cfm->status_changed;
890 cfm->status_changed = false;
891 ovs_mutex_unlock(&mutex);
897 cfm_get_fault__(const struct cfm *cfm) OVS_REQUIRES(mutex)
899 if (cfm->fault_override >= 0) {
900 return cfm->fault_override ? CFM_FAULT_OVERRIDE : 0;
905 /* Gets the fault status of 'cfm'. Returns a bit mask of 'cfm_fault_reason's
906 * indicating the cause of the connectivity fault, or zero if there is no
909 cfm_get_fault(const struct cfm *cfm) OVS_EXCLUDED(mutex)
913 ovs_mutex_lock(&mutex);
914 fault = cfm_get_fault__(cfm);
915 ovs_mutex_unlock(&mutex);
919 /* Gets the number of cfm fault flapping since start. */
921 cfm_get_flap_count(const struct cfm *cfm) OVS_EXCLUDED(mutex)
924 ovs_mutex_lock(&mutex);
925 flap_count = cfm->flap_count;
926 ovs_mutex_unlock(&mutex);
930 /* Gets the health of 'cfm'. Returns an integer between 0 and 100 indicating
931 * the health of the link as a percentage of ccm frames received in
932 * CFM_HEALTH_INTERVAL * 'fault_interval' if there is only 1 remote_mpid,
933 * returns 0 if there are no remote_mpids, and returns -1 if there are more
934 * than 1 remote_mpids. */
936 cfm_get_health(const struct cfm *cfm) OVS_EXCLUDED(mutex)
940 ovs_mutex_lock(&mutex);
941 health = cfm->health;
942 ovs_mutex_unlock(&mutex);
947 cfm_get_opup__(const struct cfm *cfm_) OVS_REQUIRES(mutex)
949 struct cfm *cfm = CONST_CAST(struct cfm *, cfm_);
952 atomic_read_relaxed(&cfm->extended, &extended);
954 return extended ? cfm->remote_opup : -1;
957 /* Gets the operational state of 'cfm'. 'cfm' is considered operationally down
958 * if it has received a CCM with the operationally down bit set from any of its
959 * remote maintenance points. Returns 1 if 'cfm' is operationally up, 0 if
960 * 'cfm' is operationally down, or -1 if 'cfm' has no operational state
961 * (because it isn't in extended mode). */
963 cfm_get_opup(const struct cfm *cfm) OVS_EXCLUDED(mutex)
967 ovs_mutex_lock(&mutex);
968 opup = cfm_get_opup__(cfm);
969 ovs_mutex_unlock(&mutex);
975 cfm_get_remote_mpids__(const struct cfm *cfm, uint64_t **rmps, size_t *n_rmps)
978 *rmps = xmemdup(cfm->rmps_array, cfm->rmps_array_len * sizeof **rmps);
979 *n_rmps = cfm->rmps_array_len;
982 /* Populates 'rmps' with an array of remote maintenance points reachable by
983 * 'cfm'. The number of remote maintenance points is written to 'n_rmps'.
984 * 'cfm' retains ownership of the array written to 'rmps' */
986 cfm_get_remote_mpids(const struct cfm *cfm, uint64_t **rmps, size_t *n_rmps)
989 ovs_mutex_lock(&mutex);
990 cfm_get_remote_mpids__(cfm, rmps, n_rmps);
991 ovs_mutex_unlock(&mutex);
994 /* Extracts the status of 'cfm' and fills in the 's'. */
996 cfm_get_status(const struct cfm *cfm, struct cfm_status *s) OVS_EXCLUDED(mutex)
998 ovs_mutex_lock(&mutex);
999 s->faults = cfm_get_fault__(cfm);
1000 s->remote_opstate = cfm_get_opup__(cfm);
1001 s->flap_count = cfm->flap_count;
1002 s->health = cfm->health;
1003 cfm_get_remote_mpids__(cfm, &s->rmps, &s->n_rmps);
1004 ovs_mutex_unlock(&mutex);
1008 cfm_find(const char *name) OVS_REQUIRES(mutex)
1012 HMAP_FOR_EACH_WITH_HASH (cfm, hmap_node, hash_string(name, 0), all_cfms) {
1013 if (!strcmp(cfm->name, name)) {
1021 cfm_print_details(struct ds *ds, struct cfm *cfm) OVS_REQUIRES(mutex)
1023 struct remote_mp *rmp;
1027 atomic_read_relaxed(&cfm->extended, &extended);
1029 ds_put_format(ds, "---- %s ----\n", cfm->name);
1030 ds_put_format(ds, "MPID %"PRIu64":%s%s\n", cfm->mpid,
1031 extended ? " extended" : "",
1032 cfm->fault_override >= 0 ? " fault_override" : "");
1034 fault = cfm_get_fault__(cfm);
1036 ds_put_cstr(ds, "\tfault: ");
1037 ds_put_cfm_fault(ds, fault);
1038 ds_put_cstr(ds, "\n");
1041 if (cfm->health == -1) {
1042 ds_put_format(ds, "\taverage health: undefined\n");
1044 ds_put_format(ds, "\taverage health: %d\n", cfm->health);
1046 ds_put_format(ds, "\topstate: %s\n", cfm->opup ? "up" : "down");
1047 ds_put_format(ds, "\tremote_opstate: %s\n",
1048 cfm->remote_opup ? "up" : "down");
1049 ds_put_format(ds, "\tinterval: %dms\n", cfm->ccm_interval_ms);
1050 ds_put_format(ds, "\tnext CCM tx: %lldms\n",
1051 timer_msecs_until_expired(&cfm->tx_timer));
1052 ds_put_format(ds, "\tnext fault check: %lldms\n",
1053 timer_msecs_until_expired(&cfm->fault_timer));
1055 HMAP_FOR_EACH (rmp, node, &cfm->remote_mps) {
1056 ds_put_format(ds, "Remote MPID %"PRIu64"\n", rmp->mpid);
1057 ds_put_format(ds, "\trecv since check: %s\n",
1058 rmp->recv ? "true" : "false");
1059 ds_put_format(ds, "\topstate: %s\n", rmp->opup? "up" : "down");
1064 cfm_unixctl_show(struct unixctl_conn *conn, int argc, const char *argv[],
1065 void *aux OVS_UNUSED) OVS_EXCLUDED(mutex)
1067 struct ds ds = DS_EMPTY_INITIALIZER;
1070 ovs_mutex_lock(&mutex);
1072 cfm = cfm_find(argv[1]);
1074 unixctl_command_reply_error(conn, "no such CFM object");
1077 cfm_print_details(&ds, cfm);
1079 HMAP_FOR_EACH (cfm, hmap_node, all_cfms) {
1080 cfm_print_details(&ds, cfm);
1084 unixctl_command_reply(conn, ds_cstr(&ds));
1087 ovs_mutex_unlock(&mutex);
1091 cfm_unixctl_set_fault(struct unixctl_conn *conn, int argc, const char *argv[],
1092 void *aux OVS_UNUSED) OVS_EXCLUDED(mutex)
1094 const char *fault_str = argv[argc - 1];
1098 ovs_mutex_lock(&mutex);
1099 if (!strcasecmp("true", fault_str)) {
1101 } else if (!strcasecmp("false", fault_str)) {
1103 } else if (!strcasecmp("normal", fault_str)) {
1104 fault_override = -1;
1106 unixctl_command_reply_error(conn, "unknown fault string");
1111 cfm = cfm_find(argv[1]);
1113 unixctl_command_reply_error(conn, "no such CFM object");
1116 cfm->fault_override = fault_override;
1117 cfm_status_changed(cfm);
1119 HMAP_FOR_EACH (cfm, hmap_node, all_cfms) {
1120 cfm->fault_override = fault_override;
1121 cfm_status_changed(cfm);
1125 unixctl_command_reply(conn, "OK");
1128 ovs_mutex_unlock(&mutex);