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