lib/cfm.c

   1 /*
   2  * Copyright (c) 2010, 2011 Nicira Networks.
   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 "flow.h"
  25 #include "hash.h"
  26 #include "hmap.h"
  27 #include "ofpbuf.h"
  28 #include "packets.h"
  29 #include "poll-loop.h"
  30 #include "timeval.h"
  31 #include "vlog.h"
  32
  33 VLOG_DEFINE_THIS_MODULE(cfm);
  34
  35 #define CCM_OPCODE 1              /* CFM message opcode meaning CCM. */
  36
  37 struct cfm_internal {
  38     struct cfm cfm;
  39     uint32_t seq;          /* The sequence number of our last CCM. */
  40
  41     uint8_t ccm_interval;  /* The CCM transmission interval. */
  42     int ccm_interval_ms;   /* 'ccm_interval' in milliseconds. */
  43
  44     long long ccm_sent;    /* The time we last sent a CCM. */
  45     long long fault_check; /* The time we last checked for faults. */
  46 };
  47
  48 static int
  49 ccm_interval_to_ms(uint8_t interval)
  50 {
  51     switch (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. */
  55     case 3:  return 100;
  56     case 4:  return 1000;
  57     case 5:  return 10000;
  58     case 6:  return 60000;
  59     case 7:  return 600000;
  60     default: NOT_REACHED(); /* Explicitly not supported by 802.1ag. */
  61     }
  62
  63     NOT_REACHED();
  64 }
  65
  66 static uint8_t
  67 ms_to_ccm_interval(int interval_ms)
  68 {
  69     uint8_t i;
  70
  71     for (i = 7; i > 0; i--) {
  72         if (ccm_interval_to_ms(i) <= interval_ms) {
  73             return i;
  74         }
  75     }
  76
  77     return 1;
  78 }
  79
  80 static struct cfm_internal *
  81 cfm_to_internal(struct cfm *cfm)
  82 {
  83     return CONTAINER_OF(cfm, struct cfm_internal, cfm);
  84 }
  85
  86 static uint32_t
  87 hash_mpid(uint8_t mpid)
  88 {
  89     return hash_int(mpid, 0);
  90 }
  91
  92 static bool
  93 cfm_is_valid_mpid(uint32_t mpid)
  94 {
  95     /* 802.1ag specification requires MPIDs to be within the range [1, 8191] */
  96     return mpid >= 1 && mpid <= 8191;
  97 }
  98
  99 static struct remote_mp *
 100 lookup_remote_mp(const struct hmap *hmap, uint16_t mpid)
 101 {
 102     struct remote_mp *rmp;
 103
 104     HMAP_FOR_EACH_IN_BUCKET (rmp, node, hash_mpid(mpid), hmap) {
 105         if (rmp->mpid == mpid) {
 106             return rmp;
 107         }
 108     }
 109
 110     return NULL;
 111 }
 112
 113 static struct ofpbuf *
 114 compose_ccm(struct cfm_internal *cfmi)
 115 {
 116     struct ccm *ccm;
 117     struct ofpbuf *packet;
 118     struct eth_header *eth;
 119
 120     packet = ofpbuf_new(ETH_HEADER_LEN + CCM_LEN + 2);
 121
 122     ofpbuf_reserve(packet, 2);
 123
 124     eth = ofpbuf_put_zeros(packet, ETH_HEADER_LEN);
 125     ccm = ofpbuf_put_zeros(packet, CCM_LEN);
 126
 127     memcpy(eth->eth_dst, eth_addr_ccm, ETH_ADDR_LEN);
 128     memcpy(eth->eth_src, cfmi->cfm.eth_src, sizeof eth->eth_src);
 129     eth->eth_type = htons(ETH_TYPE_CFM);
 130
 131     ccm->mdlevel_version = 0;
 132     ccm->opcode          = CCM_OPCODE;
 133     ccm->tlv_offset      = 70;
 134     ccm->seq             = htonl(++cfmi->seq);
 135     ccm->mpid            = htons(cfmi->cfm.mpid);
 136     ccm->flags           = cfmi->ccm_interval;
 137     memcpy(ccm->maid, cfmi->cfm.maid, sizeof ccm->maid);
 138     return packet;
 139 }
 140
 141 /* Allocates a 'cfm' object.  This object should have its 'mpid', 'maid',
 142  * 'eth_src', and 'interval' filled out.  When changes are made to the 'cfm'
 143  * object, cfm_configure should be called before using it. */
 144 struct cfm *
 145 cfm_create(void)
 146 {
 147     struct cfm *cfm;
 148     struct cfm_internal *cfmi;
 149
 150     cfmi = xzalloc(sizeof *cfmi);
 151     cfm  = &cfmi->cfm;
 152
 153     hmap_init(&cfm->remote_mps);
 154     hmap_init(&cfm->x_remote_mps);
 155     hmap_init(&cfm->x_remote_maids);
 156     return cfm;
 157 }
 158
 159 void
 160 cfm_destroy(struct cfm *cfm)
 161 {
 162     struct remote_mp *rmp, *rmp_next;
 163     struct remote_maid *rmaid, *rmaid_next;
 164
 165     if (!cfm) {
 166         return;
 167     }
 168
 169     HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &cfm->remote_mps) {
 170         hmap_remove(&cfm->remote_mps, &rmp->node);
 171         free(rmp);
 172     }
 173
 174     HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &cfm->x_remote_mps) {
 175         hmap_remove(&cfm->x_remote_mps, &rmp->node);
 176         free(rmp);
 177     }
 178
 179     HMAP_FOR_EACH_SAFE (rmaid, rmaid_next, node, &cfm->x_remote_maids) {
 180         hmap_remove(&cfm->x_remote_maids, &rmaid->node);
 181         free(rmaid);
 182     }
 183
 184     hmap_destroy(&cfm->remote_mps);
 185     hmap_destroy(&cfm->x_remote_mps);
 186     hmap_destroy(&cfm->x_remote_maids);
 187     free(cfm_to_internal(cfm));
 188 }
 189
 190 /* Should be run periodically to update fault statistics and generate CCM
 191  * messages.  If necessary, returns a packet which the caller is responsible
 192  * for sending, un-initing, and deallocating.  Otherwise returns NULL. */
 193 struct ofpbuf *
 194 cfm_run(struct cfm *cfm)
 195 {
 196     long long now = time_msec();
 197     struct cfm_internal *cfmi = cfm_to_internal(cfm);
 198
 199     /* According to the 802.1ag specification we should assume every other MP
 200      * with the same MAID has the same transmission interval that we have.  If
 201      * an MP has a different interval, cfm_process_heartbeat will register it
 202      * as a fault (likely due to a configuration error).  Thus we can check all
 203      * MPs at once making this quite a bit simpler.
 204      *
 205      * According to the specification we should check when (ccm_interval_ms *
 206      * 3.5)ms have passed.  We changed the multiplier to 4 to avoid messy
 207      * floating point arithmetic and add a bit of wiggle room. */
 208     if (now >= cfmi->fault_check + cfmi->ccm_interval_ms * 4) {
 209         bool fault;
 210         struct remote_mp *rmp, *rmp_next;
 211         struct remote_maid *rmaid, *rmaid_next;
 212
 213         fault = false;
 214
 215         HMAP_FOR_EACH (rmp, node, &cfm->remote_mps) {
 216             rmp->fault = rmp->fault || cfmi->fault_check > rmp->recv_time;
 217             fault      = rmp->fault || fault;
 218         }
 219
 220         HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &cfm->x_remote_mps) {
 221             if (cfmi->fault_check > rmp->recv_time) {
 222                 hmap_remove(&cfm->x_remote_mps, &rmp->node);
 223                 free(rmp);
 224             }
 225         }
 226
 227         HMAP_FOR_EACH_SAFE (rmaid, rmaid_next, node, &cfm->x_remote_maids) {
 228             if (cfmi->fault_check > rmaid->recv_time) {
 229                 hmap_remove(&cfm->x_remote_maids, &rmaid->node);
 230                 free(rmaid);
 231             }
 232         }
 233
 234         fault = (fault || !hmap_is_empty(&cfm->x_remote_mps)
 235                  || !hmap_is_empty(&cfm->x_remote_maids));
 236
 237         cfm->fault        = fault;
 238         cfmi->fault_check = now;
 239     }
 240
 241     if (now >= cfmi->ccm_sent + cfmi->ccm_interval_ms) {
 242         cfmi->ccm_sent = now;
 243         return compose_ccm(cfmi);
 244     }
 245
 246     return NULL;
 247 }
 248
 249 void
 250 cfm_wait(struct cfm *cfm)
 251 {
 252     long long wait;
 253     struct cfm_internal *cfmi = cfm_to_internal(cfm);
 254
 255     wait = MIN(cfmi->ccm_sent + cfmi->ccm_interval_ms,
 256                cfmi->fault_check + cfmi->ccm_interval_ms * 4);
 257     poll_timer_wait_until(wait);
 258 }
 259
 260 /* Should be called whenever a client of the cfm library changes the internals
 261  * of 'cfm'. Returns true if 'cfm' is valid. */
 262 bool
 263 cfm_configure(struct cfm *cfm)
 264 {
 265     struct cfm_internal *cfmi;
 266
 267     if (!cfm_is_valid_mpid(cfm->mpid) || !cfm->interval) {
 268         return false;
 269     }
 270
 271     cfmi                  = cfm_to_internal(cfm);
 272     cfmi->ccm_interval    = ms_to_ccm_interval(cfm->interval);
 273     cfmi->ccm_interval_ms = ccm_interval_to_ms(cfmi->ccm_interval);
 274
 275     /* Force a resend and check in case anything changed. */
 276     cfmi->ccm_sent    = 0;
 277     cfmi->fault_check = 0;
 278     return true;
 279 }
 280
 281 /* Given an array of MPIDs, updates the 'remote_mps' map of 'cfm' to reflect
 282  * it.  Invalid MPIDs are skipped. */
 283 void
 284 cfm_update_remote_mps(struct cfm *cfm, const uint16_t *mpids, size_t n_mpids)
 285 {
 286     size_t i;
 287     struct hmap new_rmps;
 288     struct remote_mp *rmp, *rmp_next;
 289
 290     hmap_init(&new_rmps);
 291
 292     for (i = 0; i < n_mpids; i++) {
 293         uint16_t mpid = mpids[i];
 294
 295         if (!cfm_is_valid_mpid(mpid)
 296             || lookup_remote_mp(&new_rmps, mpid)) {
 297             continue;
 298         }
 299
 300         if ((rmp = lookup_remote_mp(&cfm->remote_mps, mpid))) {
 301             hmap_remove(&cfm->remote_mps, &rmp->node);
 302         } else if ((rmp = lookup_remote_mp(&cfm->x_remote_mps, mpid))) {
 303             hmap_remove(&cfm->x_remote_mps, &rmp->node);
 304         } else {
 305             rmp = xzalloc(sizeof *rmp);
 306             rmp->mpid = mpid;
 307         }
 308
 309         hmap_insert(&new_rmps, &rmp->node, hash_mpid(mpid));
 310     }
 311
 312     hmap_swap(&new_rmps, &cfm->remote_mps);
 313
 314     HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &new_rmps) {
 315         hmap_remove(&new_rmps, &rmp->node);
 316         free(rmp);
 317     }
 318
 319     hmap_destroy(&new_rmps);
 320 }
 321
 322 /* Finds a 'remote_mp' with 'mpid' in 'cfm'.  If no such 'remote_mp' exists
 323  * returns NULL. */
 324 const struct remote_mp *
 325 cfm_get_remote_mp(const struct cfm *cfm, uint16_t mpid)
 326 {
 327     return lookup_remote_mp(&cfm->remote_mps, mpid);
 328 }
 329
 330 /* Generates 'maid' from 'md_name' and 'ma_name'.  A NULL parameter indicates
 331  * the default should be used. Returns false if unsuccessful. */
 332 bool
 333 cfm_generate_maid(const char *md_name, const char *ma_name,
 334                   uint8_t maid[CCM_MAID_LEN])
 335 {
 336     uint8_t *ma_p;
 337     size_t md_len, ma_len;
 338
 339     if (!md_name) {
 340         md_name = "ovs";
 341     }
 342
 343     if (!ma_name) {
 344         ma_name = "ovs";
 345     }
 346
 347     memset(maid, 0, CCM_MAID_LEN);
 348
 349     md_len = strlen(md_name);
 350     ma_len = strlen(ma_name);
 351
 352     if (!md_len || !ma_len || md_len + ma_len + 4 > CCM_MAID_LEN) {
 353         return false;
 354     }
 355
 356     maid[0] = 4;                       /* MD name string format. */
 357     maid[1] = md_len;                  /* MD name size. */
 358     memcpy(&maid[2], md_name, md_len); /* MD name. */
 359
 360     ma_p    = maid + 2 + md_len;
 361     ma_p[0] = 2;                       /* MA name string format. */
 362     ma_p[1] = ma_len;                  /* MA name size. */
 363     memcpy(&ma_p[2], ma_name, ma_len); /* MA name. */
 364     return true;
 365 }
 366
 367 /* Returns true if the CFM library should process packets from 'flow'. */
 368 bool
 369 cfm_should_process_flow(const struct flow *flow)
 370 {
 371     return (ntohs(flow->dl_type) == ETH_TYPE_CFM
 372             && eth_addr_equals(flow->dl_dst, eth_addr_ccm));
 373 }
 374
 375 /* Updates internal statistics relevant to packet 'p'.  Should be called on
 376  * every packet whose flow returned true when passed to
 377  * cfm_should_process_flow. */
 378 void
 379 cfm_process_heartbeat(struct cfm *cfm, const struct ofpbuf *p)
 380 {
 381     struct ccm *ccm;
 382     uint16_t ccm_mpid;
 383     uint32_t ccm_seq;
 384     uint8_t ccm_interval;
 385     struct remote_mp *rmp;
 386
 387     struct cfm_internal *cfmi        = cfm_to_internal(cfm);
 388     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
 389
 390     ccm = ofpbuf_at(p, (uint8_t *)p->l3 - (uint8_t *)p->data, CCM_LEN);
 391
 392     if (!ccm) {
 393         VLOG_INFO_RL(&rl, "Received an un-parseable 802.1ag CCM heartbeat.");
 394         return;
 395     }
 396
 397     if (ccm->opcode != CCM_OPCODE) {
 398         VLOG_INFO_RL(&rl, "Received an unsupported 802.1ag message. "
 399                      "(opcode %u)", ccm->opcode);
 400         return;
 401     }
 402
 403     if (memcmp(ccm->maid, cfm->maid, sizeof ccm->maid)) {
 404         uint32_t hash;
 405         struct remote_maid *rmaid;
 406
 407         hash = hash_bytes(ccm->maid, sizeof ccm->maid, 0);
 408
 409         HMAP_FOR_EACH_IN_BUCKET (rmaid, node, hash, &cfm->x_remote_maids) {
 410             if (memcmp(rmaid->maid, ccm->maid, sizeof rmaid->maid) == 0) {
 411                 rmaid->recv_time = time_msec();
 412                 return;
 413             }
 414         }
 415
 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, hash);
 420         return;
 421     }
 422
 423     ccm_mpid     = ntohs(ccm->mpid);
 424     ccm_seq      = ntohl(ccm->seq);
 425     ccm_interval = ccm->flags & 0x7;
 426
 427     rmp = lookup_remote_mp(&cfm->remote_mps, ccm_mpid);
 428
 429     if (!rmp) {
 430         rmp = lookup_remote_mp(&cfm->x_remote_mps, ccm_mpid);
 431     }
 432
 433     if (!rmp) {
 434         rmp       = xzalloc(sizeof *rmp);
 435         rmp->mpid = ccm_mpid;
 436         hmap_insert(&cfm->x_remote_mps, &rmp->node, hash_mpid(ccm_mpid));
 437         cfm->fault = true;
 438     }
 439
 440     rmp->recv_time = time_msec();
 441     rmp->fault     = ccm_interval != cfmi->ccm_interval;
 442 }