X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=lib%2Flibrte_sched%2Frte_sched.h;h=3f27755916fb782d848a42351a2a559909e3d28d;hb=3031749c2df04a63cdcef186dcce3781e61436e8;hp=1c4ebc54e1bdcec7961a22e4696130f876f7cf08;hpb=d10296d7ea9c7e4f0da51ff2fb9c89b838e06940;p=dpdk.git diff --git a/lib/librte_sched/rte_sched.h b/lib/librte_sched/rte_sched.h index 1c4ebc54e1..3f27755916 100644 --- a/lib/librte_sched/rte_sched.h +++ b/lib/librte_sched/rte_sched.h @@ -1,13 +1,13 @@ /*- * BSD LICENSE - * + * * Copyright(c) 2010-2014 Intel Corporation. All rights reserved. * All rights reserved. - * + * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: - * + * * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * Redistributions in binary form must reproduce the above copyright @@ -17,7 +17,7 @@ * * Neither the name of Intel Corporation nor the names of its * contributors may be used to endorse or promote products derived * from this software without specific prior written permission. - * + * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR @@ -47,7 +47,7 @@ extern "C" { * for the current network node. * * The scheduler supports thousands of packet queues grouped under a 5-level hierarchy: - * 1. Port: + * 1. Port: * - Typical usage: output Ethernet port; * - Multiple ports are scheduled in round robin order with equal priority; * 2. Subport: @@ -56,11 +56,11 @@ extern "C" { * - Upper limit enforced per traffic class at subport level; * - Lower priority traffic classes able to reuse subport bandwidth currently * unused by higher priority traffic classes of the same subport; - * - When any subport traffic class is oversubscribed (configuration time - * event), the usage of subport member pipes with high demand for that - * traffic class pipes is truncated to a dynamically adjusted value with no + * - When any subport traffic class is oversubscribed (configuration time + * event), the usage of subport member pipes with high demand for that + * traffic class pipes is truncated to a dynamically adjusted value with no * impact to low demand pipes; - * 3. Pipe: + * 3. Pipe: * - Typical usage: individual user/subscriber; * - Traffic shaping using the token bucket algorithm (one bucket per pipe); * 4. Traffic class: @@ -69,9 +69,9 @@ extern "C" { * - Lower priority traffic classes able to reuse pipe bandwidth currently * unused by higher priority traffic classes of the same pipe; * 5. Queue: - * - Typical usage: queue hosting packets from one or multiple connections + * - Typical usage: queue hosting packets from one or multiple connections * of same traffic class belonging to the same user; - * - Weighted Round Robin (WRR) is used to service the queues within same + * - Weighted Round Robin (WRR) is used to service the queues within same * pipe traffic class. * ***/ @@ -113,15 +113,15 @@ of struct rte_mbuf). */ #endif /** Subport configuration parameters. The period and credits_per_period parameters are measured -in bytes, with one byte meaning the time duration associated with the transmission of one byte -on the physical medium of the output port, with pipe or pipe traffic class rate (measured as +in bytes, with one byte meaning the time duration associated with the transmission of one byte +on the physical medium of the output port, with pipe or pipe traffic class rate (measured as percentage of output port rate) determined as credits_per_period divided by period. One credit represents one byte. */ struct rte_sched_subport_params { /* Subport token bucket */ uint32_t tb_rate; /**< Subport token bucket rate (measured in bytes per second) */ uint32_t tb_size; /**< Subport token bucket size (measured in credits) */ - + /* Subport traffic classes */ uint32_t tc_rate[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE]; /**< Subport traffic class rates (measured in bytes per second) */ uint32_t tc_period; /**< Enforcement period for traffic class rates (measured in milliseconds) */ @@ -134,31 +134,31 @@ struct rte_sched_subport_stats { subport for each traffic class */ uint32_t n_pkts_tc_dropped[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE]; /**< Number of packets dropped by the current subport for each traffic class due to subport queues being full or congested*/ - + /* Bytes */ - uint32_t n_bytes_tc[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE]; /**< Number of bytes successfully written to current + uint32_t n_bytes_tc[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE]; /**< Number of bytes successfully written to current subport for each traffic class*/ - uint32_t n_bytes_tc_dropped[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE]; /**< Number of bytes dropped by the current + uint32_t n_bytes_tc_dropped[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE]; /**< Number of bytes dropped by the current subport for each traffic class due to subport queues being full or congested */ }; /** Pipe configuration parameters. The period and credits_per_period parameters are measured -in bytes, with one byte meaning the time duration associated with the transmission of one byte -on the physical medium of the output port, with pipe or pipe traffic class rate (measured as +in bytes, with one byte meaning the time duration associated with the transmission of one byte +on the physical medium of the output port, with pipe or pipe traffic class rate (measured as percentage of output port rate) determined as credits_per_period divided by period. One credit represents one byte. */ struct rte_sched_pipe_params { /* Pipe token bucket */ uint32_t tb_rate; /**< Pipe token bucket rate (measured in bytes per second) */ uint32_t tb_size; /**< Pipe token bucket size (measured in credits) */ - + /* Pipe traffic classes */ uint32_t tc_rate[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE]; /**< Pipe traffic class rates (measured in bytes per second) */ uint32_t tc_period; /**< Enforcement period for pipe traffic class rates (measured in milliseconds) */ #ifdef RTE_SCHED_SUBPORT_TC_OV uint8_t tc_ov_weight; /**< Weight for the current pipe in the event of subport traffic class 3 oversubscription */ #endif - + /* Pipe queues */ uint8_t wrr_weights[RTE_SCHED_QUEUES_PER_PIPE]; /**< WRR weights for the queues of the current pipe */ }; @@ -168,10 +168,10 @@ struct rte_sched_queue_stats { /* Packets */ uint32_t n_pkts; /**< Number of packets successfully written to current queue */ uint32_t n_pkts_dropped; /**< Number of packets dropped due to current queue being full or congested */ - + /* Bytes */ uint32_t n_bytes; /**< Number of bytes successfully written to current queue */ - uint32_t n_bytes_dropped; /**< Number of bytes dropped due to current queue being full or congested */ + uint32_t n_bytes_dropped; /**< Number of bytes dropped due to current queue being full or congested */ }; /** Port configuration parameters. */ @@ -183,8 +183,8 @@ struct rte_sched_port_params { uint32_t frame_overhead; /**< Framing overhead per packet (measured in bytes) */ uint32_t n_subports_per_port; /**< Number of subports for the current port scheduler instance*/ uint32_t n_pipes_per_subport; /**< Number of pipes for each port scheduler subport */ - uint16_t qsize[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE]; /**< Packet queue size for each traffic class. All queues - within the same pipe traffic class have the same size. Queues from + uint16_t qsize[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE]; /**< Packet queue size for each traffic class. All queues + within the same pipe traffic class have the same size. Queues from different pipes serving the same traffic class have the same size. */ struct rte_sched_pipe_params *pipe_profiles; /**< Pipe profile table defined for current port scheduler instance. Every pipe of the current port scheduler is configured using one of the @@ -197,7 +197,7 @@ struct rte_sched_port_params { /** Path through the scheduler hierarchy used by the scheduler enqueue operation to identify the destination queue for the current packet. Stored in the field pkt.hash.sched -of struct rte_mbuf of each packet, typically written by the classification stage and read by +of struct rte_mbuf of each packet, typically written by the classification stage and read by scheduler enqueue.*/ struct rte_sched_port_hierarchy { uint32_t queue:2; /**< Queue ID (0 .. 3) */ @@ -220,7 +220,7 @@ struct rte_sched_port_hierarchy { * @return * Handle to port scheduler instance upon success or NULL otherwise. */ -struct rte_sched_port * +struct rte_sched_port * rte_sched_port_config(struct rte_sched_port_params *params); /** @@ -245,7 +245,7 @@ rte_sched_port_free(struct rte_sched_port *port); * 0 upon success, error code otherwise */ int -rte_sched_subport_config(struct rte_sched_port *port, +rte_sched_subport_config(struct rte_sched_port *port, uint32_t subport_id, struct rte_sched_subport_params *params); @@ -265,7 +265,7 @@ rte_sched_subport_config(struct rte_sched_port *port, */ int rte_sched_pipe_config(struct rte_sched_port *port, - uint32_t subport_id, + uint32_t subport_id, uint32_t pipe_id, int32_t pipe_profile); @@ -281,7 +281,7 @@ uint32_t rte_sched_port_get_memory_footprint(struct rte_sched_port_params *params); /* - * Statistics + * Statistics * ***/ @@ -293,7 +293,7 @@ rte_sched_port_get_memory_footprint(struct rte_sched_port_params *params); * @param subport_id * Subport ID * @param stats - * Pointer to pre-allocated subport statistics structure where the statistics + * Pointer to pre-allocated subport statistics structure where the statistics * counters should be stored * @param tc_ov * Pointer to pre-allocated 4-entry array where the oversubscription status for @@ -315,7 +315,7 @@ rte_sched_subport_read_stats(struct rte_sched_port *port, * @param queue_id * Queue ID within port scheduler * @param stats - * Pointer to pre-allocated subport statistics structure where the statistics + * Pointer to pre-allocated subport statistics structure where the statistics * counters should be stored * @param qlen * Pointer to pre-allocated variable where the current queue length should be stored. @@ -328,15 +328,15 @@ rte_sched_queue_read_stats(struct rte_sched_port *port, struct rte_sched_queue_stats *stats, uint16_t *qlen); -/* - * Run-time +/* + * Run-time * ***/ /** - * Scheduler hierarchy path write to packet descriptor. Typically called by the + * Scheduler hierarchy path write to packet descriptor. Typically called by the * packet classification stage. - * + * * @param pkt * Packet descriptor handle * @param subport @@ -349,11 +349,11 @@ rte_sched_queue_read_stats(struct rte_sched_port *port, * Queue ID within pipe traffic class (0 .. 3) */ static inline void -rte_sched_port_pkt_write(struct rte_mbuf *pkt, +rte_sched_port_pkt_write(struct rte_mbuf *pkt, uint32_t subport, uint32_t pipe, uint32_t traffic_class, uint32_t queue, enum rte_meter_color color) { struct rte_sched_port_hierarchy *sched = (struct rte_sched_port_hierarchy *) &pkt->pkt.hash.sched; - + sched->color = (uint32_t) color; sched->subport = subport; sched->pipe = pipe; @@ -363,7 +363,7 @@ rte_sched_port_pkt_write(struct rte_mbuf *pkt, /** * Scheduler hierarchy path read from packet descriptor (struct rte_mbuf). Typically - * called as part of the hierarchical scheduler enqueue operation. The subport, + * called as part of the hierarchical scheduler enqueue operation. The subport, * pipe, traffic class and queue parameters need to be pre-allocated by the caller. * * @param pkt @@ -376,13 +376,13 @@ rte_sched_port_pkt_write(struct rte_mbuf *pkt, * Traffic class ID within pipe (0 .. 3) * @param queue * Queue ID within pipe traffic class (0 .. 3) - * + * */ static inline void rte_sched_port_pkt_read_tree_path(struct rte_mbuf *pkt, uint32_t *subport, uint32_t *pipe, uint32_t *traffic_class, uint32_t *queue) { struct rte_sched_port_hierarchy *sched = (struct rte_sched_port_hierarchy *) &pkt->pkt.hash.sched; - + *subport = sched->subport; *pipe = sched->pipe; *traffic_class = sched->traffic_class; @@ -398,11 +398,11 @@ rte_sched_port_pkt_read_color(struct rte_mbuf *pkt) } /** - * Hierarchical scheduler port enqueue. Writes up to n_pkts to port scheduler and + * Hierarchical scheduler port enqueue. Writes up to n_pkts to port scheduler and * returns the number of packets actually written. For each packet, the port scheduler - * queue to write the packet to is identified by reading the hierarchy path from the - * packet descriptor; if the queue is full or congested and the packet is not written - * to the queue, then the packet is automatically dropped without any action required + * queue to write the packet to is identified by reading the hierarchy path from the + * packet descriptor; if the queue is full or congested and the packet is not written + * to the queue, then the packet is automatically dropped without any action required * from the caller. * * @param port @@ -418,14 +418,14 @@ int rte_sched_port_enqueue(struct rte_sched_port *port, struct rte_mbuf **pkts, uint32_t n_pkts); /** - * Hierarchical scheduler port dequeue. Reads up to n_pkts from the port scheduler - * and stores them in the pkts array and returns the number of packets actually read. + * Hierarchical scheduler port dequeue. Reads up to n_pkts from the port scheduler + * and stores them in the pkts array and returns the number of packets actually read. * The pkts array needs to be pre-allocated by the caller with at least n_pkts entries. * * @param port * Handle to port scheduler instance * @param pkts - * Pre-allocated packet descriptor array where the packets dequeued from the port + * Pre-allocated packet descriptor array where the packets dequeued from the port * scheduler should be stored * @param n_pkts * Number of packets to dequeue from the port scheduler