ovs-thread: Use fair (but nonrecursive) rwlocks on glibc.
[sliver-openvswitch.git] / lib / cfm.c
1 /*
2  * Copyright (c) 2010, 2011, 2012, 2013 Nicira, Inc.
3  *
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:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 #include <config.h>
18 #include "cfm.h"
19
20 #include <stdint.h>
21 #include <stdlib.h>
22 #include <string.h>
23
24 #include "byte-order.h"
25 #include "connectivity.h"
26 #include "dynamic-string.h"
27 #include "flow.h"
28 #include "hash.h"
29 #include "hmap.h"
30 #include "netdev.h"
31 #include "ofpbuf.h"
32 #include "packets.h"
33 #include "poll-loop.h"
34 #include "random.h"
35 #include "seq.h"
36 #include "timer.h"
37 #include "timeval.h"
38 #include "unixctl.h"
39 #include "vlog.h"
40
41 VLOG_DEFINE_THIS_MODULE(cfm);
42
43 #define CFM_MAX_RMPS 256
44
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
49 };
50
51 #define ETH_TYPE_CFM 0x8902
52
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.
56  *
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. */
60 #define CCM_LEN 75
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
66
67 OVS_PACKED(
68 struct ccm {
69     uint8_t mdlevel_version; /* MD Level and Version */
70     uint8_t opcode;
71     uint8_t flags;
72     uint8_t tlv_offset;
73     ovs_be32 seq;
74     ovs_be16 mpid;
75     uint8_t maid[CCM_MAID_LEN];
76
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. */
81     uint8_t zero[5];
82
83     /* TLV space. */
84     uint8_t end_tlv;
85 });
86 BUILD_ASSERT_DECL(CCM_LEN == sizeof(struct ccm));
87
88 struct cfm {
89     const char *name;           /* Name of this CFM object. */
90     struct hmap_node hmap_node; /* Node in all_cfms list. */
91
92     struct netdev *netdev;
93     uint64_t rx_packets;        /* Packets received by 'netdev'. */
94
95     uint64_t mpid;
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
100                                           receive. */
101     bool opup;             /* Operational State. */
102     bool remote_opup;      /* Remote Operational State. */
103
104     int fault_override;    /* Manual override of 'fault' status.
105                               Ignored if negative. */
106
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
111                               random. */
112     uint8_t ccm_pcp;       /* Priority of CCM PDUs. */
113     uint8_t maid[CCM_MAID_LEN]; /* The MAID of this CFM. */
114
115     struct timer tx_timer;    /* Send CCM when expired. */
116     struct timer fault_timer; /* Check for faults when expired. */
117
118     struct hmap remote_mps;   /* Remote MPs. */
119
120     /* Result of cfm_get_remote_mpids(). Updated only during fault check to
121      * avoid flapping. */
122     uint64_t *rmps_array;     /* Cache of remote_mps. */
123     size_t rmps_array_len;    /* Number of rmps in 'rmps_array'. */
124
125     int health;               /* Percentage of the number of CCM frames
126                                  received. */
127     int health_interval;      /* Number of fault_intervals since health was
128                                  recomputed. */
129     long long int last_tx;    /* Last CCM transmission time. */
130
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;
134
135     uint64_t flap_count;       /* Count the flaps since boot. */
136 };
137
138 /* Remote MPs represent foreign network entities that are configured to have
139  * the same MAID as this CFM instance. */
140 struct remote_mp {
141     uint64_t mpid;         /* The Maintenance Point ID of this 'remote_mp'. */
142     struct hmap_node node; /* Node in 'remote_mps' map. */
143
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. */
150
151 };
152
153 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(20, 30);
154
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__;
158
159 static unixctl_cb_func cfm_unixctl_show;
160 static unixctl_cb_func cfm_unixctl_set_fault;
161
162 static uint64_t
163 cfm_rx_packets(const struct cfm *cfm) OVS_REQUIRES(mutex)
164 {
165     struct netdev_stats stats;
166
167     if (!netdev_get_stats(cfm->netdev, &stats)) {
168         return stats.rx_packets;
169     } else {
170         return 0;
171     }
172 }
173
174 static const uint8_t *
175 cfm_ccm_addr(struct cfm *cfm)
176 {
177     bool extended;
178     atomic_read(&cfm->extended, &extended);
179     return extended ? eth_addr_ccm_x : eth_addr_ccm;
180 }
181
182 /* Returns the string representation of the given cfm_fault_reason 'reason'. */
183 const char *
184 cfm_fault_reason_to_str(int reason)
185 {
186     switch (reason) {
187 #define CFM_FAULT_REASON(NAME, STR) case CFM_FAULT_##NAME: return #STR;
188         CFM_FAULT_REASONS
189 #undef CFM_FAULT_REASON
190     default: return "<unknown>";
191     }
192 }
193
194 static void
195 ds_put_cfm_fault(struct ds *ds, int fault)
196 {
197     int i;
198
199     for (i = 0; i < CFM_FAULT_N_REASONS; i++) {
200         int reason = 1 << i;
201
202         if (fault & reason) {
203             ds_put_format(ds, "%s ", cfm_fault_reason_to_str(reason));
204         }
205     }
206
207     ds_chomp(ds, ' ');
208 }
209
210 static void
211 cfm_generate_maid(struct cfm *cfm) OVS_REQUIRES(mutex)
212 {
213     const char *ovs_md_name = "ovs";
214     const char *ovs_ma_name = "ovs";
215     uint8_t *ma_p;
216     size_t md_len, ma_len;
217
218     memset(cfm->maid, 0, CCM_MAID_LEN);
219
220     md_len = strlen(ovs_md_name);
221     ma_len = strlen(ovs_ma_name);
222
223     ovs_assert(md_len && ma_len && md_len + ma_len + 4 <= CCM_MAID_LEN);
224
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. */
228
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. */
233 }
234
235 static int
236 ccm_interval_to_ms(uint8_t interval)
237 {
238     switch (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. */
242     case 3:  return 100;
243     case 4:  return 1000;
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. */
248     }
249
250     OVS_NOT_REACHED();
251 }
252
253 static long long int
254 cfm_fault_interval(struct cfm *cfm) OVS_REQUIRES(mutex)
255 {
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.
261      *
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. */
266
267     return (MAX(cfm->ccm_interval_ms, cfm->demand ? 500 : cfm->ccm_interval_ms)
268             * 7) / 2;
269 }
270
271 static uint8_t
272 ms_to_ccm_interval(int interval_ms)
273 {
274     uint8_t i;
275
276     for (i = 7; i > 0; i--) {
277         if (ccm_interval_to_ms(i) <= interval_ms) {
278             return i;
279         }
280     }
281
282     return 1;
283 }
284
285 static uint32_t
286 hash_mpid(uint64_t mpid)
287 {
288     return hash_bytes(&mpid, sizeof mpid, 0);
289 }
290
291 static bool
292 cfm_is_valid_mpid(bool extended, uint64_t mpid)
293 {
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);
297 }
298
299 static struct remote_mp *
300 lookup_remote_mp(const struct cfm *cfm, uint64_t mpid) OVS_REQUIRES(mutex)
301 {
302     struct remote_mp *rmp;
303
304     HMAP_FOR_EACH_IN_BUCKET (rmp, node, hash_mpid(mpid), &cfm->remote_mps) {
305         if (rmp->mpid == mpid) {
306             return rmp;
307         }
308     }
309
310     return NULL;
311 }
312
313 void
314 cfm_init(void)
315 {
316     unixctl_command_register("cfm/show", "[interface]", 0, 1, cfm_unixctl_show,
317                              NULL);
318     unixctl_command_register("cfm/set-fault", "[interface] normal|false|true",
319                              1, 2, cfm_unixctl_set_fault, NULL);
320 }
321
322 /* Allocates a 'cfm' object called 'name'.  'cfm' should be initialized by
323  * cfm_configure() before use. */
324 struct cfm *
325 cfm_create(const struct netdev *netdev) OVS_EXCLUDED(mutex)
326 {
327     struct cfm *cfm;
328
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;
335     cfm->health = -1;
336     cfm->last_tx = 0;
337     cfm->flap_count = 0;
338     atomic_init(&cfm->extended, false);
339     atomic_init(&cfm->check_tnl_key, false);
340     ovs_refcount_init(&cfm->ref_cnt);
341
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);
346     return cfm;
347 }
348
349 void
350 cfm_unref(struct cfm *cfm) OVS_EXCLUDED(mutex)
351 {
352     struct remote_mp *rmp, *rmp_next;
353
354     if (!cfm) {
355         return;
356     }
357
358     if (ovs_refcount_unref(&cfm->ref_cnt) != 1) {
359         return;
360     }
361
362     ovs_mutex_lock(&mutex);
363     hmap_remove(all_cfms, &cfm->hmap_node);
364     ovs_mutex_unlock(&mutex);
365
366     HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &cfm->remote_mps) {
367         hmap_remove(&cfm->remote_mps, &rmp->node);
368         free(rmp);
369     }
370
371     hmap_destroy(&cfm->remote_mps);
372     netdev_close(cfm->netdev);
373     free(cfm->rmps_array);
374
375     atomic_destroy(&cfm->extended);
376     atomic_destroy(&cfm->check_tnl_key);
377     ovs_refcount_destroy(&cfm->ref_cnt);
378
379     free(cfm);
380 }
381
382 struct cfm *
383 cfm_ref(const struct cfm *cfm_)
384 {
385     struct cfm *cfm = CONST_CAST(struct cfm *, cfm_);
386     if (cfm) {
387         ovs_refcount_ref(&cfm->ref_cnt);
388     }
389     return cfm;
390 }
391
392 /* Should be run periodically to update fault statistics messages. */
393 void
394 cfm_run(struct cfm *cfm) OVS_EXCLUDED(mutex)
395 {
396     ovs_mutex_lock(&mutex);
397     if (timer_expired(&cfm->fault_timer)) {
398         long long int interval = cfm_fault_interval(cfm);
399         struct remote_mp *rmp, *rmp_next;
400         bool old_cfm_fault = cfm->fault;
401         bool old_rmp_opup = cfm->remote_opup;
402         bool demand_override;
403         bool rmp_set_opup = false;
404         bool rmp_set_opdown = false;
405
406         cfm->fault = cfm->recv_fault;
407         cfm->recv_fault = 0;
408
409         cfm->rmps_array_len = 0;
410         free(cfm->rmps_array);
411         cfm->rmps_array = xmalloc(hmap_count(&cfm->remote_mps) *
412                                   sizeof *cfm->rmps_array);
413
414         if (cfm->health_interval == CFM_HEALTH_INTERVAL) {
415             /* Calculate the cfm health of the interface.  If the number of
416              * remote_mpids of a cfm interface is > 1, the cfm health is
417              * undefined. If the number of remote_mpids is 1, the cfm health is
418              * the percentage of the ccm frames received in the
419              * (CFM_HEALTH_INTERVAL * 3.5)ms, else it is 0. */
420             if (hmap_count(&cfm->remote_mps) > 1) {
421                 cfm->health = -1;
422             } else if (hmap_is_empty(&cfm->remote_mps)) {
423                 cfm->health = 0;
424             } else {
425                 int exp_ccm_recvd;
426                 int old_health = cfm->health;
427
428                 rmp = CONTAINER_OF(hmap_first(&cfm->remote_mps),
429                                    struct remote_mp, node);
430                 exp_ccm_recvd = (CFM_HEALTH_INTERVAL * 7) / 2;
431                 /* Calculate the percentage of healthy ccm frames received.
432                  * Since the 'fault_interval' is (3.5 * cfm_interval), and
433                  * 1 CCM packet must be received every cfm_interval,
434                  * the 'remote_mpid' health reports the percentage of
435                  * healthy CCM frames received every
436                  * 'CFM_HEALTH_INTERVAL'th 'fault_interval'. */
437                 cfm->health = (rmp->num_health_ccm * 100) / exp_ccm_recvd;
438                 cfm->health = MIN(cfm->health, 100);
439                 rmp->num_health_ccm = 0;
440                 ovs_assert(cfm->health >= 0 && cfm->health <= 100);
441
442                 if (cfm->health != old_health) {
443                     seq_change(connectivity_seq_get());
444                 }
445             }
446             cfm->health_interval = 0;
447         }
448         cfm->health_interval++;
449
450         demand_override = false;
451         if (cfm->demand) {
452             uint64_t rx_packets = cfm_rx_packets(cfm);
453             demand_override = hmap_count(&cfm->remote_mps) == 1
454                 && rx_packets > cfm->rx_packets;
455             cfm->rx_packets = rx_packets;
456         }
457
458         HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &cfm->remote_mps) {
459             if (!rmp->recv) {
460                 VLOG_INFO("%s: Received no CCM from RMP %"PRIu64" in the last"
461                           " %lldms", cfm->name, rmp->mpid,
462                           time_msec() - rmp->last_rx);
463                 if (!demand_override) {
464                     hmap_remove(&cfm->remote_mps, &rmp->node);
465                     free(rmp);
466                 }
467             } else {
468                 rmp->recv = false;
469
470                 if (rmp->opup) {
471                     rmp_set_opup = true;
472                 } else {
473                     rmp_set_opdown = true;
474                 }
475
476                 cfm->rmps_array[cfm->rmps_array_len++] = rmp->mpid;
477             }
478         }
479
480         if (rmp_set_opdown) {
481             cfm->remote_opup = false;
482         }
483         else if (rmp_set_opup) {
484             cfm->remote_opup = true;
485         }
486
487         if (old_rmp_opup != cfm->remote_opup) {
488             seq_change(connectivity_seq_get());
489         }
490
491         if (hmap_is_empty(&cfm->remote_mps)) {
492             cfm->fault |= CFM_FAULT_RECV;
493         }
494
495         if (old_cfm_fault != cfm->fault) {
496             if (!VLOG_DROP_INFO(&rl)) {
497                 struct ds ds = DS_EMPTY_INITIALIZER;
498
499                 ds_put_cstr(&ds, "from [");
500                 ds_put_cfm_fault(&ds, old_cfm_fault);
501                 ds_put_cstr(&ds, "] to [");
502                 ds_put_cfm_fault(&ds, cfm->fault);
503                 ds_put_char(&ds, ']');
504                 VLOG_INFO("%s: CFM faults changed %s.", cfm->name, ds_cstr(&ds));
505                 ds_destroy(&ds);
506             }
507
508             /* If there is a flap, increments the counter. */
509             if (old_cfm_fault == false || cfm->fault == false) {
510                 cfm->flap_count++;
511             }
512
513             seq_change(connectivity_seq_get());
514         }
515
516         cfm->booted = true;
517         timer_set_duration(&cfm->fault_timer, interval);
518         VLOG_DBG("%s: new fault interval", cfm->name);
519     }
520     ovs_mutex_unlock(&mutex);
521 }
522
523 /* Should be run periodically to check if the CFM module has a CCM message it
524  * wishes to send. */
525 bool
526 cfm_should_send_ccm(struct cfm *cfm) OVS_EXCLUDED(mutex)
527 {
528     bool ret;
529
530     ovs_mutex_lock(&mutex);
531     ret = timer_expired(&cfm->tx_timer);
532     ovs_mutex_unlock(&mutex);
533     return ret;
534 }
535
536 /* Composes a CCM message into 'packet'.  Messages generated with this function
537  * should be sent whenever cfm_should_send_ccm() indicates. */
538 void
539 cfm_compose_ccm(struct cfm *cfm, struct ofpbuf *packet,
540                 uint8_t eth_src[ETH_ADDR_LEN]) OVS_EXCLUDED(mutex)
541 {
542     uint16_t ccm_vlan;
543     struct ccm *ccm;
544     bool extended;
545
546     ovs_mutex_lock(&mutex);
547     timer_set_duration(&cfm->tx_timer, cfm->ccm_interval_ms);
548     eth_compose(packet, cfm_ccm_addr(cfm), eth_src, ETH_TYPE_CFM, sizeof *ccm);
549
550     ccm_vlan = (cfm->ccm_vlan != CFM_RANDOM_VLAN
551                 ? cfm->ccm_vlan
552                 : random_uint16());
553     ccm_vlan = ccm_vlan & VLAN_VID_MASK;
554
555     if (ccm_vlan || cfm->ccm_pcp) {
556         uint16_t tci = ccm_vlan | (cfm->ccm_pcp << VLAN_PCP_SHIFT);
557         eth_push_vlan(packet, htons(ETH_TYPE_VLAN), htons(tci));
558     }
559
560     ccm = packet->l3;
561     ccm->mdlevel_version = 0;
562     ccm->opcode = CCM_OPCODE;
563     ccm->tlv_offset = 70;
564     ccm->seq = htonl(++cfm->seq);
565     ccm->flags = cfm->ccm_interval;
566     memcpy(ccm->maid, cfm->maid, sizeof ccm->maid);
567     memset(ccm->zero, 0, sizeof ccm->zero);
568     ccm->end_tlv = 0;
569
570     atomic_read(&cfm->extended, &extended);
571     if (extended) {
572         ccm->mpid = htons(hash_mpid(cfm->mpid));
573         ccm->mpid64 = htonll(cfm->mpid);
574         ccm->opdown = !cfm->opup;
575     } else {
576         ccm->mpid = htons(cfm->mpid);
577         ccm->mpid64 = htonll(0);
578         ccm->opdown = 0;
579     }
580
581     if (cfm->ccm_interval == 0) {
582         ovs_assert(extended);
583         ccm->interval_ms_x = htons(cfm->ccm_interval_ms);
584     } else {
585         ccm->interval_ms_x = htons(0);
586     }
587
588     if (cfm->booted && hmap_is_empty(&cfm->remote_mps)) {
589         ccm->flags |= CCM_RDI_MASK;
590     }
591
592     if (cfm->last_tx) {
593         long long int delay = time_msec() - cfm->last_tx;
594         if (delay > (cfm->ccm_interval_ms * 3 / 2)) {
595             VLOG_WARN("%s: long delay of %lldms (expected %dms) sending CCM"
596                       " seq %"PRIu32, cfm->name, delay, cfm->ccm_interval_ms,
597                       cfm->seq);
598         }
599     }
600     cfm->last_tx = time_msec();
601     ovs_mutex_unlock(&mutex);
602 }
603
604 void
605 cfm_wait(struct cfm *cfm) OVS_EXCLUDED(mutex)
606 {
607     poll_timer_wait_until(cfm_wake_time(cfm));
608 }
609
610
611 /* Returns the next cfm wakeup time. */
612 long long int
613 cfm_wake_time(struct cfm *cfm) OVS_EXCLUDED(mutex)
614 {
615     long long int retval;
616
617     if (!cfm) {
618         return LLONG_MAX;
619     }
620
621     ovs_mutex_lock(&mutex);
622     retval = MIN(cfm->tx_timer.t, cfm->fault_timer.t);
623     ovs_mutex_unlock(&mutex);
624     return retval;
625 }
626
627
628 /* Configures 'cfm' with settings from 's'. */
629 bool
630 cfm_configure(struct cfm *cfm, const struct cfm_settings *s)
631     OVS_EXCLUDED(mutex)
632 {
633     uint8_t interval;
634     int interval_ms;
635
636     if (!cfm_is_valid_mpid(s->extended, s->mpid) || s->interval <= 0) {
637         return false;
638     }
639
640     ovs_mutex_lock(&mutex);
641     cfm->mpid = s->mpid;
642     cfm->opup = s->opup;
643     interval = ms_to_ccm_interval(s->interval);
644     interval_ms = ccm_interval_to_ms(interval);
645
646     atomic_store(&cfm->check_tnl_key, s->check_tnl_key);
647     atomic_store(&cfm->extended, s->extended);
648
649     cfm->ccm_vlan = s->ccm_vlan;
650     cfm->ccm_pcp = s->ccm_pcp & (VLAN_PCP_MASK >> VLAN_PCP_SHIFT);
651     if (s->extended && interval_ms != s->interval) {
652         interval = 0;
653         interval_ms = MIN(s->interval, UINT16_MAX);
654     }
655
656     if (s->extended && s->demand) {
657         if (!cfm->demand) {
658             cfm->demand = true;
659             cfm->rx_packets = cfm_rx_packets(cfm);
660         }
661     } else {
662         cfm->demand = false;
663     }
664
665     if (interval != cfm->ccm_interval || interval_ms != cfm->ccm_interval_ms) {
666         cfm->ccm_interval = interval;
667         cfm->ccm_interval_ms = interval_ms;
668
669         timer_set_expired(&cfm->tx_timer);
670         timer_set_duration(&cfm->fault_timer, cfm_fault_interval(cfm));
671     }
672
673     ovs_mutex_unlock(&mutex);
674     return true;
675 }
676
677 /* Must be called when the netdev owned by 'cfm' should change. */
678 void
679 cfm_set_netdev(struct cfm *cfm, const struct netdev *netdev)
680     OVS_EXCLUDED(mutex)
681 {
682     ovs_mutex_lock(&mutex);
683     if (cfm->netdev != netdev) {
684         netdev_close(cfm->netdev);
685         cfm->netdev = netdev_ref(netdev);
686     }
687     ovs_mutex_unlock(&mutex);
688 }
689
690 /* Returns true if 'cfm' should process packets from 'flow'.  Sets
691  * fields in 'wc' that were used to make the determination. */
692 bool
693 cfm_should_process_flow(const struct cfm *cfm_, const struct flow *flow,
694                         struct flow_wildcards *wc)
695 {
696     struct cfm *cfm = CONST_CAST(struct cfm *, cfm_);
697     bool check_tnl_key;
698
699     atomic_read(&cfm->check_tnl_key, &check_tnl_key);
700     memset(&wc->masks.dl_dst, 0xff, sizeof wc->masks.dl_dst);
701     if (check_tnl_key) {
702         memset(&wc->masks.tunnel.tun_id, 0xff, sizeof wc->masks.tunnel.tun_id);
703     }
704     return (ntohs(flow->dl_type) == ETH_TYPE_CFM
705             && eth_addr_equals(flow->dl_dst, cfm_ccm_addr(cfm))
706             && (!check_tnl_key || flow->tunnel.tun_id == htonll(0)));
707 }
708
709 /* Updates internal statistics relevant to packet 'p'.  Should be called on
710  * every packet whose flow returned true when passed to
711  * cfm_should_process_flow. */
712 void
713 cfm_process_heartbeat(struct cfm *cfm, const struct ofpbuf *p)
714     OVS_EXCLUDED(mutex)
715 {
716     struct ccm *ccm;
717     struct eth_header *eth;
718
719     ovs_mutex_lock(&mutex);
720
721     eth = p->l2;
722     ccm = ofpbuf_at(p, (uint8_t *)p->l3 - (uint8_t *)p->data, CCM_ACCEPT_LEN);
723
724     if (!ccm) {
725         VLOG_INFO_RL(&rl, "%s: Received an unparseable 802.1ag CCM heartbeat.",
726                      cfm->name);
727         goto out;
728     }
729
730     if (ccm->opcode != CCM_OPCODE) {
731         VLOG_INFO_RL(&rl, "%s: Received an unsupported 802.1ag message. "
732                      "(opcode %u)", cfm->name, ccm->opcode);
733         goto out;
734     }
735
736     /* According to the 802.1ag specification, reception of a CCM with an
737      * incorrect ccm_interval, unexpected MAID, or unexpected MPID should
738      * trigger a fault.  We ignore this requirement for several reasons.
739      *
740      * Faults can cause a controller or Open vSwitch to make potentially
741      * expensive changes to the network topology.  It seems prudent to trigger
742      * them judiciously, especially when CFM is used to check slave status of
743      * bonds. Furthermore, faults can be maliciously triggered by crafting
744      * unexpected CCMs. */
745     if (memcmp(ccm->maid, cfm->maid, sizeof ccm->maid)) {
746         cfm->recv_fault |= CFM_FAULT_MAID;
747         VLOG_WARN_RL(&rl, "%s: Received unexpected remote MAID from MAC "
748                      ETH_ADDR_FMT, cfm->name, ETH_ADDR_ARGS(eth->eth_src));
749     } else {
750         uint8_t ccm_interval = ccm->flags & 0x7;
751         bool ccm_rdi = ccm->flags & CCM_RDI_MASK;
752         uint16_t ccm_interval_ms_x = ntohs(ccm->interval_ms_x);
753
754         struct remote_mp *rmp;
755         uint64_t ccm_mpid;
756         uint32_t ccm_seq;
757         bool ccm_opdown;
758         bool extended;
759         enum cfm_fault_reason cfm_fault = 0;
760
761         atomic_read(&cfm->extended, &extended);
762         if (extended) {
763             ccm_mpid = ntohll(ccm->mpid64);
764             ccm_opdown = ccm->opdown;
765         } else {
766             ccm_mpid = ntohs(ccm->mpid);
767             ccm_opdown = false;
768         }
769         ccm_seq = ntohl(ccm->seq);
770
771         if (ccm_interval != cfm->ccm_interval) {
772             VLOG_WARN_RL(&rl, "%s: received a CCM with an unexpected interval"
773                          " (%"PRIu8") from RMP %"PRIu64, cfm->name,
774                          ccm_interval, ccm_mpid);
775         }
776
777         if (extended && ccm_interval == 0
778             && ccm_interval_ms_x != cfm->ccm_interval_ms) {
779             VLOG_WARN_RL(&rl, "%s: received a CCM with an unexpected extended"
780                          " interval (%"PRIu16"ms) from RMP %"PRIu64, cfm->name,
781                          ccm_interval_ms_x, ccm_mpid);
782         }
783
784         rmp = lookup_remote_mp(cfm, ccm_mpid);
785         if (!rmp) {
786             if (hmap_count(&cfm->remote_mps) < CFM_MAX_RMPS) {
787                 rmp = xzalloc(sizeof *rmp);
788                 hmap_insert(&cfm->remote_mps, &rmp->node, hash_mpid(ccm_mpid));
789             } else {
790                 cfm_fault |= CFM_FAULT_OVERFLOW;
791                 VLOG_WARN_RL(&rl,
792                              "%s: dropped CCM with MPID %"PRIu64" from MAC "
793                              ETH_ADDR_FMT, cfm->name, ccm_mpid,
794                              ETH_ADDR_ARGS(eth->eth_src));
795             }
796         }
797
798         if (ccm_rdi) {
799             cfm_fault |= CFM_FAULT_RDI;
800             VLOG_DBG("%s: RDI bit flagged from RMP %"PRIu64, cfm->name,
801                      ccm_mpid);
802         }
803
804         VLOG_DBG("%s: received CCM (seq %"PRIu32") (mpid %"PRIu64")"
805                  " (interval %"PRIu8") (RDI %s)", cfm->name, ccm_seq,
806                  ccm_mpid, ccm_interval, ccm_rdi ? "true" : "false");
807
808         if (rmp) {
809             if (rmp->mpid == cfm->mpid) {
810                 cfm_fault |= CFM_FAULT_LOOPBACK;
811                 VLOG_WARN_RL(&rl,"%s: received CCM with local MPID"
812                              " %"PRIu64, cfm->name, rmp->mpid);
813             }
814
815             if (rmp->seq && ccm_seq != (rmp->seq + 1)) {
816                 VLOG_WARN_RL(&rl, "%s: (mpid %"PRIu64") detected sequence"
817                              " numbers which indicate possible connectivity"
818                              " problems (previous %"PRIu32") (current %"PRIu32
819                              ")", cfm->name, ccm_mpid, rmp->seq, ccm_seq);
820             }
821
822             rmp->mpid = ccm_mpid;
823             if (!cfm_fault) {
824                 rmp->num_health_ccm++;
825             }
826             rmp->recv = true;
827             cfm->recv_fault |= cfm_fault;
828             rmp->seq = ccm_seq;
829             rmp->opup = !ccm_opdown;
830             rmp->last_rx = time_msec();
831         }
832     }
833
834 out:
835     ovs_mutex_unlock(&mutex);
836 }
837
838 static int
839 cfm_get_fault__(const struct cfm *cfm) OVS_REQUIRES(mutex)
840 {
841     if (cfm->fault_override >= 0) {
842         return cfm->fault_override ? CFM_FAULT_OVERRIDE : 0;
843     }
844     return cfm->fault;
845 }
846
847 /* Gets the fault status of 'cfm'.  Returns a bit mask of 'cfm_fault_reason's
848  * indicating the cause of the connectivity fault, or zero if there is no
849  * fault. */
850 int
851 cfm_get_fault(const struct cfm *cfm) OVS_EXCLUDED(mutex)
852 {
853     int fault;
854
855     ovs_mutex_lock(&mutex);
856     fault = cfm_get_fault__(cfm);
857     ovs_mutex_unlock(&mutex);
858     return fault;
859 }
860
861 /* Gets the number of cfm fault flapping since start. */
862 uint64_t
863 cfm_get_flap_count(const struct cfm *cfm) OVS_EXCLUDED(mutex)
864 {
865     uint64_t flap_count;
866     ovs_mutex_lock(&mutex);
867     flap_count = cfm->flap_count;
868     ovs_mutex_unlock(&mutex);
869     return flap_count;
870 }
871
872 /* Gets the health of 'cfm'.  Returns an integer between 0 and 100 indicating
873  * the health of the link as a percentage of ccm frames received in
874  * CFM_HEALTH_INTERVAL * 'fault_interval' if there is only 1 remote_mpid,
875  * returns 0 if there are no remote_mpids, and returns -1 if there are more
876  * than 1 remote_mpids. */
877 int
878 cfm_get_health(const struct cfm *cfm) OVS_EXCLUDED(mutex)
879 {
880     int health;
881
882     ovs_mutex_lock(&mutex);
883     health = cfm->health;
884     ovs_mutex_unlock(&mutex);
885     return health;
886 }
887
888 /* Gets the operational state of 'cfm'.  'cfm' is considered operationally down
889  * if it has received a CCM with the operationally down bit set from any of its
890  * remote maintenance points. Returns 1 if 'cfm' is operationally up, 0 if
891  * 'cfm' is operationally down, or -1 if 'cfm' has no operational state
892  * (because it isn't in extended mode). */
893 int
894 cfm_get_opup(const struct cfm *cfm_) OVS_EXCLUDED(mutex)
895 {
896     struct cfm *cfm = CONST_CAST(struct cfm *, cfm_);
897     bool extended;
898     int opup;
899
900     ovs_mutex_lock(&mutex);
901     atomic_read(&cfm->extended, &extended);
902     opup = extended ? cfm->remote_opup : -1;
903     ovs_mutex_unlock(&mutex);
904
905     return opup;
906 }
907
908 /* Populates 'rmps' with an array of remote maintenance points reachable by
909  * 'cfm'. The number of remote maintenance points is written to 'n_rmps'.
910  * 'cfm' retains ownership of the array written to 'rmps' */
911 void
912 cfm_get_remote_mpids(const struct cfm *cfm, uint64_t **rmps, size_t *n_rmps)
913     OVS_EXCLUDED(mutex)
914 {
915     ovs_mutex_lock(&mutex);
916     *rmps = xmemdup(cfm->rmps_array, cfm->rmps_array_len * sizeof **rmps);
917     *n_rmps = cfm->rmps_array_len;
918     ovs_mutex_unlock(&mutex);
919 }
920
921 static struct cfm *
922 cfm_find(const char *name) OVS_REQUIRES(mutex)
923 {
924     struct cfm *cfm;
925
926     HMAP_FOR_EACH_WITH_HASH (cfm, hmap_node, hash_string(name, 0), all_cfms) {
927         if (!strcmp(cfm->name, name)) {
928             return cfm;
929         }
930     }
931     return NULL;
932 }
933
934 static void
935 cfm_print_details(struct ds *ds, struct cfm *cfm) OVS_REQUIRES(mutex)
936 {
937     struct remote_mp *rmp;
938     bool extended;
939     int fault;
940
941     atomic_read(&cfm->extended, &extended);
942
943     ds_put_format(ds, "---- %s ----\n", cfm->name);
944     ds_put_format(ds, "MPID %"PRIu64":%s%s\n", cfm->mpid,
945                   extended ? " extended" : "",
946                   cfm->fault_override >= 0 ? " fault_override" : "");
947
948     fault = cfm_get_fault__(cfm);
949     if (fault) {
950         ds_put_cstr(ds, "\tfault: ");
951         ds_put_cfm_fault(ds, fault);
952         ds_put_cstr(ds, "\n");
953     }
954
955     if (cfm->health == -1) {
956         ds_put_format(ds, "\taverage health: undefined\n");
957     } else {
958         ds_put_format(ds, "\taverage health: %d\n", cfm->health);
959     }
960     ds_put_format(ds, "\topstate: %s\n", cfm->opup ? "up" : "down");
961     ds_put_format(ds, "\tremote_opstate: %s\n",
962                   cfm->remote_opup ? "up" : "down");
963     ds_put_format(ds, "\tinterval: %dms\n", cfm->ccm_interval_ms);
964     ds_put_format(ds, "\tnext CCM tx: %lldms\n",
965                   timer_msecs_until_expired(&cfm->tx_timer));
966     ds_put_format(ds, "\tnext fault check: %lldms\n",
967                   timer_msecs_until_expired(&cfm->fault_timer));
968
969     HMAP_FOR_EACH (rmp, node, &cfm->remote_mps) {
970         ds_put_format(ds, "Remote MPID %"PRIu64"\n", rmp->mpid);
971         ds_put_format(ds, "\trecv since check: %s\n",
972                       rmp->recv ? "true" : "false");
973         ds_put_format(ds, "\topstate: %s\n", rmp->opup? "up" : "down");
974     }
975 }
976
977 static void
978 cfm_unixctl_show(struct unixctl_conn *conn, int argc, const char *argv[],
979                  void *aux OVS_UNUSED) OVS_EXCLUDED(mutex)
980 {
981     struct ds ds = DS_EMPTY_INITIALIZER;
982     struct cfm *cfm;
983
984     ovs_mutex_lock(&mutex);
985     if (argc > 1) {
986         cfm = cfm_find(argv[1]);
987         if (!cfm) {
988             unixctl_command_reply_error(conn, "no such CFM object");
989             goto out;
990         }
991         cfm_print_details(&ds, cfm);
992     } else {
993         HMAP_FOR_EACH (cfm, hmap_node, all_cfms) {
994             cfm_print_details(&ds, cfm);
995         }
996     }
997
998     unixctl_command_reply(conn, ds_cstr(&ds));
999     ds_destroy(&ds);
1000 out:
1001     ovs_mutex_unlock(&mutex);
1002 }
1003
1004 static void
1005 cfm_unixctl_set_fault(struct unixctl_conn *conn, int argc, const char *argv[],
1006                       void *aux OVS_UNUSED) OVS_EXCLUDED(mutex)
1007 {
1008     const char *fault_str = argv[argc - 1];
1009     int fault_override;
1010     struct cfm *cfm;
1011
1012     ovs_mutex_lock(&mutex);
1013     if (!strcasecmp("true", fault_str)) {
1014         fault_override = 1;
1015     } else if (!strcasecmp("false", fault_str)) {
1016         fault_override = 0;
1017     } else if (!strcasecmp("normal", fault_str)) {
1018         fault_override = -1;
1019     } else {
1020         unixctl_command_reply_error(conn, "unknown fault string");
1021         goto out;
1022     }
1023
1024     if (argc > 2) {
1025         cfm = cfm_find(argv[1]);
1026         if (!cfm) {
1027             unixctl_command_reply_error(conn, "no such CFM object");
1028             goto out;
1029         }
1030         cfm->fault_override = fault_override;
1031     } else {
1032         HMAP_FOR_EACH (cfm, hmap_node, all_cfms) {
1033             cfm->fault_override = fault_override;
1034         }
1035     }
1036
1037     seq_change(connectivity_seq_get());
1038     unixctl_command_reply(conn, "OK");
1039
1040 out:
1041     ovs_mutex_unlock(&mutex);
1042 }