| Message ID | 1438728085-3240-6-git-send-email-bill.fischofer@linaro.org |
|---|---|
| State | New |
| Headers | show |
Hi, On 5 August 2015 at 04:11, Bill Fischofer <bill.fischofer@linaro.org> wrote: > Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> > --- > include/odp/api/schedule.h | 38 ++++++++++++++++++++++++-------------- > 1 file changed, 24 insertions(+), 14 deletions(-) > > diff --git a/include/odp/api/schedule.h b/include/odp/api/schedule.h > index 95fc8df..0ab91e4 100644 > --- a/include/odp/api/schedule.h > +++ b/include/odp/api/schedule.h > @@ -147,21 +147,31 @@ void odp_schedule_resume(void); > void odp_schedule_release_atomic(void); > > /** > - * Release the current ordered context > - * > - * This call is valid only for source queues with ordered > synchronization. It > - * hints the scheduler that the user has done all enqueues that need to > maintain > - * event order in the current ordered context. The scheduler is allowed to > - * release the ordered context of this thread and avoid reordering any > following > - * enqueues. However, the context may be still held until the next > - * odp_schedule() or odp_schedule_multi() call - this call allows but > does not > - * force the scheduler to release the context early. > - * > - * Early ordered context release may increase parallelism and thus system > - * performance, since scheduler may start reordering events sooner than > the next > - * schedule call. > + * Release the order associated with an event > + * > + * This call tells the scheduler that order no longer needs to be > maintained > + * for the specified event. This call is needed if, for example, the > caller > I believe we had agreed to modify the above sentence to include "specified event in this ordered context" Regards, Bala > + * will free or otherwise dispose of an event that came from an ordered > queue > + * without enqueuing it to another queue. This call does not effect the > + * ordering associated with any other event held by the caller. > + * > + * Order release may increase parallelism and thus system performance, > since > + * the scheduler may start resolving reordered events sooner than the next > + * odp_queue_enq() call. > + * > + * @param ev The event to be released from order preservation. > + * > + * @retval 0 Success. Upon return ev behaves as if it originated > + * from a parallel rather than an ordered queue. > + * > + * @retval <0 Failure. This can occur if the event did not originate > + * from an ordered queue (caller error) or the > implementation > + * is unable to release order at this time. In this case, > + * the caller must not dispose of ev without enqueing it > + * first to avoid deadlocking other events originating from > + * ev's ordered queue. > */ > -void odp_schedule_release_ordered(void); > +int odp_schedule_release_ordered(odp_event_t ev); > > /** > * Prefetch events for next schedule call > -- > 2.1.4 > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org > https://lists.linaro.org/mailman/listinfo/lng-odp >
Yes. I'll reword in v8. Thanks. On Wed, Aug 5, 2015 at 1:09 AM, Bala Manoharan <bala.manoharan@linaro.org> wrote: > Hi, > > On 5 August 2015 at 04:11, Bill Fischofer <bill.fischofer@linaro.org> > wrote: > >> Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> >> --- >> include/odp/api/schedule.h | 38 ++++++++++++++++++++++++-------------- >> 1 file changed, 24 insertions(+), 14 deletions(-) >> >> diff --git a/include/odp/api/schedule.h b/include/odp/api/schedule.h >> index 95fc8df..0ab91e4 100644 >> --- a/include/odp/api/schedule.h >> +++ b/include/odp/api/schedule.h >> @@ -147,21 +147,31 @@ void odp_schedule_resume(void); >> void odp_schedule_release_atomic(void); >> >> /** >> - * Release the current ordered context >> - * >> - * This call is valid only for source queues with ordered >> synchronization. It >> - * hints the scheduler that the user has done all enqueues that need to >> maintain >> - * event order in the current ordered context. The scheduler is allowed >> to >> - * release the ordered context of this thread and avoid reordering any >> following >> - * enqueues. However, the context may be still held until the next >> - * odp_schedule() or odp_schedule_multi() call - this call allows but >> does not >> - * force the scheduler to release the context early. >> - * >> - * Early ordered context release may increase parallelism and thus system >> - * performance, since scheduler may start reordering events sooner than >> the next >> - * schedule call. >> + * Release the order associated with an event >> + * >> + * This call tells the scheduler that order no longer needs to be >> maintained >> + * for the specified event. This call is needed if, for example, the >> caller >> > > I believe we had agreed to modify the above sentence to include "specified > event in this ordered context" > > Regards, > Bala > >> + * will free or otherwise dispose of an event that came from an ordered >> queue >> + * without enqueuing it to another queue. This call does not effect the >> + * ordering associated with any other event held by the caller. >> + * >> + * Order release may increase parallelism and thus system performance, >> since >> + * the scheduler may start resolving reordered events sooner than the >> next >> + * odp_queue_enq() call. >> + * >> + * @param ev The event to be released from order preservation. >> + * >> + * @retval 0 Success. Upon return ev behaves as if it originated >> + * from a parallel rather than an ordered queue. >> + * >> + * @retval <0 Failure. This can occur if the event did not originate >> + * from an ordered queue (caller error) or the >> implementation >> + * is unable to release order at this time. In this case, >> + * the caller must not dispose of ev without enqueing it >> + * first to avoid deadlocking other events originating >> from >> + * ev's ordered queue. >> */ >> -void odp_schedule_release_ordered(void); >> +int odp_schedule_release_ordered(odp_event_t ev); >> >> /** >> * Prefetch events for next schedule call >> -- >> 2.1.4 >> >> _______________________________________________ >> lng-odp mailing list >> lng-odp@lists.linaro.org >> https://lists.linaro.org/mailman/listinfo/lng-odp >> > >
diff --git a/include/odp/api/schedule.h b/include/odp/api/schedule.h index 95fc8df..0ab91e4 100644 --- a/include/odp/api/schedule.h +++ b/include/odp/api/schedule.h @@ -147,21 +147,31 @@ void odp_schedule_resume(void); void odp_schedule_release_atomic(void); /** - * Release the current ordered context - * - * This call is valid only for source queues with ordered synchronization. It - * hints the scheduler that the user has done all enqueues that need to maintain - * event order in the current ordered context. The scheduler is allowed to - * release the ordered context of this thread and avoid reordering any following - * enqueues. However, the context may be still held until the next - * odp_schedule() or odp_schedule_multi() call - this call allows but does not - * force the scheduler to release the context early. - * - * Early ordered context release may increase parallelism and thus system - * performance, since scheduler may start reordering events sooner than the next - * schedule call. + * Release the order associated with an event + * + * This call tells the scheduler that order no longer needs to be maintained + * for the specified event. This call is needed if, for example, the caller + * will free or otherwise dispose of an event that came from an ordered queue + * without enqueuing it to another queue. This call does not effect the + * ordering associated with any other event held by the caller. + * + * Order release may increase parallelism and thus system performance, since + * the scheduler may start resolving reordered events sooner than the next + * odp_queue_enq() call. + * + * @param ev The event to be released from order preservation. + * + * @retval 0 Success. Upon return ev behaves as if it originated + * from a parallel rather than an ordered queue. + * + * @retval <0 Failure. This can occur if the event did not originate + * from an ordered queue (caller error) or the implementation + * is unable to release order at this time. In this case, + * the caller must not dispose of ev without enqueing it + * first to avoid deadlocking other events originating from + * ev's ordered queue. */ -void odp_schedule_release_ordered(void); +int odp_schedule_release_ordered(odp_event_t ev); /** * Prefetch events for next schedule call
Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> --- include/odp/api/schedule.h | 38 ++++++++++++++++++++++++-------------- 1 file changed, 24 insertions(+), 14 deletions(-)