Refactor sensor list in SensorService
Refactor sensor lists management logic in sensorservice:
* Factor all sensor list management code into a separate class.
* Remove error-prone repeated sensor lists.
* Solve synchronization issue when sensor is added or removed during runtime.
* Switch to STL containers.
Bug: b/27911774
Change-Id: I94d5571e1fa3166dbe893ffac2a2a7584be6349c
diff --git a/services/sensorservice/SensorList.h b/services/sensorservice/SensorList.h
new file mode 100644
index 0000000..3fe73cc
--- /dev/null
+++ b/services/sensorservice/SensorList.h
@@ -0,0 +1,145 @@
+/*
+ * Copyright (C) 2016 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef ANDROID_SENSOR_LIST_H
+#define ANDROID_SENSOR_LIST_H
+
+#include "SensorInterface.h"
+
+#include <gui/Sensor.h>
+#include <utils/String8.h>
+#include <utils/Vector.h>
+
+#include <mutex>
+#include <map>
+#include <string>
+#include <unordered_set>
+#include <vector>
+
+namespace android {
+class SensorInterface;
+
+namespace SensorServiceUtil {
+
+class Dumpable {
+public:
+ virtual std::string dump() const;
+ virtual void setFormat(std::string ) {}
+ virtual ~Dumpable() {}
+};
+
+class SensorList : public Dumpable {
+public:
+ // After SensorInterface * is added into SensorList, it can be assumed that SensorList own the
+ // object it pointed to and the object should not be released elsewhere.
+ bool add(int handle, SensorInterface* si, bool isForDebug = false, bool isVirtual = false);
+ bool remove(int handle);
+
+ inline bool hasAnySensor() const { return mHandleMap.size() > 0;}
+
+ //helper functions
+ const Vector<Sensor> getUserSensors() const;
+ const Vector<Sensor> getUserDebugSensors() const;
+ const Vector<Sensor> getDynamicSensors() const;
+ const Vector<Sensor> getVirtualSensors() const;
+
+ String8 getName(int handle) const;
+ const Sensor& get(int handle) const;
+ SensorInterface* getInterface(int handle) const;
+ bool isNewHandle(int handle) const;
+
+ // Iterate through Sensor in sensor list and perform operation f on each Sensor object.
+ //
+ // TF is a function with the signature:
+ // bool f(const Sensor &);
+ // A return value of 'false' stops the iteration immediately.
+ //
+ // Note: in the function f, it is illegal to make calls to member functions of the same
+ // SensorList object on which forEachSensor is invoked.
+ template <typename TF>
+ void forEachSensor(const TF& f) const;
+
+ const Sensor& getNonSensor() const { return mNonSensor;}
+
+ // Dumpable interface
+ virtual std::string dump() const override;
+
+ virtual ~SensorList();
+private:
+ struct Entry {
+ //TODO: use sp<> here
+ SensorInterface * const si;
+ const bool isForDebug;
+ const bool isVirtual;
+ Entry(SensorInterface* si_, bool debug_, bool virtual_) :
+ si(si_), isForDebug(debug_), isVirtual(virtual_) {
+ }
+ };
+
+ const static Sensor mNonSensor; //.getName() == "unknown",
+
+ // Iterate through Entry in sensor list and perform operation f on each Entry.
+ //
+ // TF is a function with the signature:
+ // bool f(const Entry &);
+ // A return value of 'false' stops the iteration over entries immediately.
+ //
+ // Note: in the function being passed in, it is illegal to make calls to member functions of the
+ // same SensorList object on which forEachSensor is invoked.
+ template <typename TF>
+ void forEachEntry(const TF& f) const;
+
+ template <typename T, typename TF>
+ T getOne(int handle, const TF& accessor, T def = T()) const;
+
+ mutable std::mutex mLock;
+ std::map<int, Entry> mHandleMap;
+ std::unordered_set<int> mUsedHandle;
+ std::vector<SensorInterface *> mRecycle;
+};
+
+template <typename TF>
+void SensorList::forEachSensor(const TF& f) const {
+ // lock happens in forEachEntry
+ forEachEntry([&f] (const Entry& e) -> bool { return f(e.si->getSensor());});
+}
+
+template <typename TF>
+void SensorList::forEachEntry(const TF& f) const {
+ std::lock_guard<std::mutex> lk(mLock);
+
+ for (auto&& i : mHandleMap) {
+ if (!f(i.second)){
+ break;
+ }
+ }
+}
+
+template <typename T, typename TF>
+T SensorList::getOne(int handle, const TF& accessor, T def) const {
+ std::lock_guard<std::mutex> lk(mLock);
+ auto i = mHandleMap.find(handle);
+ if (i != mHandleMap.end()) {
+ return accessor(i->second);
+ } else {
+ return def;
+ }
+}
+
+} // namespace SensorServiceUtil
+} // namespace android
+
+#endif // ANDROID_SENSOR_LIST_H