From patchwork Sat May 7 16:15:07 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 67317 Delivered-To: patch@linaro.org Received: by 10.140.92.199 with SMTP id b65csp842391qge; Sat, 7 May 2016 09:15:20 -0700 (PDT) X-Received: by 10.107.161.68 with SMTP id k65mr32990970ioe.110.1462637720572; Sat, 07 May 2016 09:15:20 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id m6si672553ioa.20.2016.05.07.09.15.19; Sat, 07 May 2016 09:15:20 -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; Authentication-Results: mx.google.com; spf=pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) smtp.mailfrom=lng-odp-bounces@lists.linaro.org; dmarc=pass (p=NONE dis=NONE) header.from=linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id 378406163C; Sat, 7 May 2016 16:15:19 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on ip-10-142-244-252 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 [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 308B4615CE; Sat, 7 May 2016 16:15:15 +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 63780615C4; Sat, 7 May 2016 16:15:12 +0000 (UTC) Received: from mail-oi0-f46.google.com (mail-oi0-f46.google.com [209.85.218.46]) by lists.linaro.org (Postfix) with ESMTPS id 66ED7615C4 for ; Sat, 7 May 2016 16:15:11 +0000 (UTC) Received: by mail-oi0-f46.google.com with SMTP id k142so170415027oib.1 for ; Sat, 07 May 2016 09:15:11 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=RItqW08drp28G7m74LacVkeG7j2NEFxxcKmGnBEbw6Q=; b=gkCsipNquJfkQQyKPoRTr61ZV7WFcBilMLLyfYX3ADk4x0GMM0GauZOT0hWF8HYuqq HrEsBnBkdkc3U/thJ4GOopvdEdlNexyPCiYjKEVYbDdO8U97W8SUIRwsaKMlgJ+1t8rj mCVK1TyWar3dAQ6iAAeTgUVV4y8bYxIfGNmO8q+KnN47eCE1rWTzW+9po/sk8zcVHHK1 x8sPz1khesJOPsgj7rKowU2itAg8qnO9YodUkMntwSyHr6RYKrieZbtj/TWjX5TB81NI GZI/Ka50XnFPMlp1pK6n4Iem3NQJgAku55nDuZLIRb3I1S1WG2iQe7Aeo52IIdtCTlcm 87JQ== X-Gm-Message-State: AOPr4FVRQwr8rVJL6+vN4TIkze07hjNHTSFCJUAeHpm2CERNkn1et56mbgz8ltDXTm0z6o7OHaU= X-Received: by 10.202.179.8 with SMTP id c8mr12283262oif.50.1462637710830; Sat, 07 May 2016 09:15:10 -0700 (PDT) Received: from Ubuntu15.localdomain (cpe-66-68-129-43.austin.res.rr.com. [66.68.129.43]) by smtp.gmail.com with ESMTPSA id mz4sm6485558obb.20.2016.05.07.09.15.09 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Sat, 07 May 2016 09:15:10 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Sat, 7 May 2016 11:15:07 -0500 Message-Id: <1462637708-1491-1-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.5.0 X-Topics: timers patch Subject: [lng-odp] [PATCHv2 1/2] doc: userguide: add timer/timeout state diagram X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.16 Precedence: list List-Id: "The OpenDataPlane \(ODP\) List" 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" Signed-off-by: Bill Fischofer --- doc/images/.gitignore | 1 + doc/images/timer_fsm.gv | 38 ++++++++++++++++++++++++++++++++++++++ doc/users-guide/Makefile.am | 1 + 3 files changed, 40 insertions(+) create mode 100644 doc/images/timer_fsm.gv diff --git a/doc/images/.gitignore b/doc/images/.gitignore index a19aa75..72cf7ec 100644 --- a/doc/images/.gitignore +++ b/doc/images/.gitignore @@ -1,2 +1,3 @@ resource_management.svg pktio_fsm.svg +timer_fsm.svg diff --git a/doc/images/timer_fsm.gv b/doc/images/timer_fsm.gv new file mode 100644 index 0000000..f8cb21a --- /dev/null +++ b/doc/images/timer_fsm.gv @@ -0,0 +1,38 @@ +digraph timer_state_machine { + rankdir=LR; + size="12,20"; + node [fontsize=28]; + edge [fontsize=28]; + node [shape=doublecircle]; Timer_Unalloc + Timeout_Unalloc + Timeout_Delivered; + node [shape=rectangle]; Timeout_Queued; + node [shape=circle]; + Timer_Unalloc -> Timer_Alloc [label="odp_timer_alloc()"]; + Timer_Alloc -> Timer_Unalloc [label="odp_timer_free()"]; + Timer_Alloc -> Timer_Set [label="odp_timer_set_abs()"]; + Timer_Alloc -> Timer_Set [label="odp_timer_set_rel()"]; + Timer_Set -> Timer_Alloc [label="odp_timer_cancel()"]; + Timer_Set -> Timeout_Alloc + [label="odp_timer_cancel()" constraint=false]; + Timer_Set -> Timeout_Queued [label="=>odp_queue_enq()"]; + Timeout_Queued -> Timeout_Delivered [label="odp_schedule()"]; + Timeout_Unalloc -> Timeout_Alloc + [label="odp_timeout_alloc()" constraint=false]; + Timeout_Alloc -> Timeout_Unalloc + [label="odp_timeout_free()" constraint=false]; + Timeout_Alloc -> Timer_Set + [label="odp_timer_set_abs()" constraint=false]; + Timeout_Alloc -> Timer_Set + [label="odp_timer_set_rel()"]; + Timeout_Delivered -> Timer_Unalloc [label="odp_timer_free()"]; + Timeout_Delivered -> Timer_Set [label="odp_timer_set_abs()"]; + Timeout_Delivered -> Timer_Set [label="odp_timer_set_rel()"]; + Timeout_Delivered -> Timeout_Delivered + [label="odp_timeout_from_event()"]; + Timeout_Delivered -> Timeout_Delivered + [label="odp_timeout_timer()"]; + Timeout_Delivered -> Timeout_Unalloc + [label="odp_event_free() / odp_timeout_freee()" + constraint=false]; +} diff --git a/doc/users-guide/Makefile.am b/doc/users-guide/Makefile.am index 74caa96..6bb0131 100644 --- a/doc/users-guide/Makefile.am +++ b/doc/users-guide/Makefile.am @@ -30,6 +30,7 @@ IMAGES = $(top_srcdir)/doc/images/overview.svg \ $(top_srcdir)/doc/images/release_git.svg \ $(top_srcdir)/doc/images/segment.svg \ $(top_srcdir)/doc/images/simple_release_git.svg \ + $(top_srcdir)/doc/images/timer_fsm.svg \ $(top_srcdir)/doc/images/tm_hierarchy.svg \ $(top_srcdir)/doc/images/tm_node.svg