1 /* 2 * Copyright (C) 2010 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 #ifndef ANDROID_SENSOR_SERVICE_H 18 #define ANDROID_SENSOR_SERVICE_H 19 20 #include "SensorList.h" 21 #include "RecentEventLogger.h" 22 23 #include <binder/BinderService.h> 24 #include <cutils/compiler.h> 25 #include <sensor/ISensorServer.h> 26 #include <sensor/ISensorEventConnection.h> 27 #include <sensor/Sensor.h> 28 29 #include <utils/AndroidThreads.h> 30 #include <utils/KeyedVector.h> 31 #include <utils/Looper.h> 32 #include <utils/SortedVector.h> 33 #include <utils/String8.h> 34 #include <utils/Vector.h> 35 #include <utils/threads.h> 36 37 #include <stdint.h> 38 #include <sys/types.h> 39 #include <unordered_map> 40 #include <unordered_set> 41 42 #if __clang__ 43 // Clang warns about SensorEventConnection::dump hiding BBinder::dump. The cause isn't fixable 44 // without changing the API, so let's tell clang this is indeed intentional. 45 #pragma clang diagnostic ignored "-Woverloaded-virtual" 46 #endif 47 48 // --------------------------------------------------------------------------- 49 #define IGNORE_HARDWARE_FUSION false 50 #define DEBUG_CONNECTIONS false 51 // Max size is 100 KB which is enough to accept a batch of about 1000 events. 52 #define MAX_SOCKET_BUFFER_SIZE_BATCHED (100 * 1024) 53 // For older HALs which don't support batching, use a smaller socket buffer size. 54 #define SOCKET_BUFFER_SIZE_NON_BATCHED (4 * 1024) 55 56 #define SENSOR_REGISTRATIONS_BUF_SIZE 200 57 58 namespace android { 59 // --------------------------------------------------------------------------- 60 class SensorInterface; 61 using namespace SensorServiceUtil; 62 63 class SensorService : 64 public BinderService<SensorService>, 65 public BnSensorServer, 66 protected Thread 67 { 68 // nested class/struct for internal use 69 class SensorEventConnection; 70 class SensorDirectConnection; 71 72 public: 73 void cleanupConnection(SensorEventConnection* connection); 74 void cleanupConnection(SensorDirectConnection* c); 75 76 status_t enable(const sp<SensorEventConnection>& connection, int handle, 77 nsecs_t samplingPeriodNs, nsecs_t maxBatchReportLatencyNs, int reservedFlags, 78 const String16& opPackageName); 79 80 status_t disable(const sp<SensorEventConnection>& connection, int handle); 81 82 status_t setEventRate(const sp<SensorEventConnection>& connection, int handle, nsecs_t ns, 83 const String16& opPackageName); 84 85 status_t flushSensor(const sp<SensorEventConnection>& connection, 86 const String16& opPackageName); 87 88 private: 89 friend class BinderService<SensorService>; 90 91 // nested class/struct for internal use 92 class SensorRecord; 93 class SensorEventAckReceiver; 94 class SensorRegistrationInfo; 95 96 enum Mode { 97 // The regular operating mode where any application can register/unregister/call flush on 98 // sensors. 99 NORMAL = 0, 100 // This mode is only used for testing purposes. Not all HALs support this mode. In this mode, 101 // the HAL ignores the sensor data provided by physical sensors and accepts the data that is 102 // injected from the SensorService as if it were the real sensor data. This mode is primarily 103 // used for testing various algorithms like vendor provided SensorFusion, Step Counter and 104 // Step Detector etc. Typically in this mode, there will be a client (a 105 // SensorEventConnection) which will be injecting sensor data into the HAL. Normal apps can 106 // unregister and register for any sensor that supports injection. Registering to sensors 107 // that do not support injection will give an error. TODO(aakella) : Allow exactly one 108 // client to inject sensor data at a time. 109 DATA_INJECTION = 1, 110 // This mode is used only for testing sensors. Each sensor can be tested in isolation with 111 // the required sampling_rate and maxReportLatency parameters without having to think about 112 // the data rates requested by other applications. End user devices are always expected to be 113 // in NORMAL mode. When this mode is first activated, all active sensors from all connections 114 // are disabled. Calling flush() will return an error. In this mode, only the requests from 115 // selected apps whose package names are whitelisted are allowed (typically CTS apps). Only 116 // these apps can register/unregister/call flush() on sensors. If SensorService switches to 117 // NORMAL mode again, all sensors that were previously registered to are activated with the 118 // corresponding paramaters if the application hasn't unregistered for sensors in the mean 119 // time. NOTE: Non whitelisted app whose sensors were previously deactivated may still 120 // receive events if a whitelisted app requests data from the same sensor. 121 RESTRICTED = 2 122 123 // State Transitions supported. 124 // RESTRICTED <--- NORMAL ---> DATA_INJECTION 125 // ---> <--- 126 127 // Shell commands to switch modes in SensorService. 128 // 1) Put SensorService in RESTRICTED mode with packageName .cts. If it is already in 129 // restricted mode it is treated as a NO_OP (and packageName is NOT changed). 130 // 131 // $ adb shell dumpsys sensorservice restrict .cts. 132 // 133 // 2) Put SensorService in DATA_INJECTION mode with packageName .xts. If it is already in 134 // data_injection mode it is treated as a NO_OP (and packageName is NOT changed). 135 // 136 // $ adb shell dumpsys sensorservice data_injection .xts. 137 // 138 // 3) Reset sensorservice back to NORMAL mode. 139 // $ adb shell dumpsys sensorservice enable 140 }; 141 142 static const char* WAKE_LOCK_NAME; getServiceName()143 static char const* getServiceName() ANDROID_API { return "sensorservice"; } 144 SensorService() ANDROID_API; 145 virtual ~SensorService(); 146 147 virtual void onFirstRef(); 148 149 // Thread interface 150 virtual bool threadLoop(); 151 152 // ISensorServer interface 153 virtual Vector<Sensor> getSensorList(const String16& opPackageName); 154 virtual Vector<Sensor> getDynamicSensorList(const String16& opPackageName); 155 virtual sp<ISensorEventConnection> createSensorEventConnection( 156 const String8& packageName, 157 int requestedMode, const String16& opPackageName); 158 virtual int isDataInjectionEnabled(); 159 virtual sp<ISensorEventConnection> createSensorDirectConnection(const String16& opPackageName, 160 uint32_t size, int32_t type, int32_t format, const native_handle *resource); 161 virtual int setOperationParameter( 162 int32_t handle, int32_t type, const Vector<float> &floats, const Vector<int32_t> &ints); 163 virtual status_t dump(int fd, const Vector<String16>& args); 164 165 String8 getSensorName(int handle) const; 166 bool isVirtualSensor(int handle) const; 167 sp<SensorInterface> getSensorInterfaceFromHandle(int handle) const; 168 bool isWakeUpSensor(int type) const; 169 void recordLastValueLocked(sensors_event_t const* buffer, size_t count); 170 static void sortEventBuffer(sensors_event_t* buffer, size_t count); 171 const Sensor& registerSensor(SensorInterface* sensor, 172 bool isDebug = false, bool isVirtual = false); 173 const Sensor& registerVirtualSensor(SensorInterface* sensor, bool isDebug = false); 174 const Sensor& registerDynamicSensorLocked(SensorInterface* sensor, bool isDebug = false); 175 bool unregisterDynamicSensorLocked(int handle); 176 status_t cleanupWithoutDisable(const sp<SensorEventConnection>& connection, int handle); 177 status_t cleanupWithoutDisableLocked(const sp<SensorEventConnection>& connection, int handle); 178 void cleanupAutoDisabledSensorLocked(const sp<SensorEventConnection>& connection, 179 sensors_event_t const* buffer, const int count); 180 static bool canAccessSensor(const Sensor& sensor, const char* operation, 181 const String16& opPackageName); 182 // SensorService acquires a partial wakelock for delivering events from wake up sensors. This 183 // method checks whether all the events from these wake up sensors have been delivered to the 184 // corresponding applications, if yes the wakelock is released. 185 void checkWakeLockState(); 186 void checkWakeLockStateLocked(); 187 bool isWakeLockAcquired(); 188 bool isWakeUpSensorEvent(const sensors_event_t& event) const; 189 190 sp<Looper> getLooper() const; 191 192 // Reset mWakeLockRefCounts for all SensorEventConnections to zero. This may happen if 193 // SensorService did not receive any acknowledgements from apps which have registered for 194 // wake_up sensors. 195 void resetAllWakeLockRefCounts(); 196 197 // Acquire or release wake_lock. If wake_lock is acquired, set the timeout in the looper to 5 198 // seconds and wake the looper. 199 void setWakeLockAcquiredLocked(bool acquire); 200 201 // Send events from the event cache for this particular connection. 202 void sendEventsFromCache(const sp<SensorEventConnection>& connection); 203 204 // Promote all weak referecences in mActiveConnections vector to strong references and add them 205 // to the output vector. 206 void populateActiveConnections( SortedVector< sp<SensorEventConnection> >* activeConnections); 207 208 // If SensorService is operating in RESTRICTED mode, only select whitelisted packages are 209 // allowed to register for or call flush on sensors. Typically only cts test packages are 210 // allowed. 211 bool isWhiteListedPackage(const String8& packageName); 212 bool isOperationRestricted(const String16& opPackageName); 213 214 // Reset the state of SensorService to NORMAL mode. 215 status_t resetToNormalMode(); 216 status_t resetToNormalModeLocked(); 217 218 // Transforms the UUIDs for all the sensors into proper IDs. 219 void makeUuidsIntoIdsForSensorList(Vector<Sensor> &sensorList) const; 220 // Gets the appropriate ID from the given UUID. 221 int32_t getIdFromUuid(const Sensor::uuid_t &uuid) const; 222 // Either read from storage or create a new one. 223 static bool initializeHmacKey(); 224 225 // Enable SCHED_FIFO priority for thread 226 void enableSchedFifoMode(); 227 228 static uint8_t sHmacGlobalKey[128]; 229 static bool sHmacGlobalKeyIsValid; 230 231 SensorList mSensors; 232 status_t mInitCheck; 233 234 // Socket buffersize used to initialize BitTube. This size depends on whether batching is 235 // supported or not. 236 uint32_t mSocketBufferSize; 237 sp<Looper> mLooper; 238 sp<SensorEventAckReceiver> mAckReceiver; 239 240 // protected by mLock 241 mutable Mutex mLock; 242 DefaultKeyedVector<int, SensorRecord*> mActiveSensors; 243 std::unordered_set<int> mActiveVirtualSensors; 244 SortedVector< wp<SensorEventConnection> > mActiveConnections; 245 bool mWakeLockAcquired; 246 sensors_event_t *mSensorEventBuffer, *mSensorEventScratch; 247 wp<const SensorEventConnection> * mMapFlushEventsToConnections; 248 std::unordered_map<int, RecentEventLogger*> mRecentEvent; 249 SortedVector< wp<SensorDirectConnection> > mDirectConnections; 250 Mode mCurrentOperatingMode; 251 252 // This packagaName is set when SensorService is in RESTRICTED or DATA_INJECTION mode. Only 253 // applications with this packageName are allowed to activate/deactivate or call flush on 254 // sensors. To run CTS this is can be set to ".cts." and only CTS tests will get access to 255 // sensors. 256 String8 mWhiteListedPackage; 257 258 int mNextSensorRegIndex; 259 Vector<SensorRegistrationInfo> mLastNSensorRegistrations; 260 }; 261 262 } // namespace android 263 #endif // ANDROID_SENSOR_SERVICE_H 264