From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by dpdk.org (Postfix) with ESMTP id AF62C2B95 for ; Tue, 9 Apr 2019 08:33:26 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga005.fm.intel.com ([10.253.24.32]) by fmsmga104.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 08 Apr 2019 23:33:25 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.60,328,1549958400"; d="scan'208";a="336190489" Received: from unknown (HELO saesrv02-S2600CWR.intel.com) ([10.224.122.203]) by fmsmga005.fm.intel.com with ESMTP; 08 Apr 2019 23:33:22 -0700 From: Vipin Varghese To: dev@dpdk.org, marko.kovacevic@intel.com, john.mcnamara@intel.com, shreyansh.jain@nxp.com Cc: keith.wiles@intel.com, amit.tamboli@intel.com, sanjay.padubidri@intel.com, amol.patel@intel.com, ferruh.yigit@intel.com, Vipin Varghese Date: Tue, 9 Apr 2019 12:03:42 +0530 Message-Id: <20190409063344.36564-1-vipin.varghese@intel.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20190225171222.64134-3-vipin.varghese@intel.com> References: <20190225171222.64134-3-vipin.varghese@intel.com> Subject: [dpdk-dev] [PATCH v8 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: , X-List-Received-Date: Tue, 09 Apr 2019 06:33:27 -0000 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 ========== V8: - remove quotes from notes section - John Macnamara - add quotes for DPDK API and variables - Thomas Monjalon - update use of JUMBO for rx bottleneck - Vipin Varghese - Add ACK from v7 - Vipin Varghese 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 | 464 ++++++++++++++++++ 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, 847 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 Future Work =========== - More use cases. - Runs as non root. - Effects of Cache partitioning. - How to run application as non root user. -- 2.17.1 From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by dpdk.space (Postfix) with ESMTP id C08D2A0096 for ; Tue, 9 Apr 2019 08:33:29 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 9BD8E4CC3; Tue, 9 Apr 2019 08:33:28 +0200 (CEST) Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by dpdk.org (Postfix) with ESMTP id AF62C2B95 for ; Tue, 9 Apr 2019 08:33:26 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga005.fm.intel.com ([10.253.24.32]) by fmsmga104.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 08 Apr 2019 23:33:25 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.60,328,1549958400"; d="scan'208";a="336190489" Received: from unknown (HELO saesrv02-S2600CWR.intel.com) ([10.224.122.203]) by fmsmga005.fm.intel.com with ESMTP; 08 Apr 2019 23:33:22 -0700 From: Vipin Varghese To: dev@dpdk.org, marko.kovacevic@intel.com, john.mcnamara@intel.com, shreyansh.jain@nxp.com Cc: keith.wiles@intel.com, amit.tamboli@intel.com, sanjay.padubidri@intel.com, amol.patel@intel.com, ferruh.yigit@intel.com, Vipin Varghese Date: Tue, 9 Apr 2019 12:03:42 +0530 Message-Id: <20190409063344.36564-1-vipin.varghese@intel.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20190225171222.64134-3-vipin.varghese@intel.com> References: <20190225171222.64134-3-vipin.varghese@intel.com> Subject: [dpdk-dev] [PATCH v8 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" Content-Type: text/plain; charset="UTF-8" Message-ID: <20190409063342.d8YuXtBULsrwiT7Ma4akU-V55c8ur9z8bHofvKb2VaU@z> 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 ========== V8: - remove quotes from notes section - John Macnamara - add quotes for DPDK API and variables - Thomas Monjalon - update use of JUMBO for rx bottleneck - Vipin Varghese - Add ACK from v7 - Vipin Varghese 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 | 464 ++++++++++++++++++ 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, 847 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 Future Work =========== - More use cases. - Runs as non root. - Effects of Cache partitioning. - How to run application as non root user. -- 2.17.1