Home | History | Annotate | Line # | Download | only in lagg
if_lagg_lacp.h revision 1.3 
      1 /*	$NetBSD: if_lagg_lacp.h,v 1.3 2021/11/30 01:17:02 yamaguchi Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 2021 Internet Initiative Japan Inc.
      5  * All rights reserved.
      6  *
      7  * Redistribution and use in source and binary forms, with or without
      8  * modification, are permitted provided that the following conditions
      9  * are met:
     10  * 1. Redistributions of source code must retain the above copyright
     11  *    notice, this list of conditions and the following disclaimer.
     12  * 2. Redistributions in binary form must reproduce the above copyright
     13  *    notice, this list of conditions and the following disclaimer in the
     14  *    documentation and/or other materials provided with the distribution.
     15  *
     16  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     17  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     18  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     19  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     20  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     26  * POSSIBILITY OF SUCH DAMAGE.
     27  */
     28 
     29 #ifndef _NET_LAGG_IF_LAGG_LACP_H_
     30 #define _NET_LAGG_IF_LAGG_LACP_H_
     31 
     32 /* timeout values (in sec) */
     33 #define LACP_FAST_PERIODIC_TIME		1
     34 #define LACP_SLOW_PERIODIC_TIME		30
     35 #define LACP_SHORT_TIMEOUT_TIME		(3 * LACP_FAST_PERIODIC_TIME)
     36 #define LACP_LONG_TIMEOUT_TIME		(3 * LACP_SLOW_PERIODIC_TIME)
     37 #define LACP_CHURN_DETECTION_TIME	60
     38 #define LACP_AGGREGATE_WAIT_TIME	2
     39 #define LACP_TRANSIT_DELAY		3
     40 
     41 #define LACP_MAX_PORTS		16
     42 #define LACP_SYSTEM_PRIO	0x8000U
     43 #define LACP_PORT_PRIO		LAGG_PORT_PRIO
     44 
     45 #define LACP_PARTNER_ADMIN_OPTIMISTIC	(LACP_STATE_SYNC | \
     46 					LACP_STATE_AGGREGATION | \
     47 					LACP_STATE_COLLECTING | \
     48 					LACP_STATE_DISTRIBUTING)
     49 #define LACP_PARTNER_ADMIN_STRICT	0
     50 
     51 #define TLV_TYPE_TERMINATE	0
     52 
     53 #define LACP_TYPE_TERMINATE	TLV_TYPE_TERMINATE
     54 #define LACP_TYPE_ACTORINFO	1
     55 #define LACP_TYPE_PARTNERINFO	2
     56 #define LACP_TYPE_COLLECTORINFO	3
     57 
     58 #define MARKER_TYPE_TERMINATE	TLV_TYPE_TERMINATE
     59 #define MARKER_TYPE_INFO	1
     60 #define MARKER_TYPE_RESPONSE	2
     61 
     62 struct tlvhdr {
     63 	uint8_t		 tlv_type;
     64 	uint8_t		 tlv_length;
     65 } __packed;
     66 
     67 struct tlv {
     68 	uint8_t		 tlv_t;
     69 	uint8_t		 tlv_l;
     70 	void		*tlv_v;
     71 };
     72 
     73 static inline void
     74 tlv_set(struct tlvhdr *th, uint8_t t, uint8_t l)
     75 {
     76 
     77 	th->tlv_type = t;
     78 	th->tlv_length = sizeof(*th) + l;
     79 }
     80 
     81 struct lacpdu_peerinfo {
     82 	uint16_t	 lpi_system_prio;
     83 	uint8_t		 lpi_system_mac[LACP_MAC_LEN];
     84 	uint16_t	 lpi_key;
     85 	uint16_t	 lpi_port_prio;
     86 	uint16_t	 lpi_port_no;
     87 	uint8_t		 lpi_state;
     88 	uint8_t		 lpi_resv[3];
     89 } __packed;
     90 
     91 struct lacpdu_collectorinfo {
     92 	uint16_t	 lci_maxdelay;
     93 	uint8_t		 lci_resv[12];
     94 } __packed;
     95 
     96 struct lacpdu {
     97 	struct ether_header	 ldu_eh;
     98 	struct slowprothdr	 ldu_sph;
     99 
    100 	struct tlvhdr		 ldu_tlv_actor;
    101 	struct lacpdu_peerinfo	 ldu_actor;
    102 	struct tlvhdr		 ldu_tlv_partner;
    103 	struct lacpdu_peerinfo	 ldu_partner;
    104 
    105 	struct tlvhdr		 ldu_tlv_collector;
    106 	struct lacpdu_collectorinfo
    107 				 ldu_collector;
    108 
    109 	struct tlvhdr		 ldu_tlv_term;
    110 	uint8_t			 ldu_resv[50];
    111 } __packed;
    112 
    113 struct markerdu_info {
    114 	uint16_t	 mi_rq_port;
    115 	uint8_t		 mi_rq_system[LACP_MAC_LEN];
    116 	uint32_t	 mi_rq_xid;
    117 	uint8_t		 mi_pad[2];
    118 } __packed;
    119 
    120 struct markerdu {
    121 	struct ether_header	 mdu_eh;
    122 	struct slowprothdr	 mdu_sph;
    123 
    124 	struct tlvhdr		 mdu_tlv_info;
    125 	struct markerdu_info	 mdu_info;
    126 
    127 	struct tlvhdr		 mdu_tlv_term;
    128 	uint8_t			 mdu_resv[90];
    129 } __packed;
    130 
    131 /*
    132  * lacp media:
    133  *   1byte
    134  * +-------+-------+-------+-------+
    135  * | media |                 speed |
    136  * +-------+-------+-------+-------+
    137  */
    138 
    139 enum lacp_linkspeed {
    140 	LACP_LINKSPEED_UNKNOWN = 0,
    141 	LACP_LINKSPEED_10,
    142 	LACP_LINKSPEED_100,
    143 	LACP_LINKSPEED_1000,
    144 	LACP_LINKSPEED_2500,
    145 	LACP_LINKSPEED_5000,
    146 	LACP_LINKSPEED_10G,
    147 	LACP_LINKSPEED_25G,
    148 	LACP_LINKSPEED_40G,
    149 	LACP_LINKSPEED_50G,
    150 	LACP_LINKSPEED_56G,
    151 	LACP_LINKSPEED_100G,
    152 	LACP_LINKSPEED_200G,
    153 };
    154 
    155 #define LACP_MEDIA_OFFSET	24
    156 #define LACP_MEDIA_MASK		0xff000000U
    157 #define LACP_MEDIA_ETHER	(__BIT(0) << LACP_MEDIA_OFFSET)
    158 #define LACP_MEDIA_FDX		(__BIT(1) << LACP_MEDIA_OFFSET)
    159 #define LACP_MEDIA_DEFAULT	(LACP_LINKSPEED_UNKNOWN |	\
    160 				 LACP_MEDIA_ETHER | LACP_MEDIA_FDX)
    161 #endif
    162