ip: Protocol Independent IP Neighbors

[vpp.git] / src / vnet / ip-neighbor / ip_neighbor_types.h

diff --git a/src/vnet/ip-neighbor/ip_neighbor_types.h b/src/vnet/ip-neighbor/ip_neighbor_types.h
new file mode 100644 (file)
index 0000000..c6d4e10
--- /dev/null
+++ b/src/vnet/ip-neighbor/ip_neighbor_types.h
@@ -0,0 +1,127 @@
+/*
+ * ip_neighbor.h: ip neighbor generic services
+ *
+ * Copyright (c) 2018 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 __INCLUDE_IP_NEIGHBOR_TYPES_H__
+#define __INCLUDE_IP_NEIGHBOR_TYPES_H__
+
+#include <vnet/ip/ip6_packet.h>
+#include <vnet/ethernet/mac_address.h>
+#include <vnet/fib/fib_types.h>
+
+#define IP_SCAN_DISABLED       0
+#define IP_SCAN_V4_NEIGHBORS   (1 << 0)
+#define IP_SCAN_V6_NEIGHBORS   (1 << 1)
+#define IP_SCAN_V46_NEIGHBORS  (IP_SCAN_V4_NEIGHBORS | IP_SCAN_V6_NEIGHBORS)
+
+typedef struct
+{
+  u8 mode;                     /* 0: disable, 1: ip4, 2: ip6, 3: both */
+  u8 scan_interval;            /* neighbor scan interval in minutes */
+  u8 max_proc_time;            /* max processing time per run, in usecs */
+  u8 max_update;               /* max probe/delete operations per run */
+  u8 scan_int_delay;           /* delay in msecs, to resume scan on max */
+  u8 stale_threshold;          /* Threshold in minutes to delete nei entry */
+} ip_neighbor_scan_arg_t;
+
+typedef enum ip_neighbor_flags_t_
+{
+  IP_NEIGHBOR_FLAG_NONE = 0,
+  IP_NEIGHBOR_FLAG_STATIC = (1 << 0),
+  IP_NEIGHBOR_FLAG_DYNAMIC = (1 << 1),
+  IP_NEIGHBOR_FLAG_NO_FIB_ENTRY = (1 << 2),
+  IP_NEIGHBOR_FLAG_PENDING = (1 << 3),
+} __attribute__ ((packed)) ip_neighbor_flags_t;
+
+typedef struct ip_neighbor_watcher_t_
+{
+  u32 ipw_pid;
+  u32 ipw_client;
+} ip_neighbor_watcher_t;
+
+extern u8 *format_ip_neighbor_watcher (u8 * s, va_list * args);
+
+typedef struct ip_neighbor_key_t_
+{
+  ip46_address_t ipnk_ip;
+  ip46_type_t ipnk_type;
+  u32 ipnk_sw_if_index;
+} ip_neighbor_key_t;
+
+/**
+ * A representation of an IP neighbour/peer
+ */
+typedef struct ip_neighbor_t_
+{
+  /**
+   * The idempotent key
+   */
+  ip_neighbor_key_t *ipn_key;
+
+  /**
+   * The learned MAC address of the neighbour
+   */
+  mac_address_t ipn_mac;
+
+  /**
+   * Falgs for this object
+   */
+  ip_neighbor_flags_t ipn_flags;
+
+  /**
+   * Aging related data
+   *  - last time the neighbour was probed
+   *  - number of probes - 3 and it's dead
+   */
+  f64 ipn_time_last_updated;
+  u8 ipn_n_probes;
+  index_t ipn_elt;
+
+  /**
+   * The index of the adj fib created for this neighbour
+   */
+  fib_node_index_t ipn_fib_entry_index;
+} ip_neighbor_t;
+
+extern u8 *format_ip_neighbor_flags (u8 * s, va_list * args);
+extern u8 *format_ip_neighbor_key (u8 * s, va_list * args);
+extern u8 *format_ip_neighbor (u8 * s, va_list * args);
+
+extern ip_neighbor_t *ip_neighbor_get (index_t ipni);
+
+typedef struct ip_neighbor_learn_t_
+{
+  ip46_address_t ip;
+  ip46_type_t type;
+  mac_address_t mac;
+  u32 sw_if_index;
+} ip_neighbor_learn_t;
+
+typedef struct ip_neighbor_event_t_
+{
+  ip_neighbor_watcher_t ipne_watch;
+  index_t ipne_index;
+} ip_neighbor_event_t;
+
+#endif /* __INCLUDE_IP_NEIGHBOR_H__ */
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */