Patch Detail

HTTP 200 OK
Allow: GET, PUT, PATCH, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "id": 56791,
    "url": "http://patches.dpdk.org/api/patches/56791/?format=api",
    "web_url": "http://patches.dpdk.org/project/dpdk/patch/20190719141825.101844-7-jasvinder.singh@intel.com/",
    "project": {
        "id": 1,
        "url": "http://patches.dpdk.org/api/projects/1/?format=api",
        "name": "DPDK",
        "link_name": "dpdk",
        "list_id": "dev.dpdk.org",
        "list_email": "dev@dpdk.org",
        "web_url": "http://core.dpdk.org",
        "scm_url": "git://dpdk.org/dpdk",
        "webscm_url": "http://git.dpdk.org/dpdk",
        "list_archive_url": "https://inbox.dpdk.org/dev",
        "list_archive_url_format": "https://inbox.dpdk.org/dev/{}",
        "commit_url_format": ""
    },
    "msgid": "<20190719141825.101844-7-jasvinder.singh@intel.com>",
    "list_archive_url": "https://inbox.dpdk.org/dev/20190719141825.101844-7-jasvinder.singh@intel.com",
    "date": "2019-07-19T14:18:20",
    "name": "[v6,06/11] sched: improve doxygen comments",
    "commit_ref": null,
    "pull_url": null,
    "state": "superseded",
    "archived": true,
    "hash": "738e4e5890d21425c0f6e4e983c7282ca8093211",
    "submitter": {
        "id": 285,
        "url": "http://patches.dpdk.org/api/people/285/?format=api",
        "name": "Jasvinder Singh",
        "email": "jasvinder.singh@intel.com"
    },
    "delegate": {
        "id": 1,
        "url": "http://patches.dpdk.org/api/users/1/?format=api",
        "username": "tmonjalo",
        "first_name": "Thomas",
        "last_name": "Monjalon",
        "email": "thomas@monjalon.net"
    },
    "mbox": "http://patches.dpdk.org/project/dpdk/patch/20190719141825.101844-7-jasvinder.singh@intel.com/mbox/",
    "series": [
        {
            "id": 5625,
            "url": "http://patches.dpdk.org/api/series/5625/?format=api",
            "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=5625",
            "date": "2019-07-19T14:18:14",
            "name": "sched: feature enhancements",
            "version": 6,
            "mbox": "http://patches.dpdk.org/series/5625/mbox/"
        }
    ],
    "comments": "http://patches.dpdk.org/api/patches/56791/comments/",
    "check": "success",
    "checks": "http://patches.dpdk.org/api/patches/56791/checks/",
    "tags": {},
    "related": [],
    "headers": {
        "Return-Path": "<dev-bounces@dpdk.org>",
        "X-Original-To": "patchwork@dpdk.org",
        "Delivered-To": "patchwork@dpdk.org",
        "Received": [
            "from [92.243.14.124] (localhost [127.0.0.1])\n\tby dpdk.org (Postfix) with ESMTP id 8F88C1B998;\n\tFri, 19 Jul 2019 16:18:37 +0200 (CEST)",
            "from mga09.intel.com (mga09.intel.com [134.134.136.24])\n\tby dpdk.org (Postfix) with ESMTP id 375BC5680\n\tfor <dev@dpdk.org>; Fri, 19 Jul 2019 16:18:26 +0200 (CEST)",
            "from orsmga008.jf.intel.com ([10.7.209.65])\n\tby orsmga102.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;\n\t19 Jul 2019 07:18:24 -0700",
            "from silpixa00381635.ir.intel.com (HELO\n\tsilpixa00381635.ger.corp.intel.com) ([10.237.223.4])\n\tby orsmga008.jf.intel.com with ESMTP; 19 Jul 2019 07:18:24 -0700"
        ],
        "X-Amp-Result": "SKIPPED(no attachment in message)",
        "X-Amp-File-Uploaded": "False",
        "X-ExtLoop1": "1",
        "X-IronPort-AV": "E=Sophos;i=\"5.64,282,1559545200\"; d=\"scan'208\";a=\"162417202\"",
        "From": "Jasvinder Singh <jasvinder.singh@intel.com>",
        "To": "dev@dpdk.org",
        "Cc": "cristian.dumitrescu@intel.com, Abraham Tovar <abrahamx.tovar@intel.com>, \n\tLukasz Krakowiak <lukaszx.krakowiak@intel.com>",
        "Date": "Fri, 19 Jul 2019 15:18:20 +0100",
        "Message-Id": "<20190719141825.101844-7-jasvinder.singh@intel.com>",
        "X-Mailer": "git-send-email 2.21.0",
        "In-Reply-To": "<20190719141825.101844-1-jasvinder.singh@intel.com>",
        "References": "<20190717144245.138876-2-jasvinder.singh@intel.com>\n\t<20190719141825.101844-1-jasvinder.singh@intel.com>",
        "MIME-Version": "1.0",
        "Content-Transfer-Encoding": "8bit",
        "Subject": "[dpdk-dev] [PATCH v6 06/11] sched: improve doxygen comments",
        "X-BeenThere": "dev@dpdk.org",
        "X-Mailman-Version": "2.1.15",
        "Precedence": "list",
        "List-Id": "DPDK patches and discussions <dev.dpdk.org>",
        "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n\t<mailto:dev-request@dpdk.org?subject=unsubscribe>",
        "List-Archive": "<http://mails.dpdk.org/archives/dev/>",
        "List-Post": "<mailto:dev@dpdk.org>",
        "List-Help": "<mailto:dev-request@dpdk.org?subject=help>",
        "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n\t<mailto:dev-request@dpdk.org?subject=subscribe>",
        "Errors-To": "dev-bounces@dpdk.org",
        "Sender": "\"dev\" <dev-bounces@dpdk.org>"
    },
    "content": "Improve doxygen comments.\n\nSigned-off-by: Jasvinder Singh <jasvinder.singh@intel.com>\nSigned-off-by: Abraham Tovar <abrahamx.tovar@intel.com>\nSigned-off-by: Lukasz Krakowiak <lukaszx.krakowiak@intel.com>\n---\n lib/librte_sched/rte_sched.h | 152 ++++++++++++++++++++++-------------\n 1 file changed, 94 insertions(+), 58 deletions(-)",
    "diff": "diff --git a/lib/librte_sched/rte_sched.h b/lib/librte_sched/rte_sched.h\nindex d7d4f1767..fffbad696 100644\n--- a/lib/librte_sched/rte_sched.h\n+++ b/lib/librte_sched/rte_sched.h\n@@ -52,7 +52,7 @@ extern \"C\" {\n  *\t    multiple connections of same traffic class belonging to\n  *\t    the same user;\n  *           - Weighted Round Robin (WRR) is used to service the\n- *\t    queues within same pipe traffic class.\n+ *\t    queues within same pipe lowest priority traffic class (best-effort).\n  *\n  */\n \n@@ -83,7 +83,8 @@ extern \"C\" {\n #define RTE_SCHED_BE_QUEUES_PER_PIPE    4\n \n /** Number of traffic classes per pipe (as well as subport).\n- * Cannot be changed.\n+ * @see struct rte_sched_subport_params\n+ * @see struct rte_sched_pipe_params\n  */\n #define RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE    \\\n (RTE_SCHED_QUEUES_PER_PIPE - RTE_SCHED_BE_QUEUES_PER_PIPE + 1)\n@@ -113,6 +114,8 @@ extern \"C\" {\n  *\n  * The FCS is considered overhead only if not included in the packet\n  * length (field pkt_len of struct rte_mbuf).\n+ *\n+ * @see struct rte_sched_port_params\n  */\n #ifndef RTE_SCHED_FRAME_OVERHEAD_DEFAULT\n #define RTE_SCHED_FRAME_OVERHEAD_DEFAULT      24\n@@ -128,34 +131,36 @@ extern \"C\" {\n  * byte.\n  */\n struct rte_sched_subport_params {\n-\t/* Subport token bucket */\n-\tuint32_t tb_rate;                /**< Rate (measured in bytes per second) */\n-\tuint32_t tb_size;                /**< Size (measured in credits) */\n+\t/** Token bucket rate (measured in bytes per second) */\n+\tuint32_t tb_rate;\n+\n+\t/** Token bucket size (measured in credits) */\n+\tuint32_t tb_size;\n \n-\t/* Subport traffic classes */\n+\t/** Traffic class rates (measured in bytes per second) */\n \tuint32_t tc_rate[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE];\n-\t/**< Traffic class rates (measured in bytes per second) */\n+\n+\t/** Enforcement period for rates (measured in milliseconds) */\n \tuint32_t tc_period;\n-\t/**< Enforcement period for rates (measured in milliseconds) */\n };\n \n /** Subport statistics */\n struct rte_sched_subport_stats {\n-\t/* Packets */\n+\t/** Number of packets successfully written */\n \tuint32_t n_pkts_tc[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE];\n-\t/**< Number of packets successfully written */\n+\n+\t/** Number of packets dropped */\n \tuint32_t n_pkts_tc_dropped[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE];\n-\t/**< Number of packets dropped */\n \n-\t/* Bytes */\n+\t/** Number of bytes successfully written for each traffic class */\n \tuint32_t n_bytes_tc[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE];\n-\t/**< Number of bytes successfully written for each traffic class */\n+\n+\t/** Number of bytes dropped for each traffic class */\n \tuint32_t n_bytes_tc_dropped[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE];\n-\t/**< Number of bytes dropped for each traffic class */\n \n #ifdef RTE_SCHED_RED\n+\t/** Number of packets dropped by red */\n \tuint32_t n_pkts_red_dropped[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE];\n-\t/**< Number of packets dropped by red */\n #endif\n };\n \n@@ -169,61 +174,90 @@ struct rte_sched_subport_stats {\n  * byte.\n  */\n struct rte_sched_pipe_params {\n-\t/* Pipe token bucket */\n-\tuint32_t tb_rate;                /**< Rate (measured in bytes per second) */\n-\tuint32_t tb_size;                /**< Size (measured in credits) */\n+\t/** Token bucket rate (measured in bytes per second) */\n+\tuint32_t tb_rate;\n \n-\t/* Pipe traffic classes */\n+\t/** Token bucket size (measured in credits) */\n+\tuint32_t tb_size;\n+\n+\t/** Traffic class rates (measured in bytes per second) */\n \tuint32_t tc_rate[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE];\n-\t/**< Traffic class rates (measured in bytes per second) */\n+\n+\t/** Enforcement period (measured in milliseconds) */\n \tuint32_t tc_period;\n-\t/**< Enforcement period (measured in milliseconds) */\n-\tuint8_t tc_ov_weight;\t\t /**< Weight Traffic class 3 oversubscription */\n \n-\t/* Pipe queues */\n-\tuint8_t  wrr_weights[RTE_SCHED_BE_QUEUES_PER_PIPE]; /**< WRR weights */\n+\t/** Best-effort traffic class oversubscription weight */\n+\tuint8_t tc_ov_weight;\n+\n+\t/** WRR weights of best-effort traffic class queues */\n+\tuint8_t wrr_weights[RTE_SCHED_BE_QUEUES_PER_PIPE];\n };\n \n /** Queue statistics */\n struct rte_sched_queue_stats {\n-\t/* Packets */\n-\tuint32_t n_pkts;                 /**< Packets successfully written */\n-\tuint32_t n_pkts_dropped;         /**< Packets dropped */\n+\t/** Packets successfully written */\n+\tuint32_t n_pkts;\n+\n+\t/** Packets dropped */\n+\tuint32_t n_pkts_dropped;\n+\n #ifdef RTE_SCHED_RED\n-\tuint32_t n_pkts_red_dropped;\t /**< Packets dropped by RED */\n+\t/** Packets dropped by RED */\n+\tuint32_t n_pkts_red_dropped;\n #endif\n \n-\t/* Bytes */\n-\tuint32_t n_bytes;                /**< Bytes successfully written */\n-\tuint32_t n_bytes_dropped;        /**< Bytes dropped */\n+\t/** Bytes successfully written */\n+\tuint32_t n_bytes;\n+\n+\t/** Bytes dropped */\n+\tuint32_t n_bytes_dropped;\n };\n \n /** Port configuration parameters. */\n struct rte_sched_port_params {\n-\tconst char *name;                /**< String to be associated */\n-\tint socket;                      /**< CPU socket ID */\n-\tuint32_t rate;                   /**< Output port rate\n-\t\t\t\t\t  * (measured in bytes per second) */\n-\tuint32_t mtu;                    /**< Maximum Ethernet frame size\n-\t\t\t\t\t  * (measured in bytes).\n-\t\t\t\t\t  * Should not include the framing overhead. */\n-\tuint32_t frame_overhead;         /**< Framing overhead per packet\n-\t\t\t\t\t  * (measured in bytes) */\n-\tuint32_t n_subports_per_port;    /**< Number of subports */\n-\tuint32_t n_pipes_per_subport;    /**< Number of pipes per subport */\n+\t/** Name of the port to be associated */\n+\tconst char *name;\n+\n+\t/** CPU socket ID */\n+\tint socket;\n+\n+\t/** Output port rate (measured in bytes per second) */\n+\tuint32_t rate;\n+\n+\t/** Maximum Ethernet frame size (measured in bytes).\n+\t * Should not include the framing overhead.\n+\t */\n+\tuint32_t mtu;\n+\n+\t/** Framing overhead per packet (measured in bytes) */\n+\tuint32_t frame_overhead;\n+\n+\t/** Number of subports */\n+\tuint32_t n_subports_per_port;\n+\n+\t/** Number of subport_pipes */\n+\tuint32_t n_pipes_per_subport;\n+\n+\t/** Packet queue size for each traffic class.\n+\t * All the pipes within the same subport share the similar\n+\t * configuration for the queues.\n+\t */\n \tuint16_t qsize[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE];\n-\t/**< Packet queue size for each traffic class.\n-\t * All queues within the same pipe traffic class have the same\n-\t * size. Queues from different pipes serving the same traffic\n-\t * class have the same size. */\n+\n+\t/** Pipe profile table.\n+\t * Every pipe is configured using one of the profiles from this table.\n+\t */\n \tstruct rte_sched_pipe_params *pipe_profiles;\n-\t/**< Pipe profile table.\n-\t * Every pipe is configured using one of the profiles from this table. */\n-\tuint32_t n_pipe_profiles;        /**< Profiles in the pipe profile table */\n+\n+\t/** Profiles in the pipe profile table */\n+\tuint32_t n_pipe_profiles;\n+\n+\t/** Max profiles allowed in the pipe profile table */\n \tuint32_t n_max_pipe_profiles;\n-\t/**< Max profiles allowed in the pipe profile table */\n+\n #ifdef RTE_SCHED_RED\n-\tstruct rte_red_params red_params[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE][RTE_COLORS]; /**< RED parameters */\n+\t/** RED parameters */\n+\tstruct rte_red_params red_params[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE][RTE_COLORS];\n #endif\n };\n \n@@ -337,8 +371,9 @@ rte_sched_port_get_memory_footprint(struct rte_sched_port_params *params);\n  *   Pointer to pre-allocated subport statistics structure where the statistics\n  *   counters should be stored\n  * @param tc_ov\n- *   Pointer to pre-allocated 4-entry array where the oversubscription status for\n- *   each of the 4 subport traffic classes should be stored.\n+ *   Pointer to pre-allocated RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE-entry array\n+ *   where the oversubscription status for each of the subport traffic classes\n+ *   should be stored.\n  * @return\n  *   0 upon success, error code otherwise\n  */\n@@ -383,9 +418,10 @@ rte_sched_queue_read_stats(struct rte_sched_port *port,\n  * @param pipe\n  *   Pipe ID within subport\n  * @param traffic_class\n- *   Traffic class ID within pipe (0 .. 3)\n+ *   Traffic class ID within pipe (0 .. RTE_SCHED_TRAFFIC_CLASS_BE)\n  * @param queue\n- *   Queue ID within pipe traffic class (0 .. 3)\n+ *   Queue ID within pipe traffic class, 0 for high priority TCs, and\n+ *   0 .. (RTE_SCHED_BE_QUEUES_PER_PIPE - 1) for best-effort TC\n  * @param color\n  *   Packet color set\n  */\n@@ -410,10 +446,10 @@ rte_sched_port_pkt_write(struct rte_sched_port *port,\n  * @param pipe\n  *   Pipe ID within subport\n  * @param traffic_class\n- *   Traffic class ID within pipe (0 .. 3)\n+ *   Traffic class ID within pipe (0 .. RTE_SCHED_TRAFFIC_CLASS_BE)\n  * @param queue\n- *   Queue ID within pipe traffic class (0 .. 3)\n- *\n+ *   Queue ID within pipe traffic class, 0 for high priority TCs, and\n+ *   0 .. (RTE_SCHED_BE_QUEUES_PER_PIPE - 1) for best-effort TC\n  */\n void\n rte_sched_port_pkt_read_tree_path(struct rte_sched_port *port,\n",
    "prefixes": [
        "v6",
        "06/11"
    ]
}