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.
29 #include "poll-loop.h"
33 VLOG_DEFINE_THIS_MODULE(cfm);
35 #define CCM_OPCODE 1 /* CFM message opcode meaning CCM. */
39 uint32_t seq; /* The sequence number of our last CCM. */
41 uint8_t ccm_interval; /* The CCM transmission interval. */
42 int ccm_interval_ms; /* 'ccm_interval' in milliseconds. */
44 long long ccm_sent; /* The time we last sent a CCM. */
45 long long fault_check; /* The time we last checked for faults. */
47 struct hmap x_remote_mps; /* Unexpected remote MPs. */
48 struct hmap x_remote_maids; /* Unexpected remote MAIDs. */
52 ccm_interval_to_ms(uint8_t interval)
55 case 0: NOT_REACHED(); /* Explicitly not supported by 802.1ag. */
56 case 1: return 3; /* Not recommended due to timer resolution. */
57 case 2: return 10; /* Not recommended due to timer resolution. */
62 case 7: return 600000;
63 default: NOT_REACHED(); /* Explicitly not supported by 802.1ag. */
70 ms_to_ccm_interval(int interval_ms)
74 for (i = 7; i > 0; i--) {
75 if (ccm_interval_to_ms(i) <= interval_ms) {
83 static struct cfm_internal *
84 cfm_to_internal(struct cfm *cfm)
86 return CONTAINER_OF(cfm, struct cfm_internal, cfm);
90 hash_mpid(uint8_t mpid)
92 return hash_int(mpid, 0);
96 cfm_is_valid_mpid(uint32_t mpid)
98 /* 802.1ag specification requires MPIDs to be within the range [1, 8191] */
99 return mpid >= 1 && mpid <= 8191;
102 static struct remote_mp *
103 lookup_remote_mp(const struct hmap *hmap, uint16_t mpid)
105 struct remote_mp *rmp;
107 HMAP_FOR_EACH_IN_BUCKET (rmp, node, hash_mpid(mpid), hmap) {
108 if (rmp->mpid == mpid) {
116 static struct remote_maid *
117 lookup_remote_maid(const struct hmap *hmap, uint8_t maid[CCM_MAID_LEN])
120 struct remote_maid *rmaid;
122 hash = hash_bytes(maid, CCM_MAID_LEN, 0);
123 HMAP_FOR_EACH_WITH_HASH (rmaid, node, hash, hmap) {
124 if (memcmp(rmaid->maid, maid, CCM_MAID_LEN) == 0) {
131 /* Allocates a 'cfm' object. This object should have its 'mpid', 'maid',
132 * 'eth_src', and 'interval' filled out. When changes are made to the 'cfm'
133 * object, cfm_configure should be called before using it. */
138 struct cfm_internal *cfmi;
140 cfmi = xzalloc(sizeof *cfmi);
143 hmap_init(&cfm->remote_mps);
144 hmap_init(&cfmi->x_remote_mps);
145 hmap_init(&cfmi->x_remote_maids);
150 cfm_destroy(struct cfm *cfm)
152 struct cfm_internal *cfmi = cfm_to_internal(cfm);
153 struct remote_mp *rmp, *rmp_next;
154 struct remote_maid *rmaid, *rmaid_next;
160 HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &cfm->remote_mps) {
161 hmap_remove(&cfm->remote_mps, &rmp->node);
165 HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &cfmi->x_remote_mps) {
166 hmap_remove(&cfmi->x_remote_mps, &rmp->node);
170 HMAP_FOR_EACH_SAFE (rmaid, rmaid_next, node, &cfmi->x_remote_maids) {
171 hmap_remove(&cfmi->x_remote_maids, &rmaid->node);
175 hmap_destroy(&cfm->remote_mps);
176 hmap_destroy(&cfmi->x_remote_mps);
177 hmap_destroy(&cfmi->x_remote_maids);
181 /* Should be run periodically to update fault statistics messages. */
183 cfm_run(struct cfm *cfm)
185 long long now = time_msec();
186 struct cfm_internal *cfmi = cfm_to_internal(cfm);
188 /* According to the 802.1ag specification we should assume every other MP
189 * with the same MAID has the same transmission interval that we have. If
190 * an MP has a different interval, cfm_process_heartbeat will register it
191 * as a fault (likely due to a configuration error). Thus we can check all
192 * MPs at once making this quite a bit simpler.
194 * According to the specification we should check when (ccm_interval_ms *
195 * 3.5)ms have passed. */
196 if (now >= cfmi->fault_check + (cfmi->ccm_interval_ms * 7) / 2) {
198 struct remote_mp *rmp, *rmp_next;
199 struct remote_maid *rmaid, *rmaid_next;
203 HMAP_FOR_EACH (rmp, node, &cfm->remote_mps) {
204 rmp->fault = rmp->fault || cfmi->fault_check > rmp->recv_time;
205 fault = rmp->fault || fault;
208 HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &cfmi->x_remote_mps) {
209 if (cfmi->fault_check > rmp->recv_time) {
210 hmap_remove(&cfmi->x_remote_mps, &rmp->node);
215 HMAP_FOR_EACH_SAFE (rmaid, rmaid_next, node, &cfmi->x_remote_maids) {
216 if (cfmi->fault_check > rmaid->recv_time) {
217 hmap_remove(&cfmi->x_remote_maids, &rmaid->node);
222 fault = (fault || !hmap_is_empty(&cfmi->x_remote_mps)
223 || !hmap_is_empty(&cfmi->x_remote_maids));
226 cfmi->fault_check = now;
230 /* Should be run periodically to check if the CFM module has a CCM message it
233 cfm_should_send_ccm(struct cfm *cfm)
235 struct cfm_internal *cfmi = cfm_to_internal(cfm);
237 return time_msec() >= cfmi->ccm_sent + cfmi->ccm_interval_ms;
240 /* Composes a CCM message into 'ccm'. Messages generated with this function
241 * should be sent whenever cfm_should_send_ccm() indicates. */
243 cfm_compose_ccm(struct cfm *cfm, struct ccm *ccm)
245 struct cfm_internal *cfmi = cfm_to_internal(cfm);
247 cfmi->ccm_sent = time_msec();
249 ccm->mdlevel_version = 0;
250 ccm->opcode = CCM_OPCODE;
251 ccm->tlv_offset = 70;
252 ccm->seq = htonl(++cfmi->seq);
253 ccm->mpid = htons(cfmi->cfm.mpid);
254 ccm->flags = cfmi->ccm_interval;
255 memcpy(ccm->maid, cfmi->cfm.maid, sizeof ccm->maid);
259 cfm_wait(struct cfm *cfm)
262 struct cfm_internal *cfmi = cfm_to_internal(cfm);
264 wait = MIN(cfmi->ccm_sent + cfmi->ccm_interval_ms,
265 cfmi->fault_check + cfmi->ccm_interval_ms * 4);
266 poll_timer_wait_until(wait);
269 /* Should be called whenever a client of the cfm library changes the internals
270 * of 'cfm'. Returns true if 'cfm' is valid. */
272 cfm_configure(struct cfm *cfm)
274 struct cfm_internal *cfmi;
276 if (!cfm_is_valid_mpid(cfm->mpid) || !cfm->interval) {
280 cfmi = cfm_to_internal(cfm);
281 cfmi->ccm_interval = ms_to_ccm_interval(cfm->interval);
282 cfmi->ccm_interval_ms = ccm_interval_to_ms(cfmi->ccm_interval);
284 /* Force a resend and check in case anything changed. */
286 cfmi->fault_check = 0;
290 /* Given an array of MPIDs, updates the 'remote_mps' map of 'cfm' to reflect
291 * it. Invalid MPIDs are skipped. */
293 cfm_update_remote_mps(struct cfm *cfm, const uint16_t *mpids, size_t n_mpids)
295 struct cfm_internal *cfmi = cfm_to_internal(cfm);
297 struct hmap new_rmps;
298 struct remote_mp *rmp, *rmp_next;
300 hmap_init(&new_rmps);
302 for (i = 0; i < n_mpids; i++) {
303 uint16_t mpid = mpids[i];
305 if (!cfm_is_valid_mpid(mpid)
306 || lookup_remote_mp(&new_rmps, mpid)) {
310 if ((rmp = lookup_remote_mp(&cfm->remote_mps, mpid))) {
311 hmap_remove(&cfm->remote_mps, &rmp->node);
312 } else if ((rmp = lookup_remote_mp(&cfmi->x_remote_mps, mpid))) {
313 hmap_remove(&cfmi->x_remote_mps, &rmp->node);
315 rmp = xzalloc(sizeof *rmp);
319 hmap_insert(&new_rmps, &rmp->node, hash_mpid(mpid));
322 hmap_swap(&new_rmps, &cfm->remote_mps);
324 HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &new_rmps) {
325 hmap_remove(&new_rmps, &rmp->node);
329 hmap_destroy(&new_rmps);
332 /* Finds a 'remote_mp' with 'mpid' in 'cfm'. If no such 'remote_mp' exists
334 const struct remote_mp *
335 cfm_get_remote_mp(const struct cfm *cfm, uint16_t mpid)
337 return lookup_remote_mp(&cfm->remote_mps, mpid);
340 /* Generates 'maid' from 'md_name' and 'ma_name'. A NULL parameter indicates
341 * the default should be used. Returns false if unsuccessful. */
343 cfm_generate_maid(const char *md_name, const char *ma_name,
344 uint8_t maid[CCM_MAID_LEN])
347 size_t md_len, ma_len;
357 memset(maid, 0, CCM_MAID_LEN);
359 md_len = strlen(md_name);
360 ma_len = strlen(ma_name);
362 if (!md_len || !ma_len || md_len + ma_len + 4 > CCM_MAID_LEN) {
366 maid[0] = 4; /* MD name string format. */
367 maid[1] = md_len; /* MD name size. */
368 memcpy(&maid[2], md_name, md_len); /* MD name. */
370 ma_p = maid + 2 + md_len;
371 ma_p[0] = 2; /* MA name string format. */
372 ma_p[1] = ma_len; /* MA name size. */
373 memcpy(&ma_p[2], ma_name, ma_len); /* MA name. */
377 /* Returns true if the CFM library should process packets from 'flow'. */
379 cfm_should_process_flow(const struct flow *flow)
381 return (ntohs(flow->dl_type) == ETH_TYPE_CFM
382 && eth_addr_equals(flow->dl_dst, eth_addr_ccm));
385 /* Updates internal statistics relevant to packet 'p'. Should be called on
386 * every packet whose flow returned true when passed to
387 * cfm_should_process_flow. */
389 cfm_process_heartbeat(struct cfm *cfm, const struct ofpbuf *p)
394 uint8_t ccm_interval;
395 struct remote_mp *rmp;
397 struct cfm_internal *cfmi = cfm_to_internal(cfm);
398 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
400 ccm = ofpbuf_at(p, (uint8_t *)p->l3 - (uint8_t *)p->data, CCM_LEN);
403 VLOG_INFO_RL(&rl, "Received an un-parseable 802.1ag CCM heartbeat.");
407 if (ccm->opcode != CCM_OPCODE) {
408 VLOG_INFO_RL(&rl, "Received an unsupported 802.1ag message. "
409 "(opcode %u)", ccm->opcode);
413 if (memcmp(ccm->maid, cfm->maid, sizeof ccm->maid)) {
414 struct remote_maid *rmaid;
416 rmaid = lookup_remote_maid(&cfmi->x_remote_maids, ccm->maid);
418 rmaid->recv_time = time_msec();
420 rmaid = xzalloc(sizeof *rmaid);
421 rmaid->recv_time = time_msec();
422 memcpy(rmaid->maid, ccm->maid, sizeof rmaid->maid);
423 hmap_insert(&cfmi->x_remote_maids, &rmaid->node,
424 hash_bytes(ccm->maid, CCM_MAID_LEN, 0));
428 ccm_mpid = ntohs(ccm->mpid);
429 ccm_seq = ntohl(ccm->seq);
430 ccm_interval = ccm->flags & 0x7;
432 rmp = lookup_remote_mp(&cfm->remote_mps, ccm_mpid);
435 rmp = lookup_remote_mp(&cfmi->x_remote_mps, ccm_mpid);
439 rmp = xzalloc(sizeof *rmp);
440 rmp->mpid = ccm_mpid;
441 hmap_insert(&cfmi->x_remote_mps, &rmp->node, hash_mpid(ccm_mpid));
445 rmp->recv_time = time_msec();
446 rmp->fault = ccm_interval != cfmi->ccm_interval;