SensorService.h revision a9e6cc387072e25706a6d847a97b02a6f25a918b
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 <stdint.h> 21#include <sys/types.h> 22 23#include <utils/Vector.h> 24#include <utils/SortedVector.h> 25#include <utils/KeyedVector.h> 26#include <utils/threads.h> 27#include <utils/AndroidThreads.h> 28#include <utils/RefBase.h> 29#include <utils/Looper.h> 30#include <utils/String8.h> 31 32#include <binder/BinderService.h> 33 34#include <gui/Sensor.h> 35#include <gui/BitTube.h> 36#include <gui/ISensorServer.h> 37#include <gui/ISensorEventConnection.h> 38 39#include "SensorInterface.h" 40 41#if __clang__ 42// Clang warns about SensorEventConnection::dump hiding BBinder::dump 43// The cause isn't fixable without changing the API, so let's tell clang 44// this is indeed intentional. 45#pragma clang diagnostic ignored "-Woverloaded-virtual" 46#endif 47 48// --------------------------------------------------------------------------- 49 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 56struct sensors_poll_device_t; 57struct sensors_module_t; 58 59namespace android { 60// --------------------------------------------------------------------------- 61 62class SensorService : 63 public BinderService<SensorService>, 64 public BnSensorServer, 65 protected Thread 66{ 67 friend class BinderService<SensorService>; 68 69 enum Mode { 70 // The regular operating mode where any application can register/unregister/call flush on 71 // sensors. 72 NORMAL = 0, 73 // This mode is only used for testing purposes. Not all HALs support this mode. In this 74 // mode, the HAL ignores the sensor data provided by physical sensors and accepts the data 75 // that is injected from the SensorService as if it were the real sensor data. This mode 76 // is primarily used for testing various algorithms like vendor provided SensorFusion, 77 // Step Counter and Step Detector etc. Typically in this mode, there will be a client 78 // (a SensorEventConnection) which will be injecting sensor data into the HAL. Normal apps 79 // can unregister and register for any sensor that supports injection. Registering to sensors 80 // that do not support injection will give an error. 81 // TODO(aakella) : Allow exactly one client to inject sensor data at a time. 82 DATA_INJECTION = 1, 83 // This mode is used only for testing sensors. Each sensor can be tested in isolation with 84 // the required sampling_rate and maxReportLatency parameters without having to think about 85 // the data rates requested by other applications. End user devices are always expected to be 86 // in NORMAL mode. When this mode is first activated, all active sensors from all connections 87 // are disabled. Calling flush() will return an error. In this mode, only the requests from 88 // selected apps whose package names are whitelisted are allowed (typically CTS apps). Only 89 // these apps can register/unregister/call flush() on sensors. If SensorService switches to 90 // NORMAL mode again, all sensors that were previously registered to are activated with the 91 // corresponding paramaters if the application hasn't unregistered for sensors in the mean 92 // time. 93 // NOTE: Non whitelisted app whose sensors were previously deactivated may still receive 94 // events if a whitelisted app requests data from the same sensor. 95 RESTRICTED = 2 96 97 // State Transitions supported. 98 // RESTRICTED <--- NORMAL ---> DATA_INJECTION 99 // ---> <--- 100 }; 101 102 static const char* WAKE_LOCK_NAME; 103 104 static char const* getServiceName() ANDROID_API { return "sensorservice"; } 105 SensorService() ANDROID_API; 106 virtual ~SensorService(); 107 108 virtual void onFirstRef(); 109 110 // Thread interface 111 virtual bool threadLoop(); 112 113 // ISensorServer interface 114 virtual Vector<Sensor> getSensorList(); 115 virtual sp<ISensorEventConnection> createSensorEventConnection(const String8& packageName, 116 int requestedMode); 117 virtual status_t enableDataInjection(int enable); 118 virtual status_t dump(int fd, const Vector<String16>& args); 119 120 class SensorEventConnection : public BnSensorEventConnection, public LooperCallback { 121 friend class SensorService; 122 virtual ~SensorEventConnection(); 123 virtual void onFirstRef(); 124 virtual sp<BitTube> getSensorChannel() const; 125 virtual status_t enableDisable(int handle, bool enabled, nsecs_t samplingPeriodNs, 126 nsecs_t maxBatchReportLatencyNs, int reservedFlags); 127 virtual status_t setEventRate(int handle, nsecs_t samplingPeriodNs); 128 virtual status_t flush(); 129 // Count the number of flush complete events which are about to be dropped in the buffer. 130 // Increment mPendingFlushEventsToSend in mSensorInfo. These flush complete events will be 131 // sent separately before the next batch of events. 132 void countFlushCompleteEventsLocked(sensors_event_t const* scratch, int numEventsDropped); 133 134 // Check if there are any wake up events in the buffer. If yes, return the index of the 135 // first wake_up sensor event in the buffer else return -1. This wake_up sensor event will 136 // have the flag WAKE_UP_SENSOR_EVENT_NEEDS_ACK set. Exactly one event per packet will have 137 // the wake_up flag set. SOCK_SEQPACKET ensures that either the entire packet is read or 138 // dropped. 139 int findWakeUpSensorEventLocked(sensors_event_t const* scratch, int count); 140 141 // Send pending flush_complete events. There may have been flush_complete_events that are 142 // dropped which need to be sent separately before other events. On older HALs (1_0) this 143 // method emulates the behavior of flush(). 144 void sendPendingFlushEventsLocked(); 145 146 // Writes events from mEventCache to the socket. 147 void writeToSocketFromCache(); 148 149 // Compute the approximate cache size from the FIFO sizes of various sensors registered for 150 // this connection. Wake up and non-wake up sensors have separate FIFOs but FIFO may be 151 // shared amongst wake-up sensors and non-wake up sensors. 152 int computeMaxCacheSizeLocked() const; 153 154 // When more sensors register, the maximum cache size desired may change. Compute max cache 155 // size, reallocate memory and copy over events from the older cache. 156 void reAllocateCacheLocked(sensors_event_t const* scratch, int count); 157 158 // LooperCallback method. If there is data to read on this fd, it is an ack from the 159 // app that it has read events from a wake up sensor, decrement mWakeLockRefCount. 160 // If this fd is available for writing send the data from the cache. 161 virtual int handleEvent(int fd, int events, void* data); 162 163 // Increment mPendingFlushEventsToSend for the given sensor handle. 164 void incrementPendingFlushCount(int32_t handle); 165 166 // Add or remove the file descriptor associated with the BitTube to the looper. If mDead is 167 // set to true or there are no more sensors for this connection, the file descriptor is 168 // removed if it has been previously added to the Looper. Depending on the state of the 169 // connection FD may be added to the Looper. The flags to set are determined by the internal 170 // state of the connection. FDs are added to the looper when wake-up sensors are registered 171 // (to poll for acknowledgements) and when write fails on the socket when there are too many 172 // error and the other end hangs up or when this client unregisters for this connection. 173 void updateLooperRegistration(const sp<Looper>& looper); 174 void updateLooperRegistrationLocked(const sp<Looper>& looper); 175 176 sp<SensorService> const mService; 177 sp<BitTube> mChannel; 178 uid_t mUid; 179 mutable Mutex mConnectionLock; 180 // Number of events from wake up sensors which are still pending and haven't been delivered 181 // to the corresponding application. It is incremented by one unit for each write to the 182 // socket. 183 uint32_t mWakeLockRefCount; 184 185 // If this flag is set to true, it means that the file descriptor associated with the 186 // BitTube has been added to the Looper in SensorService. This flag is typically set when 187 // this connection has wake-up sensors associated with it or when write has failed on this 188 // connection and we're storing some events in the cache. 189 bool mHasLooperCallbacks; 190 // If there are any errors associated with the Looper this flag is set to true and 191 // mWakeLockRefCount is reset to zero. needsWakeLock method will always return false, if 192 // this flag is set. 193 bool mDead; 194 195 bool mDataInjectionMode; 196 struct FlushInfo { 197 // The number of flush complete events dropped for this sensor is stored here. 198 // They are sent separately before the next batch of events. 199 int mPendingFlushEventsToSend; 200 // Every activate is preceded by a flush. Only after the first flush complete is 201 // received, the events for the sensor are sent on that *connection*. 202 bool mFirstFlushPending; 203 FlushInfo() : mPendingFlushEventsToSend(0), mFirstFlushPending(false) {} 204 }; 205 // protected by SensorService::mLock. Key for this vector is the sensor handle. 206 KeyedVector<int, FlushInfo> mSensorInfo; 207 sensors_event_t *mEventCache; 208 int mCacheSize, mMaxCacheSize; 209 String8 mPackageName; 210#if DEBUG_CONNECTIONS 211 int mEventsReceived, mEventsSent, mEventsSentFromCache; 212 int mTotalAcksNeeded, mTotalAcksReceived; 213#endif 214 215 public: 216 SensorEventConnection(const sp<SensorService>& service, uid_t uid, String8 packageName, 217 bool isDataInjectionMode); 218 219 status_t sendEvents(sensors_event_t const* buffer, size_t count, 220 sensors_event_t* scratch, 221 SensorEventConnection const * const * mapFlushEventsToConnections = NULL); 222 bool hasSensor(int32_t handle) const; 223 bool hasAnySensor() const; 224 bool hasOneShotSensors() const; 225 bool addSensor(int32_t handle); 226 bool removeSensor(int32_t handle); 227 void setFirstFlushPending(int32_t handle, bool value); 228 void dump(String8& result); 229 bool needsWakeLock(); 230 void resetWakeLockRefCount(); 231 String8 getPackageName() const; 232 233 uid_t getUid() const { return mUid; } 234 }; 235 236 class SensorRecord { 237 SortedVector< wp<SensorEventConnection> > mConnections; 238 // A queue of all flush() calls made on this sensor. Flush complete events will be 239 // sent in this order. 240 Vector< wp<SensorEventConnection> > mPendingFlushConnections; 241 public: 242 SensorRecord(const sp<SensorEventConnection>& connection); 243 bool addConnection(const sp<SensorEventConnection>& connection); 244 bool removeConnection(const wp<SensorEventConnection>& connection); 245 size_t getNumConnections() const { return mConnections.size(); } 246 247 void addPendingFlushConnection(const sp<SensorEventConnection>& connection); 248 void removeFirstPendingFlushConnection(); 249 SensorEventConnection * getFirstPendingFlushConnection(); 250 void clearAllPendingFlushConnections(); 251 }; 252 253 class SensorEventAckReceiver : public Thread { 254 sp<SensorService> const mService; 255 public: 256 virtual bool threadLoop(); 257 SensorEventAckReceiver(const sp<SensorService>& service): mService(service) {} 258 }; 259 260 String8 getSensorName(int handle) const; 261 bool isVirtualSensor(int handle) const; 262 Sensor getSensorFromHandle(int handle) const; 263 bool isWakeUpSensor(int type) const; 264 void recordLastValueLocked(sensors_event_t const* buffer, size_t count); 265 static void sortEventBuffer(sensors_event_t* buffer, size_t count); 266 Sensor registerSensor(SensorInterface* sensor); 267 Sensor registerVirtualSensor(SensorInterface* sensor); 268 status_t cleanupWithoutDisable( 269 const sp<SensorEventConnection>& connection, int handle); 270 status_t cleanupWithoutDisableLocked( 271 const sp<SensorEventConnection>& connection, int handle); 272 void cleanupAutoDisabledSensorLocked(const sp<SensorEventConnection>& connection, 273 sensors_event_t const* buffer, const int count); 274 static bool canAccessSensor(const Sensor& sensor); 275 static bool verifyCanAccessSensor(const Sensor& sensor, const char* operation); 276 static bool hasDataInjectionPermissions(); 277 // SensorService acquires a partial wakelock for delivering events from wake up sensors. This 278 // method checks whether all the events from these wake up sensors have been delivered to the 279 // corresponding applications, if yes the wakelock is released. 280 void checkWakeLockState(); 281 void checkWakeLockStateLocked(); 282 bool isWakeLockAcquired(); 283 bool isWakeUpSensorEvent(const sensors_event_t& event) const; 284 285 SensorRecord * getSensorRecord(int handle); 286 287 sp<Looper> getLooper() const; 288 289 // Reset mWakeLockRefCounts for all SensorEventConnections to zero. This may happen if 290 // SensorService did not receive any acknowledgements from apps which have registered for 291 // wake_up sensors. 292 void resetAllWakeLockRefCounts(); 293 294 // Acquire or release wake_lock. If wake_lock is acquired, set the timeout in the looper to 295 // 5 seconds and wake the looper. 296 void setWakeLockAcquiredLocked(bool acquire); 297 298 // Send events from the event cache for this particular connection. 299 void sendEventsFromCache(const sp<SensorEventConnection>& connection); 300 301 // Promote all weak referecences in mActiveConnections vector to strong references and add them 302 // to the output vector. 303 void populateActiveConnections(SortedVector< sp<SensorEventConnection> >* activeConnections); 304 305 // If SensorService is operating in RESTRICTED mode, only select whitelisted packages are 306 // allowed to register for or call flush on sensors. Typically only cts test packages are 307 // allowed. 308 bool isWhiteListedPackage(const String8& packageName); 309 310 // Reset the state of SensorService to NORMAL mode. 311 status_t resetToNormalMode(); 312 status_t resetToNormalModeLocked(); 313 314 // constants 315 Vector<Sensor> mSensorList; 316 Vector<Sensor> mUserSensorListDebug; 317 Vector<Sensor> mUserSensorList; 318 DefaultKeyedVector<int, SensorInterface*> mSensorMap; 319 Vector<SensorInterface *> mVirtualSensorList; 320 status_t mInitCheck; 321 // Socket buffersize used to initialize BitTube. This size depends on whether batching is 322 // supported or not. 323 uint32_t mSocketBufferSize; 324 sp<Looper> mLooper; 325 sp<SensorEventAckReceiver> mAckReceiver; 326 327 // protected by mLock 328 mutable Mutex mLock; 329 DefaultKeyedVector<int, SensorRecord*> mActiveSensors; 330 DefaultKeyedVector<int, SensorInterface*> mActiveVirtualSensors; 331 SortedVector< wp<SensorEventConnection> > mActiveConnections; 332 bool mWakeLockAcquired; 333 sensors_event_t *mSensorEventBuffer, *mSensorEventScratch; 334 SensorEventConnection const **mMapFlushEventsToConnections; 335 Mode mCurrentOperatingMode; 336 337 // The size of this vector is constant, only the items are mutable 338 KeyedVector<int32_t, sensors_event_t> mLastEventSeen; 339 340public: 341 void cleanupConnection(SensorEventConnection* connection); 342 status_t enable(const sp<SensorEventConnection>& connection, int handle, 343 nsecs_t samplingPeriodNs, nsecs_t maxBatchReportLatencyNs, int reservedFlags); 344 status_t disable(const sp<SensorEventConnection>& connection, int handle); 345 status_t setEventRate(const sp<SensorEventConnection>& connection, int handle, nsecs_t ns); 346 status_t flushSensor(const sp<SensorEventConnection>& connection); 347}; 348 349// --------------------------------------------------------------------------- 350}; // namespace android 351 352#endif // ANDROID_SENSOR_SERVICE_H 353