lacp: Enable "fast" lacp timing mode.
[sliver-openvswitch.git] / lib / lacp.c
1 /* Copyright (c) 2011 Nicira Networks
2  *
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15
16 #include <config.h>
17 #include "lacp.h"
18
19 #include <assert.h>
20 #include <stdlib.h>
21
22 #include "dynamic-string.h"
23 #include "hash.h"
24 #include "hmap.h"
25 #include "ofpbuf.h"
26 #include "packets.h"
27 #include "poll-loop.h"
28 #include "timeval.h"
29 #include "unixctl.h"
30 #include "vlog.h"
31
32 VLOG_DEFINE_THIS_MODULE(lacp);
33
34 enum slave_status {
35     LACP_CURRENT,   /* Current State.  Partner up to date. */
36     LACP_EXPIRED,   /* Expired State.  Partner out of date. */
37     LACP_DEFAULTED, /* Defaulted State.  No partner. */
38 };
39
40 struct lacp {
41     struct list node;             /* Node in all_lacps list. */
42     char *name;                   /* Name of this lacp object. */
43     uint8_t sys_id[ETH_ADDR_LEN]; /* System ID. */
44     uint16_t sys_priority;        /* System Priority. */
45     bool active;                  /* Active or Passive. */
46
47     struct hmap slaves;      /* Slaves this LACP object controls. */
48     struct slave *key_slave; /* Slave whose ID will be the aggregation key. */
49
50     bool fast;                /* Fast or Slow LACP time. */
51     bool negotiated;         /* True if LACP negotiations were successful. */
52     bool update;             /* True if lacp_update() needs to be called. */
53 };
54
55 struct slave {
56     void *aux;                    /* Handle used to identify this slave. */
57     struct hmap_node node;        /* Node in master's slaves map. */
58
59     struct lacp *lacp;            /* LACP object containing this slave. */
60     uint16_t port_id;             /* Port ID. */
61     uint16_t port_priority;       /* Port Priority. */
62     char *name;                   /* Name of this slave. */
63
64     enum slave_status status;     /* Slave status. */
65     bool attached;                /* Attached. Traffic may flow. */
66     bool enabled;                 /* Enabled. Traffic is flowing. */
67     struct lacp_info partner;     /* Partner information. */
68     struct lacp_info ntt_actor;   /* Used to decide if we Need To Transmit. */
69     long long int tx;             /* Next message transmission time. */
70     long long int rx;             /* Expected message receive time. */
71 };
72
73 static struct list all_lacps = LIST_INITIALIZER(&all_lacps);
74
75 static void lacp_update_attached(struct lacp *);
76
77 static void slave_destroy(struct slave *);
78 static void slave_set_defaulted(struct slave *);
79 static void slave_set_expired(struct slave *);
80 static void slave_get_actor(struct slave *, struct lacp_info *actor);
81 static void slave_get_priority(struct slave *, struct lacp_info *priority);
82 static bool slave_may_tx(const struct slave *);
83 static struct slave *slave_lookup(const struct lacp *, const void *slave);
84 static bool info_tx_equal(struct lacp_info *, struct lacp_info *);
85
86 static void lacp_unixctl_show(struct unixctl_conn *, const char *args,
87                               void *aux);
88
89 /* Initializes the lacp module. */
90 void
91 lacp_init(void)
92 {
93     unixctl_command_register("lacp/show", lacp_unixctl_show, NULL);
94 }
95
96 /* Creates a LACP object. */
97 struct lacp *
98 lacp_create(void)
99 {
100     struct lacp *lacp;
101
102     lacp = xzalloc(sizeof *lacp);
103     hmap_init(&lacp->slaves);
104     list_push_back(&all_lacps, &lacp->node);
105     return lacp;
106 }
107
108 /* Destroys 'lacp' and its slaves. Does nothing if 'lacp' is NULL. */
109 void
110 lacp_destroy(struct lacp *lacp)
111 {
112     if (lacp) {
113         struct slave *slave, *next;
114
115         HMAP_FOR_EACH_SAFE (slave, next, node, &lacp->slaves) {
116             slave_destroy(slave);
117         }
118
119         hmap_destroy(&lacp->slaves);
120         list_remove(&lacp->node);
121         free(lacp->name);
122         free(lacp);
123     }
124 }
125
126 /* Configures 'lacp' with the given 'name', 'sys_id', 'sys_priority', and
127  * 'active' parameters. */
128 void
129 lacp_configure(struct lacp *lacp, const char *name,
130                uint8_t sys_id[ETH_ADDR_LEN], uint16_t sys_priority,
131                bool active, bool fast)
132 {
133     if (!lacp->name || strcmp(name, lacp->name)) {
134         free(lacp->name);
135         lacp->name = xstrdup(name);
136     }
137
138     memcpy(lacp->sys_id, sys_id, ETH_ADDR_LEN);
139     lacp->sys_priority = sys_priority;
140     lacp->active = active;
141     lacp->fast = fast;
142 }
143
144 /* Processes 'pdu', a parsed LACP packet received on 'slave_'.  This function
145  * should be called on all packets received on 'slave_' with Ethernet Type
146  * ETH_TYPE_LACP and parsable by parse_lacp_packet(). */
147 void
148 lacp_process_pdu(struct lacp *lacp, const void *slave_,
149                  const struct lacp_pdu *pdu)
150 {
151     struct slave *slave = slave_lookup(lacp, slave_);
152
153     slave->status = LACP_CURRENT;
154     slave->rx = time_msec() + (lacp->fast
155                                ? LACP_FAST_TIME_RX
156                                : LACP_SLOW_TIME_RX);
157
158     slave->ntt_actor = pdu->partner;
159
160     /* Update our information about our partner if it's out of date.  This may
161      * cause priorities to change so re-calculate attached status of all
162      * slaves.  */
163     if (memcmp(&slave->partner, &pdu->actor, sizeof pdu->actor)) {
164         lacp->update = true;
165         slave->partner = pdu->actor;
166     }
167 }
168
169 /* Returns true if 'lacp' has successfully negotiated with its partner.  False
170  * if 'lacp' is NULL. */
171 bool
172 lacp_negotiated(const struct lacp *lacp)
173 {
174     return lacp ? lacp->negotiated : false;
175 }
176
177 /* Registers 'slave_' as subordinate to 'lacp'.  This should be called at least
178  * once per slave in a LACP managed bond.  Should also be called whenever a
179  * slave's name, port_id, or port_priority change. */
180 void
181 lacp_slave_register(struct lacp *lacp, void *slave_, const char *name,
182                     uint16_t port_id, uint16_t port_priority)
183 {
184     struct slave *slave = slave_lookup(lacp, slave_);
185
186     if (!slave) {
187         slave = xzalloc(sizeof *slave);
188         slave->lacp = lacp;
189         slave->aux = slave_;
190         hmap_insert(&lacp->slaves, &slave->node, hash_pointer(slave_, 0));
191         slave_set_defaulted(slave);
192
193         if (!lacp->key_slave) {
194             lacp->key_slave = slave;
195         }
196     }
197
198     if (!slave->name || strcmp(name, slave->name)) {
199         free(slave->name);
200         slave->name = xstrdup(name);
201     }
202
203     if (slave->port_id != port_id || slave->port_priority != port_priority) {
204
205         slave->port_id = port_id;
206         slave->port_priority = port_priority;
207
208         lacp->update = true;
209
210         if (lacp->active || lacp->negotiated) {
211             slave_set_expired(slave);
212         }
213     }
214 }
215
216 /* Unregisters 'slave_' with 'lacp'.  */
217 void
218 lacp_slave_unregister(struct lacp *lacp, const void *slave_)
219 {
220     struct slave *slave = slave_lookup(lacp, slave_);
221
222     if (slave) {
223         slave_destroy(slave);
224     }
225 }
226
227 /* Should be called regularly to indicate whether 'slave_' is enabled.  An
228  * enabled slave is allowed to send and receive traffic.  Generally a slave
229  * should not be enabled if its carrier is down, or lacp_slave_may_enable()
230  * indicates it should not be enabled. */
231 void
232 lacp_slave_enable(struct lacp *lacp, void *slave_, bool enabled)
233 {
234    slave_lookup(lacp, slave_)->enabled = enabled;
235 }
236
237 /* This function should be called whenever the carrier status of 'slave_' has
238  * changed. */
239 void
240 lacp_slave_carrier_changed(const struct lacp *lacp, const void *slave_)
241 {
242     struct slave *slave = slave_lookup(lacp, slave_);
243
244     if (slave->status == LACP_CURRENT || slave->lacp->active) {
245         slave_set_expired(slave);
246     }
247 }
248
249 /* This function should be called before enabling 'slave_' to send or receive
250  * traffic.  If it returns false, 'slave_' should not enabled.  As a
251  * convenience, returns true if 'lacp' is NULL. */
252 bool
253 lacp_slave_may_enable(const struct lacp *lacp, const void *slave_)
254 {
255     if (lacp) {
256         struct slave *slave = slave_lookup(lacp, slave_);
257
258         /* The slave may be enabled if it's attached to an aggregator and its
259          * partner is synchronized.  The only exception is defaulted slaves.
260          * They are not required to have synchronized partners because they
261          * have no partners at all.  They will only be attached if negotiations
262          * failed on all slaves in the bond. */
263         return slave->attached && (slave->partner.state & LACP_STATE_SYNC
264                                    || slave->status == LACP_DEFAULTED);
265     } else {
266         return true;
267     }
268 }
269
270 /* This function should be called periodically to update 'lacp'. */
271 void
272 lacp_run(struct lacp *lacp, lacp_send_pdu *send_pdu)
273 {
274     struct slave *slave;
275
276     HMAP_FOR_EACH (slave, node, &lacp->slaves) {
277         if (time_msec() >= slave->rx) {
278             if (slave->status == LACP_CURRENT) {
279                 slave_set_expired(slave);
280             } else if (slave->status == LACP_EXPIRED) {
281                 slave_set_defaulted(slave);
282             }
283         }
284     }
285
286     if (lacp->update) {
287         lacp_update_attached(lacp);
288     }
289
290     HMAP_FOR_EACH (slave, node, &lacp->slaves) {
291         struct lacp_pdu pdu;
292         struct lacp_info actor;
293
294         if (!slave_may_tx(slave)) {
295             continue;
296         }
297
298         slave_get_actor(slave, &actor);
299
300         if (time_msec() >= slave->tx
301             || !info_tx_equal(&actor, &slave->ntt_actor)) {
302
303             slave->ntt_actor = actor;
304             compose_lacp_pdu(&actor, &slave->partner, &pdu);
305             send_pdu(slave->aux, &pdu);
306
307             slave->tx = time_msec() +
308                 (slave->partner.state & LACP_STATE_TIME
309                  ? LACP_FAST_TIME_TX
310                  : LACP_SLOW_TIME_TX);
311         }
312     }
313 }
314
315 /* Causes poll_block() to wake up when lacp_run() needs to be called again. */
316 void
317 lacp_wait(struct lacp *lacp)
318 {
319     struct slave *slave;
320
321     HMAP_FOR_EACH (slave, node, &lacp->slaves) {
322         if (slave_may_tx(slave)) {
323             poll_timer_wait_until(slave->tx);
324         }
325
326         if (slave->status != LACP_DEFAULTED) {
327             poll_timer_wait_until(slave->rx);
328         }
329     }
330 }
331 \f
332 /* Static Helpers. */
333
334 /* Updates the attached status of all slaves controlled b 'lacp' and sets its
335  * negotiated parameter to true if any slaves are attachable. */
336 static void
337 lacp_update_attached(struct lacp *lacp)
338 {
339     struct slave *lead, *slave;
340     struct lacp_info lead_pri;
341     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 10);
342
343     lacp->update = false;
344
345     lead = NULL;
346     HMAP_FOR_EACH (slave, node, &lacp->slaves) {
347         struct lacp_info pri;
348
349         slave->attached = true;
350
351         /* XXX: In the future allow users to configure the expected system ID.
352          * For now just special case loopback. */
353         if (eth_addr_equals(slave->partner.sys_id, slave->lacp->sys_id)) {
354             VLOG_WARN_RL(&rl, "slave %s: Loopback detected. Slave is "
355                          "connected to its own bond", slave->name);
356             slave->attached = false;
357             continue;
358         }
359
360         if (slave->status == LACP_DEFAULTED) {
361             continue;
362         }
363
364         slave_get_priority(slave, &pri);
365
366         if (!lead || memcmp(&pri, &lead_pri, sizeof pri) < 0) {
367             lead = slave;
368             lead_pri = pri;
369         }
370     }
371
372     lacp->negotiated = lead != NULL;
373
374     if (lead) {
375         HMAP_FOR_EACH (slave, node, &lacp->slaves) {
376             if (slave->status == LACP_DEFAULTED
377                 || lead->partner.key != slave->partner.key
378                 || !eth_addr_equals(lead->partner.sys_id,
379                                     slave->partner.sys_id)) {
380                 slave->attached = false;
381             }
382         }
383     }
384 }
385
386 static void
387 slave_destroy(struct slave *slave)
388 {
389     if (slave) {
390         struct lacp *lacp = slave->lacp;
391
392         lacp->update = true;
393         hmap_remove(&lacp->slaves, &slave->node);
394
395         if (lacp->key_slave == slave) {
396             struct hmap_node *slave_node = hmap_first(&lacp->slaves);
397
398             if (slave_node) {
399                 lacp->key_slave = CONTAINER_OF(slave_node, struct slave, node);
400             } else {
401                 lacp->key_slave = NULL;
402             }
403         }
404
405         free(slave->name);
406         free(slave);
407     }
408 }
409
410 static void
411 slave_set_defaulted(struct slave *slave)
412 {
413     memset(&slave->partner, 0, sizeof slave->partner);
414
415     slave->lacp->update = true;
416     slave->status = LACP_DEFAULTED;
417 }
418
419 static void
420 slave_set_expired(struct slave *slave)
421 {
422     slave->status = LACP_EXPIRED;
423     slave->partner.state |= LACP_STATE_TIME;
424     slave->partner.state &= ~LACP_STATE_SYNC;
425
426     slave->rx = time_msec() + LACP_FAST_TIME_RX;
427 }
428
429 static void
430 slave_get_actor(struct slave *slave, struct lacp_info *actor)
431 {
432     uint8_t state = 0;
433
434     if (slave->lacp->active) {
435         state |= LACP_STATE_ACT;
436     }
437
438     if (slave->lacp->fast) {
439         state |= LACP_STATE_TIME;
440     }
441
442     if (slave->attached) {
443         state |= LACP_STATE_SYNC;
444     }
445
446     if (slave->status == LACP_DEFAULTED) {
447         state |= LACP_STATE_DEF;
448     }
449
450     if (slave->status == LACP_EXPIRED) {
451         state |= LACP_STATE_EXP;
452     }
453
454     if (hmap_count(&slave->lacp->slaves) > 1) {
455         state |= LACP_STATE_AGG;
456     }
457
458     if (slave->enabled) {
459         state |= LACP_STATE_COL | LACP_STATE_DIST;
460     }
461
462     actor->state = state;
463     actor->key = htons(slave->lacp->key_slave->port_id);
464     actor->port_priority = htons(slave->port_priority);
465     actor->port_id = htons(slave->port_id);
466     actor->sys_priority = htons(slave->lacp->sys_priority);
467     memcpy(&actor->sys_id, slave->lacp->sys_id, ETH_ADDR_LEN);
468 }
469
470 /* Given 'slave', populates 'priority' with data representing its LACP link
471  * priority.  If two priority objects populated by this function are compared
472  * using memcmp, the higher priority link will be less than the lower priority
473  * link. */
474 static void
475 slave_get_priority(struct slave *slave, struct lacp_info *priority)
476 {
477     uint16_t partner_priority, actor_priority;
478
479     /* Choose the lacp_info of the higher priority system by comparing their
480      * system priorities and mac addresses. */
481     actor_priority = slave->lacp->sys_priority;
482     partner_priority = ntohs(slave->partner.sys_priority);
483     if (actor_priority < partner_priority) {
484         slave_get_actor(slave, priority);
485     } else if (partner_priority < actor_priority) {
486         *priority = slave->partner;
487     } else if (eth_addr_compare_3way(slave->lacp->sys_id,
488                                      slave->partner.sys_id) < 0) {
489         slave_get_actor(slave, priority);
490     } else {
491         *priority = slave->partner;
492     }
493
494     /* Key and state are not used in priority comparisons. */
495     priority->key = 0;
496     priority->state = 0;
497 }
498
499 static bool
500 slave_may_tx(const struct slave *slave)
501 {
502     return slave->lacp->active || slave->status != LACP_DEFAULTED;
503 }
504
505 static struct slave *
506 slave_lookup(const struct lacp *lacp, const void *slave_)
507 {
508     struct slave *slave;
509
510     HMAP_FOR_EACH_IN_BUCKET (slave, node, hash_pointer(slave_, 0),
511                              &lacp->slaves) {
512         if (slave->aux == slave_) {
513             return slave;
514         }
515     }
516
517     return NULL;
518 }
519
520 /* Two lacp_info structures are tx_equal if and only if they do not differ in
521  * ways which would require a lacp_pdu transmission. */
522 static bool
523 info_tx_equal(struct lacp_info *a, struct lacp_info *b)
524 {
525
526     /* LACP specification dictates that we transmit whenever the actor and
527      * remote_actor differ in the following fields: Port, Port Priority,
528      * System, System Priority, Aggregation Key, Activity State, Timeout State,
529      * Sync State, and Aggregation State. The state flags are most likely to
530      * change so are checked first. */
531     return !((a->state ^ b->state) & (LACP_STATE_ACT
532                                       | LACP_STATE_TIME
533                                       | LACP_STATE_SYNC
534                                       | LACP_STATE_AGG))
535         && a->port_id == b->port_id
536         && a->port_priority == b->port_priority
537         && a->key == b->key
538         && a->sys_priority == b->sys_priority
539         && eth_addr_equals(a->sys_id, b->sys_id);
540 }
541 \f
542 static struct lacp *
543 lacp_find(const char *name)
544 {
545     struct lacp *lacp;
546
547     LIST_FOR_EACH (lacp, node, &all_lacps) {
548         if (!strcmp(lacp->name, name)) {
549             return lacp;
550         }
551     }
552
553     return NULL;
554 }
555
556 static void
557 ds_put_lacp_state(struct ds *ds, uint8_t state)
558 {
559     if (state & LACP_STATE_ACT) {
560         ds_put_cstr(ds, "activity ");
561     }
562
563     if (state & LACP_STATE_TIME) {
564         ds_put_cstr(ds, "timeout ");
565     }
566
567     if (state & LACP_STATE_AGG) {
568         ds_put_cstr(ds, "aggregation ");
569     }
570
571     if (state & LACP_STATE_SYNC) {
572         ds_put_cstr(ds, "synchronized ");
573     }
574
575     if (state & LACP_STATE_COL) {
576         ds_put_cstr(ds, "collecting ");
577     }
578
579     if (state & LACP_STATE_DIST) {
580         ds_put_cstr(ds, "distributing ");
581     }
582
583     if (state & LACP_STATE_DEF) {
584         ds_put_cstr(ds, "defaulted ");
585     }
586
587     if (state & LACP_STATE_EXP) {
588         ds_put_cstr(ds, "expired ");
589     }
590 }
591
592 static void
593 lacp_unixctl_show(struct unixctl_conn *conn,
594                   const char *args, void *aux OVS_UNUSED)
595 {
596     struct ds ds = DS_EMPTY_INITIALIZER;
597     struct lacp *lacp;
598     struct slave *slave;
599
600     lacp = lacp_find(args);
601     if (!lacp) {
602         unixctl_command_reply(conn, 501, "no such lacp object");
603         return;
604     }
605
606     ds_put_format(&ds, "lacp: %s\n", lacp->name);
607     ds_put_format(&ds, "\tstatus: %s %s\n",
608                   lacp->active ? "active" : "passive",
609                   lacp->negotiated ? "negotiated" : "");
610     ds_put_format(&ds, "\tsys_id: " ETH_ADDR_FMT "\n", ETH_ADDR_ARGS(lacp->sys_id));
611     ds_put_format(&ds, "\tsys_priority: %u\n", lacp->sys_priority);
612     ds_put_cstr(&ds, "\taggregation key: ");
613     if (lacp->key_slave) {
614         ds_put_format(&ds, "%u", lacp->key_slave->port_id);
615     } else {
616         ds_put_cstr(&ds, "none");
617     }
618     ds_put_cstr(&ds, "\n");
619
620     HMAP_FOR_EACH (slave, node, &lacp->slaves) {
621         char *status;
622         struct lacp_info actor;
623
624         slave_get_actor(slave, &actor);
625         switch (slave->status) {
626         case LACP_CURRENT:
627             status = "current";
628             break;
629         case LACP_EXPIRED:
630             status = "expired";
631             break;
632         case LACP_DEFAULTED:
633             status = "defaulted";
634             break;
635         default:
636             NOT_REACHED();
637         }
638
639         ds_put_format(&ds, "\nslave: %s: %s %s %s\n", slave->name, status,
640                       slave->attached ? "attached" : "detached",
641                       slave->enabled ? "enabled" : "disabled");
642         ds_put_format(&ds, "\tport_id: %u\n", slave->port_id);
643         ds_put_format(&ds, "\tport_priority: %u\n", slave->port_priority);
644
645         ds_put_format(&ds, "\n\tactor sys_id: " ETH_ADDR_FMT "\n",
646                       ETH_ADDR_ARGS(actor.sys_id));
647         ds_put_format(&ds, "\tactor sys_priority: %u\n",
648                       ntohs(actor.sys_priority));
649         ds_put_format(&ds, "\tactor port_id: %u\n",
650                       ntohs(actor.port_id));
651         ds_put_format(&ds, "\tactor port_priority: %u\n",
652                       ntohs(actor.port_priority));
653         ds_put_format(&ds, "\tactor key: %u\n",
654                       ntohs(actor.key));
655         ds_put_cstr(&ds, "\tactor state: ");
656         ds_put_lacp_state(&ds, actor.state);
657         ds_put_cstr(&ds, "\n\n");
658
659         ds_put_format(&ds, "\tpartner sys_id: " ETH_ADDR_FMT "\n",
660                       ETH_ADDR_ARGS(slave->partner.sys_id));
661         ds_put_format(&ds, "\tpartner sys_priority: %u\n",
662                       ntohs(slave->partner.sys_priority));
663         ds_put_format(&ds, "\tpartner port_id: %u\n",
664                       ntohs(slave->partner.port_id));
665         ds_put_format(&ds, "\tpartner port_priority: %u\n",
666                       ntohs(slave->partner.port_priority));
667         ds_put_format(&ds, "\tpartner key: %u\n",
668                       ntohs(slave->partner.key));
669         ds_put_cstr(&ds, "\tpartner state: ");
670         ds_put_lacp_state(&ds, slave->partner.state);
671         ds_put_cstr(&ds, "\n");
672     }
673
674     unixctl_command_reply(conn, 200, ds_cstr(&ds));
675     ds_destroy(&ds);
676 }