[spp] [PATCH 06/23] spp_vf: move defines to common dir

[x-fn-spp@sl.ntt-tx.co.jp]

From: Hideyuki Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>

Move defines of consts, enums and structs of spp_vf and spp_mirror
common directory.

Signed-off-by: Hideyuki Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>
Signed-off-by: Naoki Takada <takada.naoki@lab.ntt.co.jp>
---
 src/vf/common/spp_proc.h | 309 ++++++++++++++++++++++++++++++++++++++-
 src/vf/spp_vf.c          |  88 -----------
 src/vf/spp_vf.h          | 196 -------------------------
 3 files changed, 307 insertions(+), 286 deletions(-)

diff --git a/src/vf/common/spp_proc.h b/src/vf/common/spp_proc.h
index 125af52..f90b2ac 100644
--- a/src/vf/common/spp_proc.h
+++ b/src/vf/common/spp_proc.h
@@ -16,8 +16,313 @@
 #include "common.h"
 
 /**
- * Make a hexdump of an array data in every 4 byte.
- * This function is used to dump core_info or component info.
+ * TODO(Yamashita) change type names.
+ *  "merge" -> "merger", "forward" -> "forwarder".
+ */
+/** Identifier string for each component (status command) */
+#define SPP_TYPE_CLASSIFIER_MAC_STR "classifier_mac"
+#define SPP_TYPE_MERGE_STR          "merge"
+#define SPP_TYPE_FORWARD_STR        "forward"
+#define SPP_TYPE_UNUSE_STR          "unuse"
+
+/** Identifier string for each interface */
+#define SPP_IFTYPE_NIC_STR   "phy"
+#define SPP_IFTYPE_VHOST_STR "vhost"
+#define SPP_IFTYPE_RING_STR  "ring"
+
+/** Update wait timer (micro sec) */
+#define SPP_CHANGE_UPDATE_INTERVAL 10
+
+/** The max number of buffer for management */
+#define SPP_INFO_AREA_MAX 2
+
+/** The length of shortest character string */
+#define SPP_MIN_STR_LEN   32
+
+/** The length of NAME string */
+#define SPP_NAME_STR_LEN  128
+
+/** Maximum number of port abilities available */
+#define SPP_PORT_ABILITY_MAX 4
+
+/** Number of VLAN ID */
+#define SPP_NUM_VLAN_VID 4096
+
+/** Maximum VLAN PCP */
+#define SPP_VLAN_PCP_MAX 7
+
+/* Max number of core status check */
+#define SPP_CORE_STATUS_CHECK_MAX 5
+
+/** Character sting for default port of classifier */
+#define SPP_DEFAULT_CLASSIFIED_SPEC_STR     "default"
+
+/** Value for default MAC address of classifier */
+#define SPP_DEFAULT_CLASSIFIED_DMY_ADDR     0x010000000000
+
+/** Character sting for default MAC address of classifier */
+#define SPP_DEFAULT_CLASSIFIED_DMY_ADDR_STR "00:00:00:00:00:01"
+
+/* Sampling interval timer for latency evaluation */
+#define SPP_RING_LATENCY_STATS_SAMPLING_INTERVAL 1000000
+
+/**
+ * TODO(Yamashita) change type names.
+ *  "merge" -> "merger", "forward" -> "forwarder".
+ */
+/* Name string for each component */
+#define CORE_TYPE_CLASSIFIER_MAC_STR "classifier_mac"
+#define CORE_TYPE_MERGE_STR          "merge"
+#define CORE_TYPE_FORWARD_STR        "forward"
+
+/* State on component */
+enum spp_core_status {
+	SPP_CORE_UNUSE,        /**< Not used */
+	SPP_CORE_STOP,         /**< Stopped */
+	SPP_CORE_IDLE,         /**< Idling */
+	SPP_CORE_FORWARD,      /**< Forwarding  */
+	SPP_CORE_STOP_REQUEST, /**< Request stopping */
+	SPP_CORE_IDLE_REQUEST /**< Request idling */
+};
+
+/* Process type for each component */
+enum spp_component_type {
+	SPP_COMPONENT_UNUSE,          /**< Not used */
+	SPP_COMPONENT_CLASSIFIER_MAC, /**< Classifier_mac */
+	SPP_COMPONENT_MERGE,          /**< Merger */
+	SPP_COMPONENT_FORWARD,        /**< Forwarder */
+};
+
+/* Classifier Type */
+enum spp_classifier_type {
+	SPP_CLASSIFIER_TYPE_NONE, /**< Type none */
+	SPP_CLASSIFIER_TYPE_MAC,  /**< MAC address */
+	SPP_CLASSIFIER_TYPE_VLAN  /**< VLAN ID */
+};
+
+enum spp_return_value {
+	SPP_RET_OK = 0,  /**< succeeded */
+	SPP_RET_NG = -1, /**< failed */
+};
+
+/**
+ * Port type (rx or tx) to indicate which direction packet goes
+ * (e.g. receiving or transmitting)
+ */
+enum spp_port_rxtx {
+	SPP_PORT_RXTX_NONE, /**< none */
+	SPP_PORT_RXTX_RX,   /**< rx port */
+	SPP_PORT_RXTX_TX,   /**< tx port */
+	SPP_PORT_RXTX_ALL,  /**< rx/tx port */
+};
+
+/**
+ * Port ability operation which indicates vlan tag operation on the port
+ * (e.g. add vlan tag or delete vlan tag)
+ */
+enum spp_port_ability_ope {
+	SPP_PORT_ABILITY_OPE_NONE,	  /**< none */
+	SPP_PORT_ABILITY_OPE_ADD_VLANTAG, /**< add VLAN tag */
+	SPP_PORT_ABILITY_OPE_DEL_VLANTAG, /**< delete VLAN tag */
+};
+
+/* getopt_long return value for long option */
+enum SPP_LONGOPT_RETVAL {
+	SPP_LONGOPT_RETVAL__ = 127,
+
+	/*
+	 * Return value definition for getopt_long()
+	 * Only for long option
+	 */
+	SPP_LONGOPT_RETVAL_CLIENT_ID,   /* --client-id    */
+	SPP_LONGOPT_RETVAL_VHOST_CLIENT /* --vhost-client */
+};
+
+/* Flag of processing type to copy management information */
+enum copy_mng_flg {
+	COPY_MNG_FLG_NONE,
+	COPY_MNG_FLG_UPDCOPY,
+	COPY_MNG_FLG_ALLCOPY,
+};
+
+/**
+ * Interface information structure
+ */
+struct spp_port_index {
+	enum port_type  iface_type; /**< Interface type (phy/vhost/ring) */
+	int             iface_no;   /**< Interface number */
+};
+
+/** VLAN tag information */
+struct spp_vlantag_info {
+	int vid; /**< VLAN ID */
+	int pcp; /**< Priority Code Point */
+	int tci; /**< Tag Control Information */
+};
+
+/**
+ * Data for each port ability which indicates vlantag related information
+ * for the port
+ */
+union spp_ability_data {
+	/** VLAN tag information */
+	struct spp_vlantag_info vlantag;
+};
+
+/** Port ability information */
+struct spp_port_ability {
+	enum spp_port_ability_ope ope; /**< Operation */
+	enum spp_port_rxtx rxtx;       /**< rx/tx identifier */
+	union spp_ability_data data;   /**< Port ability data */
+};
+
+/** Port class identifier for classifying */
+struct spp_port_class_identifier {
+	uint64_t mac_addr;                      /**< Mac address (binary) */
+	char     mac_addr_str[SPP_MIN_STR_LEN]; /**< Mac address (text) */
+	struct spp_vlantag_info vlantag;        /**< VLAN tag information */
+};
+
+/* Port info */
+struct spp_port_info {
+	enum port_type iface_type;      /**< Interface type (phy/vhost/ring) */
+	int            iface_no;        /**< Interface number */
+	int            dpdk_port;       /**< DPDK port number */
+	struct spp_port_class_identifier class_id;
+					/**< Port class identifier */
+	struct spp_port_ability ability[SPP_PORT_ABILITY_MAX];
+					/**< Port ability */
+};
+
+/* Component info */
+struct spp_component_info {
+	char name[SPP_NAME_STR_LEN];	/**< Component name */
+	enum spp_component_type type;	/**< Component type */
+	unsigned int lcore_id;		/**< Logical core ID for component */
+	int component_id;		/**< Component ID */
+	int num_rx_port;		/**< The number of rx ports */
+	int num_tx_port;		/**< The number of tx ports */
+	struct spp_port_info *rx_ports[RTE_MAX_ETHPORTS];
+					/**< Array of pointers to rx ports */
+	struct spp_port_info *tx_ports[RTE_MAX_ETHPORTS];
+					/**< Array of pointers to tx ports */
+};
+
+/* Manage given options as global variable */
+struct startup_param {
+	int client_id;		/* Client ID */
+	char server_ip[INET_ADDRSTRLEN];
+				/* IP address stiring of spp-ctl */
+	int server_port;	/* Port Number of spp-ctl */
+	int vhost_client;	/* Flag for --vhost-client option */
+};
+
+/* Manage number of interfaces  and port information as global variable */
+struct iface_info {
+	int num_nic;		/* The number of phy */
+	int num_vhost;		/* The number of vhost */
+	int num_ring;		/* The number of ring */
+	struct spp_port_info nic[RTE_MAX_ETHPORTS];
+				/* Port information of phy */
+	struct spp_port_info vhost[RTE_MAX_ETHPORTS];
+				/* Port information of vhost */
+	struct spp_port_info ring[RTE_MAX_ETHPORTS];
+				/* Port information of ring */
+};
+
+/* Manage component running in core as global variable */
+struct core_info {
+	volatile enum spp_component_type type;
+			       /* Component type */
+	int num;	       /* The number of IDs below */
+	int id[RTE_MAX_LCORE]; /* ID list of components executed on cpu core */
+};
+
+/* Manage core status and component information as global variable */
+struct core_mng_info {
+	/* Status of cpu core */
+	volatile enum spp_core_status status;
+
+	/* Index number of core information for reference */
+	volatile int ref_index;
+
+	/* Index number of core information for updating */
+	volatile int upd_index;
+
+	/* Core information of each cpu core */
+	struct core_info core[SPP_INFO_AREA_MAX];
+};
+
+/* Manage data to be backup */
+struct cancel_backup_info {
+	/* Backup data of core information */
+	struct core_mng_info core[RTE_MAX_LCORE];
+
+	/* Backup data of component information */
+	struct spp_component_info component[RTE_MAX_LCORE];
+
+	/* Backup data of interface information */
+	struct iface_info interface;
+};
+
+struct spp_iterate_core_params;
+/**
+ * definition of iterated core element procedure function
+ * which is member of spp_iterate_core_params structure.
+ * Above structure is used when listing core information
+ * (e.g) create resonse to status command.
+ */
+typedef int (*spp_iterate_core_element_proc)(
+		struct spp_iterate_core_params *params,
+		const unsigned int lcore_id,
+		const char *name,
+		const char *type,
+		const int num_rx,
+		const struct spp_port_index *rx_ports,
+		const int num_tx,
+		const struct spp_port_index *tx_ports);
+
+/**
+ * iterate core table parameters which is
+ * used when listing core table content
+ * (e.g.) create response to status command.
+ */
+struct spp_iterate_core_params {
+	/** Output buffer */
+	char *output;
+
+	/** The function for creating core information */
+	spp_iterate_core_element_proc element_proc;
+};
+
+struct spp_iterate_classifier_table_params;
+/**
+ * definition of iterated classifier element procedure function
+ * which is member of spp_iterate_classifier_table_params structure.
+ * Above structure is used when listing classifier table information
+ * (e.g) create resonse to status command.
+ */
+typedef int (*spp_iterate_classifier_element_proc)(
+		struct spp_iterate_classifier_table_params *params,
+		enum spp_classifier_type type,
+		int vid, const char *mac,
+		const struct spp_port_index *port);
+
+/**
+ * iterate classifier table parameters which is
+ * used when listing classifier table content
+ * (e.g.) create response to status command.
+ */
+struct spp_iterate_classifier_table_params {
+	/* Output buffer */
+	void *output;
+
+	/* The function for creating classifier table information */
+	spp_iterate_classifier_element_proc element_proc;
+};
+
+/**
+ * Make a hexdump of an array data in every 4 byte
  *
  * @param name
  *  dump name.
diff --git a/src/vf/spp_vf.c b/src/vf/spp_vf.c
index accef02..62ceb20 100644
--- a/src/vf/spp_vf.c
+++ b/src/vf/spp_vf.c
@@ -18,94 +18,6 @@
 #include "command_proc.h"
 #include "spp_port.h"
 
-/* Max number of core status check */
-#define SPP_CORE_STATUS_CHECK_MAX 5
-
-/* Sampling interval timer for latency evaluation */
-#define SPP_RING_LATENCY_STATS_SAMPLING_INTERVAL 1000000
-
-/* Name string for each component */
-#define CORE_TYPE_CLASSIFIER_MAC_STR "classifier_mac"
-#define CORE_TYPE_MERGE_STR          "merge"
-#define CORE_TYPE_FORWARD_STR        "forward"
-
-/* getopt_long return value for long option */
-enum SPP_LONGOPT_RETVAL {
-	SPP_LONGOPT_RETVAL__ = 127,
-
-	/*
-	 * Return value definition for getopt_long()
-	 * Only for long option
-	 */
-	SPP_LONGOPT_RETVAL_CLIENT_ID,   /* --client-id    */
-	SPP_LONGOPT_RETVAL_VHOST_CLIENT /* --vhost-client */
-};
-
-/* Flag of processing type to copy management information */
-enum copy_mng_flg {
-	COPY_MNG_FLG_NONE,
-	COPY_MNG_FLG_UPDCOPY,
-	COPY_MNG_FLG_ALLCOPY,
-};
-
-/* Manage given options as global variable */
-struct startup_param {
-	int client_id;          /* Client ID of spp_vf */
-	char server_ip[INET_ADDRSTRLEN];
-				/* IP address sting of spp controller */
-	int server_port;        /* Port Number of spp controller */
-	int vhost_client;       /* Flag for --vhost-client option */
-};
-
-/* Manage number of interfaces  and port information as global variable */
-struct iface_info {
-	int num_nic;            /* The number of phy */
-	int num_vhost;          /* The number of vhost */
-	int num_ring;           /* The number of ring */
-	struct spp_port_info nic[RTE_MAX_ETHPORTS];
-				/* Port information of phy */
-	struct spp_port_info vhost[RTE_MAX_ETHPORTS];
-				/* Port information of vhost */
-	struct spp_port_info ring[RTE_MAX_ETHPORTS];
-				/* Port information of ring */
-};
-
-/* Manage component running in core as global variable */
-struct core_info {
-	volatile enum spp_component_type type;
-				/* Component type */
-	int num;                /* The number of IDs below */
-	int id[RTE_MAX_LCORE];
-			/* ID list of components executed on cpu core */
-};
-
-/* Manage core status and component information as global variable */
-struct core_mng_info {
-	/* Status of cpu core */
-	volatile enum spp_core_status status;
-
-	/* Index number of core information for reference */
-	volatile int ref_index;
-
-	/* Index number of core information for updating */
-	volatile int upd_index;
-
-	/* Core information of each cpu core */
-	struct core_info core[SPP_INFO_AREA_MAX];
-};
-
-/* Manage data to be backup */
-struct cancel_backup_info {
-	/* Backup data of core information */
-	struct core_mng_info core[RTE_MAX_LCORE];
-
-	/* Backup data of component information */
-	struct spp_component_info component[RTE_MAX_LCORE];
-
-	/* Backup data of interface information */
-	struct iface_info interface;
-};
-
 /* Declare global variables */
 /* Logical core ID for main process */
 static unsigned int g_main_lcore_id = 0xffffffff;
