Add support for experimental attributes (opencomputeproject#807)

* Add supporf for experimental attributes

* Fix comments

* Remove example fpga extensions

Author: kcudnik

experimental/saiextensions.h

@@ -0,0 +1,51 @@
+/**
+ * Copyright (c) 2018 Microsoft Open Technologies, Inc.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License"); you may
+ *    not use this file except in compliance with the License. You may obtain
+ *    a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR
+ *    CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT
+ *    LIMITATION ANY IMPLIED WARRANTIES OR CONDITIONS OF TITLE, FITNESS
+ *    FOR A PARTICULAR PURPOSE, MERCHANTABILITY OR NON-INFRINGEMENT.
+ *
+ *    See the Apache Version 2.0 License for specific language governing
+ *    permissions and limitations under the License.
+ *
+ *    Microsoft would like to thank the following companies for their review and
+ *    assistance with these files: Intel Corporation, Mellanox Technologies Ltd,
+ *    Dell Products, L.P., Facebook, Inc., Marvell International Ltd.
+ *
+ * @file    saiextensions.h
+ *
+ * @brief   This module defines extensions of the Switch Abstraction Interface (SAI)
+ */
+
+#ifndef __SAIEXTENSIONS_H_
+#define __SAIEXTENSIONS_H_
+
+#include <saitypes.h>
+
+/* existing enum extensions */
+#include "saitypesextensions.h"
+#include "saiswitchextensions.h"
+
+/* new experimental object type includes */
+
+/**
+ * @brief Extensions to SAI APIs
+ *
+ * @flags
+ */
+typedef enum _sai_api_extensions_t
+{
+    SAI_API_EXTENSIONS_RANGE_START = SAI_API_MAX,
+
+    /* Add new experimental APIs above this line */
+
+    SAI_API_EXTENSIONS_RANGE_START_END
+
+} sai_api_extensions_t;
+
+#endif /* __SAIEXTENSIONS_H_ */

experimental/saiswitchextensions.h

@@ -0,0 +1,43 @@
+/**
+ * Copyright (c) 2018 Microsoft Open Technologies, Inc.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License"); you may
+ *    not use this file except in compliance with the License. You may obtain
+ *    a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR
+ *    CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT
+ *    LIMITATION ANY IMPLIED WARRANTIES OR CONDITIONS OF TITLE, FITNESS
+ *    FOR A PARTICULAR PURPOSE, MERCHANTABILITY OR NON-INFRINGEMENT.
+ *
+ *    See the Apache Version 2.0 License for specific language governing
+ *    permissions and limitations under the License.
+ *
+ *    Microsoft would like to thank the following companies for their review and
+ *    assistance with these files: Intel Corporation, Mellanox Technologies Ltd,
+ *    Dell Products, L.P., Facebook, Inc., Marvell International Ltd.
+ *
+ * @file    saiswitchextensions.h
+ *
+ * @brief   This module defines switch extensions of the Switch Abstraction Interface (SAI)
+ */
+
+#ifndef __SAISWITCHEXTENSIONS_H_
+#define __SAISWITCHEXTENSIONS_H_
+
+#include <saitypes.h>
+
+/**
+ * @brief SAI switch attribute extensions.
+ *
+ * @flags
+ */
+typedef enum _sai_switch_attr_extensions_t
+{
+    SAI_SWITCH_ATTR_EXTENSIONS_RANGE_START = SAI_SWITCH_ATTR_END,
+
+    SAI_SWITCH_ATTR_EXTENSIONS_RANGE_END
+
+} sai_switch_attr_extensions_t;
+
+#endif /* __SAISWITCHEXTENSIONS_H_ */

experimental/saitypesextensions.h

@@ -0,0 +1,46 @@
+/**
+ * Copyright (c) 2018 Microsoft Open Technologies, Inc.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License"); you may
+ *    not use this file except in compliance with the License. You may obtain
+ *    a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR
+ *    CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT
+ *    LIMITATION ANY IMPLIED WARRANTIES OR CONDITIONS OF TITLE, FITNESS
+ *    FOR A PARTICULAR PURPOSE, MERCHANTABILITY OR NON-INFRINGEMENT.
+ *
+ *    See the Apache Version 2.0 License for specific language governing
+ *    permissions and limitations under the License.
+ *
+ *    Microsoft would like to thank the following companies for their review and
+ *    assistance with these files: Intel Corporation, Mellanox Technologies Ltd,
+ *    Dell Products, L.P., Facebook, Inc., Marvell International Ltd.
+ *
+ * @file    saitypesextensions.h
+ *
+ * @brief   This module defines type extensions of the Switch Abstraction Interface (SAI)
+ */
+
+#ifndef __SAITYPESEXTENSIONS_H_
+#define __SAITYPESEXTENSIONS_H_
+
+#include <saitypes.h>
+
+/**
+ * @brief SAI object type extensions
+ *
+ * @flags
+ */
+typedef enum _sai_object_type_extensions_t
+{
+    SAI_OBJECT_TYPE_EXTENSIONS_RANGE_START = SAI_OBJECT_TYPE_MAX,
+
+    /* Add new experimental object types above this line */
+
+    SAI_OBJECT_TYPE_EXTENSIONS_RANGE_END
+
+} sai_object_type_extensions_t;
+
+#endif /* __SAITYPESEXTENSIONS_H_ */
+

meta/Doxyfile

@@ -745,6 +745,7 @@ WARN_LOGFILE           =
 # Note: If this tag is empty the current directory is searched.
 
 INPUT                  = ../inc/
+INPUT                  += ../experimental/
 INPUT                  += saimetadatatypes.h
 INPUT                  += saimetadatautils.h
 INPUT                  += saimetadatalogger.h

meta/Makefile

@@ -63,9 +63,9 @@ WARNINGS = \
 	-Wvariadic-macros \
 	-Wwrite-strings
 
-CFLAGS += -I../inc $(WARNINGS)
+CFLAGS += -I../inc -I../experimental $(WARNINGS)
 
-DEPS = $(wildcard ../inc/*.h)
+DEPS = $(wildcard ../inc/*.h) $(wildcard ../experimental/*.h)
 XMLDEPS = $(wildcard xml/*.xml)
 
 OBJ = saimetadata.o saimetadatautils.o saiserialize.o

meta/acronyms.txt

@@ -19,6 +19,7 @@ DLDR - Dead Lock Detection and Recovery
 DLL - Dynamic Link Library
 DLR - Dead Lock Recovery
 DSCP - Differentiated Services Code Point
+DTEL - Data Plane Telemetry
 ECMP - Equal Cost Multi-Path
 ECN - Explicit Congestion Notification
 ECT - ECN Capable Transport
@@ -28,11 +29,13 @@ FCS - Frame Check Sequence
 FD - File Descriptor
 FDB - Forwarding Data Base
 FEC - Forward Error Correction
+FPGA - Field Programmable Gate Array
 GRE - Generic Routing Encapsulation
 HW - Hardware
 I2C - Inter Integrated Circuit
 ICMP - Internet Control Message Protocol
 IEEE - Institute of Electrical and Electronics Engineers
+IGMP - Internet Group Management Protocol
 IP - Internet Protocol
 IP2ME - IP packets to local router IP
 IPMC - Intelligent Platform Management Controller
@@ -45,6 +48,7 @@ MPLS - Multi Protocol Label Switching
 MTU - Maximum Transmission Unit
 NHLFE - Next Hop Label Forwarding Entry
 NPU - Numeric Processing Unit
+OAM - Operations Administration and Maintenance
 OUI - Organizationally Unique Identifier
 PBS - Peak Burst Size
 PCI - Peripheral Component Interconnect
@@ -81,6 +85,3 @@ WWW - World Wide Web
 XG - (*,G) Any-source Multicast
 XOFF - Transmitter Off
 XON - Transmitter On
-IGMP - Internet Group Management Protocol
-OAM - Operations Administration and Maintenance
-DTEL - Data Plane Telemetry

meta/aspell.en.pws

@@ -8,24 +8,26 @@ Dst
 Enum
 EtherType
 FC
+FPGAs
 Facebook
 HQOS
 HQoS
 Hostif
-Inservice
 InSegment
+Inservice
 LAGs
 Linux
 Loopback
-Marvell
 MCAST
 MERCHANTABILITY
+Marvell
 Mbps
 Mellanox
 Metadata
 Microburst
 Microbursts
 Multicast
+NPUs
 Netdevice
 OID
 OIDs
@@ -80,14 +82,14 @@ lookup
 lookups
 loopback
 lossless
+mUI
+mV
 mcast
 metadata
 microburst
 millivolts
-mUI
 multi
 multicast
-mV
 netdev
 netdevs
 nexthop
@@ -109,6 +111,7 @@ struct
 sublayer
 subnet
 subnets
+timestamp
 tx
 uBurst
 uBursts
@@ -119,7 +122,6 @@ validonly
 versa
 vlan
 warmboot
+watchlist
 wildcard
 www
-timestamp
-watchlist