SensorService.h revision d4db70a7b8b2d136c46c50f89b276f8150be5fc2
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 56#define CIRCULAR_BUF_SIZE 10 57#define SENSOR_REGISTRATIONS_BUF_SIZE 20 58 59struct sensors_poll_device_t; 60struct sensors_module_t; 61 62namespace android { 63// --------------------------------------------------------------------------- 64 65class SensorService : 66 public BinderService<SensorService>, 67 public BnSensorServer, 68 protected Thread 69{ 70 friend class BinderService<SensorService>; 71 72 enum Mode { 73 // The regular operating mode where any application can register/unregister/call flush on 74 // sensors. 75 NORMAL = 0, 76 // This mode is only used for testing purposes. Not all HALs support this mode. In this 77 // mode, the HAL ignores the sensor data provided by physical sensors and accepts the data 78 // that is injected from the SensorService as if it were the real sensor data. This mode 79 // is primarily used for testing various algorithms like vendor provided SensorFusion, 80 // Step Counter and Step Detector etc. Typically in this mode, there will be a client 81 // (a SensorEventConnection) which will be injecting sensor data into the HAL. Normal apps 82 // can unregister and register for any sensor that supports injection. Registering to sensors 83 // that do not support injection will give an error. 84 // TODO(aakella) : Allow exactly one client to inject sensor data at a time. 85 DATA_INJECTION = 1, 86 // This mode is used only for testing sensors. Each sensor can be tested in isolation with 87 // the required sampling_rate and maxReportLatency parameters without having to think about 88 // the data rates requested by other applications. End user devices are always expected to be 89 // in NORMAL mode. When this mode is first activated, all active sensors from all connections 90 // are disabled. Calling flush() will return an error. In this mode, only the requests from 91 // selected apps whose package names are whitelisted are allowed (typically CTS apps). Only 92 // these apps can register/unregister/call flush() on sensors. If SensorService switches to 93 // NORMAL mode again, all sensors that were previously registered to are activated with the 94 // corresponding paramaters if the application hasn't unregistered for sensors in the mean 95 // time. 96 // NOTE: Non whitelisted app whose sensors were previously deactivated may still receive 97 // events if a whitelisted app requests data from the same sensor. 98 RESTRICTED = 2 99 100 // State Transitions supported. 101 // RESTRICTED <--- NORMAL ---> DATA_INJECTION 102 // ---> <--- 103 104 // Shell commands to switch modes in SensorService. 105 // 1) Put SensorService in RESTRICTED mode with packageName .cts. If it is already in 106 // restricted mode it is treated as a NO_OP (and packageName is NOT changed). 107 // $ adb shell dumpsys sensorservice restrict .cts. 108 // 109 // 2) Put SensorService in DATA_INJECTION mode with packageName .xts. If it is already in 110 // data_injection mode it is treated as a NO_OP (and packageName is NOT changed). 111 // $ adb shell dumpsys sensorservice data_injection .xts. 112 // 113 // 3) Reset sensorservice back to NORMAL mode. 114 // $ adb shell dumpsys sensorservice enable 115 }; 116 117 static const char* WAKE_LOCK_NAME; 118 119 static char const* getServiceName() ANDROID_API { return "sensorservice"; } 120 SensorService() ANDROID_API; 121 virtual ~SensorService(); 122 123 virtual void onFirstRef(); 124 125 // Thread interface 126 virtual bool threadLoop(); 127 128 // ISensorServer interface 129 virtual Vector<Sensor> getSensorList(const String16& opPackageName); 130 virtual sp<ISensorEventConnection> createSensorEventConnection(const String8& packageName, 131 int requestedMode, const String16& opPackageName); 132 virtual int isDataInjectionEnabled(); 133 virtual status_t setSensorPhysicalData(const char* physicaldata); 134 virtual status_t dump(int fd, const Vector<String16>& args); 135 136 class SensorEventConnection : public BnSensorEventConnection, public LooperCallback { 137 friend class SensorService; 138 virtual ~SensorEventConnection(); 139 virtual void onFirstRef(); 140 virtual sp<BitTube> getSensorChannel() const; 141 virtual status_t enableDisable(int handle, bool enabled, nsecs_t samplingPeriodNs, 142 nsecs_t maxBatchReportLatencyNs, int reservedFlags); 143 virtual status_t setEventRate(int handle, nsecs_t samplingPeriodNs); 144 virtual status_t flush(); 145 // Count the number of flush complete events which are about to be dropped in the buffer. 146 // Increment mPendingFlushEventsToSend in mSensorInfo. These flush complete events will be 147 // sent separately before the next batch of events. 148 void countFlushCompleteEventsLocked(sensors_event_t const* scratch, int numEventsDropped); 149 150 // Check if there are any wake up events in the buffer. If yes, return the index of the 151 // first wake_up sensor event in the buffer else return -1. This wake_up sensor event will 152 // have the flag WAKE_UP_SENSOR_EVENT_NEEDS_ACK set. Exactly one event per packet will have 153 // the wake_up flag set. SOCK_SEQPACKET ensures that either the entire packet is read or 154 // dropped. 155 int findWakeUpSensorEventLocked(sensors_event_t const* scratch, int count); 156 157 // Send pending flush_complete events. There may have been flush_complete_events that are 158 // dropped which need to be sent separately before other events. On older HALs (1_0) this 159 // method emulates the behavior of flush(). 160 void sendPendingFlushEventsLocked(); 161 162 // Writes events from mEventCache to the socket. 163 void writeToSocketFromCache(); 164 165 // Compute the approximate cache size from the FIFO sizes of various sensors registered for 166 // this connection. Wake up and non-wake up sensors have separate FIFOs but FIFO may be 167 // shared amongst wake-up sensors and non-wake up sensors. 168 int computeMaxCacheSizeLocked() const; 169 170 // When more sensors register, the maximum cache size desired may change. Compute max cache 171 // size, reallocate memory and copy over events from the older cache. 172 void reAllocateCacheLocked(sensors_event_t const* scratch, int count); 173 174 // LooperCallback method. If there is data to read on this fd, it is an ack from the 175 // app that it has read events from a wake up sensor, decrement mWakeLockRefCount. 176 // If this fd is available for writing send the data from the cache. 177 virtual int handleEvent(int fd, int events, void* data); 178 179 // Increment mPendingFlushEventsToSend for the given sensor handle. 180 void incrementPendingFlushCount(int32_t handle); 181 182 // Add or remove the file descriptor associated with the BitTube to the looper. If mDead is 183 // set to true or there are no more sensors for this connection, the file descriptor is 184 // removed if it has been previously added to the Looper. Depending on the state of the 185 // connection FD may be added to the Looper. The flags to set are determined by the internal 186 // state of the connection. FDs are added to the looper when wake-up sensors are registered 187 // (to poll for acknowledgements) and when write fails on the socket when there are too many 188 // error and the other end hangs up or when this client unregisters for this connection. 189 void updateLooperRegistration(const sp<Looper>& looper); 190 void updateLooperRegistrationLocked(const sp<Looper>& looper); 191 192 sp<SensorService> const mService; 193 sp<BitTube> mChannel; 194 uid_t mUid; 195 mutable Mutex mConnectionLock; 196 // Number of events from wake up sensors which are still pending and haven't been delivered 197 // to the corresponding application. It is incremented by one unit for each write to the 198 // socket. 199 uint32_t mWakeLockRefCount; 200 201 // If this flag is set to true, it means that the file descriptor associated with the 202 // BitTube has been added to the Looper in SensorService. This flag is typically set when 203 // this connection has wake-up sensors associated with it or when write has failed on this 204 // connection and we're storing some events in the cache. 205 bool mHasLooperCallbacks; 206 // If there are any errors associated with the Looper this flag is set to true and 207 // mWakeLockRefCount is reset to zero. needsWakeLock method will always return false, if 208 // this flag is set. 209 bool mDead; 210 211 bool mDataInjectionMode; 212 struct FlushInfo { 213 // The number of flush complete events dropped for this sensor is stored here. 214 // They are sent separately before the next batch of events. 215 int mPendingFlushEventsToSend; 216 // Every activate is preceded by a flush. Only after the first flush complete is 217 // received, the events for the sensor are sent on that *connection*. 218 bool mFirstFlushPending; 219 FlushInfo() : mPendingFlushEventsToSend(0), mFirstFlushPending(false) {} 220 }; 221 // protected by SensorService::mLock. Key for this vector is the sensor handle. 222 KeyedVector<int, FlushInfo> mSensorInfo; 223 sensors_event_t *mEventCache; 224 int mCacheSize, mMaxCacheSize; 225 String8 mPackageName; 226 const String16 mOpPackageName; 227#if DEBUG_CONNECTIONS 228 int mEventsReceived, mEventsSent, mEventsSentFromCache; 229 int mTotalAcksNeeded, mTotalAcksReceived; 230#endif 231 232 public: 233 SensorEventConnection(const sp<SensorService>& service, uid_t uid, String8 packageName, 234 bool isDataInjectionMode, const String16& opPackageName); 235 236 status_t sendEvents(sensors_event_t const* buffer, size_t count, 237 sensors_event_t* scratch, 238 SensorEventConnection const * const * mapFlushEventsToConnections = NULL); 239 bool hasSensor(int32_t handle) const; 240 bool hasAnySensor() const; 241 bool hasOneShotSensors() const; 242 bool addSensor(int32_t handle); 243 bool removeSensor(int32_t handle); 244 void setFirstFlushPending(int32_t handle, bool value); 245 void dump(String8& result); 246 bool needsWakeLock(); 247 void resetWakeLockRefCount(); 248 String8 getPackageName() const; 249 250 uid_t getUid() const { return mUid; } 251 }; 252 253 class SensorRecord { 254 SortedVector< wp<SensorEventConnection> > mConnections; 255 // A queue of all flush() calls made on this sensor. Flush complete events will be 256 // sent in this order. 257 Vector< wp<SensorEventConnection> > mPendingFlushConnections; 258 public: 259 SensorRecord(const sp<SensorEventConnection>& connection); 260 bool addConnection(const sp<SensorEventConnection>& connection); 261 bool removeConnection(const wp<SensorEventConnection>& connection); 262 size_t getNumConnections() const { return mConnections.size(); } 263 264 void addPendingFlushConnection(const sp<SensorEventConnection>& connection); 265 void removeFirstPendingFlushConnection(); 266 SensorEventConnection * getFirstPendingFlushConnection(); 267 void clearAllPendingFlushConnections(); 268 }; 269 270 class SensorEventAckReceiver : public Thread { 271 sp<SensorService> const mService; 272 public: 273 virtual bool threadLoop(); 274 SensorEventAckReceiver(const sp<SensorService>& service): mService(service) {} 275 }; 276 277 // sensor_event_t with only the data and the timestamp. 278 struct TrimmedSensorEvent { 279 union { 280 float *mData; 281 uint64_t mStepCounter; 282 }; 283 // Timestamp from the sensor_event. 284 int64_t mTimestamp; 285 // HH:MM:SS local time at which this sensor event is read at SensorService. Useful 286 // for debugging. 287 int32_t mHour, mMin, mSec; 288 289 TrimmedSensorEvent(int sensorType); 290 static bool isSentinel(const TrimmedSensorEvent& event); 291 292 ~TrimmedSensorEvent() { 293 delete [] mData; 294 } 295 }; 296 297 // A circular buffer of TrimmedSensorEvents. The size of this buffer is typically 10. The 298 // last N events generated from the sensor are stored in this buffer. The buffer is NOT 299 // cleared when the sensor unregisters and as a result one may see very old data in the 300 // dumpsys output but this is WAI. 301 class CircularBuffer { 302 int mNextInd; 303 int mSensorType; 304 int mBufSize; 305 TrimmedSensorEvent ** mTrimmedSensorEventArr; 306 public: 307 CircularBuffer(int sensor_event_type); 308 void addEvent(const sensors_event_t& sensor_event); 309 void printBuffer(String8& buffer) const; 310 bool populateLastEvent(sensors_event_t *event); 311 ~CircularBuffer(); 312 }; 313 314 struct SensorRegistrationInfo { 315 int32_t mSensorHandle; 316 String8 mPackageName; 317 bool mActivated; 318 int32_t mSamplingRateUs; 319 int32_t mMaxReportLatencyUs; 320 int32_t mHour, mMin, mSec; 321 322 SensorRegistrationInfo() : mPackageName() { 323 mSensorHandle = mSamplingRateUs = mMaxReportLatencyUs = INT32_MIN; 324 mHour = mMin = mSec = INT32_MIN; 325 mActivated = false; 326 } 327 328 static bool isSentinel(const SensorRegistrationInfo& info) { 329 return (info.mHour == INT32_MIN && info.mMin == INT32_MIN && info.mSec == INT32_MIN); 330 } 331 }; 332 333 static int getNumEventsForSensorType(int sensor_event_type); 334 String8 getSensorName(int handle) const; 335 bool isVirtualSensor(int handle) const; 336 Sensor getSensorFromHandle(int handle) const; 337 bool isWakeUpSensor(int type) const; 338 void recordLastValueLocked(sensors_event_t const* buffer, size_t count); 339 static void sortEventBuffer(sensors_event_t* buffer, size_t count); 340 Sensor registerSensor(SensorInterface* sensor); 341 Sensor registerVirtualSensor(SensorInterface* sensor); 342 status_t cleanupWithoutDisable( 343 const sp<SensorEventConnection>& connection, int handle); 344 status_t cleanupWithoutDisableLocked( 345 const sp<SensorEventConnection>& connection, int handle); 346 void cleanupAutoDisabledSensorLocked(const sp<SensorEventConnection>& connection, 347 sensors_event_t const* buffer, const int count); 348 static bool canAccessSensor(const Sensor& sensor, const char* operation, 349 const String16& opPackageName); 350 // SensorService acquires a partial wakelock for delivering events from wake up sensors. This 351 // method checks whether all the events from these wake up sensors have been delivered to the 352 // corresponding applications, if yes the wakelock is released. 353 void checkWakeLockState(); 354 void checkWakeLockStateLocked(); 355 bool isWakeLockAcquired(); 356 bool isWakeUpSensorEvent(const sensors_event_t& event) const; 357 358 SensorRecord * getSensorRecord(int handle); 359 360 sp<Looper> getLooper() const; 361 362 // Reset mWakeLockRefCounts for all SensorEventConnections to zero. This may happen if 363 // SensorService did not receive any acknowledgements from apps which have registered for 364 // wake_up sensors. 365 void resetAllWakeLockRefCounts(); 366 367 // Acquire or release wake_lock. If wake_lock is acquired, set the timeout in the looper to 368 // 5 seconds and wake the looper. 369 void setWakeLockAcquiredLocked(bool acquire); 370 371 // Send events from the event cache for this particular connection. 372 void sendEventsFromCache(const sp<SensorEventConnection>& connection); 373 374 // Promote all weak referecences in mActiveConnections vector to strong references and add them 375 // to the output vector. 376 void populateActiveConnections(SortedVector< sp<SensorEventConnection> >* activeConnections); 377 378 // If SensorService is operating in RESTRICTED mode, only select whitelisted packages are 379 // allowed to register for or call flush on sensors. Typically only cts test packages are 380 // allowed. 381 bool isWhiteListedPackage(const String8& packageName); 382 383 // Reset the state of SensorService to NORMAL mode. 384 status_t resetToNormalMode(); 385 status_t resetToNormalModeLocked(); 386 387 // constants 388 Vector<Sensor> mSensorList; 389 Vector<Sensor> mUserSensorListDebug; 390 Vector<Sensor> mUserSensorList; 391 DefaultKeyedVector<int, SensorInterface*> mSensorMap; 392 Vector<SensorInterface *> mVirtualSensorList; 393 status_t mInitCheck; 394 // Socket buffersize used to initialize BitTube. This size depends on whether batching is 395 // supported or not. 396 uint32_t mSocketBufferSize; 397 sp<Looper> mLooper; 398 sp<SensorEventAckReceiver> mAckReceiver; 399 400 // protected by mLock 401 mutable Mutex mLock; 402 DefaultKeyedVector<int, SensorRecord*> mActiveSensors; 403 DefaultKeyedVector<int, SensorInterface*> mActiveVirtualSensors; 404 SortedVector< wp<SensorEventConnection> > mActiveConnections; 405 bool mWakeLockAcquired; 406 sensors_event_t *mSensorEventBuffer, *mSensorEventScratch; 407 SensorEventConnection const **mMapFlushEventsToConnections; 408 Mode mCurrentOperatingMode; 409 // This packagaName is set when SensorService is in RESTRICTED or DATA_INJECTION mode. Only 410 // applications with this packageName are allowed to activate/deactivate or call flush on 411 // sensors. To run CTS this is can be set to ".cts." and only CTS tests will get access to 412 // sensors. 413 String8 mWhiteListedPackage; 414 415 // The size of this vector is constant, only the items are mutable 416 KeyedVector<int32_t, CircularBuffer *> mLastEventSeen; 417 418 int mNextSensorRegIndex; 419 Vector<SensorRegistrationInfo> mLastNSensorRegistrations; 420public: 421 void cleanupConnection(SensorEventConnection* connection); 422 status_t enable(const sp<SensorEventConnection>& connection, int handle, 423 nsecs_t samplingPeriodNs, nsecs_t maxBatchReportLatencyNs, int reservedFlags, 424 const String16& opPackageName); 425 status_t disable(const sp<SensorEventConnection>& connection, int handle); 426 status_t setEventRate(const sp<SensorEventConnection>& connection, int handle, nsecs_t ns, 427 const String16& opPackageName); 428 status_t flushSensor(const sp<SensorEventConnection>& connection, 429 const String16& opPackageName); 430}; 431 432// --------------------------------------------------------------------------- 433}; // namespace android 434 435#endif // ANDROID_SENSOR_SERVICE_H 436