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_EVENT_CONNECTION_H 18 #define ANDROID_SENSOR_EVENT_CONNECTION_H 19 20 #include <atomic> 21 #include <stdint.h> 22 #include <sys/types.h> 23 #include <unordered_map> 24 25 #include <utils/Vector.h> 26 #include <utils/SortedVector.h> 27 #include <utils/threads.h> 28 #include <utils/AndroidThreads.h> 29 #include <utils/RefBase.h> 30 #include <utils/Looper.h> 31 #include <utils/String8.h> 32 33 #include <binder/BinderService.h> 34 35 #include <sensor/Sensor.h> 36 #include <sensor/BitTube.h> 37 #include <sensor/ISensorServer.h> 38 #include <sensor/ISensorEventConnection.h> 39 40 #include "SensorService.h" 41 42 namespace android { 43 44 class SensorService; 45 46 class SensorService::SensorEventConnection: 47 public BnSensorEventConnection, public LooperCallback { 48 49 friend class SensorService; 50 51 public: 52 SensorEventConnection(const sp<SensorService>& service, uid_t uid, String8 packageName, 53 bool isDataInjectionMode, const String16& opPackageName); 54 55 status_t sendEvents(sensors_event_t const* buffer, size_t count, sensors_event_t* scratch, 56 wp<const SensorEventConnection> const * mapFlushEventsToConnections = nullptr); 57 bool hasSensor(int32_t handle) const; 58 bool hasAnySensor() const; 59 bool hasOneShotSensors() const; 60 bool addSensor(int32_t handle); 61 bool removeSensor(int32_t handle); 62 std::vector<int32_t> getActiveSensorHandles() const; 63 void setFirstFlushPending(int32_t handle, bool value); 64 void dump(String8& result); 65 void dump(util::ProtoOutputStream* proto) const; 66 bool needsWakeLock(); 67 void resetWakeLockRefCount(); 68 String8 getPackageName() const; 69 getUid()70 uid_t getUid() const { return mUid; } 71 72 private: 73 virtual ~SensorEventConnection(); 74 virtual void onFirstRef(); 75 virtual sp<BitTube> getSensorChannel() const; 76 virtual status_t enableDisable(int handle, bool enabled, nsecs_t samplingPeriodNs, 77 nsecs_t maxBatchReportLatencyNs, int reservedFlags); 78 virtual status_t setEventRate(int handle, nsecs_t samplingPeriodNs); 79 virtual status_t flush(); 80 virtual int32_t configureChannel(int handle, int rateLevel); 81 virtual void destroy(); 82 83 // Count the number of flush complete events which are about to be dropped in the buffer. 84 // Increment mPendingFlushEventsToSend in mSensorInfo. These flush complete events will be sent 85 // separately before the next batch of events. 86 void countFlushCompleteEventsLocked(sensors_event_t const* scratch, int numEventsDropped); 87 88 // Check if there are any wake up events in the buffer. If yes, return the index of the first 89 // wake_up sensor event in the buffer else return -1. This wake_up sensor event will have the 90 // flag WAKE_UP_SENSOR_EVENT_NEEDS_ACK set. Exactly one event per packet will have the wake_up 91 // flag set. SOCK_SEQPACKET ensures that either the entire packet is read or dropped. 92 int findWakeUpSensorEventLocked(sensors_event_t const* scratch, int count); 93 94 // Send pending flush_complete events. There may have been flush_complete_events that are 95 // dropped which need to be sent separately before other events. On older HALs (1_0) this method 96 // emulates the behavior of flush(). 97 void sendPendingFlushEventsLocked(); 98 99 // Writes events from mEventCache to the socket. 100 void writeToSocketFromCache(); 101 102 // Compute the approximate cache size from the FIFO sizes of various sensors registered for this 103 // connection. Wake up and non-wake up sensors have separate FIFOs but FIFO may be shared 104 // amongst wake-up sensors and non-wake up sensors. 105 int computeMaxCacheSizeLocked() const; 106 107 // When more sensors register, the maximum cache size desired may change. Compute max cache 108 // size, reallocate memory and copy over events from the older cache. 109 void reAllocateCacheLocked(sensors_event_t const* scratch, int count); 110 111 // Add the events to the cache. If the cache would be exceeded, drop events at the beginning of 112 // the cache. 113 void appendEventsToCacheLocked(sensors_event_t const* events, int count); 114 115 // LooperCallback method. If there is data to read on this fd, it is an ack from the app that it 116 // has read events from a wake up sensor, decrement mWakeLockRefCount. If this fd is available 117 // for writing send the data from the cache. 118 virtual int handleEvent(int fd, int events, void* data); 119 120 // Increment mPendingFlushEventsToSend for the given handle if the connection has sensor access. 121 // Returns true if this connection does have sensor access. 122 bool incrementPendingFlushCountIfHasAccess(int32_t handle); 123 124 // Add or remove the file descriptor associated with the BitTube to the looper. If mDead is set 125 // to true or there are no more sensors for this connection, the file descriptor is removed if 126 // it has been previously added to the Looper. Depending on the state of the connection FD may 127 // be added to the Looper. The flags to set are determined by the internal state of the 128 // connection. FDs are added to the looper when wake-up sensors are registered (to poll for 129 // acknowledgements) and when write fails on the socket when there are too many error and the 130 // other end hangs up or when this client unregisters for this connection. 131 void updateLooperRegistration(const sp<Looper>& looper); void 132 updateLooperRegistrationLocked(const sp<Looper>& looper); 133 134 // Returns whether sensor access is available based on both the uid being active and sensor 135 // privacy not being enabled. 136 bool hasSensorAccess(); 137 138 // Call noteOp for the sensor if the sensor requires a permission 139 bool noteOpIfRequired(const sensors_event_t& event); 140 141 sp<SensorService> const mService; 142 sp<BitTube> mChannel; 143 uid_t mUid; 144 mutable Mutex mConnectionLock; 145 // Number of events from wake up sensors which are still pending and haven't been delivered to 146 // the corresponding application. It is incremented by one unit for each write to the socket. 147 uint32_t mWakeLockRefCount; 148 149 // If this flag is set to true, it means that the file descriptor associated with the BitTube 150 // has been added to the Looper in SensorService. This flag is typically set when this 151 // connection has wake-up sensors associated with it or when write has failed on this connection 152 // and we're storing some events in the cache. 153 bool mHasLooperCallbacks; 154 // If there are any errors associated with the Looper this flag is set to true and 155 // mWakeLockRefCount is reset to zero. needsWakeLock method will always return false, if this 156 // flag is set. 157 bool mDead; 158 159 bool mDataInjectionMode; 160 struct FlushInfo { 161 // The number of flush complete events dropped for this sensor is stored here. They are 162 // sent separately before the next batch of events. 163 int mPendingFlushEventsToSend; 164 165 // Every activate is preceded by a flush. Only after the first flush complete is received, 166 // the events for the sensor are sent on that *connection*. 167 bool mFirstFlushPending; 168 FlushInfoFlushInfo169 FlushInfo() : mPendingFlushEventsToSend(0), mFirstFlushPending(false) {} 170 }; 171 // protected by SensorService::mLock. Key for this map is the sensor handle. 172 std::unordered_map<int32_t, FlushInfo> mSensorInfo; 173 174 sensors_event_t *mEventCache; 175 int mCacheSize, mMaxCacheSize; 176 int64_t mTimeOfLastEventDrop; 177 int mEventsDropped; 178 String8 mPackageName; 179 const String16 mOpPackageName; 180 int mTargetSdk; 181 #if DEBUG_CONNECTIONS 182 int mEventsReceived, mEventsSent, mEventsSentFromCache; 183 int mTotalAcksNeeded, mTotalAcksReceived; 184 #endif 185 186 // Used to track if this object was inappropriately used after destroy(). 187 std::atomic_bool mDestroyed; 188 189 // Store a mapping of sensor handles to required AppOp for a sensor. This map only contains a 190 // valid mapping for sensors that require a permission in order to reduce the lookup time. 191 std::unordered_map<int32_t, int32_t> mHandleToAppOp; 192 }; 193 194 } // namepsace android 195 196 #endif // ANDROID_SENSOR_EVENT_CONNECTION_H 197 198