From patchwork Tue May 10 23:46:00 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 67479 Delivered-To: patch@linaro.org Received: by 10.140.92.199 with SMTP id b65csp2388469qge; Tue, 10 May 2016 16:46:15 -0700 (PDT) X-Received: by 10.140.38.165 with SMTP id t34mr274662qgt.47.1462923975653; Tue, 10 May 2016 16:46:15 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id s39si3187690qgs.6.2016.05.10.16.46.15; Tue, 10 May 2016 16:46:15 -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 EB95C61586; Tue, 10 May 2016 23:46:14 +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 A6810611FB; Tue, 10 May 2016 23:46:09 +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 A08566157C; Tue, 10 May 2016 23:46:07 +0000 (UTC) Received: from mail-oi0-f49.google.com (mail-oi0-f49.google.com [209.85.218.49]) by lists.linaro.org (Postfix) with ESMTPS id 8954A61103 for ; Tue, 10 May 2016 23:46:06 +0000 (UTC) Received: by mail-oi0-f49.google.com with SMTP id x19so41985966oix.2 for ; Tue, 10 May 2016 16:46:06 -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=HtOrkVJASuwvImgJstJfv9+jgjj2ieG6YrP7KMAIT5c=; b=ZQQGnHJ+rOso3pPUIuarObDl3h1L9YAkSUi3yoJLL44kG0t+EH9hxx/0uKOqqB7Acu kEpsfCC/XlIS1sIAe69L0S0SQRvHpkP7/Lt6f7x39d7lKOLZovN0yWYeaEz2lr2RxjFA Ch0JltBcFIAr0Qmni0eDCpMSF4z3QFeP/vFyrob4oeAElkkEOu9AoU9Sx/3uNdIelKds oMd1X12FA+d5QYayGuRyjYHc6dmRh4Gi341nwcZ0vz9dKbqwD8ZHmqvVvR8D870nL4dp t57dnOQ6tYj3JC0tf141OKY6lrVM3arD9GbRhLw9lzDNc2C3OGch3LB/87c7S/xUoU+3 RtUQ== X-Gm-Message-State: AOPr4FXN4kczVO3wcDGqn/Hd7ke1RhRvlPFKJduJ8VrCQqOe5s4UicxZTaiKrnOgg+KZerh1GH8= X-Received: by 10.202.240.215 with SMTP id o206mr131671oih.132.1462923965974; Tue, 10 May 2016 16:46:05 -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 u41sm1308550otd.37.2016.05.10.16.46.02 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 10 May 2016 16:46:03 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Tue, 10 May 2016 18:46:00 -0500 Message-Id: <1462923961-6798-1-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.5.0 X-Topics: timers patch Subject: [lng-odp] [PATCHv3 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 | 55 +++++++++++++++++++++++++++++++++++++++++++++ doc/users-guide/Makefile.am | 1 + 3 files changed, 57 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..69370a2 --- /dev/null +++ b/doc/images/timer_fsm.gv @@ -0,0 +1,55 @@ +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 [fontcolor=green, + label="odp_timer_alloc()"]; + Timer_Alloc -> Timer_Unalloc [fontcolor=green, + label="odp_timer_free()"]; + + Timeout_Unalloc -> Timeout_Alloc + [fontcolor=blue, + label="odp_timeout_alloc()"]; + Timeout_Alloc -> Timeout_Unalloc + [fontcolor=blue, + label="odp_timeout_free()"]; + + Timer_Alloc -> Timer_Set [fontcolor=green, label="odp_timer_set_abs()"]; + Timer_Alloc -> Timer_Set [fontcolor=green, label="odp_timer_set_rel()"]; + Timer_Set -> Timer_Alloc [fontcolor=green, label="odp_timer_cancel()"]; + + Timeout_Alloc -> Timer_Set + [fontcolor=blue, + label="odp_timer_set_abs()"]; + Timeout_Alloc -> Timer_Set + [fontcolor=blue, label="odp_timer_set_rel()"]; + Timer_Set -> Timeout_Alloc + [fontcolor=blue, + label="odp_timer_cancel()"]; + + Timer_Set -> Timeout_Queued [fontcolor=red, label="=>odp_queue_enq()"]; + Timeout_Queued -> Timeout_Delivered [fontcolor=red, + label="odp_schedule()"]; + + Timeout_Delivered -> Timer_Unalloc [fontcolor=green, + label="odp_timer_free()"]; + Timeout_Delivered -> Timer_Set [fontcolor=green, + label="odp_timer_set_abs()"]; + Timeout_Delivered -> Timer_Set [fontcolor=green, + label="odp_timer_set_rel()"]; + Timeout_Delivered -> Timeout_Delivered + [fontcolor=blue, label="odp_timeout_from_event()"]; + Timeout_Delivered -> Timeout_Delivered + [fontcolor=green, label="odp_timeout_timer()"]; + Timeout_Delivered -> Timeout_Unalloc + [fontcolor=blue, + label="odp_event_free(), odp_timeout_free()" + 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