services/sensorservice/SensorService.h

   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 <gui/ISensorServer.h>
  26 #include <gui/ISensorEventConnection.h>
  27 #include <gui/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
  71 public:
  72     void cleanupConnection(SensorEventConnection* connection);
  73
  74     status_t enable(const sp<SensorEventConnection>& connection, int handle,
  75                     nsecs_t samplingPeriodNs,  nsecs_t maxBatchReportLatencyNs, int reservedFlags,
  76                     const String16& opPackageName);
  77
  78     status_t disable(const sp<SensorEventConnection>& connection, int handle);
  79
  80     status_t setEventRate(const sp<SensorEventConnection>& connection, int handle, nsecs_t ns,
  81                           const String16& opPackageName);
  82
  83     status_t flushSensor(const sp<SensorEventConnection>& connection,
  84                          const String16& opPackageName);
  85
  86 private:
  87     friend class BinderService<SensorService>;
  88
  89     // nested class/struct for internal use
  90     class SensorRecord;
  91     class SensorEventAckReceiver;
  92     struct SensorRegistrationInfo;
  93
  94     enum Mode {
  95        // The regular operating mode where any application can register/unregister/call flush on
  96        // sensors.
  97        NORMAL = 0,
  98        // This mode is only used for testing purposes. Not all HALs support this mode. In this mode,
  99        // the HAL ignores the sensor data provided by physical sensors and accepts the data that is
 100        // injected from the SensorService as if it were the real sensor data. This mode is primarily
 101        // used for testing various algorithms like vendor provided SensorFusion, Step Counter and
 102        // Step Detector etc. Typically in this mode, there will be a client (a
 103        // SensorEventConnection) which will be injecting sensor data into the HAL. Normal apps can
 104        // unregister and register for any sensor that supports injection. Registering to sensors
 105        // that do not support injection will give an error.  TODO(aakella) : Allow exactly one
 106        // client to inject sensor data at a time.
 107        DATA_INJECTION = 1,
 108        // This mode is used only for testing sensors. Each sensor can be tested in isolation with
 109        // the required sampling_rate and maxReportLatency parameters without having to think about
 110        // the data rates requested by other applications. End user devices are always expected to be
 111        // in NORMAL mode. When this mode is first activated, all active sensors from all connections
 112        // are disabled. Calling flush() will return an error. In this mode, only the requests from
 113        // selected apps whose package names are whitelisted are allowed (typically CTS apps).  Only
 114        // these apps can register/unregister/call flush() on sensors. If SensorService switches to
 115        // NORMAL mode again, all sensors that were previously registered to are activated with the
 116        // corresponding paramaters if the application hasn't unregistered for sensors in the mean
 117        // time.  NOTE: Non whitelisted app whose sensors were previously deactivated may still
 118        // receive events if a whitelisted app requests data from the same sensor.
 119        RESTRICTED = 2
 120
 121       // State Transitions supported.
 122       //     RESTRICTED   <---  NORMAL   ---> DATA_INJECTION
 123       //                  --->           <---
 124
 125       // Shell commands to switch modes in SensorService.
 126       // 1) Put SensorService in RESTRICTED mode with packageName .cts. If it is already in
 127       // restricted mode it is treated as a NO_OP (and packageName is NOT changed).
 128       //
 129       //     $ adb shell dumpsys sensorservice restrict .cts.
 130       //
 131       // 2) Put SensorService in DATA_INJECTION mode with packageName .xts. If it is already in
 132       // data_injection mode it is treated as a NO_OP (and packageName is NOT changed).
 133       //
 134       //     $ adb shell dumpsys sensorservice data_injection .xts.
 135       //
 136       // 3) Reset sensorservice back to NORMAL mode.
 137       //     $ adb shell dumpsys sensorservice enable
 138     };
 139
 140     static const char* WAKE_LOCK_NAME;
 141     static char const* getServiceName() ANDROID_API { return "sensorservice"; }
 142     SensorService() ANDROID_API;
 143     virtual ~SensorService();
 144
 145     virtual void onFirstRef();
 146
 147     // Thread interface
 148     virtual bool threadLoop();
 149
 150     // ISensorServer interface
 151     virtual Vector<Sensor> getSensorList(const String16& opPackageName);
 152     virtual Vector<Sensor> getDynamicSensorList(const String16& opPackageName);
 153     virtual sp<ISensorEventConnection> createSensorEventConnection(
 154             const String8& packageName,
 155             int requestedMode, const String16& opPackageName);
 156     virtual int isDataInjectionEnabled();
 157     virtual status_t dump(int fd, const Vector<String16>& args);
 158
 159     String8 getSensorName(int handle) const;
 160     bool isVirtualSensor(int handle) const;
 161     sp<SensorInterface> getSensorInterfaceFromHandle(int handle) const;
 162     bool isWakeUpSensor(int type) const;
 163     void recordLastValueLocked(sensors_event_t const* buffer, size_t count);
 164     static void sortEventBuffer(sensors_event_t* buffer, size_t count);
 165     const Sensor& registerSensor(SensorInterface* sensor,
 166                                  bool isDebug = false, bool isVirtual = false);
 167     const Sensor& registerVirtualSensor(SensorInterface* sensor, bool isDebug = false);
 168     const Sensor& registerDynamicSensorLocked(SensorInterface* sensor, bool isDebug = false);
 169     bool unregisterDynamicSensorLocked(int handle);
 170     status_t cleanupWithoutDisable(const sp<SensorEventConnection>& connection, int handle);
 171     status_t cleanupWithoutDisableLocked(const sp<SensorEventConnection>& connection, int handle);
 172     void cleanupAutoDisabledSensorLocked(const sp<SensorEventConnection>& connection,
 173             sensors_event_t const* buffer, const int count);
 174     static bool canAccessSensor(const Sensor& sensor, const char* operation,
 175             const String16& opPackageName);
 176     // SensorService acquires a partial wakelock for delivering events from wake up sensors. This
 177     // method checks whether all the events from these wake up sensors have been delivered to the
 178     // corresponding applications, if yes the wakelock is released.
 179     void checkWakeLockState();
 180     void checkWakeLockStateLocked();
 181     bool isWakeLockAcquired();
 182     bool isWakeUpSensorEvent(const sensors_event_t& event) const;
 183
 184     sp<Looper> getLooper() const;
 185
 186     // Reset mWakeLockRefCounts for all SensorEventConnections to zero. This may happen if
 187     // SensorService did not receive any acknowledgements from apps which have registered for
 188     // wake_up sensors.
 189     void resetAllWakeLockRefCounts();
 190
 191     // Acquire or release wake_lock. If wake_lock is acquired, set the timeout in the looper to 5
 192     // seconds and wake the looper.
 193     void setWakeLockAcquiredLocked(bool acquire);
 194
 195     // Send events from the event cache for this particular connection.
 196     void sendEventsFromCache(const sp<SensorEventConnection>& connection);
 197
 198     // Promote all weak referecences in mActiveConnections vector to strong references and add them
 199     // to the output vector.
 200     void populateActiveConnections( SortedVector< sp<SensorEventConnection> >* activeConnections);
 201
 202     // If SensorService is operating in RESTRICTED mode, only select whitelisted packages are
 203     // allowed to register for or call flush on sensors. Typically only cts test packages are
 204     // allowed.
 205     bool isWhiteListedPackage(const String8& packageName);
 206
 207     // Reset the state of SensorService to NORMAL mode.
 208     status_t resetToNormalMode();
 209     status_t resetToNormalModeLocked();
 210
 211     // Transforms the UUIDs for all the sensors into proper IDs.
 212     void makeUuidsIntoIdsForSensorList(Vector<Sensor> &sensorList) const;
 213     // Gets the appropriate ID from the given UUID.
 214     int32_t getIdFromUuid(const Sensor::uuid_t &uuid) const;
 215     // Either read from storage or create a new one.
 216     static bool initializeHmacKey();
 217
 218     // Enable SCHED_FIFO priority for thread
 219     void enableSchedFifoMode();
 220
 221     static uint8_t sHmacGlobalKey[128];
 222     static bool sHmacGlobalKeyIsValid;
 223
 224     SensorList mSensors;
 225     status_t mInitCheck;
 226
 227     // Socket buffersize used to initialize BitTube. This size depends on whether batching is
 228     // supported or not.
 229     uint32_t mSocketBufferSize;
 230     sp<Looper> mLooper;
 231     sp<SensorEventAckReceiver> mAckReceiver;
 232
 233     // protected by mLock
 234     mutable Mutex mLock;
 235     DefaultKeyedVector<int, SensorRecord*> mActiveSensors;
 236     std::unordered_set<int> mActiveVirtualSensors;
 237     SortedVector< wp<SensorEventConnection> > mActiveConnections;
 238     bool mWakeLockAcquired;
 239     sensors_event_t *mSensorEventBuffer, *mSensorEventScratch;
 240     wp<const SensorEventConnection> * mMapFlushEventsToConnections;
 241     std::unordered_map<int, RecentEventLogger*> mRecentEvent;
 242     Mode mCurrentOperatingMode;
 243
 244     // This packagaName is set when SensorService is in RESTRICTED or DATA_INJECTION mode. Only
 245     // applications with this packageName are allowed to activate/deactivate or call flush on
 246     // sensors. To run CTS this is can be set to ".cts." and only CTS tests will get access to
 247     // sensors.
 248     String8 mWhiteListedPackage;
 249
 250     int mNextSensorRegIndex;
 251     Vector<SensorRegistrationInfo> mLastNSensorRegistrations;
 252 };
 253
 254 } // namespace android
 255 #endif // ANDROID_SENSOR_SERVICE_H