From patchwork Mon Aug 3 22:29:35 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 51886 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-la0-f69.google.com (mail-la0-f69.google.com [209.85.215.69]) by patches.linaro.org (Postfix) with ESMTPS id 0973A228F2 for ; Mon, 3 Aug 2015 22:35:58 +0000 (UTC) Received: by labth1 with SMTP id th1sf26939785lab.2 for ; Mon, 03 Aug 2015 15:35:57 -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=etGmQdQD36oDLVuh2zX8nVDn4vK19nPycoEUmLDAL0M=; b=aRknspS+5bEkvEGPN+gOnbrbPRQnPnUHQCidsupRprhjZ12+1P3ayYhxWyx7us5bAY 7bo6Uu/6wX5vL+XJ+xGvKNXpusWBIcL4LZogekJrXokEOKEBvxITwraaWvR+fFnWS5to CwOyWxNRGbyltpAOJIy4GaYCWIxagBUcWn8OR+Fl3pby85yJwGYonAszkbI4KUQDk3oU l9ZUx9DaSWfu+OUvJs3q0i9/Gg6dOIPPNT6F2WO9kBlbpKqCSs0kDlwC8tLpVa9cehKN 5mNTEvyuCYZQr4bnyXw7ZJcC8XqyR6BYzO5A2CEehgdISRfjEUUMhMFPdGPCLCmM8RI0 1z0Q== X-Gm-Message-State: ALoCoQn6u9BAiTzZ1UAw5VySe2HNjvP2vjKIsBSARLWCj4unE6k4ioFJ6CjshkoHwn3ckX1Q8gl1 X-Received: by 10.112.138.2 with SMTP id qm2mr109652lbb.19.1438641356968; Mon, 03 Aug 2015 15:35:56 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.2.202 with SMTP id 10ls762291law.79.gmail; Mon, 03 Aug 2015 15:35:56 -0700 (PDT) X-Received: by 10.112.161.197 with SMTP id xu5mr283110lbb.69.1438641356693; Mon, 03 Aug 2015 15:35:56 -0700 (PDT) Received: from mail-lb0-f177.google.com (mail-lb0-f177.google.com. [209.85.217.177]) by mx.google.com with ESMTPS id w18si13221848laz.27.2015.08.03.15.35.56 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 03 Aug 2015 15:35:56 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.177 as permitted sender) client-ip=209.85.217.177; Received: by lbbud7 with SMTP id ud7so81512914lbb.3 for ; Mon, 03 Aug 2015 15:35:56 -0700 (PDT) X-Received: by 10.152.120.135 with SMTP id lc7mr291778lab.41.1438641356156; Mon, 03 Aug 2015 15:35:56 -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 l6csp2098441lba; Mon, 3 Aug 2015 15:35:55 -0700 (PDT) X-Received: by 10.55.31.65 with SMTP id f62mr652277qkf.73.1438641354636; Mon, 03 Aug 2015 15:35:54 -0700 (PDT) Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id q15si1673916qkq.98.2015.08.03.15.35.53; Mon, 03 Aug 2015 15:35:54 -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 C627161EFB; Mon, 3 Aug 2015 22:35:53 +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 0266561CBB; Mon, 3 Aug 2015 22:30:42 +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 29D5861EF3; Mon, 3 Aug 2015 22:30:33 +0000 (UTC) Received: from mail-oi0-f54.google.com (mail-oi0-f54.google.com [209.85.218.54]) by lists.linaro.org (Postfix) with ESMTPS id 2F4A961EF4 for ; Mon, 3 Aug 2015 22:29:52 +0000 (UTC) Received: by oibv126 with SMTP id v126so20501089oib.3 for ; Mon, 03 Aug 2015 15:29:51 -0700 (PDT) X-Received: by 10.202.232.67 with SMTP id f64mr282398oih.63.1438640991589; Mon, 03 Aug 2015 15:29:51 -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 fw2sm8211222obb.24.2015.08.03.15.29.50 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 03 Aug 2015 15:29:51 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Mon, 3 Aug 2015 17:29:35 -0500 Message-Id: <1438640978-16334-9-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.1.4 In-Reply-To: <1438640978-16334-1-git-send-email-bill.fischofer@linaro.org> References: <1438640978-16334-1-git-send-email-bill.fischofer@linaro.org> X-Topics: patch Subject: [lng-odp] [API-NEXT PATCHv6 08/11] api: queue: document ordered chain enq support 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.217.177 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/queue.h | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/include/odp/api/queue.h b/include/odp/api/queue.h index ce04eb4..5a6dbc0 100644 --- a/include/odp/api/queue.h +++ b/include/odp/api/queue.h @@ -173,6 +173,29 @@ int odp_queue_enq(odp_queue_t queue, odp_event_t ev); * * @return Number of events actually enqueued (0 ... num) * @retval <0 on failure + * + * @note odp_queue_enq_multi() serves two purposes. First, it allows + * multiple events to be enqueued via a single call. In addition, it + * permits multiple events to partitipate in ordering. When an event + * originating from an ordered queue is followed by one or more events + * that did not originate from an ordered queue, then these subsequent + * events are "chained" to the ordered event such that they participate + * in its ordering. This provides a convenient means for an application + * to split a packet into multiple packets and have them retain the + * relative order of the original packet. + * + * @note If multiple events originating from ordered queues are passed + * to odp_queue_enq_multi() then they (and their associated chains, if + * any) are handled independently. To see this, consider the following + * array of events: uo1, uo2, o1, uo3, uo4, o2, o3, uo5. When this + * array is passed to odp_queue_enq_multi() then unordered events uo1 and + * uo2 will be added to queue, then ordered event o1 and the chained + * events uo3, and uo4, will be added, then ordered event o2, then ordered + * event o3 and the chained event uo5 will be added. In all cases, + * unordered events that are chained to ordered events inherit the relative + * order of their ordered lead event. Note also that there is no + * requirement that the ordered events passed to this routine all originate + * from the same ordered queue sine each is treated independently. */ int odp_queue_enq_multi(odp_queue_t queue, const odp_event_t events[], int num);