lib/lacp.h

   1 /*
   2  * Copyright (c) 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 LACP_H
  18 #define LACP_H 1
  19
  20 #include <stdbool.h>
  21 #include <stdint.h>
  22 #include "packets.h"
  23
  24 /* LACP Protocol Implementation. */
  25
  26 enum lacp_status {
  27     LACP_NEGOTIATED,                  /* Successful LACP negotations. */
  28     LACP_CONFIGURED,                  /* LACP is enabled but not negotiated. */
  29     LACP_DISABLED                     /* LACP is not enabled. */
  30 };
  31
  32 struct lacp_settings {
  33     char *name;                       /* Name (for debugging). */
  34     uint8_t id[ETH_ADDR_LEN];         /* System ID. Must be nonzero. */
  35     uint16_t priority;                /* System priority. */
  36     bool active;                      /* Active or passive mode? */
  37     bool fast;                        /* Fast or slow probe interval. */
  38 };
  39
  40 void lacp_init(void);
  41 struct lacp *lacp_create(void);
  42 void lacp_destroy(struct lacp *);
  43
  44 void lacp_configure(struct lacp *, const struct lacp_settings *);
  45 bool lacp_is_active(const struct lacp *);
  46
  47 void lacp_process_packet(struct lacp *, const void *slave,
  48                          const struct ofpbuf *packet);
  49 enum lacp_status lacp_status(const struct lacp *);
  50
  51 struct lacp_slave_settings {
  52     char *name;                       /* Name (for debugging). */
  53     uint16_t id;                      /* Port ID. */
  54     uint16_t priority;                /* Port priority. */
  55     uint16_t key;                     /* Aggregation key. */
  56 };
  57
  58 void lacp_slave_register(struct lacp *, void *slave_,
  59                          const struct lacp_slave_settings *);
  60 void lacp_slave_unregister(struct lacp *, const void *slave);
  61 void lacp_slave_carrier_changed(const struct lacp *, const void *slave);
  62 bool lacp_slave_may_enable(const struct lacp *, const void *slave);
  63 uint16_t lacp_slave_get_port_id(const struct lacp *, const void *slave);
  64 bool lacp_slave_is_current(const struct lacp *, const void *slave_);
  65
  66 /* Callback function for lacp_run() for sending a LACP PDU. */
  67 typedef void lacp_send_pdu(void *slave, const void *pdu, size_t pdu_size);
  68
  69 void lacp_run(struct lacp *, lacp_send_pdu *);
  70 void lacp_wait(struct lacp *);
  71
  72 #endif /* lacp.h */