2 * Copyright (c) 2008, 2009, 2010, 2011, 2014 Nicira, Inc.
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.
22 #include "ofproto-provider.h"
31 /* How flows are balanced among bond slaves. */
33 BM_TCP, /* Transport Layer Load Balance. */
34 BM_SLB, /* Source Load Balance. */
35 BM_AB /* Active Backup. */
38 bool bond_mode_from_string(enum bond_mode *, const char *);
39 const char *bond_mode_to_string(enum bond_mode);
41 /* Configuration for a bond as a whole. */
42 struct bond_settings {
43 char *name; /* Bond's name, for log messages. */
44 uint32_t basis; /* Flow hashing basis. */
46 /* Balancing configuration. */
47 enum bond_mode balance;
48 int rebalance_interval; /* Milliseconds between rebalances.
49 Zero to disable rebalancing. */
51 /* Link status detection. */
52 int up_delay; /* ms before enabling an up slave. */
53 int down_delay; /* ms before disabling a down slave. */
55 /* Legacy compatibility. */
56 bool fake_iface; /* Update fake stats for netdev 'name'? */
57 bool lacp_fallback_ab_cfg; /* Fallback to active-backup on LACP failure. */
60 /* Program startup. */
64 struct bond *bond_create(const struct bond_settings *,
65 struct ofproto_dpif *ofproto);
66 void bond_unref(struct bond *);
67 struct bond *bond_ref(const struct bond *);
69 bool bond_reconfigure(struct bond *, const struct bond_settings *);
70 void bond_slave_register(struct bond *, void *slave_, ofp_port_t ofport, struct netdev *);
71 void bond_slave_set_netdev(struct bond *, void *slave_, struct netdev *);
72 void bond_slave_unregister(struct bond *, const void *slave);
74 bool bond_run(struct bond *, enum lacp_status);
75 void bond_wait(struct bond *);
77 void bond_slave_set_may_enable(struct bond *, void *slave_, bool may_enable);
79 /* Special MAC learning support for SLB bonding. */
80 bool bond_should_send_learning_packets(struct bond *);
81 struct ofpbuf *bond_compose_learning_packet(struct bond *,
82 const uint8_t eth_src[ETH_ADDR_LEN],
83 uint16_t vlan, void **port_aux);
85 /* Packet processing. */
87 BV_ACCEPT, /* Accept this packet. */
88 BV_DROP, /* Drop this packet. */
89 BV_DROP_IF_MOVED /* Drop if we've learned a different port. */
91 enum bond_verdict bond_check_admissibility(struct bond *, const void *slave_,
92 const uint8_t dst[ETH_ADDR_LEN]);
93 void *bond_choose_output_slave(struct bond *, const struct flow *,
94 struct flow_wildcards *, uint16_t vlan);
97 void bond_account(struct bond *, const struct flow *, uint16_t vlan,
99 bool bond_rebalance(struct bond *);
103 * Only balance_tcp mode uses recirculation.
105 * When recirculation is used, each bond port is assigned with a unique
106 * recirc_id. The output action to the bond port will be replaced by
109 * ... actions= ... RECIRC(L4_HASH, recirc_id) ....
111 * On handling first output packet, 256 post recirculation flows are installed:
113 * recirc_id=<bond_recirc_id>, dp_hash=<[0..255]>/0xff, actions: output<slave>
115 * Bond module pulls stats from those post recirculation rules. If rebalancing
116 * is needed, those rules are updated with new output actions.
118 void bond_update_post_recirc_rules(struct bond *, const bool force);
119 bool bond_may_recirc(const struct bond *, uint32_t *recirc_id,
120 uint32_t *hash_bias);
121 void bond_recirculation_account(struct bond *);