aboutsummaryrefslogtreecommitdiffstats
path: root/src/vpp-api/vom/types.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/vpp-api/vom/types.hpp')
-rw-r--r--src/vpp-api/vom/types.hpp408
1 files changed, 0 insertions, 408 deletions
diff --git a/src/vpp-api/vom/types.hpp b/src/vpp-api/vom/types.hpp
deleted file mode 100644
index 53654c51ac5..00000000000
--- a/src/vpp-api/vom/types.hpp
+++ /dev/null
@@ -1,408 +0,0 @@
-/*
- * Copyright (c) 2017 Cisco and/or its affiliates.
- * 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
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-#ifndef __VOM_TYPES_H__
-#define __VOM_TYPES_H__
-
-#include <array>
-#include <vector>
-
-#include <boost/asio/ip/address.hpp>
-
-#include "vom/enum_base.hpp"
-
-/**
- * Convenince wrapper macro for error handling in VAPI sends
- */
-#define VAPI_CALL(_stmt) \
- { \
- vapi_error_e _rv; \
- do { \
- _rv = (_stmt); \
- } while (VAPI_OK != _rv); \
- }
-
-namespace VOM {
-/**
- * There needs to be a strict order in which object types are read from VPP
- * (at boot time) and replayed to VPP (if VPP restarts). That ordering is
- * defined in this enum types
- */
-enum class dependency_t
-{
- /**
- * Global Configuration has no dependency
- */
- GLOBAL = 0,
-
- /**
- * interfaces are the root of the dependency graph
- */
- INTERFACE,
-
- /**
- * bond group binding is after interfaces but before
- * anything else
- */
- BOND_BINDING,
-
- /**
- * Tunnel or virtual interfaces next
- */
- TUNNEL,
-
- /**
- * Tables in which entries are added, e.g bridge/route-domains
- */
- TABLE,
-
- /**
- * ACLs
- */
- ACL,
-
- /**
- * Then L2/objects that bind to interfaces, BD, ACLS, etc
- */
- BINDING,
-
- /**
- * Entries in Tables
- */
- ENTRY,
-};
-
-/**
- * Error codes that VPP will return during a HW write
- */
-struct rc_t : public enum_base<rc_t>
-{
- rc_t(const rc_t& rc) = default;
-
- /**
- * Destructor
- */
- ~rc_t() = default;
-
- /**
- * The value un-set
- */
- const static rc_t UNSET;
-
- /**
- * The HW write/update action was/has not been attempted
- */
- const static rc_t NOOP;
-
- /**
- * The HW write was successfull
- */
- const static rc_t OK;
-
- /**
- * HW write reported invalid input
- */
- const static rc_t INVALID;
-
- /**
- * HW write timedout - VPP did not respond within a timely manner
- */
- const static rc_t TIMEOUT;
-
- /**
- * Get the rc_t from the VPP API value
- */
- static const rc_t& from_vpp_retval(int32_t rv);
-
-private:
- /**
- * Constructor
- */
- rc_t(int v, const std::string s);
-};
-
-/**
- * Feature Directions
- */
-struct direction_t : public enum_base<direction_t>
-{
- /**
- * Constructor
- */
- direction_t(int v, const std::string s);
-
- /**
- * Destructor
- */
- ~direction_t() = default;
-
- /**
- * Permit Direction
- */
- const static direction_t INPUT;
-
- /**
- * Deny Direction
- */
- const static direction_t OUTPUT;
-};
-
-/**
- * Output ostream for direction_t
- */
-std::ostream& operator<<(std::ostream& os, const direction_t& dir);
-
-/**
- * Feature Ethertype
- */
-struct ethertype_t : public enum_base<ethertype_t>
-{
- /**
- * Constructor
- */
- ethertype_t(int v, const std::string s);
-
- /**
- * Destructor
- */
- ~ethertype_t() = default;
-
- /**
- * Ethertype Arp
- */
- const static ethertype_t ARP;
-
- /**
- * Ethertype FCoE
- */
- const static ethertype_t FCOE;
-
- /**
- * Ethertype IPv4
- */
- const static ethertype_t IPV4;
-
- /**
- * Ethertype Ipv6
- */
- const static ethertype_t IPV6;
-
- /**
- * Ethertype MAC Security
- */
- const static ethertype_t MAC_SECURITY;
-
- /**
- * Ethertype MPLS unicast
- */
- const static ethertype_t MPLS_UNICAST;
-
- /**
- * Ethertype TRILL
- */
- const static ethertype_t TRILL;
-
- /**
- * Ethertype Unspecified
- */
- const static ethertype_t UNSPECIFIED;
-
- /**
- * Get the ethertype from the numeric value
- */
- static const ethertype_t& from_numeric_val(uint16_t numeric);
-};
-
-/**
- * Output ostream for ethertype_t
- */
-std::ostream& operator<<(std::ostream& os, const ethertype_t& eth);
-
-/**
- * A type declaration of an interface handle in VPP
- */
-struct handle_t
-{
- /**
- * Constructor
- */
- handle_t(int value);
-
- /**
- * Constructor
- */
- handle_t();
-
- /**
- * convert to string format for debug purposes
- */
- std::string to_string() const;
-
- /**
- * Comparison operator
- */
- bool operator==(const handle_t& other) const;
-
- /**
- * Comparison operator
- */
- bool operator!=(const handle_t& other) const;
-
- /**
- * less than operator
- */
- bool operator<(const handle_t& other) const;
-
- /**
- * A value of an interface handle_t that means the itf does not exist
- */
- const static handle_t INVALID;
-
- /**
- * get the value of the handle
- */
- uint32_t value() const;
-
- /**
- * reset the value of the handle to ~0
- */
- void reset();
-
-private:
- /**
- * VPP's handle value
- */
- uint32_t m_value;
-};
-
-/**
- * ostream print of a handle_t
- */
-std::ostream& operator<<(std::ostream& os, const handle_t& h);
-
-/**
- * Type def of a Ethernet address
- */
-struct mac_address_t
-{
- mac_address_t(uint8_t bytes[6]);
- mac_address_t(const std::string& str);
- mac_address_t(std::initializer_list<uint8_t> bytes);
- /**
- * Convert to byte array
- */
- void to_bytes(uint8_t* array, uint8_t len) const;
-
- /**
- * An all 1's MAC address
- */
- const static mac_address_t ONE;
-
- /**
- * An all 0's MAC address
- */
- const static mac_address_t ZERO;
-
- /**
- * Comparison operator
- */
- bool operator==(const mac_address_t& m) const;
-
- /**
- * less than operator
- */
- bool operator<(const mac_address_t& m) const;
-
- /**
- * String conversion
- */
- std::string to_string() const;
-
- /**
- * Underlying bytes array
- */
- std::array<uint8_t, 6> bytes;
-};
-
-/**
- * Type def of a L2 address as read from VPP
- */
-struct l2_address_t
-{
- l2_address_t(const uint8_t bytes[8], uint8_t n_bytes);
- l2_address_t(std::initializer_list<uint8_t> bytes);
- l2_address_t(const mac_address_t& mac);
-
- /**
- * Convert to byte array
- */
- void to_bytes(uint8_t* array, uint8_t len) const;
-
- /**
- * An all 1's L2 address
- */
- const static l2_address_t ONE;
-
- /**
- * An all 0's L2 address
- */
- const static l2_address_t ZERO;
-
- /**
- * Comparison operator
- */
- bool operator==(const l2_address_t& m) const;
-
- /**
- * Comparison operator
- */
- bool operator!=(const l2_address_t& m) const;
-
- /**
- * String conversion
- */
- std::string to_string() const;
-
- /**
- * MAC address conversion
- */
- mac_address_t to_mac() const;
-
- /**
- * Underlying bytes array - filled from least to most significant
- */
- std::vector<uint8_t> bytes;
-};
-
-/**
- * Ostream operator for a MAC address
- */
-std::ostream& operator<<(std::ostream& os, const mac_address_t& mac);
-
-/**
- * Ostream operator for a MAC address
- */
-std::ostream& operator<<(std::ostream& os, const l2_address_t& l2);
-};
-
-/*
- * fd.io coding-style-patch-verification: ON
- *
- * Local Variables:
- * eval: (c-set-style "mozilla")
- * End:
- */
-
-#endif