| Message ID | 1452722824-13299-1-git-send-email-mike.holmes@linaro.org |
|---|---|
| State | Accepted |
| Commit | 68ee8ea09b471800069c9dd96c0b2728df3006a3 |
| Headers | show |
For this series: Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> On Wed, Jan 13, 2016 at 4:07 PM, Mike Holmes <mike.holmes@linaro.org> wrote: > Signed-off-by: Mike Holmes <mike.holmes@linaro.org> > --- > doc/users-guide/users-guide-tm.adoc | 83 > +++++++++++++++++++++++++++++++++++++ > 1 file changed, 83 insertions(+) > > diff --git a/doc/users-guide/users-guide-tm.adoc > b/doc/users-guide/users-guide-tm.adoc > index dc0d003..e68157f 100644 > --- a/doc/users-guide/users-guide-tm.adoc > +++ b/doc/users-guide/users-guide-tm.adoc > @@ -262,3 +262,86 @@ This header file defines some constants representing > the absolute maximum > settings for any TM system, though in most cases a TM system can (and > should) > be created/instantiated with smaller values, since lower values will often > result in faster operation and/or less memory used. > + > +=== Examples > + > +.Create a tm_node chain for two nodes and associate the scheduler > +[source,c] > +---- > + > + odp_tm_params_init(&tm_params); /* <1> */ > + tm_params.pktio = egress_pktio; > + tm = odp_tm_create(“Example TM”, &tm_params); > + > +/* create 5 input queues here – two at priority 1 and three at priority > 2. */ > + > + odp_tm_queue_params_init(&queue_params); > + queue_params.priority = 1; > + tmq_A1 = odp_tm_queue_create(tm, &queue_params); > + tmq_B1 = odp_tm_queue_create(tm, &queue_params); > + > + queue_params.priority = 2; > + tmq_A2 = odp_tm_queue_create(tm, &queue_params); > + tmq_B2 = odp_tm_queue_create(tm, &queue_params); > + tmq_C2 = odp_tm_queue_create(tm, &queue_params); > + > + odp_tm_node_params_init(&node_params); /* <2> */ > + node_params.level = 1; > + tm_node_1 = odp_tm_node_create(tm, “TmNode1”, &node_params); > + > + odp_tm_queue_connect(tmq_A1, tm_node_1); /* <3> */ > + odp_tm_queue_connect(tmq_B1, tm_node_1); > + odp_tm_queue_connect(tmq_A2, tm_node_1); > + odp_tm_queue_connect(tmq_B2, tm_node_1); > + odp_tm_queue_connect(tmq_C2, tm_node_1); > + > +/* It is IMPORTANT to understand that the following code does NOT create > any > +schedulers! In fact there is NO call to create a tm scheduler that exists > +inside of a tm_node. Such an entity comes into existence as needed. What > this > +code does is create a scheduler PROFILE, which is effectively a > registered set > +of common scheduler parameters. NOTE that this uses some pseudocode below > +instead of real C code so as to be more concise. */ > + > + odp_tm_sched_params_init(&sched_params); /* <4> */ > + sched_params.sched_modes = { ODP_TM_FRAME_BASED_WEIGHTS, … }; > + sched_params.sched_weights = { 8, 8, 8, … }; > + sched_profile_RR = odp_tm_sched_create(“SchedProfileRR”, > &sched_params); > + > + sched_params.sched_modes = { ODP_TM_BYTE_BASED_WEIGHTS, … }; > + sched_params.sched_weights = { 8, 8, 8, … }; > + sched_profile_FQ = odp_tm_sched_create(“SchedProfileFQ”, > &sched_params); > + > + odp_tm_queue_sched_config(tm_node_1, tmq_A1, sched_profile_RR); /* <5> > */ > + odp_tm_queue_sched_config(tm_node_1, tmq_B1, sched_profile_RR); > + odp_tm_queue_sched_config(tm_node_1, tmq_A2, sched_profile_FQ); > + odp_tm_queue_sched_config(tm_node_1, tmq_B2, sched_profile_FQ); > + odp_tm_queue_sched_config(tm_node_1, tmq_C2, sched_profile_FQ); > + > + odp_tm_node_params_init(&node_params); /* <6> */ > + node_params.level = 2; > + tm_node_2 = odp_tm_node_create(tm, “TmNode2”, &node_params); > + > + odp_tm_node_connect(tm_node_1, tm_node_2); /* <7> */ > + > + odp_tm_sched_params_init(&sched_params); /* <8> */ > + sched_params.sched_modes = { ODP_TM_BYTE_BASED_WEIGHTS, … }; > + sched_params.sched_weights = { 8, 16, 24, … }; > + sched_profile_WFQ = odp_tm_sched_create(“SchedProfileWFQ”, > &sched_params); > + > + odp_tm_node_sched_config(tm_node_2, tm_node_1, sched_profile_WFQ); /* > <9> */ > +---- > + > +<1> Create a tm system, since that is a precursor to creating tm_queues. > +<2> Create a Node #1 > +<3> Connect the Queue(s) to the Node -> odp_tm_queue_connect() > +<4> Create two sets of scheduler params – one implementing Round Robin > (since > +all weights are the same – namely 8) and the second implementing Fair > Queuing. > + > +<5> Associate the Scheduler to the Node and the Queue(s) -> > odp_tm_queue_sched_config() > +Use the Round Robin profile for the priority 1 fan-in’s and Fair Queuing > +for the priority 2 fan-ins. > + > +<6> Create a second Node #2 > +<7> Connect the first Node #1 to the second Node #2 -> > odp_tm_node_connect() > +<8> Create a Scheduler Profile > +<9> Associate the Scheduler to the Node #1 and #2 -> > odp_tm_node_sched_config() > -- > 2.5.0 > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org > https://lists.linaro.org/mailman/listinfo/lng-odp >
Merged, Maxim. On 01/14/2016 02:15, Bill Fischofer wrote: > For this series: > > Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org > <mailto:bill.fischofer@linaro.org>> > > On Wed, Jan 13, 2016 at 4:07 PM, Mike Holmes <mike.holmes@linaro.org > <mailto:mike.holmes@linaro.org>> wrote: > > Signed-off-by: Mike Holmes <mike.holmes@linaro.org > <mailto:mike.holmes@linaro.org>> > --- > doc/users-guide/users-guide-tm.adoc | 83 > +++++++++++++++++++++++++++++++++++++ > 1 file changed, 83 insertions(+) > > diff --git a/doc/users-guide/users-guide-tm.adoc > b/doc/users-guide/users-guide-tm.adoc > index dc0d003..e68157f 100644 > --- a/doc/users-guide/users-guide-tm.adoc > +++ b/doc/users-guide/users-guide-tm.adoc > @@ -262,3 +262,86 @@ This header file defines some constants > representing the absolute maximum > settings for any TM system, though in most cases a TM system can > (and should) > be created/instantiated with smaller values, since lower values > will often > result in faster operation and/or less memory used. > + > +=== Examples > + > +.Create a tm_node chain for two nodes and associate the scheduler > +[source,c] > +---- > + > + odp_tm_params_init(&tm_params); /* <1> */ > + tm_params.pktio = egress_pktio; > + tm = odp_tm_create(“Example TM”, &tm_params); > + > +/* create 5 input queues here – two at priority 1 and three at > priority 2. */ > + > + odp_tm_queue_params_init(&queue_params); > + queue_params.priority = 1; > + tmq_A1 = odp_tm_queue_create(tm, &queue_params); > + tmq_B1 = odp_tm_queue_create(tm, &queue_params); > + > + queue_params.priority = 2; > + tmq_A2 = odp_tm_queue_create(tm, &queue_params); > + tmq_B2 = odp_tm_queue_create(tm, &queue_params); > + tmq_C2 = odp_tm_queue_create(tm, &queue_params); > + > + odp_tm_node_params_init(&node_params); /* <2> */ > + node_params.level = 1; > + tm_node_1 = odp_tm_node_create(tm, “TmNode1”, &node_params); > + > + odp_tm_queue_connect(tmq_A1, tm_node_1); /* <3> */ > + odp_tm_queue_connect(tmq_B1, tm_node_1); > + odp_tm_queue_connect(tmq_A2, tm_node_1); > + odp_tm_queue_connect(tmq_B2, tm_node_1); > + odp_tm_queue_connect(tmq_C2, tm_node_1); > + > +/* It is IMPORTANT to understand that the following code does NOT > create any > +schedulers! In fact there is NO call to create a tm scheduler > that exists > +inside of a tm_node. Such an entity comes into existence as > needed. What this > +code does is create a scheduler PROFILE, which is effectively a > registered set > +of common scheduler parameters. NOTE that this uses some > pseudocode below > +instead of real C code so as to be more concise. */ > + > + odp_tm_sched_params_init(&sched_params); /* <4> */ > + sched_params.sched_modes = { ODP_TM_FRAME_BASED_WEIGHTS, … }; > + sched_params.sched_weights = { 8, 8, 8, … }; > + sched_profile_RR = odp_tm_sched_create(“SchedProfileRR”, > &sched_params); > + > + sched_params.sched_modes = { ODP_TM_BYTE_BASED_WEIGHTS, … }; > + sched_params.sched_weights = { 8, 8, 8, … }; > + sched_profile_FQ = odp_tm_sched_create(“SchedProfileFQ”, > &sched_params); > + > + odp_tm_queue_sched_config(tm_node_1, tmq_A1, > sched_profile_RR); /* <5> */ > + odp_tm_queue_sched_config(tm_node_1, tmq_B1, sched_profile_RR); > + odp_tm_queue_sched_config(tm_node_1, tmq_A2, sched_profile_FQ); > + odp_tm_queue_sched_config(tm_node_1, tmq_B2, sched_profile_FQ); > + odp_tm_queue_sched_config(tm_node_1, tmq_C2, sched_profile_FQ); > + > + odp_tm_node_params_init(&node_params); /* <6> */ > + node_params.level = 2; > + tm_node_2 = odp_tm_node_create(tm, “TmNode2”, &node_params); > + > + odp_tm_node_connect(tm_node_1, tm_node_2); /* <7> */ > + > + odp_tm_sched_params_init(&sched_params); /* <8> */ > + sched_params.sched_modes = { ODP_TM_BYTE_BASED_WEIGHTS, … }; > + sched_params.sched_weights = { 8, 16, 24, … }; > + sched_profile_WFQ = odp_tm_sched_create(“SchedProfileWFQ”, > &sched_params); > + > + odp_tm_node_sched_config(tm_node_2, tm_node_1, > sched_profile_WFQ); /* <9> */ > +---- > + > +<1> Create a tm system, since that is a precursor to creating > tm_queues. > +<2> Create a Node #1 > +<3> Connect the Queue(s) to the Node -> odp_tm_queue_connect() > +<4> Create two sets of scheduler params – one implementing Round > Robin (since > +all weights are the same – namely 8) and the second implementing > Fair Queuing. > + > +<5> Associate the Scheduler to the Node and the Queue(s) -> > odp_tm_queue_sched_config() > +Use the Round Robin profile for the priority 1 fan-in’s and Fair > Queuing > +for the priority 2 fan-ins. > + > +<6> Create a second Node #2 > +<7> Connect the first Node #1 to the second Node #2 -> > odp_tm_node_connect() > +<8> Create a Scheduler Profile > +<9> Associate the Scheduler to the Node #1 and #2 -> > odp_tm_node_sched_config() > -- > 2.5.0 > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org <mailto:lng-odp@lists.linaro.org> > https://lists.linaro.org/mailman/listinfo/lng-odp > > > > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org > https://lists.linaro.org/mailman/listinfo/lng-odp
diff --git a/doc/users-guide/users-guide-tm.adoc b/doc/users-guide/users-guide-tm.adoc index dc0d003..e68157f 100644 --- a/doc/users-guide/users-guide-tm.adoc +++ b/doc/users-guide/users-guide-tm.adoc @@ -262,3 +262,86 @@ This header file defines some constants representing the absolute maximum settings for any TM system, though in most cases a TM system can (and should) be created/instantiated with smaller values, since lower values will often result in faster operation and/or less memory used. + +=== Examples + +.Create a tm_node chain for two nodes and associate the scheduler +[source,c] +---- + + odp_tm_params_init(&tm_params); /* <1> */ + tm_params.pktio = egress_pktio; + tm = odp_tm_create(“Example TM”, &tm_params); + +/* create 5 input queues here – two at priority 1 and three at priority 2. */ + + odp_tm_queue_params_init(&queue_params); + queue_params.priority = 1; + tmq_A1 = odp_tm_queue_create(tm, &queue_params); + tmq_B1 = odp_tm_queue_create(tm, &queue_params); + + queue_params.priority = 2; + tmq_A2 = odp_tm_queue_create(tm, &queue_params); + tmq_B2 = odp_tm_queue_create(tm, &queue_params); + tmq_C2 = odp_tm_queue_create(tm, &queue_params); + + odp_tm_node_params_init(&node_params); /* <2> */ + node_params.level = 1; + tm_node_1 = odp_tm_node_create(tm, “TmNode1”, &node_params); + + odp_tm_queue_connect(tmq_A1, tm_node_1); /* <3> */ + odp_tm_queue_connect(tmq_B1, tm_node_1); + odp_tm_queue_connect(tmq_A2, tm_node_1); + odp_tm_queue_connect(tmq_B2, tm_node_1); + odp_tm_queue_connect(tmq_C2, tm_node_1); + +/* It is IMPORTANT to understand that the following code does NOT create any +schedulers! In fact there is NO call to create a tm scheduler that exists +inside of a tm_node. Such an entity comes into existence as needed. What this +code does is create a scheduler PROFILE, which is effectively a registered set +of common scheduler parameters. NOTE that this uses some pseudocode below +instead of real C code so as to be more concise. */ + + odp_tm_sched_params_init(&sched_params); /* <4> */ + sched_params.sched_modes = { ODP_TM_FRAME_BASED_WEIGHTS, … }; + sched_params.sched_weights = { 8, 8, 8, … }; + sched_profile_RR = odp_tm_sched_create(“SchedProfileRR”, &sched_params); + + sched_params.sched_modes = { ODP_TM_BYTE_BASED_WEIGHTS, … }; + sched_params.sched_weights = { 8, 8, 8, … }; + sched_profile_FQ = odp_tm_sched_create(“SchedProfileFQ”, &sched_params); + + odp_tm_queue_sched_config(tm_node_1, tmq_A1, sched_profile_RR); /* <5> */ + odp_tm_queue_sched_config(tm_node_1, tmq_B1, sched_profile_RR); + odp_tm_queue_sched_config(tm_node_1, tmq_A2, sched_profile_FQ); + odp_tm_queue_sched_config(tm_node_1, tmq_B2, sched_profile_FQ); + odp_tm_queue_sched_config(tm_node_1, tmq_C2, sched_profile_FQ); + + odp_tm_node_params_init(&node_params); /* <6> */ + node_params.level = 2; + tm_node_2 = odp_tm_node_create(tm, “TmNode2”, &node_params); + + odp_tm_node_connect(tm_node_1, tm_node_2); /* <7> */ + + odp_tm_sched_params_init(&sched_params); /* <8> */ + sched_params.sched_modes = { ODP_TM_BYTE_BASED_WEIGHTS, … }; + sched_params.sched_weights = { 8, 16, 24, … }; + sched_profile_WFQ = odp_tm_sched_create(“SchedProfileWFQ”, &sched_params); + + odp_tm_node_sched_config(tm_node_2, tm_node_1, sched_profile_WFQ); /* <9> */ +---- + +<1> Create a tm system, since that is a precursor to creating tm_queues. +<2> Create a Node #1 +<3> Connect the Queue(s) to the Node -> odp_tm_queue_connect() +<4> Create two sets of scheduler params – one implementing Round Robin (since +all weights are the same – namely 8) and the second implementing Fair Queuing. + +<5> Associate the Scheduler to the Node and the Queue(s) -> odp_tm_queue_sched_config() +Use the Round Robin profile for the priority 1 fan-in’s and Fair Queuing +for the priority 2 fan-ins. + +<6> Create a second Node #2 +<7> Connect the first Node #1 to the second Node #2 -> odp_tm_node_connect() +<8> Create a Scheduler Profile +<9> Associate the Scheduler to the Node #1 and #2 -> odp_tm_node_sched_config()
Signed-off-by: Mike Holmes <mike.holmes@linaro.org> --- doc/users-guide/users-guide-tm.adoc | 83 +++++++++++++++++++++++++++++++++++++ 1 file changed, 83 insertions(+)