From patchwork Mon Feb 25 17:12:20 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Varghese, Vipin" X-Patchwork-Id: 50499 Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 9A31F2A6A; Mon, 25 Feb 2019 18:12:21 +0100 (CET) Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) by dpdk.org (Postfix) with ESMTP id E234C29C6 for ; Mon, 25 Feb 2019 18:12:19 +0100 (CET) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga005.jf.intel.com ([10.7.209.41]) by orsmga103.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 25 Feb 2019 09:12:18 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.58,411,1544515200"; d="scan'208";a="302415854" Received: from unknown (HELO saesrv02-S2600CWR.intel.com) ([10.224.122.203]) by orsmga005.jf.intel.com with ESMTP; 25 Feb 2019 09:12:15 -0800 From: Vipin Varghese To: john.mcnamara@intel.com, marko.kovacevic@intel.com, thomas@monjalon.net, ferruh.yigit@intel.com, shreyansh.jain@nxp.com, dev@dpdk.org Cc: sanjay.padubidri@intel.com, amol.patel@intel.com, Vipin Varghese Date: Mon, 25 Feb 2019 22:42:20 +0530 Message-Id: <20190225171222.64134-1-vipin.varghese@intel.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20190213054106.45163-1-vipin.varghese@intel.com> References: <20190213054106.45163-1-vipin.varghese@intel.com> Subject: [dpdk-dev] [PATCH v7 0/2] guide to debug and troubleshoot. X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" The patch series adds a how-to guide for debugging and troubleshooting tips. Motivation ========== DPDK proc-info tool is been enhanced to accommodate the debug information for the port, traffic manager crypto, ring and mempool contents. With these additional information, it becomes easy to analyze issues and performance variance. But applications are designed based on the target platform, workload, poll mode drivers, and multi-process. This raises variance in debugging and collecting data. Hence attempt of patch series is identified such symptoms and share step by step guide to cover the cases. Not all possible cases could be covered in a single attempt. But with feedback and support from the community, this can be expanded. Status ====== Reviews and changes accommodated. ACK received for documentation and SVG files. Change Log: ========== V7: - add space to note and indent - John Macnamara V6: - correction for word style and grammar - Thomas Monjalon - add license for svg files - Vipin Varghese v5: - rework of content - Vipin Varghese V4: - Correction for word style - Shreyansh Jain V3: - reorder for removing warning in 'make doc-guides-html' - Thomas Monjalon V2: - add offload flag check - Vipin Varghese - change tab to space - Marko Kovacevic - spelling correction - Marko Kovacevic - remove extra characters - Marko Kovacevic - add ACK by Marko - Vipn Varghese - add ACK from Marko - Vipin Varghese Vipin Varghese (2): doc: add svg for debug and troubleshoot guide doc: add guide for debug and troubleshoot doc/guides/howto/debug_troubleshoot_guide.rst | 465 ++++++++++++++++++ doc/guides/howto/img/dtg_consumer_ring.svg | 24 + doc/guides/howto/img/dtg_crypto.svg | 21 + .../howto/img/dtg_distributor_worker.svg | 36 ++ doc/guides/howto/img/dtg_mempool.svg | 27 + doc/guides/howto/img/dtg_pdump.svg | 33 ++ doc/guides/howto/img/dtg_producer_ring.svg | 24 + doc/guides/howto/img/dtg_qos_tx.svg | 29 ++ doc/guides/howto/img/dtg_rx_rate.svg | 25 + doc/guides/howto/img/dtg_rx_tx_drop.svg | 33 ++ doc/guides/howto/img/dtg_sample_app_model.svg | 110 +++++ doc/guides/howto/img/dtg_service.svg | 20 + doc/guides/howto/index.rst | 1 + 13 files changed, 848 insertions(+) create mode 100644 doc/guides/howto/debug_troubleshoot_guide.rst create mode 100644 doc/guides/howto/img/dtg_consumer_ring.svg create mode 100644 doc/guides/howto/img/dtg_crypto.svg create mode 100644 doc/guides/howto/img/dtg_distributor_worker.svg create mode 100644 doc/guides/howto/img/dtg_mempool.svg create mode 100644 doc/guides/howto/img/dtg_pdump.svg create mode 100644 doc/guides/howto/img/dtg_producer_ring.svg create mode 100644 doc/guides/howto/img/dtg_qos_tx.svg create mode 100644 doc/guides/howto/img/dtg_rx_rate.svg create mode 100644 doc/guides/howto/img/dtg_rx_tx_drop.svg create mode 100644 doc/guides/howto/img/dtg_sample_app_model.svg create mode 100644 doc/guides/howto/img/dtg_service.svg