Patch Detail
Show a patch.
GET /api/patches/273/?format=api
{ "id": 273, "url": "https://patchwork.libcamera.org/api/patches/273/?format=api", "web_url": "https://patchwork.libcamera.org/patch/273/", "project": { "id": 1, "url": "https://patchwork.libcamera.org/api/projects/1/?format=api", "name": "libcamera", "link_name": "libcamera", "list_id": "libcamera_core", "list_email": "libcamera-devel@lists.libcamera.org", "web_url": "", "scm_url": "", "webscm_url": "" }, "msgid": "<20190118174311.3905-1-laurent.pinchart@ideasonboard.com>", "date": "2019-01-18T17:43:11", "name": "[libcamera-devel,v1.1,1/4] Documentation: coding_style: Add object ownership rules", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": false, "hash": "a45e021cb91dde0de33150789df9588bcf64109f", "submitter": { "id": 2, "url": "https://patchwork.libcamera.org/api/people/2/?format=api", "name": "Laurent Pinchart", "email": "laurent.pinchart@ideasonboard.com" }, "delegate": null, "mbox": "https://patchwork.libcamera.org/patch/273/mbox/", "series": [ { "id": 93, "url": "https://patchwork.libcamera.org/api/series/93/?format=api", "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=93", "date": "2019-01-18T17:43:11", "name": "[libcamera-devel,v1.1,1/4] Documentation: coding_style: Add object ownership rules", "version": 1, "mbox": "https://patchwork.libcamera.org/series/93/mbox/" } ], "comments": "https://patchwork.libcamera.org/api/patches/273/comments/", "check": "pending", "checks": "https://patchwork.libcamera.org/api/patches/273/checks/", "tags": {}, "headers": { "Return-Path": "<laurent.pinchart@ideasonboard.com>", "Received": [ "from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 9348A60B21\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tFri, 18 Jan 2019 18:43:14 +0100 (CET)", "from pendragon.bb.dnainternet.fi\n\t(dfj612yhrgyx302h3jwwy-3.rev.dnainternet.fi\n\t[IPv6:2001:14ba:21f5:5b00:ce28:277f:58d7:3ca4])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 2210A53E\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tFri, 18 Jan 2019 18:43:14 +0100 (CET)" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1547833394;\n\tbh=N8iUPhOEYK3CshP6bPaSM5jlH0ZvQ6US8scU0KGSffs=;\n\th=From:To:Subject:Date:In-Reply-To:References:From;\n\tb=c9Vc0PYbFDkaKVUE93V6Ez+S4vWvTfI5ZjMGSG2WbH35Q/Povfnhq65GiC7Y/aMhj\n\t6n0X6/ePP3YZ1Kdy5C4xRBlY7r4NY11f0UsuOt7SnznmSssaVJWZdNPSejJ8dDt/Np\n\tZlu4UsF8i/2fR2hSXygESFNG3UMRqCyy0iB/7op8=", "From": "Laurent Pinchart <laurent.pinchart@ideasonboard.com>", "To": "libcamera-devel@lists.libcamera.org", "Date": "Fri, 18 Jan 2019 19:43:11 +0200", "Message-Id": "<20190118174311.3905-1-laurent.pinchart@ideasonboard.com>", "X-Mailer": "git-send-email 2.19.2", "In-Reply-To": "<20190117235916.1906-2-laurent.pinchart@ideasonboard.com>", "References": "<20190117235916.1906-2-laurent.pinchart@ideasonboard.com>", "MIME-Version": "1.0", "Content-Type": "text/plain; charset=UTF-8", "Content-Transfer-Encoding": "8bit", "Subject": "[libcamera-devel] [PATCH v1.1 1/4] Documentation: coding_style: Add\n\tobject ownership rules", "X-BeenThere": "libcamera-devel@lists.libcamera.org", "X-Mailman-Version": "2.1.23", "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>", "X-List-Received-Date": "Fri, 18 Jan 2019 17:43:14 -0000" }, "content": "Object ownership is a complex topic that can lead to many issues, from\nmemory leak to crashes. Document the rules that libcamera enforces to\nmake object ownership tracking explicit.\n\nThis is a first version of the rules and is expected to be expanded as\nthe library is developed.\n\nSigned-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\nReviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>\nReviewed-by: Jacopo Mondi <jacopo@jmondi.org>\n---\nChanges since v1:\n\n- Clarify documentation\n---\n Documentation/coding-style.rst | 76 ++++++++++++++++++++++++++++++++++\n 1 file changed, 76 insertions(+)", "diff": "diff --git a/Documentation/coding-style.rst b/Documentation/coding-style.rst\nindex f8d2fdfeda8e..45b0b4d38959 100644\n--- a/Documentation/coding-style.rst\n+++ b/Documentation/coding-style.rst\n@@ -81,6 +81,82 @@ C++-11-specific features:\n overused.\n * Variadic class and function templates\n \n+Object Ownership\n+~~~~~~~~~~~~~~~~\n+\n+libcamera creates and destroys many objects at runtime, for both objects\n+internal to the library and objects exposed to the user. To guarantee proper\n+operation without use after free, double free or memory leaks, knowing who owns\n+each object at any time is crucial. The project has enacted a set of rules to\n+make object ownership tracking as explicit and fool-proof as possible.\n+\n+In the context of this section, the terms object and instance are used\n+interchangeably and both refer to an instance of a class. The term reference\n+refers to both C++ references and C++ pointers in their capacity to refer to an\n+object. Passing a reference means offering a way to a callee to obtain a\n+reference to an object that the caller has a valid reference to. Borrowing a\n+reference means using a reference passed by a caller without ownership transfer\n+based on the assumption that the caller guarantees the validity of the\n+reference for the duration of the operation that borrows it.\n+\n+#. Single Owner Objects\n+\n+ * By default an object has a single owner at any time.\n+ * Storage of single owner objects varies depending on how the object\n+ ownership will evolve through the lifetime of the object.\n+\n+ * Objects whose ownership needs to be transferred shall be stored as\n+ std::unique_ptr<> as much as possible to emphasize the single ownership.\n+ * Objects whose owner doesn't change may be embedded in other objects, or\n+ stored as pointer or references. They may be stored as std::unique_ptr<>\n+ for automatic deletion if desired.\n+\n+ * Ownership is transferred by passing the reference as a std::unique_ptr<>\n+ and using std::move(). After ownership transfer the former owner has no\n+ valid reference to the object anymore and shall not access it without first\n+ obtaining a valid reference.\n+ * Objects may be borrowed by passing an object reference from the owner to\n+ the borrower, providing that\n+\n+ * the owner guarantees the validity of the reference for the whole duration\n+ of the borrowing, and\n+ * the borrower doesn't access the reference after the end of the borrowing.\n+\n+ When borrowing from caller to callee for the duration of a function call,\n+ this implies that the callee shall not keep any stored reference after it\n+ returns. These rules apply to the callee and all the functions it calls,\n+ directly or indirectly.\n+\n+ When the object is stored in a std::unique_ptr<>, borrowing passes a\n+ reference to the object, not to the std::unique_ptr<>, as\n+\n+ * a 'const &' when the object doesn't need to be modified and may not be\n+ null.\n+ * a pointer when the object may be modified or may be null. Unless\n+ otherwise specified, pointers passed to functions are considered as\n+ borrowed references valid for the duration of the function only.\n+\n+#. Shared Objects\n+\n+ * Objects that may have multiple owners at a given time are called shared\n+ objects. They are reference-counted and live as long as any references to\n+ the object exist.\n+ * Shared objects are created with std::make_shared<> or\n+ std::allocate_shared<> and stored in an std::shared_ptr<>.\n+ * Ownership is shared by creating and passing copies of any valid\n+ std::shared_ptr<> reference. Ownership is released by destroying the\n+ corresponding std::shared_ptr<>.\n+ * Borrowed references to shared objects are passed as references to the\n+ object itself, not to the std::shared_ptr<>, with the same rules as for\n+ single owner objects.\n+\n+.. attention:: Long term borrowing of single owner objects is allowed. Example\n+ use cases are implementation of the singleton pattern (where the singleton\n+ guarantees the validity of the reference forever), or returning references\n+ to global objects whose lifetime matches the lifetime of the application. As\n+ long term borrowing isn't marked through language constructs, it shall be\n+ documented explicitly in details in the API.\n+\n \n Tools\n -----\n", "prefixes": [ "libcamera-devel", "v1.1", "1/4" ] }