ethdev: rename and extend the mirror type
authorJingjing Wu <jingjing.wu@intel.com>
Wed, 10 Jun 2015 06:24:31 +0000 (14:24 +0800)
committerThomas Monjalon <thomas.monjalon@6wind.com>
Tue, 7 Jul 2015 15:45:45 +0000 (17:45 +0200)
This path renames the mirror type in rte_eth_mirror_conf and macros,
and rework the mirror set in ixgbe drivers by using new definition.
It also fixes some coding style.

Test report: http://dpdk.org/ml/archives/dev/2015-June/019118.html

Signed-off-by: Jingjing Wu <jingjing.wu@intel.com>
Acked-by: Jijiang Liu <jijiang.liu@intel.com>
Acked-by: Helin Zhang <helin.zhang@intel.com>
app/test-pmd/cmdline.c
doc/guides/testpmd_app_ug/testpmd_funcs.rst
drivers/net/ixgbe/ixgbe_ethdev.c
lib/librte_ether/rte_ethdev.c
lib/librte_ether/rte_ethdev.h

index aa37a8c..0e8e579 100644 (file)
@@ -412,7 +412,7 @@ static void cmd_help_long_parsed(void *parsed_result,
                        "    Set rate limit for queues in VF of a port\n\n"
 
                        "set port (port_id) mirror-rule (rule_id)"
-                       "(pool-mirror|vlan-mirror)\n"
+                       " (pool-mirror-up|pool-mirror-down|vlan-mirror)"
                        " (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)\n"
                        "   Set pool or vlan type mirror rule on a port.\n"
                        "   e.g., 'set port 0 mirror-rule 0 vlan-mirror 0,1"
@@ -6647,7 +6647,8 @@ cmdline_parse_token_num_t cmd_mirror_mask_ruleid =
                                rule_id, UINT8);
 cmdline_parse_token_string_t cmd_mirror_mask_what =
        TOKEN_STRING_INITIALIZER(struct cmd_set_mirror_mask_result,
-                               what, "pool-mirror#vlan-mirror");
+                               what, "pool-mirror-up#pool-mirror-down"
+                                     "#vlan-mirror");
 cmdline_parse_token_string_t cmd_mirror_mask_value =
        TOKEN_STRING_INITIALIZER(struct cmd_set_mirror_mask_result,
                                value, NULL);