diff --git a/src/vf/spp_vf.h b/src/vf/spp_vf.h
index 5586207..1d05e66 100644
--- a/src/vf/spp_vf.h
+++ b/src/vf/spp_vf.h
@@ -15,99 +15,9 @@
 
 #include "common.h"
 
-/** Identifier string for each component (status command) @{*/
-#define SPP_TYPE_CLASSIFIER_MAC_STR "classifier_mac"
-#define SPP_TYPE_MERGE_STR          "merge"
-#define SPP_TYPE_FORWARD_STR        "forward"
-#define SPP_TYPE_UNUSE_STR          "unuse"
-/**@}*/
-
-/** Identifier string for each interface @{*/
-#define SPP_IFTYPE_NIC_STR   "phy"
-#define SPP_IFTYPE_VHOST_STR "vhost"
-#define SPP_IFTYPE_RING_STR  "ring"
-/**@}*/
-
 /** The max number of client ID */
 #define SPP_CLIENT_MAX    128
 
-/** The max number of buffer for management */
-#define SPP_INFO_AREA_MAX 2
-
-/** The length of shortest character string */
-#define SPP_MIN_STR_LEN   32
-
-/** The length of NAME string */
-#define SPP_NAME_STR_LEN  128
-
-/** Update wait timer (micro sec) */
-#define SPP_CHANGE_UPDATE_INTERVAL 10
-
-/** Character sting for default port of classifier */
-#define SPP_DEFAULT_CLASSIFIED_SPEC_STR     "default"
-
-/** Character sting for default MAC address of classifier */
-#define SPP_DEFAULT_CLASSIFIED_DMY_ADDR_STR "00:00:00:00:00:01"
-
-/** Value for default MAC address of classifier */
-#define SPP_DEFAULT_CLASSIFIED_DMY_ADDR     0x010000000000
-
-/** Maximum number of port abilities available */
-#define SPP_PORT_ABILITY_MAX 4
-
-/** Number of VLAN ID */
-#define SPP_NUM_VLAN_VID 4096
-
-/** Maximum VLAN PCP */
-#define SPP_VLAN_PCP_MAX 7
-
-/**
- * State on component
- */
-enum spp_core_status {
-	SPP_CORE_UNUSE,        /**< Not used */
-	SPP_CORE_STOP,         /**< Stopped */
-	SPP_CORE_IDLE,         /**< Idling */
-	SPP_CORE_FORWARD,      /**< Forwarding  */
-	SPP_CORE_STOP_REQUEST, /**< Request stopping */
-	SPP_CORE_IDLE_REQUEST  /**< Request idling */
-};
-
-/**
- * Process type for each component
- */
-enum spp_component_type {
-	SPP_COMPONENT_UNUSE,          /**< Not used */
-	SPP_COMPONENT_CLASSIFIER_MAC, /**< Classifier_mac */
-	SPP_COMPONENT_MERGE,          /**< Merger */
-	SPP_COMPONENT_FORWARD,        /**< Forwarder */
-};
-
-/**
- * Classifier Type
- */
-enum spp_classifier_type {
-	SPP_CLASSIFIER_TYPE_NONE, /**< Type none */
-	SPP_CLASSIFIER_TYPE_MAC,  /**< MAC address */
-	SPP_CLASSIFIER_TYPE_VLAN  /**< VLAN ID */
-};
-
-/**
- * API Return value
- */
-enum spp_return_value {
-	SPP_RET_OK = 0,  /**< succeeded */
-	SPP_RET_NG = -1, /**< failed */
-};
-
-/** Port type (rx or tx) */
-enum spp_port_rxtx {
-	SPP_PORT_RXTX_NONE, /**< none */
-	SPP_PORT_RXTX_RX,   /**< rx port */
-	SPP_PORT_RXTX_TX,   /**< tx port */
-	SPP_PORT_RXTX_ALL,  /**< rx/tx port */
-};
-
 /** command setting type */
 enum spp_command_action {
 	SPP_CMD_ACTION_NONE,  /**< none */
@@ -117,77 +27,6 @@ enum spp_command_action {
 	SPP_CMD_ACTION_DEL,   /**< delete */
 };
 
-/** Port ability operation */
-enum spp_port_ability_ope {
-	SPP_PORT_ABILITY_OPE_NONE,        /**< none */
-	SPP_PORT_ABILITY_OPE_ADD_VLANTAG, /**< add VLAN tag */
-	SPP_PORT_ABILITY_OPE_DEL_VLANTAG, /**< delete VLAN tag */
-};
-
-/**
- * Interface information structure
- */
-struct spp_port_index {
-	enum port_type  iface_type; /**< Interface type (phy/vhost/ring) */
-	int             iface_no;   /**< Interface number */
-};
-
-/** VLAN tag information */
-struct spp_vlantag_info {
-	int vid; /**< VLAN ID */
-	int pcp; /**< Priority Code Point */
-	int tci; /**< Tag Control Information */
-};
-
-/** Data for each port ability */
-union spp_ability_data {
-	/** VLAN tag information */
-	struct spp_vlantag_info vlantag;
-};
-
-/** Port ability information */
-struct spp_port_ability {
-	enum spp_port_ability_ope ope; /**< Operation */
-	enum spp_port_rxtx rxtx;       /**< rx/tx identifier */
-	union spp_ability_data data;   /**< Port ability data */
-};
-
-/** Port class identifier for classifying */
-struct spp_port_class_identifier {
-	uint64_t mac_addr;                      /**< Mac address (binary) */
-	char     mac_addr_str[SPP_MIN_STR_LEN]; /**< Mac address (text) */
-	struct spp_vlantag_info vlantag;        /**< VLAN tag information */
-};
-
-/**
- * Port info
- */
-struct spp_port_info {
-	enum port_type iface_type;      /**< Interface type (phy/vhost/ring) */
-	int            iface_no;        /**< Interface number */
-	int            dpdk_port;       /**< DPDK port number */
-	struct spp_port_class_identifier class_id;
-					/**< Port class identifier */
-	struct spp_port_ability ability[SPP_PORT_ABILITY_MAX];
-					/**< Port ability */
-};
-
-/**
- * Component info
- */
-struct spp_component_info {
-	char name[SPP_NAME_STR_LEN];    /**< Component name */
-	enum spp_component_type type;   /**< Component type */
-	unsigned int lcore_id;          /**< Logical core ID for component */
-	int component_id;               /**< Component ID */
-	int num_rx_port;                /**< The number of rx ports */
-	int num_tx_port;                /**< The number of tx ports */
-	struct spp_port_info *rx_ports[RTE_MAX_ETHPORTS];
-					/**< Array of pointers to rx ports */
-	struct spp_port_info *tx_ports[RTE_MAX_ETHPORTS];
-					/**< Array of pointers to tx ports */
-};
-
 /**
  * Get client ID
  *
@@ -267,27 +106,6 @@ int spp_update_port(
  */
 int spp_flush(void);
 
-struct spp_iterate_core_params;
-/** definition of iterated core element procedure function */
-typedef int (*spp_iterate_core_element_proc)(
-		struct spp_iterate_core_params *params,
-		const unsigned int lcore_id,
-		const char *name,
-		const char *type,
-		const int num_rx,
-		const struct spp_port_index *rx_ports,
-		const int num_tx,
-		const struct spp_port_index *tx_ports);
-
-/** iterate core information parameters */
-struct spp_iterate_core_params {
-	/** Output buffer */
-	char *output;
-
-	/** The function for creating core information */
-	spp_iterate_core_element_proc element_proc;
-};
-
 /**
  * Iterate core information
  *
@@ -300,20 +118,6 @@ struct spp_iterate_core_params {
  */
 int spp_iterate_core_info(struct spp_iterate_core_params *params);
 
-struct spp_iterate_classifier_table_params;
-/** definition of iterated classifier element procedure function */
-typedef int (*spp_iterate_classifier_element_proc)(
-		struct spp_iterate_classifier_table_params *params,
-		enum spp_classifier_type type,
-		int vid, const char *mac,
-		const struct spp_port_index *port);
-
-/** iterate classifier table parameters */
-struct spp_iterate_classifier_table_params {
-	void *output;
-	spp_iterate_classifier_element_proc element_proc;
-};
-
 /**
  * Iterate Classifier_table
  *
-- 
2.18.0