1 #include "display_surface.h"
3 #include <private/android_filesystem_config.h>
4 #include <utils/Trace.h>
6 #include <private/dvr/trusted_uids.h>
8 #include "display_service.h"
9 #include "hardware_composer.h"
13 using android::dvr::display::DisplayProtocol;
14 using android::pdx::BorrowedChannelHandle;
15 using android::pdx::ErrorStatus;
16 using android::pdx::LocalChannelHandle;
17 using android::pdx::LocalHandle;
18 using android::pdx::Message;
19 using android::pdx::RemoteChannelHandle;
20 using android::pdx::Status;
21 using android::pdx::rpc::DispatchRemoteMethod;
22 using android::pdx::rpc::IfAnyOf;
27 DisplaySurface::DisplaySurface(DisplayService* service,
28 SurfaceType surface_type, int surface_id,
29 int process_id, int user_id,
30 const display::SurfaceAttributes& attributes)
32 surface_type_(surface_type),
33 surface_id_(surface_id),
34 process_id_(process_id),
36 attributes_(attributes),
37 update_flags_(display::SurfaceUpdateFlags::NewSurface) {}
39 DisplaySurface::~DisplaySurface() {
41 "DisplaySurface::~DisplaySurface: surface_id=%d process_id=%d",
42 surface_id(), process_id());
45 Status<void> DisplaySurface::HandleMessage(pdx::Message& message) {
46 switch (message.GetOp()) {
47 case DisplayProtocol::SetAttributes::Opcode:
48 DispatchRemoteMethod<DisplayProtocol::SetAttributes>(
49 *this, &DisplaySurface::OnSetAttributes, message);
52 case DisplayProtocol::GetSurfaceInfo::Opcode:
53 DispatchRemoteMethod<DisplayProtocol::GetSurfaceInfo>(
54 *this, &DisplaySurface::OnGetSurfaceInfo, message);
57 case DisplayProtocol::CreateQueue::Opcode:
58 DispatchRemoteMethod<DisplayProtocol::CreateQueue>(
59 *this, &DisplaySurface::OnCreateQueue, message);
66 Status<void> DisplaySurface::OnSetAttributes(
67 pdx::Message& /*message*/, const display::SurfaceAttributes& attributes) {
68 display::SurfaceUpdateFlags update_flags;
70 for (const auto& attribute : attributes) {
71 const auto& key = attribute.first;
72 const auto* variant = &attribute.second;
73 bool invalid_value = false;
74 bool visibility_changed = false;
76 // Catch attributes that have significance to the display service.
78 case display::SurfaceAttribute::ZOrder:
79 invalid_value = !IfAnyOf<int32_t, int64_t, float>::Call(
80 variant, [&](const auto& value) {
81 if (z_order_ != value) {
82 visibility_changed = true;
87 case display::SurfaceAttribute::Visible:
88 invalid_value = !IfAnyOf<int32_t, int64_t, bool>::Call(
89 variant, [&](const auto& value) {
90 if (visible_ != value) {
91 visibility_changed = true;
100 "DisplaySurface::OnClientSetAttributes: Failed to set display "
101 "surface attribute '%d' because of incompatible type: %d",
102 key, variant->index());
104 // Only update the attribute map with valid values.
105 attributes_[attribute.first] = attribute.second;
107 // All attribute changes generate a notification, even if the value
108 // doesn't change. Visibility attributes set a flag only if the value
110 update_flags.Set(display::SurfaceUpdateFlags::AttributesChanged);
111 if (visibility_changed)
112 update_flags.Set(display::SurfaceUpdateFlags::VisibilityChanged);
116 SurfaceUpdated(update_flags);
120 void DisplaySurface::SurfaceUpdated(display::SurfaceUpdateFlags update_flags) {
122 "DisplaySurface::SurfaceUpdated: surface_id=%d update_flags=0x%x",
123 surface_id(), update_flags.value());
125 update_flags_.Set(update_flags);
126 service()->SurfaceUpdated(surface_type(), update_flags_);
129 void DisplaySurface::ClearUpdate() {
130 ALOGD_IF(TRACE, "DisplaySurface::ClearUpdate: surface_id=%d", surface_id());
131 update_flags_ = display::SurfaceUpdateFlags::None;
134 Status<display::SurfaceInfo> DisplaySurface::OnGetSurfaceInfo(
135 Message& /*message*/) {
138 "DisplaySurface::OnGetSurfaceInfo: surface_id=%d visible=%d z_order=%d",
139 surface_id(), visible(), z_order());
140 return {{surface_id(), visible(), z_order()}};
143 Status<void> DisplaySurface::RegisterQueue(
144 const std::shared_ptr<ConsumerQueue>& consumer_queue) {
145 ALOGD_IF(TRACE, "DisplaySurface::RegisterQueue: surface_id=%d queue_id=%d",
146 surface_id(), consumer_queue->id());
147 // Capture references for the lambda to work around apparent clang bug.
148 // TODO(eieio): Figure out if there is a clang bug or C++11 ambiguity when
149 // capturing self and consumer_queue by copy in the following case:
150 // auto self = Self();
151 // [self, consumer_queue](int events) {
152 // self->OnQueueEvent(consuemr_queue, events); }
155 std::shared_ptr<DisplaySurface> surface;
156 std::shared_ptr<ConsumerQueue> queue;
158 State state{Self(), consumer_queue};
160 return service()->AddEventHandler(
161 consumer_queue->queue_fd(), EPOLLIN | EPOLLHUP | EPOLLET,
162 [state](int events) {
163 state.surface->OnQueueEvent(state.queue, events);
167 Status<void> DisplaySurface::UnregisterQueue(
168 const std::shared_ptr<ConsumerQueue>& consumer_queue) {
169 ALOGD_IF(TRACE, "DisplaySurface::UnregisterQueue: surface_id=%d queue_id=%d",
170 surface_id(), consumer_queue->id());
171 return service()->RemoveEventHandler(consumer_queue->queue_fd());
174 void DisplaySurface::OnQueueEvent(
175 const std::shared_ptr<ConsumerQueue>& /*consumer_queue*/, int /*events*/) {
177 "DisplaySurface::OnQueueEvent: ERROR base virtual method should not be "
181 std::shared_ptr<ConsumerQueue> ApplicationDisplaySurface::GetQueue(
184 "ApplicationDisplaySurface::GetQueue: surface_id=%d queue_id=%d",
185 surface_id(), queue_id);
187 auto search = consumer_queues_.find(queue_id);
188 if (search != consumer_queues_.end())
189 return search->second;
194 std::vector<int32_t> ApplicationDisplaySurface::GetQueueIds() const {
195 std::vector<int32_t> queue_ids;
196 for (const auto& entry : consumer_queues_)
197 queue_ids.push_back(entry.first);
201 Status<LocalChannelHandle> ApplicationDisplaySurface::OnCreateQueue(
202 Message& /*message*/, size_t meta_size_bytes) {
203 ATRACE_NAME("ApplicationDisplaySurface::OnCreateQueue");
205 "ApplicationDisplaySurface::OnCreateQueue: surface_id=%d, "
206 "meta_size_bytes=%zu",
207 surface_id(), meta_size_bytes);
209 std::lock_guard<std::mutex> autolock(lock_);
210 auto producer = ProducerQueue::Create(meta_size_bytes);
213 "ApplicationDisplaySurface::OnCreateQueue: Failed to create producer "
215 return ErrorStatus(ENOMEM);
218 std::shared_ptr<ConsumerQueue> consumer =
219 producer->CreateSilentConsumerQueue();
220 auto status = RegisterQueue(consumer);
223 "ApplicationDisplaySurface::OnCreateQueue: Failed to register consumer "
225 status.GetErrorMessage().c_str());
226 return status.error_status();
229 consumer_queues_[consumer->id()] = std::move(consumer);
231 SurfaceUpdated(display::SurfaceUpdateFlags::BuffersChanged);
232 return std::move(producer->GetChannelHandle());
235 void ApplicationDisplaySurface::OnQueueEvent(
236 const std::shared_ptr<ConsumerQueue>& consumer_queue, int events) {
238 "ApplicationDisplaySurface::OnQueueEvent: queue_id=%d events=%x",
239 consumer_queue->id(), events);
241 // Always give the queue a chance to handle its internal bookkeeping.
242 consumer_queue->HandleQueueEvents();
244 // Check for hangup and remove a queue that is no longer needed.
245 std::lock_guard<std::mutex> autolock(lock_);
246 if (consumer_queue->hung_up()) {
247 ALOGD_IF(TRACE, "ApplicationDisplaySurface::OnQueueEvent: Removing queue.");
248 UnregisterQueue(consumer_queue);
249 auto search = consumer_queues_.find(consumer_queue->id());
250 if (search != consumer_queues_.end()) {
251 consumer_queues_.erase(search);
254 "ApplicationDisplaySurface::OnQueueEvent: Failed to find queue_id=%d",
255 consumer_queue->id());
257 SurfaceUpdated(display::SurfaceUpdateFlags::BuffersChanged);
261 Status<LocalChannelHandle> DirectDisplaySurface::OnCreateQueue(
262 Message& /*message*/, size_t meta_size_bytes) {
263 ATRACE_NAME("DirectDisplaySurface::OnCreateQueue");
266 "DirectDisplaySurface::OnCreateQueue: surface_id=%d meta_size_bytes=%zu",
267 surface_id(), meta_size_bytes);
269 std::lock_guard<std::mutex> autolock(lock_);
270 if (!direct_queue_) {
271 auto producer = ProducerQueue::Create(meta_size_bytes);
274 "DirectDisplaySurface::OnCreateQueue: Failed to create producer "
276 return ErrorStatus(ENOMEM);
279 direct_queue_ = producer->CreateConsumerQueue();
280 auto status = RegisterQueue(direct_queue_);
283 "DirectDisplaySurface::OnCreateQueue: Failed to register consumer "
285 status.GetErrorMessage().c_str());
286 return status.error_status();
289 return std::move(producer->GetChannelHandle());
291 return ErrorStatus(EALREADY);
295 void DirectDisplaySurface::OnQueueEvent(
296 const std::shared_ptr<ConsumerQueue>& consumer_queue, int events) {
297 ALOGD_IF(TRACE, "DirectDisplaySurface::OnQueueEvent: queue_id=%d events=%x",
298 consumer_queue->id(), events);
300 // Always give the queue a chance to handle its internal bookkeeping.
301 consumer_queue->HandleQueueEvents();
303 // Check for hangup and remove a queue that is no longer needed.
304 std::lock_guard<std::mutex> autolock(lock_);
305 if (consumer_queue->hung_up()) {
306 ALOGD_IF(TRACE, "DirectDisplaySurface::OnQueueEvent: Removing queue.");
307 UnregisterQueue(consumer_queue);
308 direct_queue_ = nullptr;
312 void DirectDisplaySurface::DequeueBuffersLocked() {
313 if (direct_queue_ == nullptr) {
315 "DirectDisplaySurface::DequeueBuffersLocked: Consumer queue is not "
321 LocalHandle acquire_fence;
323 auto buffer_status = direct_queue_->Dequeue(0, &slot, &acquire_fence);
324 if (!buffer_status) {
326 TRACE && buffer_status.error() == ETIMEDOUT,
327 "DirectDisplaySurface::DequeueBuffersLocked: All buffers dequeued.");
328 ALOGE_IF(buffer_status.error() != ETIMEDOUT,
329 "DirectDisplaySurface::DequeueBuffersLocked: Failed to dequeue "
331 buffer_status.GetErrorMessage().c_str());
334 auto buffer_consumer = buffer_status.take();
337 ATRACE_NAME("DropFrameOnInvisibleSurface");
339 "DirectDisplaySurface::DequeueBuffersLocked: Discarding "
340 "buffer_id=%d on invisible surface.",
341 buffer_consumer->id());
342 buffer_consumer->Discard();
346 if (acquired_buffers_.IsFull()) {
348 "DirectDisplaySurface::DequeueBuffersLocked: Posted buffers full, "
350 acquired_buffers_.PopBack();
353 acquired_buffers_.Append(
354 AcquiredBuffer(buffer_consumer, std::move(acquire_fence)));
358 AcquiredBuffer DirectDisplaySurface::AcquireCurrentBuffer() {
359 std::lock_guard<std::mutex> autolock(lock_);
360 DequeueBuffersLocked();
362 if (acquired_buffers_.IsEmpty()) {
364 "DirectDisplaySurface::AcquireCurrentBuffer: attempt to acquire buffer "
365 "when none are posted.");
366 return AcquiredBuffer();
368 AcquiredBuffer buffer = std::move(acquired_buffers_.Front());
369 acquired_buffers_.PopFront();
370 ALOGD_IF(TRACE, "DirectDisplaySurface::AcquireCurrentBuffer: buffer: %p",
371 buffer.buffer().get());
375 AcquiredBuffer DirectDisplaySurface::AcquireNewestAvailableBuffer(
376 AcquiredBuffer* skipped_buffer) {
377 std::lock_guard<std::mutex> autolock(lock_);
378 DequeueBuffersLocked();
380 AcquiredBuffer buffer;
382 // Basic latency stopgap for when the application misses a frame:
383 // If the application recovers on the 2nd or 3rd (etc) frame after
384 // missing, this code will skip frames to catch up by checking if
385 // the next frame is also available.
386 while (!acquired_buffers_.IsEmpty() &&
387 acquired_buffers_.Front().IsAvailable()) {
388 // Capture the skipped buffer into the result parameter.
389 // Note that this API only supports skipping one buffer per vsync.
390 if (frames > 0 && skipped_buffer)
391 *skipped_buffer = std::move(buffer);
393 buffer = std::move(acquired_buffers_.Front());
394 acquired_buffers_.PopFront();
399 "DirectDisplaySurface::AcquireNewestAvailableBuffer: buffer: %p",
400 buffer.buffer().get());
404 bool DirectDisplaySurface::IsBufferAvailable() {
405 std::lock_guard<std::mutex> autolock(lock_);
406 DequeueBuffersLocked();
408 return !acquired_buffers_.IsEmpty() &&
409 acquired_buffers_.Front().IsAvailable();
412 bool DirectDisplaySurface::IsBufferPosted() {
413 std::lock_guard<std::mutex> autolock(lock_);
414 DequeueBuffersLocked();
416 return !acquired_buffers_.IsEmpty();
419 Status<std::shared_ptr<DisplaySurface>> DisplaySurface::Create(
420 DisplayService* service, int surface_id, int process_id, int user_id,
421 const display::SurfaceAttributes& attributes) {
423 auto search = attributes.find(display::SurfaceAttribute::Direct);
424 if (search != attributes.end()) {
425 if (!IfAnyOf<int32_t, int64_t, bool, float>::Get(&search->second,
428 "DisplaySurface::Create: Invalid type for SurfaceAttribute::Direct!");
429 return ErrorStatus(EINVAL);
434 "DisplaySurface::Create: surface_id=%d process_id=%d user_id=%d "
436 surface_id, process_id, user_id, direct);
439 const bool trusted = user_id == AID_ROOT || IsTrustedUid(user_id);
441 return {std::shared_ptr<DisplaySurface>{new DirectDisplaySurface(
442 service, surface_id, process_id, user_id, attributes)}};
445 "DisplaySurface::Create: Direct surfaces may only be created by "
446 "trusted UIDs: user_id=%d",
448 return ErrorStatus(EPERM);
451 return {std::shared_ptr<DisplaySurface>{new ApplicationDisplaySurface(
452 service, surface_id, process_id, user_id, attributes)}};
457 } // namespace android