{"id":10307,"url":"https://patchwork.libcamera.org/api/1.1/patches/10307/?format=json","web_url":"https://patchwork.libcamera.org/patch/10307/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/1.1/projects/1/?format=json","name":"libcamera","link_name":"libcamera","list_id":"libcamera_core","list_email":"libcamera-devel@lists.libcamera.org","web_url":"","scm_url":"","webscm_url":""},"msgid":"<20201030085756.79329-3-paul.elder@ideasonboard.com>","date":"2020-10-30T08:57:53","name":"[libcamera-devel,v4,2/5] libcamera: request: Add tracepoints","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"314a5c0b7ac3a7064d6ce93276846b416830c7ae","submitter":{"id":17,"url":"https://patchwork.libcamera.org/api/1.1/people/17/?format=json","name":"Paul Elder","email":"paul.elder@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/10307/mbox/","series":[{"id":1435,"url":"https://patchwork.libcamera.org/api/1.1/series/1435/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=1435","date":"2020-10-30T08:57:51","name":"Tracing","version":4,"mbox":"https://patchwork.libcamera.org/series/1435/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/10307/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/10307/checks/","tags":{},"headers":{"Return-Path":"<libcamera-devel-bounces@lists.libcamera.org>","X-Original-To":"parsemail@patchwork.libcamera.org","Delivered-To":"parsemail@patchwork.libcamera.org","Received":["from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id 8312DBDB1E\n\tfor <parsemail@patchwork.libcamera.org>;\n\tFri, 30 Oct 2020 08:58:10 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 50DDC6298D;\n\tFri, 30 Oct 2020 09:58:10 +0100 (CET)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id C0B9662034\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tFri, 30 Oct 2020 09:58:08 +0100 (CET)","from pyrite.rasen.tech (unknown\n\t[IPv6:2400:4051:61:600:2c71:1b79:d06d:5032])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 06742A31;\n\tFri, 30 Oct 2020 09:58:06 +0100 (CET)"],"Authentication-Results":"lancelot.ideasonboard.com;\n\tdkim=fail reason=\"signature verification failed\" (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"ffM73Z8t\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1604048288;\n\tbh=/rMPkHHCCNX+FAze8b7AmntRFqBfDXEjYgdMhjZs2Jw=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=ffM73Z8tAVfGnnJxx3q8dg0GnCbhrkcWgSJMeW2iqM5iXRZFxeDLRlvH0HkrIcDJR\n\t8+qg7WU/fZPGXmn5uoVeygdFYQNzfplVCWIIDUOMto2gOUT5MeLCWE6GiUUHhDDdfj\n\t5PLUUUMTUYTM1T6283TxkaAuJNwSFbudCNGNTgPU=","From":"Paul Elder <paul.elder@ideasonboard.com>","To":"libcamera-devel@lists.libcamera.org","Date":"Fri, 30 Oct 2020 17:57:53 +0900","Message-Id":"<20201030085756.79329-3-paul.elder@ideasonboard.com>","X-Mailer":"git-send-email 2.27.0","In-Reply-To":"<20201030085756.79329-1-paul.elder@ideasonboard.com>","References":"<20201030085756.79329-1-paul.elder@ideasonboard.com>","MIME-Version":"1.0","Subject":"[libcamera-devel] [PATCH v4 2/5] libcamera: request: Add tracepoints","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"<libcamera-devel.lists.libcamera.org>","List-Unsubscribe":"<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>","List-Archive":"<https://lists.libcamera.org/pipermail/libcamera-devel/>","List-Post":"<mailto:libcamera-devel@lists.libcamera.org>","List-Help":"<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>","List-Subscribe":"<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>","Content-Type":"text/plain; charset=\"us-ascii\"","Content-Transfer-Encoding":"7bit","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>"},"content":"Add and use tracepoints in Request. Requests are core to libcamera\noperation, thus detecting delays in their processing is important, and\nserves as a good usage example of tracepoints.\n\nSigned-off-by: Paul Elder <paul.elder@ideasonboard.com>\nReviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n\n---\nChanges in v4:\n- move enum tp definitions to \"header\" tp files\n  - add them to meson accordingly\n- remove cancelled field from request_complete_buffer tracepoint\n\nChanges in v3:\n- expand the changelog\n- add enum tracepoint values so that request status and buffer status\n  are strings instead of ints in the trace\n- remove cancelled from all request tracepoints, except complete_buffer\n- expand the complete_buffer tracepoint to include information on the\n  buffer\n- display the address of the request in all tracepoints\n- remove tracepoints for add_buffer and find_buffer\n\nChanges in v2:\n- remove tracepoints from uvcvideo\n- remove comment in changelog that this is only used for demonstration\n- use Request pointers instead of feeding the fields manually to the\n  tracepoint\n---\n .../internal/tracepoints/buffer_enums.tp      |  9 +++\n .../internal/tracepoints/meson.build          |  5 ++\n .../libcamera/internal/tracepoints/request.tp | 68 +++++++++++++++++++\n .../internal/tracepoints/request_enums.tp     |  9 +++\n src/libcamera/request.cpp                     | 11 +++\n 5 files changed, 102 insertions(+)\n create mode 100644 include/libcamera/internal/tracepoints/buffer_enums.tp\n create mode 100644 include/libcamera/internal/tracepoints/request.tp\n create mode 100644 include/libcamera/internal/tracepoints/request_enums.tp","diff":"diff --git a/include/libcamera/internal/tracepoints/buffer_enums.tp b/include/libcamera/internal/tracepoints/buffer_enums.tp\nnew file mode 100644\nindex 00000000..fdbea69a\n--- /dev/null\n+++ b/include/libcamera/internal/tracepoints/buffer_enums.tp\n@@ -0,0 +1,9 @@\n+TRACEPOINT_ENUM(\n+\tlibcamera,\n+\tbuffer_status,\n+\tTP_ENUM_VALUES(\n+\t\tctf_enum_value(\"FrameSuccess\", 0)\n+\t\tctf_enum_value(\"FrameError\", 1)\n+\t\tctf_enum_value(\"FrameCancelled\", 2)\n+\t)\n+)\ndiff --git a/include/libcamera/internal/tracepoints/meson.build b/include/libcamera/internal/tracepoints/meson.build\nindex 2dd6733e..fee0758f 100644\n--- a/include/libcamera/internal/tracepoints/meson.build\n+++ b/include/libcamera/internal/tracepoints/meson.build\n@@ -1,4 +1,9 @@\n # SPDX-License-Identifier: CC0-1.0\n \n+# enum files must go first\n tracepoint_files = files([\n+    'buffer_enums.tp',\n+    'request_enums.tp',\n+\n+    'request.tp',\n ])\ndiff --git a/include/libcamera/internal/tracepoints/request.tp b/include/libcamera/internal/tracepoints/request.tp\nnew file mode 100644\nindex 00000000..dd28a714\n--- /dev/null\n+++ b/include/libcamera/internal/tracepoints/request.tp\n@@ -0,0 +1,68 @@\n+#include <libcamera/buffer.h>\n+#include <libcamera/request.h>\n+\n+TRACEPOINT_EVENT_CLASS(\n+\tlibcamera,\n+\trequest,\n+\tTP_ARGS(\n+\t\tlibcamera::Request *, req\n+\t),\n+\tTP_FIELDS(\n+\t\tctf_integer_hex(uintptr_t, request, reinterpret_cast<uintptr_t>(req))\n+\t\tctf_integer(uint64_t, cookie, req->cookie())\n+\t\tctf_enum(libcamera, request_status, uint32_t, status, req->status())\n+\t)\n+)\n+\n+TRACEPOINT_EVENT_INSTANCE(\n+\tlibcamera,\n+\trequest,\n+\trequest_construct,\n+\tTP_ARGS(\n+\t\tlibcamera::Request *, req\n+\t)\n+)\n+\n+TRACEPOINT_EVENT_INSTANCE(\n+\tlibcamera,\n+\trequest,\n+\trequest_destroy,\n+\tTP_ARGS(\n+\t\tlibcamera::Request *, req\n+\t)\n+)\n+\n+TRACEPOINT_EVENT_INSTANCE(\n+\tlibcamera,\n+\trequest,\n+\trequest_reuse,\n+\tTP_ARGS(\n+\t\tlibcamera::Request *, req\n+\t)\n+)\n+\n+TRACEPOINT_EVENT_INSTANCE(\n+\tlibcamera,\n+\trequest,\n+\trequest_complete,\n+\tTP_ARGS(\n+\t\tlibcamera::Request *, req\n+\t)\n+)\n+\n+\n+TRACEPOINT_EVENT(\n+\tlibcamera,\n+\trequest_complete_buffer,\n+\tTP_ARGS(\n+\t\tlibcamera::Request *, req,\n+\t\tlibcamera::FrameBuffer *, buf\n+\t),\n+\tTP_FIELDS(\n+\t\tctf_integer_hex(uintptr_t, request, reinterpret_cast<uintptr_t>(req))\n+\t\tctf_integer(uint64_t, cookie, req->cookie())\n+\t\tctf_integer(int, status, req->status())\n+\t\tctf_integer_hex(uintptr_t, buffer, reinterpret_cast<uintptr_t>(buf))\n+\t\tctf_enum(libcamera, buffer_status, uint32_t, buf_status, buf->metadata().status)\n+\t)\n+)\ndiff --git a/include/libcamera/internal/tracepoints/request_enums.tp b/include/libcamera/internal/tracepoints/request_enums.tp\nnew file mode 100644\nindex 00000000..371f6544\n--- /dev/null\n+++ b/include/libcamera/internal/tracepoints/request_enums.tp\n@@ -0,0 +1,9 @@\n+TRACEPOINT_ENUM(\n+\tlibcamera,\n+\trequest_status,\n+\tTP_ENUM_VALUES(\n+\t\tctf_enum_value(\"RequestPending\", 0)\n+\t\tctf_enum_value(\"RequestComplete\", 1)\n+\t\tctf_enum_value(\"RequestCancelled\", 2)\n+\t)\n+)\ndiff --git a/src/libcamera/request.cpp b/src/libcamera/request.cpp\nindex ae8b1660..a68684ef 100644\n--- a/src/libcamera/request.cpp\n+++ b/src/libcamera/request.cpp\n@@ -16,6 +16,7 @@\n \n #include \"libcamera/internal/camera_controls.h\"\n #include \"libcamera/internal/log.h\"\n+#include \"libcamera/internal/tracepoints.h\"\n \n /**\n  * \\file request.h\n@@ -85,10 +86,14 @@ Request::Request(Camera *camera, uint64_t cookie)\n \t * \\todo: Add a validator for metadata controls.\n \t */\n \tmetadata_ = new ControlList(controls::controls);\n+\n+\tLIBCAMERA_TRACEPOINT(request_construct, this);\n }\n \n Request::~Request()\n {\n+\tLIBCAMERA_TRACEPOINT(request_destroy, this);\n+\n \tdelete metadata_;\n \tdelete controls_;\n \tdelete validator_;\n@@ -106,6 +111,8 @@ Request::~Request()\n  */\n void Request::reuse(ReuseFlag flags)\n {\n+\tLIBCAMERA_TRACEPOINT(request_reuse, this);\n+\n \tpending_.clear();\n \tif (flags & ReuseBuffers) {\n \t\tfor (auto pair : bufferMap_) {\n@@ -259,6 +266,8 @@ void Request::complete()\n \tLOG(Request, Debug)\n \t\t<< \"Request has completed - cookie: \" << cookie_\n \t\t<< (cancelled_ ? \" [Cancelled]\" : \"\");\n+\n+\tLIBCAMERA_TRACEPOINT(request_complete, this);\n }\n \n /**\n@@ -276,6 +285,8 @@ void Request::complete()\n  */\n bool Request::completeBuffer(FrameBuffer *buffer)\n {\n+\tLIBCAMERA_TRACEPOINT(request_complete_buffer, this, buffer);\n+\n \tint ret = pending_.erase(buffer);\n \tASSERT(ret == 1);\n \n","prefixes":["libcamera-devel","v4","2/5"]}