[{"id":3541,"web_url":"https://patchwork.libcamera.org/comment/3541/","msgid":"<20200120141844.lvgry2c2h5cui5ju@uno.localdomain>","date":"2020-01-20T14:18:44","subject":"Re: [libcamera-devel] [PATCH 10/19] libcamera: Define the threading\n\tmodel","submitter":{"id":3,"url":"https://patchwork.libcamera.org/api/people/3/","name":"Jacopo Mondi","email":"jacopo@jmondi.org"},"content":"Hi Laurent,\n\nOn Mon, Jan 20, 2020 at 02:24:28AM +0200, Laurent Pinchart wrote:\n> Document the design of libcamera's threading support, and prepare to\n> document thread-safety of classes and functions with a doxygen alias\n> command.\n>\n> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n> ---\n>  Documentation/Doxyfile.in |  4 +-\n>  src/libcamera/thread.cpp  | 82 +++++++++++++++++++++++++++++++++++++++\n>  2 files changed, 85 insertions(+), 1 deletion(-)\n>\n> diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in\n> index 8e6fbdbb92b6..734672ed15dc 100644\n> --- a/Documentation/Doxyfile.in\n> +++ b/Documentation/Doxyfile.in\n> @@ -239,7 +239,9 @@ TAB_SIZE               = 4\n>  # newlines (in the resulting output). You can put ^^ in the value part of an\n>  # alias to insert a newline as if a physical newline was in the original file.\n>\n> -ALIASES                =\n> +ALIASES                = \"context=\\xrefitem context \\\"Thread Safety\\\" \\\"Thread Safety\\\"\"\n> +ALIASES               += \"threadbound=\\ref thread-bound \\\"thread-bound\\\"\"\n> +ALIASES               += \"threadsafe=\\ref thread-safe \\\"thread-safe\\\"\"\n>\n>  # This tag can be used to specify a number of word-keyword mappings (TCL only).\n>  # A mapping has the form \"name=value\". For example adding \"class=itcl::class\"\n> diff --git a/src/libcamera/thread.cpp b/src/libcamera/thread.cpp\n> index fe32cd677596..c1698d469a6c 100644\n> --- a/src/libcamera/thread.cpp\n> +++ b/src/libcamera/thread.cpp\n> @@ -19,6 +19,88 @@\n>  #include \"log.h\"\n>  #include \"message.h\"\n>\n> +/**\n> + * \\page thread Thread Support\n> + *\n> + * libcamera supports multi-threaded applications through a threading model that\n> + * sets precise rules to guarantee thread-safe usage of the API. Additionally,\n> + * libcamera makes internal use of threads, and offers APIs that simplify\n> + * interactions with application threads. Careful compliance with the threading\n> + * model will ensure avoidance of race conditions.\n> + *\n> + * \\section thread-reentrancy Reentrancy and Thread-Safety\n> + *\n> + * Through the documentation, several terms are used to define how classes and\n> + * their member functions can be used from multiple threads.\n> + *\n> + * - A **reentrant** function may be called simultaneously from multiple\n> + *   threads if and only if each invocation uses a different instance of the\n> + *   class. This is the default for all member functions not explictly marked\n> + *   otherwise.\n> + *\n> + * - \\anchor thread-safe A **thread-safe** function may be called\n> + *   simultaneously from multiple threads on the same instance of a class. A\n> + *   thread-safe function is thus reentrant.\n> + *\n> + * - \\anchor thread-bound A **thread-bound** function may be called only from\n> + *   the thread that the class instances lives in (see section \\ref\n> + *   thread-objects). For instances of classes that do not derive from the\n> + *   Object class, this is the thread in which the instance was created. A\n> + *   thread-bound function is not thread-safe, and may or may not be reentrant.\n> + *\n> + * Neither reentrancy nor thread-safety, in this context, mean that a function\n> + * may be called simultaneously from the same thread, for instance from a\n> + * callback invoked by the the function. This may deadlock and isn't allowed\n\ns/the the/the\n\n> + * unless separately documented.\n> + *\n> + * A class is defined as reentrant, thread-safe or thread-bound if all its\n> + * member functions are reentrant, thread-safe or thread-bound respectively.\n> + * Some member functions may additionally be documented as having additional\n> + * thread-related attributes.\n> + *\n> + * Most classes are reentrant but not thread-safe, as making them fully\n> + * thread-safe would incur locking costs considered prohibitive for the\n> + * expected use cases.\n> + *\n> + * \\section thread-objects Threads and Objects\n> + *\n> + * Instances of the Object class and all its derived classes are thread-aware\n> + * and are bound to the thread they are created in. They are said to *live* in\n> + * a thread, and they interact with the event loop of their thread for the\n> + * purpose of message passing and signal delivery. Messages posted to the\n> + * object with Object::postMessage() will be delivered from the event loop of\n> + * the thread that the object lives in. Signals delivered to the object, unless\n> + * explicitly connected with ConnectionTypeDirect, will also be delivered from\n> + * the object thread's event loop.\n> + *\n> + * All Object instances created by libcamera are bound to an internal thread,\n> + * an applications don't need to provide an event loop to support them. Object\n> + * instances created by applications require an event loop. It is the\n> + * responsibility of applications to provide that event loop, either explicitly\n> + * through CameraManager::setEventDispatcher(), or by running the default event\n> + * loop provided by CameraManager::eventDispatcher() in their main thread. The\n> + * main thread of an application is the one that calls CameraManager::start().\n\nThis is all good, but I would move this before the thread-safety\npart..\n\nApart from that\nReviewed-by: Jacopo Mondi <jacopo@jmondi.org>\n\nThanks\n  j\n\n> + *\n> + * \\section thread-signals Threads and Signals\n> + *\n> + * When sent to a receiver that does not inherit from the Object class, signals\n> + * are delivered synchronously in the thread of the sender. When the receiver\n> + * inherits from the Object class, delivery is by default asynchronous if the\n> + * sender and receiver live in different threads. In that case, the signal is\n> + * posted to the receiver's message queue and will be delivered from the\n> + * receiver's event loop, running in the receiver's thread. This mechanism can\n> + * be overridden by selecting a different connection type when calling\n> + * Signal::connect().\n> + *\n> + * Asynchronous signal delivery is used internally in libcamera, but is also\n> + * available to applications if desired. To use this feature, applications\n> + * shall create receiver classes that inherit from the Object class, and\n> + * provide an event loop to the CameraManager as explained above. Note that\n> + * Object instance created by the application are limited to living in the\n> + * application's main thread. Creating Object instances from another thread of\n> + * an application causes undefined behaviour.\n> + */\n> +\n>  /**\n>   * \\file thread.h\n>   * \\brief Thread support\n> --\n> Regards,\n>\n> Laurent Pinchart\n>\n> _______________________________________________\n> libcamera-devel mailing list\n> libcamera-devel@lists.libcamera.org\n> https://lists.libcamera.org/listinfo/libcamera-devel","headers":{"Return-Path":"<jacopo@jmondi.org>","Received":["from relay9-d.mail.gandi.net (relay9-d.mail.gandi.net\n\t[217.70.183.199])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id B91C160804\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tMon, 20 Jan 2020 15:16:13 +0100 (CET)","from uno.localdomain (93-34-114-233.ip49.fastwebnet.it\n\t[93.34.114.233]) (Authenticated sender: jacopo@jmondi.org)\n\tby relay9-d.mail.gandi.net (Postfix) with ESMTPSA id 4D311FF808;\n\tMon, 20 Jan 2020 14:16:13 +0000 (UTC)"],"X-Originating-IP":"93.34.114.233","Date":"Mon, 20 Jan 2020 15:18:44 +0100","From":"Jacopo Mondi <jacopo@jmondi.org>","To":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","Cc":"libcamera-devel@lists.libcamera.org","Message-ID":"<20200120141844.lvgry2c2h5cui5ju@uno.localdomain>","References":"<20200120002437.6633-1-laurent.pinchart@ideasonboard.com>\n\t<20200120002437.6633-11-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"multipart/signed; micalg=pgp-sha256;\n\tprotocol=\"application/pgp-signature\"; boundary=\"6c5cxh4gh3lmzzqn\"","Content-Disposition":"inline","In-Reply-To":"<20200120002437.6633-11-laurent.pinchart@ideasonboard.com>","Subject":"Re: [libcamera-devel] [PATCH 10/19] libcamera: Define the threading\n\tmodel","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>","X-List-Received-Date":"Mon, 20 Jan 2020 14:16:13 -0000"}},{"id":3571,"web_url":"https://patchwork.libcamera.org/comment/3571/","msgid":"<20200122153131.GR1124294@oden.dyn.berto.se>","date":"2020-01-22T15:31:31","subject":"Re: [libcamera-devel] [PATCH 10/19] libcamera: Define the threading\n\tmodel","submitter":{"id":5,"url":"https://patchwork.libcamera.org/api/people/5/","name":"Niklas Söderlund","email":"niklas.soderlund@ragnatech.se"},"content":"Hi Laurent,\n\nThanks for this grate write up.\n\nOn 2020-01-20 02:24:28 +0200, Laurent Pinchart wrote:\n> Document the design of libcamera's threading support, and prepare to\n> document thread-safety of classes and functions with a doxygen alias\n> command.\n> \n> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n\nReviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>\n\n> ---\n>  Documentation/Doxyfile.in |  4 +-\n>  src/libcamera/thread.cpp  | 82 +++++++++++++++++++++++++++++++++++++++\n>  2 files changed, 85 insertions(+), 1 deletion(-)\n> \n> diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in\n> index 8e6fbdbb92b6..734672ed15dc 100644\n> --- a/Documentation/Doxyfile.in\n> +++ b/Documentation/Doxyfile.in\n> @@ -239,7 +239,9 @@ TAB_SIZE               = 4\n>  # newlines (in the resulting output). You can put ^^ in the value part of an\n>  # alias to insert a newline as if a physical newline was in the original file.\n>  \n> -ALIASES                =\n> +ALIASES                = \"context=\\xrefitem context \\\"Thread Safety\\\" \\\"Thread Safety\\\"\"\n> +ALIASES               += \"threadbound=\\ref thread-bound \\\"thread-bound\\\"\"\n> +ALIASES               += \"threadsafe=\\ref thread-safe \\\"thread-safe\\\"\"\n>  \n>  # This tag can be used to specify a number of word-keyword mappings (TCL only).\n>  # A mapping has the form \"name=value\". For example adding \"class=itcl::class\"\n> diff --git a/src/libcamera/thread.cpp b/src/libcamera/thread.cpp\n> index fe32cd677596..c1698d469a6c 100644\n> --- a/src/libcamera/thread.cpp\n> +++ b/src/libcamera/thread.cpp\n> @@ -19,6 +19,88 @@\n>  #include \"log.h\"\n>  #include \"message.h\"\n>  \n> +/**\n> + * \\page thread Thread Support\n> + *\n> + * libcamera supports multi-threaded applications through a threading model that\n> + * sets precise rules to guarantee thread-safe usage of the API. Additionally,\n> + * libcamera makes internal use of threads, and offers APIs that simplify\n> + * interactions with application threads. Careful compliance with the threading\n> + * model will ensure avoidance of race conditions.\n> + *\n> + * \\section thread-reentrancy Reentrancy and Thread-Safety\n> + *\n> + * Through the documentation, several terms are used to define how classes and\n> + * their member functions can be used from multiple threads.\n> + *\n> + * - A **reentrant** function may be called simultaneously from multiple\n> + *   threads if and only if each invocation uses a different instance of the\n> + *   class. This is the default for all member functions not explictly marked\n> + *   otherwise.\n> + *\n> + * - \\anchor thread-safe A **thread-safe** function may be called\n> + *   simultaneously from multiple threads on the same instance of a class. A\n> + *   thread-safe function is thus reentrant.\n> + *\n> + * - \\anchor thread-bound A **thread-bound** function may be called only from\n> + *   the thread that the class instances lives in (see section \\ref\n> + *   thread-objects). For instances of classes that do not derive from the\n> + *   Object class, this is the thread in which the instance was created. A\n> + *   thread-bound function is not thread-safe, and may or may not be reentrant.\n> + *\n> + * Neither reentrancy nor thread-safety, in this context, mean that a function\n> + * may be called simultaneously from the same thread, for instance from a\n> + * callback invoked by the the function. This may deadlock and isn't allowed\n> + * unless separately documented.\n> + *\n> + * A class is defined as reentrant, thread-safe or thread-bound if all its\n> + * member functions are reentrant, thread-safe or thread-bound respectively.\n> + * Some member functions may additionally be documented as having additional\n> + * thread-related attributes.\n> + *\n> + * Most classes are reentrant but not thread-safe, as making them fully\n> + * thread-safe would incur locking costs considered prohibitive for the\n> + * expected use cases.\n> + *\n> + * \\section thread-objects Threads and Objects\n> + *\n> + * Instances of the Object class and all its derived classes are thread-aware\n> + * and are bound to the thread they are created in. They are said to *live* in\n> + * a thread, and they interact with the event loop of their thread for the\n> + * purpose of message passing and signal delivery. Messages posted to the\n> + * object with Object::postMessage() will be delivered from the event loop of\n> + * the thread that the object lives in. Signals delivered to the object, unless\n> + * explicitly connected with ConnectionTypeDirect, will also be delivered from\n> + * the object thread's event loop.\n> + *\n> + * All Object instances created by libcamera are bound to an internal thread,\n> + * an applications don't need to provide an event loop to support them. Object\n> + * instances created by applications require an event loop. It is the\n> + * responsibility of applications to provide that event loop, either explicitly\n> + * through CameraManager::setEventDispatcher(), or by running the default event\n> + * loop provided by CameraManager::eventDispatcher() in their main thread. The\n> + * main thread of an application is the one that calls CameraManager::start().\n> + *\n> + * \\section thread-signals Threads and Signals\n> + *\n> + * When sent to a receiver that does not inherit from the Object class, signals\n> + * are delivered synchronously in the thread of the sender. When the receiver\n> + * inherits from the Object class, delivery is by default asynchronous if the\n> + * sender and receiver live in different threads. In that case, the signal is\n> + * posted to the receiver's message queue and will be delivered from the\n> + * receiver's event loop, running in the receiver's thread. This mechanism can\n> + * be overridden by selecting a different connection type when calling\n> + * Signal::connect().\n> + *\n> + * Asynchronous signal delivery is used internally in libcamera, but is also\n> + * available to applications if desired. To use this feature, applications\n> + * shall create receiver classes that inherit from the Object class, and\n> + * provide an event loop to the CameraManager as explained above. Note that\n> + * Object instance created by the application are limited to living in the\n> + * application's main thread. Creating Object instances from another thread of\n> + * an application causes undefined behaviour.\n> + */\n> +\n>  /**\n>   * \\file thread.h\n>   * \\brief Thread support\n> -- \n> Regards,\n> \n> Laurent Pinchart\n> \n> _______________________________________________\n> libcamera-devel mailing list\n> libcamera-devel@lists.libcamera.org\n> https://lists.libcamera.org/listinfo/libcamera-devel","headers":{"Return-Path":"<niklas.soderlund@ragnatech.se>","Received":["from mail-lf1-x141.google.com (mail-lf1-x141.google.com\n\t[IPv6:2a00:1450:4864:20::141])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id D8990607F3\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tWed, 22 Jan 2020 16:31:33 +0100 (CET)","by mail-lf1-x141.google.com with SMTP id 203so5615092lfa.12\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tWed, 22 Jan 2020 07:31:33 -0800 (PST)","from localhost (h-93-159.A463.priv.bahnhof.se. [46.59.93.159])\n\tby smtp.gmail.com with ESMTPSA id\n\tf30sm20462120ljp.31.2020.01.22.07.31.32\n\t(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);\n\tWed, 22 Jan 2020 07:31:32 -0800 (PST)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=ragnatech-se.20150623.gappssmtp.com; s=20150623;\n\th=date:from:to:cc:subject:message-id:references:mime-version\n\t:content-disposition:content-transfer-encoding:in-reply-to;\n\tbh=0ng9qgUszgCSh3PbNi39BbuA2uwPX+HSeZF8aktugjE=;\n\tb=hVZY9tS5kidPw8LpFp3o+E8RzcYCBNLXE56CgflVD4GYbKCPOfBmyUB3B0iXN+ubkV\n\tot29qNp6sBz4+yih0FBAIGYH67zTdW/VGgiX45bxxOoDqKN4SMrU9WWcP5PsAGPVRScx\n\tXnemCUuY1zEiPf3efsHdmSh4xZlh6ZoR1UcmZx7gK2uZYk+GdMd2YuMmZC1fSGWyjyiT\n\tELyLFfGxcBh2djoWjDO1WmSr7uIS7dDr3VtnKX78uvgQKO7pgBmSeegPeAcTcmd6Pd/C\n\tSFLixBY9PAK/tQGRgIkwQ+R6Rm9Jzc1LAYyLEashffWaPdu5bZsj5Q/z4ELxeNJ2jz9h\n\tC52A==","X-Google-DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=1e100.net; s=20161025;\n\th=x-gm-message-state:date:from:to:cc:subject:message-id:references\n\t:mime-version:content-disposition:content-transfer-encoding\n\t:in-reply-to;\n\tbh=0ng9qgUszgCSh3PbNi39BbuA2uwPX+HSeZF8aktugjE=;\n\tb=uQZKtujSSlir81kefqqjdkmNIU8w2EaNjw3iXAr0f7C68EVRQZokAYdZt4BZlWkpex\n\tnkLbSvPiwMAmS33xxTwMWukjOMTIeu4lPkKC7xlInqVD7kFu1Bm8Z3C1qWNlpwq/Wxj7\n\tmOsGmwT3BHFp+1q06QHHILeV00iMIi5CW1x9AUZXKbf4CQGtkekPFoqsJd0UbeOnYaqs\n\tsrHIYGFKVeP9RQVQ4JegGfOjpvL2HKl2DqrSgeHfdBXGFbSRH22Y7rJKTFAdWzM5JoAa\n\tcc+k0lR7uCuXT+qi4cl0MjwaGIrtlrBsGZ4s67ADRQicuJyzBIVG87gISflnkuKwjGDT\n\tl3TQ==","X-Gm-Message-State":"APjAAAXykmVLjs7v+V3cYbOJPfdyOmicWdtIZtyTo787TshCgaAkLaOx\n\tGlrLwIDN03dyaXZkdLgvraaQVmTUOc8=","X-Google-Smtp-Source":"APXvYqwdH4uheXfar2hh/ZOPGjmgMRCTT6b9dmbYD3nuQ/6umVy9hIaSu0e4MMi/dDqQ5GRLmA5V5w==","X-Received":"by 2002:ac2:5e6c:: with SMTP id a12mr2155784lfr.32.1579707093139;\n\tWed, 22 Jan 2020 07:31:33 -0800 (PST)","Date":"Wed, 22 Jan 2020 16:31:31 +0100","From":"Niklas =?iso-8859-1?q?S=F6derlund?= <niklas.soderlund@ragnatech.se>","To":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","Cc":"libcamera-devel@lists.libcamera.org","Message-ID":"<20200122153131.GR1124294@oden.dyn.berto.se>","References":"<20200120002437.6633-1-laurent.pinchart@ideasonboard.com>\n\t<20200120002437.6633-11-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=iso-8859-1","Content-Disposition":"inline","Content-Transfer-Encoding":"8bit","In-Reply-To":"<20200120002437.6633-11-laurent.pinchart@ideasonboard.com>","Subject":"Re: [libcamera-devel] [PATCH 10/19] libcamera: Define the threading\n\tmodel","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>","X-List-Received-Date":"Wed, 22 Jan 2020 15:31:34 -0000"}},{"id":3573,"web_url":"https://patchwork.libcamera.org/comment/3573/","msgid":"<7a9f511e-1546-cec6-d83a-b064ca823fe2@ideasonboard.com>","date":"2020-01-22T15:43:38","subject":"Re: [libcamera-devel] [PATCH 10/19] libcamera: Define the threading\n\tmodel","submitter":{"id":4,"url":"https://patchwork.libcamera.org/api/people/4/","name":"Kieran Bingham","email":"kieran.bingham@ideasonboard.com"},"content":"Hi Laurent,\n\nOn 20/01/2020 00:24, Laurent Pinchart wrote:\n> Document the design of libcamera's threading support, and prepare to\n> document thread-safety of classes and functions with a doxygen alias\n> command.\n> \n> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n\nMinors below, but certainly a good write up.\n\nReviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>\n\n\n> ---\n>  Documentation/Doxyfile.in |  4 +-\n>  src/libcamera/thread.cpp  | 82 +++++++++++++++++++++++++++++++++++++++\n>  2 files changed, 85 insertions(+), 1 deletion(-)\n> \n> diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in\n> index 8e6fbdbb92b6..734672ed15dc 100644\n> --- a/Documentation/Doxyfile.in\n> +++ b/Documentation/Doxyfile.in\n> @@ -239,7 +239,9 @@ TAB_SIZE               = 4\n>  # newlines (in the resulting output). You can put ^^ in the value part of an\n>  # alias to insert a newline as if a physical newline was in the original file.\n>  \n> -ALIASES                =\n> +ALIASES                = \"context=\\xrefitem context \\\"Thread Safety\\\" \\\"Thread Safety\\\"\"\n> +ALIASES               += \"threadbound=\\ref thread-bound \\\"thread-bound\\\"\"\n> +ALIASES               += \"threadsafe=\\ref thread-safe \\\"thread-safe\\\"\"\n>  \n>  # This tag can be used to specify a number of word-keyword mappings (TCL only).\n>  # A mapping has the form \"name=value\". For example adding \"class=itcl::class\"\n> diff --git a/src/libcamera/thread.cpp b/src/libcamera/thread.cpp\n> index fe32cd677596..c1698d469a6c 100644\n> --- a/src/libcamera/thread.cpp\n> +++ b/src/libcamera/thread.cpp\n> @@ -19,6 +19,88 @@\n>  #include \"log.h\"\n>  #include \"message.h\"\n>  \n> +/**\n> + * \\page thread Thread Support\n> + *\n> + * libcamera supports multi-threaded applications through a threading model that\n> + * sets precise rules to guarantee thread-safe usage of the API. Additionally,\n> + * libcamera makes internal use of threads, and offers APIs that simplify\n> + * interactions with application threads. Careful compliance with the threading\n> + * model will ensure avoidance of race conditions.\n> + *\n> + * \\section thread-reentrancy Reentrancy and Thread-Safety\n> + *\n> + * Through the documentation, several terms are used to define how classes and\n> + * their member functions can be used from multiple threads.\n> + *\n> + * - A **reentrant** function may be called simultaneously from multiple\n> + *   threads if and only if each invocation uses a different instance of the\n> + *   class. This is the default for all member functions not explictly marked\n> + *   otherwise.\n> + *\n> + * - \\anchor thread-safe A **thread-safe** function may be called\n> + *   simultaneously from multiple threads on the same instance of a class. A\n> + *   thread-safe function is thus reentrant.\n> + *\n> + * - \\anchor thread-bound A **thread-bound** function may be called only from\n> + *   the thread that the class instances lives in (see section \\ref\n> + *   thread-objects). For instances of classes that do not derive from the\n> + *   Object class, this is the thread in which the instance was created. A\n> + *   thread-bound function is not thread-safe, and may or may not be reentrant.\n> + *\n> + * Neither reentrancy nor thread-safety, in this context, mean that a function\n> + * may be called simultaneously from the same thread, for instance from a\n> + * callback invoked by the the function. This may deadlock and isn't allowed\n> + * unless separately documented.\n> + *\n> + * A class is defined as reentrant, thread-safe or thread-bound if all its\n> + * member functions are reentrant, thread-safe or thread-bound respectively.\n> + * Some member functions may additionally be documented as having additional\n> + * thread-related attributes.\n> + *\n> + * Most classes are reentrant but not thread-safe, as making them fully\n> + * thread-safe would incur locking costs considered prohibitive for the\n> + * expected use cases.\n> + *\n> + * \\section thread-objects Threads and Objects\n> + *\n> + * Instances of the Object class and all its derived classes are thread-aware\n> + * and are bound to the thread they are created in. They are said to *live* in\n> + * a thread, and they interact with the event loop of their thread for the\n> + * purpose of message passing and signal delivery. Messages posted to the\n> + * object with Object::postMessage() will be delivered from the event loop of\n> + * the thread that the object lives in. Signals delivered to the object, unless\n> + * explicitly connected with ConnectionTypeDirect, will also be delivered from\n> + * the object thread's event loop.\n> + *\n> + * All Object instances created by libcamera are bound to an internal thread,\n> + * an applications don't need to provide an event loop to support them. Object\n\ns/* an applications/* and applications/\n\n\n> + * instances created by applications require an event loop. It is the\n> + * responsibility of applications to provide that event loop, either explicitly\n> + * through CameraManager::setEventDispatcher(), or by running the default event\n> + * loop provided by CameraManager::eventDispatcher() in their main thread. The\n> + * main thread of an application is the one that calls CameraManager::start().\n> + *\n> + * \\section thread-signals Threads and Signals\n> + *\n> + * When sent to a receiver that does not inherit from the Object class, signals\n> + * are delivered synchronously in the thread of the sender. When the receiver\n> + * inherits from the Object class, delivery is by default asynchronous if the\n> + * sender and receiver live in different threads. In that case, the signal is\n> + * posted to the receiver's message queue and will be delivered from the\n> + * receiver's event loop, running in the receiver's thread. This mechanism can\n> + * be overridden by selecting a different connection type when calling\n> + * Signal::connect().\n> + *\n> + * Asynchronous signal delivery is used internally in libcamera, but is also\n> + * available to applications if desired. To use this feature, applications\n> + * shall create receiver classes that inherit from the Object class, and\n> + * provide an event loop to the CameraManager as explained above. Note that\n> + * Object instance created by the application are limited to living in the\n\ns/instance/instances/\n\n> + * application's main thread. Creating Object instances from another thread of\n> + * an application causes undefined behaviour.\n> + */\n> +\n>  /**\n>   * \\file thread.h\n>   * \\brief Thread support\n>","headers":{"Return-Path":"<kieran.bingham@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 945F2607F3\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tWed, 22 Jan 2020 16:43:42 +0100 (CET)","from [192.168.0.20]\n\t(cpc89242-aztw30-2-0-cust488.18-1.cable.virginm.net [86.31.129.233])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id D4B6E2E5;\n\tWed, 22 Jan 2020 16:43:41 +0100 (CET)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1579707822;\n\tbh=Oi36tMIrN+D5Hx07pvAgCGKdmQl9Y+xef9iBXlHM00Q=;\n\th=Reply-To:Subject:To:References:From:Date:In-Reply-To:From;\n\tb=F3FTO58h3U4eC6w2k0mivjEVlbrsV3DR2ro5o7C+hz/bmLttpJgeKXeoWo+bbz5+r\n\tZTokK7PI9ltwm3rmV9oyBwM/0MdvSPCVfKipBeQIg5EuAvgXHE9PLuNmtQsoxZRgwA\n\tFjbEf8dNPTMrRaKpB7euUHGY7YpiBjxvxixgPCdA=","Reply-To":"kieran.bingham@ideasonboard.com","To":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>,\n\tlibcamera-devel@lists.libcamera.org","References":"<20200120002437.6633-1-laurent.pinchart@ideasonboard.com>\n\t<20200120002437.6633-11-laurent.pinchart@ideasonboard.com>","From":"Kieran Bingham <kieran.bingham@ideasonboard.com>","Openpgp":"preference=signencrypt","Autocrypt":"addr=kieran.bingham@ideasonboard.com; keydata=\n\tmQINBFYE/WYBEACs1PwjMD9rgCu1hlIiUA1AXR4rv2v+BCLUq//vrX5S5bjzxKAryRf0uHat\n\tV/zwz6hiDrZuHUACDB7X8OaQcwhLaVlq6byfoBr25+hbZG7G3+5EUl9cQ7dQEdvNj6V6y/SC\n\trRanWfelwQThCHckbobWiQJfK9n7rYNcPMq9B8e9F020LFH7Kj6YmO95ewJGgLm+idg1Kb3C\n\tpotzWkXc1xmPzcQ1fvQMOfMwdS+4SNw4rY9f07Xb2K99rjMwZVDgESKIzhsDB5GY465sCsiQ\n\tcSAZRxqE49RTBq2+EQsbrQpIc8XiffAB8qexh5/QPzCmR4kJgCGeHIXBtgRj+nIkCJPZvZtf\n\tKr2EAbc6tgg6DkAEHJb+1okosV09+0+TXywYvtEop/WUOWQ+zo+Y/OBd+8Ptgt1pDRyOBzL8\n\tRXa8ZqRf0Mwg75D+dKntZeJHzPRJyrlfQokngAAs4PaFt6UfS+ypMAF37T6CeDArQC41V3ko\n\tlPn1yMsVD0p+6i3DPvA/GPIksDC4owjnzVX9kM8Zc5Cx+XoAN0w5Eqo4t6qEVbuettxx55gq\n\t8K8FieAjgjMSxngo/HST8TpFeqI5nVeq0/lqtBRQKumuIqDg+Bkr4L1V/PSB6XgQcOdhtd36\n\tOe9X9dXB8YSNt7VjOcO7BTmFn/Z8r92mSAfHXpb07YJWJosQOQARAQABtDBLaWVyYW4gQmlu\n\tZ2hhbSA8a2llcmFuLmJpbmdoYW1AaWRlYXNvbmJvYXJkLmNvbT6JAlcEEwEKAEECGwMFCwkI\n\tBwIGFQgJCgsCBBYCAwECHgECF4ACGQEWIQSQLdeYP70o/eNy1HqhHkZyEKRh/QUCXWTtygUJ\n\tCyJXZAAKCRChHkZyEKRh/f8dEACTDsbLN2nioNZMwyLuQRUAFcXNolDX48xcUXsWS2QjxaPm\n\tVsJx8Uy8aYkS85mdPBh0C83OovQR/OVbr8AxhGvYqBs3nQvbWuTl/+4od7DfK2VZOoKBAu5S\n\tQK2FYuUcikDqYcFWJ8DQnubxfE8dvzojHEkXw0sA4igINHDDFX3HJGZtLio+WpEFQtCbfTAG\n\tYZslasz1YZRbwEdSsmO3/kqy5eMnczlm8a21A3fKUo3g8oAZEFM+f4DUNzqIltg31OAB/kZS\n\tenKZQ/SWC8PmLg/ZXBrReYakxXtkP6w3FwMlzOlhGxqhIRNiAJfXJBaRhuUWzPOpEDE9q5YJ\n\tBmqQL2WJm1VSNNVxbXJHpaWMH1sA2R00vmvRrPXGwyIO0IPYeUYQa3gsy6k+En/aMQJd27dp\n\taScf9am9PFICPY5T4ppneeJLif2lyLojo0mcHOV+uyrds9XkLpp14GfTkeKPdPMrLLTsHRfH\n\tfA4I4OBpRrEPiGIZB/0im98MkGY/Mu6qxeZmYLCcgD6qz4idOvfgVOrNh+aA8HzIVR+RMW8H\n\tQGBN9f0E3kfwxuhl3omo6V7lDw8XOdmuWZNC9zPq1UfryVHANYbLGz9KJ4Aw6M+OgBC2JpkD\n\thXMdHUkC+d20dwXrwHTlrJi1YNp6rBc+xald3wsUPOZ5z8moTHUX/uPA/qhGsbkCDQRWBP1m\n\tARAAzijkb+Sau4hAncr1JjOY+KyFEdUNxRy+hqTJdJfaYihxyaj0Ee0P0zEi35CbE6lgU0Uz\n\ttih9fiUbSV3wfsWqg1Ut3/5rTKu7kLFp15kF7eqvV4uezXRD3Qu4yjv/rMmEJbbD4cTvGCYI\n\td6MDC417f7vK3hCbCVIZSp3GXxyC1LU+UQr3fFcOyCwmP9vDUR9JV0BSqHHxRDdpUXE26Dk6\n\tmhf0V1YkspE5St814ETXpEus2urZE5yJIUROlWPIL+hm3NEWfAP06vsQUyLvr/GtbOT79vXl\n\tEn1aulcYyu20dRRxhkQ6iILaURcxIAVJJKPi8dsoMnS8pB0QW12AHWuirPF0g6DiuUfPmrA5\n\tPKe56IGlpkjc8cO51lIxHkWTpCMWigRdPDexKX+Sb+W9QWK/0JjIc4t3KBaiG8O4yRX8ml2R\n\t+rxfAVKM6V769P/hWoRGdgUMgYHFpHGSgEt80OKK5HeUPy2cngDUXzwrqiM5Sz6Od0qw5pCk\n\tNlXqI0W/who0iSVM+8+RmyY0OEkxEcci7rRLsGnM15B5PjLJjh1f2ULYkv8s4SnDwMZ/kE04\n\t/UqCMK/KnX8pwXEMCjz0h6qWNpGwJ0/tYIgQJZh6bqkvBrDogAvuhf60Sogw+mH8b+PBlx1L\n\toeTK396wc+4c3BfiC6pNtUS5GpsPMMjYMk7kVvEAEQEAAYkCPAQYAQoAJgIbDBYhBJAt15g/\n\tvSj943LUeqEeRnIQpGH9BQJdizzIBQkLSKZiAAoJEKEeRnIQpGH9eYgQAJpjaWNgqNOnMTmD\n\tMJggbwjIotypzIXfhHNCeTkG7+qCDlSaBPclcPGYrTwCt0YWPU2TgGgJrVhYT20ierN8LUvj\n\t6qOPTd+Uk7NFzL65qkh80ZKNBFddx1AabQpSVQKbdcLb8OFs85kuSvFdgqZwgxA1vl4TFhNz\n\tPZ79NAmXLackAx3sOVFhk4WQaKRshCB7cSl+RIng5S/ThOBlwNlcKG7j7W2MC06BlTbdEkUp\n\tECzuuRBv8wX4OQl+hbWbB/VKIx5HKlLu1eypen/5lNVzSqMMIYkkZcjV2SWQyUGxSwq0O/sx\n\tS0A8/atCHUXOboUsn54qdxrVDaK+6jIAuo8JiRWctP16KjzUM7MO0/+4zllM8EY57rXrj48j\n\tsbEYX0YQnzaj+jO6kJtoZsIaYR7rMMq9aUAjyiaEZpmP1qF/2sYenDx0Fg2BSlLvLvXM0vU8\n\tpQk3kgDu7kb/7PRYrZvBsr21EIQoIjXbZxDz/o7z95frkP71EaICttZ6k9q5oxxA5WC6sTXc\n\tMW8zs8avFNuA9VpXt0YupJd2ijtZy2mpZNG02fFVXhIn4G807G7+9mhuC4XG5rKlBBUXTvPU\n\tAfYnB4JBDLmLzBFavQfvonSfbitgXwCG3vS+9HEwAjU30Bar1PEOmIbiAoMzuKeRm2LVpmq4\n\tWZw01QYHU/GUV/zHJSFk","Organization":"Ideas on Board","Message-ID":"<7a9f511e-1546-cec6-d83a-b064ca823fe2@ideasonboard.com>","Date":"Wed, 22 Jan 2020 15:43:38 +0000","User-Agent":"Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101\n\tThunderbird/60.9.0","MIME-Version":"1.0","In-Reply-To":"<20200120002437.6633-11-laurent.pinchart@ideasonboard.com>","Content-Type":"text/plain; charset=utf-8","Content-Language":"en-GB","Content-Transfer-Encoding":"7bit","Subject":"Re: [libcamera-devel] [PATCH 10/19] libcamera: Define the threading\n\tmodel","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>","X-List-Received-Date":"Wed, 22 Jan 2020 15:43:42 -0000"}}]