event_loop.h revision 99f01ac9bd6e351538cb8922ef15d9e838e7339a
1e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie/* 2e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie * Copyright (C) 2016 The Android Open Source Project 3e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie * 4e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie * Licensed under the Apache License, Version 2.0 (the "License"); 5e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie * you may not use this file except in compliance with the License. 6e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie * You may obtain a copy of the License at 7e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie * 8e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie * http://www.apache.org/licenses/LICENSE-2.0 9e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie * 10e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie * Unless required by applicable law or agreed to in writing, software 11e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie * distributed under the License is distributed on an "AS IS" BASIS, 12e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie * See the License for the specific language governing permissions and 14e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie * limitations under the License. 15e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie */ 16e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie 17e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie#ifndef CHRE_CORE_EVENT_LOOP_H_ 18e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie#define CHRE_CORE_EVENT_LOOP_H_ 19e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie 20e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie#include "chre/core/event.h" 21e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie#include "chre/core/nanoapp.h" 22fbb213b072fec0a14f437ad55685c4d95eec829eAndrew Rossignol#include "chre/core/timer_pool.h" 23977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie#include "chre/platform/mutex.h" 242de17c9c5c541d72248f8371dfb4d7e402dc93e8Andrew Rossignol#include "chre/platform/platform_nanoapp.h" 25c03d7df169f13195652de29f4452830130a0c53fAndrew Rossignol#include "chre/util/dynamic_vector.h" 26022cc6c770c299bb364e35377a2661791475bbceAndrew Rossignol#include "chre/util/fixed_size_blocking_queue.h" 27e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie#include "chre/util/non_copyable.h" 28a1d5686c7513f6b8a436efd9f554d8c2227a2291Brian Duddie#include "chre/util/synchronized_memory_pool.h" 292de17c9c5c541d72248f8371dfb4d7e402dc93e8Andrew Rossignol#include "chre/util/unique_ptr.h" 30e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie 31e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddienamespace chre { 32e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie 33e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie/** 34977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie * The EventLoop represents a single thread of execution that is shared among 35977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie * zero or more nanoapps. As the name implies, the EventLoop is built around a 36977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie * loop that delivers events to the nanoapps managed within for processing. 37e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie */ 38e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddieclass EventLoop : public NonCopyable { 39e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie public: 40fbb213b072fec0a14f437ad55685c4d95eec829eAndrew Rossignol /** 41fbb213b072fec0a14f437ad55685c4d95eec829eAndrew Rossignol * Setup the event loop. 42fbb213b072fec0a14f437ad55685c4d95eec829eAndrew Rossignol */ 43fbb213b072fec0a14f437ad55685c4d95eec829eAndrew Rossignol EventLoop(); 44fbb213b072fec0a14f437ad55685c4d95eec829eAndrew Rossignol 45977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie /** 46a2f5add27054c406f36528cf8a5cbc6d4c79d246Brian Duddie * Synchronous callback used with forEachNanoapp 47a2f5add27054c406f36528cf8a5cbc6d4c79d246Brian Duddie */ 48a2f5add27054c406f36528cf8a5cbc6d4c79d246Brian Duddie typedef void (NanoappCallbackFunction)(const Nanoapp *nanoapp, void *data); 49a2f5add27054c406f36528cf8a5cbc6d4c79d246Brian Duddie 50a2f5add27054c406f36528cf8a5cbc6d4c79d246Brian Duddie /** 51977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie * Searches the set of nanoapps managed by this EventLoop for one with the 52977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie * given app ID. If found, provides its instance ID, which can be used to send 53977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie * events to the app. 54977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie * 55977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie * This function is safe to call from any thread. 56977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie * 57977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie * @param appId The nanoapp identifier to search for. 58977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie * @param instanceId If this function returns true, will be populated with the 59977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie * instanceId associated with the given appId; otherwise unmodified. 60977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie * Must not be null. 61977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie * @return true if the given app ID was found and instanceId was populated 62977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie */ 63977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie bool findNanoappInstanceIdByAppId(uint64_t appId, uint32_t *instanceId); 64e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie 65e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie /** 66a2f5add27054c406f36528cf8a5cbc6d4c79d246Brian Duddie * Iterates over the list of Nanoapps managed by this EventLoop, and invokes 67a2f5add27054c406f36528cf8a5cbc6d4c79d246Brian Duddie * the supplied callback for each one. This holds a lock if necessary, so it 68a2f5add27054c406f36528cf8a5cbc6d4c79d246Brian Duddie * is safe to call from any thread. 69a2f5add27054c406f36528cf8a5cbc6d4c79d246Brian Duddie * 70a2f5add27054c406f36528cf8a5cbc6d4c79d246Brian Duddie * @param callback Function to invoke on each Nanoapp (synchronously) 71a2f5add27054c406f36528cf8a5cbc6d4c79d246Brian Duddie * @param data Arbitrary data to pass to the callback 72a2f5add27054c406f36528cf8a5cbc6d4c79d246Brian Duddie */ 73a2f5add27054c406f36528cf8a5cbc6d4c79d246Brian Duddie void forEachNanoapp(NanoappCallbackFunction *callback, void *data); 74a2f5add27054c406f36528cf8a5cbc6d4c79d246Brian Duddie 75a2f5add27054c406f36528cf8a5cbc6d4c79d246Brian Duddie /** 7609a4783208b5ba1e14d0f0102eb31e688caca28dBrian Duddie * Invokes a message to host free callback supplied by the given nanoapp 7709a4783208b5ba1e14d0f0102eb31e688caca28dBrian Duddie * (identified by app ID). Ensures that the calling context is updated 7809a4783208b5ba1e14d0f0102eb31e688caca28dBrian Duddie * appropriately. 7909a4783208b5ba1e14d0f0102eb31e688caca28dBrian Duddie * 8009a4783208b5ba1e14d0f0102eb31e688caca28dBrian Duddie * @param appId Identifies the nanoapp that sent this message and supplied the 8109a4783208b5ba1e14d0f0102eb31e688caca28dBrian Duddie * free callback 8209a4783208b5ba1e14d0f0102eb31e688caca28dBrian Duddie * @param freeFunction The non-null message free callback given by the nanoapp 8309a4783208b5ba1e14d0f0102eb31e688caca28dBrian Duddie * @param message Pointer to the message data 8409a4783208b5ba1e14d0f0102eb31e688caca28dBrian Duddie * @param messageSize Size of the message 8509a4783208b5ba1e14d0f0102eb31e688caca28dBrian Duddie */ 8609a4783208b5ba1e14d0f0102eb31e688caca28dBrian Duddie void invokeMessageFreeFunction( 8709a4783208b5ba1e14d0f0102eb31e688caca28dBrian Duddie uint64_t appId, chreMessageFreeFunction *freeFunction, void *message, 8809a4783208b5ba1e14d0f0102eb31e688caca28dBrian Duddie size_t messageSize); 8909a4783208b5ba1e14d0f0102eb31e688caca28dBrian Duddie 9009a4783208b5ba1e14d0f0102eb31e688caca28dBrian Duddie /** 919d5b500a223ef73560f0dce38f50b809bde5dd0dBrian Duddie * Invokes the Nanoapp's start callback, and if successful, adds it to the 929d5b500a223ef73560f0dce38f50b809bde5dd0dBrian Duddie * set of Nanoapps managed by this EventLoop. This function must only be 939d5b500a223ef73560f0dce38f50b809bde5dd0dBrian Duddie * called from the context of the thread that runs this event loop (i.e. from 949d5b500a223ef73560f0dce38f50b809bde5dd0dBrian Duddie * the same thread that will call run() or from a callback invoked within 959d5b500a223ef73560f0dce38f50b809bde5dd0dBrian Duddie * run()). 96e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie * 979d5b500a223ef73560f0dce38f50b809bde5dd0dBrian Duddie * @param nanoapp The nanoapp that will be started. Upon success, this 989d5b500a223ef73560f0dce38f50b809bde5dd0dBrian Duddie * UniquePtr will become invalid, as the underlying Nanoapp instance 999d5b500a223ef73560f0dce38f50b809bde5dd0dBrian Duddie * will have been transferred to be managed by this EventLoop. 1009d5b500a223ef73560f0dce38f50b809bde5dd0dBrian Duddie * @return true if the app was started successfully 101e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie */ 1029d5b500a223ef73560f0dce38f50b809bde5dd0dBrian Duddie bool startNanoapp(UniquePtr<Nanoapp>& nanoapp); 103e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie 104e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie /** 10599f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * Stops and unloads a nanoapp identified by its instance ID. The end entry 10699f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * point will be invoked, and the chre::Nanoapp instance will be destroyed. 10799f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * After this function returns, all references to the Nanoapp instance are 10899f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * invalidated. 109e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie * 11099f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * @param instanceId The nanoapp's unique instance identifier 11199f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * @param allowSystemNanoappUnload If false, this function will reject 11299f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * attempts to unload a system nanoapp 11399f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * 11499f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * @return true if the nanoapp with the given instance ID was found & unloaded 115e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie */ 11699f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie bool unloadNanoapp(uint32_t instanceId, bool allowSystemNanoappUnload); 117e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie 118e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie /** 119977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie * Executes the loop that blocks on the event queue and delivers received 120977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie * events to nanoapps. Only returns after stop() is called (from another 121977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie * context). 122e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie */ 123e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie void run(); 124e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie 125e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie /** 126e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie * Signals the event loop currently executing in run() to exit gracefully at 127f80ea015d077330cfdbd619680b250915ffcf1d2Brian Duddie * the next available opportunity. This function is thread-safe. 128e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie */ 129e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie void stop(); 130e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie 1314927ee586656424c827920876673228fbdcf27c3Andrew Rossignol /** 1324927ee586656424c827920876673228fbdcf27c3Andrew Rossignol * Posts an event to a nanoapp that is currently running (or all nanoapps if 133042f73e3b7f019c818f69b2c097c4b6f9db839b5Brian Duddie * the target instance ID is kBroadcastInstanceId). 134042f73e3b7f019c818f69b2c097c4b6f9db839b5Brian Duddie * 135042f73e3b7f019c818f69b2c097c4b6f9db839b5Brian Duddie * This function is safe to call from any thread. 1364927ee586656424c827920876673228fbdcf27c3Andrew Rossignol * 1375d9b2d68940f7dac47bf2fbad6f6069ed3b2faaaBrian Duddie * @param eventType The type of data being posted. 1385d9b2d68940f7dac47bf2fbad6f6069ed3b2faaaBrian Duddie * @param eventData The data being posted. 1395d9b2d68940f7dac47bf2fbad6f6069ed3b2faaaBrian Duddie * @param freeCallback The callback to invoke when the event is no longer 1405d9b2d68940f7dac47bf2fbad6f6069ed3b2faaaBrian Duddie * needed. 1415d9b2d68940f7dac47bf2fbad6f6069ed3b2faaaBrian Duddie * @param senderInstanceId The instance ID of the sender of this event. 1425d9b2d68940f7dac47bf2fbad6f6069ed3b2faaaBrian Duddie * @param targetInstanceId The instance ID of the destination of this event. 1434927ee586656424c827920876673228fbdcf27c3Andrew Rossignol * 144a12d05f5b1b8bd8d953a328758426b7ca8b5e6deBrian Duddie * @return true if the event was successfully added to the queue. Note that 145a12d05f5b1b8bd8d953a328758426b7ca8b5e6deBrian Duddie * unlike chreSendEvent, this does *not* invoke the free callback if 146a12d05f5b1b8bd8d953a328758426b7ca8b5e6deBrian Duddie * it failed to post the event. 1475d9b2d68940f7dac47bf2fbad6f6069ed3b2faaaBrian Duddie * 1485d9b2d68940f7dac47bf2fbad6f6069ed3b2faaaBrian Duddie * @see chreSendEvent 1494927ee586656424c827920876673228fbdcf27c3Andrew Rossignol */ 150042f73e3b7f019c818f69b2c097c4b6f9db839b5Brian Duddie bool postEvent(uint16_t eventType, void *eventData, 1514927ee586656424c827920876673228fbdcf27c3Andrew Rossignol chreEventCompleteFunction *freeCallback, 1524927ee586656424c827920876673228fbdcf27c3Andrew Rossignol uint32_t senderInstanceId = kSystemInstanceId, 1534927ee586656424c827920876673228fbdcf27c3Andrew Rossignol uint32_t targetInstanceId = kBroadcastInstanceId); 154e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie 155e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie /** 156e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie * Returns a pointer to the currently executing Nanoapp, or nullptr if none is 157977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie * currently executing. Must only be called from within the thread context 158977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie * associated with this EventLoop. 159e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie * 160977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie * @return the currently executing nanoapp, or nullptr 161e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie */ 1627983050d7cd84f1d5736f220ef9fd49be716b2c8Andrew Rossignol Nanoapp *getCurrentNanoapp() const; 163e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie 164e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie /** 165a2f5add27054c406f36528cf8a5cbc6d4c79d246Brian Duddie * Gets the number of nanoapps currently associated with this event loop. Must 166a2f5add27054c406f36528cf8a5cbc6d4c79d246Brian Duddie * only be called within the context of this EventLoop. 167a2f5add27054c406f36528cf8a5cbc6d4c79d246Brian Duddie * 168a2f5add27054c406f36528cf8a5cbc6d4c79d246Brian Duddie * @return The number of nanoapps managed by this event loop 169a2f5add27054c406f36528cf8a5cbc6d4c79d246Brian Duddie */ 170a2f5add27054c406f36528cf8a5cbc6d4c79d246Brian Duddie size_t getNanoappCount() const; 171a2f5add27054c406f36528cf8a5cbc6d4c79d246Brian Duddie 172a2f5add27054c406f36528cf8a5cbc6d4c79d246Brian Duddie /** 173725bef45ca127971b3ea798cd1f4e4b2c0d8fe9dAndrew Rossignol * Obtains the TimerPool associated with this event loop. 174725bef45ca127971b3ea798cd1f4e4b2c0d8fe9dAndrew Rossignol * 175725bef45ca127971b3ea798cd1f4e4b2c0d8fe9dAndrew Rossignol * @return The timer pool owned by this event loop. 176725bef45ca127971b3ea798cd1f4e4b2c0d8fe9dAndrew Rossignol */ 177725bef45ca127971b3ea798cd1f4e4b2c0d8fe9dAndrew Rossignol TimerPool& getTimerPool(); 178725bef45ca127971b3ea798cd1f4e4b2c0d8fe9dAndrew Rossignol 17930f18903edc1dfe46e12b9989760ef7a56cb31d3Andrew Rossignol /** 18030f18903edc1dfe46e12b9989760ef7a56cb31d3Andrew Rossignol * Searches the set of nanoapps managed by this EventLoop for one with the 18130f18903edc1dfe46e12b9989760ef7a56cb31d3Andrew Rossignol * given instance ID. 18230f18903edc1dfe46e12b9989760ef7a56cb31d3Andrew Rossignol * 18330f18903edc1dfe46e12b9989760ef7a56cb31d3Andrew Rossignol * This function is safe to call from any thread. 18430f18903edc1dfe46e12b9989760ef7a56cb31d3Andrew Rossignol * 18530f18903edc1dfe46e12b9989760ef7a56cb31d3Andrew Rossignol * @param instanceId The nanoapp instance ID to search for. 18630f18903edc1dfe46e12b9989760ef7a56cb31d3Andrew Rossignol * @return a pointer to the found nanoapp or nullptr if no match was found. 18730f18903edc1dfe46e12b9989760ef7a56cb31d3Andrew Rossignol */ 18830f18903edc1dfe46e12b9989760ef7a56cb31d3Andrew Rossignol Nanoapp *findNanoappByInstanceId(uint32_t instanceId); 18930f18903edc1dfe46e12b9989760ef7a56cb31d3Andrew Rossignol 19099f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie /** 19199f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * @return true if the current Nanoapp (or entire CHRE) is being unloaded, and 19299f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * therefore it should not be allowed to send events or messages, etc. 19399f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie */ 19499f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie bool currentNanoappIsStopping(); 19599f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie 196e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie private: 1974927ee586656424c827920876673228fbdcf27c3Andrew Rossignol //! The maximum number of events that can be active in the system. 1984927ee586656424c827920876673228fbdcf27c3Andrew Rossignol static constexpr size_t kMaxEventCount = 1024; 1994927ee586656424c827920876673228fbdcf27c3Andrew Rossignol 200022cc6c770c299bb364e35377a2661791475bbceAndrew Rossignol //! The maximum number of events that are awaiting to be scheduled. These 201022cc6c770c299bb364e35377a2661791475bbceAndrew Rossignol //! events are in a queue to be distributed to apps. 202022cc6c770c299bb364e35377a2661791475bbceAndrew Rossignol static constexpr size_t kMaxUnscheduledEventCount = 1024; 203022cc6c770c299bb364e35377a2661791475bbceAndrew Rossignol 2044927ee586656424c827920876673228fbdcf27c3Andrew Rossignol //! The memory pool to allocate incoming events from. 205f7914d0fbadf2644c0c4096380c741bee2a026e0Andrew Rossignol SynchronizedMemoryPool<Event, kMaxEventCount> mEventPool; 2064927ee586656424c827920876673228fbdcf27c3Andrew Rossignol 207fbb213b072fec0a14f437ad55685c4d95eec829eAndrew Rossignol //! The timer used schedule timed events for tasks running in this event loop. 208fbb213b072fec0a14f437ad55685c4d95eec829eAndrew Rossignol TimerPool mTimerPool; 209fbb213b072fec0a14f437ad55685c4d95eec829eAndrew Rossignol 210c03d7df169f13195652de29f4452830130a0c53fAndrew Rossignol //! The list of nanoapps managed by this event loop. 2112de17c9c5c541d72248f8371dfb4d7e402dc93e8Andrew Rossignol DynamicVector<UniquePtr<Nanoapp>> mNanoapps; 212725bef45ca127971b3ea798cd1f4e4b2c0d8fe9dAndrew Rossignol 213977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie //! This lock *must* be held whenever we: 214977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie //! (1) make changes to the mNanoapps vector, or 215977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie //! (2) read the mNanoapps vector from a thread other than the one 216977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie //! associated with this EventLoop 217977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie //! It is not necessary to acquire the lock when reading mNanoapps from within 218977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie //! the thread context of this EventLoop. 219977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie Mutex mNanoappsLock; 220977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie 221c03d7df169f13195652de29f4452830130a0c53fAndrew Rossignol //! The blocking queue of incoming events from the system that have not been 22299f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie //! distributed out to apps yet. 2231795db1e2282dac8454cf59d23314f70b6930f7bAndrew Rossignol FixedSizeBlockingQueue<Event *, kMaxUnscheduledEventCount> mEvents; 224e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie 225977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie // TODO: should probably be atomic to be fully correct 2268c56d08e149720fcb99e6ddc71289ebb5ee594e6Brian Duddie volatile bool mRunning = true; 227e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie 22899f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie //! The nanoapp that is currently executing - must be set any time we call 22999f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie //! into the nanoapp's entry points or callbacks 230e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie Nanoapp *mCurrentApp = nullptr; 231e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie 23299f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie //! Set to the nanoapp we are in the process of unloading in unloadNanoapp() 23399f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie Nanoapp *mStoppingNanoapp = nullptr; 23499f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie 23599f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie /** 23699f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * Do one round of Nanoapp event delivery, only considering events in 23799f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * Nanoapps' own queues (not mEvents). 23899f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * 23999f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * @return true if there are more events pending in Nanoapps' own queues 24099f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie */ 24199f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie bool deliverEvents(); 24299f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie 243977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie /** 2445d9b2d68940f7dac47bf2fbad6f6069ed3b2faaaBrian Duddie * Delivers the next event pending in the Nanoapp's queue, and takes care of 2455d9b2d68940f7dac47bf2fbad6f6069ed3b2faaaBrian Duddie * freeing events once they have been delivered to all nanoapps. Must only be 2465d9b2d68940f7dac47bf2fbad6f6069ed3b2faaaBrian Duddie * called after confirming that the app has at least 1 pending event. 2475d9b2d68940f7dac47bf2fbad6f6069ed3b2faaaBrian Duddie * 2485d9b2d68940f7dac47bf2fbad6f6069ed3b2faaaBrian Duddie * @return true if the nanoapp has another event pending in its queue 2495d9b2d68940f7dac47bf2fbad6f6069ed3b2faaaBrian Duddie */ 2505d9b2d68940f7dac47bf2fbad6f6069ed3b2faaaBrian Duddie bool deliverNextEvent(const UniquePtr<Nanoapp>& app); 2515d9b2d68940f7dac47bf2fbad6f6069ed3b2faaaBrian Duddie 2525d9b2d68940f7dac47bf2fbad6f6069ed3b2faaaBrian Duddie /** 25399f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * Given an event pulled from the main incoming event queue (mEvents), deliver 25499f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * it to all Nanoapps that should receive the event, or free the event if 25599f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * there are no valid recipients. 25699f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * 25799f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * @param event The Event to distribute to Nanoapps 25899f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie */ 25999f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie void distributeEvent(Event *event); 26099f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie 26199f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie /** 26299f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * Distribute all events pending in the inbound event queue. Note that this 26399f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * function only guarantees that any events in the inbound queue at the time 26499f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * it is called will be distributed to Nanoapp event queues - new events may 26599f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * still be posted during or after this function call from other threads as 26699f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * long as postEvent() will accept them. 26799f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie */ 26899f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie void flushInboundEventQueue(); 26999f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie 27099f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie /** 27199f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * Delivers events pending in Nanoapps' own queues until they are all empty. 27299f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie */ 27399f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie void flushNanoappEventQueues(); 27499f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie 27599f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie /** 276977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie * Call after when an Event has been delivered to all intended recipients. 277977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie * Invokes the event's free callback (if given) and releases resources. 278977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie * 279977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie * @param event The event to be freed 280977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie */ 281e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie void freeEvent(Event *event); 282e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie 283977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie /** 28409a4783208b5ba1e14d0f0102eb31e688caca28dBrian Duddie * Finds a Nanoapp with the given 64-bit appId. 28509a4783208b5ba1e14d0f0102eb31e688caca28dBrian Duddie * 28609a4783208b5ba1e14d0f0102eb31e688caca28dBrian Duddie * Only safe to call within this EventLoop's thread. 28709a4783208b5ba1e14d0f0102eb31e688caca28dBrian Duddie * 28809a4783208b5ba1e14d0f0102eb31e688caca28dBrian Duddie * @param appId Nanoapp ID 28909a4783208b5ba1e14d0f0102eb31e688caca28dBrian Duddie * @return Pointer to Nanoapp instance in this EventLoop with the given app 29009a4783208b5ba1e14d0f0102eb31e688caca28dBrian Duddie * ID, or nullptr if not found 29109a4783208b5ba1e14d0f0102eb31e688caca28dBrian Duddie */ 29209a4783208b5ba1e14d0f0102eb31e688caca28dBrian Duddie Nanoapp *lookupAppByAppId(uint64_t appId); 29309a4783208b5ba1e14d0f0102eb31e688caca28dBrian Duddie 29409a4783208b5ba1e14d0f0102eb31e688caca28dBrian Duddie /** 295977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie * Finds a Nanoapp with the given instanceId. 296977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie * 297977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie * Only safe to call within this EventLoop's thread. 298977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie * 299977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie * @param instanceId Nanoapp instance identifier 300977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie * @return Nanoapp with the given instanceId, or nullptr if not found 301977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie */ 302977321d9ad051d4d6519a5fa8c2ca914f4d1424fBrian Duddie Nanoapp *lookupAppByInstanceId(uint32_t instanceId); 3035d9b2d68940f7dac47bf2fbad6f6069ed3b2faaaBrian Duddie 3045d9b2d68940f7dac47bf2fbad6f6069ed3b2faaaBrian Duddie /** 30599f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * Stops and unloads the Nanoapp at the given index in mNanoapps. 30699f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * 30799f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * IMPORTANT: prior to calling this function, the event queues must be in a 30899f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * safe condition for removal of this nanoapp. This means that there must not 30999f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * be any pending events in this nanoapp's queue, and there must not be any 31099f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * outstanding events sent by this nanoapp, as they may reference the 31199f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie * nanoapp's own memory (even if there is no free callback). 3125d9b2d68940f7dac47bf2fbad6f6069ed3b2faaaBrian Duddie */ 31399f01ac9bd6e351538cb8922ef15d9e838e7339aBrian Duddie void unloadNanoappAtIndex(size_t index); 314e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie}; 315e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie 316e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie} // namespace chre 317e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie 318e64f180233e64c40b56993cfea3696c5b4b16395Brian Duddie#endif // CHRE_CORE_EVENT_LOOP_H_ 319