tests/run-ryu: Fix setup for Ryu tests
[sliver-openvswitch.git] / ofproto / bond.h
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011 Nicira, Inc.
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 #ifndef BOND_H
18 #define BOND_H 1
19
20 #include <stdbool.h>
21 #include <stdint.h>
22
23 #include "packets.h"
24
25 struct flow;
26 struct netdev;
27 struct ofpbuf;
28 enum lacp_status;
29
30 /* How flows are balanced among bond slaves. */
31 enum bond_mode {
32     BM_TCP, /* Transport Layer Load Balance. */
33     BM_SLB, /* Source Load Balance. */
34     BM_AB   /* Active Backup. */
35 };
36
37 bool bond_mode_from_string(enum bond_mode *, const char *);
38 const char *bond_mode_to_string(enum bond_mode);
39
40 /* Configuration for a bond as a whole. */
41 struct bond_settings {
42     char *name;                 /* Bond's name, for log messages. */
43     uint32_t basis;             /* Flow hashing basis. */
44
45     /* Balancing configuration. */
46     enum bond_mode balance;
47     int rebalance_interval;     /* Milliseconds between rebalances.
48                                    Zero to disable rebalancing. */
49
50     /* Link status detection. */
51     int up_delay;               /* ms before enabling an up slave. */
52     int down_delay;             /* ms before disabling a down slave. */
53
54     /* Legacy compatibility. */
55     bool fake_iface;            /* Update fake stats for netdev 'name'? */
56     bool lacp_fallback_ab_cfg;  /* Fallback to active-backup on LACP failure. */
57 };
58
59 /* Program startup. */
60 void bond_init(void);
61
62 /* Basics. */
63 struct bond *bond_create(const struct bond_settings *);
64 void bond_unref(struct bond *);
65 struct bond *bond_ref(const struct bond *);
66
67 bool bond_reconfigure(struct bond *, const struct bond_settings *);
68 void bond_slave_register(struct bond *, void *slave_, struct netdev *);
69 void bond_slave_set_netdev(struct bond *, void *slave_, struct netdev *);
70 void bond_slave_unregister(struct bond *, const void *slave);
71
72 bool bond_run(struct bond *, enum lacp_status);
73 void bond_wait(struct bond *);
74
75 void bond_slave_set_may_enable(struct bond *, void *slave_, bool may_enable);
76
77 /* Special MAC learning support for SLB bonding. */
78 bool bond_should_send_learning_packets(struct bond *);
79 struct ofpbuf *bond_compose_learning_packet(struct bond *,
80                                             const uint8_t eth_src[ETH_ADDR_LEN],
81                                             uint16_t vlan, void **port_aux);
82
83 /* Packet processing. */
84 enum bond_verdict {
85     BV_ACCEPT,                  /* Accept this packet. */
86     BV_DROP,                    /* Drop this packet. */
87     BV_DROP_IF_MOVED            /* Drop if we've learned a different port. */
88 };
89 enum bond_verdict bond_check_admissibility(struct bond *, const void *slave_,
90                                            const uint8_t dst[ETH_ADDR_LEN]);
91 void *bond_choose_output_slave(struct bond *, const struct flow *,
92                                struct flow_wildcards *, uint16_t vlan);
93
94 /* Rebalancing. */
95 void bond_account(struct bond *, const struct flow *, uint16_t vlan,
96                   uint64_t n_bytes);
97 void bond_rebalance(struct bond *);
98
99 #endif /* bond.h */