From patchwork Fri Aug 7 11:47:15 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 52037 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-la0-f70.google.com (mail-la0-f70.google.com [209.85.215.70]) by patches.linaro.org (Postfix) with ESMTPS id A191120539 for ; Fri, 7 Aug 2015 11:56:49 +0000 (UTC) Received: by labth1 with SMTP id th1sf38867304lab.2 for ; Fri, 07 Aug 2015 04:56:48 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:delivered-to:delivered-to:from:to:date :message-id:in-reply-to:references:subject:precedence:list-id :list-unsubscribe:list-archive:list-post:list-help:list-subscribe :mime-version:content-type:content-transfer-encoding:errors-to :sender:x-original-sender:x-original-authentication-results :mailing-list; bh=wq9pIKZWn6QYiC6+gY90bkJUrFAfv1jb4ut1YN9oVNY=; b=UTYkDlS16nZ4/hESlDAsb8MEDriqKU3i4AiNvmB3uEan3/5O3sL3sbqjMRFxuV6k9H xVvVLYxL3vY7QRrk0YY9I2Ij+d3w+F63zOvkuM3rNOKEz40YwJa1f0rIT17dqTw3Iidz 7596UmzyG2urpWv2LGgX5boT0A7hYL1fyYhhvywpePjTD1zvJ570b3myRKqEFuDrcv1g c61GY1X3NtR5hPjWSt+wL8i43Em3iaMfWsZ07KfMPDgF7UXCpb6plAj4NjNH65RTfbFK c4NfXhOAk61+sGincBuQizdgrupdXpNEsDTv3AcFkRRR/ZptqH/iG92Zim+kjoFi26wo YV0g== X-Gm-Message-State: ALoCoQm97EBmHs0x5eG9DuNEQBINl+6dlpDR+aYxMEKWHZxPY3QPqd3to9K5BHhdf2VtpXtEGTGP X-Received: by 10.112.139.65 with SMTP id qw1mr1966296lbb.24.1438948608586; Fri, 07 Aug 2015 04:56:48 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.115.140 with SMTP id jo12ls177236lab.34.gmail; Fri, 07 Aug 2015 04:56:48 -0700 (PDT) X-Received: by 10.112.147.8 with SMTP id tg8mr7123297lbb.62.1438948608436; Fri, 07 Aug 2015 04:56:48 -0700 (PDT) Received: from mail-la0-f42.google.com (mail-la0-f42.google.com. [209.85.215.42]) by mx.google.com with ESMTPS id xk9si7260184lac.145.2015.08.07.04.56.48 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Fri, 07 Aug 2015 04:56:48 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.42 as permitted sender) client-ip=209.85.215.42; Received: by labkb6 with SMTP id kb6so44476909lab.2 for ; Fri, 07 Aug 2015 04:56:48 -0700 (PDT) X-Received: by 10.152.88.78 with SMTP id be14mr7054401lab.29.1438948608293; Fri, 07 Aug 2015 04:56:48 -0700 (PDT) X-Forwarded-To: patchwork-forward@linaro.org X-Forwarded-For: patch@linaro.org patchwork-forward@linaro.org Delivered-To: patch@linaro.org Received: by 10.112.7.198 with SMTP id l6csp323438lba; Fri, 7 Aug 2015 04:56:47 -0700 (PDT) X-Received: by 10.140.238.212 with SMTP id j203mr12922418qhc.32.1438948606764; Fri, 07 Aug 2015 04:56:46 -0700 (PDT) Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id q106si17462301qgq.84.2015.08.07.04.56.46; Fri, 07 Aug 2015 04:56:46 -0700 (PDT) Received-SPF: pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) client-ip=54.225.227.206; Received: by lists.linaro.org (Postfix, from userid 109) id 0DC1062028; Fri, 7 Aug 2015 11:56:46 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on ip-10-142-244-252.ec2.internal X-Spam-Level: X-Spam-Status: No, score=-2.6 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, URIBL_BLOCKED autolearn=disabled version=3.4.0 Received: from ip-10-142-244-252.ec2.internal (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id DF19C62202; Fri, 7 Aug 2015 11:48:58 +0000 (UTC) X-Original-To: lng-odp@lists.linaro.org Delivered-To: lng-odp@lists.linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id 62F5862204; Fri, 7 Aug 2015 11:48:54 +0000 (UTC) Received: from mail-ob0-f177.google.com (mail-ob0-f177.google.com [209.85.214.177]) by lists.linaro.org (Postfix) with ESMTPS id 48AD66218A for ; Fri, 7 Aug 2015 11:47:32 +0000 (UTC) Received: by obnw1 with SMTP id w1so76961859obn.3 for ; Fri, 07 Aug 2015 04:47:31 -0700 (PDT) X-Received: by 10.182.176.36 with SMTP id cf4mr6531823obc.40.1438948051773; Fri, 07 Aug 2015 04:47:31 -0700 (PDT) Received: from localhost.localdomain (cpe-24-28-70-239.austin.res.rr.com. [24.28.70.239]) by smtp.gmail.com with ESMTPSA id f128sm338865oig.2.2015.08.07.04.47.31 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Fri, 07 Aug 2015 04:47:31 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Fri, 7 Aug 2015 06:47:15 -0500 Message-Id: <1438948036-31868-13-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.1.4 In-Reply-To: <1438948036-31868-1-git-send-email-bill.fischofer@linaro.org> References: <1438948036-31868-1-git-send-email-bill.fischofer@linaro.org> X-Topics: patch Subject: [lng-odp] [API-NEXT PATCHv9 12/13] api: schedule: add odp_schedule_order_lock/unlock X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.16 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: , List-Help: , List-Subscribe: , MIME-Version: 1.0 Errors-To: lng-odp-bounces@lists.linaro.org Sender: "lng-odp" X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: bill.fischofer@linaro.org X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.42 as permitted sender) smtp.mail=patch+caf_=patchwork-forward=linaro.org@linaro.org Mailing-list: list patchwork-forward@linaro.org; contact patchwork-forward+owners@linaro.org X-Google-Group-Id: 836684582541 Signed-off-by: Bill Fischofer --- include/odp/api/schedule.h | 81 ++++++++++++++++++++++++---------------------- 1 file changed, 42 insertions(+), 39 deletions(-) diff --git a/include/odp/api/schedule.h b/include/odp/api/schedule.h index 61d3b16..f715144 100644 --- a/include/odp/api/schedule.h +++ b/include/odp/api/schedule.h @@ -174,6 +174,41 @@ void odp_schedule_release_atomic(void); int odp_schedule_release_ordered(odp_event_t ev); /** + * Ordered event lock + * + * Provide reusable in-order serialization for scheduled ordered events. Upon + * return the caller is in order with respect to other events originating from + * the current ordered context and will retain order until a subsequent + * odp_schedule_order_unlock() call is made, or until order is resolved for + * the event via a call to odp_queue_enq() or odp_schedule_release_ordered(). + * If the caller holds multiple events, e.g., as received from + * odp_schedule_multi(), then the list of events may only be locked in their + * received order to avoid deadlock. That is, if the caller received events + * 1, 2, and 3 from odp_schedule_multi(), it is an error to attempt to lock + * event 2 before locking and unlocking event 1 or otherwise resolving event + * 1's order. + * + * @param ev The event whose order is to be locked. This event MUST have + * originated from an ordered queue. + */ +void odp_schedule_order_lock(odp_event_t ev); + +/** + * Ordered event unlock + * + * Release an ordered lock previously acquired by odp_schedule_order_lock(). + * It is an error to attempt to release a lock that had not been previously + * acquired for the specified event. Following this call, the thread will + * exit the critical section protected by the ordered lock and will resume + * parallel execution until the next call to odp_schedule_order_lock() for + * that event, or until the event's order is resolved by a call to + * odp_queue_enq() or odp_schedule_release_ordered(). + * + * @param ev The event whose order is to be unlocked. + */ +void odp_schedule_order_unlock(odp_event_t ev); + +/** * Copy order from one event to another * * This call copies the order associated with an event originating from an @@ -181,14 +216,19 @@ int odp_schedule_release_ordered(odp_event_t ev); * associated ordering at input to the call. If the target is ordered, the * prior ordering must first be released by an odp_schedule_release_ordered() * call. Successfuly copying an order implicitly sets the order sustain - * attribute for the src_event as if odp_schedule_order_sustain() were called - * for it. + * attribute for the src_event as if odp_schedule_order_sustain_set() were + * called for it. * * @param src_event Event whose ordering is to be copied * @param dst_event Event to receive the same ordering as src_event. * * @retval 0 Success * @retval <0 Failure. Order not copied. + * + * @note If multiple events share the same order as a result of + * odp_schedule_order_copy(), only one of them should attempt to lock the + * order via calls to odp_schedule_order_lock(). Results are undefined if this + * restriction is not observed. */ int odp_schedule_order_copy(odp_event_t src_event, odp_event_t dst_event); @@ -336,43 +376,6 @@ int odp_schedule_group_leave(odp_schedule_group_t group, int odp_schedule_group_count(odp_schedule_group_t group); /** - * Initialize ordered context lock - * - * Initialize an ordered queue context lock. The lock can be associated only - * with ordered queues and used only within an ordered synchronization context. - * - * @param queue Ordered queue - * @param lock Ordered context lock - * - * @retval 0 on success - * @retval <0 on failure - */ -int odp_schedule_olock_init(odp_queue_t queue, odp_schedule_olock_t *lock); - -/** - * Acquire ordered context lock - * - * This call is valid only when holding an ordered synchronization context. The - * lock is used to protect a critical section that is executed within an - * ordered context. Threads enter the critical section in the order determined - * by the context (source queue). Lock ordering is automatically skipped for - * threads that release the context instead of calling the lock. - * - * @param lock Ordered context lock - */ -void odp_schedule_olock_lock(odp_schedule_olock_t *lock); - -/** - * Release ordered context lock - * - * This call is valid only when holding an ordered synchronization context. - * Release a previously locked ordered context lock. - * - * @param lock Ordered context lock - */ -void odp_schedule_olock_unlock(odp_schedule_olock_t *lock); - -/** * @} */