From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 41890A31F3 for ; Sat, 19 Oct 2019 19:04:58 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 3A4601BEA4; Sat, 19 Oct 2019 19:04:58 +0200 (CEST) Received: from mail-pg1-f180.google.com (mail-pg1-f180.google.com [209.85.215.180]) by dpdk.org (Postfix) with ESMTP id D9E171BF61 for ; Sat, 19 Oct 2019 19:04:56 +0200 (CEST) Received: by mail-pg1-f180.google.com with SMTP id f14so5100742pgi.9 for ; Sat, 19 Oct 2019 10:04:56 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:subject:date:message-id:in-reply-to:references; bh=1T8f/xOF3Z/ZkiaipCNKKBopommZVCo3At5wa4SK3+Y=; b=dKs7nsBHYIk262EcMCO+TKJEGOaJz2oQWJrl85vDwLR5XAttWSQfFxZNWABWlM6tri TwIW7XGKaOwJerPCOVk93t2Z/vu8/AJnz9DiPuvz9Nd88a+oD6zcH7gxQNdzXypdhnDR BsBh/m6dXVNDk4oUS84+35B6Ce2xU2H7GXamAF0cA/TzlnsjsGakFOTZEhh1Nu+xl9YC KYlUi5NdNt/sH2Kc54p1IbXCSrK07iQT/v6d6FoSk2A3dU/UA80cCaZbBZVvqhcHOKVB 3iWcOUq9C/4rpt75iJaGMbAW12Woz37sjlgVxYA7QPlJUZLsHTOzot9wmW+dtIloduZU xzyQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references; bh=1T8f/xOF3Z/ZkiaipCNKKBopommZVCo3At5wa4SK3+Y=; b=Wig/0jNOby2SRub4yH+S2LJbqytlqs5DRzPNdz4+DBuyxt7ovs+Ll+OFaizAizEcnb b7SXuRFjk4+1l8Mw8C7SMDBoiSkkN6hRzV76lgaW3mKvIaIDgz6n6vQJTy+zrGWEb7aa a62CgUPF7C/mssacRMugbuwlSFvNmf0Y9ll5VJK7OsgR8v9/medaCYfFGecudmkUcnwt 0GSXBUFtiG65eSJKKzszjF9Vm1y4S/L/mJ8IAuXofTrE12sTgZt558mPcaghZMMM02WF +Jw5EXHYxTdBbJm7jTwKpC1k6oy+nVFHDqTGNtZ/t9X9NVWqdkg/qcITaaMaFM0PRcbw qGbA== X-Gm-Message-State: APjAAAUSbwqdWe+1lcMSuDlMaMlwuXMEfNJb9U4XNf4q+RNbbCRe3Ger M/1JVAz7S+jj4bPYT+8aDsoI/42tCFo= X-Google-Smtp-Source: APXvYqzmfmxLAgIS0l6L/3E96q0RjVB+pM8Fs4bxt9VWf10oBqloj9Hmyq9djDDtedt/Vflj5Kx/9w== X-Received: by 2002:a17:90a:9ae:: with SMTP id 43mr18143600pjo.65.1571504695765; Sat, 19 Oct 2019 10:04:55 -0700 (PDT) Received: from localhost.localdomain ([2400:4050:c8c2:de00:188c:998e:6041:844a]) by smtp.gmail.com with ESMTPSA id 206sm9493122pge.80.2019.10.19.10.04.54 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 19 Oct 2019 10:04:55 -0700 (PDT) From: Yasufumi Ogawa To: spp@dpdk.org, ferruh.yigit@intel.com, yasufum.o@gmail.com Date: Sun, 20 Oct 2019 02:04:43 +0900 Message-Id: <20191019170443.23225-6-yasufum.o@gmail.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20191019170443.23225-1-yasufum.o@gmail.com> References: <20191019170443.23225-1-yasufum.o@gmail.com> Subject: [spp] [PATCH 5/5] docs: add pri commands for forwarder X-BeenThere: spp@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: Soft Patch Panel List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: spp-bounces@dpdk.org Sender: "spp" This update is to add `add`, `del`, `forward`, `stop` and `patch` commands for spp_primary in `SPP Commands`. Signed-off-by: Yasufumi Ogawa --- docs/guides/commands/primary.rst | 160 +++++++++++++++++++-- docs/guides/commands/secondary/spp_nfv.rst | 8 +- 2 files changed, 151 insertions(+), 17 deletions(-) diff --git a/docs/guides/commands/primary.rst b/docs/guides/commands/primary.rst index da60947..54aead4 100644 --- a/docs/guides/commands/primary.rst +++ b/docs/guides/commands/primary.rst @@ -44,22 +44,49 @@ All of Sub commands are referred with ``help`` command. status ------ -Show status fo spp_primary and forwarding statistics of each of ports. +Show status fo ``spp_primary`` and forwarding statistics of each of ports. .. code-block:: console spp > pri; status - - lcores: - - [0] - - physical ports: - ID rx tx tx_drop mac_addr - 0 0 0 0 56:48:4f:53:54:00 - 1 0 0 0 56:48:4f:53:54:01 - - ring Ports: - ID rx tx rx_drop tx_drop - 0 0 0 0 0 - 1 0 0 0 0 - ... + - lcore_ids: + - master: 0 + - stats + - physical ports: + ID rx tx tx_drop mac_addr + 0 0 0 0 56:48:4f:53:54:00 + 1 0 0 0 56:48:4f:53:54:01 + - ring ports: + ID rx tx rx_drop tx_drop + 0 0 0 0 0 + 1 0 0 0 0 + 2 0 0 0 0 + ... + +If you run ``spp_primary`` with forwarder thread, status of the forwarder is +also displayed. + +.. code-block:: console + + spp > pri; status + - lcore_ids: + - master: 0 + - slave: 1 + - forwarder: + - status: idling + - ports: + - phy:0 + - phy:1 + - stats + - physical ports: + ID rx tx tx_drop mac_addr + 0 0 0 0 56:48:4f:53:54:00 + 1 0 0 0 56:48:4f:53:54:01 + - ring ports: + ID rx tx rx_drop tx_drop + 0 0 0 0 0 + 1 0 0 0 0 + ... .. _commands_primary_clear: @@ -75,12 +102,119 @@ Clear statistics. Clear port statistics. +.. _commands_primary_add: + +add +--- + +Add a port with resource ID. + +For example, adding ``ring:0`` by + +.. code-block:: console + + spp > pri; add ring:0 + Add ring:0. + +Or adding ``vhost:0`` by + +.. code-block:: console + + spp > pri; add vhost:0 + Add vhost:0. + + +.. _commands_primary_patch: + +patch +------ + +Create a path between two ports, source and destination ports. +This command just creates a path and does not start forwarding. + +.. code-block:: console + + spp > pri; patch phy:0 ring:0 + Patch ports (phy:0 -> ring:0). + + +.. _commands_primary_forward: + +forward +------- + +Start forwarding. + +.. code-block:: console + + spp > pri; forward + Start forwarding. + +Running status is changed from ``idling`` to ``running`` by +executing it. + +.. code-block:: console + + spp > pri; status + - lcore_ids: + - master: 0 + - slave: 1 + - forwarder: + - status: running + - ports: + - phy:0 + - phy:1 + ... + + +.. _commands_primary_stop: + +stop +---- + +Stop forwarding. + +.. code-block:: console + + spp > pri; stop + Stop forwarding. + +Running status is changed from ``running`` to ``idling`` by +executing it. + +.. code-block:: console + + spp > pri; status + - lcore_ids: + - master: 0 + - slave: 1 + - forwarder: + - status: idling + - ports: + - phy:0 + - phy:1 + ... + + +.. _commands_primary_del: + +del +--- + +Delete a port of given resource UID. + +.. code-block:: console + + spp > pri; del ring:0 + Delete ring:0. + + .. _commands_primary_launch: launch ------ -Launch secondary process. +Launch a secondary process. Spp_primary is able to launch a secondary process with given type, secondary ID and options of EAL and application itself. This is a list of supported type diff --git a/docs/guides/commands/secondary/spp_nfv.rst b/docs/guides/commands/secondary/spp_nfv.rst index d6db76e..6389b73 100644 --- a/docs/guides/commands/secondary/spp_nfv.rst +++ b/docs/guides/commands/secondary/spp_nfv.rst @@ -72,14 +72,14 @@ For example, adding ``ring:0`` by .. code-block:: console - spp> nfv 1; add ring:0 + spp > nfv 1; add ring:0 Add ring:0. Or adding ``vhost:0`` by .. code-block:: console - spp> nfv 1; add vhost:0 + spp > nfv 1; add vhost:0 Add vhost:0. @@ -154,7 +154,7 @@ Delete a port from the secondary. .. code-block:: console - spp> nfv 1; del ring:0 + spp > nfv 1; del ring:0 Delete ring:0. @@ -168,4 +168,4 @@ use ``bye sec`` command instead of it. .. code-block:: console - spp> nfv 1; exit + spp > nfv 1; exit -- 2.17.1