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. */
49 ccm_interval_to_ms(uint8_t interval)
52 case 0: NOT_REACHED(); /* Explicitly not supported by 802.1ag. */
53 case 1: return 3; /* Not recommended due to timer resolution. */
54 case 2: return 10; /* Not recommended due to timer resolution. */
59 case 7: return 600000;
60 default: NOT_REACHED(); /* Explicitly not supported by 802.1ag. */
67 ms_to_ccm_interval(int interval_ms)
71 for (i = 7; i > 0; i--) {
72 if (ccm_interval_to_ms(i) <= interval_ms) {
80 static struct cfm_internal *
81 cfm_to_internal(struct cfm *cfm)
83 return CONTAINER_OF(cfm, struct cfm_internal, cfm);
87 hash_mpid(uint8_t mpid)
89 return hash_int(mpid, 0);
93 cfm_is_valid_mpid(uint32_t mpid)
95 /* 802.1ag specification requires MPIDs to be within the range [1, 8191] */
96 return mpid >= 1 && mpid <= 8191;
99 static struct remote_mp *
100 lookup_remote_mp(const struct hmap *hmap, uint16_t mpid)
102 struct remote_mp *rmp;
104 HMAP_FOR_EACH_IN_BUCKET (rmp, node, hash_mpid(mpid), hmap) {
105 if (rmp->mpid == mpid) {
113 static struct remote_maid *
114 lookup_remote_maid(const struct hmap *hmap, uint8_t maid[CCM_MAID_LEN])
117 struct remote_maid *rmaid;
119 hash = hash_bytes(maid, CCM_MAID_LEN, 0);
120 HMAP_FOR_EACH_WITH_HASH (rmaid, node, hash, hmap) {
121 if (memcmp(rmaid->maid, maid, CCM_MAID_LEN) == 0) {
128 /* Allocates a 'cfm' object. This object should have its 'mpid', 'maid',
129 * 'eth_src', and 'interval' filled out. When changes are made to the 'cfm'
130 * object, cfm_configure should be called before using it. */
135 struct cfm_internal *cfmi;
137 cfmi = xzalloc(sizeof *cfmi);
140 hmap_init(&cfm->remote_mps);
141 hmap_init(&cfm->x_remote_mps);
142 hmap_init(&cfm->x_remote_maids);
147 cfm_destroy(struct cfm *cfm)
149 struct remote_mp *rmp, *rmp_next;
150 struct remote_maid *rmaid, *rmaid_next;
156 HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &cfm->remote_mps) {
157 hmap_remove(&cfm->remote_mps, &rmp->node);
161 HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &cfm->x_remote_mps) {
162 hmap_remove(&cfm->x_remote_mps, &rmp->node);
166 HMAP_FOR_EACH_SAFE (rmaid, rmaid_next, node, &cfm->x_remote_maids) {
167 hmap_remove(&cfm->x_remote_maids, &rmaid->node);
171 hmap_destroy(&cfm->remote_mps);
172 hmap_destroy(&cfm->x_remote_mps);
173 hmap_destroy(&cfm->x_remote_maids);
174 free(cfm_to_internal(cfm));
177 /* Should be run periodically to update fault statistics messages. */
179 cfm_run(struct cfm *cfm)
181 long long now = time_msec();
182 struct cfm_internal *cfmi = cfm_to_internal(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. We changed the multiplier to 4 to avoid messy
192 * floating point arithmetic and add a bit of wiggle room. */
193 if (now >= cfmi->fault_check + cfmi->ccm_interval_ms * 4) {
195 struct remote_mp *rmp, *rmp_next;
196 struct remote_maid *rmaid, *rmaid_next;
200 HMAP_FOR_EACH (rmp, node, &cfm->remote_mps) {
201 rmp->fault = rmp->fault || cfmi->fault_check > rmp->recv_time;
202 fault = rmp->fault || fault;
205 HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &cfm->x_remote_mps) {
206 if (cfmi->fault_check > rmp->recv_time) {
207 hmap_remove(&cfm->x_remote_mps, &rmp->node);
212 HMAP_FOR_EACH_SAFE (rmaid, rmaid_next, node, &cfm->x_remote_maids) {
213 if (cfmi->fault_check > rmaid->recv_time) {
214 hmap_remove(&cfm->x_remote_maids, &rmaid->node);
219 fault = (fault || !hmap_is_empty(&cfm->x_remote_mps)
220 || !hmap_is_empty(&cfm->x_remote_maids));
223 cfmi->fault_check = now;
227 /* Should be run periodically to check if the CFM module has a CCM message it
230 cfm_should_send_ccm(struct cfm *cfm)
232 struct cfm_internal *cfmi = cfm_to_internal(cfm);
234 return time_msec() >= cfmi->ccm_sent + cfmi->ccm_interval_ms;
237 /* Composes a CCM message into 'ccm'. Messages generated with this function
238 * should be sent whenever cfm_should_send_ccm() indicates. */
240 cfm_compose_ccm(struct cfm *cfm, struct ccm *ccm)
242 struct cfm_internal *cfmi = cfm_to_internal(cfm);
244 cfmi->ccm_sent = time_msec();
246 ccm->mdlevel_version = 0;
247 ccm->opcode = CCM_OPCODE;
248 ccm->tlv_offset = 70;
249 ccm->seq = htonl(++cfmi->seq);
250 ccm->mpid = htons(cfmi->cfm.mpid);
251 ccm->flags = cfmi->ccm_interval;
252 memcpy(ccm->maid, cfmi->cfm.maid, sizeof ccm->maid);
256 cfm_wait(struct cfm *cfm)
259 struct cfm_internal *cfmi = cfm_to_internal(cfm);
261 wait = MIN(cfmi->ccm_sent + cfmi->ccm_interval_ms,
262 cfmi->fault_check + cfmi->ccm_interval_ms * 4);
263 poll_timer_wait_until(wait);
266 /* Should be called whenever a client of the cfm library changes the internals
267 * of 'cfm'. Returns true if 'cfm' is valid. */
269 cfm_configure(struct cfm *cfm)
271 struct cfm_internal *cfmi;
273 if (!cfm_is_valid_mpid(cfm->mpid) || !cfm->interval) {
277 cfmi = cfm_to_internal(cfm);
278 cfmi->ccm_interval = ms_to_ccm_interval(cfm->interval);
279 cfmi->ccm_interval_ms = ccm_interval_to_ms(cfmi->ccm_interval);
281 /* Force a resend and check in case anything changed. */
283 cfmi->fault_check = 0;
287 /* Given an array of MPIDs, updates the 'remote_mps' map of 'cfm' to reflect
288 * it. Invalid MPIDs are skipped. */
290 cfm_update_remote_mps(struct cfm *cfm, const uint16_t *mpids, size_t n_mpids)
293 struct hmap new_rmps;
294 struct remote_mp *rmp, *rmp_next;
296 hmap_init(&new_rmps);
298 for (i = 0; i < n_mpids; i++) {
299 uint16_t mpid = mpids[i];
301 if (!cfm_is_valid_mpid(mpid)
302 || lookup_remote_mp(&new_rmps, mpid)) {
306 if ((rmp = lookup_remote_mp(&cfm->remote_mps, mpid))) {
307 hmap_remove(&cfm->remote_mps, &rmp->node);
308 } else if ((rmp = lookup_remote_mp(&cfm->x_remote_mps, mpid))) {
309 hmap_remove(&cfm->x_remote_mps, &rmp->node);
311 rmp = xzalloc(sizeof *rmp);
315 hmap_insert(&new_rmps, &rmp->node, hash_mpid(mpid));
318 hmap_swap(&new_rmps, &cfm->remote_mps);
320 HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &new_rmps) {
321 hmap_remove(&new_rmps, &rmp->node);
325 hmap_destroy(&new_rmps);
328 /* Finds a 'remote_mp' with 'mpid' in 'cfm'. If no such 'remote_mp' exists
330 const struct remote_mp *
331 cfm_get_remote_mp(const struct cfm *cfm, uint16_t mpid)
333 return lookup_remote_mp(&cfm->remote_mps, mpid);
336 /* Generates 'maid' from 'md_name' and 'ma_name'. A NULL parameter indicates
337 * the default should be used. Returns false if unsuccessful. */
339 cfm_generate_maid(const char *md_name, const char *ma_name,
340 uint8_t maid[CCM_MAID_LEN])
343 size_t md_len, ma_len;
353 memset(maid, 0, CCM_MAID_LEN);
355 md_len = strlen(md_name);
356 ma_len = strlen(ma_name);
358 if (!md_len || !ma_len || md_len + ma_len + 4 > CCM_MAID_LEN) {
362 maid[0] = 4; /* MD name string format. */
363 maid[1] = md_len; /* MD name size. */
364 memcpy(&maid[2], md_name, md_len); /* MD name. */
366 ma_p = maid + 2 + md_len;
367 ma_p[0] = 2; /* MA name string format. */
368 ma_p[1] = ma_len; /* MA name size. */
369 memcpy(&ma_p[2], ma_name, ma_len); /* MA name. */
373 /* Returns true if the CFM library should process packets from 'flow'. */
375 cfm_should_process_flow(const struct flow *flow)
377 return (ntohs(flow->dl_type) == ETH_TYPE_CFM
378 && eth_addr_equals(flow->dl_dst, eth_addr_ccm));
381 /* Updates internal statistics relevant to packet 'p'. Should be called on
382 * every packet whose flow returned true when passed to
383 * cfm_should_process_flow. */
385 cfm_process_heartbeat(struct cfm *cfm, const struct ofpbuf *p)
390 uint8_t ccm_interval;
391 struct remote_mp *rmp;
393 struct cfm_internal *cfmi = cfm_to_internal(cfm);
394 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
396 ccm = ofpbuf_at(p, (uint8_t *)p->l3 - (uint8_t *)p->data, CCM_LEN);
399 VLOG_INFO_RL(&rl, "Received an un-parseable 802.1ag CCM heartbeat.");
403 if (ccm->opcode != CCM_OPCODE) {
404 VLOG_INFO_RL(&rl, "Received an unsupported 802.1ag message. "
405 "(opcode %u)", ccm->opcode);
409 if (memcmp(ccm->maid, cfm->maid, sizeof ccm->maid)) {
410 struct remote_maid *rmaid;
412 rmaid = lookup_remote_maid(&cfm->x_remote_maids, ccm->maid);
414 rmaid->recv_time = time_msec();
416 rmaid = xzalloc(sizeof *rmaid);
417 rmaid->recv_time = time_msec();
418 memcpy(rmaid->maid, ccm->maid, sizeof rmaid->maid);
419 hmap_insert(&cfm->x_remote_maids, &rmaid->node,
420 hash_bytes(ccm->maid, CCM_MAID_LEN, 0));
424 ccm_mpid = ntohs(ccm->mpid);
425 ccm_seq = ntohl(ccm->seq);
426 ccm_interval = ccm->flags & 0x7;
428 rmp = lookup_remote_mp(&cfm->remote_mps, ccm_mpid);
431 rmp = lookup_remote_mp(&cfm->x_remote_mps, ccm_mpid);
435 rmp = xzalloc(sizeof *rmp);
436 rmp->mpid = ccm_mpid;
437 hmap_insert(&cfm->x_remote_mps, &rmp->node, hash_mpid(ccm_mpid));
441 rmp->recv_time = time_msec();
442 rmp->fault = ccm_interval != cfmi->ccm_interval;