From patchwork Mon Nov 2 17:41:16 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 55904 Delivered-To: patch@linaro.org Received: by 10.112.61.134 with SMTP id p6csp1395760lbr; Mon, 2 Nov 2015 09:41:38 -0800 (PST) X-Received: by 10.107.47.24 with SMTP id j24mr22824725ioo.168.1446486098454; Mon, 02 Nov 2015 09:41:38 -0800 (PST) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id av8si13035066igc.7.2015.11.02.09.41.37; Mon, 02 Nov 2015 09:41:38 -0800 (PST) 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; dkim=neutral (body hash did not verify) header.i=@linaro_org.20150623.gappssmtp.com Received: by lists.linaro.org (Postfix, from userid 109) id 9AB4E61B5D; Mon, 2 Nov 2015 17:41:37 +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.5 required=5.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, T_DKIM_INVALID, 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 5369861B1B; Mon, 2 Nov 2015 17:41:31 +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 492C561B3B; Mon, 2 Nov 2015 17:41:27 +0000 (UTC) Received: from mail-qk0-f180.google.com (mail-qk0-f180.google.com [209.85.220.180]) by lists.linaro.org (Postfix) with ESMTPS id 698B261AF3 for ; Mon, 2 Nov 2015 17:41:25 +0000 (UTC) Received: by qkct129 with SMTP id t129so1465549qkc.2 for ; Mon, 02 Nov 2015 09:41:25 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro_org.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=BVAHl6bogKw2bREq4eEb6YGzE9GfGTon4ExtA6Y4yMk=; b=y/tj9wjEQRdxU6a4MTcRAX+dUQxAy1LrqMlUqRyWfDi9lnw+KKwj257DLolhykfLrE RvDuav9/EM5Bfre8QQrv1tSeNpA4uf3HfDpNsOmC7Bt6cLOL15rKbf10bbP3OeRq5Iiv x/EkeCO7q/VKSyhDjLU89NjrXf0+UDIzSOyiufOKkqpbfEBnxwJBYzedJfopRp/sEQUM twc9r4BkLEok2eJZG18MLY8qCpiHYDc6aJtNkMkAcRPyZqcXy1UmsKT3Jy1xzZ9TlTwe X9Mttmti492w402GazLanU/x0vRcBeDedSVnwPKSGFfBpvpZYBstNpKjIV5kC9WF07S6 0xDw== 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:in-reply-to :references; bh=BVAHl6bogKw2bREq4eEb6YGzE9GfGTon4ExtA6Y4yMk=; b=R1f+Gl/HSId/Nfarrsji1lp7kB9VP81PCWQyzkfoniaBtZBkqQZTWtx/IjNKO3Gm9l HNPoPak6OoDv3ppwYpWn/QUplQ78fM/6yig2Ww4tDbzagrzY5x8OeTzMBnlZt+V8AqE+ zCYNW8fHxaWr2bkBd2+9JkU1k0uvvTC6kLayfuoY4Sz/MRFNdzHgZNYipmhQJXPzjjAD fC6ERKAvaMXKth71NLs8l2b7TqLzDn6ozjE+qPEDK4nOI3PQptLilBVNmwvwyCaVANiq x9uEfs1o2+BLZZbTUm0zAck3JhHP/lqxnrZq9x9IIr2YunvHgGVz3Piij4mq+s+M95bM 2j+A== X-Gm-Message-State: ALoCoQlqr4I3hofDCytIdZd4lwdbmLsgmlsAa/3itZQgSU8EIrQvn89/qvVmAymRWq2sOJr9O4Vi X-Received: by 10.55.55.82 with SMTP id e79mr30358820qka.59.1446486085068; Mon, 02 Nov 2015 09:41:25 -0800 (PST) Received: from localhost.localdomain (c-98-221-136-245.hsd1.nj.comcast.net. [98.221.136.245]) by smtp.gmail.com with ESMTPSA id r67sm8299312qki.17.2015.11.02.09.41.24 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 02 Nov 2015 09:41:24 -0800 (PST) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Mon, 2 Nov 2015 12:41:16 -0500 Message-Id: <1446486077-14973-2-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 2.5.0 In-Reply-To: <1446486077-14973-1-git-send-email-mike.holmes@linaro.org> References: <1446486077-14973-1-git-send-email-mike.holmes@linaro.org> X-Topics: patch Subject: [lng-odp] [PATCH v2 2/3] doc: images: add resource_management.msc for users-guide 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: Mike Holmes --- DEPENDENCIES | 5 +++++ configure.ac | 10 +++++++++ doc/images/Makefile.am | 13 +++++++++-- doc/images/resource_management.msc | 45 ++++++++++++++++++++++++++++++++++++++ 4 files changed, 71 insertions(+), 2 deletions(-) create mode 100644 doc/images/resource_management.msc diff --git a/DEPENDENCIES b/DEPENDENCIES index 7d22bde..d551a58 100644 --- a/DEPENDENCIES +++ b/DEPENDENCIES @@ -194,6 +194,11 @@ Prerequisites for building the OpenDataPlane (ODP) API # Debian/Ubuntu # apt-get install imagemagick + Message squence diagrams are stored as msc files and the png or eps versions generated when the docs are built + mscgen is used + #Debian/Ubuntu + # apt-get install mscgen + 5.1 API Guide See http://www.stack.nl/~dimitri/doxygen/manual/install.html diff --git a/configure.ac b/configure.ac index 5cf07ca..d9669b9 100644 --- a/configure.ac +++ b/configure.ac @@ -258,6 +258,16 @@ AM_CONDITIONAL([user_guide], [test "x${user_guides}" = "xyes" ]) AM_CONDITIONAL([HAVE_IMAGEMAGIC], [test "x${IMAGEMAGIC}" = "xconvert"]) ########################################################################## +# Check for mscgen availability +########################################################################## + AC_CHECK_PROGS([MSCGEN], [mscgen]) + if test -z "$MSCGEN"; + then AC_MSG_WARN([mscgen not found - continuing without sequence message support]) + fi + +AM_CONDITIONAL([HAVE_MSCGEN], [test "x${MSCGEN}" = "xmscgen"]) + +########################################################################## # Save and set temporary compilation flags ########################################################################## OLD_LDFLAGS=$LDFLAGS diff --git a/doc/images/Makefile.am b/doc/images/Makefile.am index df8f9d4..0f9a8a8 100644 --- a/doc/images/Makefile.am +++ b/doc/images/Makefile.am @@ -3,8 +3,10 @@ SVG_SRCS = atomic_queue.svg \ parallel_queue.svg SVG_TARGETS = $(SVG_SRCS:svg=png) SVG_TARGETS += $(SVG_SRCS:svg=eps) +MSG_SRCS = resource_management.msc +MSG_TARGETS = $(MSG_SRCS:msc=png) -EXTRA_DIST = $(SVG_SRCS) +EXTRA_DIST = $(SVG_SRCS) $(MSG_SRCS) TARGETS= @@ -12,10 +14,14 @@ if HAVE_IMAGEMAGIC TARGETS += $(SVG_TARGETS) endif +if HAVE_MSCGEN +TARGETS += $(MSG_TARGETS) +endif + all-local: $(TARGETS) clean-local: - rm -f $(TARGETS) + rm -f $(SVG_TARGETS) $(MSG_TARGETS) atomic_queue.png: atomic_queue.svg convert $< $@ @@ -31,3 +37,6 @@ parallel_queue.png: parallel_queue.svg convert $< $@ ordered_queue.eps: ordered_queue.svg convert $< $@ + +resource_management.png: resource_management.msc + mscgen -T png -i $< -o $@ diff --git a/doc/images/resource_management.msc b/doc/images/resource_management.msc new file mode 100644 index 0000000..fa54c4c --- /dev/null +++ b/doc/images/resource_management.msc @@ -0,0 +1,45 @@ +# ODP resource management +msc { + + a,b,c; + + a->a [ label = "odp_init_global()"]; + a->b [ label = "odp_thread_start()"]; + a->c [ label = "odp_thread_start()"]; + a->a [ label = "odp_init_local()"], + b->b [ label = "odp_init_local()"], + c->c [ label = "odp_init_local()"]; + ---; + b->b [ label = "pool = odp_pool_create()", textcolour="#7f7fff"]; + + a->a [ label = "barrier()"], + b->b [ label = "barrier()"], + c->c [ label = "barrier()"]; + + a->a [ label = " buf = alloc(pool)", textcolour="#ffb000"], + b->b [ label = " buf = alloc(pool)", textcolour="#ffb000"], + c->c [ label = " buf = alloc(pool)", textcolour="#ffb000"]; + + a->a [ label = " free(buf)", textcolour="#ffb000"], + b->b [ label = " free(buf)", textcolour="#ffb000"], + c->c [ label = " free(buf)", textcolour="#ffb000"]; + + a->a [ label = "barrier()"], + b->b [ label = "barrier()"], + c->c [ label = "barrier()"]; + + a->a [ label = "pool = odp_pool_destroy(pool)", textcolour="#7f7fff"]; + ---; + a->a [ label = "barrier()"], + b->b [ label = "barrier()"], + c->c [ label = "barrier()"]; + + --- [ label = "do work", ID="*" ]; + + a->a [ label = "odp_term_local()"], + b->b [ label = "odp_term_local()"], + c->c [ label = "odp_term_local()"]; + b->a [ label = "odp_thread_term()"]; + c->a [ label = "odp_thread_term()"]; + a->a [ label = "odp_term_global()"]; +}