2 * Copyright (c) 2010, 2011 Nicira Networks.
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.
25 #include "byte-order.h"
26 #include "dynamic-string.h"
32 #include "poll-loop.h"
38 VLOG_DEFINE_THIS_MODULE(cfm);
40 #define CFM_MAX_RMPS 256
42 /* Ethernet destination address of CCM packets. */
43 static const uint8_t eth_addr_ccm[6] = { 0x01, 0x80, 0xC2, 0x00, 0x00, 0x30 };
44 static const uint8_t eth_addr_ccm_x[6] = {
45 0x01, 0x23, 0x20, 0x00, 0x00, 0x30
48 #define ETH_TYPE_CFM 0x8902
50 /* A 'ccm' represents a Continuity Check Message from the 802.1ag
51 * specification. Continuity Check Messages are broadcast periodically so that
52 * hosts can determine whom they have connectivity to.
54 * The minimum length of a CCM as specified by IEEE 802.1ag is 75 bytes.
55 * Previous versions of Open vSwitch generated 74-byte CCM messages, so we
56 * accept such messages too. */
58 #define CCM_ACCEPT_LEN 74
59 #define CCM_MAID_LEN 48
60 #define CCM_OPCODE 1 /* CFM message opcode meaning CCM. */
61 #define CCM_RDI_MASK 0x80
63 uint8_t mdlevel_version; /* MD Level and Version */
69 uint8_t maid[CCM_MAID_LEN];
71 /* Defined by ITU-T Y.1731 should be zero */
72 ovs_be16 interval_ms_x; /* Transmission interval in ms. */
73 ovs_be64 mpid64; /* MPID in extended mode. */
74 uint8_t opdown; /* Operationally down. */
79 } __attribute__((packed));
80 BUILD_ASSERT_DECL(CCM_LEN == sizeof(struct ccm));
83 char *name; /* Name of this CFM object. */
84 struct hmap_node hmap_node; /* Node in all_cfms list. */
87 bool extended; /* Extended mode. */
88 bool fault; /* Indicates connectivity fault. */
89 bool unexpected_recv; /* Received an unexpected CCM. */
90 bool opup; /* Operational State. */
91 bool remote_opup; /* Remote Operational State. */
93 int fault_override; /* Manual override of 'fault' status.
94 Ignored if negative. */
96 uint32_t seq; /* The sequence number of our last CCM. */
97 uint8_t ccm_interval; /* The CCM transmission interval. */
98 int ccm_interval_ms; /* 'ccm_interval' in milliseconds. */
99 uint16_t ccm_vlan; /* Vlan tag of CCM PDUs. */
100 uint8_t maid[CCM_MAID_LEN]; /* The MAID of this CFM. */
102 struct timer tx_timer; /* Send CCM when expired. */
103 struct timer fault_timer; /* Check for faults when expired. */
105 struct hmap remote_mps; /* Remote MPs. */
107 /* Result of cfm_get_remote_mpids(). Updated only during fault check to
109 uint64_t *rmps_array; /* Cache of remote_mps. */
110 size_t rmps_array_len; /* Number of rmps in 'rmps_array'. */
113 /* Remote MPs represent foreign network entities that are configured to have
114 * the same MAID as this CFM instance. */
116 uint64_t mpid; /* The Maintenance Point ID of this 'remote_mp'. */
117 struct hmap_node node; /* Node in 'remote_mps' map. */
119 bool recv; /* CCM was received since last fault check. */
120 bool rdi; /* Remote Defect Indicator. Indicates remote_mp isn't
121 receiving CCMs that it's expecting to. */
122 bool opup; /* Operational State. */
123 uint32_t seq; /* Most recently received sequence number. */
126 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(20, 30);
127 static struct hmap all_cfms = HMAP_INITIALIZER(&all_cfms);
129 static unixctl_cb_func cfm_unixctl_show;
130 static unixctl_cb_func cfm_unixctl_set_fault;
132 static const uint8_t *
133 cfm_ccm_addr(const struct cfm *cfm)
135 return cfm->extended ? eth_addr_ccm_x : eth_addr_ccm;
139 cfm_generate_maid(struct cfm *cfm)
141 const char *ovs_md_name = "ovs";
142 const char *ovs_ma_name = "ovs";
144 size_t md_len, ma_len;
146 memset(cfm->maid, 0, CCM_MAID_LEN);
148 md_len = strlen(ovs_md_name);
149 ma_len = strlen(ovs_ma_name);
151 assert(md_len && ma_len && md_len + ma_len + 4 <= CCM_MAID_LEN);
153 cfm->maid[0] = 4; /* MD name string format. */
154 cfm->maid[1] = md_len; /* MD name size. */
155 memcpy(&cfm->maid[2], ovs_md_name, md_len); /* MD name. */
157 ma_p = cfm->maid + 2 + md_len;
158 ma_p[0] = 2; /* MA name string format. */
159 ma_p[1] = ma_len; /* MA name size. */
160 memcpy(&ma_p[2], ovs_ma_name, ma_len); /* MA name. */
164 ccm_interval_to_ms(uint8_t interval)
167 case 0: NOT_REACHED(); /* Explicitly not supported by 802.1ag. */
168 case 1: return 3; /* Not recommended due to timer resolution. */
169 case 2: return 10; /* Not recommended due to timer resolution. */
172 case 5: return 10000;
173 case 6: return 60000;
174 case 7: return 600000;
175 default: NOT_REACHED(); /* Explicitly not supported by 802.1ag. */
182 cfm_fault_interval(struct cfm *cfm)
184 /* According to the 802.1ag specification we should assume every other MP
185 * with the same MAID has the same transmission interval that we have. If
186 * an MP has a different interval, cfm_process_heartbeat will register it
187 * as a fault (likely due to a configuration error). Thus we can check all
188 * MPs at once making this quite a bit simpler.
190 * According to the specification we should check when (ccm_interval_ms *
191 * 3.5)ms have passed. */
192 return (cfm->ccm_interval_ms * 7) / 2;
196 ms_to_ccm_interval(int interval_ms)
200 for (i = 7; i > 0; i--) {
201 if (ccm_interval_to_ms(i) <= interval_ms) {
210 hash_mpid(uint64_t mpid)
212 return hash_bytes(&mpid, sizeof mpid, 0);
216 cfm_is_valid_mpid(bool extended, uint64_t mpid)
218 /* 802.1ag specification requires MPIDs to be within the range [1, 8191].
219 * In extended mode we relax this requirement. */
220 return mpid >= 1 && (extended || mpid <= 8191);
223 static struct remote_mp *
224 lookup_remote_mp(const struct cfm *cfm, uint64_t mpid)
226 struct remote_mp *rmp;
228 HMAP_FOR_EACH_IN_BUCKET (rmp, node, hash_mpid(mpid), &cfm->remote_mps) {
229 if (rmp->mpid == mpid) {
240 unixctl_command_register("cfm/show", "[interface]", 0, 1, cfm_unixctl_show,
242 unixctl_command_register("cfm/set-fault", "[interface] normal|false|true",
243 1, 2, cfm_unixctl_set_fault, NULL);
246 /* Allocates a 'cfm' object called 'name'. 'cfm' should be initialized by
247 * cfm_configure() before use. */
249 cfm_create(const char *name)
253 cfm = xzalloc(sizeof *cfm);
254 cfm->name = xstrdup(name);
255 hmap_init(&cfm->remote_mps);
256 cfm_generate_maid(cfm);
257 hmap_insert(&all_cfms, &cfm->hmap_node, hash_string(cfm->name, 0));
258 cfm->remote_opup = true;
259 cfm->fault_override = -1;
264 cfm_destroy(struct cfm *cfm)
266 struct remote_mp *rmp, *rmp_next;
272 HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &cfm->remote_mps) {
273 hmap_remove(&cfm->remote_mps, &rmp->node);
277 hmap_destroy(&cfm->remote_mps);
278 hmap_remove(&all_cfms, &cfm->hmap_node);
279 free(cfm->rmps_array);
284 /* Should be run periodically to update fault statistics messages. */
286 cfm_run(struct cfm *cfm)
288 if (timer_expired(&cfm->fault_timer)) {
289 long long int interval = cfm_fault_interval(cfm);
290 struct remote_mp *rmp, *rmp_next;
291 bool old_cfm_fault = cfm->fault;
293 cfm->fault = cfm->unexpected_recv;
294 cfm->unexpected_recv = false;
296 cfm->rmps_array_len = 0;
297 free(cfm->rmps_array);
298 cfm->rmps_array = xmalloc(hmap_count(&cfm->remote_mps) *
299 sizeof *cfm->rmps_array);
301 cfm->remote_opup = true;
302 HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &cfm->remote_mps) {
305 VLOG_DBG("%s: no CCM from RMP %"PRIu64" in the last %lldms",
306 cfm->name, rmp->mpid, interval);
307 hmap_remove(&cfm->remote_mps, &rmp->node);
312 if (rmp->mpid == cfm->mpid) {
313 VLOG_WARN_RL(&rl,"%s: received CCM with local MPID"
314 " %"PRIu64, cfm->name, rmp->mpid);
319 VLOG_DBG("%s: RDI bit flagged from RMP %"PRIu64, cfm->name,
325 cfm->remote_opup = rmp->opup;
328 cfm->rmps_array[cfm->rmps_array_len++] = rmp->mpid;
332 if (hmap_is_empty(&cfm->remote_mps)) {
336 if (old_cfm_fault != cfm->fault) {
337 VLOG_INFO_RL(&rl, "%s: CFM fault status changed to %s",
338 cfm->name, cfm->fault ? "true" : "false");
341 timer_set_duration(&cfm->fault_timer, interval);
345 /* Should be run periodically to check if the CFM module has a CCM message it
348 cfm_should_send_ccm(struct cfm *cfm)
350 return timer_expired(&cfm->tx_timer);
353 /* Composes a CCM message into 'packet'. Messages generated with this function
354 * should be sent whenever cfm_should_send_ccm() indicates. */
356 cfm_compose_ccm(struct cfm *cfm, struct ofpbuf *packet,
357 uint8_t eth_src[ETH_ADDR_LEN])
361 timer_set_duration(&cfm->tx_timer, cfm->ccm_interval_ms);
362 eth_compose(packet, cfm_ccm_addr(cfm), eth_src, ETH_TYPE_CFM, sizeof *ccm);
365 eth_push_vlan(packet, htons(cfm->ccm_vlan));
369 ccm->mdlevel_version = 0;
370 ccm->opcode = CCM_OPCODE;
371 ccm->tlv_offset = 70;
372 ccm->seq = htonl(++cfm->seq);
373 ccm->flags = cfm->ccm_interval;
374 memcpy(ccm->maid, cfm->maid, sizeof ccm->maid);
375 memset(ccm->zero, 0, sizeof ccm->zero);
379 ccm->mpid = htons(hash_mpid(cfm->mpid));
380 ccm->mpid64 = htonll(cfm->mpid);
381 ccm->opdown = !cfm->opup;
383 ccm->mpid = htons(cfm->mpid);
384 ccm->mpid64 = htonll(0);
388 if (cfm->ccm_interval == 0) {
389 assert(cfm->extended);
390 ccm->interval_ms_x = htons(cfm->ccm_interval_ms);
393 if (hmap_is_empty(&cfm->remote_mps)) {
394 ccm->flags |= CCM_RDI_MASK;
399 cfm_wait(struct cfm *cfm)
401 timer_wait(&cfm->tx_timer);
402 timer_wait(&cfm->fault_timer);
405 /* Configures 'cfm' with settings from 's'. */
407 cfm_configure(struct cfm *cfm, const struct cfm_settings *s)
412 if (!cfm_is_valid_mpid(s->extended, s->mpid) || s->interval <= 0) {
417 cfm->extended = s->extended;
419 interval = ms_to_ccm_interval(s->interval);
420 interval_ms = ccm_interval_to_ms(interval);
422 cfm->ccm_vlan = s->ccm_vlan & VLAN_VID_MASK;
423 if (cfm->extended && interval_ms != s->interval) {
425 interval_ms = MIN(s->interval, UINT16_MAX);
428 if (interval != cfm->ccm_interval || interval_ms != cfm->ccm_interval_ms) {
429 cfm->ccm_interval = interval;
430 cfm->ccm_interval_ms = interval_ms;
432 timer_set_expired(&cfm->tx_timer);
433 timer_set_duration(&cfm->fault_timer, cfm_fault_interval(cfm));
439 /* Returns true if 'cfm' should process packets from 'flow'. */
441 cfm_should_process_flow(const struct cfm *cfm, const struct flow *flow)
443 return (ntohs(flow->dl_type) == ETH_TYPE_CFM
444 && eth_addr_equals(flow->dl_dst, cfm_ccm_addr(cfm)));
447 /* Updates internal statistics relevant to packet 'p'. Should be called on
448 * every packet whose flow returned true when passed to
449 * cfm_should_process_flow. */
451 cfm_process_heartbeat(struct cfm *cfm, const struct ofpbuf *p)
454 struct eth_header *eth;
457 ccm = ofpbuf_at(p, (uint8_t *)p->l3 - (uint8_t *)p->data, CCM_ACCEPT_LEN);
460 VLOG_INFO_RL(&rl, "%s: Received an unparseable 802.1ag CCM heartbeat.",
465 if (ccm->opcode != CCM_OPCODE) {
466 VLOG_INFO_RL(&rl, "%s: Received an unsupported 802.1ag message. "
467 "(opcode %u)", cfm->name, ccm->opcode);
471 /* According to the 802.1ag specification, reception of a CCM with an
472 * incorrect ccm_interval, unexpected MAID, or unexpected MPID should
473 * trigger a fault. We ignore this requirement for several reasons.
475 * Faults can cause a controller or Open vSwitch to make potentially
476 * expensive changes to the network topology. It seems prudent to trigger
477 * them judiciously, especially when CFM is used to check slave status of
478 * bonds. Furthermore, faults can be maliciously triggered by crafting
480 if (memcmp(ccm->maid, cfm->maid, sizeof ccm->maid)) {
481 cfm->unexpected_recv = true;
482 VLOG_WARN_RL(&rl, "%s: Received unexpected remote MAID from MAC "
483 ETH_ADDR_FMT, cfm->name, ETH_ADDR_ARGS(eth->eth_src));
485 uint8_t ccm_interval = ccm->flags & 0x7;
486 bool ccm_rdi = ccm->flags & CCM_RDI_MASK;
487 uint16_t ccm_interval_ms_x = ntohs(ccm->interval_ms_x);
489 struct remote_mp *rmp;
495 ccm_mpid = ntohll(ccm->mpid64);
496 ccm_opdown = ccm->opdown;
498 ccm_mpid = ntohs(ccm->mpid);
501 ccm_seq = ntohl(ccm->seq);
503 if (ccm_interval != cfm->ccm_interval) {
504 VLOG_WARN_RL(&rl, "%s: received a CCM with an invalid interval"
505 " (%"PRIu8") from RMP %"PRIu64, cfm->name,
506 ccm_interval, ccm_mpid);
509 if (cfm->extended && ccm_interval == 0
510 && ccm_interval_ms_x != cfm->ccm_interval_ms) {
511 VLOG_WARN_RL(&rl, "%s: received a CCM with an invalid extended"
512 " interval (%"PRIu16"ms) from RMP %"PRIu64, cfm->name,
513 ccm_interval_ms_x, ccm_mpid);
516 rmp = lookup_remote_mp(cfm, ccm_mpid);
518 if (hmap_count(&cfm->remote_mps) < CFM_MAX_RMPS) {
519 rmp = xzalloc(sizeof *rmp);
520 hmap_insert(&cfm->remote_mps, &rmp->node, hash_mpid(ccm_mpid));
522 cfm->unexpected_recv = true;
524 "%s: dropped CCM with MPID %"PRIu64" from MAC "
525 ETH_ADDR_FMT, cfm->name, ccm_mpid,
526 ETH_ADDR_ARGS(eth->eth_src));
530 VLOG_DBG("%s: received CCM (seq %"PRIu32") (mpid %"PRIu64")"
531 " (interval %"PRIu8") (RDI %s)", cfm->name, ccm_seq,
532 ccm_mpid, ccm_interval, ccm_rdi ? "true" : "false");
535 if (rmp->seq && ccm_seq != (rmp->seq + 1)) {
536 VLOG_WARN_RL(&rl, "%s: (mpid %"PRIu64") detected sequence"
537 " numbers which indicate possible connectivity"
538 " problems (previous %"PRIu32") (current %"PRIu32
539 ")", cfm->name, ccm_mpid, rmp->seq, ccm_seq);
542 rmp->mpid = ccm_mpid;
546 rmp->opup = !ccm_opdown;
551 /* Gets the fault status of 'cfm'. Returns true when 'cfm' has detected
552 * connectivity problems, false otherwise. */
554 cfm_get_fault(const struct cfm *cfm)
556 if (cfm->fault_override >= 0) {
557 return cfm->fault_override;
562 /* Gets the operational state of 'cfm'. 'cfm' is considered operationally down
563 * if it has received a CCM with the operationally down bit set from any of its
564 * remote maintenance points. Returns true if 'cfm' is operationally up. False
567 cfm_get_opup(const struct cfm *cfm)
569 return cfm->remote_opup;
572 /* Populates 'rmps' with an array of remote maintenance points reachable by
573 * 'cfm'. The number of remote maintenance points is written to 'n_rmps'.
574 * 'cfm' retains ownership of the array written to 'rmps' */
576 cfm_get_remote_mpids(const struct cfm *cfm, const uint64_t **rmps,
579 *rmps = cfm->rmps_array;
580 *n_rmps = cfm->rmps_array_len;
584 cfm_find(const char *name)
588 HMAP_FOR_EACH_WITH_HASH (cfm, hmap_node, hash_string(name, 0), &all_cfms) {
589 if (!strcmp(cfm->name, name)) {
597 cfm_print_details(struct ds *ds, const struct cfm *cfm)
599 struct remote_mp *rmp;
601 ds_put_format(ds, "---- %s ----\n", cfm->name);
602 ds_put_format(ds, "MPID %"PRIu64":%s%s%s%s\n", cfm->mpid,
603 cfm->extended ? " extended" : "",
604 cfm_get_fault(cfm) ? " fault" : "",
605 cfm->fault_override >= 0 ? " fault_override" : "",
606 cfm->unexpected_recv ? " unexpected_recv" : "");
608 ds_put_format(ds, "\topstate: %s\n", cfm->opup ? "up" : "down");
609 ds_put_format(ds, "\tremote_opstate: %s\n",
610 cfm->remote_opup ? "up" : "down");
611 ds_put_format(ds, "\tinterval: %dms\n", cfm->ccm_interval_ms);
612 ds_put_format(ds, "\tnext CCM tx: %lldms\n",
613 timer_msecs_until_expired(&cfm->tx_timer));
614 ds_put_format(ds, "\tnext fault check: %lldms\n",
615 timer_msecs_until_expired(&cfm->fault_timer));
617 HMAP_FOR_EACH (rmp, node, &cfm->remote_mps) {
618 ds_put_format(ds, "Remote MPID %"PRIu64":%s\n",
620 rmp->rdi ? " rdi" : "");
621 ds_put_format(ds, "\trecv since check: %s\n",
622 rmp->recv ? "true" : "false");
623 ds_put_format(ds, "\topstate: %s\n", rmp->opup? "up" : "down");
628 cfm_unixctl_show(struct unixctl_conn *conn, int argc, const char *argv[],
629 void *aux OVS_UNUSED)
631 struct ds ds = DS_EMPTY_INITIALIZER;
632 const struct cfm *cfm;
635 cfm = cfm_find(argv[1]);
637 unixctl_command_reply(conn, 501, "no such CFM object");
640 cfm_print_details(&ds, cfm);
642 HMAP_FOR_EACH (cfm, hmap_node, &all_cfms) {
643 cfm_print_details(&ds, cfm);
647 unixctl_command_reply(conn, 200, ds_cstr(&ds));
652 cfm_unixctl_set_fault(struct unixctl_conn *conn, int argc, const char *argv[],
653 void *aux OVS_UNUSED)
655 const char *fault_str = argv[argc - 1];
659 if (!strcasecmp("true", fault_str)) {
661 } else if (!strcasecmp("false", fault_str)) {
663 } else if (!strcasecmp("normal", fault_str)) {
666 unixctl_command_reply(conn, 501, "unknown fault string");
671 cfm = cfm_find(argv[1]);
673 unixctl_command_reply(conn, 501, "no such CFM object");
676 cfm->fault_override = fault_override;
678 HMAP_FOR_EACH (cfm, hmap_node, &all_cfms) {
679 cfm->fault_override = fault_override;
683 unixctl_command_reply(conn, 200, "OK");