@@ -6676,13 +6677,16 @@ cmd_set_mirror_mask_parsed(void *parsed_result,
 
        mr_conf.dst_pool = res->dstpool_id;
 
-       if (!strcmp(res->what, "pool-mirror")) {
-               mr_conf.pool_mask = strtoull(res->value,NULL,16);
-               mr_conf.rule_type_mask = ETH_VMDQ_POOL_MIRROR;
-       } else if(!strcmp(res->what, "vlan-mirror")) {
-               mr_conf.rule_type_mask = ETH_VMDQ_VLAN_MIRROR;
-               nb_item = parse_item_list(res->value, "core",
-                                       ETH_MIRROR_MAX_VLANS, vlan_list, 1);
+       if (!strcmp(res->what, "pool-mirror-up")) {
+               mr_conf.pool_mask = strtoull(res->value, NULL, 16);
+               mr_conf.rule_type = ETH_MIRROR_VIRTUAL_POOL_UP;
+       } else if (!strcmp(res->what, "pool-mirror-down")) {
+               mr_conf.pool_mask = strtoull(res->value, NULL, 16);
+               mr_conf.rule_type = ETH_MIRROR_VIRTUAL_POOL_DOWN;
+       } else if (!strcmp(res->what, "vlan-mirror")) {
+               mr_conf.rule_type = ETH_MIRROR_VLAN;
+               nb_item = parse_item_list(res->value, "vlan",
+                               ETH_MIRROR_MAX_VLANS, vlan_list, 1);
                if (nb_item <= 0)
                        return;
 
@@ -6697,21 +6701,21 @@ cmd_set_mirror_mask_parsed(void *parsed_result,
                }
        }
 
-       if(!strcmp(res->on, "on"))
+       if (!strcmp(res->on, "on"))
                ret = rte_eth_mirror_rule_set(res->port_id, &mr_conf,
                                                res->rule_id, 1);
        else
                ret = rte_eth_mirror_rule_set(res->port_id, &mr_conf,
                                                res->rule_id, 0);
-       if(ret < 0)
+       if (ret < 0)
                printf("mirror rule add error: (%s)\n", strerror(-ret));
 }
 
 cmdline_parse_inst_t cmd_set_mirror_mask = {
                .f = cmd_set_mirror_mask_parsed,
                .data = NULL,
-               .help_str = "set port X mirror-rule Y pool-mirror|vlan-mirror "
-                               "pool_mask|vlan_id[,vlan_id]* dst-pool Z on|off",
+               .help_str = "set port X mirror-rule Y pool-mirror-up|pool-mirror-down|vlan-mirror"
+                           pool_mask|vlan_id[,vlan_id]* dst-pool Z on|off",
                .tokens = {
                        (void *)&cmd_mirror_mask_set,
                        (void *)&cmd_mirror_mask_port,
@@ -6778,14 +6782,14 @@ cmd_set_mirror_link_parsed(void *parsed_result,
        struct rte_eth_mirror_conf mr_conf;
 
        memset(&mr_conf, 0, sizeof(struct rte_eth_mirror_conf));
-       if(!strcmp(res->what, "uplink-mirror")) {
-               mr_conf.rule_type_mask = ETH_VMDQ_UPLINK_MIRROR;
-       }else if(!strcmp(res->what, "downlink-mirror"))
-               mr_conf.rule_type_mask = ETH_VMDQ_DOWNLIN_MIRROR;
+       if (!strcmp(res->what, "uplink-mirror"))
+               mr_conf.rule_type = ETH_MIRROR_UPLINK_PORT;
+       else
+               mr_conf.rule_type = ETH_MIRROR_DOWNLINK_PORT;
 
        mr_conf.dst_pool = res->dstpool_id;
 
-       if(!strcmp(res->on, "on"))
+       if (!strcmp(res->on, "on"))
                ret = rte_eth_mirror_rule_set(res->port_id, &mr_conf,
                                                res->rule_id, 1);
        else
@@ -6793,7 +6797,7 @@ cmd_set_mirror_link_parsed(void *parsed_result,
                                                res->rule_id, 0);
 
        /* check the return value and print it if is < 0 */
-       if(ret < 0)
+       if (ret < 0)
                printf("mirror rule add error: (%s)\n", strerror(-ret));
 
 }
index f1fa523..9ca0b38 100644 (file)
@@ -782,9 +782,13 @@ set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
 set port - mirror rule
 ~~~~~~~~~~~~~~~~~~~~~~
 
-Set port or vlan type mirror rule for a port.
+Set pool or vlan type mirror rule for a port:
 
-set port (port_id) mirror-rule (rule_id) (pool-mirror|vlan-mirror) (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)
+set port (port_id) mirror-rule (rule_id) (pool-mirror-up|pool-mirror-down|vlan-mirror) (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)
+
+Set link mirror rule for a port:
+
+set port (port_id) mirror-rule (rule_id) (uplink-mirror|downlink-mirror) dst-pool (pool_id) (on|off)
 
 For example to enable mirror traffic with vlan 0,1 to pool 0:
 
index deb4423..0638302 100644 (file)
@@ -3414,6 +3414,14 @@ ixgbe_set_pool_vlan_filter(struct rte_eth_dev *dev, uint16_t vlan,
        return ret;
 }
 
+#define IXGBE_MRCTL_VPME  0x01 /* Virtual Pool Mirroring. */
+#define IXGBE_MRCTL_UPME  0x02 /* Uplink Port Mirroring. */
+#define IXGBE_MRCTL_DPME  0x04 /* Downlink Port Mirroring. */
+#define IXGBE_MRCTL_VLME  0x08 /* VLAN Mirroring. */
+#define IXGBE_INVALID_MIRROR_TYPE(mirror_type) \
+       ((mirror_type) & ~(uint8_t)(ETH_MIRROR_VIRTUAL_POOL_UP | \
+       ETH_MIRROR_UPLINK_PORT | ETH_MIRROR_DOWNLINK_PORT | ETH_MIRROR_VLAN))
+
 static int
 ixgbe_mirror_rule_set(struct rte_eth_dev *dev,
                        struct rte_eth_mirror_conf *mirror_conf,
@@ -3438,6 +3446,7 @@ ixgbe_mirror_rule_set(struct rte_eth_dev *dev,
                        (IXGBE_DEV_PRIVATE_TO_PFDATA(dev->data->dev_private));
        struct ixgbe_hw *hw =
                IXGBE_DEV_PRIVATE_TO_HW(dev->data->dev_private);
+       uint8_t mirror_type = 0;
 
        if (ixgbe_vmdq_mode_check(hw) < 0)
                return -ENOTSUP;
@@ -3445,28 +3454,29 @@ ixgbe_mirror_rule_set(struct rte_eth_dev *dev,
        if (rule_id >= IXGBE_MAX_MIRROR_RULES)
                return -EINVAL;
 
-       /* Check if vlan mask is valid */
-       if ((mirror_conf->rule_type_mask & ETH_VMDQ_VLAN_MIRROR) && (on)) {
-               if (mirror_conf->vlan.vlan_mask == 0)
-                       return (-EINVAL);
+       if (IXGBE_INVALID_MIRROR_TYPE(mirror_conf->rule_type)) {
+               PMD_DRV_LOG(ERR, "unsupported mirror type 0x%x.",
+                       mirror_conf->rule_type);
+               return -EINVAL;
        }
 
-       /* Check if vlan id is valid and find conresponding VLAN ID index in VLVF */
-       if (mirror_conf->rule_type_mask & ETH_VMDQ_VLAN_MIRROR) {
+       if (mirror_conf->rule_type & ETH_MIRROR_VLAN) {
+               mirror_type |= IXGBE_MRCTL_VLME;
+               /* Check if vlan id is valid and find conresponding VLAN ID index in VLVF */
                for (i = 0;i < IXGBE_VLVF_ENTRIES; i++) {
                        if (mirror_conf->vlan.vlan_mask & (1ULL << i)) {
                                /* search vlan id related pool vlan filter index */
                                reg_index = ixgbe_find_vlvf_slot(hw,
                                                mirror_conf->vlan.vlan_id[i]);
                                if(reg_index < 0)
-                                       return (-EINVAL);
+                                       return -EINVAL;
                                vlvf = IXGBE_READ_REG(hw, IXGBE_VLVF(reg_index));
                                if ((vlvf & IXGBE_VLVF_VIEN) &&
-                                       ((vlvf & IXGBE_VLVF_VLANID_MASK)
-                                               == mirror_conf->vlan.vlan_id[i]))
+                                   ((vlvf & IXGBE_VLVF_VLANID_MASK) ==
+                                     mirror_conf->vlan.vlan_id[i]))
                                        vlan_mask |= (1ULL << reg_index);
                                else
-                                       return (-EINVAL);
+                                       return -EINVAL;
                        }
                }
 
@@ -3494,7 +3504,8 @@ ixgbe_mirror_rule_set(struct rte_eth_dev *dev,
         * if enable pool mirror, write related pool mask register,if disable
         * pool mirror, clear PFMRVM register
         */
-       if (mirror_conf->rule_type_mask & ETH_VMDQ_POOL_MIRROR) {
+       if (mirror_conf->rule_type & ETH_MIRROR_VIRTUAL_POOL_UP) {
+               mirror_type |= IXGBE_MRCTL_VPME;
                if (on) {
                        mp_lsb = mirror_conf->pool_mask & 0xFFFFFFFF;
                        mp_msb = mirror_conf->pool_mask >> pool_mask_offset;
@@ -3507,31 +3518,35 @@ ixgbe_mirror_rule_set(struct rte_eth_dev *dev,
                        mr_info->mr_conf[rule_id].pool_mask = 0;
                }
        }
+       if (mirror_conf->rule_type & ETH_MIRROR_UPLINK_PORT)
+               mirror_type |= IXGBE_MRCTL_UPME;
+       if (mirror_conf->rule_type & ETH_MIRROR_DOWNLINK_PORT)
+               mirror_type |= IXGBE_MRCTL_DPME;
 
        /* read  mirror control register and recalculate it */
-       mr_ctl = IXGBE_READ_REG(hw,IXGBE_MRCTL(rule_id));
+       mr_ctl = IXGBE_READ_REG(hw, IXGBE_MRCTL(rule_id));
 
        if (on) {
-               mr_ctl |= mirror_conf->rule_type_mask;
+               mr_ctl |= mirror_type;
                mr_ctl &= mirror_rule_mask;
                mr_ctl |= mirror_conf->dst_pool << dst_pool_offset;
        } else
-               mr_ctl &= ~(mirror_conf->rule_type_mask & mirror_rule_mask);
+               mr_ctl &= ~(mirror_conf->rule_type & mirror_rule_mask);
 
-       mr_info->mr_conf[rule_id].rule_type_mask = (uint8_t)(mr_ctl & mirror_rule_mask);
+       mr_info->mr_conf[rule_id].rule_type = mirror_conf->rule_type;
        mr_info->mr_conf[rule_id].dst_pool = mirror_conf->dst_pool;
 
        /* write mirrror control  register */
        IXGBE_WRITE_REG(hw, IXGBE_MRCTL(rule_id), mr_ctl);
 
-        /* write pool mirrror control  register */
-       if (mirror_conf->rule_type_mask & ETH_VMDQ_POOL_MIRROR) {
+       /* write pool mirrror control  register */
+       if (mirror_conf->rule_type == ETH_MIRROR_VIRTUAL_POOL_UP) {
                IXGBE_WRITE_REG(hw, IXGBE_VMRVM(rule_id), mp_lsb);
                IXGBE_WRITE_REG(hw, IXGBE_VMRVM(rule_id + rule_mr_offset),
                                mp_msb);
        }
        /* write VLAN mirrror control  register */
-       if (mirror_conf->rule_type_mask & ETH_VMDQ_VLAN_MIRROR) {
+       if (mirror_conf->rule_type == ETH_MIRROR_VLAN) {
                IXGBE_WRITE_REG(hw, IXGBE_VMRVLAN(rule_id), mv_lsb);
                IXGBE_WRITE_REG(hw, IXGBE_VMRVLAN(rule_id + rule_mr_offset),
                                mv_msb);
index 4be17f1..34ac677 100644 (file)
@@ -2817,7 +2817,7 @@ rte_eth_mirror_rule_set(uint8_t port_id,
        struct rte_eth_dev *dev = &rte_eth_devices[port_id];
 
        VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
-       if (mirror_conf->rule_type_mask == 0) {
+       if (mirror_conf->rule_type == 0) {
                PMD_DEBUG_TRACE("mirror rule type can not be 0.\n");
                return -EINVAL;
        }
@@ -2828,12 +2828,19 @@ rte_eth_mirror_rule_set(uint8_t port_id,
                return -EINVAL;
        }
 
-       if ((mirror_conf->rule_type_mask & ETH_VMDQ_POOL_MIRROR) &&
-               (mirror_conf->pool_mask == 0)) {
+       if ((mirror_conf->rule_type & (ETH_MIRROR_VIRTUAL_POOL_UP |
+            ETH_MIRROR_VIRTUAL_POOL_DOWN)) &&
+           (mirror_conf->pool_mask == 0)) {
                PMD_DEBUG_TRACE("Invalid mirror pool, pool mask can not be 0.\n");
                return -EINVAL;
        }
 
+       if ((mirror_conf->rule_type & ETH_MIRROR_VLAN) &&
+           mirror_conf->vlan.vlan_mask == 0) {
+               PMD_DEBUG_TRACE("Invalid vlan mask, vlan mask can not be 0.\n");
+               return -EINVAL;
+       }
+
        dev = &rte_eth_devices[port_id];
        FUNC_PTR_OR_ERR_RET(*dev->dev_ops->mirror_rule_set, -ENOTSUP);
 
index 7d7fc2e..37d9a2b 100644 (file)
@@ -470,10 +470,11 @@ struct rte_eth_rss_conf {
 /** Maximum nb. of vlan per mirror rule */
 #define ETH_MIRROR_MAX_VLANS       64
 
-#define ETH_VMDQ_POOL_MIRROR    0x0001 /**< Virtual Pool Mirroring. */
-#define ETH_VMDQ_UPLINK_MIRROR  0x0002 /**< Uplink Port Mirroring. */
-#define ETH_VMDQ_DOWNLIN_MIRROR 0x0004 /**< Downlink Port Mirroring. */
-#define ETH_VMDQ_VLAN_MIRROR    0x0008 /**< VLAN Mirroring. */
+#define ETH_MIRROR_VIRTUAL_POOL_UP     0x01  /**< Virtual Pool uplink Mirroring. */
+#define ETH_MIRROR_UPLINK_PORT         0x02  /**< Uplink Port Mirroring. */
+#define ETH_MIRROR_DOWNLINK_PORT       0x04  /**< Downlink Port Mirroring. */
+#define ETH_MIRROR_VLAN                0x08  /**< VLAN Mirroring. */
+#define ETH_MIRROR_VIRTUAL_POOL_DOWN   0x10  /**< Virtual Pool downlink Mirroring. */
 
 /**
  * A structure used to configure VLAN traffic mirror of an Ethernet port.
@@ -488,7 +489,7 @@ struct rte_eth_vlan_mirror {
  * A structure used to configure traffic mirror of an Ethernet port.
  */
 struct rte_eth_mirror_conf {
-       uint8_t rule_type_mask; /**< Mirroring rule type mask we want to set */
+       uint8_t rule_type; /**< Mirroring rule type */
        uint8_t dst_pool;  /**< Destination pool for this mirror rule. */
        uint64_t pool_mask; /**< Bitmap of pool for pool mirroring */
        /** VLAN ID setting for VLAN mirroring. */