ofpbuf: Fix trivial spelling typo.
[cascardo/ovs.git] / lib / lacp.h
index 3965692..f35cff5 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011 Nicira Networks.
+ * Copyright (c) 2011 Nicira, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
 #include <stdint.h>
 #include "packets.h"
 
-/* Masks for lacp_info state member. */
-#define LACP_STATE_ACT  0x01 /* Activity. Active or passive? */
-#define LACP_STATE_TIME 0x02 /* Timeout. Short or long timeout? */
-#define LACP_STATE_AGG  0x04 /* Aggregation. Is the link is bondable? */
-#define LACP_STATE_SYNC 0x08 /* Synchronization. Is the link in up to date? */
-#define LACP_STATE_COL  0x10 /* Collecting. Is the link receiving frames? */
-#define LACP_STATE_DIST 0x20 /* Distributing. Is the link sending frames? */
-#define LACP_STATE_DEF  0x40 /* Defaulted. Using default partner info? */
-#define LACP_STATE_EXP  0x80 /* Expired. Using expired partner info? */
-
-#define LACP_FAST_TIME_TX 1000  /* Fast transmission rate. */
-#define LACP_SLOW_TIME_TX 30000 /* Slow transmission rate. */
-#define LACP_RX_MULTIPLIER 3    /* Multiply by TX rate to get RX rate. */
-
-#define LACP_INFO_LEN 15
-struct lacp_info {
-    ovs_be16 sys_priority;            /* System priority. */
-    uint8_t sys_id[ETH_ADDR_LEN];     /* System ID. */
-    ovs_be16 key;                     /* Operational key. */
-    ovs_be16 port_priority;           /* Port priority. */
-    ovs_be16 port_id;                 /* Port ID. */
-    uint8_t state;                    /* State mask.  See LACP_STATE macros. */
-} __attribute__((packed));
-BUILD_ASSERT_DECL(LACP_INFO_LEN == sizeof(struct lacp_info));
-
-#define LACP_PDU_LEN 110
-struct lacp_pdu {
-    uint8_t subtype;          /* Always 1. */
-    uint8_t version;          /* Always 1. */
-
-    uint8_t actor_type;       /* Always 1. */
-    uint8_t actor_len;        /* Always 20. */
-    struct lacp_info actor;   /* LACP actor information. */
-    uint8_t z1[3];            /* Reserved.  Always 0. */
-
-    uint8_t partner_type;     /* Always 2. */
-    uint8_t partner_len;      /* Always 20. */
-    struct lacp_info partner; /* LACP partner information. */
-    uint8_t z2[3];            /* Reserved.  Always 0. */
-
-    uint8_t collector_type;   /* Always 3. */
-    uint8_t collector_len;    /* Always 16. */
-    ovs_be16 collector_delay; /* Maximum collector delay. Set to UINT16_MAX. */
-    uint8_t z3[64];           /* Combination of several fields.  Always 0. */
-} __attribute__((packed));
-BUILD_ASSERT_DECL(LACP_PDU_LEN == sizeof(struct lacp_pdu));
-
-void compose_lacp_pdu(const struct lacp_info *actor,
-                      const struct lacp_info *partner, struct lacp_pdu *);
-
-const struct lacp_pdu *parse_lacp_packet(const struct ofpbuf *);
-\f
 /* LACP Protocol Implementation. */
 
-enum lacp_time {
-    LACP_TIME_FAST,
-    LACP_TIME_SLOW,
-    LACP_TIME_CUSTOM
+enum lacp_status {
+    LACP_NEGOTIATED,                  /* Successful LACP negotations. */
+    LACP_CONFIGURED,                  /* LACP is enabled but not negotiated. */
+    LACP_DISABLED                     /* LACP is not enabled. */
 };
 
 struct lacp_settings {
-    char *name;
-    uint8_t id[ETH_ADDR_LEN];
-    uint16_t priority;
-    bool active;
-    enum lacp_time lacp_time;
-    long long int custom_time;
-    bool strict;
+    char *name;                       /* Name (for debugging). */
+    struct eth_addr id;               /* System ID. Must be nonzero. */
+    uint16_t priority;                /* System priority. */
+    bool active;                      /* Active or passive mode? */
+    bool fast;                        /* Fast or slow probe interval. */
+    bool fallback_ab_cfg;             /* Fallback to BM_SLB on LACP failure. */
 };
 
 void lacp_init(void);
 struct lacp *lacp_create(void);
-void lacp_destroy(struct lacp *);
+void lacp_unref(struct lacp *);
+struct lacp *lacp_ref(const struct lacp *);
 
 void lacp_configure(struct lacp *, const struct lacp_settings *);
 bool lacp_is_active(const struct lacp *);
 
-void lacp_process_pdu(struct lacp *, const void *slave,
-                      const struct lacp_pdu *);
-bool lacp_negotiated(const struct lacp *);
+void lacp_process_packet(struct lacp *, const void *slave,
+                         const struct dp_packet *packet);
+enum lacp_status lacp_status(const struct lacp *);
 
 struct lacp_slave_settings {
-    char *name;
-    uint16_t id;
-    uint16_t priority;
+    char *name;                       /* Name (for debugging). */
+    uint16_t id;                      /* Port ID. */
+    uint16_t priority;                /* Port priority. */
+    uint16_t key;                     /* Aggregation key. */
 };
 
 void lacp_slave_register(struct lacp *, void *slave_,
@@ -113,13 +62,35 @@ void lacp_slave_register(struct lacp *, void *slave_,
 void lacp_slave_unregister(struct lacp *, const void *slave);
 void lacp_slave_carrier_changed(const struct lacp *, const void *slave);
 bool lacp_slave_may_enable(const struct lacp *, const void *slave);
-uint16_t lacp_slave_get_port_id(const struct lacp *, const void *slave);
 bool lacp_slave_is_current(const struct lacp *, const void *slave_);
 
 /* Callback function for lacp_run() for sending a LACP PDU. */
-typedef void lacp_send_pdu(void *slave, const struct lacp_pdu *);
+typedef void lacp_send_pdu(void *slave, const void *pdu, size_t pdu_size);
 
 void lacp_run(struct lacp *, lacp_send_pdu *);
 void lacp_wait(struct lacp *);
 
+struct lacp_slave_stats {
+    /* id */
+    struct eth_addr dot3adAggPortActorSystemID;
+    struct eth_addr dot3adAggPortPartnerOperSystemID;
+    uint32_t dot3adAggPortAttachedAggID;
+    /* state */
+    uint8_t dot3adAggPortActorAdminState;
+    uint8_t dot3adAggPortActorOperState;
+    uint8_t dot3adAggPortPartnerAdminState;
+    uint8_t dot3adAggPortPartnerOperState;
+    /* counters */
+    uint32_t dot3adAggPortStatsLACPDUsRx;
+    /* uint32_t dot3adAggPortStatsMarkerPDUsRx; */
+    /* uint32_t dot3adAggPortStatsMarkerResponsePDUsRx; */
+    /* uint32_t dot3adAggPortStatsUnknownRx; */
+    uint32_t dot3adAggPortStatsIllegalRx;
+    uint32_t dot3adAggPortStatsLACPDUsTx;
+    /* uint32_t dot3adAggPortStatsMarkerPDUsTx; */
+    /* uint32_t dot3adAggPortStatsMarkerResponsePDUsTx; */
+};
+
+bool lacp_get_slave_stats(const struct lacp *, const void *slave_, struct lacp_slave_stats *);
+
 #endif /* lacp.h */